Skip to main content

HS.FHIRModel.R4.AllergyIntolerance

class HS.FHIRModel.R4.AllergyIntolerance extends HS.FHIRModel.FHIRClassSuper

*****************************************
** AllergyIntolerance generated class schema
*****************************************
Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.

Property Inventory

Method Inventory

Parameters

parameter XMLTYPE = R4_ALLERGYINTOLERANCE;
Inherited description: This parameter provides the default XMLTYPE for the class. If it is empty then the class name will be used to construct a default XML type.

The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.

Properties

property _category as HS.FHIRModel.R4.SeqOfElement;
Extensions for category
Property methods: _categoryGet(), _categoryGetSwizzled(), _categoryIsValid(), _categoryNewObject(), _categorySet()
property _criticality as HS.FHIRModel.R4.Element;
Extensions for criticality
Property methods: _criticalityGet(), _criticalityGetSwizzled(), _criticalityIsValid(), _criticalityNewObject(), _criticalitySet()
property _implicitRules as HS.FHIRModel.R4.Element;
Extensions for implicitRules
Property methods: _implicitRulesGet(), _implicitRulesGetSwizzled(), _implicitRulesIsValid(), _implicitRulesNewObject(), _implicitRulesSet()
property _language as HS.FHIRModel.R4.Element;
Extensions for language
Property methods: _languageGet(), _languageGetSwizzled(), _languageIsValid(), _languageNewObject(), _languageSet()
property _lastOccurrence as HS.FHIRModel.R4.Element;
Extensions for lastOccurrence
Property methods: _lastOccurrenceGet(), _lastOccurrenceGetSwizzled(), _lastOccurrenceIsValid(), _lastOccurrenceNewObject(), _lastOccurrenceSet()
property _onsetDateTime as HS.FHIRModel.R4.Element;
Extensions for onsetDateTime
Property methods: _onsetDateTimeGet(), _onsetDateTimeGetSwizzled(), _onsetDateTimeIsValid(), _onsetDateTimeNewObject(), _onsetDateTimeSet()
property _onsetString as HS.FHIRModel.R4.Element;
Extensions for onsetString
Property methods: _onsetStringGet(), _onsetStringGetSwizzled(), _onsetStringIsValid(), _onsetStringNewObject(), _onsetStringSet()
property _recordedDate as HS.FHIRModel.R4.Element;
Extensions for recordedDate
Property methods: _recordedDateGet(), _recordedDateGetSwizzled(), _recordedDateIsValid(), _recordedDateNewObject(), _recordedDateSet()
property _type as HS.FHIRModel.R4.Element;
Extensions for type
Property methods: _typeGet(), _typeGetSwizzled(), _typeIsValid(), _typeNewObject(), _typeSet()
property asserter as HS.FHIRModel.R4.Reference;
The source of the information about the allergy that is recorded.
Property methods: asserterGet(), asserterGetSwizzled(), asserterIsValid(), asserterNewObject(), asserterSet()
property category as %String (VALUELIST = ",food,medication,environment,biologic");
Category of the identified substance.
Property methods: categoryDisplayToLogical(), categoryGet(), categoryIsValid(), categoryLogicalToDisplay(), categoryLogicalToOdbc(), categoryNormalize(), categorySet()
property clinicalStatus as HS.FHIRModel.R4.CodeableConcept;
The clinical status of the allergy or intolerance.
Property methods: clinicalStatusGet(), clinicalStatusGetSwizzled(), clinicalStatusIsValid(), clinicalStatusNewObject(), clinicalStatusSet()
Code for an allergy or intolerance statement (either a positive or a negated/excluded statement). This may be a code for a substance or pharmaceutical product that is considered to be responsible for the adverse reaction risk (e.g., "Latex"), an allergy or intolerance condition (e.g., "Latex allergy"), or a negated/excluded code for a specific substance or class (e.g., "No latex allergy") or a general or categorical negated statement (e.g., "No known allergy", "No known drug allergies"). Note: the substance for a specific reaction may be different from the substance identified as the cause of the risk, but it must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite product that includes the identified substance. It must be clinically safe to only process the 'code' and ignore the 'reaction.substance'. If a receiving system is unable to confirm that AllergyIntolerance.reaction.substance falls within the semantic scope of AllergyIntolerance.code, then the receiving system should ignore AllergyIntolerance.reaction.substance.
Property methods: codeGet(), codeGetSwizzled(), codeIsValid(), codeNewObject(), codeSet()
property contained as HS.FHIRModel.R4.SeqOfResourceList;
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.
Property methods: containedGet(), containedGetSwizzled(), containedIsValid(), containedNewObject(), containedSet()
property criticality as %String (VALUELIST = ",low,high,unable-to-assess");
Estimate of the potential clinical harm, or seriousness, of the reaction to the identified substance.
Property methods: criticalityDisplayToLogical(), criticalityGet(), criticalityIsValid(), criticalityLogicalToDisplay(), criticalityLogicalToOdbc(), criticalityNormalize(), criticalitySet()
property encounter as HS.FHIRModel.R4.Reference;
The encounter when the allergy or intolerance was asserted.
Property methods: encounterGet(), encounterGetSwizzled(), encounterIsValid(), encounterNewObject(), encounterSet()
property extension as HS.FHIRModel.R4.SeqOfExtension;
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.
Property methods: extensionGet(), extensionGetSwizzled(), extensionIsValid(), extensionNewObject(), extensionSet()
property fhirID as %String;
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Property methods: fhirIDDisplayToLogical(), fhirIDGet(), fhirIDIsValid(), fhirIDLogicalToDisplay(), fhirIDLogicalToOdbc(), fhirIDNormalize(), fhirIDSet()
property identifier as HS.FHIRModel.R4.SeqOfIdentifier;
Business identifiers assigned to this AllergyIntolerance by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
Property methods: identifierGet(), identifierGetSwizzled(), identifierIsValid(), identifierNewObject(), identifierSet()
property implicitRules as %String;
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.
Property methods: implicitRulesDisplayToLogical(), implicitRulesGet(), implicitRulesIsValid(), implicitRulesLogicalToDisplay(), implicitRulesLogicalToOdbc(), implicitRulesNormalize(), implicitRulesSet()
property language as %String;
The base language in which the resource is written.
Property methods: languageDisplayToLogical(), languageGet(), languageIsValid(), languageLogicalToDisplay(), languageLogicalToOdbc(), languageNormalize(), languageSet()
property lastOccurrence as %String;
Represents the date and/or time of the last known occurrence of a reaction event.
Property methods: lastOccurrenceDisplayToLogical(), lastOccurrenceGet(), lastOccurrenceIsValid(), lastOccurrenceLogicalToDisplay(), lastOccurrenceLogicalToOdbc(), lastOccurrenceNormalize(), lastOccurrenceSet()
property meta as HS.FHIRModel.R4.Meta;
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.
Property methods: metaGet(), metaGetSwizzled(), metaIsValid(), metaNewObject(), metaSet()
property modifierExtension as HS.FHIRModel.R4.SeqOfExtension;
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).
Property methods: modifierExtensionGet(), modifierExtensionGetSwizzled(), modifierExtensionIsValid(), modifierExtensionNewObject(), modifierExtensionSet()
Additional narrative about the propensity for the Adverse Reaction, not captured in other fields.
Property methods: noteGet(), noteGetSwizzled(), noteIsValid(), noteNewObject(), noteSet()
property onsetAge as HS.FHIRModel.R4.Age;
Estimated or actual date, date-time, or age when allergy or intolerance was identified.
Property methods: onsetAgeGet(), onsetAgeGetSwizzled(), onsetAgeIsValid(), onsetAgeNewObject(), onsetAgeSet()
property onsetDateTime as %String;
Estimated or actual date, date-time, or age when allergy or intolerance was identified.
Property methods: onsetDateTimeDisplayToLogical(), onsetDateTimeGet(), onsetDateTimeIsValid(), onsetDateTimeLogicalToDisplay(), onsetDateTimeLogicalToOdbc(), onsetDateTimeNormalize(), onsetDateTimeSet()
property onsetPeriod as HS.FHIRModel.R4.Period;
Estimated or actual date, date-time, or age when allergy or intolerance was identified.
Property methods: onsetPeriodGet(), onsetPeriodGetSwizzled(), onsetPeriodIsValid(), onsetPeriodNewObject(), onsetPeriodSet()
property onsetRange as HS.FHIRModel.R4.Range;
Estimated or actual date, date-time, or age when allergy or intolerance was identified.
Property methods: onsetRangeGet(), onsetRangeGetSwizzled(), onsetRangeIsValid(), onsetRangeNewObject(), onsetRangeSet()
property onsetString as %String;
Estimated or actual date, date-time, or age when allergy or intolerance was identified.
Property methods: onsetStringDisplayToLogical(), onsetStringGet(), onsetStringIsValid(), onsetStringLogicalToDisplay(), onsetStringLogicalToOdbc(), onsetStringNormalize(), onsetStringSet()
property patient as HS.FHIRModel.R4.Reference [ Required ];
The patient who has the allergy or intolerance.
Property methods: patientGet(), patientGetSwizzled(), patientIsValid(), patientNewObject(), patientSet()
Details about each adverse reaction event linked to exposure to the identified substance.
Property methods: reactionGet(), reactionGetSwizzled(), reactionIsValid(), reactionNewObject(), reactionSet()
property recordedDate as %String;
The recordedDate represents when this particular AllergyIntolerance record was created in the system, which is often a system-generated date.
Property methods: recordedDateDisplayToLogical(), recordedDateGet(), recordedDateIsValid(), recordedDateLogicalToDisplay(), recordedDateLogicalToOdbc(), recordedDateNormalize(), recordedDateSet()
property recorder as HS.FHIRModel.R4.Reference;
Individual who recorded the record and takes responsibility for its content.
Property methods: recorderGet(), recorderGetSwizzled(), recorderIsValid(), recorderNewObject(), recorderSet()
property resourceType as %String [ InitialExpression = "AllergyIntolerance" , Required ];
This is a AllergyIntolerance resource
Property methods: resourceTypeDisplayToLogical(), resourceTypeGet(), resourceTypeIsValid(), resourceTypeLogicalToDisplay(), resourceTypeLogicalToOdbc(), resourceTypeNormalize(), resourceTypeSet()
property text as HS.FHIRModel.R4.Narrative;
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.
Property methods: textGet(), textGetSwizzled(), textIsValid(), textNewObject(), textSet()
property type as %String (VALUELIST = ",allergy,intolerance");
Identification of the underlying physiological mechanism for the reaction risk.
Property methods: typeDisplayToLogical(), typeGet(), typeIsValid(), typeLogicalToDisplay(), typeLogicalToOdbc(), typeNormalize(), typeSet()
property verificationStatus as HS.FHIRModel.R4.CodeableConcept;
Assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified substance (including pharmaceutical product).
Property methods: verificationStatusGet(), verificationStatusGetSwizzled(), verificationStatusIsValid(), verificationStatusNewObject(), verificationStatusSet()

Methods

method IncludeAsserter()
method IncludeClinicalStatus()
method IncludeCode()
method IncludeContained()
method IncludeEncounter()
method IncludeExtension()
method IncludeIdentifier()
method IncludeMeta()
method IncludeModifierExtension()
method IncludeNote()
method IncludeOnsetAge()
method IncludeOnsetPeriod()
method IncludeOnsetRange()
method IncludePatient()
method IncludeReaction()
method IncludeRecorder()
method IncludeText()
method IncludeVerificationStatus()
method _getProperties() as %DynamicArray
Inherited description: Return an array of the defined properties of this class in the definition order that they were discovered in the the HL7FHIR JSchema document
method toDao() as %DynamicAbstractObject
Inherited description: >

The toDao() method casts the set to a DAO.

Inherited Members

Inherited Methods

FeedbackOpens in a new tab