com.ibm.fhir.model.type.code.AppointmentStatus Maven / Gradle / Ivy
/*
* (C) Copyright IBM Corp. 2019, 2021
*
* SPDX-License-Identifier: Apache-2.0
*/
package com.ibm.fhir.model.type.code;
import com.ibm.fhir.model.annotation.System;
import com.ibm.fhir.model.type.Code;
import com.ibm.fhir.model.type.Extension;
import com.ibm.fhir.model.type.String;
import java.util.Collection;
import java.util.Objects;
import javax.annotation.Generated;
@System("http://hl7.org/fhir/appointmentstatus")
@Generated("com.ibm.fhir.tools.CodeGenerator")
public class AppointmentStatus extends Code {
/**
* Proposed
*
* None of the participant(s) have finalized their acceptance of the appointment request, and the start/end time might
* not be set yet.
*/
public static final AppointmentStatus PROPOSED = AppointmentStatus.builder().value(Value.PROPOSED).build();
/**
* Pending
*
*
Some or all of the participant(s) have not finalized their acceptance of the appointment request.
*/
public static final AppointmentStatus PENDING = AppointmentStatus.builder().value(Value.PENDING).build();
/**
* Booked
*
*
All participant(s) have been considered and the appointment is confirmed to go ahead at the date/times specified.
*/
public static final AppointmentStatus BOOKED = AppointmentStatus.builder().value(Value.BOOKED).build();
/**
* Arrived
*
*
The patient/patients has/have arrived and is/are waiting to be seen.
*/
public static final AppointmentStatus ARRIVED = AppointmentStatus.builder().value(Value.ARRIVED).build();
/**
* 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.
*/
public static final AppointmentStatus FULFILLED = AppointmentStatus.builder().value(Value.FULFILLED).build();
/**
* Cancelled
*
*
The appointment has been cancelled.
*/
public static final AppointmentStatus CANCELLED = AppointmentStatus.builder().value(Value.CANCELLED).build();
/**
* No Show
*
*
Some or all of the participant(s) have not/did not appear for the appointment (usually the patient).
*/
public static final AppointmentStatus NOSHOW = AppointmentStatus.builder().value(Value.NOSHOW).build();
/**
* Entered in error
*
*
This instance should not have been part of this patient's medical record.
*/
public static final AppointmentStatus ENTERED_IN_ERROR = AppointmentStatus.builder().value(Value.ENTERED_IN_ERROR).build();
/**
* Checked In
*
*
When checked in, all pre-encounter administrative work is complete, and the encounter may begin. (where multiple
* patients are involved, they are all present).
*/
public static final AppointmentStatus CHECKED_IN = AppointmentStatus.builder().value(Value.CHECKED_IN).build();
/**
* Waitlisted
*
*
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.
*/
public static final AppointmentStatus WAITLIST = AppointmentStatus.builder().value(Value.WAITLIST).build();
private volatile int hashCode;
private AppointmentStatus(Builder builder) {
super(builder);
}
/**
* Get the value of this AppointmentStatus as an enum constant.
* @deprecated replaced by {@link #getValueAsEnum()}
*/
@Deprecated
public ValueSet getValueAsEnumConstant() {
return (value != null) ? ValueSet.from(value) : null;
}
/**
* Get the value of this AppointmentStatus as an enum constant.
*/
public Value getValueAsEnum() {
return (value != null) ? Value.from(value) : null;
}
/**
* Factory method for creating AppointmentStatus objects from a passed enum value.
* @deprecated replaced by {@link #of(Value)}
*/
@Deprecated
public static AppointmentStatus of(ValueSet value) {
switch (value) {
case PROPOSED:
return PROPOSED;
case PENDING:
return PENDING;
case BOOKED:
return BOOKED;
case ARRIVED:
return ARRIVED;
case FULFILLED:
return FULFILLED;
case CANCELLED:
return CANCELLED;
case NOSHOW:
return NOSHOW;
case ENTERED_IN_ERROR:
return ENTERED_IN_ERROR;
case CHECKED_IN:
return CHECKED_IN;
case WAITLIST:
return WAITLIST;
default:
throw new IllegalStateException(value.name());
}
}
/**
* Factory method for creating AppointmentStatus objects from a passed enum value.
*/
public static AppointmentStatus of(Value value) {
switch (value) {
case PROPOSED:
return PROPOSED;
case PENDING:
return PENDING;
case BOOKED:
return BOOKED;
case ARRIVED:
return ARRIVED;
case FULFILLED:
return FULFILLED;
case CANCELLED:
return CANCELLED;
case NOSHOW:
return NOSHOW;
case ENTERED_IN_ERROR:
return ENTERED_IN_ERROR;
case CHECKED_IN:
return CHECKED_IN;
case WAITLIST:
return WAITLIST;
default:
throw new IllegalStateException(value.name());
}
}
/**
* Factory method for creating AppointmentStatus objects from a passed string value.
*
* @param value
* A string that matches one of the allowed code values
* @throws IllegalArgumentException
* If the passed string cannot be parsed into an allowed code value
*/
public static AppointmentStatus of(java.lang.String value) {
return of(Value.from(value));
}
/**
* Inherited factory method for creating AppointmentStatus objects from a passed string value.
*
* @param value
* A string that matches one of the allowed code values
* @throws IllegalArgumentException
* If the passed string cannot be parsed into an allowed code value
*/
public static String string(java.lang.String value) {
return of(Value.from(value));
}
/**
* Inherited factory method for creating AppointmentStatus objects from a passed string value.
*
* @param value
* A string that matches one of the allowed code values
* @throws IllegalArgumentException
* If the passed string cannot be parsed into an allowed code value
*/
public static Code code(java.lang.String value) {
return of(Value.from(value));
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (getClass() != obj.getClass()) {
return false;
}
AppointmentStatus other = (AppointmentStatus) obj;
return Objects.equals(id, other.id) && Objects.equals(extension, other.extension) && Objects.equals(value, other.value);
}
@Override
public int hashCode() {
int result = hashCode;
if (result == 0) {
result = Objects.hash(id, extension, value);
hashCode = result;
}
return result;
}
public Builder toBuilder() {
return new Builder().from(this);
}
public static Builder builder() {
return new Builder();
}
public static class Builder extends Code.Builder {
private Builder() {
super();
}
@Override
public Builder id(java.lang.String id) {
return (Builder) super.id(id);
}
@Override
public Builder extension(Extension... extension) {
return (Builder) super.extension(extension);
}
@Override
public Builder extension(Collection extension) {
return (Builder) super.extension(extension);
}
@Override
public Builder value(java.lang.String value) {
return (value != null) ? (Builder) super.value(Value.from(value).value()) : this;
}
/**
* @deprecated replaced by {@link #value(Value)}
*/
@Deprecated
public Builder value(ValueSet value) {
return (value != null) ? (Builder) super.value(value.value()) : this;
}
/**
* Primitive value for code
*
* @param value
* An enum constant for AppointmentStatus
*
* @return
* A reference to this Builder instance
*/
public Builder value(Value value) {
return (value != null) ? (Builder) super.value(value.value()) : this;
}
@Override
public AppointmentStatus build() {
AppointmentStatus appointmentStatus = new AppointmentStatus(this);
if (validating) {
validate(appointmentStatus);
}
return appointmentStatus;
}
protected void validate(AppointmentStatus appointmentStatus) {
super.validate(appointmentStatus);
}
protected Builder from(AppointmentStatus appointmentStatus) {
super.from(appointmentStatus);
return this;
}
}
@Deprecated
public enum ValueSet {
/**
* Proposed
*
* None of the participant(s) have finalized their acceptance of the appointment request, and the start/end time might
* not be set yet.
*/
PROPOSED("proposed"),
/**
* Pending
*
*
Some or all of the participant(s) have not finalized their acceptance of the appointment request.
*/
PENDING("pending"),
/**
* Booked
*
*
All participant(s) have been considered and the appointment is confirmed to go ahead at the date/times specified.
*/
BOOKED("booked"),
/**
* Arrived
*
*
The patient/patients has/have arrived and is/are waiting to be seen.
*/
ARRIVED("arrived"),
/**
* 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.
*/
FULFILLED("fulfilled"),
/**
* Cancelled
*
*
The appointment has been cancelled.
*/
CANCELLED("cancelled"),
/**
* No Show
*
*
Some or all of the participant(s) have not/did not appear for the appointment (usually the patient).
*/
NOSHOW("noshow"),
/**
* Entered in error
*
*
This instance should not have been part of this patient's medical record.
*/
ENTERED_IN_ERROR("entered-in-error"),
/**
* Checked In
*
*
When checked in, all pre-encounter administrative work is complete, and the encounter may begin. (where multiple
* patients are involved, they are all present).
*/
CHECKED_IN("checked-in"),
/**
* Waitlisted
*
*
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.
*/
WAITLIST("waitlist");
private final java.lang.String value;
ValueSet(java.lang.String value) {
this.value = value;
}
/**
* @return
* The java.lang.String value of the code represented by this enum
*/
public java.lang.String value() {
return value;
}
/**
* Factory method for creating AppointmentStatus.Value values from a passed string value.
*
* @param value
* A string that matches one of the allowed code values
* @throws IllegalArgumentException
* If the passed string cannot be parsed into an allowed code value
*/
public static ValueSet from(java.lang.String value) {
for (ValueSet c : ValueSet.values()) {
if (c.value.equals(value)) {
return c;
}
}
throw new IllegalArgumentException(value);
}
}
public enum Value {
/**
* Proposed
*
*
None of the participant(s) have finalized their acceptance of the appointment request, and the start/end time might
* not be set yet.
*/
PROPOSED("proposed"),
/**
* Pending
*
*
Some or all of the participant(s) have not finalized their acceptance of the appointment request.
*/
PENDING("pending"),
/**
* Booked
*
*
All participant(s) have been considered and the appointment is confirmed to go ahead at the date/times specified.
*/
BOOKED("booked"),
/**
* Arrived
*
*
The patient/patients has/have arrived and is/are waiting to be seen.
*/
ARRIVED("arrived"),
/**
* 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.
*/
FULFILLED("fulfilled"),
/**
* Cancelled
*
*
The appointment has been cancelled.
*/
CANCELLED("cancelled"),
/**
* No Show
*
*
Some or all of the participant(s) have not/did not appear for the appointment (usually the patient).
*/
NOSHOW("noshow"),
/**
* Entered in error
*
*
This instance should not have been part of this patient's medical record.
*/
ENTERED_IN_ERROR("entered-in-error"),
/**
* Checked In
*
*
When checked in, all pre-encounter administrative work is complete, and the encounter may begin. (where multiple
* patients are involved, they are all present).
*/
CHECKED_IN("checked-in"),
/**
* Waitlisted
*
*
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.
*/
WAITLIST("waitlist");
private final java.lang.String value;
Value(java.lang.String value) {
this.value = value;
}
/**
* @return
* The java.lang.String value of the code represented by this enum
*/
public java.lang.String value() {
return value;
}
/**
* Factory method for creating AppointmentStatus.Value values from a passed string value.
*
* @param value
* A string that matches one of the allowed code values
* @return
* The corresponding AppointmentStatus.Value or null if a null value was passed
* @throws IllegalArgumentException
* If the passed string is not null and cannot be parsed into an allowed code value
*/
public static Value from(java.lang.String value) {
if (value == null) {
return null;
}
switch (value) {
case "proposed":
return PROPOSED;
case "pending":
return PENDING;
case "booked":
return BOOKED;
case "arrived":
return ARRIVED;
case "fulfilled":
return FULFILLED;
case "cancelled":
return CANCELLED;
case "noshow":
return NOSHOW;
case "entered-in-error":
return ENTERED_IN_ERROR;
case "checked-in":
return CHECKED_IN;
case "waitlist":
return WAITLIST;
default:
throw new IllegalArgumentException(value);
}
}
}
}