Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: R5 Ballot - 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 R2

Example ValueSet/name-part-qualifier (XML)

Vocabulary Work GroupMaturity Level: N/AStandards Status: Informative

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

Definition for Value SetEntityNamePartQualifier

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

<ValueSet xmlns="http://hl7.org/fhir">
  <id value="name-part-qualifier"/> 
  <meta> 
    <lastUpdated value="2022-09-10T04:52:37.223+10: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 these codes as defined in 
          <a href="http://terminology.hl7.org/3.1.0/CodeSystem-v3-EntityNamePartQualifierR2.html">
            <code> http://terminology.hl7.org/CodeSystem/v3-EntityNamePartQualifierR2</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/3.1.0/CodeSystem-v3-EntityNamePartQualifierR2.html#v3-EntityNamePa
                rtQualifierR2-LS">LS</a> 
              </td> 
              <td> Legal status</td> 
              <td> For organizations a suffix indicating the legal status, e.g., Inc., &quot;Co.&quot;,
                 &quot;AG&quot;, &quot;GmbH&quot;, &quot;B.V.&quot; &quot;S.A.&quot;, &quot;Ltd.&quot;
                 Etc.</td> 
            </tr> 
            <tr> 
              <td> 
                <a href="http://terminology.hl7.org/3.1.0/CodeSystem-v3-EntityNamePartQualifierR2.html#v3-EntityNamePa
                rtQualifierR2-AC">AC</a> 
              </td> 
              <td> Academic</td> 
              <td> Indicates that a prefix like &quot;Dr.&quot; or a suffix like &quot;M.D.&quot;
                 or &quot;Ph.D.&quot; is an academic title.</td> 
            </tr> 
            <tr> 
              <td> 
                <a href="http://terminology.hl7.org/3.1.0/CodeSystem-v3-EntityNamePartQualifierR2.html#v3-EntityNamePa
                rtQualifierR2-NB">NB</a> 
              </td> 
              <td> Nobility</td> 
              <td> In Europe and Asia, there are still people with nobility titles (aristocrats).
                 German &quot;von&quot; is generally a nobility title, not a mere voorvoegsel. Others
                 are &quot;Earl of&quot; or &quot;His Majesty King of...&quot; etc. Rarely used
                 nowadays, but some systems do keep  track of this.</td> 
            </tr> 
            <tr> 
              <td> 
                <a href="http://terminology.hl7.org/3.1.0/CodeSystem-v3-EntityNamePartQualifierR2.html#v3-EntityNamePa
                rtQualifierR2-PR">PR</a> 
              </td> 
              <td> Professional</td> 
              <td> Primarily in the British Imperial culture people tend to have an abbreviation of
                 their professional organization as part of their credential suffices</td> 
            </tr> 
            <tr> 
              <td> 
                <a href="http://terminology.hl7.org/3.1.0/CodeSystem-v3-EntityNamePartQualifierR2.html#v3-EntityNamePa
                rtQualifierR2-HON">HON</a> 
              </td> 
              <td> Honorific</td> 
              <td> An honorific such as &quot;The Right Honourable&quot; or &quot;Weledelgeleerde
                 Heer&quot;.</td> 
            </tr> 
            <tr> 
              <td> 
                <a href="http://terminology.hl7.org/3.1.0/CodeSystem-v3-EntityNamePartQualifierR2.html#v3-EntityNamePa
                rtQualifierR2-BR">BR</a> 
              </td> 
              <td> Birth</td> 
              <td> A name that a person was given at birth or established as a consequence of adoption.
                 NOTE: This is not used for temporary names assigned at birth such as 'Baby of Smith'
                 – which is just a name with a use code of TEMP</td> 
            </tr> 
            <tr> 
              <td> 
                <a href="http://terminology.hl7.org/3.1.0/CodeSystem-v3-EntityNamePartQualifierR2.html#v3-EntityNamePa
                rtQualifierR2-AD">AD</a> 
              </td> 
              <td> Acquired</td> 
              <td> A name part a person acquired. The name part may be acquired by adoption, or the
                 person may have chosen to use the name part for some other reason. NOTE  This differs
                 from an other/psuedonym/alias in that an acquired name part is acquired on a formal
                 basis rather than an informal one (e.g. registered as part of the official name)</td> 
            </tr> 
            <tr> 
              <td> 
                <a href="http://terminology.hl7.org/3.1.0/CodeSystem-v3-EntityNamePartQualifierR2.html#v3-EntityNamePa
                rtQualifierR2-SP">SP</a> 
              </td> 
              <td> Spouse</td> 
              <td> The name assumed from the partner in a marital relationship. Usually the spouse‘s
                 family name. No inference about gender may be made from the existence of spouse
                 names</td> 
            </tr> 
            <tr> 
              <td> 
                <a href="http://terminology.hl7.org/3.1.0/CodeSystem-v3-EntityNamePartQualifierR2.html#v3-EntityNamePa
                rtQualifierR2-MID">MID</a> 
              </td> 
              <td> Middle Name</td> 
              <td> Indicates that the name part is a middle name. In general, the  English  &quot;middle
                 name&quot;  concept is all of the given names after the first. This qualifier may
                 be used to explicitly indicate which given names are considered to be middle names.
                 The middle name qualifier may also be used with family names. This is a Scandinavian
                 use case, matching the concept of &quot;mellomnavn&quot;/&quot;mellannamn&quot;.
                 There are specific rules that indicate what names may be taken as a mellannamnin
                 different Scandinavian countries</td> 
            </tr> 
            <tr> 
              <td> 
                <a href="http://terminology.hl7.org/3.1.0/CodeSystem-v3-EntityNamePartQualifierR2.html#v3-EntityNamePa
                rtQualifierR2-CL">CL</a> 
              </td> 
              <td> Call me</td> 
              <td> Callme is used to indicate which of the various name parts is used when interacting
                 with the person</td> 
            </tr> 
            <tr> 
              <td> 
                <a href="http://terminology.hl7.org/3.1.0/CodeSystem-v3-EntityNamePartQualifierR2.html#v3-EntityNamePa
                rtQualifierR2-IN">IN</a> 
              </td> 
              <td> Initial</td> 
              <td> Indicates that a name part is just an initial. Initials do not imply a trailing
                 period since this would not work with non-Latin scripts. Initials may consist of
                 more than one letter, e.g., &quot;Ph.&quot; could stand for &quot;Philippe&quot;
                 or &quot;Th.&quot; for &quot;Thomas&quot;</td> 
            </tr> 
          </table> 
        </li> 
        <li> Include these codes as defined in 
          <a href="http://terminology.hl7.org/3.1.0/CodeSystem-v3-EntityNamePartQualifier.html">
            <code> http://terminology.hl7.org/CodeSystem/v3-EntityNamePartQualifier</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/3.1.0/CodeSystem-v3-EntityNamePartQualifier.html#v3-EntityNamePart
                Qualifier-VV">VV</a> 
              </td> 
              <td> Voorvoegsel</td> 
              <td> A Dutch &quot;voorvoegsel&quot; is something like &quot;van&quot; or &quot;de&quot;
                 that might have indicated nobility in the past but no longer so. Similar prefixes
                 exist in other languages such as German, Spanish, French or Portugese</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-part-qualifier"/> 
  <identifier> 
    <system value="urn:ietf:rfc:3986"/> 
    <value value="urn:oid:2.16.840.1.113883.4.642.3.906"/> 
  </identifier> 
  <version value="5.0.0-ballot"/> 
  <name value="EntityNamePartQualifier"/> 
  <title value="EntityNamePartQualifier"/> 
  <status value="draft"/> 
  <experimental value="false"/> 
  <date value="2022-09-10T04:52:37+10: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 set of codes each of which specifies a certain subcategory of the name part in
   addition to the main name part type."/> 
  <compose> 
    <include> 
      <system value="http://terminology.hl7.org/CodeSystem/v3-EntityNamePartQualifierR2"/> 
      <concept> 
        <extension url="http://hl7.org/fhir/StructureDefinition/valueset-concept-definition">
          <valueString value="For organizations a suffix indicating the legal status, e.g., Inc., &quot;Co.&quot;,
           &quot;AG&quot;, &quot;GmbH&quot;, &quot;B.V.&quot; &quot;S.A.&quot;, &quot;Ltd.&quot;
           Etc."/> 
        </extension> 
        <code value="LS"/> 
        <display value="Legal status"/> 
      </concept> 
      <concept> 
        <extension url="http://hl7.org/fhir/StructureDefinition/valueset-concept-definition">
          <valueString value="Indicates that a prefix like &quot;Dr.&quot; or a suffix like &quot;M.D.&quot;
           or &quot;Ph.D.&quot; is an academic title."/> 
        </extension> 
        <code value="AC"/> 
        <display value="Academic"/> 
      </concept> 
      <concept> 
        <extension url="http://hl7.org/fhir/StructureDefinition/valueset-concept-definition">
          <valueString value="In Europe and Asia, there are still people with nobility titles (aristocrats).
           German &quot;von&quot; is generally a nobility title, not a mere voorvoegsel. Others
           are &quot;Earl of&quot; or &quot;His Majesty King of...&quot; etc. Rarely used
           nowadays, but some systems do keep  track of this."/> 
        </extension> 
        <code value="NB"/> 
        <display value="Nobility"/> 
      </concept> 
      <concept> 
        <extension url="http://hl7.org/fhir/StructureDefinition/valueset-concept-definition">
          <valueString value="Primarily in the British Imperial culture people tend to have an abbreviation of
           their professional organization as part of their credential suffices"/> 
        </extension> 
        <code value="PR"/> 
        <display value="Professional"/> 
      </concept> 
      <concept> 
        <extension url="http://hl7.org/fhir/StructureDefinition/valueset-concept-definition">
          <valueString value="An honorific such as &quot;The Right Honourable&quot; or &quot;Weledelgeleerde
           Heer&quot;."/> 
        </extension> 
        <code value="HON"/> 
        <display value="Honorific"/> 
      </concept> 
      <concept> 
        <extension url="http://hl7.org/fhir/StructureDefinition/valueset-concept-definition">
          <valueString value="A name that a person was given at birth or established as a consequence of adoption.
           NOTE: This is not used for temporary names assigned at birth such as 'Baby of Smith'
           – which is just a name with a use code of TEMP"/> 
        </extension> 
        <code value="BR"/> 
        <display value="Birth"/> 
      </concept> 
      <concept> 
        <extension url="http://hl7.org/fhir/StructureDefinition/valueset-concept-definition">
          <valueString value="A name part a person acquired. The name part may be acquired by adoption, or the
           person may have chosen to use the name part for some other reason. NOTE  This differs
           from an other/psuedonym/alias in that an acquired name part is acquired on a formal
           basis rather than an informal one (e.g. registered as part of the official name)"/> 
        </extension> 
        <code value="AD"/> 
        <display value="Acquired"/> 
      </concept> 
      <concept> 
        <extension url="http://hl7.org/fhir/StructureDefinition/valueset-concept-definition">
          <valueString value="The name assumed from the partner in a marital relationship. Usually the spouse‘s
           family name. No inference about gender may be made from the existence of spouse
           names"/> 
        </extension> 
        <code value="SP"/> 
        <display value="Spouse"/> 
      </concept> 
      <concept> 
        <extension url="http://hl7.org/fhir/StructureDefinition/valueset-concept-definition">
          <valueString value="Indicates that the name part is a middle name. In general, the  English  &quot;middle
           name&quot;  concept is all of the given names after the first. This qualifier may
           be used to explicitly indicate which given names are considered to be middle names.
           The middle name qualifier may also be used with family names. This is a Scandinavian
           use case, matching the concept of &quot;mellomnavn&quot;/&quot;mellannamn&quot;.
           There are specific rules that indicate what names may be taken as a mellannamnin
           different Scandinavian countries"/> 
        </extension> 
        <code value="MID"/> 
        <display value="Middle Name"/> 
      </concept> 
      <concept> 
        <extension url="http://hl7.org/fhir/StructureDefinition/valueset-concept-definition">
          <valueString value="Callme is used to indicate which of the various name parts is used when interacting
           with the person"/> 
        </extension> 
        <code value="CL"/> 
        <display value="Call me"/> 
      </concept> 
      <concept> 
        <extension url="http://hl7.org/fhir/StructureDefinition/valueset-concept-definition">
          <valueString value="Indicates that a name part is just an initial. Initials do not imply a trailing
           period since this would not work with non-Latin scripts. Initials may consist of
           more than one letter, e.g., &quot;Ph.&quot; could stand for &quot;Philippe&quot;
           or &quot;Th.&quot; for &quot;Thomas&quot;"/> 
        </extension> 
        <code value="IN"/> 
        <display value="Initial"/> 
      </concept> 
    </include> 
    <include> 
      <system value="http://terminology.hl7.org/CodeSystem/v3-EntityNamePartQualifier"/> 
      <concept> 
        <extension url="http://hl7.org/fhir/StructureDefinition/valueset-concept-definition">
          <valueString value="A Dutch &quot;voorvoegsel&quot; is something like &quot;van&quot; or &quot;de&quot;
           that might have indicated nobility in the past but no longer so. Similar prefixes
           exist in other languages such as German, Spanish, French or Portugese"/> 
        </extension> 
        <code value="VV"/> 
        <display value="Voorvoegsel"/> 
      </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.