AllergyIntolerance
| Property | Value |
|---|---|
| Publisher | |
| Name | AllergyIntolerance |
| URL | http://hl7.org/fhir/StructureDefinition/AllergyIntolerance |
| Status | draft |
| Description | |
| Abstract | false |
Structure
| Path | Cardinality | Type | Description |
|---|---|---|---|
| AllergyIntolerance | 0..* | AllergyIntolerance | Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance. |
| AllergyIntolerance.id | 0..1 | http://hl7.org/fhirpath/System.String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
| AllergyIntolerance.meta | 0..1 | 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. |
| AllergyIntolerance.implicitRules | 0..1 | uri | 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. |
| AllergyIntolerance.language | 0..1 | code | The base language in which the resource is written. |
| AllergyIntolerance.text | 0..1 | 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. |
| AllergyIntolerance.contained | 0..* | Resource | 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. |
| AllergyIntolerance.extension | 0..* | 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. |
| AllergyIntolerance.modifierExtension | 0..* | 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). |
| AllergyIntolerance.identifier | 0..* | Identifier | 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. |
| AllergyIntolerance.clinicalStatus | 0..1 | CodeableConcept | The clinical status of the allergy or intolerance. |
| AllergyIntolerance.verificationStatus | 0..1 | CodeableConcept | Assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified substance (including pharmaceutical product). |
| AllergyIntolerance.type | 0..1 | code | Identification of the underlying physiological mechanism for the reaction risk. |
| AllergyIntolerance.category | 0..* | code | Category of the identified substance. |
| AllergyIntolerance.criticality | 0..1 | code | Estimate of the potential clinical harm, or seriousness, of the reaction to the identified substance. |
| AllergyIntolerance.code | 0..1 | CodeableConcept | 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. |
| AllergyIntolerance.patient | 1..1 | Reference | The patient who has the allergy or intolerance. |
| AllergyIntolerance.encounter | 0..1 | Reference | The encounter when the allergy or intolerance was asserted. |
| AllergyIntolerance.onset[x] | 0..1 | dateTime | Estimated or actual date, date-time, or age when allergy or intolerance was identified. |
| AllergyIntolerance.recordedDate | 0..1 | dateTime | The recordedDate represents when this particular AllergyIntolerance record was created in the system, which is often a system-generated date. |
| AllergyIntolerance.recorder | 0..1 | Reference | Individual who recorded the record and takes responsibility for its content. |
| AllergyIntolerance.asserter | 0..1 | Reference | The source of the information about the allergy that is recorded. |
| AllergyIntolerance.lastOccurrence | 0..1 | dateTime | Represents the date and/or time of the last known occurrence of a reaction event. |
| AllergyIntolerance.note | 0..* | Annotation | Additional narrative about the propensity for the Adverse Reaction, not captured in other fields. |
| AllergyIntolerance.reaction | 0..* | BackboneElement | Details about each adverse reaction event linked to exposure to the identified substance. |
| AllergyIntolerance.reaction.id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| AllergyIntolerance.reaction.extension | 0..* | 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. |
| AllergyIntolerance.reaction.modifierExtension | 0..* | Extension | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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). |
| AllergyIntolerance.reaction.substance | 0..1 | CodeableConcept | Identification of the specific substance (or pharmaceutical product) considered to be responsible for the Adverse Reaction event. 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. |
| AllergyIntolerance.reaction.manifestation | 1..* | CodeableConcept | Clinical symptoms and/or signs that are observed or associated with the adverse reaction event. |
| AllergyIntolerance.reaction.description | 0..1 | string | Text description about the reaction as a whole, including details of the manifestation if required. |
| AllergyIntolerance.reaction.onset | 0..1 | dateTime | Record of the date and/or time of the onset of the Reaction. |
| AllergyIntolerance.reaction.severity | 0..1 | code | Clinical assessment of the severity of the reaction event as a whole, potentially considering multiple different manifestations. |
| AllergyIntolerance.reaction.exposureRoute | 0..1 | CodeableConcept | Identification of the route by which the subject was exposed to the substance. |
| AllergyIntolerance.reaction.note | 0..* | Annotation | Additional text about the adverse reaction event not captured in other fields. |
Search Parameters
| Name | Type | Description | Expression |
|---|---|---|---|
| _text | string | Search on the narrative of the resource | |
| _content | string | Search on the entire content of the resource | |
| _filter | token | Filter search parameter which supports a more sophisticated grammar for searching. See documentation for further details | |
| _has | string | Provides limited support for reverse chaining - that is, selecting resources based on the properties of resources that refer to them (instead of chaining where resources can be selected based on the properties of resources that they refer to). See the FHIR search page for further documentation | |
| _id | token | Logical id of this artifact | Resource.id |
| _lastUpdated | date | When the resource version last changed | Resource.meta.lastUpdated |
| _list | string | All resources in nominated list (by id, Type/id, url or one of the magic List types) | |
| _profile | uri | Profiles this resource claims to conform to | Resource.meta.profile |
| _query | token | A custom search profile that describes a specific defined query operation | |
| _security | token | Security Labels applied to this resource | Resource.meta.security |
| _source | uri | Identifies where the resource comes from | Resource.meta.source |
| _tag | token | Tags applied to this resource | Resource.meta.tag |
| _text | string | Search on the narrative text (html) of the resource | |
| _type | token | Used when a search is performed in a context which doesn't limit the search to indicate which types are being searched. See the FHIR search page for further discussion | |
| asserter | reference | Source of the information about the allergy | AllergyIntolerance.asserter |
| category | token | food / medication / environment / biologic | AllergyIntolerance.category |
| clinical-status | token | active / inactive / resolved | AllergyIntolerance.clinicalStatus |
| code | token | Multiple Resources: * AllergyIntolerance: Code that identifies the allergy or intolerance* Condition: Code for the condition* DeviceRequest: Code for what is being requested/ordered* DiagnosticReport: The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result* FamilyMemberHistory: A search by a condition code* List: What the purpose of this list is* Medication: Returns medications for a specific code* MedicationAdministration: Return administrations of this medication code* MedicationDispense: Returns dispenses of this medicine code* MedicationRequest: Return prescriptions of this medication code* MedicationStatement: Return statements of this medication code* Observation: The code of the observation type* Procedure: A code to identify a procedure* ServiceRequest: What is being requested/ordered | AllergyIntolerance.code / AllergyIntolerance.reaction.substance / Condition.code / (DeviceRequest.code.ofType(CodeableConcept)) / DiagnosticReport.code / FamilyMemberHistory.condition.code / List.code / Medication.code / (MedicationAdministration.medication.ofType(CodeableConcept)) / (MedicationDispense.medication.ofType(CodeableConcept)) / (MedicationRequest.medication.ofType(CodeableConcept)) / (MedicationStatement.medication.ofType(CodeableConcept)) / Observation.code / Procedure.code / ServiceRequest.code |
| criticality | token | low / high / unable-to-assess | AllergyIntolerance.criticality |
| date | date | Multiple Resources: * AllergyIntolerance: Date first version of the resource instance was recorded* CarePlan: Time period plan covers* CareTeam: Time period team covers* ClinicalImpression: When the assessment was documented* Composition: Composition editing time* Consent: When this Consent was created or indexed* DiagnosticReport: The clinically relevant time of the report* Encounter: A date within the period the Encounter lasted* EpisodeOfCare: The provided date search value falls within the episode of care's period* FamilyMemberHistory: When history was recorded or last updated* Flag: Time period when flag is active* Immunization: Vaccination (non)-Administration Date* List: When the list was prepared* Observation: Obtained date/time. If the obtained element is a period, a date that falls in the period* Procedure: When the procedure was performed* RiskAssessment: When was assessment made?* SupplyRequest: When the request was made | AllergyIntolerance.recordedDate / CarePlan.period / CareTeam.period / ClinicalImpression.date / Composition.date / Consent.dateTime / DiagnosticReport.effective / Encounter.period / EpisodeOfCare.period / FamilyMemberHistory.date / Flag.period / (Immunization.occurrence.ofType(dateTime)) / List.date / Observation.effective / Procedure.performed / (RiskAssessment.occurrence.ofType(dateTime)) / SupplyRequest.authoredOn |
| identifier | token | Multiple Resources: * AllergyIntolerance: External ids for this item* CarePlan: External Ids for this plan* CareTeam: External Ids for this team* Composition: Version-independent identifier for the Composition* Condition: A unique identifier of the condition record* Consent: Identifier for this record (external references)* DetectedIssue: Unique id for the detected issue* DeviceRequest: Business identifier for request/order* DiagnosticReport: An identifier for the report* DocumentManifest: Unique Identifier for the set of documents* DocumentReference: Master Version Specific Identifier* Encounter: Identifier(s) by which this encounter is known* EpisodeOfCare: Business Identifier(s) relevant for this EpisodeOfCare* FamilyMemberHistory: A search by a record identifier* Goal: External Ids for this goal* ImagingStudy: Identifiers for the Study, such as DICOM Study Instance UID and Accession number* Immunization: Business identifier* List: Business identifier* MedicationAdministration: Return administrations with this external identifier* MedicationDispense: Returns dispenses with this external identifier* MedicationRequest: Return prescriptions with this external identifier* MedicationStatement: Return statements with this external identifier* NutritionOrder: Return nutrition orders with this external identifier* Observation: The unique id for a particular observation* Procedure: A unique identifier for a procedure* RiskAssessment: Unique identifier for the assessment* ServiceRequest: Identifiers assigned to this order* SupplyDelivery: External identifier* SupplyRequest: Business Identifier for SupplyRequest* VisionPrescription: Return prescriptions with this external identifier | AllergyIntolerance.identifier / CarePlan.identifier / CareTeam.identifier / Composition.identifier / Condition.identifier / Consent.identifier / DetectedIssue.identifier / DeviceRequest.identifier / DiagnosticReport.identifier / DocumentManifest.masterIdentifier / DocumentManifest.identifier / DocumentReference.masterIdentifier / DocumentReference.identifier / Encounter.identifier / EpisodeOfCare.identifier / FamilyMemberHistory.identifier / Goal.identifier / ImagingStudy.identifier / Immunization.identifier / List.identifier / MedicationAdministration.identifier / MedicationDispense.identifier / MedicationRequest.identifier / MedicationStatement.identifier / NutritionOrder.identifier / Observation.identifier / Procedure.identifier / RiskAssessment.identifier / ServiceRequest.identifier / SupplyDelivery.identifier / SupplyRequest.identifier / VisionPrescription.identifier |
| last-date | date | Date(/time) of last known occurrence of a reaction | AllergyIntolerance.lastOccurrence |
| manifestation | token | Clinical symptoms/signs associated with the Event | AllergyIntolerance.reaction.manifestation |
| onset | date | Date(/time) when manifestations showed | AllergyIntolerance.reaction.onset |
| patient | reference | Multiple Resources: * AllergyIntolerance: Who the sensitivity is for* CarePlan: Who the care plan is for* CareTeam: Who care team is for* ClinicalImpression: Patient or group assessed* Composition: Who and/or what the composition is about* Condition: Who has the condition?* Consent: Who the consent applies to* DetectedIssue: Associated patient* DeviceRequest: Individual the service is ordered for* DeviceUseStatement: Search by subject - a patient* DiagnosticReport: The subject of the report if a patient* DocumentManifest: The subject of the set of documents* DocumentReference: Who/what is the subject of the document* Encounter: The patient or group present at the encounter* EpisodeOfCare: The patient who is the focus of this episode of care* FamilyMemberHistory: The identity of a subject to list family member history items for* Flag: The identity of a subject to list flags for* Goal: Who this goal is intended for* ImagingStudy: Who the study is about* Immunization: The patient for the vaccination record* List: If all resources have the same subject* MedicationAdministration: The identity of a patient to list administrations for* MedicationDispense: The identity of a patient to list dispenses for* MedicationRequest: Returns prescriptions for a specific patient* MedicationStatement: Returns statements for a specific patient.* NutritionOrder: The identity of the person who requires the diet, formula or nutritional supplement* Observation: The subject that the observation is about (if patient)* Procedure: Search by subject - a patient* RiskAssessment: Who/what does assessment apply to?* ServiceRequest: Search by subject - a patient* SupplyDelivery: Patient for whom the item is supplied* VisionPrescription: The identity of a patient to list dispenses for | AllergyIntolerance.patient / CarePlan.subject.where(resolve() is Patient) / CareTeam.subject.where(resolve() is Patient) / ClinicalImpression.subject.where(resolve() is Patient) / Composition.subject.where(resolve() is Patient) / Condition.subject.where(resolve() is Patient) / Consent.patient / DetectedIssue.patient / DeviceRequest.subject.where(resolve() is Patient) / DeviceUseStatement.subject.where(resolve() is Patient) / DiagnosticReport.subject.where(resolve() is Patient) / DocumentManifest.subject.where(resolve() is Patient) / DocumentReference.subject.where(resolve() is Patient) / Encounter.subject.where(resolve() is Patient) / EpisodeOfCare.patient / FamilyMemberHistory.patient / Flag.subject.where(resolve() is Patient) / Goal.subject.where(resolve() is Patient) / ImagingStudy.subject.where(resolve() is Patient) / Immunization.patient / List.subject.where(resolve() is Patient) / MedicationAdministration.subject.where(resolve() is Patient) / MedicationDispense.subject.where(resolve() is Patient) / MedicationRequest.subject.where(resolve() is Patient) / MedicationStatement.subject.where(resolve() is Patient) / NutritionOrder.patient / Observation.subject.where(resolve() is Patient) / Procedure.subject.where(resolve() is Patient) / RiskAssessment.subject.where(resolve() is Patient) / ServiceRequest.subject.where(resolve() is Patient) / SupplyDelivery.patient / VisionPrescription.patient |
| recorder | reference | Who recorded the sensitivity | AllergyIntolerance.recorder |
| route | token | How the subject was exposed to the substance | AllergyIntolerance.reaction.exposureRoute |
| severity | token | mild / moderate / severe (of event as a whole) | AllergyIntolerance.reaction.severity |
| type | token | Multiple Resources: * AllergyIntolerance: allergy / intolerance - Underlying mechanism (if known)* Composition: Kind of composition (LOINC if possible)* DocumentManifest: Kind of document set* DocumentReference: Kind of document (LOINC if possible)* Encounter: Specific type of encounter* EpisodeOfCare: Type/class - e.g. specialist referral, disease management | AllergyIntolerance.type / Composition.type / DocumentManifest.type / DocumentReference.type / Encounter.type / EpisodeOfCare.type |
| verification-status | token | unconfirmed / confirmed / refuted / entered-in-error | AllergyIntolerance.verificationStatus |