Consolidated CDA (C-CDA)
4.0.0-ballot - STU4 Ballot United States of America flag

Consolidated CDA (C-CDA), published by Health Level Seven. This guide is not an authorized publication; it is the continuous build for version 4.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/CDA-ccda/ and changes regularly. See the Directory of published versions

Logical Model: ExternalDocumentReference - Detailed Descriptions

Draft as of 2024-12-19

Definitions for the ExternalDocumentReference logical model.

Guidance on how to interpret the contents of this table can be found here

0. ExternalDocument
Logical ContainerClinicalDocument (CDA Class)
ValidationInstance of this type are validated by templateId
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
Invariantsshould-setId: SHOULD contain setId (setId.exists())
should-versionNumber: SHOULD contain versionNumber (versionNumber.exists())
2. ExternalDocument.templateId
Control1..?
SlicingThis element introduces a set of slices on ExternalDocument.templateId. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ root
  • value @ extension
  • 4. ExternalDocument.templateId:external-doc-ref
    Slice Nameexternal-doc-ref
    Control1..1
    6. ExternalDocument.templateId:external-doc-ref.root
    Control1..?
    Pattern Value2.16.840.1.113883.10.20.22.4.115
    8. ExternalDocument.templateId:external-doc-ref.extension
    Control1..?
    Pattern Value2014-06-09
    10. ExternalDocument.classCode
    Comments

    SHALL contain exactly one [1..1] @classCode="DOCCLIN" Clinical Document (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6) (CONF:1098-31931).

    Control1..?
    Fixed ValueDOCCLIN
    12. ExternalDocument.moodCode
    Comments

    SHALL contain exactly one [1..1] @moodCode="EVN" Event (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001) (CONF:1098-31932).

    Control1..?
    14. ExternalDocument.id
    Comments

    SHALL contain exactly one [1..1] id (CONF:1098-32751).

    Control1..1
    16. ExternalDocument.code
    Comments

    SHALL contain exactly one [1..1] code (CONF:1098-31933).

    Control1..?
    18. ExternalDocument.setId
    Comments

    SHOULD contain zero or one [0..1] setId (CONF:1098-32752).

    20. ExternalDocument.versionNumber
    Comments

    SHOULD contain zero or one [0..1] versionNumber (CONF:1098-32753).