com.ibm.fhir.model.resource.BodyStructure Maven / Gradle / Ivy
/*
* (C) Copyright IBM Corp. 2019, 2021
*
* SPDX-License-Identifier: Apache-2.0
*/
package com.ibm.fhir.model.resource;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import javax.annotation.Generated;
import com.ibm.fhir.model.annotation.Binding;
import com.ibm.fhir.model.annotation.Maturity;
import com.ibm.fhir.model.annotation.ReferenceTarget;
import com.ibm.fhir.model.annotation.Required;
import com.ibm.fhir.model.annotation.Summary;
import com.ibm.fhir.model.type.Attachment;
import com.ibm.fhir.model.type.Boolean;
import com.ibm.fhir.model.type.Code;
import com.ibm.fhir.model.type.CodeableConcept;
import com.ibm.fhir.model.type.Extension;
import com.ibm.fhir.model.type.Identifier;
import com.ibm.fhir.model.type.Meta;
import com.ibm.fhir.model.type.Narrative;
import com.ibm.fhir.model.type.Reference;
import com.ibm.fhir.model.type.String;
import com.ibm.fhir.model.type.Uri;
import com.ibm.fhir.model.type.code.BindingStrength;
import com.ibm.fhir.model.type.code.StandardsStatus;
import com.ibm.fhir.model.util.ValidationSupport;
import com.ibm.fhir.model.visitor.Visitor;
/**
* Record details about an anatomical structure. This resource may be used when a coded concept does not provide the
* necessary detail needed for the use case.
*
* Maturity level: FMM1 (Trial Use)
*/
@Maturity(
level = 1,
status = StandardsStatus.Value.TRIAL_USE
)
@Generated("com.ibm.fhir.tools.CodeGenerator")
public class BodyStructure extends DomainResource {
@Summary
private final List identifier;
@Summary
private final Boolean active;
@Summary
@Binding(
bindingName = "BodyStructureCode",
strength = BindingStrength.Value.EXAMPLE,
description = "Codes describing anatomic morphology.",
valueSet = "http://hl7.org/fhir/ValueSet/bodystructure-code"
)
private final CodeableConcept morphology;
@Summary
@Binding(
bindingName = "BodySite",
strength = BindingStrength.Value.EXAMPLE,
description = "Codes describing anatomical locations. May include laterality.",
valueSet = "http://hl7.org/fhir/ValueSet/body-site"
)
private final CodeableConcept location;
@Binding(
bindingName = "BodyStructureQualifier",
strength = BindingStrength.Value.EXAMPLE,
description = "Concepts modifying the anatomic location.",
valueSet = "http://hl7.org/fhir/ValueSet/bodystructure-relative-location"
)
private final List locationQualifier;
@Summary
private final String description;
private final List image;
@Summary
@ReferenceTarget({ "Patient" })
@Required
private final Reference patient;
private BodyStructure(Builder builder) {
super(builder);
identifier = Collections.unmodifiableList(builder.identifier);
active = builder.active;
morphology = builder.morphology;
location = builder.location;
locationQualifier = Collections.unmodifiableList(builder.locationQualifier);
description = builder.description;
image = Collections.unmodifiableList(builder.image);
patient = builder.patient;
}
/**
* Identifier for this instance of the anatomical structure.
*
* @return
* An unmodifiable list containing immutable objects of type {@link Identifier} that may be empty.
*/
public List getIdentifier() {
return identifier;
}
/**
* Whether this body site is in active use.
*
* @return
* An immutable object of type {@link Boolean} that may be null.
*/
public Boolean getActive() {
return active;
}
/**
* The kind of structure being represented by the body structure at `BodyStructure.location`. This can define both normal
* and abnormal morphologies.
*
* @return
* An immutable object of type {@link CodeableConcept} that may be null.
*/
public CodeableConcept getMorphology() {
return morphology;
}
/**
* The anatomical location or region of the specimen, lesion, or body structure.
*
* @return
* An immutable object of type {@link CodeableConcept} that may be null.
*/
public CodeableConcept getLocation() {
return location;
}
/**
* Qualifier to refine the anatomical location. These include qualifiers for laterality, relative location,
* directionality, number, and plane.
*
* @return
* An unmodifiable list containing immutable objects of type {@link CodeableConcept} that may be empty.
*/
public List getLocationQualifier() {
return locationQualifier;
}
/**
* A summary, characterization or explanation of the body structure.
*
* @return
* An immutable object of type {@link String} that may be null.
*/
public String getDescription() {
return description;
}
/**
* Image or images used to identify a location.
*
* @return
* An unmodifiable list containing immutable objects of type {@link Attachment} that may be empty.
*/
public List getImage() {
return image;
}
/**
* The person to which the body site belongs.
*
* @return
* An immutable object of type {@link Reference} that is non-null.
*/
public Reference getPatient() {
return patient;
}
@Override
public boolean hasChildren() {
return super.hasChildren() ||
!identifier.isEmpty() ||
(active != null) ||
(morphology != null) ||
(location != null) ||
!locationQualifier.isEmpty() ||
(description != null) ||
!image.isEmpty() ||
(patient != null);
}
@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(meta, "meta", visitor);
accept(implicitRules, "implicitRules", visitor);
accept(language, "language", visitor);
accept(text, "text", visitor);
accept(contained, "contained", visitor, Resource.class);
accept(extension, "extension", visitor, Extension.class);
accept(modifierExtension, "modifierExtension", visitor, Extension.class);
accept(identifier, "identifier", visitor, Identifier.class);
accept(active, "active", visitor);
accept(morphology, "morphology", visitor);
accept(location, "location", visitor);
accept(locationQualifier, "locationQualifier", visitor, CodeableConcept.class);
accept(description, "description", visitor);
accept(image, "image", visitor, Attachment.class);
accept(patient, "patient", 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;
}
BodyStructure other = (BodyStructure) obj;
return Objects.equals(id, other.id) &&
Objects.equals(meta, other.meta) &&
Objects.equals(implicitRules, other.implicitRules) &&
Objects.equals(language, other.language) &&
Objects.equals(text, other.text) &&
Objects.equals(contained, other.contained) &&
Objects.equals(extension, other.extension) &&
Objects.equals(modifierExtension, other.modifierExtension) &&
Objects.equals(identifier, other.identifier) &&
Objects.equals(active, other.active) &&
Objects.equals(morphology, other.morphology) &&
Objects.equals(location, other.location) &&
Objects.equals(locationQualifier, other.locationQualifier) &&
Objects.equals(description, other.description) &&
Objects.equals(image, other.image) &&
Objects.equals(patient, other.patient);
}
@Override
public int hashCode() {
int result = hashCode;
if (result == 0) {
result = Objects.hash(id,
meta,
implicitRules,
language,
text,
contained,
extension,
modifierExtension,
identifier,
active,
morphology,
location,
locationQualifier,
description,
image,
patient);
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 DomainResource.Builder {
private List identifier = new ArrayList<>();
private Boolean active;
private CodeableConcept morphology;
private CodeableConcept location;
private List locationQualifier = new ArrayList<>();
private String description;
private List image = new ArrayList<>();
private Reference patient;
private Builder() {
super();
}
/**
* The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
*
* @param id
* Logical id of this artifact
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder id(java.lang.String id) {
return (Builder) super.id(id);
}
/**
* The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content
* might not always be associated with version changes to the resource.
*
* @param meta
* Metadata about the resource
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder meta(Meta meta) {
return (Builder) super.meta(meta);
}
/**
* A reference to a set of rules that were followed when the resource was constructed, and which must be understood when
* processing the content. Often, this is a reference to an implementation guide that defines the special rules along
* with other profiles etc.
*
* @param implicitRules
* A set of rules under which this content was created
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder implicitRules(Uri implicitRules) {
return (Builder) super.implicitRules(implicitRules);
}
/**
* The base language in which the resource is written.
*
* @param language
* Language of the resource content
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder language(Code language) {
return (Builder) super.language(language);
}
/**
* A human-readable narrative that contains a summary of the resource and can be used to represent the content of the
* resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient
* detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what
* content should be represented in the narrative to ensure clinical safety.
*
* @param text
* Text summary of the resource, for human interpretation
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder text(Narrative text) {
return (Builder) super.text(text);
}
/**
* These resources do not have an independent existence apart from the resource that contains them - they cannot be
* identified independently, and nor can they have their own independent transaction scope.
*
* Adds new element(s) to the existing list
*
* @param contained
* Contained, inline Resources
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder contained(Resource... contained) {
return (Builder) super.contained(contained);
}
/**
* These resources do not have an independent existence apart from the resource that contains them - they cannot be
* identified independently, and nor can they have their own independent transaction scope.
*
*
Replaces the existing list with a new one containing elements from the Collection
*
* @param contained
* Contained, inline Resources
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder contained(Collection contained) {
return (Builder) super.contained(contained);
}
/**
* May be used to represent additional information that is not part of the basic definition of the resource. 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 resource. 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);
}
/**
* May be used to represent additional information that is not part of the basic definition of the resource and that
* modifies the understanding of the element that contains it and/or the understanding of the containing element's
* descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the
* definition of the extension. Applications processing a resource are required to check for modifier extensions.
*
* Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot
* change the meaning of modifierExtension itself).
*
*
Adds new element(s) to the existing list
*
* @param modifierExtension
* Extensions that cannot be ignored
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder modifierExtension(Extension... modifierExtension) {
return (Builder) super.modifierExtension(modifierExtension);
}
/**
* May be used to represent additional information that is not part of the basic definition of the resource and that
* modifies the understanding of the element that contains it and/or the understanding of the containing element's
* descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the
* definition of the extension. Applications processing a resource are required to check for modifier extensions.
*
*
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot
* change the meaning of modifierExtension itself).
*
*
Replaces the existing list with a new one containing elements from the Collection
*
* @param modifierExtension
* Extensions that cannot be ignored
*
* @return
* A reference to this Builder instance
*/
@Override
public Builder modifierExtension(Collection modifierExtension) {
return (Builder) super.modifierExtension(modifierExtension);
}
/**
* Identifier for this instance of the anatomical structure.
*
* Adds new element(s) to the existing list
*
* @param identifier
* Bodystructure identifier
*
* @return
* A reference to this Builder instance
*/
public Builder identifier(Identifier... identifier) {
for (Identifier value : identifier) {
this.identifier.add(value);
}
return this;
}
/**
* Identifier for this instance of the anatomical structure.
*
*
Replaces the existing list with a new one containing elements from the Collection
*
* @param identifier
* Bodystructure identifier
*
* @return
* A reference to this Builder instance
*/
public Builder identifier(Collection identifier) {
this.identifier = new ArrayList<>(identifier);
return this;
}
/**
* Whether this body site is in active use.
*
* @param active
* Whether this record is in active use
*
* @return
* A reference to this Builder instance
*/
public Builder active(Boolean active) {
this.active = active;
return this;
}
/**
* The kind of structure being represented by the body structure at `BodyStructure.location`. This can define both normal
* and abnormal morphologies.
*
* @param morphology
* Kind of Structure
*
* @return
* A reference to this Builder instance
*/
public Builder morphology(CodeableConcept morphology) {
this.morphology = morphology;
return this;
}
/**
* The anatomical location or region of the specimen, lesion, or body structure.
*
* @param location
* Body site
*
* @return
* A reference to this Builder instance
*/
public Builder location(CodeableConcept location) {
this.location = location;
return this;
}
/**
* Qualifier to refine the anatomical location. These include qualifiers for laterality, relative location,
* directionality, number, and plane.
*
* Adds new element(s) to the existing list
*
* @param locationQualifier
* Body site modifier
*
* @return
* A reference to this Builder instance
*/
public Builder locationQualifier(CodeableConcept... locationQualifier) {
for (CodeableConcept value : locationQualifier) {
this.locationQualifier.add(value);
}
return this;
}
/**
* Qualifier to refine the anatomical location. These include qualifiers for laterality, relative location,
* directionality, number, and plane.
*
*
Replaces the existing list with a new one containing elements from the Collection
*
* @param locationQualifier
* Body site modifier
*
* @return
* A reference to this Builder instance
*/
public Builder locationQualifier(Collection locationQualifier) {
this.locationQualifier = new ArrayList<>(locationQualifier);
return this;
}
/**
* A summary, characterization or explanation of the body structure.
*
* @param description
* Text description
*
* @return
* A reference to this Builder instance
*/
public Builder description(String description) {
this.description = description;
return this;
}
/**
* Image or images used to identify a location.
*
* Adds new element(s) to the existing list
*
* @param image
* Attached images
*
* @return
* A reference to this Builder instance
*/
public Builder image(Attachment... image) {
for (Attachment value : image) {
this.image.add(value);
}
return this;
}
/**
* Image or images used to identify a location.
*
*
Replaces the existing list with a new one containing elements from the Collection
*
* @param image
* Attached images
*
* @return
* A reference to this Builder instance
*/
public Builder image(Collection image) {
this.image = new ArrayList<>(image);
return this;
}
/**
* The person to which the body site belongs.
*
* This element is required.
*
*
Allowed resource types for this reference:
*
* - {@link Patient}
*
*
* @param patient
* Who this is about
*
* @return
* A reference to this Builder instance
*/
public Builder patient(Reference patient) {
this.patient = patient;
return this;
}
/**
* Build the {@link BodyStructure}
*
* Required elements:
*
* - patient
*
*
* @return
* An immutable object of type {@link BodyStructure}
* @throws IllegalStateException
* if the current state cannot be built into a valid BodyStructure per the base specification
*/
@Override
public BodyStructure build() {
BodyStructure bodyStructure = new BodyStructure(this);
if (validating) {
validate(bodyStructure);
}
return bodyStructure;
}
protected void validate(BodyStructure bodyStructure) {
super.validate(bodyStructure);
ValidationSupport.checkList(bodyStructure.identifier, "identifier", Identifier.class);
ValidationSupport.checkList(bodyStructure.locationQualifier, "locationQualifier", CodeableConcept.class);
ValidationSupport.checkList(bodyStructure.image, "image", Attachment.class);
ValidationSupport.requireNonNull(bodyStructure.patient, "patient");
ValidationSupport.checkReferenceType(bodyStructure.patient, "patient", "Patient");
}
protected Builder from(BodyStructure bodyStructure) {
super.from(bodyStructure);
identifier.addAll(bodyStructure.identifier);
active = bodyStructure.active;
morphology = bodyStructure.morphology;
location = bodyStructure.location;
locationQualifier.addAll(bodyStructure.locationQualifier);
description = bodyStructure.description;
image.addAll(bodyStructure.image);
patient = bodyStructure.patient;
return this;
}
}
}