Package org.hl7.fhir.dstu3.model.codesystems

Enum Class V3EntityNamePartQualifier

java.lang.Object
java.lang.Enum<V3EntityNamePartQualifier>
org.hl7.fhir.dstu3.model.codesystems.V3EntityNamePartQualifier
All Implemented Interfaces:
Serializable, Comparable<V3EntityNamePartQualifier>, Constable
public enum V3EntityNamePartQualifier extends Enum<V3EntityNamePartQualifier>

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    _ORGANIZATIONNAMEPARTQUALIFIER
    OrganizationNamePartQualifier
    _PERSONNAMEPARTAFFIXTYPES
    PersonNamePartAffixTypes
    _PERSONNAMEPARTCHANGEQUALIFIER
    PersonNamePartChangeQualifier
    _PERSONNAMEPARTMISCQUALIFIER
    PersonNamePartMiscQualifier
    _PERSONNAMEPARTQUALIFIER
    PersonNamePartQualifier
    AC
    Indicates that a prefix like "Dr." or a suffix like "M.D." or "Ph.D." is an academic title.
    AD
    The name the person was given at the time of adoption.
    BR
    A name that a person had shortly after being born.
    CL
    A callme name is (usually a given name) that is preferred when a person is directly addressed.
    CON
    Description: This refers to the container if present in the medicinal product name.
    DEV
    Description: This refers to the qualifiers in the name for devices and is at the moment mainly applicable to insulins and inhalation products.
    FLAV
    Description: This refers to a flavor of the medicinal product if present in the medicinal product name.
    FORMUL
    Description: This refers to the formulation of the medicinal product if present in the medicinal product name.
    FRM
    Description: This refers to the pharmaceutical form/ if present in the medicinal product name.
    IN
    Indicates that a name part is just an initial.
    INV
    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.
    LS
    For organizations a suffix indicating the legal status, e.g., "Inc.", "Co.", "AG", "GmbH", "B.V."
    NB
    In Europe and Asia, there are still people with nobility titles (aristocrats).
    NULL
    added to help the parsers
    PHARMACEUTICALENTITYNAMEPARTQUALIFIERS
    Description: Medication Name Parts are a means of specifying a range of acceptable "official" forms of the name of a product.
    POPUL
    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"
    PR
    Primarily in the British Imperial culture people tend to have an abbreviation of their professional organization as part of their credential suffices.
    SCI
    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.
    SP
    The name assumed from the partner in a marital relationship (hence the "SP").
    STR
    Description: This refers to the strength if present in the medicinal product name.
    TIME
    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"
    TITLE
    Indicates that a prefix or a suffix is a title that applies to the whole name, not just the adjacent name part.
    TMK
    Description: This refers to trademark/company element if present in the medicinal product name.
    USE
    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.
    VV
    A Dutch "voorvoegsel" is something like "van" or "de" that might have indicated nobility in the past but no longer so.

  • Method Summary

    Modifier and Type
    Method
    Description
    static V3EntityNamePartQualifier
    fromCode(String codeString)
     
    String
    getDefinition()
     
    String
    getDisplay()
     
    String
    getSystem()
     
    String
    toCode()
     
    static V3EntityNamePartQualifier
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static V3EntityNamePartQualifier[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • _ORGANIZATIONNAMEPARTQUALIFIER

      public static final V3EntityNamePartQualifier _ORGANIZATIONNAMEPARTQUALIFIER
      OrganizationNamePartQualifier

    • AC

      public static final V3EntityNamePartQualifier AC
      Indicates that a prefix like "Dr." or a suffix like "M.D." or "Ph.D." is an academic title.

    • BR

      public static final V3EntityNamePartQualifier BR
      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.

    • CL

      public static final V3EntityNamePartQualifier CL
      A callme name is (usually a given name) that is preferred when a person is directly addressed.

    • IN

      public static final V3EntityNamePartQualifier IN
      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., "Ph." could stand for "Philippe" or "Th." for "Thomas".

    • LS

      public static final V3EntityNamePartQualifier LS
      For organizations a suffix indicating the legal status, e.g., "Inc.", "Co.", "AG", "GmbH", "B.V." "S.A.", "Ltd." etc.

    • NB

      public static final V3EntityNamePartQualifier NB
      In Europe and Asia, there are still people with nobility titles (aristocrats). German "von" is generally a nobility title, not a mere voorvoegsel. Others are "Earl of" or "His Majesty King of..." etc. Rarely used nowadays, but some systems do keep track of this.

    • PR

      public static final V3EntityNamePartQualifier PR
      Primarily in the British Imperial culture people tend to have an abbreviation of their professional organization as part of their credential suffices.

    • SP

      public static final V3EntityNamePartQualifier SP
      The name assumed from the partner in a marital relationship (hence the "SP"). Usually the spouse's family name. Note that no inference about gender can be made from the existence of spouse names.

    • TITLE

      public static final V3EntityNamePartQualifier TITLE
      Indicates that a prefix or a suffix is a title that applies to the whole name, not just the adjacent name part.

    • VV

      public static final V3EntityNamePartQualifier VV
      A Dutch "voorvoegsel" is something like "van" or "de" that might have indicated nobility in the past but no longer so. Similar prefixes exist in other languages such as Spanish, French or Portugese.

    • PHARMACEUTICALENTITYNAMEPARTQUALIFIERS

      public static final V3EntityNamePartQualifier PHARMACEUTICALENTITYNAMEPARTQUALIFIERS
      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.

    • CON

      public static final V3EntityNamePartQualifier CON
      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

    • DEV

      public static final V3EntityNamePartQualifier DEV
      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.

    • FLAV

      public static final V3EntityNamePartQualifier FLAV
      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" For 'Wonderdrug Syrup Cherry Flavor', the flavor part is "Cherry"

    • FORMUL

      public static final V3EntityNamePartQualifier FORMUL
      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"

    • FRM

      public static final V3EntityNamePartQualifier FRM
      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

    • INV

      public static final V3EntityNamePartQualifier INV
      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

    • POPUL

      public static final V3EntityNamePartQualifier POPUL
      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"

    • SCI

      public static final V3EntityNamePartQualifier SCI
      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

    • STR

      public static final V3EntityNamePartQualifier STR
      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

    • TIME

      public static final V3EntityNamePartQualifier TIME
      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"

    • TMK

      public static final V3EntityNamePartQualifier TMK
      Description: This refers to trademark/company element if present in the medicinal product name. EXAMPLES: for Insulin Human Winthrop Comb 15: Winthrop

    • USE

      public static final V3EntityNamePartQualifier USE
      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"

    • _PERSONNAMEPARTQUALIFIER

      public static final V3EntityNamePartQualifier _PERSONNAMEPARTQUALIFIER
      PersonNamePartQualifier

    • _PERSONNAMEPARTAFFIXTYPES

      public static final V3EntityNamePartQualifier _PERSONNAMEPARTAFFIXTYPES
      PersonNamePartAffixTypes

    • _PERSONNAMEPARTCHANGEQUALIFIER

      public static final V3EntityNamePartQualifier _PERSONNAMEPARTCHANGEQUALIFIER
      PersonNamePartChangeQualifier

    • _PERSONNAMEPARTMISCQUALIFIER

      public static final V3EntityNamePartQualifier _PERSONNAMEPARTMISCQUALIFIER
      PersonNamePartMiscQualifier

    • NULL

      public static final V3EntityNamePartQualifier NULL
      added to help the parsers

  • Method Details

    • values

      public static V3EntityNamePartQualifier[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static V3EntityNamePartQualifier valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • fromCode

      public static V3EntityNamePartQualifier fromCode(String codeString) throws org.hl7.fhir.exceptions.FHIRException
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • toCode

      public String toCode()

    • getSystem

      public String getSystem()

    • getDefinition

      public String getDefinition()

    • getDisplay

      public String getDisplay()