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
| Vocabulary Work Group | Maturity Level: N/A | Ballot Status: Informative |
Raw XML (canonical form + also see XML Format Specification)
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.
<?xml version="1.0" encoding="UTF-8"?> <CodeSystem xmlns="http://hl7.org/fhir"> <id value="v3-EntityNamePartQualifierR2"/> <meta> <lastUpdated value="2018-08-12T00:00:00.000+10:00"/> </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> AD <a name="v3-EntityNamePartQualifierR2-AD"> </a> </td> <td> acquired</td> <td> 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. <br/> 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). <br/> </td> </tr> <tr> <td> 2</td> <td> SP <a name="v3-EntityNamePartQualifierR2-SP"> </a> </td> <td> spouse</td> <td> 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. <br/> </td> </tr> <tr> <td> 1</td> <td> BR <a name="v3-EntityNamePartQualifierR2-BR"> </a> </td> <td> birth</td> <td> Description:A name that a person was given at birth or established as a consequence of adoption. <br/> Note: This is not used for temporary names assigned at birth such as "Baby of Smith" a" which is just a name with a use code of "TEMP". <br/> </td> </tr> <tr> <td> 1</td> <td> CL <a name="v3-EntityNamePartQualifierR2-CL"> </a> </td> <td> callme</td> <td> Description:Used to indicate which of the various name parts is used when interacting with the person. <br/> </td> </tr> <tr> <td> 1</td> <td> IN <a name="v3-EntityNamePartQualifierR2-IN"> </a> </td> <td> initial</td> <td> 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., "Ph" could stand for "Philippe" or "Th" For "Thomas". <br/> </td> </tr> <tr> <td> 1</td> <td> LS <a name="v3-EntityNamePartQualifierR2-LS"> </a> </td> <td> legal status</td> <td> Description:For organizations a suffix indicating the legal status, e.g., "Inc.", "Co.", "AG", "GmbH", "B.V." "S.A.", "Ltd." etc. <br/> </td> </tr> <tr> <td> 1</td> <td> MID <a name="v3-EntityNamePartQualifierR2-MID"> </a> </td> <td> middle name</td> <td> Description:Indicates that the name part is a middle name. <br/> Usage Notes: In general, the english "middle name" 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 "mellomnavn","mellannamn". Note that there are specific rules that indicate what names may be taken as a mellannamn in different Scandinavian countries. <br/> </td> </tr> <tr> <td> 1</td> <td> PFX <a name="v3-EntityNamePartQualifierR2-PFX"> </a> </td> <td> prefix</td> <td> 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). <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-EntityNamePartQualifierR2-PharmaceuticalEntityNamePartQualifiers"> </a> </td> <td> Description: Medication Name Parts are a means of specifying a range of acceptable "official" 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 "doseForm" or "route" or "strength" 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-EntityNamePartQualifierR2-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-EntityNamePartQualifierR2-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-EntityNamePartQualifierR2-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 "Orange&qu ot; For 'Wonderdrug Syrup Cherry Flavor', the flavor part is "Cherry&quo t; </td> </tr> <tr> <td> 2</td> <td> FORMUL <a name="v3-EntityNamePartQualifierR2-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 "Sugar Free" For 'QuickCure Gluten-free Bulk Fibre', the formulation name part is "gluten-free" </td> </tr> <tr> <td> 2</td> <td> FRM <a name="v3-EntityNamePartQualifierR2-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-EntityNamePartQualifierR2-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-EntityNamePartQualifierR2-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 "children" For 'Adult Chesty Cough Syrup', the target population part is "adult" </td> </tr> <tr> <td> 2</td> <td> SCI <a name="v3-EntityNamePartQualifierR2-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-EntityNamePartQualifierR2-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-EntityNamePartQualifierR2-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 "2008/2009 season" </td> </tr> <tr> <td> 2</td> <td> TMK <a name="v3-EntityNamePartQualifierR2-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-EntityNamePartQualifierR2-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: "Heartburn Relief" For 'Medicine Honey Syrup for Soothing Coughs' the intended use part is "Soothing Coughs" </td> </tr> <tr> <td> 1</td> <td> SFX <a name="v3-EntityNamePartQualifierR2-SFX"> </a> </td> <td> suffix</td> <td> 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). <br/> </td> </tr> <tr> <td> 1</td> <td> <span style="color: grey"> <i> (TitleStyles)</i> </span> <b> <i> Abstract</i> </b> </td> <td> <a name="v3-EntityNamePartQualifierR2-TitleStyles"> </a> </td> <td> Description:Extra information about the style of a title <br/> </td> </tr> <tr> <td> 2</td> <td> AC <a name="v3-EntityNamePartQualifierR2-AC"> </a> </td> <td> academic</td> <td> Description:Indicates that a title like "Dr.", "M.D." or "Ph.D." is an academic title. <br/> </td> </tr> <tr> <td> 2</td> <td> HON <a name="v3-EntityNamePartQualifierR2-HON"> </a> </td> <td> honorific</td> <td> Description:A honorific such as "The Right Honourable" or "Weledelgeleerde Heer". <br/> </td> </tr> <tr> <td> 2</td> <td> NB <a name="v3-EntityNamePartQualifierR2-NB"> </a> </td> <td> nobility</td> <td> Description:A nobility title such as Sir, Count, Grafin. <br/> </td> </tr> <tr> <td> 2</td> <td> PR <a name="v3-EntityNamePartQualifierR2-PR"> </a> </td> <td> professional</td> <td> Description:Primarily in the British Imperial culture people tend to have an abbreviation of their professional organization as part of their credential titles. <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> <url value="http://terminology.hl7.org/CodeSystem/v3-EntityNamePartQualifierR2"/> <identifier> <system value="urn:ietf:rfc:3986"/> <value value="urn:oid:2.16.840.1.113883.5.1122"/> </identifier> <version value="2018-08-12"/> <name value="v3.EntityNamePartQualifierR2"/> <title value="v3 Code System EntityNamePartQualifierR2"/> <status value="active"/> <experimental value="false"/> <date value="2018-08-12T00:00:00+10:00"/> <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."/> <caseSensitive value="true"/> <valueSet value="http://terminology.hl7.org/ValueSet/v3-EntityNamePartQualifierR2"/> <hierarchyMeaning value="is-a"/> <content value="complete"/> <property> <code value="notSelectable"/> <uri value="http://hl7.org/fhir/concept-properties#notSelectable"/> <description value="Indicates that the code is abstract - only intended to be used as a selector for other concepts"/> <type value="boolean"/> </property> <concept> <code value="AD"/> <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"/> <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"/> <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 "Baby of Smith" a" which is just a name with a use code of "TEMP"."/> </concept> <concept> <code value="CL"/> <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"/> <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., "Ph" could stand for "Philippe" or "Th" For "Thomas"."/> </concept> <concept> <code value="LS"/> <display value="legal status"/> <definition value="Description:For organizations a suffix indicating the legal status, e.g., "Inc.", "Co.", "AG", "GmbH", "B.V." "S.A.", "Ltd." etc."/> </concept> <concept> <code value="MID"/> <display value="middle name"/> <definition value="Description:Indicates that the name part is a middle name. Usage Notes: In general, the english "middle name" 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 "mellomnavn","mellannamn". 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"/> <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"/> <display value="PharmaceuticalEntityNamePartQualifiers"/> <definition value="Description: Medication Name Parts are a means of specifying a range of acceptable "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 "doseForm" or "route" or "strength" 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."/> <property> <code value="notSelectable"/> <valueBoolean value="true"/> </property> <concept> <code value="CON"/> <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"/> <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"/> <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 "Orange&qu ot; For 'Wonderdrug Syrup Cherry Flavor', the flavor part is "Cherry&quo t;"/> </concept> <concept> <code value="FORMUL"/> <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 "Sugar Free" For 'QuickCure Gluten-free Bulk Fibre', the formulation name part is "gluten-free""/> </concept> <concept> <code value="FRM"/> <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"/> <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"/> <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 "children" For 'Adult Chesty Cough Syrup', the target population part is "adult""/> </concept> <concept> <code value="SCI"/> <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"/> <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"/> <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 "2008/2009 season""/> </concept> <concept> <code value="TMK"/> <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"/> <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: "Heartburn Relief" For 'Medicine Honey Syrup for Soothing Coughs' the intended use part is "Soothing Coughs""/> </concept> </concept> <concept> <code value="SFX"/> <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"/> <display value="TitleStyles"/> <definition value="Description:Extra information about the style of a title"/> <property> <code value="notSelectable"/> <valueBoolean value="true"/> </property> <concept> <code value="AC"/> <display value="academic"/> <definition value="Description:Indicates that a title like "Dr.", "M.D." or "Ph.D." is an academic title."/> </concept> <concept> <code value="HON"/> <display value="honorific"/> <definition value="Description:A honorific such as "The Right Honourable" or "Weledelgeleerde Heer"."/> </concept> <concept> <code value="NB"/> <display value="nobility"/> <definition value="Description:A nobility title such as Sir, Count, Grafin."/> </concept> <concept> <code value="PR"/> <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> </CodeSystem>
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.
®© HL7.org 2011+. FHIR Mixed Nomative/Trial Use Ballot #2 (v3.5.0-14907) generated on Sun, Aug 19, 2018 21:55+1000. QA Page
Links: Search |
Version History |
Table of Contents |
Credits |
Compare to DSTU3 |
Ballot Comparison |
|
Propose a change
Terminology