Page History
1.1.1 HL7 C-CDA model
The Consolidated Clinical Document Architecture (C-CDA) specification (release 1.1 and 2.0) is required for communication of clinical data at transitions of care by the Office of the National Coordinator (ONC) for Health IT in the US. The ONC 2015 Edition Final Rule updated this requirement to specify the 2.1 version for Meaningful Use Stage 3 certification. The 2.1 C-CDA version includes an updated Allergy - Intolerance Observation (V2) 2.16.840.1.113883.10.20.22.4.7 template which includes a new Criticality Observation 2.16.840.1.113883.10.20.22.4.145 (replacing the previous Severity Observation (V2) at the allergy propensity level – the Severity Observation (V2) continues to be used in the Reaction Observation (V2)). The other relevant templates for use cases in section 3 are: Allergy Concern Act (V3) 2.16.840.1.113883.10.20.22.4.30 and Result Observation (V2) 2.16.840.1.113883.10.20.22.4.2.
The latest information about the HL7® C-CDA® standard can be found here: http://www.hl7.org/implement/standards/product_brief.cfm?product_id=492
1.1.1.1 Allergy Concern Act (V3)
This template reflects an ongoing concern on behalf of the provider that placed the allergy on a patient’s allergy list. As long as the underlying condition is of concern to the provider (i.e., as long as the allergy, whether active or resolved, is of ongoing concern and interest to the provider), the statusCode is “active”. Only when the underlying allergy is no longer of concern is the statusCode set to “completed”. The effectiveTime reflects the time that the underlying allergy was felt to be a concern.
The statusCode of the Allergy Concern Act is the definitive indication of the status of the concern, whereas the effectiveTime of the nested Allergy - Intolerance Observation is the definitive indication of whether or not the underlying allergy is resolved.
The effectiveTime/low of the Allergy Concern Act asserts when the concern became active. This equates to the time the concern was authored in the patient's chart. The effectiveTime/high asserts when the concern was completed (e.g., when the clinician deemed there is no longer any need to track the underlying condition).
1.1.1.2 Allergy - Intolerance Observation (V2)
This template reflects a discrete observation about a patient's allergy or intolerance. Because it is a discrete observation, it will have a statusCode of "completed". The effectiveTime, also referred to as the "biologically relevant time" is the time at which the observation holds for the patient. For a provider seeing a patient in the clinic today, observing a history of penicillin allergy that developed five years ago, the effectiveTime is five years ago.
The effectiveTime of the Allergy - Intolerance Observation is the definitive indication of whether or not the underlying allergy/intolerance is resolved. If known to be resolved, then an effectiveTime/high would be present. If the date of resolution is not known, then effectiveTime/high will be present with a nullFlavor of "UNK".
The agent responsible for an allergy or adverse reaction is not always a manufactured material (for example, food allergies), nor is it necessarily consumed. The following constraints reflect limitations in the base CDA R2 specification, and should be used to represent any type of responsible agent, i.e., use playingEntity classCode = "MMAT" for all agents, manufactured or not.
1.1.1.3 Result Observation (V3)
This template represents the results of a laboratory, radiology, or other study performed on a patient.
The result observation includes a statusCode to allow recording the status of an observation. “Pending” results (e.g., a test has been run but results have not been reported yet) should be represented as “active” ActStatus.
For examples of C-CDA templates, see the C-CDA implementation guide.
1.1.2 HL7 Patient Care Domain Analysis Model
This domain analysis model for allergy records was developed by the HL7 Patient Care Work Group and has been used to inform the allergy/intolerance modeling in the C-CDA® and FHIR® specifications.
http://www.hl7.org/implement/standards/product_brief.cfm?product_id=308
Figure 7: Patient Care Domain Analysis Model
...
Selected attribute definitions
Attribute name | Datatype | Definition |
|---|---|---|
Adverse reaction | ||
severity | Coded | Assessment of the severity of the reaction |
didNotOccurFlag | Boolean | Indicates a reaction did not occur at contact with substance |
OccurrenceDate | DateTime | Time stamp for manifestation of the reaction |
Health condition | ||
status | Coded | Current status of the concern |
Adverse sensitivity to substance | ||
criticality | Coded | Clinical judgement regarding potential seriousness of a future reaction. |
sensitivityType | Coded | Allergy; intolerance |
createdDate | Date Time | Date time the entry was created |
Substance | ||
identifier | Coded | Coded reference to the substance involved in the reaction |
name | String | Name of the substance |
Exposure | ||
exposureDate | Date Time | Date time when the exposure occurred; may be approximated |
exposureType | Coded | How the exposure occurred, eg vaccination, prescription, administration, accidental |
Manifestation | ||
severity | Coded | Severity of the manifestation of the reaction |
reactionType | Coded | Clinical finding characterizing the reaction, eg code for rash or hives |
Sensitivity test | ||
identifier | Identifier | Identifier pointing to results of the sensitivity test |
name | String | Name of the test |
1.1.3 Fast Healthcare Interoperability Resources (FHIR®; HL7®)
FHIR® is an HL7® standard for exchanging healthcare information electronically. The fourth STU release (R4) was published in October 2019, including the first (partial) normative content. FHIR models the classes of information for interoperable use as Resources. The FHIR® Resources relevant to the use cases in section 4 are AllergyIntolerance, Condition and Observation.
1.1.3.1 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).
Figure 8: 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.
Where a propensity is identified, to record information or evidence about a reaction event that is characterized by any harmful or undesirable physiological response that is specific to the individual and triggered by exposure of an individual to the identified 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."
Table 1 shows 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
...
...
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
...
...
AllergyIntoleranceVerificationStatusCodes
...
AllergyIntolerance.type
...
Identification of the underlying physiological mechanism for the reaction risk, if known.
...
- allergy
- intolerance
...
...
...
AllergyIntolerance
.category
...
Category of an identified substance associated with allergies or intolerances.
...
- food
- medication
- environment
- biologic
...
...
...
AllergyIntolerance
.criticality
...
Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.
...
- low
- high
- unable-to-assess
...
...
...
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").
...
...
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).
...
...
...
AllergyIntolerance
.reaction.manifestation
...
Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event.
...
...
...
AllergyIntolerance
.reaction.severity
...
Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations.
...
- mild
- moderate
- severe
...
...
...
AllergyIntolerance
.reaction.exposureRoute
...
A coded concept describing the route or physiological path by which the subject was exposed to the substance.
...
...
It is important to note that
- In the FHIR® AllergyIntolerance resource, some elements (type, category, criticality and severity) have currently a "Code" data type. They thus require the use of the FHIR values provided and no other classification or terminology code can be used as value in these elements, unless one is using a FHIR® extension, while other elements (clinicalStatus, verificationStatus) have a "CodeableConcept" data type and thus allow for simultaneous use of several code systems (ex: both the FHIR values and the SNOMED CT concepts representing the same meaning as those FHIR values).
Here you will find an example of extension for AllergyIntolerance.type, which allows capturing, in SNOMED CT, more type of reaction values then the two FHIR values of "allergy" and "intolerance". The full discussion regarding this extension can be found on the 22/02/2022 SNOMED on FHIR group meeting page.
- 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.
1.1.3.2 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).
Figure 9: 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.
Uses for the Observation resource include:
- Vital signs such as body weight, blood pressure, and temperature
- Laboratory Data like blood glucose, or an estimated GFR
- Imaging results like bone density or fetal measurements
- Clinical Findings such as abdominal tenderness
- Device measurements such as EKG data or Pulse Oximetry data
- Clinical assessment tools such as APGAR or a Glasgow Coma Score
- Personal characteristics: such as eye-color
- Social history like tobacco use, family support, or cognitive status
- Core characteristics like pregnancy status, or a death assertion
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 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
...
...
...
Observation.category
...
A code that classifies the general type of observation being made.
...
...
...
Observation.code
...
Type of observation (code / type). Describes what was observed. Sometimes this is called the observation "name".
...
...
...
Observation.dataAbsentReason
...
Provides a reason why the expected value in the element Observation.value[x] is missing.
...
...
...
Observation.interpretation
...
A categorical assessment of an observation value. For example, high, low, normal.
...
...
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.
...
...
...
Observation.method
...
Indicates the mechanism used to perform the observation.
...
...
...
Observation.referenceRange.type
...
Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.
...
...
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.
...
...
Observation Reference Range AppliesToCodes
...
Observation.component.code
...
Type of component observation (code / type).
Describes what was observed. Sometimes this is called the observation "code".
...
...
...
Observation.component.dataAbsentreason
...
Provides a reason why the expected value in the element Observation.component.value[x] is missing.
...
...
...
Observation.component.interpretation
...
A categorical assessment of an observation value. For example, high, low, normal.
...
...
Observation InterpretationCodes
1.1.3.3 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® 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).
While conditions are frequently a result of a clinician's assessment and assertion of a particular aspect of a patient's state of health, conditions can also be expressed by the patient, related person, or any care team member. A clinician may have a concern about a patient condition (e.g. anorexia) that the patient is not concerned about. Likewise, the patient may have a condition (e.g. hair loss) that does not rise to the level of importance such that it belongs on a practitioner’s Problem List.
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 bindings.
...
Path/Element
...
Definition
...
Values
...
Binding Strength
...
Binding
...
Condition.clinicalStatus
...
The clinical status of the condition or diagnosis.
...
- active
- recurrence
- relapse
- inactive
- remission
- resolved
...
...
...
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
...
...
...
Condition.category
...
A category assigned to the condition.
...
...
...
Condition.severity
...
A subjective assessment of the severity of the condition as evaluated by the clinician.
...
...
...
Condition.code
...
Identification of the condition or diagnosis.
...
...
Condition/Problem/DiagnosisCodes
...
Condition.bodySite
...
Codes describing anatomical locations. May include laterality.
...
...
...
Condition.stage.summary
...
Codes describing condition stages (e.g. Cancer stages).
...
...
...
Condition.stage.type
...
Codes describing the kind of condition staging (e.g. clinical or pathological).
...
...
...
Condition.evidence.code
...
Codes that describe the manifestation or symptoms of a condition.
...
...
1.1.3.4 Example of a typical Medication allergy resource from a clinical system (id = "medication") (JSON format):
| Code Block |
|---|
{
"resourceType": "AllergyIntolerance",
"id": "medication",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: medication</p><p><b>clinicalStatus</b>: Active <span>(Details : {http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical code 'active' = 'Active', given as 'Active'})</span></p><p><b>verificationStatus</b>: Unconfirmed <span>(Details : {http://terminology.hl7.org/CodeSystem/allergyintolerance-verification code 'unconfirmed' = 'Unconfirmed', given as 'Unconfirmed'})</span></p><p><b>category</b>: medication</p><p><b>criticality</b>: high</p><p><b>code</b>: Penicillin G <span>(Details : {RxNorm code '7980' = 'Penicillin G', given as 'Penicillin G'})</span></p><p><b>patient</b>: <a>Patient/example</a></p><p><b>recordedDate</b>: 01/03/2010</p><p><b>recorder</b>: <a>Practitioner/13</a></p><h3>Reactions</h3><table><tr><td>-</td><td><b>Manifestation</b></td></tr><tr><td>*</td><td>Hives <span>(Details : {SNOMED CT code '247472004' = 'Weal', given as 'Hives'})</span></td></tr></table></div>"
},
"clinicalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
"code": "active",
"display": "Active"
}
]
},
"verificationStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
"code": "unconfirmed",
"display": "Unconfirmed"
}
]
},
"category": [
"medication"
],
"criticality": "high",
"code": {
"coding": [
{
"system": "http://www.nlm.nih.gov/research/umls/rxnorm",
"code": "7980",
"display": "Penicillin G"
}
]
},
"patient": {
"reference": "Patient/example"
},
"recordedDate": "2010-03-01",
"recorder": {
"reference": "Practitioner/13"
},
"reaction": [
{
"manifestation": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "247472004",
"display": "Hives"
}
]
}
]
}
]
} |
1.1.3.5 Using SNOMED CT concepts in FHIR® resources
The SNOMED on FHIR group can provide help and direction on how to deal with the specific issues that may arise when using SNOMED CT concepts in FHIR® resources. SNOMED CT implementation in FHIR guidance can be found here: http://build.fhir.org/ig/IHTSDO/snomed-ig/, while proposals of SNOMED CT adapted FHIR resources can be found here: http://build.fhir.org/ig/IHTSDO/snomed-ig/profiles.html.
You will note that there are two separate FHIR® profiles proposed on this page, based on the general HL7 FHIR AllergyIntolerance resource. One is substance-focused, meaning that the record centers for the AllergyIntolerance.code value on the substance the patient reacts to and captures separately the type of reaction in the AllergyIntolerance.type element. One can say this model captures the allergy/intolerance to X in a post-coordinated way. The second profile is finding-focused, meaning it captures the allergy/intolerance in the AllergyIntolerance.code element using pre-coordinated "allergy/intolerance to X" SNOMED CT concepts and makes no use of the AllergyIntolerance.type element.
1.1.4 ISO International Patient Summary (IPS)
The IPS is designed to provide clinical information to assist care across any jurisdictional (e.g. local, regional, state/provincial, national) or organizational border by providing a minimal but not exhaustive data set useful for subsequent clinical care scenarios. It emphasizes the data required and the associated business rules to support use and the necessary conformance of the use case for an international patient summary. The ISO TC215 International Patient Summary includes a section on Allergies and Intolerances.
The IPS includes the following conformance attributes:
M | Mandatory | Shall always be present and - where applicable - shall be instantiated with valid values. No exceptions or empty/null values are allowed in this case. |
R | Required | A required element shall always be present and - where applicable - should be instantiated with valid values. Exceptions or empty/null values are allowed in this case. |
RK | Required if Known | If there is information available, the element must be present and - where applicable - instantiated with valid values. If there is no information available, the element may be omitted, may be left empty, or may be instantiated with exceptional or null values depending on the implementation. |
C | Conditional | Depending on predicate conditions, the element may assume different conformance strengths (e.g. O, R, RK) or not being present. |
O | Optional | This data element can be omitted from a derived model, including from implementations. Recipient may ignore optional elements. |
The Allergies and Intolerance section of IPS data set includes:
...
Data Element
...
Conformance
...
Datatype
...
Data Element Description
...
Allergies/Intolerances content status
...
C
...
coded
...
As this IPS Section is mandatory for conformance, information about “known absence of allergies” or no information about allergies is required to be stated. Known Content will be accompanied by the conditional list of Allergies and intolerances.
...
Allergies and Intolerances
...
C
...
List
...
If present then they shall be listed else give explicit reasons for why none are recorded. An ordered list comprising the name, code, a description of the Allergy/intolerance and Agent details for each Allergy/intolerance.
...
1) Allergy/Intolerance
...
M
...
Label concept
...
If allergies present then they shall be listed else give explicit reasons for why none are recorded. An ordered list comprising the name, code, a description of the Allergy/intolerance and Agent details for each Allergy/intolerance.
...
a. Allergy/Intolerance description
...
R
...
Text
...
Textual description of the allergy or intolerance.
...
b. Clinical status
...
R
...
Coded
...
Provides the current status of the allergy or intolerance (e.g., active)
...
c. Onset date
...
RK
...
Datetime
...
It shall be provided with the highest known precision, at least to the year
...
d. End Date
...
C
...
Datetime
...
If Clinical Status is non-active then an exception can be raised to indicate inconsistency. It shall be provided with the highest known precision, at least to the year.
...
e. Criticality
...
O
...
Coded
...
Represents the gravity of the potential risk for future life-threatening adverse reactions when exposed to a substance known to cause an adverse reaction in that individual.
...
f. Certainty
...
O
...
Coded
...
Assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified substance.
...
g. Type of propensity
...
RK
...
Coded
...
Type of allergy or intolerance. (e.g., allergy)
...
h. Diagnosis
...
O
...
Coded
...
A code indicating the type of reaction and the agent; an alternative option for describing an allergy to the agent. (e.g., lactose intolerant)
...
i. Reaction
...
RK
...
Label Concept
...
A Label Concept recognizing that other data concerning the reaction may be made available in later versions of this standard.
...
i) Manifestation of the reaction
...
RK
...
Coded
...
Description of the clinical manifestation of the allergic reaction. Example: anaphylactic shock
...
ii) Severity
...
RK
...
Coded
...
Coded element that describes the subjective assessment of the severity of the condition as evaluated by the clinician, in the case of an allergy it is used as attribute of a manifestation of a reaction.
...
j. Agent
...
R
...
Label Concept
...
...
iii) Agent code
...
R
...
Coded
...
A specific allergen or other agent/substance to which the patient has an adverse reaction propensity.
...
iv) Category
...
O
...
Coded
...
Allergy substance category (eg food)
Additional information about FHIR® implementation guide of the International Patient Summary can be found here: http://hl7.org/fhir/uv/ips/ .
1.1.5 Other information models
...
Overview
Content Tools
Apps