CarePlanDAM - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Logical Model: API Plan Payload
| Official URL: http://hl7.org/dam/StructureDefinition/APIPlanPayload | Version: 0.1.0 | |||
| Active as of 2026-02-18 | Computable Name: APIPlanPayload | |||
A care plan manifested as a digital payload for system exchange
Usages:
- This Logical Model is not used by any profiles in this Implementation Guide
You can also check for usages in the FHIR IG Statistics
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  APIPlanPayload |
0..* | View | API Plan Payload Elements defined in Ancestors:viewType Instances of this logical model can be the target of a Reference | |
  viewType |
0..1 | CodeableConcept | Type of view | |
 payloadFormat |
0..1 | code | Format of the API payload (e.g., FHIR, HL7v2) | |
 endpoint |
0..1 | url | API endpoint | |
| Documentation for this format | ||||
This structure is derived from View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| APIPlanPayload |
0..* | View | API Plan Payload Elements defined in Ancestors:viewType Instances of this logical model can be the target of a Reference | |
| payloadFormat |
0..1 | code | Format of the API payload (e.g., FHIR, HL7v2) | |
| endpoint |
0..1 | url | API endpoint | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| APIPlanPayload |
0..* | View | API Plan Payload Elements defined in Ancestors:viewType Instances of this logical model can be the target of a Reference | |
| viewType |
0..1 | CodeableConcept | Type of view | |
| payloadFormat |
0..1 | code | Format of the API payload (e.g., FHIR, HL7v2) | |
| endpoint |
0..1 | url | API endpoint | |
| Documentation for this format | ||||
This structure is derived from View
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| APIPlanPayload |
0..* | View | API Plan Payload Elements defined in Ancestors:viewType Instances of this logical model can be the target of a Reference | |
| viewType |
0..1 | CodeableConcept | Type of view | |
| payloadFormat |
0..1 | code | Format of the API payload (e.g., FHIR, HL7v2) | |
| endpoint |
0..1 | url | API endpoint | |
| Documentation for this format | ||||
Differential View
This structure is derived from View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| APIPlanPayload |
0..* | View | API Plan Payload Elements defined in Ancestors:viewType Instances of this logical model can be the target of a Reference | |
| payloadFormat |
0..1 | code | Format of the API payload (e.g., FHIR, HL7v2) | |
| endpoint |
0..1 | url | API endpoint | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| APIPlanPayload |
0..* | View | API Plan Payload Elements defined in Ancestors:viewType Instances of this logical model can be the target of a Reference | |
| viewType |
0..1 | CodeableConcept | Type of view | |
| payloadFormat |
0..1 | code | Format of the API payload (e.g., FHIR, HL7v2) | |
| endpoint |
0..1 | url | API endpoint | |
| Documentation for this format | ||||
This structure is derived from View