0.1.0 - ci-build

CarePlanDAM - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Logical Model: APIPlanPayload - Detailed Descriptions

Active as of 2026-02-18

Definitions for the APIPlanPayload logical model.

Guidance on how to interpret the contents of this table can be foundhere

0. APIPlanPayload
Definition

A care plan manifested as a digital payload for system exchange

ShortAPI Plan Payload
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. APIPlanPayload.viewType
Definition

Type of view

ShortType of view
Control0..1
TypeCodeableConcept
4. APIPlanPayload.payloadFormat
Definition

Format of the API payload (e.g., FHIR, HL7v2)

ShortFormat of the API payload (e.g., FHIR, HL7v2)
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. APIPlanPayload.endpoint
Definition

API endpoint

ShortAPI endpoint
Control0..1
Typeurl
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

Guidance on how to interpret the contents of this table can be foundhere

0. APIPlanPayload
Definition

A care plan manifested as a digital payload for system exchange

ShortAPI Plan Payload
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. APIPlanPayload.payloadFormat
Definition

Format of the API payload (e.g., FHIR, HL7v2)

ShortFormat of the API payload (e.g., FHIR, HL7v2)
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. APIPlanPayload.endpoint
Definition

API endpoint

ShortAPI endpoint
Control0..1
Typeurl
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

Guidance on how to interpret the contents of this table can be foundhere

0. APIPlanPayload
Definition

A care plan manifested as a digital payload for system exchange

ShortAPI Plan Payload
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. APIPlanPayload.viewType
Definition

Type of view

ShortType of view
Control0..1
TypeCodeableConcept
4. APIPlanPayload.payloadFormat
Definition

Format of the API payload (e.g., FHIR, HL7v2)

ShortFormat of the API payload (e.g., FHIR, HL7v2)
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. APIPlanPayload.endpoint
Definition

API endpoint

ShortAPI endpoint
Control0..1
Typeurl
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension