Patient Aliases

back to homepage

Approval Status

Approval Status: Approved Example Task Force: 11/7/2019 SDWG: 5/28/2020

C-CDA 2.1 Example:

US Realm Patient Name (PTN.US.FIELDED) 2.16.840.1.113883.

Reference to full CDA sample:


Validation location



Best practices for sending one or more patient aliases


Matt Szczepankiewicz (GitHub: mjszczep)


Demographics, Name, Aliases, Callme


Patient Aliases (C-CDA R2.1).xml



Example: download example view on GitHub

    <!-- Best practices for sending one or more patient aliases -->
    <!-- Note: This snippet omits other data elements required to meet C-CDA R2.1 requirements (telecom, address, etc.) -->
        <id nullFlavor="NI" />
            <!-- SHALL contain at least one [1..*] US Realm Patient Name (CONF:1198-5284) -->
            <name use="L">
            <!-- Recommended way to send patient aliases; note @use='P' (pseudonym) and given/@qualifier='CL' (callme) -->
            <name use="P">
                <given qualifier="CL">Dee</given>
  1. C-CDA Example Search Help

    C-CDA Example Search Results
    This screen displays the results of executing the example search criteria against the existing examples recorded in the example database.

  2. Search Criteria Panel

    This panel allow you to further refine your queries and narrow the results

  3. Text Search Words

    Use this field to enter words related to your search. These words can appear in the title, the comments or as part of a special list of keywords associated with the example. The search words should be entered with spaces separating the items.

  4. Filter by example status

    By selecting the various statuses, the search results can be limited to only the example that are set to the selected status(es). By removing all status selections, the filtering is removed and examples from all statuses will be returned (based on any other filtering).

  5. Select only ONC Certified examples

    These are samples referenced in a government rule or certification companion guide.

  6. Execute the search based on the criteria entered (or retrieve all examples if no criteria specified).

  7. The number of results that match the query parameters can be found here.

  8. Use this link to jump back to the initial page of the application (that lists the sections).

  9. This columns list the names of the examples that match the criteria (and the comment for each example).

  10. This columns lists the area in the C-CDA specification (the specification is broken into distinct topics for the various exchangeable documents, the common header, and the sections that occur within the exchangeable documents) that the example demonstrates.

  11. This columns lists the state of the example in the example verification and approval process.

  12. You can select to download the examples directly or navigate to page with the full detailed description of the example.

  13. Tour Complete

    Return to the C-CDA Example Search Results page.