R5 Final QA

This page is part of the FHIR Specification (v5.0.0-draft-final: Final QA Preview for R5 - see ballot notes). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R4B R4 R3

Example ValueSet/name-assembly-order (XML)

Terminology Infrastructure Work GroupMaturity Level: N/AStandards Status: Informative

Raw XML (canonical form + also see XML Format Specification)

Definition for Value SetHumanNameAssemblyOrder

<?xml version="1.0" encoding="UTF-8"?>

<ValueSet xmlns="http://hl7.org/fhir">
  <id value="name-assembly-order"/> 
  <meta> 
    <lastUpdated value="2023-03-01T23:03:57.298+11:00"/> 
    <profile value="http://hl7.org/fhir/StructureDefinition/shareablevalueset"/> 
  </meta> 
  <text> 
    <status value="extensions"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">
      <p> This value set includes codes based on the following rules:</p> 
      <ul> 
        <li> Include all codes defined in 
          <a href="codesystem-name-assembly-order.html">
            <code> http://terminology.hl7.org/CodeSystem/name-assembly-order</code> 
          </a> 
        </li> 
        <li> Include these codes as defined in 
          <a href="http://terminology.hl7.org/4.0.0/CodeSystem-v2-0444.html">
            <code> http://terminology.hl7.org/CodeSystem/v2-0444</code> 
          </a> 
          <table class="none">
            <tr> 
              <td style="white-space:nowrap">
                <b> Code</b> 
              </td> 
              <td> 
                <b> Display</b> 
              </td> 
              <td> 
                <b> Definition</b> 
              </td> 
            </tr> 
            <tr> 
              <td> 
                <a href="http://terminology.hl7.org/4.0.0/CodeSystem-v2-0444.html#v2-0444-F">F</a> 
              </td> 
              <td> Prefix Family Given Suffix</td> 
              <td> Prefix Family Middle Given Suffix</td> 
            </tr> 
            <tr> 
              <td> 
                <a href="http://terminology.hl7.org/4.0.0/CodeSystem-v2-0444.html#v2-0444-G">G</a> 
              </td> 
              <td> Prefix Given Family Suffix</td> 
              <td> Prefix Given Middle Family Suffix</td> 
            </tr> 
          </table> 
        </li> 
        <li> Include these codes as defined in 
          <a href="http://terminology.hl7.org/4.0.0/CodeSystem-v3-NullFlavor.html">
            <code> http://terminology.hl7.org/CodeSystem/v3-NullFlavor</code> 
          </a> 
          <table class="none">
            <tr> 
              <td style="white-space:nowrap">
                <b> Code</b> 
              </td> 
              <td> 
                <b> Display</b> 
              </td> 
              <td> 
                <b> Definition</b> 
              </td> 
            </tr> 
            <tr> 
              <td> 
                <a href="http://terminology.hl7.org/4.0.0/CodeSystem-v3-NullFlavor.html#v3-NullFlavor-UNK">UNK</a> 
              </td> 
              <td> Unknown</td> 
              <td> **Description:**A proper value is applicable, but not known.
                <br/>  
                <br/>  **Usage Notes**: This means the actual value is not known. If the only thing that
                 is unknown is how to properly express the value in the necessary constraints (value
                 set, datatype, etc.), then the OTH or UNC flavor should be used. No properties
                 should be included for a datatype with this property unless:
                <br/>  
                <br/>  1.  Those properties themselves directly translate to a semantic of &quot;unknown&quot;.
                 (E.g. a local code sent as a translation that conveys 'unknown')
                <br/>  2.  Those properties further qualify the nature of what is unknown. (E.g. specifying
                 a use code of &quot;H&quot; and a URL prefix of &quot;tel:&quot; to convey that
                 it is the home phone number that is unknown.)
              </td> 
            </tr> 
          </table> 
        </li> 
      </ul> 
    </div> 
  </text> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="fhir"/> 
  </extension> 
  <url value="http://hl7.org/fhir/ValueSet/name-assembly-order"/> 
  <identifier> 
    <system value="urn:ietf:rfc:3986"/> 
    <value value="urn:oid:2.16.840.1.113883.4.642.3.913"/> 
  </identifier> 
  <version value="5.0.0-draft-final"/> 
  <name value="HumanNameAssemblyOrder"/> 
  <title value="HumanNameAssemblyOrder"/> 
  <status value="draft"/> 
  <experimental value="false"/> 
  <date value="2023-03-01T23:03:57+11:00"/> 
  <publisher value="HL7 (FHIR Project)"/> 
  <contact> 
    <telecom> 
      <system value="url"/> 
      <value value="http://hl7.org/fhir"/> 
    </telecom> 
    <telecom> 
      <system value="email"/> 
      <value value="fhir@lists.hl7.org"/> 
    </telecom> 
  </contact> 
  <description value="A code that represents the preferred display order of the components of a human
   name."/> 
  <jurisdiction> 
    <coding> 
      <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/> 
      <code value="001"/> 
      <display value="World"/> 
    </coding> 
  </jurisdiction> 
  <immutable value="true"/> 
  <compose> 
    <include> 
      <system value="http://terminology.hl7.org/CodeSystem/name-assembly-order"/> 
    </include> 
    <include> 
      <system value="http://terminology.hl7.org/CodeSystem/v2-0444"/> 
      <concept> 
        <code value="F"/> 
        <display value="Prefix Family Given Suffix"/> 
      </concept> 
      <concept> 
        <code value="G"/> 
        <display value="Prefix Given Family Suffix"/> 
      </concept> 
    </include> 
    <include> 
      <system value="http://terminology.hl7.org/CodeSystem/v3-NullFlavor"/> 
      <concept> 
        <code value="UNK"/> 
        <display value="Unknown"/> 
      </concept> 
    </include> 
  </compose> 
</ValueSet> 

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.