Package org.hl7.fhir.r5.model

Enum Identifier.IdentifierUse

java.lang.Object

java.lang.Enum<Identifier.IdentifierUse>

org.hl7.fhir.r5.model.Identifier.IdentifierUse

All Implemented Interfaces:

Serializable, Comparable<Identifier.IdentifierUse>

Enclosing class:

Identifier

public static enum Identifier.IdentifierUse
extends Enum<Identifier.IdentifierUse>

Enum Constant Summary

Enum Constants

Enum Constant	Description
NULL	added to help the parsers with the generic types
OFFICIAL	The identifier considered to be most trusted for the identification of this item.
OLD	The identifier id no longer considered valid, but may be relevant for search purposes.
SECONDARY	An identifier that was assigned in secondary use - it serves to identify the object in a relative context, but cannot be consistently assigned to the same object again in a different context.
TEMP	A temporary identifier.
USUAL	The identifier recommended for display and use in real-world interactions which should be used when such identifier is different from the \"official\" identifier.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

USUAL

public static final Identifier.IdentifierUse USUAL

The identifier recommended for display and use in real-world interactions which should be used when such identifier is different from the \"official\" identifier.

OFFICIAL

public static final Identifier.IdentifierUse OFFICIAL

The identifier considered to be most trusted for the identification of this item. Sometimes also known as \"primary\" and \"main\". The determination of \"official\" is subjective and implementation guides often provide additional guidelines for use.

TEMP

public static final Identifier.IdentifierUse TEMP

A temporary identifier.

SECONDARY

public static final Identifier.IdentifierUse SECONDARY

An identifier that was assigned in secondary use - it serves to identify the object in a relative context, but cannot be consistently assigned to the same object again in a different context.

OLD

public static final Identifier.IdentifierUse OLD

The identifier id no longer considered valid, but may be relevant for search purposes. E.g. Changes to identifier schemes, account merges, etc.

NULL

public static final Identifier.IdentifierUse NULL

added to help the parsers with the generic types

Method Details

values

public static Identifier.IdentifierUse[] 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

public static Identifier.IdentifierUse 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 name

NullPointerException - if the argument is null

fromCode

public static Identifier.IdentifierUse 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()