R4 Ballot #2 (Mixed Normative/Trial use)

This page is part of the FHIR Specification (v3.5.0: R4 Ballot #2). 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: R4 R3 R2

V3-EntityNameUseR2.xml

Vocabulary Work GroupMaturity Level: N/ABallot Status: Informative

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

Description: A set of codes advising a system or user which name in a set of names to select for a given purpose.

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

<ValueSet xmlns="http://hl7.org/fhir">
  <id value="v3-EntityNameUseR2"/> 
  <meta> 
    <lastUpdated value="2018-08-12T00:00:00.000+10:00"/> 
    <profile value="http://hl7.org/fhir/StructureDefinition/shareablevalueset"/> 
  </meta> 
  <text> 
    <status value="generated"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">
      <p> Release Date: 2018-08-12</p> 

      <table class="grid">
 
        <tr> 
          <td> 
            <b> Level</b> 
          </td> 
          <td> 
            <b> Code</b> 
          </td> 
          <td> 
            <b> Display</b> 
          </td> 
          <td> 
            <b> Definition</b> 
          </td> 
        </tr> 
 
        <tr> 
          <td> 1</td> 
          <td> 
            <span style="color: grey">
              <i> (Assumed)</i> 
            </span>  
            <b> 
              <i> Abstract</i> 
            </b> 
          </td> 
          <td> 
            <a name="v3-EntityNameUseR2-Assumed"> </a> 
          </td> 
          <td> 
                        
                           Description:A name that a person has assumed or has been assumed
               to them. 
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 2</td> 
          <td>   A
            <a name="v3-EntityNameUseR2-A"> </a> 
          </td> 
          <td> business name</td> 
          <td> 
                        
                           Description:A name used in a Professional or Business context
               .  Examples: Continuing to use a maiden name in a professional context, or using a stage
               performing name (some of these names are also pseudonyms)
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 2</td> 
          <td>   ANON
            <a name="v3-EntityNameUseR2-ANON"> </a> 
          </td> 
          <td> Anonymous</td> 
          <td> 
                        
                           Description:Anonymous assigned name (used to protect a persons
               identity for privacy reasons)
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 2</td> 
          <td>   I
            <a name="v3-EntityNameUseR2-I"> </a> 
          </td> 
          <td> Indigenous/Tribal</td> 
          <td> 
                        
                           Description:e.g .  Chief Red Cloud
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 2</td> 
          <td>   P
            <a name="v3-EntityNameUseR2-P"> </a> 
          </td> 
          <td> Other/Pseudonym/Alias</td> 
          <td> 
                        
                           Description:A non-official name by which the person is sometimes
               known.  (This may also be used to record informal names such as a nickname)
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 2</td> 
          <td>   R
            <a name="v3-EntityNameUseR2-R"> </a> 
          </td> 
          <td> religious</td> 
          <td> 
                        
                           Description:A name assumed as part of a religious vocation
               .  e.g .  Sister Mary Francis, Brother John
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 1</td> 
          <td> C
            <a name="v3-EntityNameUseR2-C"> </a> 
          </td> 
          <td> customary</td> 
          <td> 
                        
                           Description:Known as/conventional/the one you normally use
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 1</td> 
          <td> M
            <a name="v3-EntityNameUseR2-M"> </a> 
          </td> 
          <td> maiden name</td> 
          <td> 
                        
                           Description:A name used prior to marriage.Note that marriage
               naming customs vary greatly around the world.  This name use is for use by applications
               that collect and store maiden names.  Though the concept of maiden name is often gender
               specific, the use of this term is not gender specific.  The use of this term does not
               imply any particular history for a person's name, nor should the maiden name be determined
               algorithmically
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 1</td> 
          <td> 
            <span style="color: grey">
              <i> (NameRepresentationUse)</i> 
            </span>  
            <b> 
              <i> Abstract</i> 
            </b> 
          </td> 
          <td> 
            <a name="v3-EntityNameUseR2-NameRepresentationUse"> </a> 
          </td> 
          <td> 
                        
                           Description:Identifies the different representations of a name
               .  The representation may affect how the name is used .  (E.g .  use of Ideographic for
               formal communications.) 
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 2</td> 
          <td>   ABC
            <a name="v3-EntityNameUseR2-ABC"> </a> 
          </td> 
          <td> alphabetic</td> 
          <td> 
                        
                           Description:Alphabetic transcription of name in latin alphabet
               (Japanese: romaji)
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 2</td> 
          <td>   IDE
            <a name="v3-EntityNameUseR2-IDE"> </a> 
          </td> 
          <td> ideographic</td> 
          <td> 
                        
                           Description:Ideographic representation of name (e.g., Japanese
               kanji, Chinese characters)
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 2</td> 
          <td>   SYL
            <a name="v3-EntityNameUseR2-SYL"> </a> 
          </td> 
          <td> syllabic</td> 
          <td> 
                        
                           Description:Syllabic transcription of name (e.g., Japanese
               kana, Korean hangul)
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 1</td> 
          <td> OLD
            <a name="v3-EntityNameUseR2-OLD"> </a> 
          </td> 
          <td> no longer in use</td> 
          <td> 
                        
                           Description:This name is no longer in use (note: Names may
               also carry valid time ranges .  This code is used to cover the situations where it is
               known that the name is no longer valid, but no particular time range for its use is known)
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 2</td> 
          <td>   DN
            <a name="v3-EntityNameUseR2-DN"> </a> 
          </td> 
          <td> do not use</td> 
          <td> 
                        
                           Description:This name should no longer be used when interacting
               with the person (i.e .  in addition to no longer being used, the name should not be even
               mentioned when interacting with the person)Note: applications are not required to compare
               names labeled &quot;Do Not Use&quot; and other names in order to eliminate name parts
               that are common between the other name and a name labeled &quot;Do Not Use&quot;.
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 1</td> 
          <td> OR
            <a name="v3-EntityNameUseR2-OR"> </a> 
          </td> 
          <td> official registry name</td> 
          <td> 
                        
                           Description:The formal name as registered in an official (government)
               registry, but which name might not be commonly used .  May correspond to the concept of
               legal name
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 1</td> 
          <td> PHON
            <a name="v3-EntityNameUseR2-PHON"> </a> 
          </td> 
          <td> phonetic</td> 
          <td> 
                        
                           Description:The name as understood by the data enterer, i.e.
               a close approximation of a phonetic spelling of the name, not based on a phonetic algorithm.
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 1</td> 
          <td> SRCH
            <a name="v3-EntityNameUseR2-SRCH"> </a> 
          </td> 
          <td> search</td> 
          <td> 
                        
                           Description:A name intended for use in searching or matching.
                This is used when the name is incomplete and contains enough details for search matching,
               but not enough for other uses.
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 1</td> 
          <td> T
            <a name="v3-EntityNameUseR2-T"> </a> 
          </td> 
          <td> temporary</td> 
          <td> 
                        
                           Description:A temporary name.  Note that a name valid time
               can provide more detailed information.  This may also be used for temporary names assigned
               at birth or in emergency situations.
            <br/>  

                     
          </td> 
        </tr> 

      </table> 

    </div> 
  </text> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
    <valueString value="External"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
    <valueInteger value="0"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="vocab"/> 
  </extension> 
  <url value="http://terminology.hl7.org/ValueSet/v3-EntityNameUseR2"/> 
  <identifier> 
    <system value="urn:ietf:rfc:3986"/> 
    <value value="urn:oid:2.16.840.1.113883.1.11.20321"/> 
  </identifier> 
  <version value="2018-08-12"/> 
  <name value="v3.EntityNameUseR2"/> 
  <title value="v3 Code System EntityNameUseR2"/> 
  <status value="active"/> 
  <experimental value="false"/> 
  <date value="2018-08-12"/> 
  <publisher value="HL7, Inc"/> 
  <contact> 
    <telecom> 
      <system value="url"/> 
      <value value="http://hl7.org"/> 
    </telecom> 
  </contact> 
  <description value="  Description:
A set of codes advising a system or user which name in a set of names to select for a
     given purpose."/> 
  <immutable value="true"/> 
  <compose> 
    <include> 
      <system value="http://terminology.hl7.org/CodeSystem/v3-EntityNameUseR2"/> 
    </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.