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

Active as of 2022-05-13

Definitions for the 2.16.840.1.113883.10.20.6.2.6 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:81-9207).

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

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

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-9209) 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.6.2.6" (CONF:81-10533).

Pattern Value2.16.840.1.113883.10.20.6.2.6
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-9210).

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-9213).

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-9211).

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-19172).

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="113014" (CONF:81-19173).

Pattern Value113014
22. Act.code.codeSystem
Definition

Specifies the code system that defines the code.

Control1..1
Typestring
Requirements

This code 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-26506).

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.

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CR
30. 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
31. Act.negationInd
Control0..1
Typeboolean
32. Act.text
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
Requirements

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

33. Act.text.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.text.charset
Definition

For character-based encoding types, this property specifies the character set and character encoding used. The charset shall be identified by an Internet Assigned Numbers Authority (IANA) Charset Registration [] in accordance with RFC 2978 [].

Control0..1
Typecode
35. Act.text.compression
Definition

Indicates whether the raw byte data is compressed, and what compression algorithm was used.

Control0..1
BindingThe codes SHALL be taken from CompressionAlgorithm
Typecode
36. Act.text.integrityCheck
Definition

The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created.

Control0..1
Typebase64Binary
37. Act.text.integrityCheckAlgorithm
Definition

Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage.

Control0..1
BindingThe codes SHALL be taken from IntegrityCheckAlgorithm
Typecode
38. Act.text.language
Definition

For character based information the language property specifies the human language of the text.

Control0..1
Typecode
39. Act.text.mediaType
Definition

Identifies the type of the encapsulated data and identifies a method to interpret or render the data.

Control0..1
Typecode
40. Act.text.representation
Control0..1
Typecode
41. Act.text.data[x]
Definition

Data that is primarily intended for human interpretation or for further machine processing is outside the scope of HL7. This includes unformatted or formatted written language, multimedia data, or structured information as defined by a different standard (e.g., XML-signatures.)

Control0..1
TypeChoice of: string, base64Binary
[x] NoteSee Choice of Data Types for further information about how to use [x]
42. Act.text.reference
Definition

A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
Requirements

The text, if present, SHOULD contain zero or one [0..1] reference (CONF:81-15995).

43. Act.text.reference.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
44. Act.text.reference.value
Control0..1
Typeuri
Requirements

The reference, if present, SHOULD contain zero or one [0..1] @value (CONF:81-15996).

InvariantsDefined on this element
81-15997: This reference/@value SHALL begin with a '#' and SHALL point to its corresponding narrative (using the approach defined in CDA Release 2, section 4.3.5.1) (CONF:81-15997). (: )
45. Act.text.reference.useablePeriod
Definition

Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address.

Control0..*
TypeChoice of: http://hl7.org/fhir/cda/StructureDefinition/IVL-TS, http://hl7.org/fhir/cda/StructureDefinition/EIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/PIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/SXPR-TS
46. Act.text.reference.use
Definition

One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need.

Control0..*
BindingThe codes SHALL be taken from AddressUse
Typecode
47. Act.text.thumbnail
Definition

An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
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-9216).

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 @ act
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:seriesAct
SliceNameseriesAct
Control1..*
TypeElement
Requirements

SHALL contain at least one [1..*] entryRelationship (CONF:81-9219) 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:seriesAct.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-9220).

Pattern ValueCOMP
84. Act.entryRelationship:seriesAct.inversionInd
Control0..1
Typeboolean
85. Act.entryRelationship:seriesAct.contextConductionInd
Control1..1
Typeboolean
Default Valuetrue
86. Act.entryRelationship:seriesAct.sequenceNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
87. Act.entryRelationship:seriesAct.negationInd
Control0..1
Typeboolean
88. Act.entryRelationship:seriesAct.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
89. Act.entryRelationship:seriesAct.observation
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation
90. Act.entryRelationship:seriesAct.regionOfInterest
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
91. Act.entryRelationship:seriesAct.observationMedia
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
92. Act.entryRelationship:seriesAct.substanceAdministration
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
93. Act.entryRelationship:seriesAct.supply
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
94. Act.entryRelationship:seriesAct.procedure
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
95. Act.entryRelationship:seriesAct.encounter
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
96. Act.entryRelationship:seriesAct.organizer
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
97. Act.entryRelationship:seriesAct.act
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act(SeriesAct)
Requirements

SHALL contain exactly one [1..1] Series Act (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.63) (CONF:81-15937).

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