Package org.hl7.fhir.r4.model.codesystems

Enum V3IdentifierScope

java.lang.Object

java.lang.Enum<V3IdentifierScope>

org.hl7.fhir.r4.model.codesystems.V3IdentifierScope

All Implemented Interfaces:

Serializable, Comparable<V3IdentifierScope>

public enum V3IdentifierScope
extends Enum<V3IdentifierScope>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BUSN	Description: An identifier whose scope is defined by the business practices associated with the object.
NULL	added to help the parsers
OBJ	Description: The identifier associated with a particular object.
VER	Description: An identifier that references a particular object as it existed at a given point in time.
VW	Description: An identifier that references a particular object as it existed at a given point in time.

Method Summary

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

BUSN

public static final V3IdentifierScope BUSN

Description: An identifier whose scope is defined by the business practices associated with the object. In contrast to the other scope identifiers, the scope of the use of the id is not necessarily restricted to a single object, but may be reused for other objects closely associated with the object due to business practice.

OBJ

public static final V3IdentifierScope OBJ

Description: The identifier associated with a particular object. It remains consistent as the object undergoes state transitions.

VER

public static final V3IdentifierScope VER

Description: An identifier that references a particular object as it existed at a given point in time. The identifier SHALL change with each state transition on the object. I.e. The version identifier of an object prior to a 'suspend' state transition is distinct from the identifier of the object after the state transition. Each version identifier can be tied to exactly one ControlAct event which brought that version into being (though the control act may never be instantiated). NOTE: Applications that do not support versioning of objects must ignore and not persist these ids to avoid confusion resulting from leaving the same identifier on an object that undergoes changes.

VW

public static final V3IdentifierScope VW

Description: An identifier that references a particular object as it existed at a given point in time. The identifier SHALL change with each state transition on the object. Example The version identifier of an object prior to a 'suspend' state transition is distinct from the identifier of the object after the state transition. Each version identifier can be tied to exactly one ControlAct event which brought that version into being (though the control act may never be instantiated). NOTE: Applications that do not support versioning of objects must ignore and not persist these ids to avoid confusion resulting from leaving the same identifier on an object that undergoes changes.

NULL

public static final V3IdentifierScope NULL

added to help the parsers

Method Detail

values

public static V3IdentifierScope[] 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 (V3IdentifierScope c : V3IdentifierScope.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static V3IdentifierScope 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 V3IdentifierScope 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()