QI-Core Implementation Guide
6.0.0 - STU6
QI-Core Implementation Guide
6.0.0 - STU6
This page is part of the Quality Improvement Core Framework (v6.0.0: STU6 (v6.0.0)) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. 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: 6.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 | 0..* | USCoreAllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) | |
  resolutionAge | 0..1 | Age | Age that the allergy or intolerance resolved URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-resolutionAge | |
 type | 0..1 | code | (QI-Core) allergy | intolerance - Underlying mechanism (if known) | |
| category | 0..* | code | (QI-Core) food | medication | environment | biologic | |
| criticality | 0..1 | code | (QI-Core) low | high | unable-to-assess | |
 patient | 1..1 | Reference(QICore Patient) | (QI-Core)(USCDI) Who the sensitivity is for | |
  onset[x] | 0..1 | When allergy or intolerance was identified | ||
  onsetDateTime | dateTime | |||
 onsetAge | Age | |||
| onsetPeriod | Period | |||
 onsetRange | Range | |||
| recordedDate | 0..1 | dateTime | (QI-Core) Date first version of the resource instance was recorded | |
 reaction | 0..* | BackboneElement | (QI-Core)(USCDI) Adverse Reaction Events linked to exposure to substance | |
 severity | 0..1 | code | (QI-Core) mild | moderate | severe (of event as a whole) | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AllergyIntolerance | C | 0..* | USCoreAllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) ait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error |
| 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 | (USCDI) active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required) |
| verificationStatus | ?!SΣC | 0..1 | CodeableConcept | (USCDI) unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatusCodes (required) |
| type | Σ | 0..1 | code | (QI-Core) allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk. |
| category | Σ | 0..* | code | (QI-Core) food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances. |
| criticality | Σ | 0..1 | code | (QI-Core) 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 | (USCDI) 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) | (QI-Core)(USCDI) Who the sensitivity is for |
| onset[x] | 0..1 | When allergy or intolerance was identified | ||
| onsetDateTime | dateTime | |||
| onsetAge | Age | |||
| onsetPeriod | Period | |||
| onsetRange | Range | |||
| recordedDate | 0..1 | dateTime | (QI-Core) Date first version of the resource instance was recorded | |
| reaction | S | 0..* | BackboneElement | (QI-Core)(USCDI) Adverse Reaction Events linked to exposure to substance |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| manifestation | S | 1..* | CodeableConcept | (USCDI) Clinical symptoms/signs associated with the Event Binding: SNOMEDCTClinicalFindings (extensible) |
| severity | 0..1 | code | (QI-Core) 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 | URI |
| AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-clinicalfrom the FHIR Standard | |
| AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-verificationfrom the FHIR Standard | |
| AllergyIntolerance.type | required | AllergyIntoleranceTypehttp://hl7.org/fhir/ValueSet/allergy-intolerance-type|4.0.1from the FHIR Standard | |
| AllergyIntolerance.category | required | AllergyIntoleranceCategoryhttp://hl7.org/fhir/ValueSet/allergy-intolerance-category|4.0.1from the FHIR Standard | |
| AllergyIntolerance.criticality | required | AllergyIntoleranceCriticalityhttp://hl7.org/fhir/ValueSet/allergy-intolerance-criticality|4.0.1from the FHIR Standard | |
| AllergyIntolerance.code | extensible | Common substances for allergy and intolerance documentation including refutations http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1186.8 | |
| AllergyIntolerance.reaction.manifestation | extensible | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findingsfrom the FHIR Standard | |
| AllergyIntolerance.reaction.severity | required | AllergyIntoleranceSeverityhttp://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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) ait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error | ||||
| 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 | (USCDI) active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required) | ||||
| verificationStatus | ?!SΣC | 0..1 | CodeableConcept | (USCDI) unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatusCodes (required) | ||||
| type | Σ | 0..1 | code | (QI-Core) allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk. | ||||
| category | Σ | 0..* | code | (QI-Core) food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances. | ||||
| criticality | Σ | 0..1 | code | (QI-Core) 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 | (USCDI) 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) | (QI-Core)(USCDI) Who the sensitivity is for | ||||
| encounter | 0..1 | Reference(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 | 0..1 | dateTime | (QI-Core) Date first version of the resource instance was recorded | |||||
| recorder | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | Who recorded the sensitivity | |||||
| asserter | Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | 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 | (QI-Core)(USCDI) Adverse Reaction Events linked to exposure to substance | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| 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 | (USCDI) Clinical symptoms/signs associated with the Event Binding: SNOMEDCTClinicalFindings (extensible) | ||||
| description | 0..1 | string | Description of the event as a whole | |||||
| onset | 0..1 | dateTime | Date(/time) when manifestations showed | |||||
| severity | 0..1 | code | (QI-Core) 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 | URI | |||
| AllergyIntolerance.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-clinicalfrom the FHIR Standard | ||||
| AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-verificationfrom the FHIR Standard | ||||
| AllergyIntolerance.type | required | AllergyIntoleranceTypehttp://hl7.org/fhir/ValueSet/allergy-intolerance-type|4.0.1from the FHIR Standard | ||||
| AllergyIntolerance.category | required | AllergyIntoleranceCategoryhttp://hl7.org/fhir/ValueSet/allergy-intolerance-category|4.0.1from the FHIR Standard | ||||
| AllergyIntolerance.criticality | required | AllergyIntoleranceCriticalityhttp://hl7.org/fhir/ValueSet/allergy-intolerance-criticality|4.0.1from the FHIR Standard | ||||
| AllergyIntolerance.code | extensible | Common substances for allergy and intolerance documentation including refutations http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1186.8 | ||||
| AllergyIntolerance.reaction.substance | example | SubstanceCodehttp://hl7.org/fhir/ValueSet/substance-codefrom the FHIR Standard | ||||
| AllergyIntolerance.reaction.manifestation | extensible | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findingsfrom the FHIR Standard | ||||
| AllergyIntolerance.reaction.severity | required | AllergyIntoleranceSeverityhttp://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1from the FHIR Standard | ||||
| AllergyIntolerance.reaction.exposureRoute | example | SNOMEDCTRouteCodeshttp://hl7.org/fhir/ValueSet/route-codesfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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() |
This structure is derived from USCoreAllergyIntolerance
Differential View
This structure is derived from USCoreAllergyIntolerance
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AllergyIntolerance | 0..* | USCoreAllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) | |
| resolutionAge | 0..1 | Age | Age that the allergy or intolerance resolved URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-resolutionAge | |
| type | 0..1 | code | (QI-Core) allergy | intolerance - Underlying mechanism (if known) | |
| category | 0..* | code | (QI-Core) food | medication | environment | biologic | |
| criticality | 0..1 | code | (QI-Core) low | high | unable-to-assess | |
| patient | 1..1 | Reference(QICore Patient) | (QI-Core)(USCDI) Who the sensitivity is for | |
| onset[x] | 0..1 | When allergy or intolerance was identified | ||
| onsetDateTime | dateTime | |||
| onsetAge | Age | |||
| onsetPeriod | Period | |||
| onsetRange | Range | |||
| recordedDate | 0..1 | dateTime | (QI-Core) Date first version of the resource instance was recorded | |
| reaction | 0..* | BackboneElement | (QI-Core)(USCDI) Adverse Reaction Events linked to exposure to substance | |
| severity | 0..1 | code | (QI-Core) mild | moderate | severe (of event as a whole) | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AllergyIntolerance | C | 0..* | USCoreAllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) ait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error |
| 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 | (USCDI) active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required) |
| verificationStatus | ?!SΣC | 0..1 | CodeableConcept | (USCDI) unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatusCodes (required) |
| type | Σ | 0..1 | code | (QI-Core) allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk. |
| category | Σ | 0..* | code | (QI-Core) food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances. |
| criticality | Σ | 0..1 | code | (QI-Core) 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 | (USCDI) 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) | (QI-Core)(USCDI) Who the sensitivity is for |
| onset[x] | 0..1 | When allergy or intolerance was identified | ||
| onsetDateTime | dateTime | |||
| onsetAge | Age | |||
| onsetPeriod | Period | |||
| onsetRange | Range | |||
| recordedDate | 0..1 | dateTime | (QI-Core) Date first version of the resource instance was recorded | |
| reaction | S | 0..* | BackboneElement | (QI-Core)(USCDI) Adverse Reaction Events linked to exposure to substance |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| manifestation | S | 1..* | CodeableConcept | (USCDI) Clinical symptoms/signs associated with the Event Binding: SNOMEDCTClinicalFindings (extensible) |
| severity | 0..1 | code | (QI-Core) 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 | URI |
| AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-clinicalfrom the FHIR Standard | |
| AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-verificationfrom the FHIR Standard | |
| AllergyIntolerance.type | required | AllergyIntoleranceTypehttp://hl7.org/fhir/ValueSet/allergy-intolerance-type|4.0.1from the FHIR Standard | |
| AllergyIntolerance.category | required | AllergyIntoleranceCategoryhttp://hl7.org/fhir/ValueSet/allergy-intolerance-category|4.0.1from the FHIR Standard | |
| AllergyIntolerance.criticality | required | AllergyIntoleranceCriticalityhttp://hl7.org/fhir/ValueSet/allergy-intolerance-criticality|4.0.1from the FHIR Standard | |
| AllergyIntolerance.code | extensible | Common substances for allergy and intolerance documentation including refutations http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1186.8 | |
| AllergyIntolerance.reaction.manifestation | extensible | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findingsfrom the FHIR Standard | |
| AllergyIntolerance.reaction.severity | required | AllergyIntoleranceSeverityhttp://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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) ait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error | ||||
| 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 | (USCDI) active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required) | ||||
| verificationStatus | ?!SΣC | 0..1 | CodeableConcept | (USCDI) unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatusCodes (required) | ||||
| type | Σ | 0..1 | code | (QI-Core) allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk. | ||||
| category | Σ | 0..* | code | (QI-Core) food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances. | ||||
| criticality | Σ | 0..1 | code | (QI-Core) 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 | (USCDI) 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) | (QI-Core)(USCDI) Who the sensitivity is for | ||||
| encounter | 0..1 | Reference(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 | 0..1 | dateTime | (QI-Core) Date first version of the resource instance was recorded | |||||
| recorder | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | Who recorded the sensitivity | |||||
| asserter | Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | 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 | (QI-Core)(USCDI) Adverse Reaction Events linked to exposure to substance | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| 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 | (USCDI) Clinical symptoms/signs associated with the Event Binding: SNOMEDCTClinicalFindings (extensible) | ||||
| description | 0..1 | string | Description of the event as a whole | |||||
| onset | 0..1 | dateTime | Date(/time) when manifestations showed | |||||
| severity | 0..1 | code | (QI-Core) 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 | URI | |||
| AllergyIntolerance.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-clinicalfrom the FHIR Standard | ||||
| AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-verificationfrom the FHIR Standard | ||||
| AllergyIntolerance.type | required | AllergyIntoleranceTypehttp://hl7.org/fhir/ValueSet/allergy-intolerance-type|4.0.1from the FHIR Standard | ||||
| AllergyIntolerance.category | required | AllergyIntoleranceCategoryhttp://hl7.org/fhir/ValueSet/allergy-intolerance-category|4.0.1from the FHIR Standard | ||||
| AllergyIntolerance.criticality | required | AllergyIntoleranceCriticalityhttp://hl7.org/fhir/ValueSet/allergy-intolerance-criticality|4.0.1from the FHIR Standard | ||||
| AllergyIntolerance.code | extensible | Common substances for allergy and intolerance documentation including refutations http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1186.8 | ||||
| AllergyIntolerance.reaction.substance | example | SubstanceCodehttp://hl7.org/fhir/ValueSet/substance-codefrom the FHIR Standard | ||||
| AllergyIntolerance.reaction.manifestation | extensible | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findingsfrom the FHIR Standard | ||||
| AllergyIntolerance.reaction.severity | required | AllergyIntoleranceSeverityhttp://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1from the FHIR Standard | ||||
| AllergyIntolerance.reaction.exposureRoute | example | SNOMEDCTRouteCodeshttp://hl7.org/fhir/ValueSet/route-codesfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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() |
This structure is derived from USCoreAllergyIntolerance
Other representations of profile: CSV, Excel, Schematron
IG © 2019+ HL7 International / Clinical Quality Information. Package hl7.fhir.us.qicore#6.0.0 based on FHIR 4.0.1. Generated 2024-03-01
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change