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

Enum Class V3EntityNameUseR2

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

  • 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
    A
    Description:A name used in a Professional or Business context .
    ABC
    Description:Alphabetic transcription of name in latin alphabet (Japanese: romaji)
    ANON
    Description:Anonymous assigned name (used to protect a persons identity for privacy reasons)
    ASSUMED
    Description:A name that a person has assumed or has been assumed to them.
    C
    Description:Known as/conventional/the one you normally use
    DN
    Description:This name should no longer be used when interacting with the person (i.e .
    I
    Description:e.g .
    IDE
    Description:Ideographic representation of name (e.g., Japanese kanji, Chinese characters)
    M
    Description:A name used prior to marriage.Note that marriage naming customs vary greatly around the world.
    NAMEREPRESENTATIONUSE
    Description:Identifies the different representations of a name .
    NULL
    added to help the parsers
    OLD
    Description:This name is no longer in use (note: Names may also carry valid time ranges .
    OR
    Description:The formal name as registered in an official (government) registry, but which name might not be commonly used .
    P
    Description:A non-official name by which the person is sometimes known.
    PHON
    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.
    R
    Description:A name assumed as part of a religious vocation .
    SRCH
    Description:A name intended for use in searching or matching.
    SYL
    Description:Syllabic transcription of name (e.g., Japanese kana, Korean hangul)
    T
    Description:A temporary name.

  • Method Summary

    Modifier and Type
    Method
    Description
    static V3EntityNameUseR2
    fromCode(String codeString)
     
    String
    getDefinition()
     
    String
    getDisplay()
     
    String
    getSystem()
     
    String
    toCode()
     
    static V3EntityNameUseR2
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static V3EntityNameUseR2[]
    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

    • ASSUMED

      public static final V3EntityNameUseR2 ASSUMED
      Description:A name that a person has assumed or has been assumed to them.

    • A

      public static final V3EntityNameUseR2 A
      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)

    • ANON

      public static final V3EntityNameUseR2 ANON
      Description:Anonymous assigned name (used to protect a persons identity for privacy reasons)

    • I

      public static final V3EntityNameUseR2 I
      Description:e.g . Chief Red Cloud

    • P

      public static final V3EntityNameUseR2 P
      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)

    • R

      public static final V3EntityNameUseR2 R
      Description:A name assumed as part of a religious vocation . e.g . Sister Mary Francis, Brother John

    • C

      public static final V3EntityNameUseR2 C
      Description:Known as/conventional/the one you normally use

    • M

      public static final V3EntityNameUseR2 M
      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

    • NAMEREPRESENTATIONUSE

      public static final V3EntityNameUseR2 NAMEREPRESENTATIONUSE
      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.)

    • ABC

      public static final V3EntityNameUseR2 ABC
      Description:Alphabetic transcription of name in latin alphabet (Japanese: romaji)

    • IDE

      public static final V3EntityNameUseR2 IDE
      Description:Ideographic representation of name (e.g., Japanese kanji, Chinese characters)

    • SYL

      public static final V3EntityNameUseR2 SYL
      Description:Syllabic transcription of name (e.g., Japanese kana, Korean hangul)

    • OLD

      public static final V3EntityNameUseR2 OLD
      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)

    • DN

      public static final V3EntityNameUseR2 DN
      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 "Do Not Use" and other names in order to eliminate name parts that are common between the other name and a name labeled "Do Not Use".

    • OR

      public static final V3EntityNameUseR2 OR
      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

    • PHON

      public static final V3EntityNameUseR2 PHON
      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.

    • SRCH

      public static final V3EntityNameUseR2 SRCH
      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.

    • T

      public static final V3EntityNameUseR2 T
      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.

    • NULL

      public static final V3EntityNameUseR2 NULL
      added to help the parsers

  • Method Details

    • values

      public static V3EntityNameUseR2[] 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 V3EntityNameUseR2 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 V3EntityNameUseR2 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()