Consolidated CDA Release 2.1 StructureDefinition Publication
2.1 - CI Build
Consolidated CDA Release 2.1 StructureDefinition Publication
2.1 - CI Build
Consolidated CDA Release 2.1 StructureDefinition Publication, published by Health Level Seven. This is not an authorized publication; it is the continuous build for version 2.1). This version is based on the current content of https://github.com/HL7/CDA-ccda-2.1-sd/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/PlannedAct | Version: 2.1 | |||
| Draft as of 2023-09-29 | Computable Name: PlannedAct | |||
| Other Identifiers: id: urn:hl7ii:2.16.840.1.113883.10.20.22.4.39:2014-06-09 | ||||
This template represents planned acts that are not classified as an observation or a procedure according to the HL7 RIM. Examples of these acts are a dressing change, the teaching or feeding of a patient or the providing of comfort measures. The priority of the activity to the patient and provider is communicated through Priority Preference. The effectiveTime indicates the time when the activity is intended to take place.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CDAR2.Act
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Act | CDAR2.Act | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, @classCode, @moodCode, realmCode, typeId, templateId, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition | ||
 classCode | 1..1 | cs | Fixed Value: ACT | |
| moodCode | 1..1 | cs | Binding: Planned moodCode (Act/Encounter/Procedure) (required) | |
  Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
   templateId:primary | 1..1 | II | ||
  root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.39 | |
  extension | 1..1 | st | Required Pattern: 2014-06-09 | |
| id | 1..* | II | ||
| code | C | 1..1 | CD | 1098-32030: This code in a Planned Act **SHOULD** be selected from LOINC (CodeSystem: 2.16.840.1.113883.6.1) *OR* SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96) (CONF:1098-32030). |
| statusCode | 1..1 | CS | ||
 code | 1..1 | cs | Fixed Value: active | |
| effectiveTime | 0..1 | IVL_TS | The effectiveTime in a planned act represents the time that the act should occur. | |
| performer | 0..* | Performer2 | The clinician who is expected to carry out the act could be identified using act/performer. | |
 author | 0..1 | AuthorParticipation | The author in a planned act represents the clinician who is requesting or planning the act. | |
 Slices for entryRelationship | 0..* | EntryRelationship | The following entryRelationship captures any instructions associated with the planned act. Slice: Unordered, Open by profile:act | |
 entryRelationship:priorityPreference | 0..* | EntryRelationship | The following entryRelationship represents the priority that a patient or a provider places on the activity. | |
 typeCode | 1..1 | cs | Fixed Value: REFR | |
| observation | 1..1 | PriorityPreference | Base for all types and resources | |
| entryRelationship:indication | 0..* | EntryRelationship | The following entryRelationship represents the indication for the act. | |
| typeCode | 1..1 | cs | Fixed Value: RSON | |
| observation | 1..1 | Indication | Base for all types and resources | |
| entryRelationship:instruction | 0..* | EntryRelationship | ||
| typeCode | 1..1 | cs | Fixed Value: SUBJ | |
| act | 1..1 | Instruction | Base for all types and resources | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Act.moodCode | required | Planned moodCode (Act/Encounter/Procedure) |
| Id | Grade | Path(s) | Details | Requirements |
| 1098-32030 | warning | Act.code | This code in a Planned Act **SHOULD** be selected from LOINC (CodeSystem: 2.16.840.1.113883.6.1) *OR* SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96) (CONF:1098-32030). : |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Act | 1..1 | CDAR2.Act | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, @classCode, @moodCode, realmCode, typeId, templateId, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition Base for all types and resources | |
 @classCode | 1..1 | cs | Fixed Value: ACT | |
| @moodCode | 1..1 | cs | Binding: Planned moodCode (Act/Encounter/Procedure) (required) | |
| Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:primary | 1..1 | II | ||
| @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.39 | |
| @extension | 1..1 | st | Required Pattern: 2014-06-09 | |
| id | 1..* | II | ||
| code | C | 1..1 | CD | Binding: v3 Code System ActCode (extensible) 1098-32030: This code in a Planned Act **SHOULD** be selected from LOINC (CodeSystem: 2.16.840.1.113883.6.1) *OR* SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96) (CONF:1098-32030). |
| statusCode | 1..1 | CS | Binding: ActStatus (required) | |
| @code | 1..1 | cs | Fixed Value: active | |
| effectiveTime | 0..1 | IVL_TS | The effectiveTime in a planned act represents the time that the act should occur. | |
| performer | 0..* | Performer2 | The clinician who is expected to carry out the act could be identified using act/performer. | |
| author | 0..1 | AuthorParticipation | The author in a planned act represents the clinician who is requesting or planning the act. | |
| Slices for entryRelationship | 0..* | EntryRelationship | The following entryRelationship captures any instructions associated with the planned act. Slice: Unordered, Open by profile:act | |
| entryRelationship:priorityPreference | 0..* | EntryRelationship | The following entryRelationship represents the priority that a patient or a provider places on the activity. | |
| @typeCode | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: REFR | |
| observation | 1..1 | PriorityPreference | Base for all types and resources | |
| entryRelationship:indication | 0..* | EntryRelationship | The following entryRelationship represents the indication for the act. | |
| @typeCode | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: RSON | |
| observation | 1..1 | Indication | Base for all types and resources | |
| entryRelationship:instruction | 0..* | EntryRelationship | ||
| @typeCode | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: SUBJ | |
| act | 1..1 | Instruction | Base for all types and resources | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Act.moodCode | required | Planned moodCode (Act/Encounter/Procedure) |
| Act.code | extensible | ActCode |
| Act.statusCode | required | ActStatus |
| Act.entryRelationship:priorityPreference.typeCode | required | Fixed Value: REFR |
| Act.entryRelationship:indication.typeCode | required | Fixed Value: RSON |
| Act.entryRelationship:instruction.typeCode | required | Fixed Value: SUBJ |
| Id | Grade | Path(s) | Details | Requirements |
| 1098-32030 | warning | Act.code | This code in a Planned Act **SHOULD** be selected from LOINC (CodeSystem: 2.16.840.1.113883.6.1) *OR* SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96) (CONF:1098-32030). : | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
| Path | Conformance | ValueSet / Code |
| Act.nullFlavor | required | NullFlavor |
| Act.moodCode | required | Planned moodCode (Act/Encounter/Procedure) |
| Act.templateId:primary.nullFlavor | required | NullFlavor |
| Act.code | extensible | ActCode |
| Act.statusCode | required | ActStatus |
| Act.statusCode.nullFlavor | required | NullFlavor |
| Act.priorityCode | extensible | ActPriority |
| Act.languageCode | required | HumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066) |
| Act.entryRelationship:priorityPreference.nullFlavor | required | NullFlavor |
| Act.entryRelationship:priorityPreference.typeCode | required | Fixed Value: REFR |
| Act.entryRelationship:indication.nullFlavor | required | NullFlavor |
| Act.entryRelationship:indication.typeCode | required | Fixed Value: RSON |
| Act.entryRelationship:instruction.nullFlavor | required | NullFlavor |
| Act.entryRelationship:instruction.typeCode | required | Fixed Value: SUBJ |
| Id | Grade | Path(s) | Details | Requirements |
| 1098-32030 | warning | Act.code | This code in a Planned Act **SHOULD** be selected from LOINC (CodeSystem: 2.16.840.1.113883.6.1) *OR* SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96) (CONF:1098-32030). : | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
This structure is derived from CDAR2.Act
Summary
Mandatory: 7 elements (3 nested mandatory elements)
Fixed Value: 5 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from CDAR2.Act
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Act | CDAR2.Act | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, @classCode, @moodCode, realmCode, typeId, templateId, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition | ||
| classCode | 1..1 | cs | Fixed Value: ACT | |
| moodCode | 1..1 | cs | Binding: Planned moodCode (Act/Encounter/Procedure) (required) | |
| Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:primary | 1..1 | II | ||
| root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.39 | |
| extension | 1..1 | st | Required Pattern: 2014-06-09 | |
| id | 1..* | II | ||
| code | C | 1..1 | CD | 1098-32030: This code in a Planned Act **SHOULD** be selected from LOINC (CodeSystem: 2.16.840.1.113883.6.1) *OR* SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96) (CONF:1098-32030). |
| statusCode | 1..1 | CS | ||
| code | 1..1 | cs | Fixed Value: active | |
| effectiveTime | 0..1 | IVL_TS | The effectiveTime in a planned act represents the time that the act should occur. | |
| performer | 0..* | Performer2 | The clinician who is expected to carry out the act could be identified using act/performer. | |
| author | 0..1 | AuthorParticipation | The author in a planned act represents the clinician who is requesting or planning the act. | |
| Slices for entryRelationship | 0..* | EntryRelationship | The following entryRelationship captures any instructions associated with the planned act. Slice: Unordered, Open by profile:act | |
| entryRelationship:priorityPreference | 0..* | EntryRelationship | The following entryRelationship represents the priority that a patient or a provider places on the activity. | |
| typeCode | 1..1 | cs | Fixed Value: REFR | |
| observation | 1..1 | PriorityPreference | Base for all types and resources | |
| entryRelationship:indication | 0..* | EntryRelationship | The following entryRelationship represents the indication for the act. | |
| typeCode | 1..1 | cs | Fixed Value: RSON | |
| observation | 1..1 | Indication | Base for all types and resources | |
| entryRelationship:instruction | 0..* | EntryRelationship | ||
| typeCode | 1..1 | cs | Fixed Value: SUBJ | |
| act | 1..1 | Instruction | Base for all types and resources | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Act.moodCode | required | Planned moodCode (Act/Encounter/Procedure) |
| Id | Grade | Path(s) | Details | Requirements |
| 1098-32030 | warning | Act.code | This code in a Planned Act **SHOULD** be selected from LOINC (CodeSystem: 2.16.840.1.113883.6.1) *OR* SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96) (CONF:1098-32030). : |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Act | 1..1 | CDAR2.Act | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, @classCode, @moodCode, realmCode, typeId, templateId, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition Base for all types and resources | |
| @classCode | 1..1 | cs | Fixed Value: ACT | |
| @moodCode | 1..1 | cs | Binding: Planned moodCode (Act/Encounter/Procedure) (required) | |
| Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:primary | 1..1 | II | ||
| @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.39 | |
| @extension | 1..1 | st | Required Pattern: 2014-06-09 | |
| id | 1..* | II | ||
| code | C | 1..1 | CD | Binding: v3 Code System ActCode (extensible) 1098-32030: This code in a Planned Act **SHOULD** be selected from LOINC (CodeSystem: 2.16.840.1.113883.6.1) *OR* SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96) (CONF:1098-32030). |
| statusCode | 1..1 | CS | Binding: ActStatus (required) | |
| @code | 1..1 | cs | Fixed Value: active | |
| effectiveTime | 0..1 | IVL_TS | The effectiveTime in a planned act represents the time that the act should occur. | |
| performer | 0..* | Performer2 | The clinician who is expected to carry out the act could be identified using act/performer. | |
| author | 0..1 | AuthorParticipation | The author in a planned act represents the clinician who is requesting or planning the act. | |
| Slices for entryRelationship | 0..* | EntryRelationship | The following entryRelationship captures any instructions associated with the planned act. Slice: Unordered, Open by profile:act | |
| entryRelationship:priorityPreference | 0..* | EntryRelationship | The following entryRelationship represents the priority that a patient or a provider places on the activity. | |
| @typeCode | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: REFR | |
| observation | 1..1 | PriorityPreference | Base for all types and resources | |
| entryRelationship:indication | 0..* | EntryRelationship | The following entryRelationship represents the indication for the act. | |
| @typeCode | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: RSON | |
| observation | 1..1 | Indication | Base for all types and resources | |
| entryRelationship:instruction | 0..* | EntryRelationship | ||
| @typeCode | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: SUBJ | |
| act | 1..1 | Instruction | Base for all types and resources | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Act.moodCode | required | Planned moodCode (Act/Encounter/Procedure) |
| Act.code | extensible | ActCode |
| Act.statusCode | required | ActStatus |
| Act.entryRelationship:priorityPreference.typeCode | required | Fixed Value: REFR |
| Act.entryRelationship:indication.typeCode | required | Fixed Value: RSON |
| Act.entryRelationship:instruction.typeCode | required | Fixed Value: SUBJ |
| Id | Grade | Path(s) | Details | Requirements |
| 1098-32030 | warning | Act.code | This code in a Planned Act **SHOULD** be selected from LOINC (CodeSystem: 2.16.840.1.113883.6.1) *OR* SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96) (CONF:1098-32030). : | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
Snapshot View
| Path | Conformance | ValueSet / Code |
| Act.nullFlavor | required | NullFlavor |
| Act.moodCode | required | Planned moodCode (Act/Encounter/Procedure) |
| Act.templateId:primary.nullFlavor | required | NullFlavor |
| Act.code | extensible | ActCode |
| Act.statusCode | required | ActStatus |
| Act.statusCode.nullFlavor | required | NullFlavor |
| Act.priorityCode | extensible | ActPriority |
| Act.languageCode | required | HumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066) |
| Act.entryRelationship:priorityPreference.nullFlavor | required | NullFlavor |
| Act.entryRelationship:priorityPreference.typeCode | required | Fixed Value: REFR |
| Act.entryRelationship:indication.nullFlavor | required | NullFlavor |
| Act.entryRelationship:indication.typeCode | required | Fixed Value: RSON |
| Act.entryRelationship:instruction.nullFlavor | required | NullFlavor |
| Act.entryRelationship:instruction.typeCode | required | Fixed Value: SUBJ |
| Id | Grade | Path(s) | Details | Requirements |
| 1098-32030 | warning | Act.code | This code in a Planned Act **SHOULD** be selected from LOINC (CodeSystem: 2.16.840.1.113883.6.1) *OR* SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96) (CONF:1098-32030). : | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
This structure is derived from CDAR2.Act
Summary
Mandatory: 7 elements (3 nested mandatory elements)
Fixed Value: 5 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
IG © 2019+ Health Level Seven. Package hl7.cda.us.ccda#2.1 based on FHIR 5.0.0. Generated 2023-09-29
Links: Table of Contents |
QA Report
| Version History 
|
|
Propose a change