Package org.hl7.fhir.r5.model

Enum Encounter.EncounterStatus

java.lang.Object

java.lang.Enum<Encounter.EncounterStatus>

org.hl7.fhir.r5.model.Encounter.EncounterStatus

All Implemented Interfaces:

Serializable, Comparable<Encounter.EncounterStatus>

Enclosing class:

Encounter

public static enum Encounter.EncounterStatus
extends Enum<Encounter.EncounterStatus>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CANCELLED	The Encounter has ended before it has begun.
COMPLETED	The Encounter has ended.
ENTEREDINERROR	This instance should not have been part of this patient's medical record.
INPROGRESS	The Encounter has begun and the patient is present / the practitioner and the patient are meeting.
NULL	added to help the parsers with the generic types
ONHOLD	The Encounter has begun, but is currently on hold, e.g.
PLANNED	The Encounter has not yet started.
UNKNOWN	The encounter status is unknown.

Method Summary

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

PLANNED

public static final Encounter.EncounterStatus PLANNED

The Encounter has not yet started.

INPROGRESS

public static final Encounter.EncounterStatus INPROGRESS

The Encounter has begun and the patient is present / the practitioner and the patient are meeting.

ONHOLD

public static final Encounter.EncounterStatus ONHOLD

The Encounter has begun, but is currently on hold, e.g. because the patient is temporarily on leave.

COMPLETED

public static final Encounter.EncounterStatus COMPLETED

The Encounter has ended.

CANCELLED

public static final Encounter.EncounterStatus CANCELLED

The Encounter has ended before it has begun.

ENTEREDINERROR

public static final Encounter.EncounterStatus ENTEREDINERROR

This instance should not have been part of this patient's medical record.

UNKNOWN

public static final Encounter.EncounterStatus UNKNOWN

The encounter status is unknown. Note that \"unknown\" is a value of last resort and every attempt should be made to provide a meaningful value other than \"unknown\".

NULL

public static final Encounter.EncounterStatus NULL

added to help the parsers with the generic types

Method Details

values

public static Encounter.EncounterStatus[] 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 Encounter.EncounterStatus 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 Encounter.EncounterStatus 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()