2nd DSTU Draft For Comment

This page is part of the FHIR Specification (v0.4.0: DSTU 2 Draft). 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-EntityNamePartQualifierR2.xml

Raw XML (canonical form)

Description: The qualifier is a set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. For example, a given name may be flagged as a nickname, a family name may be a pseudonym or a name of public records.

Raw XML

<ValueSet xmlns="http://hl7.org/fhir">
  <id value="v3-EntityNamePartQualifierR2"/>
  <meta>
    <lastUpdated value="2014-12-11T00:00:00.000+11:00"/>
    <profile value="http://hl7.org/fhir/Profile/valueset-shareable-definition"/>
  </meta>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><!-- Snipped for brevity --></div>
  </text>
  <extension url="http://hl7.org/fhir/ExtensionDefinition/valueset-oid">
    <valueUri value="urn:oid:2.16.840.1.113883.1.11.20323"/>
  </extension>
  <url value="http://hl7.org/fhir/v3/vs/EntityNamePartQualifierR2"/>
  <version value="2014-12-11"/>
  <name value="v3 Code System EntityNamePartQualifierR2"/>
  <publisher value="HL7, Inc"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://hl7.org"/>
    </telecom>
  </contact>
  <description value="  Description: The qualifier is a set of codes each of which specifies a certain subcategory
     of the name part in addition to the main name part type. For example, a given name may
     be flagged as a nickname, a family name may be a pseudonym or a name of public records."/>
  <status value="active"/>
  <experimental value="false"/>
  <date value="2014-12-11"/>
  <define>
    <extension url="http://hl7.org/fhir/ExtensionDefinition/valueset-oid">
      <valueUri value="urn:oid:2.16.840.1.113883.5.1122"/>
    </extension>
    <system value="http://hl7.org/fhir/v3/EntityNamePartQualifierR2"/>
    <caseSensitive value="true"/>
    <concept>
      <code value="AD"/>
      <abstract value="false"/>
      <display value="acquired"/>
      <definition value="Description: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)."/>
      <concept>
        <code value="SP"/>
        <abstract value="false"/>
        <display value="spouse"/>
        <definition value="Description:The name assumed from the partner in a marital relationship.  Usually the
           spouse's family name.  Note that no inference about gender can be made from the existence
           of spouse names."/>
      </concept>
    </concept>
    <concept>
      <code value="BR"/>
      <abstract value="false"/>
      <display value="birth"/>
      <definition value="Description: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 &quot;Baby of Smith&quot; a&quot; which
         is just a name with a use code of &quot;TEMP&quot;."/>
    </concept>
    <concept>
      <code value="CL"/>
      <abstract value="false"/>
      <display value="callme"/>
      <definition value="Description:Used to indicate which of the various name parts is used when interacting
         with the person."/>
    </concept>
    <concept>
      <code value="IN"/>
      <abstract value="false"/>
      <display value="initial"/>
      <definition value="Description: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.  In some languages, 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;."/>
    </concept>
    <concept>
      <code value="LS"/>
      <abstract value="false"/>
      <display value="legal status"/>
      <definition value="Description: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."/>
    </concept>
    <concept>
      <code value="MID"/>
      <abstract value="false"/>
      <display value="middle name"/>
      <definition value="Description:Indicates that the name part is a middle name.                           
                                   Usage Notes: 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;. Note that there are specific rules that
         indicate what names may be taken as a mellannamn in different Scandinavian countries."/>
    </concept>
    <concept>
      <code value="PFX"/>
      <abstract value="false"/>
      <display value="prefix"/>
      <definition value="Description:A prefix has a strong association to the immediately following name part.
         A prefix has no implicit trailing white space (it has implicit leading white space though)."/>
    </concept>
    <concept>
      <code value="PharmaceuticalEntityNamePartQualifiers"/>
      <abstract value="true"/>
      <display value="PharmaceuticalEntityNamePartQualifiers"/>
      <definition value="Description: Medication Name Parts are a means of specifying a range of acceptable &quot;official&qu
        ot; 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."/>
      <concept>
        <code value="CON"/>
        <abstract value="false"/>
        <display value="container name"/>
        <definition value="Description: This refers to the container if present in the medicinal product name.  
                                  EXAMPLES:                                                     
                                           For Optaflu suspension for injection in pre-filled syringe
           Influenza vaccine (surface antigen, inactivated, prepared in cell culture) (2007/2008
           season): pre-filled syringe"/>
      </concept>
      <concept>
        <code value="DEV"/>
        <abstract value="false"/>
        <display value="device name"/>
        <definition value="Description: This refers to the qualifiers in the name for devices and is at the moment
           mainly applicable to insulins and inhalation products.                          EXAMPLES:
                                                                                                For
           the medicinal product Actrapid FlexPen 100 IU/ml Solution for injection Subcutaneous use:
           FlexPen."/>
      </concept>
      <concept>
        <code value="FLAV"/>
        <abstract value="false"/>
        <display value="FlavorName"/>
        <definition value="Description: This refers to a flavor of the medicinal product if present in the medicinal
           product name.                                                      Examples:         
                                                                                For 'CoughCure Linctus
           Orange Flavor', the flavor part is &quot;Orange&quot;                            For 'Wonderdrug
           Syrup Cherry Flavor', the flavor part is &quot;Cherry&quot;"/>
      </concept>
      <concept>
        <code value="FORMUL"/>
        <abstract value="false"/>
        <display value="FormulationPartName"/>
        <definition value="Description: This refers to the formulation of the medicinal product if present in the
           medicinal product name.                                                      Examples:
                                                                                         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;"/>
      </concept>
      <concept>
        <code value="FRM"/>
        <abstract value="false"/>
        <display value="form name"/>
        <definition value="Description: This refers to the pharmaceutical form/ if present in the medicinal product
           name.                          EXAMPLES:                                             
                                                   For Agenerase 50 mg soft capsules: Soft Capsules
                                                                                                
            For Ludiomil 25mg-Filmtabletten: Filmtabletten                                      
                                                            For Optaflu suspension for injection
           in pre-filled syringe Influenza vaccine (surface antigen, inactivated, prepared in cell
           culture) (2007/2008 season): suspension for injection"/>
      </concept>
      <concept>
        <code value="INV"/>
        <abstract value="false"/>
        <display value="invented name"/>
        <definition value="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.          
                           EXAMPLES:                                                            
                                    Agenerase                                                   
                                               Optaflu                                          
                                                        Ludiomil"/>
      </concept>
      <concept>
        <code value="POPUL"/>
        <abstract value="false"/>
        <display value="TargetPopulationName"/>
        <definition value="Description: This refers to the target population for the medicinal product if present
           in the medicinal product name                                                      Examples:
                                                                                         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&quo
          t;"/>
      </concept>
      <concept>
        <code value="SCI"/>
        <abstract value="false"/>
        <display value="scientific name"/>
        <definition value="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.                          EXAMPLES:                                 
                                                               For Agenerase: N/A               
                                                                                   For Optaflu: Influenza
           vaccine (surface antigen, inactivated, prepared in cell culture) (2007/2008 season)  
                                                                                                For
           Ludiomil: N/A"/>
      </concept>
      <concept>
        <code value="STR"/>
        <abstract value="false"/>
        <display value="strength name"/>
        <definition value="Description: This refers to the strength if present in the medicinal product name. The
           use of decimal points should be accommodated if required.                          EXAMPLES:
                                                                                               For
           Agenerase 50 mg soft capsules: 50mg                                                  
                                                For Ludiomil 25mg-Filmtabletten: 25 mg          
                                                                                        For Optaflu
           suspension for injection in pre-filled syringe Influenza vaccine (surface antigen, inactivated,
           prepared in cell culture) (2007/2008 season): N/A"/>
      </concept>
      <concept>
        <code value="TIME"/>
        <abstract value="false"/>
        <display value="TimeOrPeriodName"/>
        <definition value="Description: This refers to a time or time period that may be specified in the text of
           the medicinal product name                                                      Example:
                                                                                         For an influenza
           vaccine 'Drug-FLU season 2008/2009', the time/period part is &quot;2008/2009 season&quot;"/>
      </concept>
      <concept>
        <code value="TMK"/>
        <abstract value="false"/>
        <display value="trademark name"/>
        <definition value="Description: This refers to trademark/company element if present in the medicinal product
           name.                          EXAMPLES:                                             
                                                   for Insulin Human Winthrop Comb 15: Winthrop"/>
      </concept>
      <concept>
        <code value="USE"/>
        <abstract value="false"/>
        <display value="intended use name"/>
        <definition value="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.                                                       Examples:
                                                                                         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;"/>
      </concept>
    </concept>
    <concept>
      <code value="SFX"/>
      <abstract value="false"/>
      <display value="suffix"/>
      <definition value="Description:A suffix has a strong association to the immediately preceding name part.
         A suffix has no implicit leading white space (it has implicit trailing white space though)."/>
    </concept>
    <concept>
      <code value="TitleStyles"/>
      <abstract value="true"/>
      <display value="TitleStyles"/>
      <definition value="Description:Extra information about the style of a title"/>
      <concept>
        <code value="AC"/>
        <abstract value="false"/>
        <display value="academic"/>
        <definition value="Description:Indicates that a title like &quot;Dr.&quot;, &quot;M.D.&quot; or &quot;Ph.D.&quot;
           is an academic title."/>
      </concept>
      <concept>
        <code value="HON"/>
        <abstract value="false"/>
        <display value="honorific"/>
        <definition value="Description:A honorific such as &quot;The Right Honourable&quot; or &quot;Weledelgeleerde
           Heer&quot;."/>
      </concept>
      <concept>
        <code value="NB"/>
        <abstract value="false"/>
        <display value="nobility"/>
        <definition value="Description:A nobility title such as Sir, Count, Grafin."/>
      </concept>
      <concept>
        <code value="PR"/>
        <abstract value="false"/>
        <display value="professional"/>
        <definition value="Description:Primarily in the British Imperial culture people tend to have an abbreviation
           of their professional organization as part of their credential titles."/>
      </concept>
    </concept>
  </define>
</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.