com.ibm.fhir.model.type.code.EncounterStatus 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/encounter-status")
@Generated("com.ibm.fhir.tools.CodeGenerator")
public class EncounterStatus extends Code {
/**
* Planned
*
* The Encounter has not yet started.
*/
public static final EncounterStatus PLANNED = EncounterStatus.builder().value(Value.PLANNED).build();
/**
* Arrived
*
*
The Patient is present for the encounter, however is not currently meeting with a practitioner.
*/
public static final EncounterStatus ARRIVED = EncounterStatus.builder().value(Value.ARRIVED).build();
/**
* Triaged
*
*
The patient has been assessed for the priority of their treatment based on the severity of their condition.
*/
public static final EncounterStatus TRIAGED = EncounterStatus.builder().value(Value.TRIAGED).build();
/**
* In Progress
*
*
The Encounter has begun and the patient is present / the practitioner and the patient are meeting.
*/
public static final EncounterStatus IN_PROGRESS = EncounterStatus.builder().value(Value.IN_PROGRESS).build();
/**
* On Leave
*
*
The Encounter has begun, but the patient is temporarily on leave.
*/
public static final EncounterStatus ONLEAVE = EncounterStatus.builder().value(Value.ONLEAVE).build();
/**
* Finished
*
*
The Encounter has ended.
*/
public static final EncounterStatus FINISHED = EncounterStatus.builder().value(Value.FINISHED).build();
/**
* Cancelled
*
*
The Encounter has ended before it has begun.
*/
public static final EncounterStatus CANCELLED = EncounterStatus.builder().value(Value.CANCELLED).build();
/**
* Entered in Error
*
*
This instance should not have been part of this patient's medical record.
*/
public static final EncounterStatus ENTERED_IN_ERROR = EncounterStatus.builder().value(Value.ENTERED_IN_ERROR).build();
/**
* 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".
*/
public static final EncounterStatus UNKNOWN = EncounterStatus.builder().value(Value.UNKNOWN).build();
private volatile int hashCode;
private EncounterStatus(Builder builder) {
super(builder);
}
/**
* Get the value of this EncounterStatus 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 EncounterStatus as an enum constant.
*/
public Value getValueAsEnum() {
return (value != null) ? Value.from(value) : null;
}
/**
* Factory method for creating EncounterStatus objects from a passed enum value.
* @deprecated replaced by {@link #of(Value)}
*/
@Deprecated
public static EncounterStatus of(ValueSet value) {
switch (value) {
case PLANNED:
return PLANNED;
case ARRIVED:
return ARRIVED;
case TRIAGED:
return TRIAGED;
case IN_PROGRESS:
return IN_PROGRESS;
case ONLEAVE:
return ONLEAVE;
case FINISHED:
return FINISHED;
case CANCELLED:
return CANCELLED;
case ENTERED_IN_ERROR:
return ENTERED_IN_ERROR;
case UNKNOWN:
return UNKNOWN;
default:
throw new IllegalStateException(value.name());
}
}
/**
* Factory method for creating EncounterStatus objects from a passed enum value.
*/
public static EncounterStatus of(Value value) {
switch (value) {
case PLANNED:
return PLANNED;
case ARRIVED:
return ARRIVED;
case TRIAGED:
return TRIAGED;
case IN_PROGRESS:
return IN_PROGRESS;
case ONLEAVE:
return ONLEAVE;
case FINISHED:
return FINISHED;
case CANCELLED:
return CANCELLED;
case ENTERED_IN_ERROR:
return ENTERED_IN_ERROR;
case UNKNOWN:
return UNKNOWN;
default:
throw new IllegalStateException(value.name());
}
}
/**
* Factory method for creating EncounterStatus 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 EncounterStatus of(java.lang.String value) {
return of(Value.from(value));
}
/**
* Inherited factory method for creating EncounterStatus 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 EncounterStatus 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;
}
EncounterStatus other = (EncounterStatus) 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 EncounterStatus
*
* @return
* A reference to this Builder instance
*/
public Builder value(Value value) {
return (value != null) ? (Builder) super.value(value.value()) : this;
}
@Override
public EncounterStatus build() {
EncounterStatus encounterStatus = new EncounterStatus(this);
if (validating) {
validate(encounterStatus);
}
return encounterStatus;
}
protected void validate(EncounterStatus encounterStatus) {
super.validate(encounterStatus);
}
protected Builder from(EncounterStatus encounterStatus) {
super.from(encounterStatus);
return this;
}
}
@Deprecated
public enum ValueSet {
/**
* Planned
*
* The Encounter has not yet started.
*/
PLANNED("planned"),
/**
* Arrived
*
*
The Patient is present for the encounter, however is not currently meeting with a practitioner.
*/
ARRIVED("arrived"),
/**
* Triaged
*
*
The patient has been assessed for the priority of their treatment based on the severity of their condition.
*/
TRIAGED("triaged"),
/**
* In Progress
*
*
The Encounter has begun and the patient is present / the practitioner and the patient are meeting.
*/
IN_PROGRESS("in-progress"),
/**
* On Leave
*
*
The Encounter has begun, but the patient is temporarily on leave.
*/
ONLEAVE("onleave"),
/**
* Finished
*
*
The Encounter has ended.
*/
FINISHED("finished"),
/**
* Cancelled
*
*
The Encounter has ended before it has begun.
*/
CANCELLED("cancelled"),
/**
* Entered in Error
*
*
This instance should not have been part of this patient's medical record.
*/
ENTERED_IN_ERROR("entered-in-error"),
/**
* 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".
*/
UNKNOWN("unknown");
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 EncounterStatus.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 {
/**
* Planned
*
*
The Encounter has not yet started.
*/
PLANNED("planned"),
/**
* Arrived
*
*
The Patient is present for the encounter, however is not currently meeting with a practitioner.
*/
ARRIVED("arrived"),
/**
* Triaged
*
*
The patient has been assessed for the priority of their treatment based on the severity of their condition.
*/
TRIAGED("triaged"),
/**
* In Progress
*
*
The Encounter has begun and the patient is present / the practitioner and the patient are meeting.
*/
IN_PROGRESS("in-progress"),
/**
* On Leave
*
*
The Encounter has begun, but the patient is temporarily on leave.
*/
ONLEAVE("onleave"),
/**
* Finished
*
*
The Encounter has ended.
*/
FINISHED("finished"),
/**
* Cancelled
*
*
The Encounter has ended before it has begun.
*/
CANCELLED("cancelled"),
/**
* Entered in Error
*
*
This instance should not have been part of this patient's medical record.
*/
ENTERED_IN_ERROR("entered-in-error"),
/**
* 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".
*/
UNKNOWN("unknown");
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 EncounterStatus.Value values from a passed string value.
*
* @param value
* A string that matches one of the allowed code values
* @return
* The corresponding EncounterStatus.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 "planned":
return PLANNED;
case "arrived":
return ARRIVED;
case "triaged":
return TRIAGED;
case "in-progress":
return IN_PROGRESS;
case "onleave":
return ONLEAVE;
case "finished":
return FINISHED;
case "cancelled":
return CANCELLED;
case "entered-in-error":
return ENTERED_IN_ERROR;
case "unknown":
return UNKNOWN;
default:
throw new IllegalArgumentException(value);
}
}
}
}