Enum V3EntityNameUse
- java.lang.Object
-
- java.lang.Enum<V3EntityNameUse>
-
- org.hl7.fhir.r4.model.codesystems.V3EntityNameUse
-
- All Implemented Interfaces:
Serializable,Comparable<V3EntityNameUse>
public enum V3EntityNameUse extends Enum<V3EntityNameUse>
-
-
Enum Constant Summary
Enum Constants Enum Constant Description _NAMEREPRESENTATIONUSEIdentifies the different representations of a name.AIncludes writer's pseudonym, stage name, etcABCAlphabetic transcription of name (Japanese: romaji)ASGNA name assigned to a person.CAs recorded on a license, record, certificate, etc.Ie.g.IDEIdeographic representation of name (e.g., Japanese kanji, Chinese characters)LKnown as/conventional/the one you useNULLadded to help the parsersORDefinition:The formal name as registered in an official (government) registry, but which name might not be commonly used.PA self asserted name that the person is using or has used.PHONA name spelled phonetically.Re.g.SNDXA name spelled according to the SoundEx algorithm.SRCHA name intended for use in searching or matching.SYLSyllabic transcription of name (e.g., Japanese kana, Korean hangul)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static V3EntityNameUsefromCode(String codeString)StringgetDefinition()StringgetDisplay()StringgetSystem()StringtoCode()static V3EntityNameUsevalueOf(String name)Returns the enum constant of this type with the specified name.static V3EntityNameUse[]values()Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
_NAMEREPRESENTATIONUSE
public static final V3EntityNameUse _NAMEREPRESENTATIONUSE
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 V3EntityNameUse ABC
Alphabetic transcription of name (Japanese: romaji)
-
IDE
public static final V3EntityNameUse IDE
Ideographic representation of name (e.g., Japanese kanji, Chinese characters)
-
SYL
public static final V3EntityNameUse SYL
Syllabic transcription of name (e.g., Japanese kana, Korean hangul)
-
ASGN
public static final V3EntityNameUse ASGN
A name assigned to a person. Reasons some organizations assign alternate names may include not knowing the person's name, or to maintain anonymity. Some, but not necessarily all, of the name types that people call "alias" may fit into this category.
-
C
public static final V3EntityNameUse C
As recorded on a license, record, certificate, etc. (only if different from legal name)
-
I
public static final V3EntityNameUse I
e.g. Chief Red Cloud
-
L
public static final V3EntityNameUse L
Known as/conventional/the one you use
-
OR
public static final V3EntityNameUse OR
Definition:The formal name as registered in an official (government) registry, but which name might not be commonly used. Particularly used in countries with a law system based on Napoleonic law.
-
P
public static final V3EntityNameUse P
A self asserted name that the person is using or has used.
-
A
public static final V3EntityNameUse A
Includes writer's pseudonym, stage name, etc
-
R
public static final V3EntityNameUse R
e.g. Sister Mary Francis, Brother John
-
SRCH
public static final V3EntityNameUse SRCH
A name intended for use in searching or matching.
-
PHON
public static final V3EntityNameUse PHON
A name spelled phonetically. There are a variety of phonetic spelling algorithms. This code value does not distinguish between these.Discussion:
-
SNDX
public static final V3EntityNameUse SNDX
A name spelled according to the SoundEx algorithm.
-
NULL
public static final V3EntityNameUse NULL
added to help the parsers
-
-
Method Detail
-
values
public static V3EntityNameUse[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (V3EntityNameUse c : V3EntityNameUse.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static V3EntityNameUse valueOf(String name)
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 V3EntityNameUse fromCode(String codeString) throws org.hl7.fhir.exceptions.FHIRException
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getDefinition
public String getDefinition()
-
getDisplay
public String getDisplay()
-
-