Consolidated CDA Release 2.2
2.2 - CI Build

Consolidated CDA Release 2.2, published by Health Level Seven. This is not an authorized publication; it is the continuous build for version 2.2). This version is based on the current content of https://github.com/HL7/CDA-ccda-2.2/ and changes regularly. See the Directory of published versions

## Resource Profile: Planned Act

Official URL: http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.4.39 | Version: 2.2
Active as of 2022-05-13 | Computable Name: PlannedAct
Other Identifiers: : 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:

- Use this Resource Profile: Plan of Treatment Section, Assessment and Plan Section, Nutrition Recommendation, Planned Intervention Act

### Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

- Text Summary
- Differential Table
- Snapshot Table
- Snapshot Table (Must Support)
- All

This structure is derived from CDAR2.Act

Summary

Mandatory: 9 elements (6 nested mandatory elements)

Structures

This structure refers to these other structures:

- Author Participation (http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.4.119)
- Priority Preference (http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.4.143)
- Indication (http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.4.19)
- Instruction (http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.4.20)

Slices

This structure defines the following Slices:

- The element Act.templateId is sliced based on the values of value:root, value:extension
- The element Act.entryRelationship is sliced based on the value of profile:act

This structure is derived from CDAR2.Act

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Act |  | 1..1 | CDAR2.Act |
classCode |  | 1..1 | code | Required Pattern: ACT
moodCode |  | 1..1 | code | Binding: Planned moodCode (Act/Encounter/Procedure) (required)
Slices for templateId |  | 0..* | II | Slice: Unordered, Open by value:root, value:extension
templateId:primary |  | 1..1 | II |
root |  | 1..1 | string | Required Pattern: 2.16.840.1.113883.10.20.22.4.39
extension |  | 1..1 | string | Required Pattern: 2014-06-09
id |  | 1..* | II |
code | I | 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 | string | Required Pattern: 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..* | Element | The following entryRelationship captures any instructions associated with the planned act. Slice: Unordered, Open by profile:act
entryRelationship:priorityPreference |  | 0..* | Element | The following entryRelationship represents the priority that a patient or a provider places on the activity.
typeCode |  | 1..1 | code | Required Pattern: REFR
observation |  | 1..1 | PriorityPreference |
entryRelationship:indication |  | 0..* | Element | The following entryRelationship represents the indication for the act.
typeCode |  | 1..1 | code | Required Pattern: RSON
observation |  | 1..1 | Indication |
entryRelationship:instruction |  | 0..* | Element |
typeCode |  | 1..1 | code | Required Pattern: SUBJ
act |  | 1..1 | Instruction |
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Act |  | 1..1 | CDAR2.Act |
classCode |  | 1..1 | code | Required Pattern: ACT
moodCode |  | 1..1 | code | Binding: Planned moodCode (Act/Encounter/Procedure) (required)
realmCode |  | 0..* | CS |
typeId |  | 0..1 | II |
Slices for templateId |  | 0..* | II | Slice: Unordered, Open by value:root, value:extension
templateId:primary |  | 1..1 | II |
nullFlavor |  | 0..1 | code | Binding: NullFlavor (required)
assigningAuthorityName |  | 0..1 | string |
displayable |  | 0..1 | boolean |
root |  | 1..1 | string | Required Pattern: 2.16.840.1.113883.10.20.22.4.39
extension |  | 1..1 | string | Required Pattern: 2014-06-09
id |  | 1..* | II |
code | I | 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).
negationInd |  | 0..1 | boolean |
text |  | 0..1 | ED |
statusCode |  | 1..1 | CS | Binding: ActStatus (required)
nullFlavor |  | 0..1 | code | Binding: NullFlavor (required)
code |  | 1..1 | string | Required Pattern: active
sdtcValueSet |  | 0..1 | string | XML: valueSet (urn:hl7-org:sdtc)
sdtcValueSetVersion |  | 0..1 | string | XML: valueSetVersion (urn:hl7-org:sdtc)
effectiveTime |  | 0..1 | IVL_TS | The effectiveTime in a planned act represents the time that the act should occur.
priorityCode |  | 0..1 | CE | Binding: ActPriority (extensible)
languageCode |  | 0..1 | CS | Binding: HumanLanguage (required)
subject |  | 0..1 | Element |
typeCode |  | 1..1 | code | Binding: ParticipationTargetSubject (required) Fixed Value: SBJ
contextControlCode |  | 1..1 | code | Binding: ContextControl (required) Fixed Value: OP
awarenessCode |  | 0..1 | CE | Binding: TargetAwareness (extensible)
relatedSubject |  | 1..1 | RelatedSubject |
specimen |  | 0..* | Specimen |
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.
informant |  | 0..* | Element |
typeCode |  | 1..1 | code | Binding: ParticipationInformationGenerator (required) Fixed Value: INF
contextControlCode |  | 1..1 | code | Binding: ContextControl (required) Fixed Value: OP
assignedEntity |  | 0..1 | AssignedEntity |
relatedEntity |  | 0..1 | RelatedEntity |
participant |  | 0..* | Participant2 |
Slices for entryRelationship | I | 0..* | Element | The following entryRelationship captures any instructions associated with the planned act. Slice: Unordered, Open by profile:act
entryRelationship:All Slices |  |  |  | Content/Rules for all slices
typeCode |  | 1..1 | code |
inversionInd |  | 0..1 | boolean |
contextConductionInd |  | 1..1 | boolean |
sequenceNumber |  | 0..1 | INT |
negationInd |  | 0..1 | boolean |
seperatableInd |  | 0..1 | BL |
(Choice of one) |  | 1..1 |  |
observation |  | 0..1 | Observation |
regionOfInterest |  | 0..1 | RegionOfInterest |
observationMedia |  | 0..1 | ObservationMedia |
substanceAdministration |  | 0..1 | SubstanceAdministration |
supply |  | 0..1 | Supply |
procedure |  | 0..1 | Procedure |
encounter |  | 0..1 | Encounter |
organizer |  | 0..1 | Organizer |
act |  | 0..1 | Act |
entryRelationship:priorityPreference | I | 0..* | Element | The following entryRelationship represents the priority that a patient or a provider places on the activity.
typeCode |  | 1..1 | code | Required Pattern: REFR
inversionInd |  | 0..1 | boolean |
contextConductionInd |  | 1..1 | boolean |
sequenceNumber |  | 0..1 | INT |
negationInd |  | 0..1 | boolean |
seperatableInd |  | 0..1 | BL |
observation |  | 1..1 | PriorityPreference |
entryRelationship:indication | I | 0..* | Element | The following entryRelationship represents the indication for the act.
typeCode |  | 1..1 | code | Required Pattern: RSON
inversionInd |  | 0..1 | boolean |
contextConductionInd |  | 1..1 | boolean |
sequenceNumber |  | 0..1 | INT |
negationInd |  | 0..1 | boolean |
seperatableInd |  | 0..1 | BL |
observation |  | 1..1 | Indication |
entryRelationship:instruction | I | 0..* | Element |
typeCode |  | 1..1 | code | Required Pattern: SUBJ
inversionInd |  | 0..1 | boolean |
contextConductionInd |  | 1..1 | boolean |
sequenceNumber |  | 0..1 | INT |
negationInd |  | 0..1 | boolean |
seperatableInd |  | 0..1 | BL |
act |  | 1..1 | Instruction |
reference |  | 0..* | Element |
typeCode |  | 1..1 | code |
seperatableInd |  | 0..1 | BL |
externalAct |  | 0..1 | ExternalAct |
externalObservation |  | 0..1 | ExternalObservation |
externalProcedure |  | 0..1 | ExternalProcedure |
externalDocument |  | 0..1 | ExternalDocument |
precondition |  | 0..* | Precondition |
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Act |  | 1..1 | CDAR2.Act |
Documentation for this format

This structure is derived from CDAR2.Act

Summary

Mandatory: 9 elements (6 nested mandatory elements)

Structures

This structure refers to these other structures:

- Author Participation (http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.4.119)
- Priority Preference (http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.4.143)
- Indication (http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.4.19)
- Instruction (http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.4.20)

Slices

This structure defines the following Slices:

- The element Act.templateId is sliced based on the values of value:root, value:extension
- The element Act.entryRelationship is sliced based on the value of profile:act

Differential View

This structure is derived from CDAR2.Act

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Act |  | 1..1 | CDAR2.Act |
classCode |  | 1..1 | code | Required Pattern: ACT
moodCode |  | 1..1 | code | Binding: Planned moodCode (Act/Encounter/Procedure) (required)
Slices for templateId |  | 0..* | II | Slice: Unordered, Open by value:root, value:extension
templateId:primary |  | 1..1 | II |
root |  | 1..1 | string | Required Pattern: 2.16.840.1.113883.10.20.22.4.39
extension |  | 1..1 | string | Required Pattern: 2014-06-09
id |  | 1..* | II |
code | I | 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 | string | Required Pattern: 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..* | Element | The following entryRelationship captures any instructions associated with the planned act. Slice: Unordered, Open by profile:act
entryRelationship:priorityPreference |  | 0..* | Element | The following entryRelationship represents the priority that a patient or a provider places on the activity.
typeCode |  | 1..1 | code | Required Pattern: REFR
observation |  | 1..1 | PriorityPreference |
entryRelationship:indication |  | 0..* | Element | The following entryRelationship represents the indication for the act.
typeCode |  | 1..1 | code | Required Pattern: RSON
observation |  | 1..1 | Indication |
entryRelationship:instruction |  | 0..* | Element |
typeCode |  | 1..1 | code | Required Pattern: SUBJ
act |  | 1..1 | Instruction |
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Act |  | 1..1 | CDAR2.Act |
classCode |  | 1..1 | code | Required Pattern: ACT
moodCode |  | 1..1 | code | Binding: Planned moodCode (Act/Encounter/Procedure) (required)
realmCode |  | 0..* | CS |
typeId |  | 0..1 | II |
Slices for templateId |  | 0..* | II | Slice: Unordered, Open by value:root, value:extension
templateId:primary |  | 1..1 | II |
nullFlavor |  | 0..1 | code | Binding: NullFlavor (required)
assigningAuthorityName |  | 0..1 | string |
displayable |  | 0..1 | boolean |
root |  | 1..1 | string | Required Pattern: 2.16.840.1.113883.10.20.22.4.39
extension |  | 1..1 | string | Required Pattern: 2014-06-09
id |  | 1..* | II |
code | I | 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).
negationInd |  | 0..1 | boolean |
text |  | 0..1 | ED |
statusCode |  | 1..1 | CS | Binding: ActStatus (required)
nullFlavor |  | 0..1 | code | Binding: NullFlavor (required)
code |  | 1..1 | string | Required Pattern: active
sdtcValueSet |  | 0..1 | string | XML: valueSet (urn:hl7-org:sdtc)
sdtcValueSetVersion |  | 0..1 | string | XML: valueSetVersion (urn:hl7-org:sdtc)
effectiveTime |  | 0..1 | IVL_TS | The effectiveTime in a planned act represents the time that the act should occur.
priorityCode |  | 0..1 | CE | Binding: ActPriority (extensible)
languageCode |  | 0..1 | CS | Binding: HumanLanguage (required)
subject |  | 0..1 | Element |
typeCode |  | 1..1 | code | Binding: ParticipationTargetSubject (required) Fixed Value: SBJ
contextControlCode |  | 1..1 | code | Binding: ContextControl (required) Fixed Value: OP
awarenessCode |  | 0..1 | CE | Binding: TargetAwareness (extensible)
relatedSubject |  | 1..1 | RelatedSubject |
specimen |  | 0..* | Specimen |
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.
informant |  | 0..* | Element |
typeCode |  | 1..1 | code | Binding: ParticipationInformationGenerator (required) Fixed Value: INF
contextControlCode |  | 1..1 | code | Binding: ContextControl (required) Fixed Value: OP
assignedEntity |  | 0..1 | AssignedEntity |
relatedEntity |  | 0..1 | RelatedEntity |
participant |  | 0..* | Participant2 |
Slices for entryRelationship | I | 0..* | Element | The following entryRelationship captures any instructions associated with the planned act. Slice: Unordered, Open by profile:act
entryRelationship:All Slices |  |  |  | Content/Rules for all slices
typeCode |  | 1..1 | code |
inversionInd |  | 0..1 | boolean |
contextConductionInd |  | 1..1 | boolean |
sequenceNumber |  | 0..1 | INT |
negationInd |  | 0..1 | boolean |
seperatableInd |  | 0..1 | BL |
(Choice of one) |  | 1..1 |  |
observation |  | 0..1 | Observation |
regionOfInterest |  | 0..1 | RegionOfInterest |
observationMedia |  | 0..1 | ObservationMedia |
substanceAdministration |  | 0..1 | SubstanceAdministration |
supply |  | 0..1 | Supply |
procedure |  | 0..1 | Procedure |
encounter |  | 0..1 | Encounter |
organizer |  | 0..1 | Organizer |
act |  | 0..1 | Act |
entryRelationship:priorityPreference | I | 0..* | Element | The following entryRelationship represents the priority that a patient or a provider places on the activity.
typeCode |  | 1..1 | code | Required Pattern: REFR
inversionInd |  | 0..1 | boolean |
contextConductionInd |  | 1..1 | boolean |
sequenceNumber |  | 0..1 | INT |
negationInd |  | 0..1 | boolean |
seperatableInd |  | 0..1 | BL |
observation |  | 1..1 | PriorityPreference |
entryRelationship:indication | I | 0..* | Element | The following entryRelationship represents the indication for the act.
typeCode |  | 1..1 | code | Required Pattern: RSON
inversionInd |  | 0..1 | boolean |
contextConductionInd |  | 1..1 | boolean |
sequenceNumber |  | 0..1 | INT |
negationInd |  | 0..1 | boolean |
seperatableInd |  | 0..1 | BL |
observation |  | 1..1 | Indication |
entryRelationship:instruction | I | 0..* | Element |
typeCode |  | 1..1 | code | Required Pattern: SUBJ
inversionInd |  | 0..1 | boolean |
contextConductionInd |  | 1..1 | boolean |
sequenceNumber |  | 0..1 | INT |
negationInd |  | 0..1 | boolean |
seperatableInd |  | 0..1 | BL |
act |  | 1..1 | Instruction |
reference |  | 0..* | Element |
typeCode |  | 1..1 | code |
seperatableInd |  | 0..1 | BL |
externalAct |  | 0..1 | ExternalAct |
externalObservation |  | 0..1 | ExternalObservation |
externalProcedure |  | 0..1 | ExternalProcedure |
externalDocument |  | 0..1 | ExternalDocument |
precondition |  | 0..* | Precondition |
Documentation for this format

Other representations of profile: CSV, Excel, Schematron

#### Terminology Bindings

Path | Conformance | ValueSet / Code
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
Act.subject.typeCode | required | Fixed Value: SBJ
Act.subject.contextControlCode | required | Fixed Value: OP
Act.subject.awarenessCode | extensible | TargetAwareness
Act.informant.typeCode | required | Fixed Value: INF
Act.informant.contextControlCode | required | Fixed Value: OP

#### Constraints

Id | Grade | Path | 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). : |
act-er-1 | error | Act.entryRelationship | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 |
act-er-1 | error | Act.entryRelationship:priorityPreference | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 |
act-er-1 | error | Act.entryRelationship:indication | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 |
act-er-1 | error | Act.entryRelationship:instruction | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 |