com.ibm.fhir.model.type.code.RiskAssessmentStatus 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/observation-status")
@Generated("com.ibm.fhir.tools.CodeGenerator")
public class RiskAssessmentStatus extends Code {
/**
* Registered
*
* The existence of the observation is registered, but there is no result yet available.
*/
public static final RiskAssessmentStatus REGISTERED = RiskAssessmentStatus.builder().value(Value.REGISTERED).build();
/**
* Preliminary
*
*
This is an initial or interim observation: data may be incomplete or unverified.
*/
public static final RiskAssessmentStatus PRELIMINARY = RiskAssessmentStatus.builder().value(Value.PRELIMINARY).build();
/**
* Final
*
*
The observation is complete and there are no further actions needed. Additional information such "released",
* "signed", etc would be represented using [Provenance](provenance.html) which provides not only the act but also the
* actors and dates and other related data. These act states would be associated with an observation status of
* `preliminary` until they are all completed and then a status of `final` would be applied.
*/
public static final RiskAssessmentStatus FINAL = RiskAssessmentStatus.builder().value(Value.FINAL).build();
/**
* Amended
*
*
Subsequent to being Final, the observation has been modified subsequent. This includes updates/new information and
* corrections.
*/
public static final RiskAssessmentStatus AMENDED = RiskAssessmentStatus.builder().value(Value.AMENDED).build();
/**
* Corrected
*
*
Subsequent to being Final, the observation has been modified to correct an error in the test result.
*/
public static final RiskAssessmentStatus CORRECTED = RiskAssessmentStatus.builder().value(Value.CORRECTED).build();
/**
* Cancelled
*
*
The observation is unavailable because the measurement was not started or not completed (also sometimes called
* "aborted").
*/
public static final RiskAssessmentStatus CANCELLED = RiskAssessmentStatus.builder().value(Value.CANCELLED).build();
/**
* Entered in Error
*
*
The observation has been withdrawn following previous final release. This electronic record should never have
* existed, though it is possible that real-world decisions were based on it. (If real-world activity has occurred, the
* status should be "cancelled" rather than "entered-in-error".).
*/
public static final RiskAssessmentStatus ENTERED_IN_ERROR = RiskAssessmentStatus.builder().value(Value.ENTERED_IN_ERROR).build();
/**
* Unknown
*
*
The authoring/source system does not know which of the status values currently applies for this observation. Note:
* This concept is not to be used for "other" - one of the listed statuses is presumed to apply, but the authoring/source
* system does not know which.
*/
public static final RiskAssessmentStatus UNKNOWN = RiskAssessmentStatus.builder().value(Value.UNKNOWN).build();
private volatile int hashCode;
private RiskAssessmentStatus(Builder builder) {
super(builder);
}
/**
* Get the value of this RiskAssessmentStatus 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 RiskAssessmentStatus as an enum constant.
*/
public Value getValueAsEnum() {
return (value != null) ? Value.from(value) : null;
}
/**
* Factory method for creating RiskAssessmentStatus objects from a passed enum value.
* @deprecated replaced by {@link #of(Value)}
*/
@Deprecated
public static RiskAssessmentStatus of(ValueSet value) {
switch (value) {
case REGISTERED:
return REGISTERED;
case PRELIMINARY:
return PRELIMINARY;
case FINAL:
return FINAL;
case AMENDED:
return AMENDED;
case CORRECTED:
return CORRECTED;
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 RiskAssessmentStatus objects from a passed enum value.
*/
public static RiskAssessmentStatus of(Value value) {
switch (value) {
case REGISTERED:
return REGISTERED;
case PRELIMINARY:
return PRELIMINARY;
case FINAL:
return FINAL;
case AMENDED:
return AMENDED;
case CORRECTED:
return CORRECTED;
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 RiskAssessmentStatus 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 RiskAssessmentStatus of(java.lang.String value) {
return of(Value.from(value));
}
/**
* Inherited factory method for creating RiskAssessmentStatus 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 RiskAssessmentStatus 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;
}
RiskAssessmentStatus other = (RiskAssessmentStatus) 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 RiskAssessmentStatus
*
* @return
* A reference to this Builder instance
*/
public Builder value(Value value) {
return (value != null) ? (Builder) super.value(value.value()) : this;
}
@Override
public RiskAssessmentStatus build() {
RiskAssessmentStatus riskAssessmentStatus = new RiskAssessmentStatus(this);
if (validating) {
validate(riskAssessmentStatus);
}
return riskAssessmentStatus;
}
protected void validate(RiskAssessmentStatus riskAssessmentStatus) {
super.validate(riskAssessmentStatus);
}
protected Builder from(RiskAssessmentStatus riskAssessmentStatus) {
super.from(riskAssessmentStatus);
return this;
}
}
@Deprecated
public enum ValueSet {
/**
* Registered
*
* The existence of the observation is registered, but there is no result yet available.
*/
REGISTERED("registered"),
/**
* Preliminary
*
*
This is an initial or interim observation: data may be incomplete or unverified.
*/
PRELIMINARY("preliminary"),
/**
* Final
*
*
The observation is complete and there are no further actions needed. Additional information such "released",
* "signed", etc would be represented using [Provenance](provenance.html) which provides not only the act but also the
* actors and dates and other related data. These act states would be associated with an observation status of
* `preliminary` until they are all completed and then a status of `final` would be applied.
*/
FINAL("final"),
/**
* Amended
*
*
Subsequent to being Final, the observation has been modified subsequent. This includes updates/new information and
* corrections.
*/
AMENDED("amended"),
/**
* Corrected
*
*
Subsequent to being Final, the observation has been modified to correct an error in the test result.
*/
CORRECTED("corrected"),
/**
* Cancelled
*
*
The observation is unavailable because the measurement was not started or not completed (also sometimes called
* "aborted").
*/
CANCELLED("cancelled"),
/**
* Entered in Error
*
*
The observation has been withdrawn following previous final release. This electronic record should never have
* existed, though it is possible that real-world decisions were based on it. (If real-world activity has occurred, the
* status should be "cancelled" rather than "entered-in-error".).
*/
ENTERED_IN_ERROR("entered-in-error"),
/**
* Unknown
*
*
The authoring/source system does not know which of the status values currently applies for this observation. Note:
* This concept is not to be used for "other" - one of the listed statuses is presumed to apply, but the authoring/source
* system does not know which.
*/
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 RiskAssessmentStatus.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 {
/**
* Registered
*
*
The existence of the observation is registered, but there is no result yet available.
*/
REGISTERED("registered"),
/**
* Preliminary
*
*
This is an initial or interim observation: data may be incomplete or unverified.
*/
PRELIMINARY("preliminary"),
/**
* Final
*
*
The observation is complete and there are no further actions needed. Additional information such "released",
* "signed", etc would be represented using [Provenance](provenance.html) which provides not only the act but also the
* actors and dates and other related data. These act states would be associated with an observation status of
* `preliminary` until they are all completed and then a status of `final` would be applied.
*/
FINAL("final"),
/**
* Amended
*
*
Subsequent to being Final, the observation has been modified subsequent. This includes updates/new information and
* corrections.
*/
AMENDED("amended"),
/**
* Corrected
*
*
Subsequent to being Final, the observation has been modified to correct an error in the test result.
*/
CORRECTED("corrected"),
/**
* Cancelled
*
*
The observation is unavailable because the measurement was not started or not completed (also sometimes called
* "aborted").
*/
CANCELLED("cancelled"),
/**
* Entered in Error
*
*
The observation has been withdrawn following previous final release. This electronic record should never have
* existed, though it is possible that real-world decisions were based on it. (If real-world activity has occurred, the
* status should be "cancelled" rather than "entered-in-error".).
*/
ENTERED_IN_ERROR("entered-in-error"),
/**
* Unknown
*
*
The authoring/source system does not know which of the status values currently applies for this observation. Note:
* This concept is not to be used for "other" - one of the listed statuses is presumed to apply, but the authoring/source
* system does not know which.
*/
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 RiskAssessmentStatus.Value values from a passed string value.
*
* @param value
* A string that matches one of the allowed code values
* @return
* The corresponding RiskAssessmentStatus.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 "registered":
return REGISTERED;
case "preliminary":
return PRELIMINARY;
case "final":
return FINAL;
case "amended":
return AMENDED;
case "corrected":
return CORRECTED;
case "cancelled":
return CANCELLED;
case "entered-in-error":
return ENTERED_IN_ERROR;
case "unknown":
return UNKNOWN;
default:
throw new IllegalArgumentException(value);
}
}
}
}