Clinical Document Architecture V2.0.1
2.1.0-draft1 - 1st Draft
Clinical Document Architecture V2.0.1
2.1.0-draft1 - 1st Draft
This page is part of the CDA: Clinical Document Architecture (v2.1.0-draft1: CDA 2.1 Draft) generated with FHIR (HL7® FHIR® Standard) v5.0.0. This version is a pre-release. The current official version is 2.0.2-sd. For a full list of available versions, see the Directory of published versions
| Active as of 2023-01-16 |
Definitions for the ClinicalDocument logical model.
Guidance on how to interpret the contents of this table can be found here.
| 1. ClinicalDocument | |
| Control | 1..1 |
| XML Representation | In the XML format, this property has the namespace urn:hl7-org:v3. |
| 2. ClinicalDocument.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActClass; other codes may be used where these codes are not suitable |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | DOCCLIN |
| Fixed Value | DOCCLIN |
| 3. ClinicalDocument.moodCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActMood |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | EVN |
| Fixed Value | EVN |
| 4. 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/fhir/cda/StructureDefinition/CS |
| 5. 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/fhir/cda/StructureDefinition/II |
| 6. 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/fhir/cda/StructureDefinition/II |
| 7. ClinicalDocument.id | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 8. ClinicalDocument.code | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from FHIRDocumentTypeCodes; other codes may be used where these codes are not suitable |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| 9. ClinicalDocument.title | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ST |
| 10. ClinicalDocument.effectiveTime | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TS |
| 11. ClinicalDocument.confidentialityCode | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| 12. ClinicalDocument.languageCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from HumanLanguage |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CS |
| 13. ClinicalDocument.setId | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 14. ClinicalDocument.versionNumber | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/INT |
| 15. ClinicalDocument.copyTime | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TS |
| 16. ClinicalDocument.recordTarget | |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/RecordTarget |
| 17. ClinicalDocument.author | |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Author |
| 18. ClinicalDocument.dataEnterer | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/DataEnterer |
| 19. ClinicalDocument.informant | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Informant |
| 20. ClinicalDocument.custodian | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Custodian |
| 21. ClinicalDocument.informationRecipient | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/InformationRecipient |
| 22. ClinicalDocument.legalAuthenticator | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/LegalAuthenticator |
| 23. ClinicalDocument.authenticator | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Authenticator |
| 24. ClinicalDocument.participant | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Participant1 |
| 25. ClinicalDocument.inFulfillmentOf | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/InFulfillmentOf |
| 26. ClinicalDocument.documentationOf | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/DocumentationOf |
| 27. ClinicalDocument.relatedDocument | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/RelatedDocument |
| 28. ClinicalDocument.authorization | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Authorization |
| 29. ClinicalDocument.componentOf | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ComponentOf |
| 30. ClinicalDocument.component | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Component2 |
Guidance on how to interpret the contents of this table can be found here.
| 1. ClinicalDocument | |
| Definition | Base definition for all types defined in FHIR type system. |
| Control | 10..1* |
| XML Representation | In the XML format, this property has the namespace urn:hl7-org:v3. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 2. ClinicalDocument.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActClass; other codes may be used where these codes are not suitable |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | DOCCLIN |
| Fixed Value | DOCCLIN |
| 3. ClinicalDocument.moodCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActMood |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | EVN |
| Fixed Value | EVN |
| 4. 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/fhir/cda/StructureDefinition/CS |
| 5. 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/fhir/cda/StructureDefinition/II |
| 6. 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/fhir/cda/StructureDefinition/II |
| 7. ClinicalDocument.id | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 8. ClinicalDocument.code | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from FHIRDocumentTypeCodes; other codes may be used where these codes are not suitable |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| 9. ClinicalDocument.title | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ST |
| 10. ClinicalDocument.effectiveTime | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TS |
| 11. ClinicalDocument.confidentialityCode | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| 12. ClinicalDocument.languageCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from HumanLanguage |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CS |
| 13. ClinicalDocument.setId | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 14. ClinicalDocument.versionNumber | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/INT |
| 15. ClinicalDocument.copyTime | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TS |
| 16. ClinicalDocument.recordTarget | |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/RecordTarget |
| 17. ClinicalDocument.author | |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Author |
| 18. ClinicalDocument.dataEnterer | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/DataEnterer |
| 19. ClinicalDocument.informant | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Informant |
| 20. ClinicalDocument.custodian | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Custodian |
| 21. ClinicalDocument.informationRecipient | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/InformationRecipient |
| 22. ClinicalDocument.legalAuthenticator | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/LegalAuthenticator |
| 23. ClinicalDocument.authenticator | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Authenticator |
| 24. ClinicalDocument.participant | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Participant1 |
| 25. ClinicalDocument.inFulfillmentOf | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/InFulfillmentOf |
| 26. ClinicalDocument.documentationOf | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/DocumentationOf |
| 27. ClinicalDocument.relatedDocument | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/RelatedDocument |
| 28. ClinicalDocument.authorization | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Authorization |
| 29. ClinicalDocument.componentOf | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ComponentOf |
| 30. ClinicalDocument.component | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Component2 |
Guidance on how to interpret the contents of this table can be found here.
| 1. ClinicalDocument | |
| Definition | Base definition for all types defined in FHIR type system. |
| Control | 1..1 |
| XML Representation | In the XML format, this property has the namespace urn:hl7-org:v3. |
| 2. ClinicalDocument.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActClass; other codes may be used where these codes are not suitable |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | DOCCLIN |
| Fixed Value | DOCCLIN |
| 3. ClinicalDocument.moodCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActMood |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | EVN |
| Fixed Value | EVN |
| 4. 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/fhir/cda/StructureDefinition/CS |
| 5. 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/fhir/cda/StructureDefinition/II |
| 6. 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/fhir/cda/StructureDefinition/II |
| 7. ClinicalDocument.id | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 8. ClinicalDocument.code | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from FHIRDocumentTypeCodes; other codes may be used where these codes are not suitable |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| 9. ClinicalDocument.title | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ST |
| 10. ClinicalDocument.effectiveTime | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TS |
| 11. ClinicalDocument.confidentialityCode | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| 12. ClinicalDocument.languageCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from HumanLanguage |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CS |
| 13. ClinicalDocument.setId | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 14. ClinicalDocument.versionNumber | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/INT |
| 15. ClinicalDocument.copyTime | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TS |
| 16. ClinicalDocument.recordTarget | |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/RecordTarget |
| 17. ClinicalDocument.author | |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Author |
| 18. ClinicalDocument.dataEnterer | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/DataEnterer |
| 19. ClinicalDocument.informant | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Informant |
| 20. ClinicalDocument.custodian | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Custodian |
| 21. ClinicalDocument.informationRecipient | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/InformationRecipient |
| 22. ClinicalDocument.legalAuthenticator | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/LegalAuthenticator |
| 23. ClinicalDocument.authenticator | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Authenticator |
| 24. ClinicalDocument.participant | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Participant1 |
| 25. ClinicalDocument.inFulfillmentOf | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/InFulfillmentOf |
| 26. ClinicalDocument.documentationOf | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/DocumentationOf |
| 27. ClinicalDocument.relatedDocument | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/RelatedDocument |
| 28. ClinicalDocument.authorization | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Authorization |
| 29. ClinicalDocument.componentOf | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ComponentOf |
| 30. ClinicalDocument.component | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Component2 |
IG © 2019+ Health Level 7. Package hl7.cda.uv.core#2.1.0-draft1 based on FHIR 5.0.0-snapshot3. Generated 2023-01-16
Links: Table of Contents |
QA Report
| Version History 
|
|
Propose a change