com.ibm.fhir.model.resource.Flag 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.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.Period;
import com.ibm.fhir.model.type.Reference;
import com.ibm.fhir.model.type.Uri;
import com.ibm.fhir.model.type.code.BindingStrength;
import com.ibm.fhir.model.type.code.FlagStatus;
import com.ibm.fhir.model.type.code.StandardsStatus;
import com.ibm.fhir.model.util.ValidationSupport;
import com.ibm.fhir.model.visitor.Visitor;
/**
* Prospective warnings of potential issues when providing care to the patient.
*
* Maturity level: FMM1 (Trial Use)
*/
@Maturity(
level = 1,
status = StandardsStatus.Value.TRIAL_USE
)
@Generated("com.ibm.fhir.tools.CodeGenerator")
public class Flag extends DomainResource {
@Summary
private final List identifier;
@Summary
@Binding(
bindingName = "FlagStatus",
strength = BindingStrength.Value.REQUIRED,
description = "Indicates whether this flag is active and needs to be displayed to a user, or whether it is no longer needed or was entered in error.",
valueSet = "http://hl7.org/fhir/ValueSet/flag-status|4.0.1"
)
@Required
private final FlagStatus status;
@Summary
@Binding(
bindingName = "FlagCategory",
strength = BindingStrength.Value.EXAMPLE,
description = "A general category for flags for filtering/display purposes.",
valueSet = "http://hl7.org/fhir/ValueSet/flag-category"
)
private final List category;
@Summary
@Binding(
bindingName = "FlagCode",
strength = BindingStrength.Value.EXAMPLE,
description = "Detail codes identifying specific flagged issues.",
valueSet = "http://hl7.org/fhir/ValueSet/flag-code"
)
@Required
private final CodeableConcept code;
@Summary
@ReferenceTarget({ "Patient", "Location", "Group", "Organization", "Practitioner", "PlanDefinition", "Medication", "Procedure" })
@Required
private final Reference subject;
@Summary
private final Period period;
@Summary
@ReferenceTarget({ "Encounter" })
private final Reference encounter;
@Summary
@ReferenceTarget({ "Device", "Organization", "Patient", "Practitioner", "PractitionerRole" })
private final Reference author;
private Flag(Builder builder) {
super(builder);
identifier = Collections.unmodifiableList(builder.identifier);
status = builder.status;
category = Collections.unmodifiableList(builder.category);
code = builder.code;
subject = builder.subject;
period = builder.period;
encounter = builder.encounter;
author = builder.author;
}
/**
* Business identifiers assigned to this flag by the performer or other systems which remain constant as the resource is
* updated and propagates from server to server.
*
* @return
* An unmodifiable list containing immutable objects of type {@link Identifier} that may be empty.
*/
public List getIdentifier() {
return identifier;
}
/**
* Supports basic workflow.
*
* @return
* An immutable object of type {@link FlagStatus} that is non-null.
*/
public FlagStatus getStatus() {
return status;
}
/**
* Allows a flag to be divided into different categories like clinical, administrative etc. Intended to be used as a
* means of filtering which flags are displayed to particular user or in a given context.
*
* @return
* An unmodifiable list containing immutable objects of type {@link CodeableConcept} that may be empty.
*/
public List getCategory() {
return category;
}
/**
* The coded value or textual component of the flag to display to the user.
*
* @return
* An immutable object of type {@link CodeableConcept} that is non-null.
*/
public CodeableConcept getCode() {
return code;
}
/**
* The patient, location, group, organization, or practitioner etc. this is about record this flag is associated with.
*
* @return
* An immutable object of type {@link Reference} that is non-null.
*/
public Reference getSubject() {
return subject;
}
/**
* The period of time from the activation of the flag to inactivation of the flag. If the flag is active, the end of the
* period should be unspecified.
*
* @return
* An immutable object of type {@link Period} that may be null.
*/
public Period getPeriod() {
return period;
}
/**
* This alert is only relevant during the encounter.
*
* @return
* An immutable object of type {@link Reference} that may be null.
*/
public Reference getEncounter() {
return encounter;
}
/**
* The person, organization or device that created the flag.
*
* @return
* An immutable object of type {@link Reference} that may be null.
*/
public Reference getAuthor() {
return author;
}
@Override
public boolean hasChildren() {
return super.hasChildren() ||
!identifier.isEmpty() ||
(status != null) ||
!category.isEmpty() ||
(code != null) ||
(subject != null) ||
(period != null) ||
(encounter != null) ||
(author != 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(status, "status", visitor);
accept(category, "category", visitor, CodeableConcept.class);
accept(code, "code", visitor);
accept(subject, "subject", visitor);
accept(period, "period", visitor);
accept(encounter, "encounter", visitor);
accept(author, "author", 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;
}
Flag other = (Flag) 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(status, other.status) &&
Objects.equals(category, other.category) &&
Objects.equals(code, other.code) &&
Objects.equals(subject, other.subject) &&
Objects.equals(period, other.period) &&
Objects.equals(encounter, other.encounter) &&
Objects.equals(author, other.author);
}
@Override
public int hashCode() {
int result = hashCode;
if (result == 0) {
result = Objects.hash(id,
meta,
implicitRules,
language,
text,
contained,
extension,
modifierExtension,
identifier,
status,
category,
code,
subject,
period,
encounter,
author);
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 FlagStatus status;
private List category = new ArrayList<>();
private CodeableConcept code;
private Reference subject;
private Period period;
private Reference encounter;
private Reference author;
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);
}
/**
* Business identifiers assigned to this flag by the performer or other systems which remain constant as the resource is
* updated and propagates from server to server.
*
* Adds new element(s) to the existing list
*
* @param identifier
* Business identifier
*
* @return
* A reference to this Builder instance
*/
public Builder identifier(Identifier... identifier) {
for (Identifier value : identifier) {
this.identifier.add(value);
}
return this;
}
/**
* Business identifiers assigned to this flag by the performer or other systems which remain constant as the resource is
* updated and propagates from server to server.
*
*
Replaces the existing list with a new one containing elements from the Collection
*
* @param identifier
* Business identifier
*
* @return
* A reference to this Builder instance
*/
public Builder identifier(Collection identifier) {
this.identifier = new ArrayList<>(identifier);
return this;
}
/**
* Supports basic workflow.
*
* This element is required.
*
* @param status
* active | inactive | entered-in-error
*
* @return
* A reference to this Builder instance
*/
public Builder status(FlagStatus status) {
this.status = status;
return this;
}
/**
* Allows a flag to be divided into different categories like clinical, administrative etc. Intended to be used as a
* means of filtering which flags are displayed to particular user or in a given context.
*
*
Adds new element(s) to the existing list
*
* @param category
* Clinical, administrative, etc.
*
* @return
* A reference to this Builder instance
*/
public Builder category(CodeableConcept... category) {
for (CodeableConcept value : category) {
this.category.add(value);
}
return this;
}
/**
* Allows a flag to be divided into different categories like clinical, administrative etc. Intended to be used as a
* means of filtering which flags are displayed to particular user or in a given context.
*
*
Replaces the existing list with a new one containing elements from the Collection
*
* @param category
* Clinical, administrative, etc.
*
* @return
* A reference to this Builder instance
*/
public Builder category(Collection category) {
this.category = new ArrayList<>(category);
return this;
}
/**
* The coded value or textual component of the flag to display to the user.
*
* This element is required.
*
* @param code
* Coded or textual message to display to user
*
* @return
* A reference to this Builder instance
*/
public Builder code(CodeableConcept code) {
this.code = code;
return this;
}
/**
* The patient, location, group, organization, or practitioner etc. this is about record this flag is associated with.
*
*
This element is required.
*
*
Allowed resource types for this reference:
*
* - {@link Patient}
* - {@link Location}
* - {@link Group}
* - {@link Organization}
* - {@link Practitioner}
* - {@link PlanDefinition}
* - {@link Medication}
* - {@link Procedure}
*
*
* @param subject
* Who/What is flag about?
*
* @return
* A reference to this Builder instance
*/
public Builder subject(Reference subject) {
this.subject = subject;
return this;
}
/**
* The period of time from the activation of the flag to inactivation of the flag. If the flag is active, the end of the
* period should be unspecified.
*
* @param period
* Time period when flag is active
*
* @return
* A reference to this Builder instance
*/
public Builder period(Period period) {
this.period = period;
return this;
}
/**
* This alert is only relevant during the encounter.
*
* Allowed resource types for this reference:
*
* - {@link Encounter}
*
*
* @param encounter
* Alert relevant during encounter
*
* @return
* A reference to this Builder instance
*/
public Builder encounter(Reference encounter) {
this.encounter = encounter;
return this;
}
/**
* The person, organization or device that created the flag.
*
* Allowed resource types for this reference:
*
* - {@link Device}
* - {@link Organization}
* - {@link Patient}
* - {@link Practitioner}
* - {@link PractitionerRole}
*
*
* @param author
* Flag creator
*
* @return
* A reference to this Builder instance
*/
public Builder author(Reference author) {
this.author = author;
return this;
}
/**
* Build the {@link Flag}
*
* Required elements:
*
* - status
* - code
* - subject
*
*
* @return
* An immutable object of type {@link Flag}
* @throws IllegalStateException
* if the current state cannot be built into a valid Flag per the base specification
*/
@Override
public Flag build() {
Flag flag = new Flag(this);
if (validating) {
validate(flag);
}
return flag;
}
protected void validate(Flag flag) {
super.validate(flag);
ValidationSupport.checkList(flag.identifier, "identifier", Identifier.class);
ValidationSupport.requireNonNull(flag.status, "status");
ValidationSupport.checkList(flag.category, "category", CodeableConcept.class);
ValidationSupport.requireNonNull(flag.code, "code");
ValidationSupport.requireNonNull(flag.subject, "subject");
ValidationSupport.checkReferenceType(flag.subject, "subject", "Patient", "Location", "Group", "Organization", "Practitioner", "PlanDefinition", "Medication", "Procedure");
ValidationSupport.checkReferenceType(flag.encounter, "encounter", "Encounter");
ValidationSupport.checkReferenceType(flag.author, "author", "Device", "Organization", "Patient", "Practitioner", "PractitionerRole");
}
protected Builder from(Flag flag) {
super.from(flag);
identifier.addAll(flag.identifier);
status = flag.status;
category.addAll(flag.category);
code = flag.code;
subject = flag.subject;
period = flag.period;
encounter = flag.encounter;
author = flag.author;
return this;
}
}
}