Package org.hl7.fhir.r5.model

Enum ElementDefinition.AdditionalBindingPurposeVS

java.lang.Object

java.lang.Enum<ElementDefinition.AdditionalBindingPurposeVS>

org.hl7.fhir.r5.model.ElementDefinition.AdditionalBindingPurposeVS

All Implemented Interfaces:

Serializable, Comparable<ElementDefinition.AdditionalBindingPurposeVS>

Enclosing class:

ElementDefinition

public static enum ElementDefinition.AdditionalBindingPurposeVS
extends Enum<ElementDefinition.AdditionalBindingPurposeVS>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CANDIDATE	This value set is a candidate to substitute for the overall conformance value set in some situations; usually these are defined in the documentation
COMPONENT	This value set is a component of the base value set.
CURRENT	New records are required to use this value set, but legacy records may use other codes.
EXTENSIBLE	This value set is used as an extensible binding (in addition to the base binding (not a replacement), usually in a particular usage context)
MAXIMUM	A required binding, for use when the binding strength is 'extensible' or 'preferred'
MINIMUM	The minimum allowable value set - any conformant system SHALL support all these codes
NULL	added to help the parsers with the generic types
PREFERRED	This is the value set that is preferred in a given context (documentation should explain why)
REQUIRED	This value set is used as a required binding (in addition to the base binding (not a replacement), usually in a particular usage context)
STARTER	This value set is a good set of codes to start with when designing your system
UI	This value set is provided for user look up in a given context.

Method Summary

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

MAXIMUM

public static final ElementDefinition.AdditionalBindingPurposeVS MAXIMUM

A required binding, for use when the binding strength is 'extensible' or 'preferred'

MINIMUM

public static final ElementDefinition.AdditionalBindingPurposeVS MINIMUM

The minimum allowable value set - any conformant system SHALL support all these codes

REQUIRED

public static final ElementDefinition.AdditionalBindingPurposeVS REQUIRED

This value set is used as a required binding (in addition to the base binding (not a replacement), usually in a particular usage context)

EXTENSIBLE

public static final ElementDefinition.AdditionalBindingPurposeVS EXTENSIBLE

This value set is used as an extensible binding (in addition to the base binding (not a replacement), usually in a particular usage context)

CANDIDATE

public static final ElementDefinition.AdditionalBindingPurposeVS CANDIDATE

This value set is a candidate to substitute for the overall conformance value set in some situations; usually these are defined in the documentation

CURRENT

public static final ElementDefinition.AdditionalBindingPurposeVS CURRENT

New records are required to use this value set, but legacy records may use other codes. The definition of 'new record' is difficult, since systems often create new records based on pre-existing data. Usually 'current' bindings are mandated by an external authority that makes clear rules around this

PREFERRED

public static final ElementDefinition.AdditionalBindingPurposeVS PREFERRED

This is the value set that is preferred in a given context (documentation should explain why)

UI

public static final ElementDefinition.AdditionalBindingPurposeVS UI

This value set is provided for user look up in a given context. Typically, these valuesets only include a subset of codes relevant for input in a context

STARTER

public static final ElementDefinition.AdditionalBindingPurposeVS STARTER

This value set is a good set of codes to start with when designing your system

COMPONENT

public static final ElementDefinition.AdditionalBindingPurposeVS COMPONENT

This value set is a component of the base value set. Usually this is called out so that documentation can be written about a portion of the value set

NULL

public static final ElementDefinition.AdditionalBindingPurposeVS NULL

added to help the parsers with the generic types

Method Details

values

public static ElementDefinition.AdditionalBindingPurposeVS[] 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 ElementDefinition.AdditionalBindingPurposeVS 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 ElementDefinition.AdditionalBindingPurposeVS 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()