Consolidated CDA Release 2.2
2.2 - CI Build
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
| Active as of 2022-05-13 |
Definitions for the 2.16.840.1.113883.10.20.22.4.122 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) (CONF:1098-31485). |
| Pattern Value | ACT |
| 3. Act.moodCode | |
| Control | 1..1 |
| Type | code |
| Requirements | SHALL contain exactly one [1..1] @moodCode="EVN" (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001) (CONF:1098-31486). |
| Pattern Value | EVN |
| 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-31487) 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.122" (CONF:1098-31488). |
| Pattern Value | 2.16.840.1.113883.10.20.22.4.122 |
| 12. Act.templateId:primary.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Control | 0..1 |
| Type | string |
| 13. Act.id | |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| Requirements | SHALL contain at least one [1..*] id (CONF:1098-31489). |
| 14. Act.code | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from v3 Code System ActCode; other codes may be used where these codes are not suitable |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CD |
| Requirements | SHALL contain exactly one [1..1] code (CONF:1098-31490). |
| 15. Act.code.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 1..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| Requirements | This code SHALL contain exactly one [1..1] @nullFlavor="NP" Not Present (CodeSystem: HL7NullFlavor urn:oid:2.16.840.1.113883.5.1008) (CONF:1098-31491). |
| Pattern Value | NP |
| 16. 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. |
| Control | 0..1 |
| Type | string |
| 17. Act.code.codeSystem | |
| Definition | Specifies the code system that defines the code. |
| Control | 0..1 |
| Type | string |
| 18. Act.code.codeSystemName | |
| Definition | The common name of the coding system. |
| Control | 0..1 |
| Type | string |
| 19. Act.code.codeSystemVersion | |
| Definition | If applicable, a version descriptor defined specifically for the given code system. |
| Control | 0..1 |
| Type | string |
| 20. Act.code.displayName | |
| Definition | A name or title for the code, under which the sending system shows the code value to its users. |
| Control | 0..1 |
| Type | string |
| 21. 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. |
| Control | 0..1 |
| Type | string |
| 22. 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. |
| Control | 0..1 |
| Type | string |
| 23. Act.code.originalText | |
| Definition | The text or phrase used as the basis for the coding. |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
| 24. Act.code.qualifier | |
| Definition | Specifies additional codes that increase the specificity of the the primary code. |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CR |
| 25. Act.code.translation | |
| Definition | A set of other concept descriptors that translate this concept descriptor into other code systems. |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CD |
| 26. Act.negationInd | |
| Control | 0..1 |
| Type | boolean |
| 27. Act.text | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
| 28. 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-31498). |
| 29. 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 |
| 30. 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 | 0..1 |
| Type | string |
| Requirements | This statusCode MAY contain zero or one [0..1] @code="completed" (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14) (CONF:1098-31499). |
| Pattern Value | completed |
| 31. Act.statusCode.codeSystem | |
| Definition | Specifies the code system that defines the code. |
| Control | 0..0 |
| Type | string |
| 32. Act.statusCode.codeSystemName | |
| Definition | The common name of the coding system. |
| Control | 0..0 |
| Type | string |
| 33. Act.statusCode.codeSystemVersion | |
| Definition | If applicable, a version descriptor defined specifically for the given code system. |
| Control | 0..0 |
| Type | string |
| 34. 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 |
| 35. 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 |
| 36. 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 |
| 37. 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 |
| 38. 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 |
| 39. 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 |
| 40. Act.effectiveTime | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/IVL-TS |
| 41. 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 |
| 42. Act.languageCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from HumanLanguage |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CS |
| 43. Act.subject | |
| Control | 0..1 |
| Type | Element |
| 44. Act.subject.typeCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ParticipationTargetSubject |
| Type | code |
| Default Value | SBJ |
| Fixed Value | SBJ |
| 45. Act.subject.contextControlCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ContextControl |
| Type | code |
| Default Value | OP |
| Fixed Value | OP |
| 46. 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 |
| 47. Act.subject.relatedSubject | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/RelatedSubject |
| 48. Act.specimen | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Specimen |
| 49. Act.performer | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Performer2 |
| 50. Act.author | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Author |
| 51. Act.informant | |
| Control | 0..* |
| Type | Element |
| 52. Act.informant.typeCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ParticipationInformationGenerator |
| Type | code |
| Default Value | INF |
| Fixed Value | INF |
| 53. Act.informant.contextControlCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ContextControl |
| Type | code |
| Default Value | OP |
| Fixed Value | OP |
| 54. Act.informant.assignedEntity | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/AssignedEntity |
| 55. Act.informant.relatedEntity | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/RelatedEntity |
| 56. Act.participant | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Participant2 |
| 57. 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) |
| 58. Act.entryRelationship.typeCode | |
| Control | 1..1 |
| Type | code |
| 59. Act.entryRelationship.inversionInd | |
| Control | 0..1 |
| Type | boolean |
| 60. Act.entryRelationship.contextConductionInd | |
| Control | 1..1 |
| Type | boolean |
| Default Value | true |
| 61. Act.entryRelationship.sequenceNumber | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/INT |
| 62. Act.entryRelationship.negationInd | |
| Control | 0..1 |
| Type | boolean |
| 63. Act.entryRelationship.seperatableInd | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/BL |
| 64. Act.entryRelationship.observation | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Observation |
| 65. Act.entryRelationship.regionOfInterest | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest |
| 66. Act.entryRelationship.observationMedia | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ObservationMedia |
| 67. Act.entryRelationship.substanceAdministration | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration |
| 68. Act.entryRelationship.supply | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Supply |
| 69. Act.entryRelationship.procedure | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Procedure |
| 70. Act.entryRelationship.encounter | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Encounter |
| 71. Act.entryRelationship.organizer | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Organizer |
| 72. Act.entryRelationship.act | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Act |
| 73. Act.reference | |
| Control | 0..* |
| Type | Element |
| 74. Act.reference.typeCode | |
| Control | 1..1 |
| Type | code |
| 75. Act.reference.seperatableInd | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/BL |
| 76. Act.reference.externalAct | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ExternalAct |
| 77. Act.reference.externalObservation | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ExternalObservation |
| 78. Act.reference.externalProcedure | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ExternalProcedure |
| 79. Act.reference.externalDocument | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ExternalDocument |
| 80. Act.precondition | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Precondition |
IG © 2019+ Health Level Seven. Package hl7.cda.us.ccdar2dot2#2.2 based on FHIR 4.0.1. Generated 2022-05-13
Links: Table of Contents |
QA Report
| Version History 
|
|
Propose a change