This page is part of the Quality Improvement Core Framework (v3.1.0: STU 3) based on FHIR R3. The current version which supercedes this version is 4.1.1. For a full list of available versions, see the Directory of published versions

D.4.1 StructureDefinition-qicore-allergyintolerance

Examples:

Typical Food Allergy
Refuted Food Allergy

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is: 

http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-allergyintolerance

Profile of AllergyIntolerance for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.

This profile builds on US Core AllergyIntolerance Profile.

This profile was published on Wed Aug 22 00:00:00 AEST 2018 as a draft by Health Level Seven, Inc. - CQI WG.

Description of Profiles, Differentials, and Snapshots.

NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance I0..*US Core Allergies Profile
1: extension: reasonRefuted is only permitted if status is refuted
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... allergyintolerance-resolutionAge I0..1AgeExtension
URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-resolutionAge
... allergyintolerance-reasonRefuted I0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-reasonRefuted
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal ids for this item
... clinicalStatus ?!SΣI0..1codeactive | inactive | resolved
Binding: AllergyIntoleranceClinicalStatus (required)
... verificationStatus ?!SΣI1..1codeunconfirmed | confirmed | refuted | entered-in-error
Binding: AllergyIntoleranceVerificationStatus (required)
... type SΣ0..1codeallergy | intolerance - Underlying mechanism (if known)
Binding: AllergyIntoleranceType (required)
... category SΣ0..*codefood | medication | environment | biologic
Binding: AllergyIntoleranceCategory (required)
... criticality SΣ0..1codelow | high | unable-to-assess
Binding: AllergyIntoleranceCriticality (required)
... code SΣ1..1CodeableConceptCode that identifies the allergy or intolerance
Binding: US Core Substance-Reactant for Intolerance and Negation Codes (preferred)
... patient SΣ1..1Reference(QICore-Patient)Who the sensitivity is for
... onset[x] 0..1dateTime, Age, Period, Range, stringWhen allergy or intolerance was identified
... assertedDate S0..1dateTimeDate record was believed accurate
... recorder 0..1Reference(QICore-Practitioner | QICore-Patient)Who recorded the sensitivity
... asserter Σ0..1Reference(Patient | RelatedPerson | Practitioner)Source of the information about the allergy
... lastOccurrence 0..1dateTimeDate(/time) of last known occurrence of a reaction
... note 0..*AnnotationAdditional text not captured in other fields
... reaction I0..*BackboneElementAdverse Reaction Events linked to exposure to substance
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... allergyintolerance-duration SI0..1DurationExtension
URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-duration
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... substance 0..1CodeableConceptSpecific substance or pharmaceutical product considered to be responsible for event
Binding: Substance Code (example)
.... manifestation S1..*CodeableConceptClinical symptoms/signs associated with the Event
Binding: SNOMED CT Clinical Findings (example)
.... description 0..1stringDescription of the event as a whole
.... onset S0..1dateTimeDate(/time) when manifestations showed
.... severity S0..1codemild | moderate | severe (of event as a whole)
Binding: AllergyIntoleranceSeverity (required)
.... exposureRoute 0..1CodeableConceptHow the subject was exposed to the substance
Binding: SNOMED CT Route Codes (example)
.... note 0..*AnnotationText about event not captured in other fields

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance I0..*US Core Allergies Profile
1: extension: reasonRefuted is only permitted if status is refuted
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... allergyintolerance-resolutionAge I0..1AgeExtension
URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-resolutionAge
... allergyintolerance-reasonRefuted I0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-reasonRefuted
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal ids for this item
... clinicalStatus ?!SΣI0..1codeactive | inactive | resolved
Binding: AllergyIntoleranceClinicalStatus (required)
... verificationStatus ?!SΣI1..1codeunconfirmed | confirmed | refuted | entered-in-error
Binding: AllergyIntoleranceVerificationStatus (required)
... type SΣ0..1codeallergy | intolerance - Underlying mechanism (if known)
Binding: AllergyIntoleranceType (required)
... category SΣ0..*codefood | medication | environment | biologic
Binding: AllergyIntoleranceCategory (required)
... criticality SΣ0..1codelow | high | unable-to-assess
Binding: AllergyIntoleranceCriticality (required)
... code SΣ1..1CodeableConceptCode that identifies the allergy or intolerance
Binding: US Core Substance-Reactant for Intolerance and Negation Codes (preferred)
... patient SΣ1..1Reference(QICore-Patient)Who the sensitivity is for
... onset[x] 0..1dateTime, Age, Period, Range, stringWhen allergy or intolerance was identified
... assertedDate S0..1dateTimeDate record was believed accurate
... recorder 0..1Reference(QICore-Practitioner | QICore-Patient)Who recorded the sensitivity
... asserter Σ0..1Reference(Patient | RelatedPerson | Practitioner)Source of the information about the allergy
... lastOccurrence 0..1dateTimeDate(/time) of last known occurrence of a reaction
... note 0..*AnnotationAdditional text not captured in other fields
... reaction I0..*BackboneElementAdverse Reaction Events linked to exposure to substance
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... allergyintolerance-duration SI0..1DurationExtension
URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-duration
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... substance 0..1CodeableConceptSpecific substance or pharmaceutical product considered to be responsible for event
Binding: Substance Code (example)
.... manifestation S1..*CodeableConceptClinical symptoms/signs associated with the Event
Binding: SNOMED CT Clinical Findings (example)
.... description 0..1stringDescription of the event as a whole
.... onset S0..1dateTimeDate(/time) when manifestations showed
.... severity S0..1codemild | moderate | severe (of event as a whole)
Binding: AllergyIntoleranceSeverity (required)
.... exposureRoute 0..1CodeableConceptHow the subject was exposed to the substance
Binding: SNOMED CT Route Codes (example)
.... note 0..*AnnotationText about event not captured in other fields

doco Documentation for this format

 

D.4.1.2 Terminology Bindings

Terminology Bindings

PathNameConformanceValueSet
AllergyIntolerance.languageCommon LanguagesextensibleCommon Languages
AllergyIntolerance.clinicalStatusAllergyIntoleranceClinicalStatusrequiredAllergyIntoleranceClinicalStatus
AllergyIntolerance.verificationStatusAllergyIntoleranceVerificationStatusrequiredAllergyIntoleranceVerificationStatus
AllergyIntolerance.typeAllergyIntoleranceTyperequiredAllergyIntoleranceType
AllergyIntolerance.categoryAllergyIntoleranceCategoryrequiredAllergyIntoleranceCategory
AllergyIntolerance.criticalityAllergyIntoleranceCriticalityrequiredAllergyIntoleranceCriticality
AllergyIntolerance.codeUS Core Substance-Reactant for Intolerance and Negation CodespreferredUS Core Substance-Reactant for Intolerance and Negation Codes
AllergyIntolerance.reaction.substanceSubstance CodeexampleSubstance Code
AllergyIntolerance.reaction.manifestationSNOMED CT Clinical FindingsexampleSNOMED CT Clinical Findings
AllergyIntolerance.reaction.severityAllergyIntoleranceSeverityrequiredAllergyIntoleranceSeverity
AllergyIntolerance.reaction.exposureRouteSNOMED CT Route CodesexampleSNOMED CT Route Codes

D.4.1.3 Constraints

Constraints

IdPathDetailsRequirements
dom-2AllergyIntoleranceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1AllergyIntoleranceIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-4AllergyIntoleranceIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-3AllergyIntoleranceIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
ait-1AllergyIntoleranceAllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error.
: verificationStatus='entered-in-error' or clinicalStatus.exists()
ait-2AllergyIntoleranceAllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error
: verificationStatus!='entered-in-error' or clinicalStatus.empty()
1AllergyIntoleranceextension: reasonRefuted is only permitted if status is refuted
: verificationStatus = 'refuted' or extension.where(url='http://hl7.org/fhir/StructureDefinition/allergyintolerance-reasonRefuted').empty()
ele-1AllergyIntolerance.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1AllergyIntolerance.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1AllergyIntolerance.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1AllergyIntolerance.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1AllergyIntolerance.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1AllergyIntolerance.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1AllergyIntolerance.reactionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ele-1AllergyIntolerance.reaction.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1AllergyIntolerance.reaction.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1AllergyIntolerance.reaction.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1AllergyIntolerance.reaction.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()