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

Active as of 2022-05-13

Definitions for the 2.16.840.1.113883.10.20.22.4.63 resource profile.

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

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

Pattern ValueACT
3. Act.moodCode
Control1..1
Typecode
Requirements

SHALL contain exactly one [1..1] @moodCode="EVN" Event (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001 STATIC) (CONF:81-9223).

Pattern ValueEVN
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
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:81-10918) 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.63" (CONF:81-10919).

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

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

Control0..1
Typestring
13. Act.id
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

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

14. Act.id.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
15. Act.id.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
16. Act.id.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
17. Act.id.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

Such ids SHALL contain exactly one [1..1] @root (CONF:81-9225).

18. Act.id.extension
Definition

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

Control0..0
Typestring
Requirements

Such ids SHALL NOT contain [0..0] @extension (CONF:81-9226).

19. 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:81-19166).

20. Act.code.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
21. Act.code.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 code SHALL contain exactly one [1..1] @code="113015" (CONF:81-19167).

Pattern Value113015
22. Act.code.codeSystem
Definition

Specifies the code system that defines the code.

Control0..1
Typestring
Requirements

This code MAY contain zero or one [0..1] @codeSystem="1.2.840.10008.2.16.4" (CodeSystem: DCM urn:oid:1.2.840.10008.2.16.4) (CONF:81-26461).

Pattern Value1.2.840.10008.2.16.4
23. Act.code.codeSystemName
Definition

The common name of the coding system.

Control0..1
Typestring
24. Act.code.codeSystemVersion
Definition

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

Control0..1
Typestring
25. Act.code.displayName
Definition

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

Control0..1
Typestring
26. Act.code.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
27. Act.code.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
28. Act.code.originalText
Definition

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

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
29. Act.code.qualifier
Definition

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

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

This code SHALL contain exactly one [1..1] qualifier (CONF:81-26462).

30. Act.code.qualifier.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
31. Act.code.qualifier.inverted
Definition

Indicates if the sense of the role name is inverted. This can be used in cases where the underlying code system defines inversion but does not provide reciprocal pairs of role names. By default, inverted is false.

Control0..1
Typeboolean
32. Act.code.qualifier.name
Definition

Specifies the manner in which the concept role value contributes to the meaning of a code phrase. For example, if SNOMED RT defines a concept "leg", a role relation "has-laterality", and another concept "left", the concept role relation allows to add the qualifier "has-laterality: left" to a primary code "leg" to construct the meaning "left leg". In this example "has-laterality" is the CR.name.

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

This qualifier SHALL contain exactly one [1..1] name (CONF:81-26463).

33. Act.code.qualifier.name.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
34. Act.code.qualifier.name.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 name SHALL contain exactly one [1..1] @code="121139" Modality (CONF:81-26464).

Pattern Value121139
35. Act.code.qualifier.name.codeSystem
Definition

Specifies the code system that defines the code.

Control1..1
Typestring
Requirements

This name SHALL contain exactly one [1..1] @codeSystem="1.2.840.10008.2.16.4" (CodeSystem: DCM urn:oid:1.2.840.10008.2.16.4) (CONF:81-26465).

Pattern Value1.2.840.10008.2.16.4
36. Act.code.qualifier.name.codeSystemName
Definition

The common name of the coding system.

Control0..1
Typestring
37. Act.code.qualifier.name.codeSystemVersion
Definition

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

Control0..1
Typestring
38. Act.code.qualifier.name.displayName
Definition

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

Control0..1
Typestring
39. Act.code.qualifier.name.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
40. Act.code.qualifier.name.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
41. Act.code.qualifier.name.originalText
Definition

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

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
42. Act.code.qualifier.name.qualifier
Definition

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

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/CR
43. Act.code.qualifier.name.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
44. Act.code.qualifier.value
Definition

The concept that modifies the primary code of a code phrase through the role relation. For example, if SNOMED RT defines a concept "leg", a role relation "has-laterality", and another concept "left", the concept role relation allows adding the qualifier "has-laterality: left" to a primary code "leg" to construct the meaning "left leg". In this example "left" is the CR.value.

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

This qualifier SHALL contain exactly one [1..1] value (CONF:81-26466).

45. Act.code.translation
Definition

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
46. Act.negationInd
Control0..1
Typeboolean
47. Act.text
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
Requirements

MAY contain zero or one [0..1] text (CONF:81-9233).

48. Act.statusCode
Control0..1
BindingThe codes SHALL be taken from ActStatus
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
49. Act.effectiveTime
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
Requirements

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

50. 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
51. Act.languageCode
Control0..1
BindingThe codes SHALL be taken from HumanLanguage
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
52. Act.subject
Control0..1
TypeElement
53. Act.subject.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationTargetSubject
Typecode
Default ValueSBJ
Fixed ValueSBJ
54. Act.subject.contextControlCode
Control1..1
BindingThe codes SHALL be taken from ContextControl
Typecode
Default ValueOP
Fixed ValueOP
55. 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
56. Act.subject.relatedSubject
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedSubject
57. Act.specimen
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Specimen
58. Act.performer
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Performer2
59. Act.author
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Author
60. Act.informant
Control0..*
TypeElement
61. Act.informant.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationInformationGenerator
Typecode
Default ValueINF
Fixed ValueINF
62. Act.informant.contextControlCode
Control1..1
BindingThe codes SHALL be taken from ContextControl
Typecode
Default ValueOP
Fixed ValueOP
63. Act.informant.assignedEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
64. Act.informant.relatedEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedEntity
65. Act.participant
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Participant2
66. 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 @ observation
67. Act.entryRelationship.typeCode
Control1..1
Typecode
68. Act.entryRelationship.inversionInd
Control0..1
Typeboolean
69. Act.entryRelationship.contextConductionInd
Control1..1
Typeboolean
Default Valuetrue
70. Act.entryRelationship.sequenceNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
71. Act.entryRelationship.negationInd
Control0..1
Typeboolean
72. Act.entryRelationship.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
73. Act.entryRelationship.observation
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation
74. Act.entryRelationship.regionOfInterest
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
75. Act.entryRelationship.observationMedia
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
76. Act.entryRelationship.substanceAdministration
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
77. Act.entryRelationship.supply
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
78. Act.entryRelationship.procedure
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
79. Act.entryRelationship.encounter
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
80. Act.entryRelationship.organizer
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
81. Act.entryRelationship.act
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act
82. Act.entryRelationship:SOPInstanceObservation
SliceNameSOPInstanceObservation
Control1..*
TypeElement
Requirements

SHALL contain at least one [1..*] entryRelationship (CONF:81-9237) 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)
83. Act.entryRelationship:SOPInstanceObservation.typeCode
Control1..1
Typecode
Requirements

SHALL contain exactly one [1..1] @typeCode="COMP" Component (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:81-9238).

Pattern ValueCOMP
84. Act.entryRelationship:SOPInstanceObservation.inversionInd
Control0..1
Typeboolean
85. Act.entryRelationship:SOPInstanceObservation.contextConductionInd
Control1..1
Typeboolean
Default Valuetrue
86. Act.entryRelationship:SOPInstanceObservation.sequenceNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
87. Act.entryRelationship:SOPInstanceObservation.negationInd
Control0..1
Typeboolean
88. Act.entryRelationship:SOPInstanceObservation.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
89. Act.entryRelationship:SOPInstanceObservation.observation
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation(SOPInstanceObservation)
Requirements

SHALL contain exactly one [1..1] observationSOP Instance Observation (identifier: urn:oid:2.16.840.1.113883.10.20.6.2.8) (CONF:81-15927).

90. Act.entryRelationship:SOPInstanceObservation.regionOfInterest
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
91. Act.entryRelationship:SOPInstanceObservation.observationMedia
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
92. Act.entryRelationship:SOPInstanceObservation.substanceAdministration
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
93. Act.entryRelationship:SOPInstanceObservation.supply
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
94. Act.entryRelationship:SOPInstanceObservation.procedure
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
95. Act.entryRelationship:SOPInstanceObservation.encounter
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
96. Act.entryRelationship:SOPInstanceObservation.organizer
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
97. Act.entryRelationship:SOPInstanceObservation.act
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act
98. Act.reference
Control0..*
TypeElement
99. Act.reference.typeCode
Control1..1
Typecode
100. Act.reference.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
101. Act.reference.externalAct
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalAct
102. Act.reference.externalObservation
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalObservation
103. Act.reference.externalProcedure
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalProcedure
104. Act.reference.externalDocument
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalDocument
105. Act.precondition
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Precondition