QI-Core Implementation Guide: STU Ballot (v3.3.0 for FHIR 4.0.0)
Quality Improvement Core Framework (v3.3.0: STU 4 Ballot 1). The current version is 3.2.0 based on FHIR R4. 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 USCoreAllergyIntolerance.
This profile was published on Wed Aug 22 00:00:00 EDT 2018 as a draft by Health Level Seven, Inc. - CQI WG.
Description of Profiles, Differentials, and Snapshots.
Summary
Mandatory: 3 elements
Must-Support: 13 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..* | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) 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: CommonLanguages (preferred) Max Binding: AllLanguages | |
| text | 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 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required) |
| verificationStatus | ?!SΣI | 1..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatusCodes (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 Common substances for allergy and intolerance documentation including refutations (preferred) |
 patient | SΣ | 1..1 | Reference(QICorePatient) | Who the sensitivity is for |
| encounter | S | 0..1 | Reference(QICoreEncounter) | Encounter when the allergy or intolerance was asserted |
 onset[x] | 0..1 | When allergy or intolerance was identified | ||
 onsetDateTime | dateTime | |||
| onsetAge | Age | |||
| onsetPeriod | Period | |||
 onsetRange | Range | |||
| recordedDate | S | 0..1 | dateTime | Date first version of the resource instance was recorded |
| recorder | 0..1 | Reference(QICorePractitioner | QICorePractitionerRole | QICorePatient | QICoreRelatedPerson) | Who recorded the sensitivity | |
| asserter | Σ | 0..1 | Reference(QICorePractitioner | QICorePractitionerRole | QICorePatient | QICoreRelatedPerson) | 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 | Unique id for inter-element referencing | |
| 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 even if unrecognized |
| substance | 0..1 | CodeableConcept | Specific substance or pharmaceutical product considered to be responsible for event Binding: SubstanceCode (example) | |
| manifestation | S | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: SNOMEDCTClinicalFindings (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: SNOMEDCTRouteCodes (example) | |
| note | 0..* | Annotation | Text about event not captured in other fields | |
| Documentation for this format | ||||
Summary
Mandatory: 3 elements
Must-Support: 13 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..* | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) 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: CommonLanguages (preferred) Max Binding: AllLanguages | |
| text | 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 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required) |
| verificationStatus | ?!SΣI | 1..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatusCodes (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 Common substances for allergy and intolerance documentation including refutations (preferred) |
| patient | SΣ | 1..1 | Reference(QICorePatient) | Who the sensitivity is for |
| encounter | S | 0..1 | Reference(QICoreEncounter) | Encounter when the allergy or intolerance was asserted |
| onset[x] | 0..1 | When allergy or intolerance was identified | ||
| onsetDateTime | dateTime | |||
| onsetAge | Age | |||
| onsetPeriod | Period | |||
| onsetRange | Range | |||
| recordedDate | S | 0..1 | dateTime | Date first version of the resource instance was recorded |
| recorder | 0..1 | Reference(QICorePractitioner | QICorePractitionerRole | QICorePatient | QICoreRelatedPerson) | Who recorded the sensitivity | |
| asserter | Σ | 0..1 | Reference(QICorePractitioner | QICorePractitionerRole | QICorePatient | QICoreRelatedPerson) | 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 | Unique id for inter-element referencing | |
| 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 even if unrecognized |
| substance | 0..1 | CodeableConcept | Specific substance or pharmaceutical product considered to be responsible for event Binding: SubstanceCode (example) | |
| manifestation | S | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: SNOMEDCTClinicalFindings (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: SNOMEDCTRouteCodes (example) | |
| note | 0..* | Annotation | Text about event not captured in other fields | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| AllergyIntolerance.language | preferred | CommonLanguages Max Binding: AllLanguages |
| AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatusCodes |
| AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatusCodes |
| AllergyIntolerance.type | required | AllergyIntoleranceType |
| AllergyIntolerance.category | required | AllergyIntoleranceCategory |
| AllergyIntolerance.criticality | required | AllergyIntoleranceCriticality |
| AllergyIntolerance.code | preferred | USCoreAllergySubstance |
| AllergyIntolerance.reaction.substance | example | SubstanceCode |
| AllergyIntolerance.reaction.manifestation | example | SNOMEDCTClinicalFindings |
| AllergyIntolerance.reaction.severity | required | AllergyIntoleranceSeverity |
| AllergyIntolerance.reaction.exposureRoute | example | SNOMEDCTRouteCodes |
| 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-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 or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-6 | AllergyIntolerance | A resource should have narrative for robust management : text.div.exists() | |
| dom-5 | AllergyIntolerance | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.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.coding.code = '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() or (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() or (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() or (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() or (children().count() > id.count()) | |
| ele-1 | AllergyIntolerance.reaction.extension | All FHIR elements must have a @value or children : hasValue() or (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() or (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+. (Clinical Quality Improvement WG). hl7.fhir.us.qicore#3.3.0 based on FHIR v4.0.0 generated 06/08/2019.
Links: Home
| QA Report | Search
| Version History
| 
| Propose a change 