CDA Examples
1.0.0 - active United States of America flag

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

Example: Narrative Reference - Supply

Approval Status: Approved
Task Force Approval: 2017-06-01
SDWG Approval: 2017-07-06

This example demonstrates how to link the section narrative (section.text) to the coded information (entry) below. The example includes several comments and does not conform to any specific C-CDA/CDA template. The principles agreed to in this sample should be present in all other examples.


  <!--  The following section is fictitious - it exists solely for the purpose of showing examples of text/reference and originalText/reference from discrete entry children. As such, many elements are omitted and replaced by ... comments. The text and content in the discrete entry elements does not use actual clinical content, but instead relies on filler text commonly used in publishing and graphic design.  -->
<section xmlns="urn:hl7-org:v3">
  <text>
    <!--  The text in this section is created strictly to illustrate how discrete entry child elements make references into the human readable text.   -->
    <!--  this list is used for a simple supply; the ID values are meant to be unique across the whole document  -->
    <list listType="unordered" ID="NonMedicinalSupplyFullTextReference">
      <item ID="NonMedicinalSupplSupplyActCodeReference1">Maecenas nec odio et ante tincidunt tempus.
        <content ID="NonMedicinalplayingDeviceCodeReference1"> et ante tincidunt</content>
      </item>
    </list>
  </text>
  <!--  This illustrates a simple supply. in C-CDA this is used as a Non-Medicinal Supply Activity, a Planned Supply, or via entryRelationships as various supply activities.  -->
  <entry>
    <supply moodCode="EVN" classCode="SPLY">
      <!--  ...  -->
      <!--  the code is optional. no guidance is provided for it's use in C-CDA  -->
      <code displayName="loreum ipsum" codeSystem="1.2.3.4.5.6.7.8.42"
            code="12345">
        <originalText>
          <reference value="#NonMedicinalSupplSupplyActCodeReference1"/>
        </originalText>
      </code>
      <!--  Example, using non-medicinal supply: VVV Cardiac Pacemaker 22-Feb2016 to 26-Feb-2016 Status: normal Quantity: 1 Supplied: yes  -->
      <text>
        <reference value="#NonMedicinalSupplyFullTextReference"/>
      </text>
      <!--  ...  -->
      <participant typeCode="PRD">
        <participantRole classCode="MANU">
          <playingDevice>
            <code displayName="loreum ipsum" codeSystem="1.2.3.4.5.6.7.8.42"
                  code="12345">
              <originalText>
                <!--  the value of this reference begins with hashtag, and is followed by text that is the value of an ID element in the human readable text
                     notice that the referenced text is similar to but different than the @displayName  of the code element
                     from an interoperability perspective, this pattern is a SHOULD as access to the human readable text reflecting the (code, codeSystem) in use is beneficial to consuming systems
                      -->
                <reference value="#NonMedicinalplayingDeviceCodeReference1"/>
              </originalText>
            </code>
          </playingDevice>
          <scopingEntity/>
        </participantRole>
      </participant>
    </supply>
  </entry>
</section>