Consolidated CDA Release 2.1 StructureDefinition Prototype Publication
2.1.0-draft1 - CI Build
United States of America
Consolidated CDA Release 2.1 StructureDefinition Prototype Publication
2.1.0-draft1 - CI Build
United States of America
This page is part of the CCDA: Consolidated CDA Release (v2.1.0-draft1: CCDA 2.1 Draft) based on FHIR v5.0.0. . For a full list of available versions, see the Directory of published versions 
| Active as of 2023-01-16 |
Definitions for the 2.16.840.1.113883.10.20.22.4.115 resource profile.
Guidance on how to interpret the contents of this table can be found here.
| 1. ExternalDocument | |
| 2. ExternalDocument.classCode | |
| Requirements | SHALL contain exactly one [1..1] @classCode="DOCCLIN" Clinical Document (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6) (CONF:1098-31931). |
| Pattern Value | DOCCLIN |
| 3. ExternalDocument.moodCode | |
| Requirements | SHALL contain exactly one [1..1] @moodCode="EVN" Event (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001) (CONF:1098-31932). |
| Pattern Value | EVN |
| 4. ExternalDocument.templateId | |
| Slicing | This element introduces a set of slices on ExternalDocument.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 5. ExternalDocument.templateId:primary | |
| SliceName | primary |
| Control | 1..1 |
| Requirements | SHALL contain exactly one [1..1] templateId (CONF:1098-32748) such that it |
| 6. ExternalDocument.templateId:primary.root | |
| Control | 1..1 |
| Requirements | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.115" (CONF:1098-32750). |
| Pattern Value | 2.16.840.1.113883.10.20.22.4.115 |
| 7. ExternalDocument.templateId:primary.extension | |
| Control | 1..1 |
| Requirements | SHALL contain exactly one [1..1] @extension="2014-06-09" (CONF:1098-32749). |
| Pattern Value | 2014-06-09 |
| 8. ExternalDocument.id | |
| Control | 10..1* |
| Requirements | SHALL contain exactly one [1..1] id (CONF:1098-32751). |
| 9. ExternalDocument.code | |
| Control | 10..1 |
| Requirements | SHALL contain exactly one [1..1] code (CONF:1098-31933). |
| 10. ExternalDocument.setId | |
| Requirements | SHOULD contain zero or one [0..1] setId (CONF:1098-32752). |
| 11. ExternalDocument.versionNumber | |
| Requirements | SHOULD contain zero or one [0..1] versionNumber (CONF:1098-32753). |
Guidance on how to interpret the contents of this table can be found here.
| 1. ExternalDocument | |
| Definition | Base definition for all types defined in FHIR type system. |
| Control | 10..1* |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 2. ExternalDocument.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActClassDocument |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | SHALL contain exactly one [1..1] @classCode="DOCCLIN" Clinical Document (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6) (CONF:1098-31931). |
| Default Value | DOC |
| Pattern Value | DOCCLIN |
| 3. ExternalDocument.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. |
| Requirements | SHALL contain exactly one [1..1] @moodCode="EVN" Event (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001) (CONF:1098-31932). |
| Default Value | EVN |
| Fixed Value | EVN |
| Pattern Value | EVN |
| 4. ExternalDocument.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 ExternalDocument.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 5. ExternalDocument.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-32748) such that it |
| 6. ExternalDocument.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 |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.115" (CONF:1098-32750). |
| Pattern Value | 2.16.840.1.113883.10.20.22.4.115 |
| 7. ExternalDocument.templateId:primary.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Control | 1..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | SHALL contain exactly one [1..1] @extension="2014-06-09" (CONF:1098-32749). |
| Pattern Value | 2014-06-09 |
| 8. ExternalDocument.id | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| Requirements | SHALL contain exactly one [1..1] id (CONF:1098-32751). |
| 9. ExternalDocument.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/CD |
| Requirements | SHALL contain exactly one [1..1] code (CONF:1098-31933). |
| 10. ExternalDocument.setId | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| Requirements | SHOULD contain zero or one [0..1] setId (CONF:1098-32752). |
| 11. ExternalDocument.versionNumber | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/INT |
| Requirements | SHOULD contain zero or one [0..1] versionNumber (CONF:1098-32753). |
Guidance on how to interpret the contents of this table can be found here.
| 1. ExternalDocument | |
| Definition | Base definition for all types defined in FHIR type system. |
| Control | 1..1 |
| 2. ExternalDocument.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActClassDocument |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | SHALL contain exactly one [1..1] @classCode="DOCCLIN" Clinical Document (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6) (CONF:1098-31931). |
| Default Value | DOC |
| Pattern Value | DOCCLIN |
| 3. ExternalDocument.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. |
| Requirements | SHALL contain exactly one [1..1] @moodCode="EVN" Event (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001) (CONF:1098-31932). |
| Default Value | EVN |
| Fixed Value | EVN |
| Pattern Value | EVN |
| 4. ExternalDocument.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 ExternalDocument.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 5. ExternalDocument.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-32748) such that it |
| 6. ExternalDocument.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 |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 7. ExternalDocument.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 |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 8. ExternalDocument.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 |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 9. ExternalDocument.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 |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.115" (CONF:1098-32750). |
| Pattern Value | 2.16.840.1.113883.10.20.22.4.115 |
| 10. ExternalDocument.templateId:primary.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Control | 1..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | SHALL contain exactly one [1..1] @extension="2014-06-09" (CONF:1098-32749). |
| Pattern Value | 2014-06-09 |
| 11. ExternalDocument.id | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| Requirements | SHALL contain exactly one [1..1] id (CONF:1098-32751). |
| 12. ExternalDocument.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/CD |
| Requirements | SHALL contain exactly one [1..1] code (CONF:1098-31933). |
| 13. ExternalDocument.text | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
| 14. ExternalDocument.setId | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| Requirements | SHOULD contain zero or one [0..1] setId (CONF:1098-32752). |
| 15. ExternalDocument.versionNumber | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/INT |
| Requirements | SHOULD contain zero or one [0..1] versionNumber (CONF:1098-32753). |
IG © 2019+ Health Level Seven. Package hl7.cda.us.ccda#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