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
Active as of 2022-05-13 |
Definitions for the 2.16.840.1.113883.10.20.22.4.20 resource profile.
1. Act | |
Control | 1..1 |
2. Act.classCode | |
Control | 1..1 |
Type | code |
Requirements | SHALL contain exactly one [1..1] @classCode="ACT" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1098-7391). |
Pattern Value | ACT |
3. Act.moodCode | |
Control | 1..1 |
Type | code |
Requirements | SHALL contain exactly one [1..1] @moodCode="INT" (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001 STATIC) (CONF:1098-7392). |
Pattern Value | INT |
4. Act.realmCode | |
Control | 0..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/CS |
5. Act.typeId | |
Control | 0..1 |
Type | http://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 |
Control | 0..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/II |
Slicing | This element introduces a set of slices on Act.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
7. Act.templateId:primary | |
SliceName | primary |
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 |
Control | 1..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/II |
Requirements | SHALL contain exactly one [1..1] templateId (CONF:1098-7393) 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. |
Control | 0..1 |
Binding | The codes SHALL be taken from NullFlavor |
Type | code |
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. |
Control | 0..1 |
Type | string |
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). |
Control | 0..1 |
Type | boolean |
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. |
Control | 1..1 |
Type | string |
Requirements | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.20" (CONF:1098-10503). |
Pattern Value | 2.16.840.1.113883.10.20.22.4.20 |
12. Act.templateId:primary.extension | |
Definition | A character string as a unique identifier within the scope of the identifier root. |
Control | 1..1 |
Type | string |
Requirements | SHALL contain exactly one [1..1] @extension="2014-06-09" (CONF:1098-32598). |
Pattern Value | 2014-06-09 |
13. Act.id | |
Control | 0..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/II |
14. Act.code | |
Control | 1..1 |
Binding | The codes SHOULD be taken from Patient Education |
Type | http://hl7.org/fhir/cda/StructureDefinition/CD |
Requirements | SHALL contain exactly one [1..1] code, which SHOULD be selected from ValueSet Patient Education urn:oid:2.16.840.1.113883.11.20.9.34 DYNAMIC (CONF:1098-16884). |
15. Act.negationInd | |
Control | 0..1 |
Type | boolean |
16. Act.text | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
17. Act.statusCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from ActStatus |
Type | http://hl7.org/fhir/cda/StructureDefinition/CS |
Requirements | SHALL contain exactly one [1..1] statusCode (CONF:1098-7396). |
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. |
Control | 0..1 |
Binding | The codes SHALL be taken from NullFlavor |
Type | code |
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. |
Control | 1..1 |
Type | string |
Requirements | This statusCode SHALL contain exactly one [1..1] @code="completed" Completed (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14 STATIC) (CONF:1098-19106). |
Pattern Value | completed |
20. Act.statusCode.codeSystem | |
Definition | Specifies the code system that defines the code. |
Control | 0..0 |
Type | string |
21. Act.statusCode.codeSystemName | |
Definition | The common name of the coding system. |
Control | 0..0 |
Type | string |
22. Act.statusCode.codeSystemVersion | |
Definition | If applicable, a version descriptor defined specifically for the given code system. |
Control | 0..0 |
Type | string |
23. Act.statusCode.displayName | |
Definition | A name or title for the code, under which the sending system shows the code value to its users. |
Control | 0..0 |
Type | string |
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. |
Control | 0..1 |
Type | string |
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. |
Control | 0..1 |
Type | string |
26. Act.statusCode.originalText | |
Definition | The text or phrase used as the basis for the coding. |
Control | 0..0 |
Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
27. Act.statusCode.qualifier | |
Definition | Specifies additional codes that increase the specificity of the the primary code. |
Control | 0..0 |
Type | http://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. |
Control | 0..0 |
Type | http://hl7.org/fhir/cda/StructureDefinition/CD |
29. Act.effectiveTime | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/IVL-TS |
30. Act.priorityCode | |
Control | 0..1 |
Binding | The codes SHALL be taken from ActPriority; other codes may be used where these codes are not suitable |
Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
31. Act.languageCode | |
Control | 0..1 |
Binding | The codes SHALL be taken from HumanLanguage |
Type | http://hl7.org/fhir/cda/StructureDefinition/CS |
32. Act.subject | |
Control | 0..1 |
Type | Element |
33. Act.subject.typeCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from ParticipationTargetSubject |
Type | code |
Default Value | SBJ |
Fixed Value | SBJ |
34. Act.subject.contextControlCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from ContextControl |
Type | code |
Default Value | OP |
Fixed Value | OP |
35. Act.subject.awarenessCode | |
Control | 0..1 |
Binding | The codes SHALL be taken from TargetAwareness; other codes may be used where these codes are not suitable |
Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
36. Act.subject.relatedSubject | |
Control | 1..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/RelatedSubject |
37. Act.specimen | |
Control | 0..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/Specimen |
38. Act.performer | |
Control | 0..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/Performer2 |
39. Act.author | |
Control | 0..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/Author |
40. Act.informant | |
Control | 0..* |
Type | Element |
41. Act.informant.typeCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from ParticipationInformationGenerator |
Type | code |
Default Value | INF |
Fixed Value | INF |
42. Act.informant.contextControlCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from ContextControl |
Type | code |
Default Value | OP |
Fixed Value | OP |
43. Act.informant.assignedEntity | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/AssignedEntity |
44. Act.informant.relatedEntity | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/RelatedEntity |
45. Act.participant | |
Control | 0..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/Participant2 |
46. Act.entryRelationship | |
Control | 0..* |
Type | Element |
Invariants | Defined 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) |
47. Act.entryRelationship.typeCode | |
Control | 1..1 |
Type | code |
48. Act.entryRelationship.inversionInd | |
Control | 0..1 |
Type | boolean |
49. Act.entryRelationship.contextConductionInd | |
Control | 1..1 |
Type | boolean |
Default Value | true |
50. Act.entryRelationship.sequenceNumber | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/INT |
51. Act.entryRelationship.negationInd | |
Control | 0..1 |
Type | boolean |
52. Act.entryRelationship.seperatableInd | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/BL |
53. Act.entryRelationship.observation | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/Observation |
54. Act.entryRelationship.regionOfInterest | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest |
55. Act.entryRelationship.observationMedia | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/ObservationMedia |
56. Act.entryRelationship.substanceAdministration | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration |
57. Act.entryRelationship.supply | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/Supply |
58. Act.entryRelationship.procedure | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/Procedure |
59. Act.entryRelationship.encounter | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/Encounter |
60. Act.entryRelationship.organizer | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/Organizer |
61. Act.entryRelationship.act | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/Act |
62. Act.reference | |
Control | 0..* |
Type | Element |
63. Act.reference.typeCode | |
Control | 1..1 |
Type | code |
64. Act.reference.seperatableInd | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/BL |
65. Act.reference.externalAct | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/ExternalAct |
66. Act.reference.externalObservation | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/ExternalObservation |
67. Act.reference.externalProcedure | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/ExternalProcedure |
68. Act.reference.externalDocument | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/ExternalDocument |
69. Act.precondition | |
Control | 0..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/Precondition |