Enum V3EntityNameUseR2
- All Implemented Interfaces:
Serializable
,Comparable<V3EntityNameUseR2>
-
Enum Constant Summary
Enum ConstantDescriptionDescription:A name used in a Professional or Business context .Description:Alphabetic transcription of name in latin alphabet (Japanese: romaji)Description:Anonymous assigned name (used to protect a persons identity for privacy reasons)Description:A name that a person has assumed or has been assumed to them.Description:Known as/conventional/the one you normally useDescription:This name should no longer be used when interacting with the person (i.e .Description:e.g .Description:Ideographic representation of name (e.g., Japanese kanji, Chinese characters)Description:A name used prior to marriage.Note that marriage naming customs vary greatly around the world.Description:Identifies the different representations of a name .added to help the parsersDescription:This name is no longer in use (note: Names may also carry valid time ranges .Description:The formal name as registered in an official (government) registry, but which name might not be commonly used .Description:A non-official name by which the person is sometimes known.Description:The name as understood by the data enterer, i.e.Description:A name assumed as part of a religious vocation .Description:A name intended for use in searching or matching.Description:Syllabic transcription of name (e.g., Japanese kana, Korean hangul)Description:A temporary name. -
Method Summary
Modifier and TypeMethodDescriptionstatic V3EntityNameUseR2
toCode()
static V3EntityNameUseR2
Returns the enum constant of this type with the specified name.static V3EntityNameUseR2[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
ASSUMED
Description:A name that a person has assumed or has been assumed to them. -
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
Description:Anonymous assigned name (used to protect a persons identity for privacy reasons) -
I
Description:e.g . Chief Red Cloud -
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
Description:A name assumed as part of a religious vocation . e.g . Sister Mary Francis, Brother John -
C
Description:Known as/conventional/the one you normally use -
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
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
Description:Alphabetic transcription of name in latin alphabet (Japanese: romaji) -
IDE
Description:Ideographic representation of name (e.g., Japanese kanji, Chinese characters) -
SYL
Description:Syllabic transcription of name (e.g., Japanese kana, Korean hangul) -
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
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
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
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
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
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
added to help the parsers
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified nameNullPointerException
- 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
-
getSystem
-
getDefinition
-
getDisplay
-