Consolidated CDA (C-CDA), published by Health Level Seven. This guide is not an authorized publication; it is the continuous build for version 5.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/CDA-ccda/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/CarePlanAct | Version: 5.0.0-ballot | |||
| Draft as of 2025-12-12 | Computable Name: CarePlanAct | |||
| Other Identifiers: urn:ietf:rfc:3986#Uniform Resource Identifier (URI)#urn:hl7ii:2.16.840.1.113883.10.20.22.4.518:2026-05-01 | ||||
The Care Plan Act represents a snapshot in time of a dynamic, consensus-driven plan that has captured a patient's and care team members' prioritized concerns, goals, and planned interventions. It reflects the state of the care plan as managed within a source system and may be exchanged to support care coordination across systems and settings.
The Care Plan Act identifies the authoring individual or organization (act.author), which aligns with the FHIR CarePlan.contributor, and records the set of health concerns or conditions being addressed.
To meet USCDI requirements, at least one entryRelationship:addresses element referencing an Indication, Problem Observation, or Observation is required.
The Care Plan Act may integrate multiple condition- or discipline-specific plans of care and serves to align activities and responsibilities among participants. Supporting entryRelationship templates such as Goal, Intervention Act, Planned Intervention Act, and Act are available for systems capable of representing structured care plans, but their use is optional and not required for USCDI compliance.
This entry conveys an instance of the evolving Care Plan at a specific point in time and does not represent a dynamically updated plan.
Although open templates may contain any valid CDA content, the following templates are specifically called out by this template:
Optional EntryRelationships: Act, EntryReference, GoalObservation, Indication, InterventionAct, Observation, PlannedInterventionAct, ProblemObservation
Usages:
You can also check for usages in the FHIR IG Statistics
Changes since version 4.0.0:
Description of Template, Differentials, Snapshots and how the different presentations work.
This structure is derived from Act
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 1..1 | Act | XML Namespace: urn:hl7-org:v3 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: should-text-ref-value |
![]() ![]() |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
![]() ![]() ![]() |
1..1 | II | ||
![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.518 | |
![]() ![]() ![]() ![]() |
1..1 | st | Required Pattern: 2026-05-01 | |
![]() ![]() |
1..1 | cs | CarePlan.intent Binding: Care Plan Mood Codes (required) | |
![]() ![]() |
1..1 | CD | Plan of care note | |
![]() ![]() ![]() |
1..1 | cs | Required Pattern: 18776-5 | |
![]() ![]() ![]() |
1..1 | oid, uuid, ruid | LOINC Required Pattern: 2.16.840.1.113883.6.1 | |
![]() ![]() ![]() |
0..* | CD | Binding: CarePlanCategory (preferred) | |
![]() ![]() |
C | 0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry |
![]() ![]() ![]() |
C | 0..1 | TEL | Constraints: value-starts-octothorpe |
![]() ![]() |
1..1 | CS | CarePlan.status | |
![]() ![]() |
0..* | AuthorParticipation | CarePlan.contributor | |
![]() ![]() |
0..* | EntryRelationship | Entries can be embedded directly or referenced via EntryReference. Use the @typeCode attribute to distinguish the type of relationship. Slice: Unordered, Open by value:typeCode | |
![]() ![]() ![]() |
C | 0..* | EntryRelationship | 𝗨𝗦𝗖𝗗𝗜: CarePlan.addresses Constraints: act-or-observation |
![]() ![]() ![]() ![]() |
1..1 | cs | Required Pattern: RSON | |
![]() ![]() ![]() ![]() |
0..1 | EntryReference, Act | References an Indication, Problem Observation, or other Problem described elsewhere in the document. | |
![]() ![]() ![]() ![]() |
0..1 | Indication, ProblemObservation, Observation | Directly-embedded Problem or Indication observation. Use EntryReference to reference an existing problem observation or indication described elsewhere in the document. | |
![]() ![]() ![]() |
C | 0..* | EntryRelationship | Desired outcome of the plan (CarePlan.goal). Can embed a Goal Observation directly or use the EntryReference template to reference a Goal Observation described elsewhere in the document. Constraints: act-or-observation |
![]() ![]() ![]() ![]() |
1..1 | cs | Required Pattern: GEVL | |
![]() ![]() ![]() ![]() |
C | 0..1 | EntryReference | Use to reference a Goal Observation elsewhere Constraints: entry-ref-goal |
![]() ![]() ![]() ![]() |
0..1 | GoalObservation | Use to embed a Goal Observation directly | |
![]() ![]() ![]() |
0..* | EntryRelationship | Information considered as part of the plan (CarePlan.supportingInfo) | |
![]() ![]() ![]() ![]() |
1..1 | cs | Required Pattern: SPRT | |
![]() ![]() ![]() |
0..* | EntryRelationship | Activity to occur as part of plan (CarePlan.activity). Common examples include the Intervention Act and Planned Intervention Act, but any entry may be considered an activity of the care plan. | |
![]() ![]() ![]() ![]() |
1..1 | cs | Required Pattern: COMP | |
![]() ![]() ![]() ![]() |
0..1 | InterventionAct, PlannedInterventionAct, Act | A care plan may have multiple COMP entryRelationships, but each entryRelationship may only have a single act/encounter/observation/supply or other clinical statement. | |
![]() ![]() ![]() ![]() |
0..1 | Encounter | A care plan may have multiple COMP entryRelationships, but each entryRelationship may only have a single act/encounter/observation/supply or other clinical statement. | |
![]() ![]() ![]() ![]() |
0..1 | Observation | A care plan may have multiple COMP entryRelationships, but each entryRelationship may only have a single act/encounter/observation/supply or other clinical statement. | |
![]() ![]() ![]() ![]() |
0..1 | Supply | A care plan may have multiple COMP entryRelationships, but each entryRelationship may only have a single act/encounter/observation/supply or other clinical statement. | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Act.moodCode | Base | required |
Care Plan Mood Codes
|
📦20251123 | VSAC v0.24 |
| Act.code.translation | Base | preferred | Care Plan Category | 📦5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| act-or-observation | error | Act.entryRelationship:addresses, Act.entryRelationship:goal | Either act or observation SHALL be present but not both. |
act.exists() or observation.exists()
|
| entry-ref-goal | error | Act.entryRelationship:goal.act | This entryReference template **SHALL** reference an instance of a Goal Observation template. |
%resource.descendants().ofType(CDA.Observation).where(templateId.exists($this.root = '2.16.840.1.113883.10.20.22.4.121' and $this.extension = '2022-06-01') and id.exists($this.root = %context.id.first().root and $this.extension ~ %context.id.first().extension))
|
| should-text-ref-value | warning | Act | SHOULD contain text/reference/@value |
text.reference.value.exists()
|
| value-starts-octothorpe | error | Act.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
value.exists() implies value.startsWith('#')
|
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 1..1 | Act | XML Namespace: urn:hl7-org:v3 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: should-text-ref-value |
![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |
![]() ![]() |
0..* | CS | ||
![]() ![]() |
C | 0..1 | II | Constraints: II-1 |
![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |
![]() ![]() ![]() |
0..1 | st | ||
![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
![]() ![]() ![]() |
1..1 | st | ||
![]() ![]() |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
![]() ![]() ![]() |
1..1 | II | ||
![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |
![]() ![]() ![]() ![]() |
0..1 | st | ||
![]() ![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.518 | |
![]() ![]() ![]() ![]() |
1..1 | st | Required Pattern: 2026-05-01 | |
![]() ![]() |
1..1 | cs | Binding: XActClassDocumentEntryAct (2.0.0) (required) | |
![]() ![]() |
1..1 | cs | CarePlan.intent Binding: Care Plan Mood Codes (required) | |
![]() ![]() |
0..1 | bl | ||
![]() ![]() |
0..* | II | ||
![]() ![]() |
1..1 | CD | Plan of care note Binding: v3 Code System ActCode (example) | |
![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |
![]() ![]() ![]() |
1..1 | cs | Required Pattern: 18776-5 | |
![]() ![]() ![]() |
1..1 | oid, uuid, ruid | LOINC Required Pattern: 2.16.840.1.113883.6.1 | |
![]() ![]() ![]() |
0..1 | st | ||
![]() ![]() ![]() |
0..1 | st | ||
![]() ![]() ![]() |
0..1 | st | ||
![]() ![]() ![]() |
0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
![]() ![]() ![]() |
0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
![]() ![]() ![]() |
0..1 | ED | ||
![]() ![]() ![]() |
0..* | CR | ||
![]() ![]() ![]() |
0..* | CD | Binding: CarePlanCategory (preferred) | |
![]() ![]() |
C | 0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry |
![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |
![]() ![]() ![]() |
0..1 | cs | Binding: CDACompressionAlgorithm (required) | |
![]() ![]() ![]() |
0..1 | bin | ||
![]() ![]() ![]() |
0..1 | cs | Binding: IntegrityCheckAlgorithm (2.0.0) (required) | |
![]() ![]() ![]() |
0..1 | cs | ||
![]() ![]() ![]() |
0..1 | cs | Binding: MediaType (example) | |
![]() ![]() ![]() |
0..1 | cs | Binding: CDABinaryDataEncoding (required) | |
![]() ![]() ![]() |
0..1 | st | Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string. | |
![]() ![]() ![]() |
C | 0..1 | TEL | Constraints: value-starts-octothorpe |
![]() ![]() ![]() |
C | 0..1 | ED | Constraints: ED-1 |
![]() ![]() |
1..1 | CS | CarePlan.status Binding: ActStatus (required) | |
![]() ![]() |
0..1 | IVL_TS | ||
![]() ![]() |
0..1 | CE | Binding: ActPriority (example) | |
![]() ![]() |
0..1 | CS | Binding: AllLanguages (required) | |
![]() ![]() |
0..1 | Subject | ||
![]() ![]() |
0..* | Specimen | ||
![]() ![]() |
0..* | Performer2 | ||
![]() ![]() |
0..* | AuthorParticipation | CarePlan.contributor | |
![]() ![]() |
0..* | Informant | ||
![]() ![]() |
0..* | Participant2 | ||
![]() ![]() |
0..* | EntryRelationship | Entries can be embedded directly or referenced via EntryReference. Use the @typeCode attribute to distinguish the type of relationship. Slice: Unordered, Open by value:typeCode | |
![]() ![]() ![]() |
C | 0..* | EntryRelationship | 𝗨𝗦𝗖𝗗𝗜: CarePlan.addresses Constraints: act-or-observation |
![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |
![]() ![]() ![]() ![]() |
0..* | CS | ||
![]() ![]() ![]() ![]() |
C | 0..1 | II | Constraints: II-1 |
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |
![]() ![]() ![]() ![]() ![]() |
0..1 | st | ||
![]() ![]() ![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
![]() ![]() ![]() ![]() ![]() |
1..1 | st | ||
![]() ![]() ![]() ![]() |
0..* | II | ||
![]() ![]() ![]() ![]() |
1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Required Pattern: RSON | |
![]() ![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() ![]() |
0..1 | INT | ||
![]() ![]() ![]() ![]() |
0..1 | BL | ||
![]() ![]() ![]() ![]() |
0..1 | EntryReference, Act | References an Indication, Problem Observation, or other Problem described elsewhere in the document. | |
![]() ![]() ![]() ![]() |
0..1 | Encounter | ||
![]() ![]() ![]() ![]() |
0..1 | Indication, ProblemObservation, Observation | Directly-embedded Problem or Indication observation. Use EntryReference to reference an existing problem observation or indication described elsewhere in the document. | |
![]() ![]() ![]() ![]() |
0..1 | ObservationMedia | ||
![]() ![]() ![]() ![]() |
0..1 | Organizer | ||
![]() ![]() ![]() ![]() |
0..1 | Procedure | ||
![]() ![]() ![]() ![]() |
0..1 | RegionOfInterest | ||
![]() ![]() ![]() ![]() |
0..1 | SubstanceAdministration | ||
![]() ![]() ![]() ![]() |
0..1 | Supply | ||
![]() ![]() ![]() |
C | 0..* | EntryRelationship | Desired outcome of the plan (CarePlan.goal). Can embed a Goal Observation directly or use the EntryReference template to reference a Goal Observation described elsewhere in the document. Constraints: act-or-observation |
![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |
![]() ![]() ![]() ![]() |
0..* | CS | ||
![]() ![]() ![]() ![]() |
C | 0..1 | II | Constraints: II-1 |
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |
![]() ![]() ![]() ![]() ![]() |
0..1 | st | ||
![]() ![]() ![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
![]() ![]() ![]() ![]() ![]() |
1..1 | st | ||
![]() ![]() ![]() ![]() |
0..* | II | ||
![]() ![]() ![]() ![]() |
1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Required Pattern: GEVL | |
![]() ![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() ![]() |
0..1 | INT | ||
![]() ![]() ![]() ![]() |
0..1 | BL | ||
![]() ![]() ![]() ![]() |
C | 0..1 | EntryReference | Use to reference a Goal Observation elsewhere Constraints: entry-ref-goal |
![]() ![]() ![]() ![]() |
0..1 | Encounter | ||
![]() ![]() ![]() ![]() |
0..1 | GoalObservation | Use to embed a Goal Observation directly | |
![]() ![]() ![]() ![]() |
0..1 | ObservationMedia | ||
![]() ![]() ![]() ![]() |
0..1 | Organizer | ||
![]() ![]() ![]() ![]() |
0..1 | Procedure | ||
![]() ![]() ![]() ![]() |
0..1 | RegionOfInterest | ||
![]() ![]() ![]() ![]() |
0..1 | SubstanceAdministration | ||
![]() ![]() ![]() ![]() |
0..1 | Supply | ||
![]() ![]() ![]() |
0..* | EntryRelationship | Information considered as part of the plan (CarePlan.supportingInfo) | |
![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |
![]() ![]() ![]() ![]() |
0..* | CS | ||
![]() ![]() ![]() ![]() |
C | 0..1 | II | Constraints: II-1 |
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |
![]() ![]() ![]() ![]() ![]() |
0..1 | st | ||
![]() ![]() ![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
![]() ![]() ![]() ![]() ![]() |
1..1 | st | ||
![]() ![]() ![]() ![]() |
0..* | II | ||
![]() ![]() ![]() ![]() |
1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Required Pattern: SPRT | |
![]() ![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() ![]() |
0..1 | INT | ||
![]() ![]() ![]() ![]() |
0..1 | BL | ||
![]() ![]() ![]() ![]() |
0..1 | Act | ||
![]() ![]() ![]() ![]() |
0..1 | Encounter | ||
![]() ![]() ![]() ![]() |
0..1 | Observation | ||
![]() ![]() ![]() ![]() |
0..1 | ObservationMedia | ||
![]() ![]() ![]() ![]() |
0..1 | Organizer | ||
![]() ![]() ![]() ![]() |
0..1 | Procedure | ||
![]() ![]() ![]() ![]() |
0..1 | RegionOfInterest | ||
![]() ![]() ![]() ![]() |
0..1 | SubstanceAdministration | ||
![]() ![]() ![]() ![]() |
0..1 | Supply | ||
![]() ![]() ![]() |
0..* | EntryRelationship | Activity to occur as part of plan (CarePlan.activity). Common examples include the Intervention Act and Planned Intervention Act, but any entry may be considered an activity of the care plan. | |
![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |
![]() ![]() ![]() ![]() |
0..* | CS | ||
![]() ![]() ![]() ![]() |
C | 0..1 | II | Constraints: II-1 |
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |
![]() ![]() ![]() ![]() ![]() |
0..1 | st | ||
![]() ![]() ![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
![]() ![]() ![]() ![]() ![]() |
1..1 | st | ||
![]() ![]() ![]() ![]() |
0..* | II | ||
![]() ![]() ![]() ![]() |
1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Required Pattern: COMP | |
![]() ![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() ![]() |
0..1 | INT | ||
![]() ![]() ![]() ![]() |
0..1 | BL | ||
![]() ![]() ![]() ![]() |
0..1 | InterventionAct, PlannedInterventionAct, Act | A care plan may have multiple COMP entryRelationships, but each entryRelationship may only have a single act/encounter/observation/supply or other clinical statement. | |
![]() ![]() ![]() ![]() |
0..1 | Encounter | A care plan may have multiple COMP entryRelationships, but each entryRelationship may only have a single act/encounter/observation/supply or other clinical statement. | |
![]() ![]() ![]() ![]() |
0..1 | Observation | A care plan may have multiple COMP entryRelationships, but each entryRelationship may only have a single act/encounter/observation/supply or other clinical statement. | |
![]() ![]() ![]() ![]() |
0..1 | ObservationMedia | ||
![]() ![]() ![]() ![]() |
0..1 | Organizer | ||
![]() ![]() ![]() ![]() |
0..1 | Procedure | ||
![]() ![]() ![]() ![]() |
0..1 | RegionOfInterest | ||
![]() ![]() ![]() ![]() |
0..1 | SubstanceAdministration | ||
![]() ![]() ![]() ![]() |
0..1 | Supply | A care plan may have multiple COMP entryRelationships, but each entryRelationship may only have a single act/encounter/observation/supply or other clinical statement. | |
![]() ![]() |
0..* | Reference | ||
![]() ![]() |
0..* | Precondition | ||
![]() ![]() |
0..* | Precondition2 | XML Namespace: urn:hl7-org:sdtc XML: precondition2 (urn:hl7-org:sdtc) | |
![]() ![]() |
0..* | InFulfillmentOf1 | XML Namespace: urn:hl7-org:sdtc XML: inFulfillmentOf1 (urn:hl7-org:sdtc) | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Act.nullFlavor | Base | required | CDANullFlavor | 📦2.0.2-sd | Clinical Document Architecture v2.0 |
| Act.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.2-sd | Clinical Document Architecture v2.0 |
| Act.templateId:care-plan-act.nullFlavor | Base | required | CDANullFlavor | 📦2.0.2-sd | Clinical Document Architecture v2.0 |
| Act.classCode | Base | required | x_ActClassDocumentEntryAct | 📍2.0.0 | THO v5.2 |
| Act.moodCode | Base | required |
Care Plan Mood Codes
|
📦20251123 | VSAC v0.24 |
| Act.code | Base | example | v3 Code System ActCode | 📦3.0.0 | THO v7.0 |
| Act.code.nullFlavor | Base | required | CDANullFlavor | 📦2.0.2-sd | Clinical Document Architecture v2.0 |
| Act.code.translation | Base | preferred | Care Plan Category | 📦5.0.0 | FHIR Std. |
| Act.text.nullFlavor | Base | required | CDANullFlavor | 📦2.0.2-sd | Clinical Document Architecture v2.0 |
| Act.text.compression | Base | required | CDACompressionAlgorithm | 📦2.0.2-sd | Clinical Document Architecture v2.0 |
| Act.text.integrityCheckAlgorithm | Base | required | IntegrityCheckAlgorithm | 📍2.0.0 | THO v5.2 |
| Act.text.mediaType | Base | example | MediaType | 📦3.0.0 | THO v7.0 |
| Act.text.representation | Base | required | CDABinaryDataEncoding | 📦2.0.2-sd | Clinical Document Architecture v2.0 |
| Act.statusCode | Base | required | ActStatus | 📦3.0.0 | THO v7.0 |
| Act.priorityCode | Base | example | ActPriority | 📦3.0.0 | THO v7.0 |
| Act.languageCode | Base | required | All Languages | 📦5.0.0 | FHIR Std. |
| Act.entryRelationship:addresses.nullFlavor | Base | required | CDANullFlavor | 📦2.0.2-sd | Clinical Document Architecture v2.0 |
| Act.entryRelationship:addresses.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.2-sd | Clinical Document Architecture v2.0 |
| Act.entryRelationship:addresses.typeCode | Base | required | x_ActRelationshipEntryRelationship | 📦3.0.0 | THO v7.0 |
| Act.entryRelationship:goal.nullFlavor | Base | required | CDANullFlavor | 📦2.0.2-sd | Clinical Document Architecture v2.0 |
| Act.entryRelationship:goal.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.2-sd | Clinical Document Architecture v2.0 |
| Act.entryRelationship:goal.typeCode | Base | required | x_ActRelationshipEntryRelationship | 📦3.0.0 | THO v7.0 |
| Act.entryRelationship:supportingInfo.nullFlavor | Base | required | CDANullFlavor | 📦2.0.2-sd | Clinical Document Architecture v2.0 |
| Act.entryRelationship:supportingInfo.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.2-sd | Clinical Document Architecture v2.0 |
| Act.entryRelationship:supportingInfo.typeCode | Base | required | x_ActRelationshipEntryRelationship | 📦3.0.0 | THO v7.0 |
| Act.entryRelationship:activity.nullFlavor | Base | required | CDANullFlavor | 📦2.0.2-sd | Clinical Document Architecture v2.0 |
| Act.entryRelationship:activity.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.2-sd | Clinical Document Architecture v2.0 |
| Act.entryRelationship:activity.typeCode | Base | required | x_ActRelationshipEntryRelationship | 📦3.0.0 | THO v7.0 |
| Id | Grade | Path(s) | Description | Expression |
| ED-1 | error | Act.text.thumbnail | Thumbnails cannot contain their own thumbnails |
thumbnail.empty()
|
| II-1 | error | Act.typeId, Act.entryRelationship:addresses.typeId, Act.entryRelationship:goal.typeId, Act.entryRelationship:supportingInfo.typeId, Act.entryRelationship:activity.typeId | An II instance must have either a root or an nullFlavor. |
root.exists() or nullFlavor.exists()
|
| act-or-observation | error | Act.entryRelationship:addresses, Act.entryRelationship:goal | Either act or observation SHALL be present but not both. |
act.exists() or observation.exists()
|
| entry-ref-goal | error | Act.entryRelationship:goal.act | This entryReference template **SHALL** reference an instance of a Goal Observation template. |
%resource.descendants().ofType(CDA.Observation).where(templateId.exists($this.root = '2.16.840.1.113883.10.20.22.4.121' and $this.extension = '2022-06-01') and id.exists($this.root = %context.id.first().root and $this.extension ~ %context.id.first().extension))
|
| should-text-ref-value | warning | Act | SHOULD contain text/reference/@value |
text.reference.value.exists()
|
| value-starts-octothorpe | error | Act.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
value.exists() implies value.startsWith('#')
|
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 1..1 | Act | XML Namespace: urn:hl7-org:v3 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: should-text-ref-value |
![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |
![]() ![]() |
0..* | CS | ||
![]() ![]() |
C | 0..1 | II | Constraints: II-1 |
![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |
![]() ![]() ![]() |
0..1 | st | ||
![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
![]() ![]() ![]() |
1..1 | st | ||
![]() ![]() |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
![]() ![]() ![]() |
1..1 | II | ||
![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |
![]() ![]() ![]() ![]() |
0..1 | st | ||
![]() ![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.518 | |
![]() ![]() ![]() ![]() |
1..1 | st | Required Pattern: 2026-05-01 | |
![]() ![]() |
1..1 | cs | Binding: XActClassDocumentEntryAct (2.0.0) (required) | |
![]() ![]() |
1..1 | cs | CarePlan.intent Binding: Care Plan Mood Codes (required) | |
![]() ![]() |
0..1 | bl | ||
![]() ![]() |
0..* | II | ||
![]() ![]() |
1..1 | CD | Plan of care note Binding: v3 Code System ActCode (example) | |
![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |
![]() ![]() ![]() |
1..1 | cs | Required Pattern: 18776-5 | |
![]() ![]() ![]() |
1..1 | oid, uuid, ruid | LOINC Required Pattern: 2.16.840.1.113883.6.1 | |
![]() ![]() ![]() |
0..1 | st | ||
![]() ![]() ![]() |
0..1 | st | ||
![]() ![]() ![]() |
0..1 | st | ||
![]() ![]() ![]() |
0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
![]() ![]() ![]() |
0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
![]() ![]() ![]() |
0..1 | ED | ||
![]() ![]() ![]() |
0..* | CR | ||
![]() ![]() ![]() |
0..* | CD | Binding: CarePlanCategory (preferred) | |
![]() ![]() |
C | 0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry |
![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |
![]() ![]() ![]() |
0..1 | cs | Binding: CDACompressionAlgorithm (required) | |
![]() ![]() ![]() |
0..1 | bin | ||
![]() ![]() ![]() |
0..1 | cs | Binding: IntegrityCheckAlgorithm (2.0.0) (required) | |
![]() ![]() ![]() |
0..1 | cs | ||
![]() ![]() ![]() |
0..1 | cs | Binding: MediaType (example) | |
![]() ![]() ![]() |
0..1 | cs | Binding: CDABinaryDataEncoding (required) | |
![]() ![]() ![]() |
0..1 | st | Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string. | |
![]() ![]() ![]() |
C | 0..1 | TEL | Constraints: value-starts-octothorpe |
![]() ![]() ![]() |
C | 0..1 | ED | Constraints: ED-1 |
![]() ![]() |
1..1 | CS | CarePlan.status Binding: ActStatus (required) | |
![]() ![]() |
0..1 | IVL_TS | ||
![]() ![]() |
0..1 | CE | Binding: ActPriority (example) | |
![]() ![]() |
0..1 | CS | Binding: AllLanguages (required) | |
![]() ![]() |
0..1 | Subject | ||
![]() ![]() |
0..* | Specimen | ||
![]() ![]() |
0..* | Performer2 | ||
![]() ![]() |
0..* | AuthorParticipation | CarePlan.contributor | |
![]() ![]() |
0..* | Informant | ||
![]() ![]() |
0..* | Participant2 | ||
![]() ![]() |
0..* | EntryRelationship | Entries can be embedded directly or referenced via EntryReference. Use the @typeCode attribute to distinguish the type of relationship. Slice: Unordered, Open by value:typeCode | |
![]() ![]() ![]() |
C | 0..* | EntryRelationship | 𝗨𝗦𝗖𝗗𝗜: CarePlan.addresses Constraints: act-or-observation |
![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |
![]() ![]() ![]() ![]() |
0..* | CS | ||
![]() ![]() ![]() ![]() |
C | 0..1 | II | Constraints: II-1 |
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |
![]() ![]() ![]() ![]() ![]() |
0..1 | st | ||
![]() ![]() ![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
![]() ![]() ![]() ![]() ![]() |
1..1 | st | ||
![]() ![]() ![]() ![]() |
0..* | II | ||
![]() ![]() ![]() ![]() |
1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Required Pattern: RSON | |
![]() ![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() ![]() |
0..1 | INT | ||
![]() ![]() ![]() ![]() |
0..1 | BL | ||
![]() ![]() ![]() ![]() |
0..1 | EntryReference, Act | References an Indication, Problem Observation, or other Problem described elsewhere in the document. | |
![]() ![]() ![]() ![]() |
0..1 | Encounter | ||
![]() ![]() ![]() ![]() |
0..1 | Indication, ProblemObservation, Observation | Directly-embedded Problem or Indication observation. Use EntryReference to reference an existing problem observation or indication described elsewhere in the document. | |
![]() ![]() ![]() ![]() |
0..1 | ObservationMedia | ||
![]() ![]() ![]() ![]() |
0..1 | Organizer | ||
![]() ![]() ![]() ![]() |
0..1 | Procedure | ||
![]() ![]() ![]() ![]() |
0..1 | RegionOfInterest | ||
![]() ![]() ![]() ![]() |
0..1 | SubstanceAdministration | ||
![]() ![]() ![]() ![]() |
0..1 | Supply | ||
![]() ![]() ![]() |
C | 0..* | EntryRelationship | Desired outcome of the plan (CarePlan.goal). Can embed a Goal Observation directly or use the EntryReference template to reference a Goal Observation described elsewhere in the document. Constraints: act-or-observation |
![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |
![]() ![]() ![]() ![]() |
0..* | CS | ||
![]() ![]() ![]() ![]() |
C | 0..1 | II | Constraints: II-1 |
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |
![]() ![]() ![]() ![]() ![]() |
0..1 | st | ||
![]() ![]() ![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
![]() ![]() ![]() ![]() ![]() |
1..1 | st | ||
![]() ![]() ![]() ![]() |
0..* | II | ||
![]() ![]() ![]() ![]() |
1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Required Pattern: GEVL | |
![]() ![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() ![]() |
0..1 | INT | ||
![]() ![]() ![]() ![]() |
0..1 | BL | ||
![]() ![]() ![]() ![]() |
C | 0..1 | EntryReference | Use to reference a Goal Observation elsewhere Constraints: entry-ref-goal |
![]() ![]() ![]() ![]() |
0..1 | Encounter | ||
![]() ![]() ![]() ![]() |
0..1 | GoalObservation | Use to embed a Goal Observation directly | |
![]() ![]() ![]() ![]() |
0..1 | ObservationMedia | ||
![]() ![]() ![]() ![]() |
0..1 | Organizer | ||
![]() ![]() ![]() ![]() |
0..1 | Procedure | ||
![]() ![]() ![]() ![]() |
0..1 | RegionOfInterest | ||
![]() ![]() ![]() ![]() |
0..1 | SubstanceAdministration | ||
![]() ![]() ![]() ![]() |
0..1 | Supply | ||
![]() ![]() ![]() |
0..* | EntryRelationship | Information considered as part of the plan (CarePlan.supportingInfo) | |
![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |
![]() ![]() ![]() ![]() |
0..* | CS | ||
![]() ![]() ![]() ![]() |
C | 0..1 | II | Constraints: II-1 |
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |
![]() ![]() ![]() ![]() ![]() |
0..1 | st | ||
![]() ![]() ![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
![]() ![]() ![]() ![]() ![]() |
1..1 | st | ||
![]() ![]() ![]() ![]() |
0..* | II | ||
![]() ![]() ![]() ![]() |
1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Required Pattern: SPRT | |
![]() ![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() ![]() |
0..1 | INT | ||
![]() ![]() ![]() ![]() |
0..1 | BL | ||
![]() ![]() ![]() ![]() |
0..1 | Act | ||
![]() ![]() ![]() ![]() |
0..1 | Encounter | ||
![]() ![]() ![]() ![]() |
0..1 | Observation | ||
![]() ![]() ![]() ![]() |
0..1 | ObservationMedia | ||
![]() ![]() ![]() ![]() |
0..1 | Organizer | ||
![]() ![]() ![]() ![]() |
0..1 | Procedure | ||
![]() ![]() ![]() ![]() |
0..1 | RegionOfInterest | ||
![]() ![]() ![]() ![]() |
0..1 | SubstanceAdministration | ||
![]() ![]() ![]() ![]() |
0..1 | Supply | ||
![]() ![]() ![]() |
0..* | EntryRelationship | Activity to occur as part of plan (CarePlan.activity). Common examples include the Intervention Act and Planned Intervention Act, but any entry may be considered an activity of the care plan. | |
![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |
![]() ![]() ![]() ![]() |
0..* | CS | ||
![]() ![]() ![]() ![]() |
C | 0..1 | II | Constraints: II-1 |
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |
![]() ![]() ![]() ![]() ![]() |
0..1 | st | ||
![]() ![]() ![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
![]() ![]() ![]() ![]() ![]() |
1..1 | st | ||
![]() ![]() ![]() ![]() |
0..* | II | ||
![]() ![]() ![]() ![]() |
1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Required Pattern: COMP | |
![]() ![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() ![]() |
0..1 | INT | ||
![]() ![]() ![]() ![]() |
0..1 | BL | ||
![]() ![]() ![]() ![]() |
0..1 | InterventionAct, PlannedInterventionAct, Act | A care plan may have multiple COMP entryRelationships, but each entryRelationship may only have a single act/encounter/observation/supply or other clinical statement. | |
![]() ![]() ![]() ![]() |
0..1 | Encounter | A care plan may have multiple COMP entryRelationships, but each entryRelationship may only have a single act/encounter/observation/supply or other clinical statement. | |
![]() ![]() ![]() ![]() |
0..1 | Observation | A care plan may have multiple COMP entryRelationships, but each entryRelationship may only have a single act/encounter/observation/supply or other clinical statement. | |
![]() ![]() ![]() ![]() |
0..1 | ObservationMedia | ||
![]() ![]() ![]() ![]() |
0..1 | Organizer | ||
![]() ![]() ![]() ![]() |
0..1 | Procedure | ||
![]() ![]() ![]() ![]() |
0..1 | RegionOfInterest | ||
![]() ![]() ![]() ![]() |
0..1 | SubstanceAdministration | ||
![]() ![]() ![]() ![]() |
0..1 | Supply | A care plan may have multiple COMP entryRelationships, but each entryRelationship may only have a single act/encounter/observation/supply or other clinical statement. | |
![]() ![]() |
0..* | Reference | ||
![]() ![]() |
0..* | Precondition | ||
![]() ![]() |
0..* | Precondition2 | XML Namespace: urn:hl7-org:sdtc XML: precondition2 (urn:hl7-org:sdtc) | |
![]() ![]() |
0..* | InFulfillmentOf1 | XML Namespace: urn:hl7-org:sdtc XML: inFulfillmentOf1 (urn:hl7-org:sdtc) | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Act.nullFlavor | Base | required | CDANullFlavor | 📦2.0.2-sd | Clinical Document Architecture v2.0 |
| Act.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.2-sd | Clinical Document Architecture v2.0 |
| Act.templateId:care-plan-act.nullFlavor | Base | required | CDANullFlavor | 📦2.0.2-sd | Clinical Document Architecture v2.0 |
| Act.classCode | Base | required | x_ActClassDocumentEntryAct | 📍2.0.0 | THO v5.2 |
| Act.moodCode | Base | required |
Care Plan Mood Codes
|
📦20251123 | VSAC v0.24 |
| Act.code | Base | example | v3 Code System ActCode | 📦3.0.0 | THO v7.0 |
| Act.code.nullFlavor | Base | required | CDANullFlavor | 📦2.0.2-sd | Clinical Document Architecture v2.0 |
| Act.code.translation | Base | preferred | Care Plan Category | 📦5.0.0 | FHIR Std. |
| Act.text.nullFlavor | Base | required | CDANullFlavor | 📦2.0.2-sd | Clinical Document Architecture v2.0 |
| Act.text.compression | Base | required | CDACompressionAlgorithm | 📦2.0.2-sd | Clinical Document Architecture v2.0 |
| Act.text.integrityCheckAlgorithm | Base | required | IntegrityCheckAlgorithm | 📍2.0.0 | THO v5.2 |
| Act.text.mediaType | Base | example | MediaType | 📦3.0.0 | THO v7.0 |
| Act.text.representation | Base | required | CDABinaryDataEncoding | 📦2.0.2-sd | Clinical Document Architecture v2.0 |
| Act.statusCode | Base | required | ActStatus | 📦3.0.0 | THO v7.0 |
| Act.priorityCode | Base | example | ActPriority | 📦3.0.0 | THO v7.0 |
| Act.languageCode | Base | required | All Languages | 📦5.0.0 | FHIR Std. |
| Act.entryRelationship:addresses.nullFlavor | Base | required | CDANullFlavor | 📦2.0.2-sd | Clinical Document Architecture v2.0 |
| Act.entryRelationship:addresses.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.2-sd | Clinical Document Architecture v2.0 |
| Act.entryRelationship:addresses.typeCode | Base | required | x_ActRelationshipEntryRelationship | 📦3.0.0 | THO v7.0 |
| Act.entryRelationship:goal.nullFlavor | Base | required | CDANullFlavor | 📦2.0.2-sd | Clinical Document Architecture v2.0 |
| Act.entryRelationship:goal.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.2-sd | Clinical Document Architecture v2.0 |
| Act.entryRelationship:goal.typeCode | Base | required | x_ActRelationshipEntryRelationship | 📦3.0.0 | THO v7.0 |
| Act.entryRelationship:supportingInfo.nullFlavor | Base | required | CDANullFlavor | 📦2.0.2-sd | Clinical Document Architecture v2.0 |
| Act.entryRelationship:supportingInfo.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.2-sd | Clinical Document Architecture v2.0 |
| Act.entryRelationship:supportingInfo.typeCode | Base | required | x_ActRelationshipEntryRelationship | 📦3.0.0 | THO v7.0 |
| Act.entryRelationship:activity.nullFlavor | Base | required | CDANullFlavor | 📦2.0.2-sd | Clinical Document Architecture v2.0 |
| Act.entryRelationship:activity.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.2-sd | Clinical Document Architecture v2.0 |
| Act.entryRelationship:activity.typeCode | Base | required | x_ActRelationshipEntryRelationship | 📦3.0.0 | THO v7.0 |
| Id | Grade | Path(s) | Description | Expression |
| ED-1 | error | Act.text.thumbnail | Thumbnails cannot contain their own thumbnails |
thumbnail.empty()
|
| II-1 | error | Act.typeId, Act.entryRelationship:addresses.typeId, Act.entryRelationship:goal.typeId, Act.entryRelationship:supportingInfo.typeId, Act.entryRelationship:activity.typeId | An II instance must have either a root or an nullFlavor. |
root.exists() or nullFlavor.exists()
|
| act-or-observation | error | Act.entryRelationship:addresses, Act.entryRelationship:goal | Either act or observation SHALL be present but not both. |
act.exists() or observation.exists()
|
| entry-ref-goal | error | Act.entryRelationship:goal.act | This entryReference template **SHALL** reference an instance of a Goal Observation template. |
%resource.descendants().ofType(CDA.Observation).where(templateId.exists($this.root = '2.16.840.1.113883.10.20.22.4.121' and $this.extension = '2022-06-01') and id.exists($this.root = %context.id.first().root and $this.extension ~ %context.id.first().extension))
|
| should-text-ref-value | warning | Act | SHOULD contain text/reference/@value |
text.reference.value.exists()
|
| value-starts-octothorpe | error | Act.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
value.exists() implies value.startsWith('#')
|
This structure is derived from Act
Summary
Mandatory: 7 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Act
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 1..1 | Act | XML Namespace: urn:hl7-org:v3 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: should-text-ref-value |
![]() ![]() |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
![]() ![]() ![]() |
1..1 | II | ||
![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.518 | |
![]() ![]() ![]() ![]() |
1..1 | st | Required Pattern: 2026-05-01 | |
![]() ![]() |
1..1 | cs | CarePlan.intent Binding: Care Plan Mood Codes (required) | |
![]() ![]() |
1..1 | CD | Plan of care note | |
![]() ![]() ![]() |
1..1 | cs | Required Pattern: 18776-5 | |
![]() ![]() ![]() |
1..1 | oid, uuid, ruid | LOINC Required Pattern: 2.16.840.1.113883.6.1 | |
![]() ![]() ![]() |
0..* | CD | Binding: CarePlanCategory (preferred) | |
![]() ![]() |
C | 0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry |
![]() ![]() ![]() |
C | 0..1 | TEL | Constraints: value-starts-octothorpe |
![]() ![]() |
1..1 | CS | CarePlan.status | |
![]() ![]() |
0..* | AuthorParticipation | CarePlan.contributor | |
![]() ![]() |
0..* | EntryRelationship | Entries can be embedded directly or referenced via EntryReference. Use the @typeCode attribute to distinguish the type of relationship. Slice: Unordered, Open by value:typeCode | |
![]() ![]() ![]() |
C | 0..* | EntryRelationship | 𝗨𝗦𝗖𝗗𝗜: CarePlan.addresses Constraints: act-or-observation |
![]() ![]() ![]() ![]() |
1..1 | cs | Required Pattern: RSON | |
![]() ![]() ![]() ![]() |
0..1 | EntryReference, Act | References an Indication, Problem Observation, or other Problem described elsewhere in the document. | |
![]() ![]() ![]() ![]() |
0..1 | Indication, ProblemObservation, Observation | Directly-embedded Problem or Indication observation. Use EntryReference to reference an existing problem observation or indication described elsewhere in the document. | |
![]() ![]() ![]() |
C | 0..* | EntryRelationship | Desired outcome of the plan (CarePlan.goal). Can embed a Goal Observation directly or use the EntryReference template to reference a Goal Observation described elsewhere in the document. Constraints: act-or-observation |
![]() ![]() ![]() ![]() |
1..1 | cs | Required Pattern: GEVL | |
![]() ![]() ![]() ![]() |
C | 0..1 | EntryReference | Use to reference a Goal Observation elsewhere Constraints: entry-ref-goal |
![]() ![]() ![]() ![]() |
0..1 | GoalObservation | Use to embed a Goal Observation directly | |
![]() ![]() ![]() |
0..* | EntryRelationship | Information considered as part of the plan (CarePlan.supportingInfo) | |
![]() ![]() ![]() ![]() |
1..1 | cs | Required Pattern: SPRT | |
![]() ![]() ![]() |
0..* | EntryRelationship | Activity to occur as part of plan (CarePlan.activity). Common examples include the Intervention Act and Planned Intervention Act, but any entry may be considered an activity of the care plan. | |
![]() ![]() ![]() ![]() |
1..1 | cs | Required Pattern: COMP | |
![]() ![]() ![]() ![]() |
0..1 | InterventionAct, PlannedInterventionAct, Act | A care plan may have multiple COMP entryRelationships, but each entryRelationship may only have a single act/encounter/observation/supply or other clinical statement. | |
![]() ![]() ![]() ![]() |
0..1 | Encounter | A care plan may have multiple COMP entryRelationships, but each entryRelationship may only have a single act/encounter/observation/supply or other clinical statement. | |
![]() ![]() ![]() ![]() |
0..1 | Observation | A care plan may have multiple COMP entryRelationships, but each entryRelationship may only have a single act/encounter/observation/supply or other clinical statement. | |
![]() ![]() ![]() ![]() |
0..1 | Supply | A care plan may have multiple COMP entryRelationships, but each entryRelationship may only have a single act/encounter/observation/supply or other clinical statement. | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Act.moodCode | Base | required |
Care Plan Mood Codes
|
📦20251123 | VSAC v0.24 |
| Act.code.translation | Base | preferred | Care Plan Category | 📦5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| act-or-observation | error | Act.entryRelationship:addresses, Act.entryRelationship:goal | Either act or observation SHALL be present but not both. |
act.exists() or observation.exists()
|
| entry-ref-goal | error | Act.entryRelationship:goal.act | This entryReference template **SHALL** reference an instance of a Goal Observation template. |
%resource.descendants().ofType(CDA.Observation).where(templateId.exists($this.root = '2.16.840.1.113883.10.20.22.4.121' and $this.extension = '2022-06-01') and id.exists($this.root = %context.id.first().root and $this.extension ~ %context.id.first().extension))
|
| should-text-ref-value | warning | Act | SHOULD contain text/reference/@value |
text.reference.value.exists()
|
| value-starts-octothorpe | error | Act.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
value.exists() implies value.startsWith('#')
|
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 1..1 | Act | XML Namespace: urn:hl7-org:v3 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: should-text-ref-value |
![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |
![]() ![]() |
0..* | CS | ||
![]() ![]() |
C | 0..1 | II | Constraints: II-1 |
![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |
![]() ![]() ![]() |
0..1 | st | ||
![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
![]() ![]() ![]() |
1..1 | st | ||
![]() ![]() |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
![]() ![]() ![]() |
1..1 | II | ||
![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |
![]() ![]() ![]() ![]() |
0..1 | st | ||
![]() ![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.518 | |
![]() ![]() ![]() ![]() |
1..1 | st | Required Pattern: 2026-05-01 | |
![]() ![]() |
1..1 | cs | Binding: XActClassDocumentEntryAct (2.0.0) (required) | |
![]() ![]() |
1..1 | cs | CarePlan.intent Binding: Care Plan Mood Codes (required) | |
![]() ![]() |
0..1 | bl | ||
![]() ![]() |
0..* | II | ||
![]() ![]() |
1..1 | CD | Plan of care note Binding: v3 Code System ActCode (example) | |
![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |
![]() ![]() ![]() |
1..1 | cs | Required Pattern: 18776-5 | |
![]() ![]() ![]() |
1..1 | oid, uuid, ruid | LOINC Required Pattern: 2.16.840.1.113883.6.1 | |
![]() ![]() ![]() |
0..1 | st | ||
![]() ![]() ![]() |
0..1 | st | ||
![]() ![]() ![]() |
0..1 | st | ||
![]() ![]() ![]() |
0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
![]() ![]() ![]() |
0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
![]() ![]() ![]() |
0..1 | ED | ||
![]() ![]() ![]() |
0..* | CR | ||
![]() ![]() ![]() |
0..* | CD | Binding: CarePlanCategory (preferred) | |
![]() ![]() |
C | 0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry |
![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |
![]() ![]() ![]() |
0..1 | cs | Binding: CDACompressionAlgorithm (required) | |
![]() ![]() ![]() |
0..1 | bin | ||
![]() ![]() ![]() |
0..1 | cs | Binding: IntegrityCheckAlgorithm (2.0.0) (required) | |
![]() ![]() ![]() |
0..1 | cs | ||
![]() ![]() ![]() |
0..1 | cs | Binding: MediaType (example) | |
![]() ![]() ![]() |
0..1 | cs | Binding: CDABinaryDataEncoding (required) | |
![]() ![]() ![]() |
0..1 | st | Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string. | |
![]() ![]() ![]() |
C | 0..1 | TEL | Constraints: value-starts-octothorpe |
![]() ![]() ![]() |
C | 0..1 | ED | Constraints: ED-1 |
![]() ![]() |
1..1 | CS | CarePlan.status Binding: ActStatus (required) | |
![]() ![]() |
0..1 | IVL_TS | ||
![]() ![]() |
0..1 | CE | Binding: ActPriority (example) | |
![]() ![]() |
0..1 | CS | Binding: AllLanguages (required) | |
![]() ![]() |
0..1 | Subject | ||
![]() ![]() |
0..* | Specimen | ||
![]() ![]() |
0..* | Performer2 | ||
![]() ![]() |
0..* | AuthorParticipation | CarePlan.contributor | |
![]() ![]() |
0..* | Informant | ||
![]() ![]() |
0..* | Participant2 | ||
![]() ![]() |
0..* | EntryRelationship | Entries can be embedded directly or referenced via EntryReference. Use the @typeCode attribute to distinguish the type of relationship. Slice: Unordered, Open by value:typeCode | |
![]() ![]() ![]() |
C | 0..* | EntryRelationship | 𝗨𝗦𝗖𝗗𝗜: CarePlan.addresses Constraints: act-or-observation |
![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |
![]() ![]() ![]() ![]() |
0..* | CS | ||
![]() ![]() ![]() ![]() |
C | 0..1 | II | Constraints: II-1 |
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |
![]() ![]() ![]() ![]() ![]() |
0..1 | st | ||
![]() ![]() ![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
![]() ![]() ![]() ![]() ![]() |
1..1 | st | ||
![]() ![]() ![]() ![]() |
0..* | II | ||
![]() ![]() ![]() ![]() |
1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Required Pattern: RSON | |
![]() ![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() ![]() |
0..1 | INT | ||
![]() ![]() ![]() ![]() |
0..1 | BL | ||
![]() ![]() ![]() ![]() |
0..1 | EntryReference, Act | References an Indication, Problem Observation, or other Problem described elsewhere in the document. | |
![]() ![]() ![]() ![]() |
0..1 | Encounter | ||
![]() ![]() ![]() ![]() |
0..1 | Indication, ProblemObservation, Observation | Directly-embedded Problem or Indication observation. Use EntryReference to reference an existing problem observation or indication described elsewhere in the document. | |
![]() ![]() ![]() ![]() |
0..1 | ObservationMedia | ||
![]() ![]() ![]() ![]() |
0..1 | Organizer | ||
![]() ![]() ![]() ![]() |
0..1 | Procedure | ||
![]() ![]() ![]() ![]() |
0..1 | RegionOfInterest | ||
![]() ![]() ![]() ![]() |
0..1 | SubstanceAdministration | ||
![]() ![]() ![]() ![]() |
0..1 | Supply | ||
![]() ![]() ![]() |
C | 0..* | EntryRelationship | Desired outcome of the plan (CarePlan.goal). Can embed a Goal Observation directly or use the EntryReference template to reference a Goal Observation described elsewhere in the document. Constraints: act-or-observation |
![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |
![]() ![]() ![]() ![]() |
0..* | CS | ||
![]() ![]() ![]() ![]() |
C | 0..1 | II | Constraints: II-1 |
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |
![]() ![]() ![]() ![]() ![]() |
0..1 | st | ||
![]() ![]() ![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
![]() ![]() ![]() ![]() ![]() |
1..1 | st | ||
![]() ![]() ![]() ![]() |
0..* | II | ||
![]() ![]() ![]() ![]() |
1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Required Pattern: GEVL | |
![]() ![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() ![]() |
0..1 | INT | ||
![]() ![]() ![]() ![]() |
0..1 | BL | ||
![]() ![]() ![]() ![]() |
C | 0..1 | EntryReference | Use to reference a Goal Observation elsewhere Constraints: entry-ref-goal |
![]() ![]() ![]() ![]() |
0..1 | Encounter | ||
![]() ![]() ![]() ![]() |
0..1 | GoalObservation | Use to embed a Goal Observation directly | |
![]() ![]() ![]() ![]() |
0..1 | ObservationMedia | ||
![]() ![]() ![]() ![]() |
0..1 | Organizer | ||
![]() ![]() ![]() ![]() |
0..1 | Procedure | ||
![]() ![]() ![]() ![]() |
0..1 | RegionOfInterest | ||
![]() ![]() ![]() ![]() |
0..1 | SubstanceAdministration | ||
![]() ![]() ![]() ![]() |
0..1 | Supply | ||
![]() ![]() ![]() |
0..* | EntryRelationship | Information considered as part of the plan (CarePlan.supportingInfo) | |
![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |
![]() ![]() ![]() ![]() |
0..* | CS | ||
![]() ![]() ![]() ![]() |
C | 0..1 | II | Constraints: II-1 |
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |
![]() ![]() ![]() ![]() ![]() |
0..1 | st | ||
![]() ![]() ![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
![]() ![]() ![]() ![]() ![]() |
1..1 | st | ||
![]() ![]() ![]() ![]() |
0..* | II | ||
![]() ![]() ![]() ![]() |
1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Required Pattern: SPRT | |
![]() ![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() ![]() |
0..1 | INT | ||
![]() ![]() ![]() ![]() |
0..1 | BL | ||
![]() ![]() ![]() ![]() |
0..1 | Act | ||
![]() ![]() ![]() ![]() |
0..1 | Encounter | ||
![]() ![]() ![]() ![]() |
0..1 | Observation | ||
![]() ![]() ![]() ![]() |
0..1 | ObservationMedia | ||
![]() ![]() ![]() ![]() |
0..1 | Organizer | ||
![]() ![]() ![]() ![]() |
0..1 | Procedure | ||
![]() ![]() ![]() ![]() |
0..1 | RegionOfInterest | ||
![]() ![]() ![]() ![]() |
0..1 | SubstanceAdministration | ||
![]() ![]() ![]() ![]() |
0..1 | Supply | ||
![]() ![]() ![]() |
0..* | EntryRelationship | Activity to occur as part of plan (CarePlan.activity). Common examples include the Intervention Act and Planned Intervention Act, but any entry may be considered an activity of the care plan. | |
![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |
![]() ![]() ![]() ![]() |
0..* | CS | ||
![]() ![]() ![]() ![]() |
C | 0..1 | II | Constraints: II-1 |
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |
![]() ![]() ![]() ![]() ![]() |
0..1 | st | ||
![]() ![]() ![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
![]() ![]() ![]() ![]() ![]() |
1..1 | st | ||
![]() ![]() ![]() ![]() |
0..* | II | ||
![]() ![]() ![]() ![]() |
1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Required Pattern: COMP | |
![]() ![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() ![]() |
0..1 | INT | ||
![]() ![]() ![]() ![]() |
0..1 | BL | ||
![]() ![]() ![]() ![]() |
0..1 | InterventionAct, PlannedInterventionAct, Act | A care plan may have multiple COMP entryRelationships, but each entryRelationship may only have a single act/encounter/observation/supply or other clinical statement. | |
![]() ![]() ![]() ![]() |
0..1 | Encounter | A care plan may have multiple COMP entryRelationships, but each entryRelationship may only have a single act/encounter/observation/supply or other clinical statement. | |
![]() ![]() ![]() ![]() |
0..1 | Observation | A care plan may have multiple COMP entryRelationships, but each entryRelationship may only have a single act/encounter/observation/supply or other clinical statement. | |
![]() ![]() ![]() ![]() |
0..1 | ObservationMedia | ||
![]() ![]() ![]() ![]() |
0..1 | Organizer | ||
![]() ![]() ![]() ![]() |
0..1 | Procedure | ||
![]() ![]() ![]() ![]() |
0..1 | RegionOfInterest | ||
![]() ![]() ![]() ![]() |
0..1 | SubstanceAdministration | ||
![]() ![]() ![]() ![]() |
0..1 | Supply | A care plan may have multiple COMP entryRelationships, but each entryRelationship may only have a single act/encounter/observation/supply or other clinical statement. | |
![]() ![]() |
0..* | Reference | ||
![]() ![]() |
0..* | Precondition | ||
![]() ![]() |
0..* | Precondition2 | XML Namespace: urn:hl7-org:sdtc XML: precondition2 (urn:hl7-org:sdtc) | |
![]() ![]() |
0..* | InFulfillmentOf1 | XML Namespace: urn:hl7-org:sdtc XML: inFulfillmentOf1 (urn:hl7-org:sdtc) | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Act.nullFlavor | Base | required | CDANullFlavor | 📦2.0.2-sd | Clinical Document Architecture v2.0 |
| Act.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.2-sd | Clinical Document Architecture v2.0 |
| Act.templateId:care-plan-act.nullFlavor | Base | required | CDANullFlavor | 📦2.0.2-sd | Clinical Document Architecture v2.0 |
| Act.classCode | Base | required | x_ActClassDocumentEntryAct | 📍2.0.0 | THO v5.2 |
| Act.moodCode | Base | required |
Care Plan Mood Codes
|
📦20251123 | VSAC v0.24 |
| Act.code | Base | example | v3 Code System ActCode | 📦3.0.0 | THO v7.0 |
| Act.code.nullFlavor | Base | required | CDANullFlavor | 📦2.0.2-sd | Clinical Document Architecture v2.0 |
| Act.code.translation | Base | preferred | Care Plan Category | 📦5.0.0 | FHIR Std. |
| Act.text.nullFlavor | Base | required | CDANullFlavor | 📦2.0.2-sd | Clinical Document Architecture v2.0 |
| Act.text.compression | Base | required | CDACompressionAlgorithm | 📦2.0.2-sd | Clinical Document Architecture v2.0 |
| Act.text.integrityCheckAlgorithm | Base | required | IntegrityCheckAlgorithm | 📍2.0.0 | THO v5.2 |
| Act.text.mediaType | Base | example | MediaType | 📦3.0.0 | THO v7.0 |
| Act.text.representation | Base | required | CDABinaryDataEncoding | 📦2.0.2-sd | Clinical Document Architecture v2.0 |
| Act.statusCode | Base | required | ActStatus | 📦3.0.0 | THO v7.0 |
| Act.priorityCode | Base | example | ActPriority | 📦3.0.0 | THO v7.0 |
| Act.languageCode | Base | required | All Languages | 📦5.0.0 | FHIR Std. |
| Act.entryRelationship:addresses.nullFlavor | Base | required | CDANullFlavor | 📦2.0.2-sd | Clinical Document Architecture v2.0 |
| Act.entryRelationship:addresses.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.2-sd | Clinical Document Architecture v2.0 |
| Act.entryRelationship:addresses.typeCode | Base | required | x_ActRelationshipEntryRelationship | 📦3.0.0 | THO v7.0 |
| Act.entryRelationship:goal.nullFlavor | Base | required | CDANullFlavor | 📦2.0.2-sd | Clinical Document Architecture v2.0 |
| Act.entryRelationship:goal.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.2-sd | Clinical Document Architecture v2.0 |
| Act.entryRelationship:goal.typeCode | Base | required | x_ActRelationshipEntryRelationship | 📦3.0.0 | THO v7.0 |
| Act.entryRelationship:supportingInfo.nullFlavor | Base | required | CDANullFlavor | 📦2.0.2-sd | Clinical Document Architecture v2.0 |
| Act.entryRelationship:supportingInfo.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.2-sd | Clinical Document Architecture v2.0 |
| Act.entryRelationship:supportingInfo.typeCode | Base | required | x_ActRelationshipEntryRelationship | 📦3.0.0 | THO v7.0 |
| Act.entryRelationship:activity.nullFlavor | Base | required | CDANullFlavor | 📦2.0.2-sd | Clinical Document Architecture v2.0 |
| Act.entryRelationship:activity.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.2-sd | Clinical Document Architecture v2.0 |
| Act.entryRelationship:activity.typeCode | Base | required | x_ActRelationshipEntryRelationship | 📦3.0.0 | THO v7.0 |
| Id | Grade | Path(s) | Description | Expression |
| ED-1 | error | Act.text.thumbnail | Thumbnails cannot contain their own thumbnails |
thumbnail.empty()
|
| II-1 | error | Act.typeId, Act.entryRelationship:addresses.typeId, Act.entryRelationship:goal.typeId, Act.entryRelationship:supportingInfo.typeId, Act.entryRelationship:activity.typeId | An II instance must have either a root or an nullFlavor. |
root.exists() or nullFlavor.exists()
|
| act-or-observation | error | Act.entryRelationship:addresses, Act.entryRelationship:goal | Either act or observation SHALL be present but not both. |
act.exists() or observation.exists()
|
| entry-ref-goal | error | Act.entryRelationship:goal.act | This entryReference template **SHALL** reference an instance of a Goal Observation template. |
%resource.descendants().ofType(CDA.Observation).where(templateId.exists($this.root = '2.16.840.1.113883.10.20.22.4.121' and $this.extension = '2022-06-01') and id.exists($this.root = %context.id.first().root and $this.extension ~ %context.id.first().extension))
|
| should-text-ref-value | warning | Act | SHOULD contain text/reference/@value |
text.reference.value.exists()
|
| value-starts-octothorpe | error | Act.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
value.exists() implies value.startsWith('#')
|
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 1..1 | Act | XML Namespace: urn:hl7-org:v3 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: should-text-ref-value |
![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |
![]() ![]() |
0..* | CS | ||
![]() ![]() |
C | 0..1 | II | Constraints: II-1 |
![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |
![]() ![]() ![]() |
0..1 | st | ||
![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
![]() ![]() ![]() |
1..1 | st | ||
![]() ![]() |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
![]() ![]() ![]() |
1..1 | II | ||
![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |
![]() ![]() ![]() ![]() |
0..1 | st | ||
![]() ![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.518 | |
![]() ![]() ![]() ![]() |
1..1 | st | Required Pattern: 2026-05-01 | |
![]() ![]() |
1..1 | cs | Binding: XActClassDocumentEntryAct (2.0.0) (required) | |
![]() ![]() |
1..1 | cs | CarePlan.intent Binding: Care Plan Mood Codes (required) | |
![]() ![]() |
0..1 | bl | ||
![]() ![]() |
0..* | II | ||
![]() ![]() |
1..1 | CD | Plan of care note Binding: v3 Code System ActCode (example) | |
![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |
![]() ![]() ![]() |
1..1 | cs | Required Pattern: 18776-5 | |
![]() ![]() ![]() |
1..1 | oid, uuid, ruid | LOINC Required Pattern: 2.16.840.1.113883.6.1 | |
![]() ![]() ![]() |
0..1 | st | ||
![]() ![]() ![]() |
0..1 | st | ||
![]() ![]() ![]() |
0..1 | st | ||
![]() ![]() ![]() |
0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
![]() ![]() ![]() |
0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
![]() ![]() ![]() |
0..1 | ED | ||
![]() ![]() ![]() |
0..* | CR | ||
![]() ![]() ![]() |
0..* | CD | Binding: CarePlanCategory (preferred) | |
![]() ![]() |
C | 0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry |
![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |
![]() ![]() ![]() |
0..1 | cs | Binding: CDACompressionAlgorithm (required) | |
![]() ![]() ![]() |
0..1 | bin | ||
![]() ![]() ![]() |
0..1 | cs | Binding: IntegrityCheckAlgorithm (2.0.0) (required) | |
![]() ![]() ![]() |
0..1 | cs | ||
![]() ![]() ![]() |
0..1 | cs | Binding: MediaType (example) | |
![]() ![]() ![]() |
0..1 | cs | Binding: CDABinaryDataEncoding (required) | |
![]() ![]() ![]() |
0..1 | st | Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string. | |
![]() ![]() ![]() |
C | 0..1 | TEL | Constraints: value-starts-octothorpe |
![]() ![]() ![]() |
C | 0..1 | ED | Constraints: ED-1 |
![]() ![]() |
1..1 | CS | CarePlan.status Binding: ActStatus (required) | |
![]() ![]() |
0..1 | IVL_TS | ||
![]() ![]() |
0..1 | CE | Binding: ActPriority (example) | |
![]() ![]() |
0..1 | CS | Binding: AllLanguages (required) | |
![]() ![]() |
0..1 | Subject | ||
![]() ![]() |
0..* | Specimen | ||
![]() ![]() |
0..* | Performer2 | ||
![]() ![]() |
0..* | AuthorParticipation | CarePlan.contributor | |
![]() ![]() |
0..* | Informant | ||
![]() ![]() |
0..* | Participant2 | ||
![]() ![]() |
0..* | EntryRelationship | Entries can be embedded directly or referenced via EntryReference. Use the @typeCode attribute to distinguish the type of relationship. Slice: Unordered, Open by value:typeCode | |
![]() ![]() ![]() |
C | 0..* | EntryRelationship | 𝗨𝗦𝗖𝗗𝗜: CarePlan.addresses Constraints: act-or-observation |
![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |
![]() ![]() ![]() ![]() |
0..* | CS | ||
![]() ![]() ![]() ![]() |
C | 0..1 | II | Constraints: II-1 |
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |
![]() ![]() ![]() ![]() ![]() |
0..1 | st | ||
![]() ![]() ![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
![]() ![]() ![]() ![]() ![]() |
1..1 | st | ||
![]() ![]() ![]() ![]() |
0..* | II | ||
![]() ![]() ![]() ![]() |
1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Required Pattern: RSON | |
![]() ![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() ![]() |
0..1 | INT | ||
![]() ![]() ![]() ![]() |
0..1 | BL | ||
![]() ![]() ![]() ![]() |
0..1 | EntryReference, Act | References an Indication, Problem Observation, or other Problem described elsewhere in the document. | |
![]() ![]() ![]() ![]() |
0..1 | Encounter | ||
![]() ![]() ![]() ![]() |
0..1 | Indication, ProblemObservation, Observation | Directly-embedded Problem or Indication observation. Use EntryReference to reference an existing problem observation or indication described elsewhere in the document. | |
![]() ![]() ![]() ![]() |
0..1 | ObservationMedia | ||
![]() ![]() ![]() ![]() |
0..1 | Organizer | ||
![]() ![]() ![]() ![]() |
0..1 | Procedure | ||
![]() ![]() ![]() ![]() |
0..1 | RegionOfInterest | ||
![]() ![]() ![]() ![]() |
0..1 | SubstanceAdministration | ||
![]() ![]() ![]() ![]() |
0..1 | Supply | ||
![]() ![]() ![]() |
C | 0..* | EntryRelationship | Desired outcome of the plan (CarePlan.goal). Can embed a Goal Observation directly or use the EntryReference template to reference a Goal Observation described elsewhere in the document. Constraints: act-or-observation |
![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |
![]() ![]() ![]() ![]() |
0..* | CS | ||
![]() ![]() ![]() ![]() |
C | 0..1 | II | Constraints: II-1 |
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |
![]() ![]() ![]() ![]() ![]() |
0..1 | st | ||
![]() ![]() ![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
![]() ![]() ![]() ![]() ![]() |
1..1 | st | ||
![]() ![]() ![]() ![]() |
0..* | II | ||
![]() ![]() ![]() ![]() |
1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Required Pattern: GEVL | |
![]() ![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() ![]() |
0..1 | INT | ||
![]() ![]() ![]() ![]() |
0..1 | BL | ||
![]() ![]() ![]() ![]() |
C | 0..1 | EntryReference | Use to reference a Goal Observation elsewhere Constraints: entry-ref-goal |
![]() ![]() ![]() ![]() |
0..1 | Encounter | ||
![]() ![]() ![]() ![]() |
0..1 | GoalObservation | Use to embed a Goal Observation directly | |
![]() ![]() ![]() ![]() |
0..1 | ObservationMedia | ||
![]() ![]() ![]() ![]() |
0..1 | Organizer | ||
![]() ![]() ![]() ![]() |
0..1 | Procedure | ||
![]() ![]() ![]() ![]() |
0..1 | RegionOfInterest | ||
![]() ![]() ![]() ![]() |
0..1 | SubstanceAdministration | ||
![]() ![]() ![]() ![]() |
0..1 | Supply | ||
![]() ![]() ![]() |
0..* | EntryRelationship | Information considered as part of the plan (CarePlan.supportingInfo) | |
![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |
![]() ![]() ![]() ![]() |
0..* | CS | ||
![]() ![]() ![]() ![]() |
C | 0..1 | II | Constraints: II-1 |
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |
![]() ![]() ![]() ![]() ![]() |
0..1 | st | ||
![]() ![]() ![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
![]() ![]() ![]() ![]() ![]() |
1..1 | st | ||
![]() ![]() ![]() ![]() |
0..* | II | ||
![]() ![]() ![]() ![]() |
1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Required Pattern: SPRT | |
![]() ![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() ![]() |
0..1 | INT | ||
![]() ![]() ![]() ![]() |
0..1 | BL | ||
![]() ![]() ![]() ![]() |
0..1 | Act | ||
![]() ![]() ![]() ![]() |
0..1 | Encounter | ||
![]() ![]() ![]() ![]() |
0..1 | Observation | ||
![]() ![]() ![]() ![]() |
0..1 | ObservationMedia | ||
![]() ![]() ![]() ![]() |
0..1 | Organizer | ||
![]() ![]() ![]() ![]() |
0..1 | Procedure | ||
![]() ![]() ![]() ![]() |
0..1 | RegionOfInterest | ||
![]() ![]() ![]() ![]() |
0..1 | SubstanceAdministration | ||
![]() ![]() ![]() ![]() |
0..1 | Supply | ||
![]() ![]() ![]() |
0..* | EntryRelationship | Activity to occur as part of plan (CarePlan.activity). Common examples include the Intervention Act and Planned Intervention Act, but any entry may be considered an activity of the care plan. | |
![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |
![]() ![]() ![]() ![]() |
0..* | CS | ||
![]() ![]() ![]() ![]() |
C | 0..1 | II | Constraints: II-1 |
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |
![]() ![]() ![]() ![]() ![]() |
0..1 | st | ||
![]() ![]() ![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
![]() ![]() ![]() ![]() ![]() |
1..1 | st | ||
![]() ![]() ![]() ![]() |
0..* | II | ||
![]() ![]() ![]() ![]() |
1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Required Pattern: COMP | |
![]() ![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() ![]() |
0..1 | INT | ||
![]() ![]() ![]() ![]() |
0..1 | BL | ||
![]() ![]() ![]() ![]() |
0..1 | InterventionAct, PlannedInterventionAct, Act | A care plan may have multiple COMP entryRelationships, but each entryRelationship may only have a single act/encounter/observation/supply or other clinical statement. | |
![]() ![]() ![]() ![]() |
0..1 | Encounter | A care plan may have multiple COMP entryRelationships, but each entryRelationship may only have a single act/encounter/observation/supply or other clinical statement. | |
![]() ![]() ![]() ![]() |
0..1 | Observation | A care plan may have multiple COMP entryRelationships, but each entryRelationship may only have a single act/encounter/observation/supply or other clinical statement. | |
![]() ![]() ![]() ![]() |
0..1 | ObservationMedia | ||
![]() ![]() ![]() ![]() |
0..1 | Organizer | ||
![]() ![]() ![]() ![]() |
0..1 | Procedure | ||
![]() ![]() ![]() ![]() |
0..1 | RegionOfInterest | ||
![]() ![]() ![]() ![]() |
0..1 | SubstanceAdministration | ||
![]() ![]() ![]() ![]() |
0..1 | Supply | A care plan may have multiple COMP entryRelationships, but each entryRelationship may only have a single act/encounter/observation/supply or other clinical statement. | |
![]() ![]() |
0..* | Reference | ||
![]() ![]() |
0..* | Precondition | ||
![]() ![]() |
0..* | Precondition2 | XML Namespace: urn:hl7-org:sdtc XML: precondition2 (urn:hl7-org:sdtc) | |
![]() ![]() |
0..* | InFulfillmentOf1 | XML Namespace: urn:hl7-org:sdtc XML: inFulfillmentOf1 (urn:hl7-org:sdtc) | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Act.nullFlavor | Base | required | CDANullFlavor | 📦2.0.2-sd | Clinical Document Architecture v2.0 |
| Act.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.2-sd | Clinical Document Architecture v2.0 |
| Act.templateId:care-plan-act.nullFlavor | Base | required | CDANullFlavor | 📦2.0.2-sd | Clinical Document Architecture v2.0 |
| Act.classCode | Base | required | x_ActClassDocumentEntryAct | 📍2.0.0 | THO v5.2 |
| Act.moodCode | Base | required |
Care Plan Mood Codes
|
📦20251123 | VSAC v0.24 |
| Act.code | Base | example | v3 Code System ActCode | 📦3.0.0 | THO v7.0 |
| Act.code.nullFlavor | Base | required | CDANullFlavor | 📦2.0.2-sd | Clinical Document Architecture v2.0 |
| Act.code.translation | Base | preferred | Care Plan Category | 📦5.0.0 | FHIR Std. |
| Act.text.nullFlavor | Base | required | CDANullFlavor | 📦2.0.2-sd | Clinical Document Architecture v2.0 |
| Act.text.compression | Base | required | CDACompressionAlgorithm | 📦2.0.2-sd | Clinical Document Architecture v2.0 |
| Act.text.integrityCheckAlgorithm | Base | required | IntegrityCheckAlgorithm | 📍2.0.0 | THO v5.2 |
| Act.text.mediaType | Base | example | MediaType | 📦3.0.0 | THO v7.0 |
| Act.text.representation | Base | required | CDABinaryDataEncoding | 📦2.0.2-sd | Clinical Document Architecture v2.0 |
| Act.statusCode | Base | required | ActStatus | 📦3.0.0 | THO v7.0 |
| Act.priorityCode | Base | example | ActPriority | 📦3.0.0 | THO v7.0 |
| Act.languageCode | Base | required | All Languages | 📦5.0.0 | FHIR Std. |
| Act.entryRelationship:addresses.nullFlavor | Base | required | CDANullFlavor | 📦2.0.2-sd | Clinical Document Architecture v2.0 |
| Act.entryRelationship:addresses.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.2-sd | Clinical Document Architecture v2.0 |
| Act.entryRelationship:addresses.typeCode | Base | required | x_ActRelationshipEntryRelationship | 📦3.0.0 | THO v7.0 |
| Act.entryRelationship:goal.nullFlavor | Base | required | CDANullFlavor | 📦2.0.2-sd | Clinical Document Architecture v2.0 |
| Act.entryRelationship:goal.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.2-sd | Clinical Document Architecture v2.0 |
| Act.entryRelationship:goal.typeCode | Base | required | x_ActRelationshipEntryRelationship | 📦3.0.0 | THO v7.0 |
| Act.entryRelationship:supportingInfo.nullFlavor | Base | required | CDANullFlavor | 📦2.0.2-sd | Clinical Document Architecture v2.0 |
| Act.entryRelationship:supportingInfo.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.2-sd | Clinical Document Architecture v2.0 |
| Act.entryRelationship:supportingInfo.typeCode | Base | required | x_ActRelationshipEntryRelationship | 📦3.0.0 | THO v7.0 |
| Act.entryRelationship:activity.nullFlavor | Base | required | CDANullFlavor | 📦2.0.2-sd | Clinical Document Architecture v2.0 |
| Act.entryRelationship:activity.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.2-sd | Clinical Document Architecture v2.0 |
| Act.entryRelationship:activity.typeCode | Base | required | x_ActRelationshipEntryRelationship | 📦3.0.0 | THO v7.0 |
| Id | Grade | Path(s) | Description | Expression |
| ED-1 | error | Act.text.thumbnail | Thumbnails cannot contain their own thumbnails |
thumbnail.empty()
|
| II-1 | error | Act.typeId, Act.entryRelationship:addresses.typeId, Act.entryRelationship:goal.typeId, Act.entryRelationship:supportingInfo.typeId, Act.entryRelationship:activity.typeId | An II instance must have either a root or an nullFlavor. |
root.exists() or nullFlavor.exists()
|
| act-or-observation | error | Act.entryRelationship:addresses, Act.entryRelationship:goal | Either act or observation SHALL be present but not both. |
act.exists() or observation.exists()
|
| entry-ref-goal | error | Act.entryRelationship:goal.act | This entryReference template **SHALL** reference an instance of a Goal Observation template. |
%resource.descendants().ofType(CDA.Observation).where(templateId.exists($this.root = '2.16.840.1.113883.10.20.22.4.121' and $this.extension = '2022-06-01') and id.exists($this.root = %context.id.first().root and $this.extension ~ %context.id.first().extension))
|
| should-text-ref-value | warning | Act | SHOULD contain text/reference/@value |
text.reference.value.exists()
|
| value-starts-octothorpe | error | Act.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
value.exists() implies value.startsWith('#')
|
This structure is derived from Act
Summary
Mandatory: 7 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices: