Consolidated CDA
3.0.0-ballot - ballot
Consolidated CDA
3.0.0-ballot - ballot
This page is part of the CCDA: Consolidated CDA Release (v3.0.0-ballot: CCDA 3.0 Ballot 1) based on FHIR (HL7® FHIR® Standard) v5.0.0. . For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/ExternalDocumentReference | Version: 3.0.0-ballot | |||
| Draft as of 2023-12-21 | Computable Name: ExternalDocumentReference | |||
| Other Identifiers: id: urn:hl7ii:2.16.840.1.113883.10.20.22.4.115:2014-06-09 | ||||
Where it is necessary to reference an external clinical document, the External Document Reference template can be used to reference this external document. However, if the containing document is appending to or replacing another document in the same set, that relationship is set in the header, using ClinicalDocument/relatedDocument.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ExternalDocument
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  ExternalDocument | C | 1..1 | ExternalDocument | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, text, setId, versionNumber Base for all types and resources Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-setId: SHOULD contain setId should-versionNumber: SHOULD contain versionNumber |
  Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
   templateId:external-doc-ref | 1..1 | II | ||
  @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.115 | |
  @extension | 1..1 | st | Required Pattern: 2014-06-09 | |
 @classCode | 1..1 | cs | Fixed Value: DOCCLIN | |
| @moodCode | 1..1 | cs | ||
| id | 1..1 | II | ||
| code | 1..1 | CD | ||
| setId | 0..1 | II | ||
 versionNumber | 0..1 | INT | ||
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| should-setId | warning | ExternalDocument | SHOULD contain setId : setId.exists() | |
| should-versionNumber | warning | ExternalDocument | SHOULD contain versionNumber : versionNumber.exists() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ExternalDocument | C | 1..1 | ExternalDocument | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, text, setId, versionNumber Base for all types and resources Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-setId: SHOULD contain setId should-versionNumber: SHOULD contain versionNumber |
| Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:external-doc-ref | 1..1 | II | ||
 @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.115 | |
| @extension | 1..1 | st | Required Pattern: 2014-06-09 | |
| @classCode | 1..1 | cs | Binding: ActClassDocument (required) Fixed Value: DOCCLIN | |
| @moodCode | 1..1 | cs | Binding: ActMood (required) Fixed Value: EVN | |
 id | 1..1 | II | ||
| code | 1..1 | CD | Binding: FHIRDocumentTypeCodes (example) | |
| setId | 0..1 | II | ||
| versionNumber | 0..1 | INT | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| ExternalDocument.classCode | required | Fixed Value: DOCCLIN |
| ExternalDocument.moodCode | required | Fixed Value: EVN |
| ExternalDocument.code | example | FHIRDocumentTypeCodes |
| Id | Grade | Path(s) | Details | Requirements |
| should-setId | warning | ExternalDocument | SHOULD contain setId : setId.exists() | |
| should-versionNumber | warning | ExternalDocument | SHOULD contain versionNumber : versionNumber.exists() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ExternalDocument | C | 1..1 | ExternalDocument | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, text, setId, versionNumber Base for all types and resources Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-setId: SHOULD contain setId should-versionNumber: SHOULD contain versionNumber |
| @nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode | 0..* | CS | ||
| typeId | 0..1 | II | ||
| @nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName | 0..1 | st | ||
| @displayable | 0..1 | bl | ||
| @root | 1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension | 1..1 | st | ||
| Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:external-doc-ref | 1..1 | II | ||
| @nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName | 0..1 | st | ||
| @displayable | 0..1 | bl | ||
| @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.115 | |
| @extension | 1..1 | st | Required Pattern: 2014-06-09 | |
| @classCode | 1..1 | cs | Binding: ActClassDocument (required) Fixed Value: DOCCLIN | |
| @moodCode | 1..1 | cs | Binding: ActMood (required) Fixed Value: EVN | |
| id | 1..1 | II | ||
| code | 1..1 | CD | Binding: FHIRDocumentTypeCodes (example) | |
| text | 0..1 | ED | ||
| setId | 0..1 | II | ||
| versionNumber | 0..1 | INT | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| ExternalDocument.nullFlavor | required | CDANullFlavor |
| ExternalDocument.typeId.nullFlavor | required | CDANullFlavor |
| ExternalDocument.templateId:external-doc-ref.nullFlavor | required | CDANullFlavor |
| ExternalDocument.classCode | required | Fixed Value: DOCCLIN |
| ExternalDocument.moodCode | required | Fixed Value: EVN |
| ExternalDocument.code | example | FHIRDocumentTypeCodes |
| Id | Grade | Path(s) | Details | Requirements |
| should-setId | warning | ExternalDocument | SHOULD contain setId : setId.exists() | |
| should-versionNumber | warning | ExternalDocument | SHOULD contain versionNumber : versionNumber.exists() |
This structure is derived from ExternalDocument
Summary
Mandatory: 8 elements
Fixed Value: 1 element
Slices
This structure defines the following Slices:
Differential View
This structure is derived from ExternalDocument
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ExternalDocument | C | 1..1 | ExternalDocument | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, text, setId, versionNumber Base for all types and resources Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-setId: SHOULD contain setId should-versionNumber: SHOULD contain versionNumber |
| Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:external-doc-ref | 1..1 | II | ||
| @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.115 | |
| @extension | 1..1 | st | Required Pattern: 2014-06-09 | |
| @classCode | 1..1 | cs | Fixed Value: DOCCLIN | |
| @moodCode | 1..1 | cs | ||
| id | 1..1 | II | ||
| code | 1..1 | CD | ||
| setId | 0..1 | II | ||
| versionNumber | 0..1 | INT | ||
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| should-setId | warning | ExternalDocument | SHOULD contain setId : setId.exists() | |
| should-versionNumber | warning | ExternalDocument | SHOULD contain versionNumber : versionNumber.exists() |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ExternalDocument | C | 1..1 | ExternalDocument | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, text, setId, versionNumber Base for all types and resources Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-setId: SHOULD contain setId should-versionNumber: SHOULD contain versionNumber |
| Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:external-doc-ref | 1..1 | II | ||
| @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.115 | |
| @extension | 1..1 | st | Required Pattern: 2014-06-09 | |
| @classCode | 1..1 | cs | Binding: ActClassDocument (required) Fixed Value: DOCCLIN | |
| @moodCode | 1..1 | cs | Binding: ActMood (required) Fixed Value: EVN | |
| id | 1..1 | II | ||
| code | 1..1 | CD | Binding: FHIRDocumentTypeCodes (example) | |
| setId | 0..1 | II | ||
| versionNumber | 0..1 | INT | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| ExternalDocument.classCode | required | Fixed Value: DOCCLIN |
| ExternalDocument.moodCode | required | Fixed Value: EVN |
| ExternalDocument.code | example | FHIRDocumentTypeCodes |
| Id | Grade | Path(s) | Details | Requirements |
| should-setId | warning | ExternalDocument | SHOULD contain setId : setId.exists() | |
| should-versionNumber | warning | ExternalDocument | SHOULD contain versionNumber : versionNumber.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ExternalDocument | C | 1..1 | ExternalDocument | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, text, setId, versionNumber Base for all types and resources Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-setId: SHOULD contain setId should-versionNumber: SHOULD contain versionNumber |
| @nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode | 0..* | CS | ||
| typeId | 0..1 | II | ||
| @nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName | 0..1 | st | ||
| @displayable | 0..1 | bl | ||
| @root | 1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension | 1..1 | st | ||
| Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:external-doc-ref | 1..1 | II | ||
| @nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName | 0..1 | st | ||
| @displayable | 0..1 | bl | ||
| @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.115 | |
| @extension | 1..1 | st | Required Pattern: 2014-06-09 | |
| @classCode | 1..1 | cs | Binding: ActClassDocument (required) Fixed Value: DOCCLIN | |
| @moodCode | 1..1 | cs | Binding: ActMood (required) Fixed Value: EVN | |
| id | 1..1 | II | ||
| code | 1..1 | CD | Binding: FHIRDocumentTypeCodes (example) | |
| text | 0..1 | ED | ||
| setId | 0..1 | II | ||
| versionNumber | 0..1 | INT | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| ExternalDocument.nullFlavor | required | CDANullFlavor |
| ExternalDocument.typeId.nullFlavor | required | CDANullFlavor |
| ExternalDocument.templateId:external-doc-ref.nullFlavor | required | CDANullFlavor |
| ExternalDocument.classCode | required | Fixed Value: DOCCLIN |
| ExternalDocument.moodCode | required | Fixed Value: EVN |
| ExternalDocument.code | example | FHIRDocumentTypeCodes |
| Id | Grade | Path(s) | Details | Requirements |
| should-setId | warning | ExternalDocument | SHOULD contain setId : setId.exists() | |
| should-versionNumber | warning | ExternalDocument | SHOULD contain versionNumber : versionNumber.exists() |
This structure is derived from ExternalDocument
Summary
Mandatory: 8 elements
Fixed Value: 1 element
Slices
This structure defines the following Slices:
IG © 2019+ Health Level Seven. Package hl7.cda.us.ccda#3.0.0-ballot based on FHIR 5.0.0. Generated 2023-12-21
Links: Table of Contents |
QA Report
| Version History 
|
|
Propose a change