Class AllergyIntolerance

  • All Implemented Interfaces:
    ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IResource, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseResource

    public class AllergyIntolerance
    extends BaseResource
    implements ca.uhn.fhir.model.api.IResource
    HAPI/FHIR AllergyIntolerance Resource ()

    Definition: Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.

    Requirements: To record a clinical assessment of a propensity, or potential risk to an individual, of an adverse reaction upon future exposure to the specified substance, or class of substance.

    Profile Definition: http://hl7.org/fhir/profiles/AllergyIntolerance

    See Also:
    Serialized Form
    • Field Detail

      • SP_SUBSTANCE

        public static final String SP_SUBSTANCE
        Search parameter constant for substance

        Description:
        Type: token
        Path: AllergyIntolerance.substance | AllergyIntolerance.reaction.substance

        See Also:
        Constant Field Values
      • SUBSTANCE

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam SUBSTANCE
        Fluent Client search parameter constant for substance

        Description:
        Type: token
        Path: AllergyIntolerance.substance | AllergyIntolerance.reaction.substance

      • STATUS

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
        Fluent Client search parameter constant for status

        Description:
        Type: token
        Path: AllergyIntolerance.status

      • CRITICALITY

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam CRITICALITY
        Fluent Client search parameter constant for criticality

        Description:
        Type: token
        Path: AllergyIntolerance.criticality

      • TYPE

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam TYPE
        Fluent Client search parameter constant for type

        Description:
        Type: token
        Path: AllergyIntolerance.type

      • CATEGORY

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam CATEGORY
        Fluent Client search parameter constant for category

        Description:
        Type: token
        Path: AllergyIntolerance.category

      • LAST_DATE

        public static final ca.uhn.fhir.rest.gclient.DateClientParam LAST_DATE
        Fluent Client search parameter constant for last-date

        Description:
        Type: date
        Path: AllergyIntolerance.lastOccurence

      • MANIFESTATION

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam MANIFESTATION
        Fluent Client search parameter constant for manifestation

        Description:
        Type: token
        Path: AllergyIntolerance.reaction.manifestation

      • SP_ONSET

        public static final String SP_ONSET
        Search parameter constant for onset

        Description:
        Type: date
        Path: AllergyIntolerance.reaction.onset

        See Also:
        Constant Field Values
      • ONSET

        public static final ca.uhn.fhir.rest.gclient.DateClientParam ONSET
        Fluent Client search parameter constant for onset

        Description:
        Type: date
        Path: AllergyIntolerance.reaction.onset

      • SP_SEVERITY

        public static final String SP_SEVERITY
        Search parameter constant for severity

        Description:
        Type: token
        Path: AllergyIntolerance.reaction.severity

        See Also:
        Constant Field Values
      • SEVERITY

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam SEVERITY
        Fluent Client search parameter constant for severity

        Description:
        Type: token
        Path: AllergyIntolerance.reaction.severity

      • SP_ROUTE

        public static final String SP_ROUTE
        Search parameter constant for route

        Description:
        Type: token
        Path: AllergyIntolerance.reaction.exposureRoute

        See Also:
        Constant Field Values
      • ROUTE

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam ROUTE
        Fluent Client search parameter constant for route

        Description:
        Type: token
        Path: AllergyIntolerance.reaction.exposureRoute

      • IDENTIFIER

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
        Fluent Client search parameter constant for identifier

        Description:
        Type: token
        Path: AllergyIntolerance.identifier

      • SP_DATE

        public static final String SP_DATE
        Search parameter constant for date

        Description:
        Type: date
        Path: AllergyIntolerance.recordedDate

        See Also:
        Constant Field Values
      • DATE

        public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE
        Fluent Client search parameter constant for date

        Description:
        Type: date
        Path: AllergyIntolerance.recordedDate

      • RECORDER

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam RECORDER
        Fluent Client search parameter constant for recorder

        Description:
        Type: reference
        Path: AllergyIntolerance.recorder

      • PATIENT

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
        Fluent Client search parameter constant for patient

        Description:
        Type: reference
        Path: AllergyIntolerance.patient

      • REPORTER

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam REPORTER
        Fluent Client search parameter constant for reporter

        Description:
        Type: reference
        Path: AllergyIntolerance.reporter

      • INCLUDE_PATIENT

        public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT
        Constant for fluent queries to be used to add include statements. Specifies the path value of "AllergyIntolerance:patient".
      • INCLUDE_RECORDER

        public static final ca.uhn.fhir.model.api.Include INCLUDE_RECORDER
        Constant for fluent queries to be used to add include statements. Specifies the path value of "AllergyIntolerance:recorder".
      • INCLUDE_REPORTER

        public static final ca.uhn.fhir.model.api.Include INCLUDE_REPORTER
        Constant for fluent queries to be used to add include statements. Specifies the path value of "AllergyIntolerance:reporter".
    • Method Detail

      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase
      • getAllPopulatedChildElementsOfType

        public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType​(Class<T> theType)
        Specified by:
        getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement
      • getIdentifier

        public List<IdentifierDtgetIdentifier()
        Gets the value(s) for identifier (). creating it if it does not exist. Will not return null.

        Definition: This records identifiers associated with this allergy/intolerance concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation)

      • setIdentifier

        public AllergyIntolerance setIdentifier​(List<IdentifierDt> theValue)
        Sets the value(s) for identifier ()

        Definition: This records identifiers associated with this allergy/intolerance concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation)

      • addIdentifier

        public IdentifierDt addIdentifier()
        Adds and returns a new value for identifier ()

        Definition: This records identifiers associated with this allergy/intolerance concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation)

      • addIdentifier

        public AllergyIntolerance addIdentifier​(IdentifierDt theValue)
        Adds a given new value for identifier ()

        Definition: This records identifiers associated with this allergy/intolerance concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation)

        Parameters:
        theValue - The identifier to add (must not be null)
      • getIdentifierFirstRep

        public IdentifierDt getIdentifierFirstRep()
        Gets the first repetition for identifier (), creating it if it does not already exist.

        Definition: This records identifiers associated with this allergy/intolerance concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation)

      • getOnsetElement

        public ca.uhn.fhir.model.primitive.DateTimeDt getOnsetElement()
        Gets the value(s) for onset (). creating it if it does not exist. Will not return null.

        Definition: Record of the date and/or time of the onset of the Allergy or Intolerance

      • getOnset

        public Date getOnset()
        Gets the value(s) for onset (). creating it if it does not exist. This method may return null.

        Definition: Record of the date and/or time of the onset of the Allergy or Intolerance

      • setOnset

        public AllergyIntolerance setOnset​(ca.uhn.fhir.model.primitive.DateTimeDt theValue)
        Sets the value(s) for onset ()

        Definition: Record of the date and/or time of the onset of the Allergy or Intolerance

      • setOnset

        public AllergyIntolerance setOnset​(Date theDate,
                                           ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
        Sets the value for onset ()

        Definition: Record of the date and/or time of the onset of the Allergy or Intolerance

      • getRecordedDateElement

        public ca.uhn.fhir.model.primitive.DateTimeDt getRecordedDateElement()
        Gets the value(s) for recordedDate (). creating it if it does not exist. Will not return null.

        Definition: Date when the sensitivity was recorded

      • getRecordedDate

        public Date getRecordedDate()
        Gets the value(s) for recordedDate (). creating it if it does not exist. This method may return null.

        Definition: Date when the sensitivity was recorded

      • setRecordedDate

        public AllergyIntolerance setRecordedDate​(ca.uhn.fhir.model.primitive.DateTimeDt theValue)
        Sets the value(s) for recordedDate ()

        Definition: Date when the sensitivity was recorded

      • setRecordedDate

        public AllergyIntolerance setRecordedDate​(Date theDate,
                                                  ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
        Sets the value for recordedDate ()

        Definition: Date when the sensitivity was recorded

      • getRecorder

        public ResourceReferenceDt getRecorder()
        Gets the value(s) for recorder (). creating it if it does not exist. Will not return null.

        Definition: Individual who recorded the record and takes responsibility for its conten

      • getPatient

        public ResourceReferenceDt getPatient()
        Gets the value(s) for patient (). creating it if it does not exist. Will not return null.

        Definition: The patient who has the allergy or intolerance

      • getReporter

        public ResourceReferenceDt getReporter()
        Gets the value(s) for reporter (). creating it if it does not exist. Will not return null.

        Definition: The source of the information about the allergy that is recorded

      • getSubstance

        public CodeableConceptDt getSubstance()
        Gets the value(s) for substance (). creating it if it does not exist. Will not return null.

        Definition: Identification of a substance, or a class of substances, that is considered to be responsible for the adverse reaction risk

      • setSubstance

        public AllergyIntolerance setSubstance​(CodeableConceptDt theValue)
        Sets the value(s) for substance ()

        Definition: Identification of a substance, or a class of substances, that is considered to be responsible for the adverse reaction risk

      • getStatusElement

        public ca.uhn.fhir.model.primitive.BoundCodeDt<AllergyIntoleranceStatusEnumgetStatusElement()
        Gets the value(s) for status (). creating it if it does not exist. Will not return null.

        Definition: Assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified Substance

      • getStatus

        public String getStatus()
        Gets the value(s) for status (). creating it if it does not exist. This method may return null.

        Definition: Assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified Substance

      • setStatus

        public AllergyIntolerance setStatus​(ca.uhn.fhir.model.primitive.BoundCodeDt<AllergyIntoleranceStatusEnum> theValue)
        Sets the value(s) for status ()

        Definition: Assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified Substance

      • getCriticalityElement

        public ca.uhn.fhir.model.primitive.BoundCodeDt<AllergyIntoleranceCriticalityEnumgetCriticalityElement()
        Gets the value(s) for criticality (). creating it if it does not exist. Will not return null.

        Definition: Estimate of the potential clinical harm, or seriousness, of the reaction to the identified Substance

      • getCriticality

        public String getCriticality()
        Gets the value(s) for criticality (). creating it if it does not exist. This method may return null.

        Definition: Estimate of the potential clinical harm, or seriousness, of the reaction to the identified Substance

      • getTypeElement

        public ca.uhn.fhir.model.primitive.BoundCodeDt<AllergyIntoleranceTypeEnumgetTypeElement()
        Gets the value(s) for type (). creating it if it does not exist. Will not return null.

        Definition: Identification of the underlying physiological mechanism for the reaction risk.

      • getType

        public String getType()
        Gets the value(s) for type (). creating it if it does not exist. This method may return null.

        Definition: Identification of the underlying physiological mechanism for the reaction risk.

      • getCategoryElement

        public ca.uhn.fhir.model.primitive.BoundCodeDt<AllergyIntoleranceCategoryEnumgetCategoryElement()
        Gets the value(s) for category (). creating it if it does not exist. Will not return null.

        Definition: Category of the identified Substance

      • getCategory

        public String getCategory()
        Gets the value(s) for category (). creating it if it does not exist. This method may return null.

        Definition: Category of the identified Substance

      • getLastOccurenceElement

        public ca.uhn.fhir.model.primitive.DateTimeDt getLastOccurenceElement()
        Gets the value(s) for lastOccurence (). creating it if it does not exist. Will not return null.

        Definition: Represents the date and/or time of the last known occurrence of a reaction event

      • getLastOccurence

        public Date getLastOccurence()
        Gets the value(s) for lastOccurence (). creating it if it does not exist. This method may return null.

        Definition: Represents the date and/or time of the last known occurrence of a reaction event

      • setLastOccurence

        public AllergyIntolerance setLastOccurence​(ca.uhn.fhir.model.primitive.DateTimeDt theValue)
        Sets the value(s) for lastOccurence ()

        Definition: Represents the date and/or time of the last known occurrence of a reaction event

      • setLastOccurence

        public AllergyIntolerance setLastOccurence​(Date theDate,
                                                   ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
        Sets the value for lastOccurence ()

        Definition: Represents the date and/or time of the last known occurrence of a reaction event

      • getNote

        public AnnotationDt getNote()
        Gets the value(s) for note (). creating it if it does not exist. Will not return null.

        Definition: Additional narrative about the propensity for the Adverse Reaction, not captured in other fields.

      • setNote

        public AllergyIntolerance setNote​(AnnotationDt theValue)
        Sets the value(s) for note ()

        Definition: Additional narrative about the propensity for the Adverse Reaction, not captured in other fields.

      • getReaction

        public List<AllergyIntolerance.ReactiongetReaction()
        Gets the value(s) for reaction (). creating it if it does not exist. Will not return null.

        Definition: Details about each adverse reaction event linked to exposure to the identified Substance

      • addReaction

        public AllergyIntolerance.Reaction addReaction()
        Adds and returns a new value for reaction ()

        Definition: Details about each adverse reaction event linked to exposure to the identified Substance

      • addReaction

        public AllergyIntolerance addReaction​(AllergyIntolerance.Reaction theValue)
        Adds a given new value for reaction ()

        Definition: Details about each adverse reaction event linked to exposure to the identified Substance

        Parameters:
        theValue - The reaction to add (must not be null)
      • getReactionFirstRep

        public AllergyIntolerance.Reaction getReactionFirstRep()
        Gets the first repetition for reaction (), creating it if it does not already exist.

        Definition: Details about each adverse reaction event linked to exposure to the identified Substance

      • getResourceName

        public String getResourceName()
        Specified by:
        getResourceName in interface ca.uhn.fhir.model.api.IResource
      • getStructureFhirVersionEnum

        public ca.uhn.fhir.context.FhirVersionEnum getStructureFhirVersionEnum()
        Specified by:
        getStructureFhirVersionEnum in interface org.hl7.fhir.instance.model.api.IBaseResource
        Specified by:
        getStructureFhirVersionEnum in interface ca.uhn.fhir.model.api.IResource