Release 5 Preview #1

This page is part of the FHIR Specification (v4.2.0: R5 Preview #1). 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-EntityNamePartQualifier.xml

Vocabulary Work GroupMaturity Level: N/AStandards Status: Informative

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

OpenIssue: Needs description

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

<ValueSet xmlns="http://hl7.org/fhir">
  <id value="v3-EntityNamePartQualifier"/> 
  <meta> 
    <lastUpdated value="2019-07-31T00: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: 2019-07-31</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> (_OrganizationNamePartQualifier)</i> 
            </span>  
            <b> 
              <i> Abstract</i> 
            </b> 
          </td> 
          <td> 
            <a name="v3-EntityNamePartQualifier-_OrganizationNamePartQualifier"> </a> 
          </td> 
          <td/>  
        </tr> 
 
        <tr> 
          <td> 2</td> 
          <td>   AC
            <a name="v3-EntityNamePartQualifier-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.
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 2</td> 
          <td>   AD
            <a name="v3-EntityNamePartQualifier-AD"> </a> 
          </td> 
          <td> adopted</td> 
          <td> 
                        The name the person was given at the time of adoption.
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 2</td> 
          <td>   BR
            <a name="v3-EntityNamePartQualifier-BR"> </a> 
          </td> 
          <td> birth</td> 
          <td> 
                        A name that a person had shortly after being born. Usually for
               family names but may be used to mark given names at birth that may have changed later.
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 2</td> 
          <td>   CL
            <a name="v3-EntityNamePartQualifier-CL"> </a> 
          </td> 
          <td> callme</td> 
          <td> 
                        A callme name is (usually a given name) that is preferred when
               a person is directly addressed.
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 2</td> 
          <td>   IN
            <a name="v3-EntityNamePartQualifier-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;.
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 2</td> 
          <td>   LS
            <a name="v3-EntityNamePartQualifier-LS"> </a> 
          </td> 
          <td> Legal status</td> 
          <td> 
                        For organizations a suffix indicating the legal status, e.g.,
               &quot;Inc.&quot;, &quot;Co.&quot;, &quot;AG&quot;, &quot;GmbH&quot;, &quot;B.V.&quot;
               &quot;S.A.&quot;,  &quot;Ltd.&quot; etc.
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 2</td> 
          <td>   NB
            <a name="v3-EntityNamePartQualifier-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.
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 2</td> 
          <td>   PR
            <a name="v3-EntityNamePartQualifier-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.
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 2</td> 
          <td>   SP
            <a name="v3-EntityNamePartQualifier-SP"> </a> 
          </td> 
          <td> spouse</td> 
          <td> 
                        The name assumed from the partner in a marital relationship (hence
               the &quot;SP&quot;). Usually the spouse's family name. Note that no inference about gender
               can be made from the existence of spouse names.
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 2</td> 
          <td>   TITLE
            <a name="v3-EntityNamePartQualifier-TITLE"> </a> 
          </td> 
          <td> title</td> 
          <td> 
                        Indicates that a prefix or a suffix is a title that applies to
               the whole name, not just the adjacent name part.
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 2</td> 
          <td>   VV
            <a name="v3-EntityNamePartQualifier-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 Spanish, French or Portugese.
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 1</td> 
          <td> 
            <span style="color: grey">
              <i> (PharmaceuticalEntityNamePartQualifiers)</i> 
            </span>  
            <b> 
              <i> Abstract</i> 
            </b> 
          </td> 
          <td> 
            <a name="v3-EntityNamePartQualifier-PharmaceuticalEntityNamePartQualifiers"> </a> 
          </td> 
          <td> 
                        
                           Description: Medication Name Parts are a means of specifying
               a range of acceptable &quot;official&quot; forms of the name of a product.  They are used
               as patterns against which input name strings may be matched for automatic identification
               of products from input text reports.   While they cover the concepts held under &quot;doseForm&quot;
               or &quot;route&quot; or &quot;strength&quot; the name parts are not the same and do not
               fit into a controlled vocabulary in the same way. By specifying up to 8 name parts a much
               larger range of possible names can be generated.
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 2</td> 
          <td>   CON
            <a name="v3-EntityNamePartQualifier-CON"> </a> 
          </td> 
          <td> container name</td> 
          <td> 
                        
                           Description: This refers to the container if present in the
               medicinal product name.
            <br/>  

                        EXAMPLES: 
            <br/>  

                        
                           
                              For Optaflu suspension for injection in pre-filled syringe
               Influenza vaccine (surface antigen, inactivated, prepared in cell culture) (2007/2008
               season): pre-filled syringe
            <br/>  

                           
                        
                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 2</td> 
          <td>   DEV
            <a name="v3-EntityNamePartQualifier-DEV"> </a> 
          </td> 
          <td> device name</td> 
          <td> 
                        
                           Description: This refers to the qualifiers in the name for
               devices and is at the moment mainly applicable to insulins and inhalation products.
            <br/>  

                        EXAMPLES: 
            <br/>  

                        
                           
                              For the medicinal product Actrapid FlexPen 100 IU/ml Solution
               for injection Subcutaneous use: FlexPen.
            <br/>  

                           
                        
                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 2</td> 
          <td>   FLAV
            <a name="v3-EntityNamePartQualifier-FLAV"> </a> 
          </td> 
          <td> FlavorName</td> 
          <td> 
                        
                           Description: This refers to a flavor of the medicinal product
               if present in the medicinal product name.
            <br/>  

                        
                           Examples:
                        
            <br/>  

                        
                           For 'CoughCure Linctus Orange Flavor', the flavor part is &quot;Orange&qu
              ot;
                           For 'Wonderdrug Syrup Cherry Flavor', the flavor part is &quot;Cherry&quo
              t;
                        
                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 2</td> 
          <td>   FORMUL
            <a name="v3-EntityNamePartQualifier-FORMUL"> </a> 
          </td> 
          <td> FormulationPartName</td> 
          <td> 
                        
                           Description: This refers to the formulation of the medicinal
               product if present in the medicinal product name.
            <br/>  

                        
                           Examples:
                        
            <br/>  

                        
                           For 'SpecialMed Sugar Free Cough Syrup', the formulation name
               part is &quot;Sugar Free&quot;
                           For 'QuickCure Gluten-free Bulk Fibre', the formulation name
               part is &quot;gluten-free&quot;
                        
                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 2</td> 
          <td>   FRM
            <a name="v3-EntityNamePartQualifier-FRM"> </a> 
          </td> 
          <td> form name</td> 
          <td> 
                        
                           Description: This refers to the pharmaceutical form/ if present
               in the medicinal product name.
            <br/>  

                        EXAMPLES: 
            <br/>  

                        
                           
                              For Agenerase 50 mg soft capsules: Soft Capsules
            <br/>  

                           
                           
                              For Ludiomil 25mg-Filmtabletten: Filmtabletten
            <br/>  

                           
                           
                              For Optaflu suspension for injection in pre-filled syringe
               Influenza vaccine (surface antigen, inactivated, prepared in cell culture) (2007/2008
               season): suspension for injection
            <br/>  

                           
                        
                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 2</td> 
          <td>   INV
            <a name="v3-EntityNamePartQualifier-INV"> </a> 
          </td> 
          <td> invented name</td> 
          <td> 
                        
                           Description: This refers to the product name without the trademark
               or the name of the marketing authorization holder or any other descriptor reflected in
               the product name and, if appropriate, whether it is intended e.g. for babies, children
               or adults. 
            <br/>  

                        EXAMPLES: 
            <br/>  

                        
                           
                              Agenerase
            <br/>  

                           
                           
                              Optaflu
            <br/>  

                           
                           
                              Ludiomil
            <br/>  

                           
                        
                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 2</td> 
          <td>   POPUL
            <a name="v3-EntityNamePartQualifier-POPUL"> </a> 
          </td> 
          <td> TargetPopulationName</td> 
          <td> 
                        
                           Description: This refers to the target population for the medicinal
               product if present in the medicinal product name
            <br/>  

                        
                           Examples:
                        
            <br/>  

                        
                           For 'Broncho-Drug 3.5 mg-capsules for children', the target
               population part is &quot;children&quot;
                           For 'Adult Chesty Cough Syrup', the target population part
               is &quot;adult&quot;
                        
                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 2</td> 
          <td>   SCI
            <a name="v3-EntityNamePartQualifier-SCI"> </a> 
          </td> 
          <td> scientific name</td> 
          <td> 
                        
                           Description: This refers to the product common or scientific
               name without the trademark or the name of the marketing authorization holder or any other
               descriptor reflected in the product name.
            <br/>  

                        EXAMPLES: 
            <br/>  

                        
                           
                              For Agenerase: N/A
            <br/>  

                           
                           
                              For Optaflu: Influenza vaccine (surface antigen, inactivated,
               prepared in cell culture) (2007/2008 season)
            <br/>  

                           
                           
                              For Ludiomil: N/A
            <br/>  

                           
                        
                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 2</td> 
          <td>   STR
            <a name="v3-EntityNamePartQualifier-STR"> </a> 
          </td> 
          <td> strength name</td> 
          <td> 
                        
                           Description: This refers to the strength if present in the
               medicinal product name. The use of decimal points should be accommodated if required.
            <br/>  

                        EXAMPLES:
            <br/>  

                        
                           
                              For Agenerase 50 mg soft capsules: 50mg
            <br/>  

                           
                           
                              For Ludiomil 25mg-Filmtabletten: 25 mg
            <br/>  

                           
                           
                              For Optaflu suspension for injection in pre-filled syringe
               Influenza vaccine (surface antigen, inactivated, prepared in cell culture) (2007/2008
               season): N/A
            <br/>  

                           
                        
                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 2</td> 
          <td>   TIME
            <a name="v3-EntityNamePartQualifier-TIME"> </a> 
          </td> 
          <td> TimeOrPeriodName</td> 
          <td> 
                        
                           Description: This refers to a time or time period that may
               be specified in the text of the medicinal product name
            <br/>  

                        
                           Example:
                        
            <br/>  

                        
                           For an influenza vaccine 'Drug-FLU season 2008/2009', the time/period
               part is &quot;2008/2009 season&quot;
                        
                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 2</td> 
          <td>   TMK
            <a name="v3-EntityNamePartQualifier-TMK"> </a> 
          </td> 
          <td> trademark name</td> 
          <td> 
                        
                           Description: This refers to trademark/company element if present
               in the medicinal product name.
            <br/>  

                        EXAMPLES: 
            <br/>  

                        
                           
                              for Insulin Human Winthrop Comb 15: Winthrop
            <br/>  

                           
                        
                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 2</td> 
          <td>   USE
            <a name="v3-EntityNamePartQualifier-USE"> </a> 
          </td> 
          <td> intended use name</td> 
          <td> 
                        
                           Description: This refers to the intended use if present in
               the medicinal product name without the trademark or the name of the marketing authorization
               holder or any other descriptor reflected in the product name.

            <br/>  

                        
                           Examples:
                        
            <br/>  

                        
                           For 'Drug-BI Caplets - Heartburn Relief', the intended use
               part is: &quot;Heartburn Relief&quot;
                           For 'Medicine Honey Syrup for Soothing Coughs' the intended
               use part is &quot;Soothing Coughs&quot;
                        
                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 1</td> 
          <td> 
            <span style="color: grey">
              <i> (_PersonNamePartQualifier)</i> 
            </span>  
            <b> 
              <i> Abstract</i> 
            </b> 
          </td> 
          <td> 
            <a name="v3-EntityNamePartQualifier-_PersonNamePartQualifier"> </a> 
          </td> 
          <td/>  
        </tr> 
 
        <tr> 
          <td> 2</td> 
          <td>   
            <a href="#IN">IN</a> 
          </td> 
          <td/>  
          <td/>  
        </tr> 
 
        <tr> 
          <td> 2</td> 
          <td>   
            <a href="#TITLE">TITLE</a> 
          </td> 
          <td/>  
          <td/>  
        </tr> 
 
        <tr> 
          <td> 2</td> 
          <td>   
            <span style="color: grey">
              <i> (_PersonNamePartAffixTypes)</i> 
            </span>  
            <b> 
              <i> Abstract</i> 
            </b> 
          </td> 
          <td> 
            <a name="v3-EntityNamePartQualifier-_PersonNamePartAffixTypes"> </a> 
          </td> 
          <td/>  
        </tr> 
 
        <tr> 
          <td> 3</td> 
          <td>     
            <a href="#AC">AC</a> 
          </td> 
          <td/>  
          <td/>  
        </tr> 
 
        <tr> 
          <td> 3</td> 
          <td>     
            <a href="#NB">NB</a> 
          </td> 
          <td/>  
          <td/>  
        </tr> 
 
        <tr> 
          <td> 3</td> 
          <td>     
            <a href="#PR">PR</a> 
          </td> 
          <td/>  
          <td/>  
        </tr> 
 
        <tr> 
          <td> 3</td> 
          <td>     
            <a href="#VV">VV</a> 
          </td> 
          <td/>  
          <td/>  
        </tr> 
 
        <tr> 
          <td> 2</td> 
          <td>   
            <span style="color: grey">
              <i> (_PersonNamePartChangeQualifier)</i> 
            </span>  
            <b> 
              <i> Abstract</i> 
            </b> 
          </td> 
          <td> 
            <a name="v3-EntityNamePartQualifier-_PersonNamePartChangeQualifier"> </a> 
          </td> 
          <td/>  
        </tr> 
 
        <tr> 
          <td> 3</td> 
          <td>     
            <a href="#AD">AD</a> 
          </td> 
          <td/>  
          <td/>  
        </tr> 
 
        <tr> 
          <td> 3</td> 
          <td>     
            <a href="#BR">BR</a> 
          </td> 
          <td/>  
          <td/>  
        </tr> 
 
        <tr> 
          <td> 3</td> 
          <td>     
            <a href="#SP">SP</a> 
          </td> 
          <td/>  
          <td/>  
        </tr> 
 
        <tr> 
          <td> 2</td> 
          <td>   
            <span style="color: grey">
              <i> (_PersonNamePartMiscQualifier)</i> 
            </span>  
            <b> 
              <i> Abstract</i> 
            </b> 
          </td> 
          <td> 
            <a name="v3-EntityNamePartQualifier-_PersonNamePartMiscQualifier"> </a> 
          </td> 
          <td/>  
        </tr> 
 
        <tr> 
          <td> 3</td> 
          <td>     
            <a href="#CL">CL</a> 
          </td> 
          <td/>  
          <td/>  
        </tr> 

      </table> 

    </div> 
  </text> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
    <valueCode 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-EntityNamePartQualifier"/> 
  <identifier> 
    <system value="urn:ietf:rfc:3986"/> 
    <value value="urn:oid:2.16.840.1.113883.1.11.15888"/> 
  </identifier> 
  <version value="2019-07-31"/> 
  <name value="v3.EntityNamePartQualifier"/> 
  <title value="v3 Code System EntityNamePartQualifier"/> 
  <status value="active"/> 
  <experimental value="false"/> 
  <date value="2019-07-31"/> 
  <publisher value="HL7, Inc"/> 
  <contact> 
    <telecom> 
      <system value="url"/> 
      <value value="http://hl7.org"/> 
    </telecom> 
  </contact> 
  <description value="  OpenIssue:
Needs description"/> 
  <immutable value="true"/> 
  <compose> 
    <include> 
      <system value="http://terminology.hl7.org/CodeSystem/v3-EntityNamePartQualifier"/> 
    </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.