ZD AllergyIntolerance
Resources conforming to this profile are requested by ZorgDomein when populating the referral letter or request form with data from the source information system.
Queries on the https://[FHIRServerUrl]/AllergyIntolerance
endpoint may include the following query parameters:
patient=[PatientID]
:[PatientID]
refers to the patient ID as provided in the Task resource that is requested by ZorgDomein during SSO.category=[food|medication|environment|biologic]
: indicates that the result must only contain AlleryIntolerance resources that have the indicated value(s) forAllergyIntolerance.category
.
The canonical URL for this profile is:
http://zorgdomein.nl/fhir/StructureDefinition/zd-allergyintolerance
This profile builds on AllergyIntolerance.
AllergyIntolerance | S | 0..* | AllergyIntolerance |
There are no (further) constraints on this element Element Id
AllergyIntolerance Allergy or Intolerance (generally: Risk of adverse reaction to a substance) Alternate namesAllergy, Intolerance, Adverse Reaction DefinitionRisk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance. Substances include, but are not limited to: a therapeutic substance administered correctly at an appropriate dosage for the individual; food; material derived from plants or animals; or venom from insect stings.
|
identifier | Σ | 0..* | Identifier |
There are no (further) constraints on this element Element Id
AllergyIntolerance.identifier External ids for this item DefinitionThis 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).
|
clinicalStatus | Σ ?! | 0..1 | codeBinding |
There are no (further) constraints on this element Element Id
AllergyIntolerance.clinicalStatus active | inactive | resolved DefinitionThe clinical status of the allergy or intolerance. This element is labeled as a modifier because the status contains the codes inactive and resolved that mark the AllergyIntolerance as not currently valid. AllergyIntoleranceClinicalStatus (required) Constraints
|
verificationStatus | S Σ ?! | 1..1 | codeBinding |
There are no (further) constraints on this element Element Id
AllergyIntolerance.verificationStatus unconfirmed | confirmed | refuted | entered-in-error DefinitionAssertion about certainty associated with the propensity, or potential risk, of a reaction to the identified substance (including pharmaceutical product). This element is labeled as a modifier because the status contains the codes refuted and entered-in-error that mark the AllergyIntolerance as not currently valid. AllergyIntoleranceVerificationStatus (required) Constraints
|
type | Σ | 0..1 | codeBinding |
There are no (further) constraints on this element Element Id
AllergyIntolerance.type allergy | intolerance - Underlying mechanism (if known) Alternate namesCategory, Class DefinitionIdentification of the underlying physiological mechanism for the reaction risk. Allergic (typically immune-mediated) reactions have been traditionally regarded as an indicator for potential escalation to significant future risk. Contemporary knowledge suggests that some reactions previously thought to be immune-mediated are, in fact, non-immune, but in some cases can still pose a life threatening risk. It is acknowledged that many clinicians may not be in a position to distinguish the mechanism of a particular reaction. Often the term "allergy" is used rather generically and may overlap with the use of "intolerance" - in practice the boundaries between these two concepts may not be well-defined or understood. This data element is included nevertheless, because many legacy systems have captured this attribute. Immunologic testing may provide supporting evidence for the basis of the reaction and the causative substance, but no tests are 100% sensitive or specific for sensitivity to a particular substance. If, as is commonly the case, it is unclear whether the reaction is due to an allergy or an intolerance, then the type element should be omitted from the resource. AllergyIntoleranceType (required) Constraints
|
category | S Σ | 0..* | codeBinding |
There are no (further) constraints on this element Element Id
AllergyIntolerance.category food | medication | environment | biologic Alternate namesCategory, Type, Reaction Type, Class DefinitionCategory of the identified substance. This data element has been included because it is currently being captured in some clinical systems. This data can be derived from the substance where coding systems are used, and is effectively redundant in that situation. When searching on category, consider the implications of AllergyIntolerance resources without a category. For example, when searching on category = medication, medication allergies that don't have a category valued will not be returned. Refer to search for more information on how to search category with a :missing modifier to get allergies that don't have a category. Additionally, category should be used with caution because category can be subjective based on the sender. AllergyIntoleranceCategory (required) Constraints
|
criticality | Σ | 0..1 | codeBinding |
There are no (further) constraints on this element Element Id
AllergyIntolerance.criticality low | high | unable-to-assess Alternate namesSeverity, Seriousness, Contra-indication, Risk DefinitionEstimate of the potential clinical harm, or seriousness, of the reaction to the identified substance. The default criticality value for any propensity to an adverse reaction should be 'Low Risk', indicating at the very least a relative contraindication to deliberate or voluntary exposure to the substance. 'High Risk' is flagged if the clinician has identified a propensity for a more serious or potentially life-threatening reaction, such as anaphylaxis, and implies an absolute contraindication to deliberate or voluntary exposure to the substance. If this element is missing, the criticality is unknown (though it may be known elsewhere). Systems that capture a severity at the condition level are actually representing the concept of criticality whereas the severity documented at the reaction level is representing the true reaction severity. Existing systems that are capturing both condition criticality and reaction severity may use the term "severity" to represent both. Criticality is the worst it could be in the future (i.e. situation-agnostic) whereas severity is situation-dependent. AllergyIntoleranceCriticality (required) Constraints
|
code | S Σ | 1..1 | CodeableConcept |
There are no (further) constraints on this element Element Id
AllergyIntolerance.code Code that identifies the allergy or intolerance Alternate namesCode DefinitionCode 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"). It is strongly recommended that this element be populated using a terminology, where possible. For example, some terminologies used include RxNorm, SNOMED CT, DM+D, NDFRT, ICD-9, IDC-10, UNI, ATC and CPT. Plain text should only be used if there is no appropriate terminology available. Additional details can be specified in the text. When a substance or product code is specified for the 'code' element, the "default" semantic context is that this is a positive statement of an allergy or intolerance (depending on the value of the 'type' element, if present) condition to the specified substance/product. In the corresponding SNOMED CT allergy model, the specified substance/product is the target (destination) of the "Causative agent" relationship. The 'substanceExposureRisk' extension is available as a structured and more flexible alternative to the 'code' element for making positive or negative allergy or intolerance statements. This extension provides the capability to make "no known allergy" (or "no risk of adverse reaction") statements regarding any coded substance/product (including cases when a pre-coordinated "no allergy to x" concept for that substance/product does not exist). If the 'substanceExposureRisk' extension is present, the AllergyIntolerance.code element SHALL be omitted. AllergyIntolerance Substance/Product, Condition and Negation Codes (example) Constraints
|
coding | Σ | 0..* | Coding |
There are no (further) constraints on this element Element Id
AllergyIntolerance.code.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
text | Σ | 1..1 | string | Element Id
AllergyIntolerance.code.text Plain text representation of the allergy or intolerance DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
patient | S Σ | 1..1 | Reference(Patient) |
There are no (further) constraints on this element Element Id
AllergyIntolerance.patient Who the sensitivity is for Alternate namesPatient DefinitionThe patient who has the allergy or intolerance. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
onset[x] | S | 0..1 | Element Id
AllergyIntolerance.onset[x] When allergy or intolerance was identified DefinitionEstimated or actual date when allergy or intolerance was identified.
|
|
onsetDateTime | dateTime | Data Type | ||
onsetPeriod | Period | Data Type | ||
assertedDate | 0..1 | dateTime |
There are no (further) constraints on this element Element Id
AllergyIntolerance.assertedDate Date record was believed accurate DefinitionThe date on which the existance of the AllergyIntolerance was first asserted or acknowledged.
|
|
recorder | 0..1 | Reference(Practitioner | Patient) |
There are no (further) constraints on this element Element Id
AllergyIntolerance.recorder Who recorded the sensitivity Alternate namesAuthor DefinitionIndividual who recorded the record and takes responsibility for its content. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Practitioner | Patient) Constraints
|
|
asserter | Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner) |
There are no (further) constraints on this element Element Id
AllergyIntolerance.asserter Source of the information about the allergy Alternate namesSource, Informant DefinitionThe source of the information about the allergy that is recorded. The recorder takes repsonsibility for the content, but can reference the source from where they got it. Reference(Patient | RelatedPerson | Practitioner) Constraints
|
lastOccurrence | 0..1 | dateTime |
There are no (further) constraints on this element Element Id
AllergyIntolerance.lastOccurrence Date(/time) of last known occurrence of a reaction DefinitionRepresents the date and/or time of the last known occurrence of a reaction event. This date may be replicated by one of the Onset of Reaction dates. Where a textual representation of the date of last occurrence is required e.g. 'In Childhood, '10 years ago' the Comment element should be used.
|
|
note | 0..* | Annotation |
There are no (further) constraints on this element Element Id
AllergyIntolerance.note Additional text not captured in other fields DefinitionAdditional narrative about the propensity for the Adverse Reaction, not captured in other fields. For example: including reason for flagging a seriousness of 'High Risk'; and instructions related to future exposure or administration of the substance, such as administration within an Intensive Care Unit or under corticosteroid cover. The notes should be related to an allergy or intolerance as a condition in general and not related to any particular episode of it. For episode notes and descriptions, use AllergyIntolerance.event.description and AllergyIntolerance.event.notes.
|
|
reaction | 0..* | BackboneElement |
There are no (further) constraints on this element Element Id
AllergyIntolerance.reaction Adverse Reaction Events linked to exposure to substance DefinitionDetails about each adverse reaction event linked to exposure to the identified substance.
|
|
substance | 0..1 | CodeableConcept |
There are no (further) constraints on this element Element Id
AllergyIntolerance.reaction.substance Specific substance or pharmaceutical product considered to be responsible for event DefinitionIdentification 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'. Coding of the specific substance (or pharmaceutical product) with a terminology capable of triggering decision support should be used wherever possible. The 'code' element allows for the use of a specific substance or pharmaceutical product, or a group or class of substances. In the case of an allergy or intolerance to a class of substances, (for example, "penicillins"), the 'reaction.substance' element could be used to code the specific substance that was identifed as having caused the reaction (for example, "amoxycillin"). Duplication of the value in the 'code' and 'reaction.substance' elements is acceptable when a specific substance has been recorded in 'code'.
|
|
manifestation | 1..* | CodeableConcept |
There are no (further) constraints on this element Element Id
AllergyIntolerance.reaction.manifestation Clinical symptoms/signs associated with the Event Alternate namesSymptoms, Signs DefinitionClinical symptoms and/or signs that are observed or associated with the adverse reaction event. Manifestation can be expressed as a single word, phrase or brief description. For example: nausea, rash or no reaction. It is preferable that manifestation should be coded with a terminology, where possible. The values entered here may be used to display on an application screen as part of a list of adverse reactions, as recommended in the UK NHS CUI guidelines. Terminologies commonly used include, but are not limited to, SNOMED CT or ICD10. SNOMED CT Clinical Findings (example) Constraints
|
|
description | 0..1 | string |
There are no (further) constraints on this element Element Id
AllergyIntolerance.reaction.description Description of the event as a whole Alternate namesNarrative, Text DefinitionText description about the reaction as a whole, including details of the manifestation if required. Use the description to provide any details of a particular event of the occurred reaction such as circumstances, reaction specifics, what happened before/after. Information, related to the event, but not describing a particular care should be captured in the comment field. For example: at the age of four, the patient was given penicillin for strep throat and subsequently developed severe hives.
|
|
onset | 0..1 | dateTime |
There are no (further) constraints on this element Element Id
AllergyIntolerance.reaction.onset Date(/time) when manifestations showed DefinitionRecord of the date and/or time of the onset of the Reaction.
|
|
severity | 0..1 | codeBinding |
There are no (further) constraints on this element Element Id
AllergyIntolerance.reaction.severity mild | moderate | severe (of event as a whole) DefinitionClinical assessment of the severity of the reaction event as a whole, potentially considering multiple different manifestations. It is acknowledged that this assessment is very subjective. There may be some some specific practice domains where objective scales have been applied. Objective scales can be included in this model as extensions. AllergyIntoleranceSeverity (required) Constraints
|
|
exposureRoute | 0..1 | CodeableConcept |
There are no (further) constraints on this element Element Id
AllergyIntolerance.reaction.exposureRoute How the subject was exposed to the substance DefinitionIdentification of the route by which the subject was exposed to the substance. Coding of the route of exposure with a terminology should be used wherever possible. SNOMED CT Route Codes (example) Constraints
|
|
note | 0..* | Annotation |
There are no (further) constraints on this element Element Id
AllergyIntolerance.reaction.note Text about event not captured in other fields DefinitionAdditional text about the adverse reaction event not captured in other fields. Use this field to record information indirectly related to a particular event and not captured in the description. For example: Clinical records are no longer available, recorded based on information provided to the patient by her mother and her mother is deceased.
|
See the profile on simplifier.net for additional details.
Example resource
Below you find an example of an AllergyIntolerance resource that conforms to the ZD AllergyIntolerance profile.
{
"resourceType" : "AllergyIntolerance",
"id" : "zd-allergyintolerance-1",
"meta" : {
"profile" : [
"http://zorgdomein.nl/fhir/StructureDefinition/zd-allergyintolerance"
]
},
"clinicalStatus" : "active",
"verificationStatus" : "confirmed",
"category" : [
"food"
],
"criticality" : "high",
"code" : {
"coding" : [
{
"system" : "http://snomed.info/sct",
"code" : "227493005",
"display" : "Cashew nuts"
}
],
"text" : "Cashew nuts"
},
"patient" : {
"reference" : "Patient/zd-patient-1"
},
"onsetDateTime" : "2014-10-09T00:00:00+01:00"
}
<AllergyIntolerance xmlns='http://hl7.org/fhir'>
<id value='zd-allergyintolerance-1'/>
<meta>
<profile value='http://zorgdomein.nl/fhir/StructureDefinition/zd-allergyintolerance'/>
</meta>
<clinicalStatus value='active'/>
<verificationStatus value='confirmed'/>
<category value='food'/>
<criticality value='high'/>
<code>
<coding>
<system value='http://snomed.info/sct'/>
<code value='227493005'/>
<display value='Cashew nuts'/>
</coding>
<text value='Cashew nuts'/>
</code>
<patient>
<reference value='Patient/zd-patient-1'/>
</patient>
<onsetDateTime value='2014-10-09T00:00:00+01:00'/>
</AllergyIntolerance>