com.ibm.fhir.model.type.code.EpisodeOfCareStatus 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/episode-of-care-status")
@Generated("com.ibm.fhir.tools.CodeGenerator")
public class EpisodeOfCareStatus extends Code {
/**
* Planned
*
* This episode of care is planned to start at the date specified in the period.start. During this status, an
* organization may perform assessments to determine if the patient is eligible to receive services, or be organizing to
* make resources available to provide care services.
*/
public static final EpisodeOfCareStatus PLANNED = EpisodeOfCareStatus.builder().value(Value.PLANNED).build();
/**
* Waitlist
*
*
This episode has been placed on a waitlist, pending the episode being made active (or cancelled).
*/
public static final EpisodeOfCareStatus WAITLIST = EpisodeOfCareStatus.builder().value(Value.WAITLIST).build();
/**
* Active
*
*
This episode of care is current.
*/
public static final EpisodeOfCareStatus ACTIVE = EpisodeOfCareStatus.builder().value(Value.ACTIVE).build();
/**
* On Hold
*
*
This episode of care is on hold; the organization has limited responsibility for the patient (such as while on
* respite).
*/
public static final EpisodeOfCareStatus ONHOLD = EpisodeOfCareStatus.builder().value(Value.ONHOLD).build();
/**
* Finished
*
*
This episode of care is finished and the organization is not expecting to be providing further care to the patient.
* Can also be known as "closed", "completed" or other similar terms.
*/
public static final EpisodeOfCareStatus FINISHED = EpisodeOfCareStatus.builder().value(Value.FINISHED).build();
/**
* Cancelled
*
*
The episode of care was cancelled, or withdrawn from service, often selected during the planned stage as the
* patient may have gone elsewhere, or the circumstances have changed and the organization is unable to provide the care.
* It indicates that services terminated outside the planned/expected workflow.
*/
public static final EpisodeOfCareStatus CANCELLED = EpisodeOfCareStatus.builder().value(Value.CANCELLED).build();
/**
* Entered in Error
*
*
This instance should not have been part of this patient's medical record.
*/
public static final EpisodeOfCareStatus ENTERED_IN_ERROR = EpisodeOfCareStatus.builder().value(Value.ENTERED_IN_ERROR).build();
private volatile int hashCode;
private EpisodeOfCareStatus(Builder builder) {
super(builder);
}
/**
* Get the value of this EpisodeOfCareStatus 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 EpisodeOfCareStatus as an enum constant.
*/
public Value getValueAsEnum() {
return (value != null) ? Value.from(value) : null;
}
/**
* Factory method for creating EpisodeOfCareStatus objects from a passed enum value.
* @deprecated replaced by {@link #of(Value)}
*/
@Deprecated
public static EpisodeOfCareStatus of(ValueSet value) {
switch (value) {
case PLANNED:
return PLANNED;
case WAITLIST:
return WAITLIST;
case ACTIVE:
return ACTIVE;
case ONHOLD:
return ONHOLD;
case FINISHED:
return FINISHED;
case CANCELLED:
return CANCELLED;
case ENTERED_IN_ERROR:
return ENTERED_IN_ERROR;
default:
throw new IllegalStateException(value.name());
}
}
/**
* Factory method for creating EpisodeOfCareStatus objects from a passed enum value.
*/
public static EpisodeOfCareStatus of(Value value) {
switch (value) {
case PLANNED:
return PLANNED;
case WAITLIST:
return WAITLIST;
case ACTIVE:
return ACTIVE;
case ONHOLD:
return ONHOLD;
case FINISHED:
return FINISHED;
case CANCELLED:
return CANCELLED;
case ENTERED_IN_ERROR:
return ENTERED_IN_ERROR;
default:
throw new IllegalStateException(value.name());
}
}
/**
* Factory method for creating EpisodeOfCareStatus 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 EpisodeOfCareStatus of(java.lang.String value) {
return of(Value.from(value));
}
/**
* Inherited factory method for creating EpisodeOfCareStatus 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 EpisodeOfCareStatus 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;
}
EpisodeOfCareStatus other = (EpisodeOfCareStatus) 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 EpisodeOfCareStatus
*
* @return
* A reference to this Builder instance
*/
public Builder value(Value value) {
return (value != null) ? (Builder) super.value(value.value()) : this;
}
@Override
public EpisodeOfCareStatus build() {
EpisodeOfCareStatus episodeOfCareStatus = new EpisodeOfCareStatus(this);
if (validating) {
validate(episodeOfCareStatus);
}
return episodeOfCareStatus;
}
protected void validate(EpisodeOfCareStatus episodeOfCareStatus) {
super.validate(episodeOfCareStatus);
}
protected Builder from(EpisodeOfCareStatus episodeOfCareStatus) {
super.from(episodeOfCareStatus);
return this;
}
}
@Deprecated
public enum ValueSet {
/**
* Planned
*
* This episode of care is planned to start at the date specified in the period.start. During this status, an
* organization may perform assessments to determine if the patient is eligible to receive services, or be organizing to
* make resources available to provide care services.
*/
PLANNED("planned"),
/**
* Waitlist
*
*
This episode has been placed on a waitlist, pending the episode being made active (or cancelled).
*/
WAITLIST("waitlist"),
/**
* Active
*
*
This episode of care is current.
*/
ACTIVE("active"),
/**
* On Hold
*
*
This episode of care is on hold; the organization has limited responsibility for the patient (such as while on
* respite).
*/
ONHOLD("onhold"),
/**
* Finished
*
*
This episode of care is finished and the organization is not expecting to be providing further care to the patient.
* Can also be known as "closed", "completed" or other similar terms.
*/
FINISHED("finished"),
/**
* Cancelled
*
*
The episode of care was cancelled, or withdrawn from service, often selected during the planned stage as the
* patient may have gone elsewhere, or the circumstances have changed and the organization is unable to provide the care.
* It indicates that services terminated outside the planned/expected workflow.
*/
CANCELLED("cancelled"),
/**
* Entered in Error
*
*
This instance should not have been part of this patient's medical record.
*/
ENTERED_IN_ERROR("entered-in-error");
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 EpisodeOfCareStatus.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
*
*
This episode of care is planned to start at the date specified in the period.start. During this status, an
* organization may perform assessments to determine if the patient is eligible to receive services, or be organizing to
* make resources available to provide care services.
*/
PLANNED("planned"),
/**
* Waitlist
*
*
This episode has been placed on a waitlist, pending the episode being made active (or cancelled).
*/
WAITLIST("waitlist"),
/**
* Active
*
*
This episode of care is current.
*/
ACTIVE("active"),
/**
* On Hold
*
*
This episode of care is on hold; the organization has limited responsibility for the patient (such as while on
* respite).
*/
ONHOLD("onhold"),
/**
* Finished
*
*
This episode of care is finished and the organization is not expecting to be providing further care to the patient.
* Can also be known as "closed", "completed" or other similar terms.
*/
FINISHED("finished"),
/**
* Cancelled
*
*
The episode of care was cancelled, or withdrawn from service, often selected during the planned stage as the
* patient may have gone elsewhere, or the circumstances have changed and the organization is unable to provide the care.
* It indicates that services terminated outside the planned/expected workflow.
*/
CANCELLED("cancelled"),
/**
* Entered in Error
*
*
This instance should not have been part of this patient's medical record.
*/
ENTERED_IN_ERROR("entered-in-error");
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 EpisodeOfCareStatus.Value values from a passed string value.
*
* @param value
* A string that matches one of the allowed code values
* @return
* The corresponding EpisodeOfCareStatus.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 "waitlist":
return WAITLIST;
case "active":
return ACTIVE;
case "onhold":
return ONHOLD;
case "finished":
return FINISHED;
case "cancelled":
return CANCELLED;
case "entered-in-error":
return ENTERED_IN_ERROR;
default:
throw new IllegalArgumentException(value);
}
}
}
}