com.ibm.fhir.model.type.Age Maven / Gradle / Ivy
/*
* (C) Copyright IBM Corp. 2019, 2021
*
* SPDX-License-Identifier: Apache-2.0
*/
package com.ibm.fhir.model.type;
import java.util.Collection;
import java.util.Objects;
import javax.annotation.Generated;
import com.ibm.fhir.model.annotation.Binding;
import com.ibm.fhir.model.annotation.Constraint;
import com.ibm.fhir.model.type.code.BindingStrength;
import com.ibm.fhir.model.type.code.QuantityComparator;
import com.ibm.fhir.model.visitor.Visitor;
/**
* A duration of time during which an organism (or a process) has existed.
*/
@Constraint(
id = "age-1",
level = "Rule",
location = "(base)",
description = "There SHALL be a code if there is a value and it SHALL be an expression of time. If system is present, it SHALL be UCUM. If value is present, it SHALL be positive.",
expression = "(code.exists() or value.empty()) and (system.empty() or system = %ucum) and (value.empty() or value.hasValue().not() or value > 0)"
)
@Constraint(
id = "age-2",
level = "Warning",
location = "(base)",
description = "SHALL, if possible, contain a code from value set http://hl7.org/fhir/ValueSet/age-units",
expression = "$this.memberOf('http://hl7.org/fhir/ValueSet/age-units', 'extensible')",
generated = true
)
@Binding(
bindingName = "AgeUnits",
strength = BindingStrength.Value.EXTENSIBLE,
description = "Appropriate units for Age.",
valueSet = "http://hl7.org/fhir/ValueSet/age-units",
maxValueSet = "http://hl7.org/fhir/ValueSet/all-time-units"
)
@Generated("com.ibm.fhir.tools.CodeGenerator")
public class Age extends Quantity {
private Age(Builder builder) {
super(builder);
}
@Override
public void accept(java.lang.String elementName, int elementIndex, Visitor visitor) {
if (visitor.preVisit(this)) {
visitor.visitStart(elementName, elementIndex, this);
if (visitor.visit(elementName, elementIndex, this)) {
// visit children
accept(id, "id", visitor);
accept(extension, "extension", visitor, Extension.class);
accept(value, "value", visitor);
accept(comparator, "comparator", visitor);
accept(unit, "unit", visitor);
accept(system, "system", visitor);
accept(code, "code", visitor);
}
visitor.visitEnd(elementName, elementIndex, this);
visitor.postVisit(this);
}
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (getClass() != obj.getClass()) {
return false;
}
Age other = (Age) obj;
return Objects.equals(id, other.id) &&
Objects.equals(extension, other.extension) &&
Objects.equals(value, other.value) &&
Objects.equals(comparator, other.comparator) &&
Objects.equals(unit, other.unit) &&
Objects.equals(system, other.system) &&
Objects.equals(code, other.code);
}
@Override
public int hashCode() {
int result = hashCode;
if (result == 0) {
result = Objects.hash(id,
extension,
value,
comparator,
unit,
system,
code);
hashCode = result;
}
return result;
}
@Override
public Builder toBuilder() {
return new Builder().from(this);
}
public static Builder builder() {
return new Builder();
}
public static class Builder extends Quantity.Builder {
private Builder() {
super();
}
/**
* Unique id for the element within a resource (for internal references). This may be any string value that does not
* contain spaces.
*
* @param id
* Unique id for inter-element referencing
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder id(java.lang.String id) {
return (Builder) super.id(id);
}
/**
* May be used to represent additional information that is not part of the basic definition of the element. To make the
* use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of
* extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part
* of the definition of the extension.
*
* Adds new element(s) to the existing list
*
* @param extension
* Additional content defined by implementations
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder extension(Extension... extension) {
return (Builder) super.extension(extension);
}
/**
* May be used to represent additional information that is not part of the basic definition of the element. To make the
* use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of
* extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part
* of the definition of the extension.
*
*
Replaces the existing list with a new one containing elements from the Collection
*
* @param extension
* Additional content defined by implementations
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder extension(Collection extension) {
return (Builder) super.extension(extension);
}
/**
* The value of the measured amount. The value includes an implicit precision in the presentation of the value.
*
* @param value
* Numerical value (with implicit precision)
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder value(Decimal value) {
return (Builder) super.value(value);
}
/**
* How the value should be understood and represented - whether the actual value is greater or less than the stated value
* due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.
*
* @param comparator
* < | <= | >= | > - how to understand the value
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder comparator(QuantityComparator comparator) {
return (Builder) super.comparator(comparator);
}
/**
* A human-readable form of the unit.
*
* @param unit
* Unit representation
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder unit(String unit) {
return (Builder) super.unit(unit);
}
/**
* The identification of the system that provides the coded form of the unit.
*
* @param system
* System that defines coded unit form
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder system(Uri system) {
return (Builder) super.system(system);
}
/**
* A computer processable form of the unit in some unit representation system.
*
* @param code
* Coded form of the unit
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder code(Code code) {
return (Builder) super.code(code);
}
/**
* Build the {@link Age}
*
* @return
* An immutable object of type {@link Age}
* @throws IllegalStateException
* if the current state cannot be built into a valid Age per the base specification
*/
@Override
public Age build() {
Age age = new Age(this);
if (validating) {
validate(age);
}
return age;
}
protected void validate(Age age) {
super.validate(age);
}
protected Builder from(Age age) {
super.from(age);
return this;
}
}
}