QI-Core Implementation Guide: STU 3.2 (v3.2.0 for FHIR 3.0.1)
This page is part of the Quality Improvement Core Framework (v3.2.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 
| Typical Food Allergy |
| Refuted Food Allergy |
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 Allergies 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.
Summary
Mandatory: 3 elements (1 nested mandatory element)
Must-Support: 12 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  AllergyIntolerance | I | 0..* | US Core Allergies Profile 1: extension: reasonRefuted is only permitted if status is refuted | |
  id | Σ | 0..1 | id | Logical id of this artifact |
 meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) Max Binding: All Languages | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
 contained | 0..* | Resource | Contained, inline Resources | |
 extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| allergyintolerance-resolutionAge | I | 0..1 | Age | Age that the allergy or intolerance resolved URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-resolutionAge |
| allergyintolerance-reasonRefuted | I | 0..1 | CodeableConcept | Explanation associated with refuted status URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-reasonRefuted |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..* | Identifier | External ids for this item |
| clinicalStatus | ?!SΣI | 0..1 | code | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatus (required) |
| verificationStatus | ?!SΣI | 1..1 | code | unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatus (required) |
| type | SΣ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required) |
| category | SΣ | 0..* | code | food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required) |
| criticality | SΣ | 0..1 | code | low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required) |
| code | SΣ | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: US Core Substance-Reactant for Intolerance and Negation Codes (preferred) |
 patient | SΣ | 1..1 | Reference(QICore-Patient) | Who the sensitivity is for |
 onset[x] | 0..1 | dateTime, Age, Period, Range, string | When allergy or intolerance was identified | |
| assertedDate | S | 0..1 | dateTime | Date record was believed accurate |
| recorder | 0..1 | Reference(QICore-Practitioner | QICore-Patient) | Who recorded the sensitivity | |
| asserter | Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner) | Source of the information about the allergy |
| lastOccurrence | 0..1 | dateTime | Date(/time) of last known occurrence of a reaction | |
| note | 0..* | Annotation | Additional text not captured in other fields | |
 reaction | I | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance |
 id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| allergyintolerance-duration | SI | 0..1 | Duration | How long Manifestations persisted URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-duration |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| substance | 0..1 | CodeableConcept | Specific substance or pharmaceutical product considered to be responsible for event Binding: Substance Code (example) | |
| manifestation | S | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: SNOMED CT Clinical Findings (example) |
| description | 0..1 | string | Description of the event as a whole | |
| onset | S | 0..1 | dateTime | Date(/time) when manifestations showed |
| severity | S | 0..1 | code | mild | moderate | severe (of event as a whole) Binding: AllergyIntoleranceSeverity (required) |
| exposureRoute | 0..1 | CodeableConcept | How the subject was exposed to the substance Binding: SNOMED CT Route Codes (example) | |
| note | 0..* | Annotation | Text about event not captured in other fields | |
| Documentation for this format | ||||
Summary
Mandatory: 3 elements (1 nested mandatory element)
Must-Support: 12 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AllergyIntolerance | I | 0..* | US Core Allergies Profile 1: extension: reasonRefuted is only permitted if status is refuted | |
| id | Σ | 0..1 | id | Logical id of this artifact |
| meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) Max Binding: All Languages | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| allergyintolerance-resolutionAge | I | 0..1 | Age | Age that the allergy or intolerance resolved URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-resolutionAge |
| allergyintolerance-reasonRefuted | I | 0..1 | CodeableConcept | Explanation associated with refuted status URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-reasonRefuted |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..* | Identifier | External ids for this item |
| clinicalStatus | ?!SΣI | 0..1 | code | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatus (required) |
| verificationStatus | ?!SΣI | 1..1 | code | unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatus (required) |
| type | SΣ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required) |
| category | SΣ | 0..* | code | food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required) |
| criticality | SΣ | 0..1 | code | low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required) |
| code | SΣ | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: US Core Substance-Reactant for Intolerance and Negation Codes (preferred) |
| patient | SΣ | 1..1 | Reference(QICore-Patient) | Who the sensitivity is for |
| onset[x] | 0..1 | dateTime, Age, Period, Range, string | When allergy or intolerance was identified | |
| assertedDate | S | 0..1 | dateTime | Date record was believed accurate |
| recorder | 0..1 | Reference(QICore-Practitioner | QICore-Patient) | Who recorded the sensitivity | |
| asserter | Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner) | Source of the information about the allergy |
| lastOccurrence | 0..1 | dateTime | Date(/time) of last known occurrence of a reaction | |
| note | 0..* | Annotation | Additional text not captured in other fields | |
| reaction | I | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| allergyintolerance-duration | SI | 0..1 | Duration | How long Manifestations persisted URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-duration |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| substance | 0..1 | CodeableConcept | Specific substance or pharmaceutical product considered to be responsible for event Binding: Substance Code (example) | |
| manifestation | S | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: SNOMED CT Clinical Findings (example) |
| description | 0..1 | string | Description of the event as a whole | |
| onset | S | 0..1 | dateTime | Date(/time) when manifestations showed |
| severity | S | 0..1 | code | mild | moderate | severe (of event as a whole) Binding: AllergyIntoleranceSeverity (required) |
| exposureRoute | 0..1 | CodeableConcept | How the subject was exposed to the substance Binding: SNOMED CT Route Codes (example) | |
| note | 0..* | Annotation | Text about event not captured in other fields | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatus |
| AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatus |
| AllergyIntolerance.type | required | AllergyIntoleranceType |
| AllergyIntolerance.category | required | AllergyIntoleranceCategory |
| AllergyIntolerance.criticality | required | AllergyIntoleranceCriticality |
| AllergyIntolerance.code | preferred | US Core Substance-Reactant for Intolerance and Negation Codes |
| AllergyIntolerance.reaction.manifestation | example | SNOMED CT Clinical Findings |
| AllergyIntolerance.reaction.severity | required | AllergyIntoleranceSeverity |
| Id | Path | Details | Requirements |
| dom-2 | AllergyIntolerance | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-1 | AllergyIntolerance | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
| dom-4 | AllergyIntolerance | If 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-3 | AllergyIntolerance | If 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-1 | AllergyIntolerance | AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. : verificationStatus='entered-in-error' or clinicalStatus.exists() | |
| ait-2 | AllergyIntolerance | AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error : verificationStatus!='entered-in-error' or clinicalStatus.empty() | |
| 1 | AllergyIntolerance | extension: reasonRefuted is only permitted if status is refuted : verificationStatus = 'refuted' or extension.where(url='http://hl7.org/fhir/StructureDefinition/allergyintolerance-reasonRefuted').empty() | |
| ele-1 | AllergyIntolerance.extension | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ext-1 | AllergyIntolerance.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | AllergyIntolerance.extension | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ext-1 | AllergyIntolerance.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | AllergyIntolerance.extension | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ext-1 | AllergyIntolerance.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | AllergyIntolerance.reaction | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ele-1 | AllergyIntolerance.reaction.extension | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ext-1 | AllergyIntolerance.reaction.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | AllergyIntolerance.reaction.extension | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ext-1 | AllergyIntolerance.reaction.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
© HL7.org 2011+. Package hl7.fhir.us.qicore#3.2.0 based on FHIR v3.0.1-11917. Generated on 14/04/2019
Links: Search |
QA Page |
|
Propose a change