QI-Core Implementation Guide
5.0.0 - STU5
QI-Core Implementation Guide
5.0.0 - STU5
This page is part of the Quality Improvement Core Framework (v5.0.0: STU5 (v5.0.0)) based on FHIR R4. The current version which supercedes this version is 4.1.1. For a full list of available versions, see the Directory of published versions 
| Official URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-allergyintolerance | Version: 5.0.0 | |||
| Active as of 2018-08-22 | Computable Name: QICoreAllergyIntolerance | |||
Profile of AllergyIntolerance for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.
define "Statin Allergy Intolerance": ["AllergyIntolerance": "Statin Allergen"] StatinAllergyIntolerance where (StatinAllergyIntolerance.clinicalStatus is null or StatinAllergyIntolerance.clinicalStatus ~ Global."allergy-active")This example represents a situation where the subject is currently experiencing, or is at risk of, a reaction to the identified substance.
| Typical Food Allergy |
| Refuted Food Allergy |
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from USCoreAllergyIntolerance
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  AllergyIntolerance | C | 0..* | USCoreAllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) 1: extension: reasonRefuted is only permitted if status is refuted |
  resolutionAge | 0..1 | Age | Age that the allergy or intolerance resolved URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-resolutionAge | |
 type | S | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) |
| category | S | 0..* | code | food | medication | environment | biologic |
| criticality | S | 0..1 | code | low | high | unable-to-assess |
 patient | S | 1..1 | Reference(QICore Patient) | Who the sensitivity is for |
| encounter | S | 0..1 | Reference(QICore Encounter) | 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(QICore Practitioner | QICore PractitionerRole | QICore Patient | QICore RelatedPerson) | Who recorded the sensitivity | |
| asserter | 0..1 | Reference(QICore Practitioner | QICore PractitionerRole | QICore Patient | QICore RelatedPerson) | Source of the information about the allergy | |
 reaction | S | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance |
 reaction-duration | S | 0..1 | Duration | How long Manifestations persisted URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-duration |
| onset | S | 0..1 | dateTime | Date(/time) when manifestations showed |
| severity | S | 0..1 | code | mild | moderate | severe (of event as a whole) |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| 1 | error | 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() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AllergyIntolerance | C | 0..* | USCoreAllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) 1: extension: reasonRefuted is only permitted if status is refuted |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| resolutionAge | 0..1 | Age | Age that the allergy or intolerance resolved URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-resolutionAge | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| clinicalStatus | ?!SΣC | 0..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required) |
| verificationStatus | ?!SΣC | 0..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): Identification of the underlying physiological mechanism for a Reaction Risk. |
| category | SΣ | 0..* | code | food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances. |
| criticality | SΣ | 0..1 | code | low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance. |
| code | SΣ | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: Common substances for allergy and intolerance documentation including refutations (extensible) |
| patient | SΣ | 1..1 | Reference(QICore Patient) | Who the sensitivity is for |
| encounter | S | 0..1 | Reference(QICore Encounter) | 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(QICore Practitioner | QICore PractitionerRole | QICore Patient | QICore RelatedPerson) | Who recorded the sensitivity | |
| asserter | Σ | 0..1 | Reference(QICore Practitioner | QICore PractitionerRole | QICore Patient | QICore RelatedPerson) | Source of the information about the allergy |
| reaction | S | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance |
| reaction-duration | S | 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 |
| manifestation | S | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: SNOMEDCTClinicalFindings (extensible) |
| 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): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatusCodes |
| AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatusCodes |
| AllergyIntolerance.type | required | AllergyIntoleranceType |
| AllergyIntolerance.category | required | AllergyIntoleranceCategory |
| AllergyIntolerance.criticality | required | AllergyIntoleranceCriticality |
| AllergyIntolerance.code | extensible | Common substances for allergy and intolerance documentation including refutations |
| AllergyIntolerance.reaction.manifestation | extensible | SNOMEDCTClinicalFindings |
| AllergyIntolerance.reaction.severity | required | AllergyIntoleranceSeverity |
| Id | Grade | Path(s) | Details | Requirements |
| 1 | error | 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() | |
| ait-1 | error | AllergyIntolerance | AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists() | |
| ait-2 | error | AllergyIntolerance | AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty() | |
| dom-2 | error | AllergyIntolerance | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | 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-4 | error | 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-5 | error | AllergyIntolerance | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | AllergyIntolerance | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| AllergyIntolerance | C | 0..* | USCoreAllergyIntolerance | 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): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
 Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| resolutionAge | 0..1 | Age | Age that the allergy or intolerance resolved URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-resolutionAge | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | External ids for this item | ||||
| clinicalStatus | ?!SΣC | 0..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required) | ||||
| verificationStatus | ?!SΣC | 0..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): Identification of the underlying physiological mechanism for a Reaction Risk. | ||||
| category | SΣ | 0..* | code | food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances. | ||||
| criticality | SΣ | 0..1 | code | low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance. | ||||
| code | SΣ | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: Common substances for allergy and intolerance documentation including refutations (extensible) | ||||
| patient | SΣ | 1..1 | Reference(QICore Patient) | Who the sensitivity is for | ||||
| encounter | S | 0..1 | Reference(QICore Encounter) | 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(QICore Practitioner | QICore PractitionerRole | QICore Patient | QICore RelatedPerson) | Who recorded the sensitivity | |||||
| asserter | Σ | 0..1 | Reference(QICore Practitioner | QICore PractitionerRole | QICore Patient | QICore RelatedPerson) | 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 | S | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| reaction-duration | S | 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): Codes defining the type of the substance (including pharmaceutical products). | |||||
| manifestation | S | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: SNOMEDCTClinicalFindings (extensible) | ||||
| 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): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations. | ||||
| exposureRoute | 0..1 | CodeableConcept | How the subject was exposed to the substance Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. | |||||
| note | 0..* | Annotation | Text about event not captured in other fields | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| AllergyIntolerance.language | preferred | CommonLanguages
| ||||
| AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatusCodes | ||||
| AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatusCodes | ||||
| AllergyIntolerance.type | required | AllergyIntoleranceType | ||||
| AllergyIntolerance.category | required | AllergyIntoleranceCategory | ||||
| AllergyIntolerance.criticality | required | AllergyIntoleranceCriticality | ||||
| AllergyIntolerance.code | extensible | Common substances for allergy and intolerance documentation including refutations | ||||
| AllergyIntolerance.reaction.substance | example | SubstanceCode | ||||
| AllergyIntolerance.reaction.manifestation | extensible | SNOMEDCTClinicalFindings | ||||
| AllergyIntolerance.reaction.severity | required | AllergyIntoleranceSeverity | ||||
| AllergyIntolerance.reaction.exposureRoute | example | SNOMEDCTRouteCodes |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from USCoreAllergyIntolerance
Summary
Mandatory: 1 element
Must-Support: 10 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from USCoreAllergyIntolerance
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AllergyIntolerance | C | 0..* | USCoreAllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) 1: extension: reasonRefuted is only permitted if status is refuted |
| resolutionAge | 0..1 | Age | Age that the allergy or intolerance resolved URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-resolutionAge | |
| type | S | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) |
| category | S | 0..* | code | food | medication | environment | biologic |
| criticality | S | 0..1 | code | low | high | unable-to-assess |
| patient | S | 1..1 | Reference(QICore Patient) | Who the sensitivity is for |
| encounter | S | 0..1 | Reference(QICore Encounter) | 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(QICore Practitioner | QICore PractitionerRole | QICore Patient | QICore RelatedPerson) | Who recorded the sensitivity | |
| asserter | 0..1 | Reference(QICore Practitioner | QICore PractitionerRole | QICore Patient | QICore RelatedPerson) | Source of the information about the allergy | |
| reaction | S | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance |
| reaction-duration | S | 0..1 | Duration | How long Manifestations persisted URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-duration |
| onset | S | 0..1 | dateTime | Date(/time) when manifestations showed |
| severity | S | 0..1 | code | mild | moderate | severe (of event as a whole) |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| 1 | error | 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() |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AllergyIntolerance | C | 0..* | USCoreAllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) 1: extension: reasonRefuted is only permitted if status is refuted |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| resolutionAge | 0..1 | Age | Age that the allergy or intolerance resolved URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-resolutionAge | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| clinicalStatus | ?!SΣC | 0..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required) |
| verificationStatus | ?!SΣC | 0..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): Identification of the underlying physiological mechanism for a Reaction Risk. |
| category | SΣ | 0..* | code | food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances. |
| criticality | SΣ | 0..1 | code | low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance. |
| code | SΣ | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: Common substances for allergy and intolerance documentation including refutations (extensible) |
| patient | SΣ | 1..1 | Reference(QICore Patient) | Who the sensitivity is for |
| encounter | S | 0..1 | Reference(QICore Encounter) | 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(QICore Practitioner | QICore PractitionerRole | QICore Patient | QICore RelatedPerson) | Who recorded the sensitivity | |
| asserter | Σ | 0..1 | Reference(QICore Practitioner | QICore PractitionerRole | QICore Patient | QICore RelatedPerson) | Source of the information about the allergy |
| reaction | S | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance |
| reaction-duration | S | 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 |
| manifestation | S | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: SNOMEDCTClinicalFindings (extensible) |
| 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): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatusCodes |
| AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatusCodes |
| AllergyIntolerance.type | required | AllergyIntoleranceType |
| AllergyIntolerance.category | required | AllergyIntoleranceCategory |
| AllergyIntolerance.criticality | required | AllergyIntoleranceCriticality |
| AllergyIntolerance.code | extensible | Common substances for allergy and intolerance documentation including refutations |
| AllergyIntolerance.reaction.manifestation | extensible | SNOMEDCTClinicalFindings |
| AllergyIntolerance.reaction.severity | required | AllergyIntoleranceSeverity |
| Id | Grade | Path(s) | Details | Requirements |
| 1 | error | 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() | |
| ait-1 | error | AllergyIntolerance | AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists() | |
| ait-2 | error | AllergyIntolerance | AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty() | |
| dom-2 | error | AllergyIntolerance | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | 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-4 | error | 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-5 | error | AllergyIntolerance | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | AllergyIntolerance | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| AllergyIntolerance | C | 0..* | USCoreAllergyIntolerance | 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): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| resolutionAge | 0..1 | Age | Age that the allergy or intolerance resolved URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-resolutionAge | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | External ids for this item | ||||
| clinicalStatus | ?!SΣC | 0..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required) | ||||
| verificationStatus | ?!SΣC | 0..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): Identification of the underlying physiological mechanism for a Reaction Risk. | ||||
| category | SΣ | 0..* | code | food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances. | ||||
| criticality | SΣ | 0..1 | code | low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance. | ||||
| code | SΣ | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: Common substances for allergy and intolerance documentation including refutations (extensible) | ||||
| patient | SΣ | 1..1 | Reference(QICore Patient) | Who the sensitivity is for | ||||
| encounter | S | 0..1 | Reference(QICore Encounter) | 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(QICore Practitioner | QICore PractitionerRole | QICore Patient | QICore RelatedPerson) | Who recorded the sensitivity | |||||
| asserter | Σ | 0..1 | Reference(QICore Practitioner | QICore PractitionerRole | QICore Patient | QICore RelatedPerson) | 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 | S | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| reaction-duration | S | 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): Codes defining the type of the substance (including pharmaceutical products). | |||||
| manifestation | S | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: SNOMEDCTClinicalFindings (extensible) | ||||
| 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): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations. | ||||
| exposureRoute | 0..1 | CodeableConcept | How the subject was exposed to the substance Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. | |||||
| note | 0..* | Annotation | Text about event not captured in other fields | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| AllergyIntolerance.language | preferred | CommonLanguages
| ||||
| AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatusCodes | ||||
| AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatusCodes | ||||
| AllergyIntolerance.type | required | AllergyIntoleranceType | ||||
| AllergyIntolerance.category | required | AllergyIntoleranceCategory | ||||
| AllergyIntolerance.criticality | required | AllergyIntoleranceCriticality | ||||
| AllergyIntolerance.code | extensible | Common substances for allergy and intolerance documentation including refutations | ||||
| AllergyIntolerance.reaction.substance | example | SubstanceCode | ||||
| AllergyIntolerance.reaction.manifestation | extensible | SNOMEDCTClinicalFindings | ||||
| AllergyIntolerance.reaction.severity | required | AllergyIntoleranceSeverity | ||||
| AllergyIntolerance.reaction.exposureRoute | example | SNOMEDCTRouteCodes |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from USCoreAllergyIntolerance
Summary
Mandatory: 1 element
Must-Support: 10 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron
IG © 2019+ http://www.hl7.org/Special/committees/cqi/index.cfm. Package hl7.fhir.us.qicore#5.0.0 based on FHIR 4.0.1. Generated 2023-04-04
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change