Search


Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

AllergyIntolerance resource

Caption reference
CapRefIdintoleranceresource
CapRefTypeFigure
shows the structure of the FHIR AllergyIntolerance resource. The full resource model structure, coded elements and terminology bindings of the AllergyIntolerance resource can be found at http://www.hl7.org/fhir/allergyintolerance.html, with various display options, including UML, XML, JSON, Turtle and the differences it underwent compared to the prior release(s).

Image Added

Caption label
CapIdintoleranceresource
CapTypeFigure

...

Structure of the AllergyIntolerance HL7 FHIR resource as in HL7® FHIR® v4.3.0: R4B - STU (From http://www.hl7.org/fhir/allergyintolerance.html, consulted on 2nd September 2022).

...


The scope of this resource is to "Record of a clinical assessment of an allergy or intolerance; a propensity, or a potential risk to an individual, to have an adverse reaction on future exposure to the specified substance, or class of 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."

Caption label
CapIdallergyintolerance

...

CapTypeTable
The definition of the main AllergyIntolerance resource elements along with details about their terminology bindings.


Path/Element

Definition

Values

Binding Strength

Binding

AllergyIntolerance

.clinicalStatus

The clinical status of the allergy or intolerance.

- active

- inactive

- resolved

Required

AllergyIntoleranceClinicalStatusCodes

AllergyIntolerance

.verificationStatus

Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.

- unconfirmed

- confirmed

- refuted

- entered-in-error

Required

AllergyIntoleranceVerificationStatusCodes

AllergyIntolerance.type

Identification of the underlying physiological mechanism for the reaction risk, if known.

- allergy

- intolerance

Required

AllergyIntoleranceType

AllergyIntolerance

.category

Category of an identified substance associated with allergies or intolerances.

- food

- medication

- environment

- biologic

Required

AllergyIntoleranceCategory

AllergyIntolerance

.criticality

Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.

- low

- high

- unable-to-assess

Required

AllergyIntoleranceCriticality

AllergyIntolerance.code

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").


Example

AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes

AllergyIntolerance

.reaction.substance

Identification of the specific substance (or pharmaceutical product) considered to be responsible for the Adverse Reaction manifestation. It can differ from the AllergyIntolerance.code in some circumstances (ex: reaction to a product containing the substance responsible).


Example

SubstanceCode

AllergyIntolerance

.reaction.manifestation

Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event.


Example

SNOMEDCTClinicalFindings

AllergyIntolerance

.reaction.severity

Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations.

- mild

- moderate

- severe

Required

AllergyIntoleranceSeverity

AllergyIntolerance

.reaction.exposureRoute

A coded concept describing the route or physiological path by which the subject was exposed to the substance.


Example

SNOMEDCTRouteCodes

 

It is important to note that

...

  • When FHIR® R5 is released (expected in late 2022):
    • The reaction.manifestation element should be able to directly reference a FHIR Observation resource representing the manifestation (proposal to be balloted in R5). This will allow the manifestation of an adverse reaction to be recorded only once, not first in an Observation resource and then once again in the AllergyIntolerance resource.
    • The AllergyIntolerance.type element will have a "CodeableConcept" data type and a binding strength of "Preferred", thus allowing the use of SNOMED CT concepts as values without the use of an extension.

 Observation resource

    • without the use of an extension.

 Observation resource

Caption reference
CapRefIdobservationresource
CapRefTypeFigure
shows the structure of the FHIR Observation resource. The full resource model structure, coded elements and terminology bindings of the Observation resource can be found on http://www.hl7.org/fhir/observation.html, with various display options, including UML, XML, JSON, Turtle and the differences it underwent compared to the prior release(s).

Image AddedFigure 9: Structure of the Observation HL7 FHIR resource as in HL7® FHIR®

Caption label
CapIdobservationresource
CapTypeFigure
Structure of the Observation HL7 FHIR resource as in HL7® FHIR® v4.3.0: R4B - STU (From http://www.hl7.org/fhir/observation.html, consulted on 2nd September 2022).

...

Observations in general are a central element in healthcare, used to support diagnosis, monitor progress, determine baselines and patterns and even capture demographic characteristics. Most observations are simple name/value pair assertions with some metadata, but some observations group other observations together logically, or even are multi-component observations. Note that the DiagnosticReport resource provides a clinical or workflow context for a set of observations and the Observation resource is referenced by DiagnosticReport to represent laboratory, imaging, and other clinical and diagnostic data to form a complete report. In the context of allergies, it can be used to present allergy test results.

...

In the context of allergies, the Observation resource can be used to record the manifestation(s) of the allergy (ex: rash on the neck). Note that the boundary between observing a (series of) clinical finding(s) and posing the diagnosis of a disorder isn't always clear cut in medical ontology, and explicit local business rules may be needed to help clinicians record the same clinical situations either as observations or as diagnosis in a consistent way. The Observation resource can also be used to record allergy test results (biological test, like dosage of specific IgE or clinical, like patch and prick tests).Table 2 shows the definition of the main Observation resource elements along with details about their terminology and prick tests).

Caption label
CapIdobservation
CapTypeTable
The definition of the main Observation resource elements along with details about their terminology bindings.


Path/Element

Definition

Values

Binding Strength

Binding

Observation.status

The status of the result value.

- registered

- preliminary

- final

- amended

- corrected

- cancelled

- entered in error

- unknown

Required

ObservationStatus

Observation.category

A code that classifies the general type of observation being made.


Preferred

Observation Category Codes

Observation.code

Type of observation (code / type). Describes what was observed. Sometimes this is called the observation "name".


Example

LOINC Codes

Observation.dataAbsentReason

Provides a reason why the expected value in the element Observation.value[x] is missing.


Extensible

DataAbsentReason

Observation.interpretation

A categorical assessment of an observation value. For example, high, low, normal.


Extensible

Observation InterpretationCodes

Observation.bodySite

Indicates the site on the subject's body where the observation was made (i.e. the target site). May include laterality.


Example

SNOMED CT Body Structures

Observation.method

Indicates the mechanism used to perform the observation.


Example

ObservationMethods

Observation.referenceRange.type

Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.


Preferred

Observation Reference Range MeaningCodes

Observation.referenceRange.appliesTo


Codes to indicate the target population this reference range applies to.  For example, a reference range may be based on the normal population or a particular sex or race.


Example

Observation Reference Range AppliesToCodes

Observation.component.code

Type of component observation (code / type).
Describes what was observed. Sometimes this is called the observation "code".


Example

LOINC Codes

Observation.component.dataAbsentreason

Provides a reason why the expected value in the element Observation.component.value[x] is missing.


Extensible

DataAbsentReason

Observation.component.interpretation

A categorical assessment of an observation value. For example, high, low, normal.


Extensible

Observation InterpretationCodes

 

Condition resource

Caption reference
CapRefIdconditionresource
CapRefTypeFigure
shows the structure of the FHIR Condition resource. The resource model structure, coded elements and terminology bindings of the Condition resource can be found on http://www.hl7.org/fhir/condition.html, with various display options, including UML, XML, JSON, Turtle and the differences it underwent compared to the prior release(s).Figure 10: Structure of the Observation HL7 FHIR resource as in HL7® FHIR® ).


Image Added

Caption label
CapIdconditionresource
CapTypeFigure
Structure of the Condition HL7 FHIR resource as in HL7® FHIR® v4.3.0: R4B - STU (From http://www.hl7.org/fhir/condition.html, consulted on 2nd September 2022)

...

 

...

This resource is used to record detailed information about a condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern. The condition could be a point in time diagnosis in the context of an encounter, it could be an item on the practitioner’s Problem List, or it could be an additional concern that does not exist on the practitioner’s Problem List. Often a condition is about a clinician's assessment and assertion of a particular aspect of a patient's state of health. It can be used to record information about a disease/illness identified from application of clinical reasoning over the pathologic and pathophysiologic findings (diagnosis), or identification of health issues/situations that a practitioner considers harmful or potentially harmful and may be investigated and managed (problem), or another health issue/situation that may require ongoing monitoring and/or management (health issue/concern).

...

In the context of allergies, the Condition resource can be used to record the manifestation(s) of the allergy (ex: allergic urticaria).Table 3 shows the definition of the main Condition resource elements along with details about their terminology

Caption label
CapIdcondition
CapTypeTable
The definition of the main Condition resource elements along with details about their terminology bindings.


Path/Element

Definition

Values

Binding Strength

Binding

Condition.clinicalStatus

The clinical status of the condition or diagnosis.

- active

- recurrence

- relapse

- inactive

- remission

- resolved

Required

ConditionClinicalStatusCodes

Condition.verificationStatus

The verification status to support or decline the clinical status of the condition or diagnosis.

- unconfirmed

- provisional

- differential

- confirmed

- refuted

- entered-in-error

Required

ConditionVerificationStatus

Condition.category

A category assigned to the condition.


Extensible

ConditionCategoryCodes

Condition.severity

A subjective assessment of the severity of the condition as evaluated by the clinician.


Preferred

Condition/DiagnosisSeverity

Condition.code

Identification of the condition or diagnosis.


Example

Condition/Problem/DiagnosisCodes

Condition.bodySite

Codes describing anatomical locations. May include laterality.


Example

SNOMEDCTBodyStructures

Condition.stage.summary

Codes describing condition stages (e.g. Cancer stages).


Example

ConditionStage

Condition.stage.type

Codes describing the kind of condition staging (e.g. clinical or pathological).


Example

ConditionStageType

Condition.evidence.code

Codes that describe the manifestation or symptoms of a condition.


Example

ManifestationAndSymptomCodes

 

 

1.1.3.4   Example of a typical Medication allergy resource from a clinical system (id = "medication") (JSON format):

...