Consolidated CDA Release 2.2, published by Health Level Seven. This is not an authorized publication; it is the continuous build for version 2.2). This version is based on the current content of https://github.com/HL7/CDA-ccda-2.2/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.4.7 | Version: 2.2 | |||
Active as of 2022-05-13 | Computable Name: AllergyIntoleranceObservation | |||
Other Identifiers: : urn:hl7ii:2.16.840.1.113883.10.20.22.4.7:2014-06-09 |
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.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from SubstanceOrDeviceAllergyIntoleranceObservation
Summary
Mandatory: 14 elements (3 nested mandatory elements)
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
This structure is derived from SubstanceOrDeviceAllergyIntoleranceObservation
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | 1..1 | SubstanceOrDeviceAllergyIntoleranceObservation | ||
classCode | 1..1 | code | Required Pattern: OBS | |
moodCode | 1..1 | code | Required Pattern: EVN | |
negationInd | 0..1 | boolean | Use negationInd="true" to indicate that the allergy was not observed. | |
Slices for templateId | 0..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:secondary | 1..1 | II | ||
root | 1..1 | string | Required Pattern: 2.16.840.1.113883.10.20.22.4.7 | |
extension | 1..1 | string | Required Pattern: 2014-06-09 | |
id | 1..* | II | ||
code | 1..1 | CD | ||
code | 1..1 | string | Required Pattern: ASSERTION | |
codeSystem | 1..1 | string | Required Pattern: 2.16.840.1.113883.5.4 | |
statusCode | 1..1 | CS | ||
code | 1..1 | string | Required Pattern: completed | |
effectiveTime | 1..1 | IVL_TS | If the allergy/intolerance is known to be resolved, but the date of resolution is not known, then the high element SHALL be present, and the nullFlavor attribute SHALL be set to 'UNK'. | |
low | 1..1 | TS | The effectiveTime/low (a.k.a. "onset date") asserts when the allergy/intolerance became biologically active. | |
high | 0..1 | TS | The effectiveTime/high (a.k.a. "resolution date") asserts when the allergy/intolerance became biologically resolved. | |
value | 1..1 | CD | The consumable participant points to the precise allergen or substance of intolerance. Because the consumable and the reaction are more clinically relevant than a categorization of the allergy/adverse event type, many systems will simply assign a fixed value here (e.g., "allergy to substance"). Binding: Allergy and Intolerance Type (required) | |
author | 0..* | AuthorParticipation | ||
Slices for entryRelationship | 0..* | Element | Slice: Unordered, Open by profile:observation | |
entryRelationship:criticality | 0..1 | Element | ||
typeCode | 1..1 | code | Required Pattern: SUBJ | |
inversionInd | 1..1 | boolean | Required Pattern: true | |
observation | 1..1 | CriticalityObservation | ||
Documentation for this format |
This structure is derived from SubstanceOrDeviceAllergyIntoleranceObservation
Summary
Mandatory: 14 elements (3 nested mandatory elements)
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from SubstanceOrDeviceAllergyIntoleranceObservation
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | 1..1 | SubstanceOrDeviceAllergyIntoleranceObservation | ||
classCode | 1..1 | code | Required Pattern: OBS | |
moodCode | 1..1 | code | Required Pattern: EVN | |
negationInd | 0..1 | boolean | Use negationInd="true" to indicate that the allergy was not observed. | |
Slices for templateId | 0..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:secondary | 1..1 | II | ||
root | 1..1 | string | Required Pattern: 2.16.840.1.113883.10.20.22.4.7 | |
extension | 1..1 | string | Required Pattern: 2014-06-09 | |
id | 1..* | II | ||
code | 1..1 | CD | ||
code | 1..1 | string | Required Pattern: ASSERTION | |
codeSystem | 1..1 | string | Required Pattern: 2.16.840.1.113883.5.4 | |
statusCode | 1..1 | CS | ||
code | 1..1 | string | Required Pattern: completed | |
effectiveTime | 1..1 | IVL_TS | If the allergy/intolerance is known to be resolved, but the date of resolution is not known, then the high element SHALL be present, and the nullFlavor attribute SHALL be set to 'UNK'. | |
low | 1..1 | TS | The effectiveTime/low (a.k.a. "onset date") asserts when the allergy/intolerance became biologically active. | |
high | 0..1 | TS | The effectiveTime/high (a.k.a. "resolution date") asserts when the allergy/intolerance became biologically resolved. | |
value | 1..1 | CD | The consumable participant points to the precise allergen or substance of intolerance. Because the consumable and the reaction are more clinically relevant than a categorization of the allergy/adverse event type, many systems will simply assign a fixed value here (e.g., "allergy to substance"). Binding: Allergy and Intolerance Type (required) | |
author | 0..* | AuthorParticipation | ||
Slices for entryRelationship | 0..* | Element | Slice: Unordered, Open by profile:observation | |
entryRelationship:criticality | 0..1 | Element | ||
typeCode | 1..1 | code | Required Pattern: SUBJ | |
inversionInd | 1..1 | boolean | Required Pattern: true | |
observation | 1..1 | CriticalityObservation | ||
Documentation for this format |
Snapshot View
Other representations of profile: CSV, Excel, Schematron
Path | Conformance | ValueSet / Code |
Observation.classCode | required | Pattern: OBS |
Observation.templateId:primary.nullFlavor | required | NullFlavor |
Observation.templateId:secondary.nullFlavor | required | NullFlavor |
Observation.code | extensible | ObservationType |
Observation.code.nullFlavor | required | NullFlavor |
Observation.statusCode | required | ActStatus |
Observation.statusCode.nullFlavor | required | NullFlavor |
Observation.effectiveTime.nullFlavor | required | NullFlavor |
Observation.priorityCode | extensible | ActPriority |
Observation.languageCode | required | HumanLanguage |
Observation.value | required | Allergy and Intolerance Type |
Observation.value.nullFlavor | required | NullFlavor |
Observation.value.code | required | Allergy and Intolerance Type |
Observation.interpretationCode | required | ObservationInterpretation |
Observation.methodCode | extensible | ObservationMethod |
Observation.subject.typeCode | required | Fixed Value: SBJ |
Observation.subject.contextControlCode | required | Fixed Value: OP |
Observation.subject.awarenessCode | extensible | TargetAwareness |
Observation.informant.typeCode | required | Fixed Value: INF |
Observation.informant.contextControlCode | required | Fixed Value: OP |
Observation.participant:participant1.nullFlavor | required | NullFlavor |
Observation.participant:participant1.typeCode | required | Pattern: CSM |
Observation.participant:participant1.contextControlCode | required | Fixed Value: OP |
Observation.participant:participant1.participantRole.classCode | required | Pattern: MANU |
Observation.participant:participant1.participantRole.code | extensible | RoleCode |
Observation.participant:participant1.participantRole.playingEntity.classCode | required | Pattern: MMAT |
Observation.participant:participant1.participantRole.playingEntity.determinerCode | required | Fixed Value: INSTANCE |
Observation.participant:participant1.participantRole.playingEntity.code | example | Substance Reactant for Intolerance |
Observation.referenceRange.typeCode | required | Fixed Value: REFV |
Id | Grade | Path | Details | Requirements |
obs-er-1 | error | Observation.entryRelationship | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 | |
obs-er-1 | error | Observation.entryRelationship:allergyStatus | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 | |
obs-er-1 | error | Observation.entryRelationship:reaction | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 | |
obs-er-1 | error | Observation.entryRelationship:severity | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 | |
obs-er-1 | error | Observation.entryRelationship:criticality | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 |