Consolidated CDA Release 2.2
2.2 - CI Build United States of America flag

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: PlannedAct - Detailed Descriptions

Active as of 2022-05-13

Definitions for the 2.16.840.1.113883.10.20.22.4.39 resource profile.

1. Act
Control1..1
2. Act.classCode
Control1..1
Typecode
Requirements

SHALL contain exactly one [1..1] @classCode="ACT" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1098-8538).

Pattern ValueACT
3. Act.moodCode
Control1..1
BindingThe codes SHALL be taken from Planned moodCode (Act/Encounter/Procedure)
Typecode
Requirements

SHALL contain exactly one [1..1] @moodCode, which SHALL be selected from ValueSet Planned moodCode (Act/Encounter/Procedure) urn:oid:2.16.840.1.113883.11.20.9.23 STATIC 2014-09-01 (CONF:1098-8539).

4. Act.realmCode
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
5. Act.typeId
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
6. Act.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
SlicingThis element introduces a set of slices on Act.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ root
  • ,
  • value @ extension
7. Act.templateId:primary
SliceNameprimary
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

SHALL contain exactly one [1..1] templateId (CONF:1098-30430) such that it

8. Act.templateId:primary.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
9. Act.templateId:primary.assigningAuthorityName
Definition

A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.

Control0..1
Typestring
10. Act.templateId:primary.displayable
Definition

Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).

Control0..1
Typeboolean
11. Act.templateId:primary.root
Definition

A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.

Control1..1
Typestring
Requirements

SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.39" (CONF:1098-30431).

Pattern Value2.16.840.1.113883.10.20.22.4.39
12. Act.templateId:primary.extension
Definition

A character string as a unique identifier within the scope of the identifier root.

Control1..1
Typestring
Requirements

SHALL contain exactly one [1..1] @extension="2014-06-09" (CONF:1098-32552).

Pattern Value2014-06-09
13. Act.id
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

SHALL contain at least one [1..*] id (CONF:1098-8546).

14. Act.code
Control1..1
BindingThe codes SHALL be taken from v3 Code System ActCode; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
Requirements

SHALL contain exactly one [1..1] code (CONF:1098-31687).

InvariantsDefined on this element
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). (: )
15. Act.negationInd
Control0..1
Typeboolean
16. Act.text
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
17. Act.statusCode
Control1..1
BindingThe codes SHALL be taken from ActStatus
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
Requirements

SHALL contain exactly one [1..1] statusCode (CONF:1098-30432).

18. Act.statusCode.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
19. Act.statusCode.code
Definition

The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache.

Control1..1
Typestring
Requirements

This statusCode SHALL contain exactly one [1..1] @code="active" Active (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14) (CONF:1098-32019).

Pattern Valueactive
20. Act.statusCode.codeSystem
Definition

Specifies the code system that defines the code.

Control0..0
Typestring
21. Act.statusCode.codeSystemName
Definition

The common name of the coding system.

Control0..0
Typestring
22. Act.statusCode.codeSystemVersion
Definition

If applicable, a version descriptor defined specifically for the given code system.

Control0..0
Typestring
23. Act.statusCode.displayName
Definition

A name or title for the code, under which the sending system shows the code value to its users.

Control0..0
Typestring
24. Act.statusCode.sdtcValueSet
Definition

The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.

Control0..1
Typestring
25. Act.statusCode.sdtcValueSetVersion
Definition

The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.

Control0..1
Typestring
26. Act.statusCode.originalText
Definition

The text or phrase used as the basis for the coding.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
27. Act.statusCode.qualifier
Definition

Specifies additional codes that increase the specificity of the the primary code.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/CR
28. Act.statusCode.translation
Definition

A set of other concept descriptors that translate this concept descriptor into other code systems.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
29. Act.effectiveTime
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
Requirements

SHOULD contain zero or one [0..1] effectiveTime (CONF:1098-30433).

30. Act.priorityCode
Control0..1
BindingThe codes SHALL be taken from ActPriority; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
31. Act.languageCode
Control0..1
BindingThe codes SHALL be taken from HumanLanguage
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
32. Act.subject
Control0..1
TypeElement
33. Act.subject.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationTargetSubject
Typecode
Default ValueSBJ
Fixed ValueSBJ
34. Act.subject.contextControlCode
Control1..1
BindingThe codes SHALL be taken from ContextControl
Typecode
Default ValueOP
Fixed ValueOP
35. Act.subject.awarenessCode
Control0..1
BindingThe codes SHALL be taken from TargetAwareness; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
36. Act.subject.relatedSubject
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedSubject
37. Act.specimen
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Specimen
38. Act.performer
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Performer2
Requirements

MAY contain zero or more [0..*] performer (CONF:1098-30435).

39. Act.author
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Author(AuthorParticipation)
Requirements

SHOULD contain zero or one [0..1] Author Participation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.119) (CONF:1098-32020).

40. Act.informant
Control0..*
TypeElement
41. Act.informant.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationInformationGenerator
Typecode
Default ValueINF
Fixed ValueINF
42. Act.informant.contextControlCode
Control1..1
BindingThe codes SHALL be taken from ContextControl
Typecode
Default ValueOP
Fixed ValueOP
43. Act.informant.assignedEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
44. Act.informant.relatedEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedEntity
45. Act.participant
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Participant2
46. Act.entryRelationship
Control0..*
TypeElement
InvariantsDefined on this element
act-er-1: Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act (: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1)
SlicingThis element introduces a set of slices on Act.entryRelationship. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • profile @ act
47. Act.entryRelationship.typeCode
Control1..1
Typecode
48. Act.entryRelationship.inversionInd
Control0..1
Typeboolean
49. Act.entryRelationship.contextConductionInd
Control1..1
Typeboolean
Default Valuetrue
50. Act.entryRelationship.sequenceNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
51. Act.entryRelationship.negationInd
Control0..1
Typeboolean
52. Act.entryRelationship.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
53. Act.entryRelationship.observation
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation
54. Act.entryRelationship.regionOfInterest
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
55. Act.entryRelationship.observationMedia
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
56. Act.entryRelationship.substanceAdministration
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
57. Act.entryRelationship.supply
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
58. Act.entryRelationship.procedure
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
59. Act.entryRelationship.encounter
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
60. Act.entryRelationship.organizer
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
61. Act.entryRelationship.act
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act
62. Act.entryRelationship:priorityPreference
SliceNamepriorityPreference
Control0..*
TypeElement
Requirements

MAY contain zero or more [0..*] entryRelationship (CONF:1098-31067) such that it

InvariantsDefined on this element
act-er-1: Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act (: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1)
63. Act.entryRelationship:priorityPreference.typeCode
Control1..1
Typecode
Requirements

SHALL contain exactly one [1..1] @typeCode="REFR" Refers to (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-31068).

Pattern ValueREFR
64. Act.entryRelationship:priorityPreference.inversionInd
Control0..1
Typeboolean
65. Act.entryRelationship:priorityPreference.contextConductionInd
Control1..1
Typeboolean
Default Valuetrue
66. Act.entryRelationship:priorityPreference.sequenceNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
67. Act.entryRelationship:priorityPreference.negationInd
Control0..1
Typeboolean
68. Act.entryRelationship:priorityPreference.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
69. Act.entryRelationship:priorityPreference.observation
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation(PriorityPreference)
Requirements

SHALL contain exactly one [1..1] Priority Preference (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.143) (CONF:1098-31069).

70. Act.entryRelationship:priorityPreference.regionOfInterest
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
71. Act.entryRelationship:priorityPreference.observationMedia
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
72. Act.entryRelationship:priorityPreference.substanceAdministration
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
73. Act.entryRelationship:priorityPreference.supply
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
74. Act.entryRelationship:priorityPreference.procedure
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
75. Act.entryRelationship:priorityPreference.encounter
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
76. Act.entryRelationship:priorityPreference.organizer
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
77. Act.entryRelationship:priorityPreference.act
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act
78. Act.entryRelationship:indication
SliceNameindication
Control0..*
TypeElement
Requirements

MAY contain zero or more [0..*] entryRelationship (CONF:1098-32021) such that it

InvariantsDefined on this element
act-er-1: Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act (: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1)
79. Act.entryRelationship:indication.typeCode
Control1..1
Typecode
Requirements

SHALL contain exactly one [1..1] @typeCode="RSON" Has Reason (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32022).

Pattern ValueRSON
80. Act.entryRelationship:indication.inversionInd
Control0..1
Typeboolean
81. Act.entryRelationship:indication.contextConductionInd
Control1..1
Typeboolean
Default Valuetrue
82. Act.entryRelationship:indication.sequenceNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
83. Act.entryRelationship:indication.negationInd
Control0..1
Typeboolean
84. Act.entryRelationship:indication.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
85. Act.entryRelationship:indication.observation
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation(Indication)
Requirements

SHALL contain exactly one [1..1] Indication (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.19:2014-06-09) (CONF:1098-32023).

86. Act.entryRelationship:indication.regionOfInterest
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
87. Act.entryRelationship:indication.observationMedia
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
88. Act.entryRelationship:indication.substanceAdministration
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
89. Act.entryRelationship:indication.supply
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
90. Act.entryRelationship:indication.procedure
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
91. Act.entryRelationship:indication.encounter
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
92. Act.entryRelationship:indication.organizer
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
93. Act.entryRelationship:indication.act
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act
94. Act.entryRelationship:instruction
SliceNameinstruction
Control0..*
TypeElement
Requirements

MAY contain zero or more [0..*] entryRelationship (CONF:1098-32024) such that it

InvariantsDefined on this element
act-er-1: Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act (: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1)
95. Act.entryRelationship:instruction.typeCode
Control1..1
Typecode
Requirements

SHALL contain exactly one [1..1] @typeCode="SUBJ" Has subject (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32025).

Pattern ValueSUBJ
96. Act.entryRelationship:instruction.inversionInd
Control0..1
Typeboolean
97. Act.entryRelationship:instruction.contextConductionInd
Control1..1
Typeboolean
Default Valuetrue
98. Act.entryRelationship:instruction.sequenceNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
99. Act.entryRelationship:instruction.negationInd
Control0..1
Typeboolean
100. Act.entryRelationship:instruction.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
101. Act.entryRelationship:instruction.observation
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation
102. Act.entryRelationship:instruction.regionOfInterest
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
103. Act.entryRelationship:instruction.observationMedia
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
104. Act.entryRelationship:instruction.substanceAdministration
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
105. Act.entryRelationship:instruction.supply
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
106. Act.entryRelationship:instruction.procedure
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
107. Act.entryRelationship:instruction.encounter
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
108. Act.entryRelationship:instruction.organizer
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
109. Act.entryRelationship:instruction.act
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act(Instruction)
Requirements

SHALL contain exactly one [1..1] Instruction (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.20:2014-06-09) (CONF:1098-32026).

110. Act.reference
Control0..*
TypeElement
111. Act.reference.typeCode
Control1..1
Typecode
112. Act.reference.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
113. Act.reference.externalAct
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalAct
114. Act.reference.externalObservation
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalObservation
115. Act.reference.externalProcedure
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalProcedure
116. Act.reference.externalDocument
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalDocument
117. Act.precondition
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Precondition