Package org.hl7.fhir.r5.model

Enum Enumerations.EncounterStatus

java.lang.Object

java.lang.Enum<Enumerations.EncounterStatus>

org.hl7.fhir.r5.model.Enumerations.EncounterStatus

All Implemented Interfaces:

Serializable, Comparable<Enumerations.EncounterStatus>

Enclosing class:

Enumerations

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

Enum Constant Summary

Enum Constants

Enum Constant	Description
CANCELLED	The Encounter has ended before it has begun.
COMPLETED	The Encounter has ended.
DISCHARGED	The Encounter has been clinically completed, the patient has been discharged from the facility or the visit has ended, and the patient may have departed (refer to subjectStatus).
DISCONTINUED	The Encounter has started, but was not able to be completed.
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
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 Enumerations.EncounterStatus	fromCode(String codeString)
String	getDefinition()
String	getDisplay()
String	getSystem()
static boolean	isValidCode(String codeString)
String	toCode()
static Enumerations.EncounterStatus	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Enumerations.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 Enumerations.EncounterStatus PLANNED

The Encounter has not yet started.

INPROGRESS

public static final Enumerations.EncounterStatus INPROGRESS

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

ONHOLD

public static final Enumerations.EncounterStatus ONHOLD

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

DISCHARGED

public static final Enumerations.EncounterStatus DISCHARGED

The Encounter has been clinically completed, the patient has been discharged from the facility or the visit has ended, and the patient may have departed (refer to subjectStatus). While the encounter is in this status, administrative activities are usually performed, collating all required documentation and charge information before being released for billing, at which point the status will move to completed.

COMPLETED

public static final Enumerations.EncounterStatus COMPLETED

The Encounter has ended.

CANCELLED

public static final Enumerations.EncounterStatus CANCELLED

The Encounter has ended before it has begun.

DISCONTINUED

public static final Enumerations.EncounterStatus DISCONTINUED

The Encounter has started, but was not able to be completed. Further action may need to be performed, such as rescheduling appointments related to this encounter.

ENTEREDINERROR

public static final Enumerations.EncounterStatus ENTEREDINERROR

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

UNKNOWN

public static final Enumerations.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 Enumerations.EncounterStatus NULL

added to help the parsers

Method Details

values

public static Enumerations.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 Enumerations.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 Enumerations.EncounterStatus fromCode(String codeString)
                                             throws org.hl7.fhir.exceptions.FHIRException

Throws:

org.hl7.fhir.exceptions.FHIRException

isValidCode

public static boolean isValidCode(String codeString)

toCode

public String toCode()

getSystem

public String getSystem()

getDefinition

public String getDefinition()

getDisplay

public String getDisplay()