Smart Health Checks
0.4.0 - ci-build
Smart Health Checks
0.4.0 - ci-build
Smart Health Checks, published by AEHRC CSIRO. This guide is not an authorized publication; it is the continuous build for version 0.4.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/aehrc/smart-forms-ig/ and changes regularly. See the Directory of published versions
| Official URL: https://smartforms.csiro.au/ig/StructureDefinition/SHCAllergyIntolerance | Version: 0.4.0 | |||
| Draft as of 2026-04-23 | Computable Name: SmartHealthChecksAllergyIntolerance | |||
Copyright/Legal: Copyright © 2022+ Australian Government Department of Health and Aged Care - All rights reserved. This content is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License. See https://creativecommons.org/licenses/by-sa/4.0/. |
||||
This profile sets the minimum expectations for an AllergyIntolerance resource to search, record and save allergy or intolerance information when used within Smart Health Checks.
The following are supported usage scenarios for this profile:
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Path | Status | Usage | ValueSet | Version | Source |
| AllergyIntolerance.clinicalStatus | Base | required | Allergy Intolerance Clinical Status Minimal | 📦0.4.0 | This IG |
| AllergyIntolerance.verificationStatus | Base | required | AllergyIntolerance Verification Status Codes | 📍4.0.1 | FHIR Std. |
| AllergyIntolerance.code | Base | extensible |
Indicator of Hypersensitivity or Intolerance to Substance
|
⏿2.1.0 | tx.hl7.org.au |
| AllergyIntolerance.reaction.manifestation | Base | preferred |
Adverse Reaction Clinical Manifestation
|
⏿1.0.0 | tx.hl7.org.au |
| AllergyIntolerance.reaction.severity | Base | required | AllergyIntoleranceSeverity | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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 AUCoreAllergyIntolerance
| Name | Flags | Card. | Type | Description & Constraints Filter:   | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
  AllergyIntolerance |
0..* | AUCoreAllergyIntolerance | An allergy or intolerance statement in an Australian healthcare context | ||||||||||||||||
  id |
SO | 0..1 | id | Logical id of this artifact
| |||||||||||||||
| clinicalStatus |
O | 0..1 | CodeableConcept | active | inactive | resolved Binding: Allergy Intolerance Clinical Status Minimal (required)
| |||||||||||||||
| verificationStatus |
O | 0..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error
| |||||||||||||||
 code |
O | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance
| |||||||||||||||
  text |
SO | 0..1 | string | Plain text representation of the concept
| |||||||||||||||
| patient |
O | 1..1 | Reference(AU Core Patient) | Who the sensitivity is for
| |||||||||||||||
| note |
0..1 | Annotation | Additional text not captured in other fields | ||||||||||||||||
| text |
SO | 1..1 | markdown | The annotation - text content (as markdown)
| |||||||||||||||
 reaction |
|||||||||||||||||||
 manifestation |
O | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event
| |||||||||||||||
| Documentation for this format | |||||||||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| AllergyIntolerance.clinicalStatus | Base | required | Allergy Intolerance Clinical Status Minimal | 📦0.4.0 | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| AllergyIntolerance |
C | 0..* | AUCoreAllergyIntolerance | An allergy or intolerance statement in an Australian healthcare context Constraints: ait-1, ait-2 | |||||||||||||||||||||||||
 id |
SOΣ | 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | ||||||||||||||||||||||||||
| contained |
0..* | Resource | Contained, inline Resources | ||||||||||||||||||||||||||
 extension |
0..* | Extension | Additional content defined by implementations | ||||||||||||||||||||||||||
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | |||||||||||||||||||||||||
| identifier |
Σ | 0..* | Identifier | External ids for this item | |||||||||||||||||||||||||
| clinicalStatus |
?!SOΣC | 0..1 | CodeableConcept | active | inactive | resolved Binding: Allergy Intolerance Clinical Status Minimal (required)
| |||||||||||||||||||||||||
| verificationStatus |
?!SOΣC | 0..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
| |||||||||||||||||||||||||
| type |
Σ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk. | |||||||||||||||||||||||||
| category |
Σ | 0..* | code | food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances. | |||||||||||||||||||||||||
| criticality |
Σ | 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 |
SOΣ | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: Indicator of Hypersensitivity or Intolerance to Substance (extensible)
| |||||||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||||||||||||||||||||||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | |||||||||||||||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| |||||||||||||||||||||||||
 patient |
SOΣ | 1..1 | Reference(AU Core Patient) | Who the sensitivity is for
| |||||||||||||||||||||||||
| encounter |
0..1 | Reference(Encounter) | Encounter when the allergy or intolerance was asserted | ||||||||||||||||||||||||||
 onset[x] |
SO | 0..1 | When allergy or intolerance was identified
| ||||||||||||||||||||||||||
| onsetDateTime |
dateTime S | ||||||||||||||||||||||||||||
| onsetAge |
Age | ||||||||||||||||||||||||||||
| onsetPeriod |
Period | ||||||||||||||||||||||||||||
| onsetRange |
Range | ||||||||||||||||||||||||||||
| recordedDate |
0..1 | dateTime | 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 |
SO | 0..1 | Annotation | Additional text not captured in other fields
| |||||||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||||||||||||||||||||||||
| author[x] |
Σ | 0..1 | Individual responsible for the annotation | ||||||||||||||||||||||||||
| authorReference |
Reference(Practitioner | Patient | RelatedPerson | Organization) | ||||||||||||||||||||||||||||
| authorString |
string | ||||||||||||||||||||||||||||
| time |
Σ | 0..1 | dateTime | When the annotation was made | |||||||||||||||||||||||||
| text |
SOΣ | 1..1 | markdown | The annotation - text content (as markdown)
| |||||||||||||||||||||||||
| reaction |
SO | 0..* | BackboneElement | 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: Adverse Reaction Agent (preferred) | ||||||||||||||||||||||||||
| manifestation |
SO | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: Adverse Reaction Clinical Manifestation (preferred)
| |||||||||||||||||||||||||
| description |
0..1 | string | Description of the event as a whole | ||||||||||||||||||||||||||
| onset |
0..1 | dateTime | Date(/time) when manifestations showed | ||||||||||||||||||||||||||
| severity |
SO | 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: Route of Administration (preferred) | ||||||||||||||||||||||||||
| note |
0..* | Annotation | Text about event not captured in other fields | ||||||||||||||||||||||||||
| Documentation for this format | |||||||||||||||||||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| AllergyIntolerance.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| AllergyIntolerance.clinicalStatus | Base | required | Allergy Intolerance Clinical Status Minimal | 📦0.4.0 | This IG |
| AllergyIntolerance.verificationStatus | Base | required | AllergyIntolerance Verification Status Codes | 📍4.0.1 | FHIR Std. |
| AllergyIntolerance.type | Base | required | AllergyIntoleranceType | 📍4.0.1 | FHIR Std. |
| AllergyIntolerance.category | Base | required | AllergyIntoleranceCategory | 📍4.0.1 | FHIR Std. |
| AllergyIntolerance.criticality | Base | required | AllergyIntoleranceCriticality | 📍4.0.1 | FHIR Std. |
| AllergyIntolerance.code | Base | extensible |
Indicator of Hypersensitivity or Intolerance to Substance
|
⏿2.1.0 | tx.hl7.org.au |
| AllergyIntolerance.reaction.substance | Base | preferred |
Adverse Reaction Agent
|
⏿1.1.1 | tx.hl7.org.au |
| AllergyIntolerance.reaction.manifestation | Base | preferred |
Adverse Reaction Clinical Manifestation
|
⏿1.0.0 | tx.hl7.org.au |
| AllergyIntolerance.reaction.severity | Base | required | AllergyIntoleranceSeverity | 📍4.0.1 | FHIR Std. |
| AllergyIntolerance.reaction.exposureRoute | Base | preferred |
Route of Administration
|
⏿1.0.2 | tx.hl7.org.au |
| Id | Grade | Path(s) | Description | Expression |
| 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 AUCoreAllergyIntolerance
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| AllergyIntolerance |
C | 0..* | AUCoreAllergyIntolerance | An allergy or intolerance statement in an Australian healthcare context Constraints: ait-1, ait-2 | |||||||||||||||||||||||||
| id |
SOΣ | 0..1 | id | Logical id of this artifact
| |||||||||||||||||||||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | |||||||||||||||||||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | |||||||||||||||||||||||||
| clinicalStatus |
?!SOΣC | 0..1 | CodeableConcept | active | inactive | resolved Binding: Allergy Intolerance Clinical Status Minimal (required)
| |||||||||||||||||||||||||
| verificationStatus |
?!SOΣC | 0..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
| |||||||||||||||||||||||||
| code |
SOΣ | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: Indicator of Hypersensitivity or Intolerance to Substance (extensible)
| |||||||||||||||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| |||||||||||||||||||||||||
| patient |
SOΣ | 1..1 | Reference(AU Core Patient) | Who the sensitivity is for
| |||||||||||||||||||||||||
| onset[x] |
SO | 0..1 | When allergy or intolerance was identified
| ||||||||||||||||||||||||||
| onsetDateTime |
dateTime S | ||||||||||||||||||||||||||||
| onsetAge |
Age | ||||||||||||||||||||||||||||
| onsetPeriod |
Period | ||||||||||||||||||||||||||||
| onsetRange |
Range | ||||||||||||||||||||||||||||
| note |
SO | 0..1 | Annotation | Additional text not captured in other fields
| |||||||||||||||||||||||||
| text |
SOΣ | 1..1 | markdown | The annotation - text content (as markdown)
| |||||||||||||||||||||||||
| reaction |
SO | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance
| |||||||||||||||||||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||||||||||||||||
| manifestation |
SO | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: Adverse Reaction Clinical Manifestation (preferred)
| |||||||||||||||||||||||||
| severity |
SO | 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 | Status | Usage | ValueSet | Version | Source |
| AllergyIntolerance.clinicalStatus | Base | required | Allergy Intolerance Clinical Status Minimal | 📦0.4.0 | This IG |
| AllergyIntolerance.verificationStatus | Base | required | AllergyIntolerance Verification Status Codes | 📍4.0.1 | FHIR Std. |
| AllergyIntolerance.code | Base | extensible |
Indicator of Hypersensitivity or Intolerance to Substance
|
⏿2.1.0 | tx.hl7.org.au |
| AllergyIntolerance.reaction.manifestation | Base | preferred |
Adverse Reaction Clinical Manifestation
|
⏿1.0.0 | tx.hl7.org.au |
| AllergyIntolerance.reaction.severity | Base | required | AllergyIntoleranceSeverity | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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()
|
Differential View
This structure is derived from AUCoreAllergyIntolerance
| Name | Flags | Card. | Type | Description & Constraints Filter: | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| AllergyIntolerance |
0..* | AUCoreAllergyIntolerance | An allergy or intolerance statement in an Australian healthcare context | ||||||||||||||||
| id |
SO | 0..1 | id | Logical id of this artifact
| |||||||||||||||
| clinicalStatus |
O | 0..1 | CodeableConcept | active | inactive | resolved Binding: Allergy Intolerance Clinical Status Minimal (required)
| |||||||||||||||
| verificationStatus |
O | 0..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error
| |||||||||||||||
| code |
O | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance
| |||||||||||||||
| text |
SO | 0..1 | string | Plain text representation of the concept
| |||||||||||||||
| patient |
O | 1..1 | Reference(AU Core Patient) | Who the sensitivity is for
| |||||||||||||||
| note |
0..1 | Annotation | Additional text not captured in other fields | ||||||||||||||||
| text |
SO | 1..1 | markdown | The annotation - text content (as markdown)
| |||||||||||||||
| reaction |
|||||||||||||||||||
| manifestation |
O | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event
| |||||||||||||||
| Documentation for this format | |||||||||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| AllergyIntolerance.clinicalStatus | Base | required | Allergy Intolerance Clinical Status Minimal | 📦0.4.0 | This IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| AllergyIntolerance |
C | 0..* | AUCoreAllergyIntolerance | An allergy or intolerance statement in an Australian healthcare context Constraints: ait-1, ait-2 | |||||||||||||||||||||||||
| id |
SOΣ | 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | ||||||||||||||||||||||||||
| contained |
0..* | Resource | Contained, inline Resources | ||||||||||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | ||||||||||||||||||||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | |||||||||||||||||||||||||
| identifier |
Σ | 0..* | Identifier | External ids for this item | |||||||||||||||||||||||||
| clinicalStatus |
?!SOΣC | 0..1 | CodeableConcept | active | inactive | resolved Binding: Allergy Intolerance Clinical Status Minimal (required)
| |||||||||||||||||||||||||
| verificationStatus |
?!SOΣC | 0..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
| |||||||||||||||||||||||||
| type |
Σ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk. | |||||||||||||||||||||||||
| category |
Σ | 0..* | code | food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances. | |||||||||||||||||||||||||
| criticality |
Σ | 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 |
SOΣ | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: Indicator of Hypersensitivity or Intolerance to Substance (extensible)
| |||||||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||||||||||||||||||||||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | |||||||||||||||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| |||||||||||||||||||||||||
| patient |
SOΣ | 1..1 | Reference(AU Core Patient) | Who the sensitivity is for
| |||||||||||||||||||||||||
| encounter |
0..1 | Reference(Encounter) | Encounter when the allergy or intolerance was asserted | ||||||||||||||||||||||||||
| onset[x] |
SO | 0..1 | When allergy or intolerance was identified
| ||||||||||||||||||||||||||
| onsetDateTime |
dateTime S | ||||||||||||||||||||||||||||
| onsetAge |
Age | ||||||||||||||||||||||||||||
| onsetPeriod |
Period | ||||||||||||||||||||||||||||
| onsetRange |
Range | ||||||||||||||||||||||||||||
| recordedDate |
0..1 | dateTime | 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 |
SO | 0..1 | Annotation | Additional text not captured in other fields
| |||||||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||||||||||||||||||||||||
| author[x] |
Σ | 0..1 | Individual responsible for the annotation | ||||||||||||||||||||||||||
| authorReference |
Reference(Practitioner | Patient | RelatedPerson | Organization) | ||||||||||||||||||||||||||||
| authorString |
string | ||||||||||||||||||||||||||||
| time |
Σ | 0..1 | dateTime | When the annotation was made | |||||||||||||||||||||||||
| text |
SOΣ | 1..1 | markdown | The annotation - text content (as markdown)
| |||||||||||||||||||||||||
| reaction |
SO | 0..* | BackboneElement | 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: Adverse Reaction Agent (preferred) | ||||||||||||||||||||||||||
| manifestation |
SO | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: Adverse Reaction Clinical Manifestation (preferred)
| |||||||||||||||||||||||||
| description |
0..1 | string | Description of the event as a whole | ||||||||||||||||||||||||||
| onset |
0..1 | dateTime | Date(/time) when manifestations showed | ||||||||||||||||||||||||||
| severity |
SO | 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: Route of Administration (preferred) | ||||||||||||||||||||||||||
| note |
0..* | Annotation | Text about event not captured in other fields | ||||||||||||||||||||||||||
| Documentation for this format | |||||||||||||||||||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| AllergyIntolerance.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| AllergyIntolerance.clinicalStatus | Base | required | Allergy Intolerance Clinical Status Minimal | 📦0.4.0 | This IG |
| AllergyIntolerance.verificationStatus | Base | required | AllergyIntolerance Verification Status Codes | 📍4.0.1 | FHIR Std. |
| AllergyIntolerance.type | Base | required | AllergyIntoleranceType | 📍4.0.1 | FHIR Std. |
| AllergyIntolerance.category | Base | required | AllergyIntoleranceCategory | 📍4.0.1 | FHIR Std. |
| AllergyIntolerance.criticality | Base | required | AllergyIntoleranceCriticality | 📍4.0.1 | FHIR Std. |
| AllergyIntolerance.code | Base | extensible |
Indicator of Hypersensitivity or Intolerance to Substance
|
⏿2.1.0 | tx.hl7.org.au |
| AllergyIntolerance.reaction.substance | Base | preferred |
Adverse Reaction Agent
|
⏿1.1.1 | tx.hl7.org.au |
| AllergyIntolerance.reaction.manifestation | Base | preferred |
Adverse Reaction Clinical Manifestation
|
⏿1.0.0 | tx.hl7.org.au |
| AllergyIntolerance.reaction.severity | Base | required | AllergyIntoleranceSeverity | 📍4.0.1 | FHIR Std. |
| AllergyIntolerance.reaction.exposureRoute | Base | preferred |
Route of Administration
|
⏿1.0.2 | tx.hl7.org.au |
| Id | Grade | Path(s) | Description | Expression |
| 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 AUCoreAllergyIntolerance
Other representations of profile: CSV, Excel, Schematron