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: Person Name Formatting

Approval Status: Approved
Task Force Approval: 2019-08-29
SDWG Approval: 2019-10-10

This example demonstrates the idea that name pieces should be sent in a logical display order (ie such that a receiver which only extracts the text and ignores the markup around <given>, <family>, etc. would still display the name in a way a human would interpret correctly).

This file includes examples of the following templates: 


<recordTarget xmlns="urn:hl7-org:v3">
  <!--  Examples of how systems send names and logical display order  -->
  <!--  Note: This snippet omits other data elements required to meet C-CDA R2.1 requirements (telecom, address, etc.)  -->
  <patientRole>
    <id nullFlavor="NI"/>
    <patient>
      <!--  This is okay; "Robin Taylor" is a logical display order  -->
      <name>
        <given>Robin</given>
        <family>Taylor</family>
      </name>
      <!--  This is okay; "Taylor, Robin" implies Lastname, Firstname ordering in the US  -->
      <name>
        <family>Taylor</family>
        <delimiter>,</delimiter>
        <given>Robin</given>
      </name>
      <!--  This is okay; "Dr. Robin Taylor" is a logical display order  -->
      <name>
        <prefix qualifier="AC TITLE">Dr.</prefix>
        <!--  Space in element is intentional (see CDA R2.0 Section 2.23.4)  -->
        <given>Robin</given>
        <family>Taylor</family>
      </name>
      <!--  This is okay; "Robin Taylor MD" is a logical display order  -->
      <!--  Space in element is intentional (see CDA R2.0 Section 2.23.4)  -->
      <name>
        <given>Robin</given>
        <family>Taylor</family>
        <suffix qualifier="AC TITLE">MD</suffix>
      </name>
      <!--  Don't do this; "Robin Taylor Dr." isn't a logical display order  -->
      <!--  Space in element is intentional  -->
      <name>
        <given>Robin</given>
        <family>Taylor</family>
        <prefix qualifier="AC TITLE">Dr.</prefix>
      </name>
      <!--  Don't do this; "Taylor Robin" is confusing (is Taylor the given name?)  -->
      <name>
        <family>Taylor</family>
        <given>Robin</given>
      </name>
    </patient>
  </patientRole>
</recordTarget>