Package org.hl7.fhir.r4.model

Enum Appointment.AppointmentStatus

java.lang.Object

java.lang.Enum<Appointment.AppointmentStatus>

org.hl7.fhir.r4.model.Appointment.AppointmentStatus

All Implemented Interfaces:

Serializable, Comparable<Appointment.AppointmentStatus>

Enclosing class:

Appointment

public static enum Appointment.AppointmentStatus
extends Enum<Appointment.AppointmentStatus>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ARRIVED	The patient/patients has/have arrived and is/are waiting to be seen.
BOOKED	All participant(s) have been considered and the appointment is confirmed to go ahead at the date/times specified.
CANCELLED	The appointment has been cancelled.
CHECKEDIN	When checked in, all pre-encounter administrative work is complete, and the encounter may begin.
ENTEREDINERROR	This instance should not have been part of this patient's medical record.
FULFILLED	The planning stages of the appointment are now complete, the encounter resource will exist and will track further status changes.
NOSHOW	Some or all of the participant(s) have not/did not appear for the appointment (usually the patient).
NULL	added to help the parsers with the generic types
PENDING	Some or all of the participant(s) have not finalized their acceptance of the appointment request.
PROPOSED	None of the participant(s) have finalized their acceptance of the appointment request, and the start/end time might not be set yet.
WAITLIST	The appointment has been placed on a waitlist, to be scheduled/confirmed in the future when a slot/service is available.

Method Summary

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

PROPOSED

public static final Appointment.AppointmentStatus PROPOSED

None of the participant(s) have finalized their acceptance of the appointment request, and the start/end time might not be set yet.

PENDING

public static final Appointment.AppointmentStatus PENDING

Some or all of the participant(s) have not finalized their acceptance of the appointment request.

BOOKED

public static final Appointment.AppointmentStatus BOOKED

All participant(s) have been considered and the appointment is confirmed to go ahead at the date/times specified.

ARRIVED

public static final Appointment.AppointmentStatus ARRIVED

The patient/patients has/have arrived and is/are waiting to be seen.

FULFILLED

public static final Appointment.AppointmentStatus FULFILLED

The planning stages of the appointment are now complete, the encounter resource will exist and will track further status changes. Note that an encounter may exist before the appointment status is fulfilled for many reasons.

CANCELLED

public static final Appointment.AppointmentStatus CANCELLED

The appointment has been cancelled.

NOSHOW

public static final Appointment.AppointmentStatus NOSHOW

Some or all of the participant(s) have not/did not appear for the appointment (usually the patient).

ENTEREDINERROR

public static final Appointment.AppointmentStatus ENTEREDINERROR

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

CHECKEDIN

public static final Appointment.AppointmentStatus CHECKEDIN

When checked in, all pre-encounter administrative work is complete, and the encounter may begin. (where multiple patients are involved, they are all present).

WAITLIST

public static final Appointment.AppointmentStatus WAITLIST

The appointment has been placed on a waitlist, to be scheduled/confirmed in the future when a slot/service is available. A specific time might or might not be pre-allocated.

NULL

public static final Appointment.AppointmentStatus NULL

added to help the parsers with the generic types

Method Detail

values

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

Returns:

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

valueOf

public static Appointment.AppointmentStatus 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 Appointment.AppointmentStatus 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()