Clinical Document Architecture
2.0.1 - active
Clinical Document Architecture
2.0.1 - active
Clinical Document Architecture, published by Health Level 7. This is not an authorized publication; it is the continuous build for version 2.0.1). This version is based on the current content of https://github.com/HL7/CDA-core-2.0/ and changes regularly. See the Directory of published versions
| Active as of 2023-10-03 |
Definitions for the ClinicalDocument logical model.
Guidance on how to interpret the contents of this table can be found here
| 0. ClinicalDocument | |
| Control | 1..1 |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:v3. |
| 2. ClinicalDocument.classCode | |
| Control | 0..1 |
| Binding | Unless not suitable, these codes SHALL be taken from ActClass |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | DOCCLIN |
| 4. ClinicalDocument.moodCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from ActMood |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | EVN |
| 6. ClinicalDocument.realmCode | |
| Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
| 8. ClinicalDocument.typeId | |
| Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question. |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 10. ClinicalDocument.typeId.root | |
| Control | 1..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | 2.16.840.1.113883.1.3 |
| 12. ClinicalDocument.typeId.extension | |
| Control | 1..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| 14. ClinicalDocument.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/cda/stds/core/StructureDefinition/II |
| 16. ClinicalDocument.id | |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 18. ClinicalDocument.code | |
| Control | 1..1 |
| Binding | Unless not suitable, these codes SHALL be taken from FHIRDocumentTypeCodes |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 20. ClinicalDocument.title | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ST |
| 22. ClinicalDocument.effectiveTime | |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TS |
| 24. ClinicalDocument.confidentialityCode | |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 26. ClinicalDocument.languageCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from HumanLanguage |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
| 28. ClinicalDocument.setId | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 30. ClinicalDocument.versionNumber | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/INT |
| 32. ClinicalDocument.copyTime | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TS |
| 34. ClinicalDocument.recordTarget | |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/RecordTarget |
| 36. ClinicalDocument.author | |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Author |
| 38. ClinicalDocument.dataEnterer | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/DataEnterer |
| 40. ClinicalDocument.informant | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Informant |
| 42. ClinicalDocument.custodian | |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Custodian |
| 44. ClinicalDocument.informationRecipient | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/InformationRecipient |
| 46. ClinicalDocument.legalAuthenticator | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/LegalAuthenticator |
| 48. ClinicalDocument.authenticator | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Authenticator |
| 50. ClinicalDocument.participant | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Participant1 |
| 52. ClinicalDocument.inFulfillmentOf | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/InFulfillmentOf |
| 54. ClinicalDocument.documentationOf | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/DocumentationOf |
| 56. ClinicalDocument.relatedDocument | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/RelatedDocument |
| 58. ClinicalDocument.authorization | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Authorization |
| 60. ClinicalDocument.componentOf | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ComponentOf |
| 62. ClinicalDocument.component | |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Component |
Guidance on how to interpret the contents of this table can be found here
| 0. ClinicalDocument | |
| Definition | Base definition for all types defined in FHIR type system. |
| Short | Base for all types and resources |
| Control | 10..1* |
| Is Modifier | false |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:v3. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 2. ClinicalDocument.classCode | |
| Control | 0..1 |
| Binding | Unless not suitable, these codes SHALL be taken from ActClass |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | DOCCLIN |
| 4. ClinicalDocument.moodCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from ActMood |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | EVN |
| 6. ClinicalDocument.realmCode | |
| Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
| 8. ClinicalDocument.typeId | |
| Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question. |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 10. ClinicalDocument.typeId.root | |
| Control | 1..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | 2.16.840.1.113883.1.3 |
| 12. ClinicalDocument.typeId.extension | |
| Control | 1..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| 14. ClinicalDocument.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/cda/stds/core/StructureDefinition/II |
| 16. ClinicalDocument.id | |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 18. ClinicalDocument.code | |
| Control | 1..1 |
| Binding | Unless not suitable, these codes SHALL be taken from FHIRDocumentTypeCodes |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 20. ClinicalDocument.title | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ST |
| 22. ClinicalDocument.effectiveTime | |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TS |
| 24. ClinicalDocument.confidentialityCode | |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 26. ClinicalDocument.languageCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from HumanLanguage |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
| 28. ClinicalDocument.setId | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 30. ClinicalDocument.versionNumber | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/INT |
| 32. ClinicalDocument.copyTime | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TS |
| 34. ClinicalDocument.recordTarget | |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/RecordTarget |
| 36. ClinicalDocument.author | |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Author |
| 38. ClinicalDocument.dataEnterer | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/DataEnterer |
| 40. ClinicalDocument.informant | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Informant |
| 42. ClinicalDocument.custodian | |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Custodian |
| 44. ClinicalDocument.informationRecipient | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/InformationRecipient |
| 46. ClinicalDocument.legalAuthenticator | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/LegalAuthenticator |
| 48. ClinicalDocument.authenticator | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Authenticator |
| 50. ClinicalDocument.participant | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Participant1 |
| 52. ClinicalDocument.inFulfillmentOf | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/InFulfillmentOf |
| 54. ClinicalDocument.documentationOf | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/DocumentationOf |
| 56. ClinicalDocument.relatedDocument | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/RelatedDocument |
| 58. ClinicalDocument.authorization | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Authorization |
| 60. ClinicalDocument.componentOf | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ComponentOf |
| 62. ClinicalDocument.component | |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Component |
Guidance on how to interpret the contents of this table can be found here
| 0. ClinicalDocument | |
| Definition | Base definition for all types defined in FHIR type system. |
| Short | Base for all types and resources |
| Control | 1..1 |
| Is Modifier | false |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:v3. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 2. ClinicalDocument.classCode | |
| Control | 0..1 |
| Binding | Unless not suitable, these codes SHALL be taken from ActClass |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | DOCCLIN |
| 4. ClinicalDocument.moodCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from ActMood |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | EVN |
| 6. ClinicalDocument.realmCode | |
| Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
| 8. ClinicalDocument.typeId | |
| Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question. |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 10. ClinicalDocument.typeId.root | |
| Control | 1..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | 2.16.840.1.113883.1.3 |
| 12. ClinicalDocument.typeId.extension | |
| Control | 1..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| 14. ClinicalDocument.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/cda/stds/core/StructureDefinition/II |
| 16. ClinicalDocument.id | |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 18. ClinicalDocument.code | |
| Control | 1..1 |
| Binding | Unless not suitable, these codes SHALL be taken from FHIRDocumentTypeCodes |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 20. ClinicalDocument.title | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ST |
| 22. ClinicalDocument.effectiveTime | |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TS |
| 24. ClinicalDocument.confidentialityCode | |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 26. ClinicalDocument.languageCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from HumanLanguage |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
| 28. ClinicalDocument.setId | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 30. ClinicalDocument.versionNumber | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/INT |
| 32. ClinicalDocument.copyTime | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TS |
| 34. ClinicalDocument.recordTarget | |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/RecordTarget |
| 36. ClinicalDocument.author | |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Author |
| 38. ClinicalDocument.dataEnterer | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/DataEnterer |
| 40. ClinicalDocument.informant | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Informant |
| 42. ClinicalDocument.custodian | |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Custodian |
| 44. ClinicalDocument.informationRecipient | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/InformationRecipient |
| 46. ClinicalDocument.legalAuthenticator | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/LegalAuthenticator |
| 48. ClinicalDocument.authenticator | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Authenticator |
| 50. ClinicalDocument.participant | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Participant1 |
| 52. ClinicalDocument.inFulfillmentOf | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/InFulfillmentOf |
| 54. ClinicalDocument.documentationOf | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/DocumentationOf |
| 56. ClinicalDocument.relatedDocument | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/RelatedDocument |
| 58. ClinicalDocument.authorization | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Authorization |
| 60. ClinicalDocument.componentOf | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ComponentOf |
| 62. ClinicalDocument.component | |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Component |
IG © 2019+ Health Level 7. Package hl7.cda.uv.core#2.0.1 based on FHIR 5.0.0. Generated 2023-10-03
Links: Table of Contents |
QA Report
| Version History 
|
|
Propose a change