Smart Health Checks
0.3.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.3.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.3.0 | |||
Draft as of 2025-09-05 | 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 record, search and save allergy or intolerance information when used within Smart Health Checks.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Path | Conformance | ValueSet | URI |
AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1 From the FHIR Standard | |
AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1 From the FHIR Standard | |
AllergyIntolerance.code | extensible | IndicatorOfHypersensitivityOrIntoleranceToSubstance ![]() https://healthterminologies.gov.au/fhir/ValueSet/indicator-hypersensitivity-intolerance-to-substance-2 | |
AllergyIntolerance.reaction.manifestation | preferred | ClinicalFinding ![]() https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 | |
AllergyIntolerance.reaction.severity | required | AllergyIntoleranceSeverityhttp://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1 From 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 AUCoreAllergyIntolerance
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | AUCoreAllergyIntolerance | An allergy or intolerance statement in an Australian healthcare context | |||||||||||
![]() ![]() ![]() |
SO | 0..1 | id | Logical id of this artifact
| ||||||||||
![]() ![]() ![]() |
O | 0..1 | CodeableConcept | active | inactive | resolved
| ||||||||||
![]() ![]() ![]() |
O | 0..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error
| ||||||||||
![]() ![]() ![]() |
O | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance
| ||||||||||
![]() ![]() ![]() |
O | 1..1 | Reference(AU Core Patient) | Who the sensitivity is for
| ||||||||||
![]() ![]() ![]() |
S | 0..1 | Annotation | Additional text not captured in other fields | ||||||||||
![]() ![]() ![]() ![]() |
SO | 1..1 | markdown | The annotation - text content (as markdown)
| ||||||||||
![]() ![]() ![]() |
||||||||||||||
![]() ![]() ![]() ![]() |
O | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event
| ||||||||||
![]() |
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | AUCoreAllergyIntolerance | An allergy or intolerance statement in an Australian healthcare context Constraints: ait-1, ait-2 | |||||||||||||||||||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | id | Logical id of this artifact
| |||||||||||||||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | |||||||||||||||||||||||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | |||||||||||||||||||||||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| ||||||||||||||||||||||||||
![]() ![]() ![]() |
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 | ||||||||||||||||||||||||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | ||||||||||||||||||||||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | ||||||||||||||||||||||||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | |||||||||||||||||||||||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | External ids for this item | |||||||||||||||||||||||||
![]() ![]() ![]() |
?!SOΣC | 0..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
| |||||||||||||||||||||||||
![]() ![]() ![]() |
?!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.
| |||||||||||||||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk. | |||||||||||||||||||||||||
![]() ![]() ![]() |
Σ | 0..* | code | food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances. | |||||||||||||||||||||||||
![]() ![]() ![]() |
Σ | 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. | |||||||||||||||||||||||||
![]() ![]() ![]() |
SOΣ | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: Indicator of Hypersensitivity or Intolerance to Substance ![]()
| |||||||||||||||||||||||||
![]() ![]() ![]() |
SOΣ | 1..1 | Reference(AU Core Patient) | Who the sensitivity is for
| |||||||||||||||||||||||||
![]() ![]() ![]() |
0..1 | Reference(Encounter) | Encounter when the allergy or intolerance was asserted | ||||||||||||||||||||||||||
![]() ![]() ![]() |
SO | 0..1 | When allergy or intolerance was identified
| ||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
dateTime | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
Age | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
Period | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
Range | ||||||||||||||||||||||||||||
![]() ![]() ![]() |
0..1 | dateTime | Date first version of the resource instance was recorded | ||||||||||||||||||||||||||
![]() ![]() ![]() |
0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | Who recorded the sensitivity | ||||||||||||||||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | Source of the information about the allergy | |||||||||||||||||||||||||
![]() ![]() ![]() |
0..1 | dateTime | Date(/time) of last known occurrence of a reaction | ||||||||||||||||||||||||||
![]() ![]() ![]() |
S | 0..1 | Annotation | Additional text not captured in other fields | |||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Individual responsible for the annotation | ||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
Reference(Practitioner | Patient | RelatedPerson | Organization) | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
string | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | dateTime | When the annotation was made | |||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
SOΣ | 1..1 | markdown | The annotation - text content (as markdown)
| |||||||||||||||||||||||||
![]() ![]() ![]() |
SO | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance
| |||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | ||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Specific substance or pharmaceutical product considered to be responsible for event Binding: Adverse Reaction Agent ![]() | ||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
SO | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: Clinical Finding ![]()
| |||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Description of the event as a whole | ||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
0..1 | dateTime | Date(/time) when manifestations showed | ||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
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.
| |||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | How the subject was exposed to the substance Binding: Route of Administration ![]() | ||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
0..* | Annotation | Text about event not captured in other fields | ||||||||||||||||||||||||||
![]() |
Path | Conformance | ValueSet | URI | |||
AllergyIntolerance.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages From the FHIR Standard
| ||||
AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1 From the FHIR Standard | ||||
AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1 From the FHIR Standard | ||||
AllergyIntolerance.type | required | AllergyIntoleranceTypehttp://hl7.org/fhir/ValueSet/allergy-intolerance-type|4.0.1 From the FHIR Standard | ||||
AllergyIntolerance.category | required | AllergyIntoleranceCategoryhttp://hl7.org/fhir/ValueSet/allergy-intolerance-category|4.0.1 From the FHIR Standard | ||||
AllergyIntolerance.criticality | required | AllergyIntoleranceCriticalityhttp://hl7.org/fhir/ValueSet/allergy-intolerance-criticality|4.0.1 From the FHIR Standard | ||||
AllergyIntolerance.code | extensible | IndicatorOfHypersensitivityOrIntoleranceToSubstance ![]() https://healthterminologies.gov.au/fhir/ValueSet/indicator-hypersensitivity-intolerance-to-substance-2 | ||||
AllergyIntolerance.reaction.substance | preferred | AdverseReactionAgent ![]() https://healthterminologies.gov.au/fhir/ValueSet/adverse-reaction-agent-1 | ||||
AllergyIntolerance.reaction.manifestation | preferred | ClinicalFinding ![]() https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 | ||||
AllergyIntolerance.reaction.severity | required | AllergyIntoleranceSeverityhttp://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1 From the FHIR Standard | ||||
AllergyIntolerance.reaction.exposureRoute | preferred | RouteOfAdministration ![]() https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 |
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 AUCoreAllergyIntolerance
Key Elements View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | AUCoreAllergyIntolerance | An allergy or intolerance statement in an Australian healthcare context Constraints: ait-1, ait-2 | |||||||||||||||||||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | id | Logical id of this artifact
| |||||||||||||||||||||||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | |||||||||||||||||||||||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | |||||||||||||||||||||||||
![]() ![]() ![]() |
?!SOΣC | 0..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
| |||||||||||||||||||||||||
![]() ![]() ![]() |
?!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.
| |||||||||||||||||||||||||
![]() ![]() ![]() |
SOΣ | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: Indicator of Hypersensitivity or Intolerance to Substance ![]()
| |||||||||||||||||||||||||
![]() ![]() ![]() |
SOΣ | 1..1 | Reference(AU Core Patient) | Who the sensitivity is for
| |||||||||||||||||||||||||
![]() ![]() ![]() |
SO | 0..1 | When allergy or intolerance was identified
| ||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
dateTime | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
Age | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
Period | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
Range | ||||||||||||||||||||||||||||
![]() ![]() ![]() |
S | 0..1 | Annotation | Additional text not captured in other fields | |||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
SOΣ | 1..1 | markdown | The annotation - text content (as markdown)
| |||||||||||||||||||||||||
![]() ![]() ![]() |
SO | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance
| |||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
SO | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: Clinical Finding ![]()
| |||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
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.
| |||||||||||||||||||||||||
![]() |
Path | Conformance | ValueSet | URI |
AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1 From the FHIR Standard | |
AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1 From the FHIR Standard | |
AllergyIntolerance.code | extensible | IndicatorOfHypersensitivityOrIntoleranceToSubstance ![]() https://healthterminologies.gov.au/fhir/ValueSet/indicator-hypersensitivity-intolerance-to-substance-2 | |
AllergyIntolerance.reaction.manifestation | preferred | ClinicalFinding ![]() https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 | |
AllergyIntolerance.reaction.severity | required | AllergyIntoleranceSeverityhttp://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1 From 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() |
Differential View
This structure is derived from AUCoreAllergyIntolerance
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | AUCoreAllergyIntolerance | An allergy or intolerance statement in an Australian healthcare context | |||||||||||
![]() ![]() ![]() |
SO | 0..1 | id | Logical id of this artifact
| ||||||||||
![]() ![]() ![]() |
O | 0..1 | CodeableConcept | active | inactive | resolved
| ||||||||||
![]() ![]() ![]() |
O | 0..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error
| ||||||||||
![]() ![]() ![]() |
O | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance
| ||||||||||
![]() ![]() ![]() |
O | 1..1 | Reference(AU Core Patient) | Who the sensitivity is for
| ||||||||||
![]() ![]() ![]() |
S | 0..1 | Annotation | Additional text not captured in other fields | ||||||||||
![]() ![]() ![]() ![]() |
SO | 1..1 | markdown | The annotation - text content (as markdown)
| ||||||||||
![]() ![]() ![]() |
||||||||||||||
![]() ![]() ![]() ![]() |
O | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event
| ||||||||||
![]() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | AUCoreAllergyIntolerance | An allergy or intolerance statement in an Australian healthcare context Constraints: ait-1, ait-2 | |||||||||||||||||||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | id | Logical id of this artifact
| |||||||||||||||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | |||||||||||||||||||||||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | |||||||||||||||||||||||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| ||||||||||||||||||||||||||
![]() ![]() ![]() |
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 | ||||||||||||||||||||||||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | ||||||||||||||||||||||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | ||||||||||||||||||||||||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | |||||||||||||||||||||||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | External ids for this item | |||||||||||||||||||||||||
![]() ![]() ![]() |
?!SOΣC | 0..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
| |||||||||||||||||||||||||
![]() ![]() ![]() |
?!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.
| |||||||||||||||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk. | |||||||||||||||||||||||||
![]() ![]() ![]() |
Σ | 0..* | code | food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances. | |||||||||||||||||||||||||
![]() ![]() ![]() |
Σ | 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. | |||||||||||||||||||||||||
![]() ![]() ![]() |
SOΣ | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: Indicator of Hypersensitivity or Intolerance to Substance ![]()
| |||||||||||||||||||||||||
![]() ![]() ![]() |
SOΣ | 1..1 | Reference(AU Core Patient) | Who the sensitivity is for
| |||||||||||||||||||||||||
![]() ![]() ![]() |
0..1 | Reference(Encounter) | Encounter when the allergy or intolerance was asserted | ||||||||||||||||||||||||||
![]() ![]() ![]() |
SO | 0..1 | When allergy or intolerance was identified
| ||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
dateTime | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
Age | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
Period | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
Range | ||||||||||||||||||||||||||||
![]() ![]() ![]() |
0..1 | dateTime | Date first version of the resource instance was recorded | ||||||||||||||||||||||||||
![]() ![]() ![]() |
0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | Who recorded the sensitivity | ||||||||||||||||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | Source of the information about the allergy | |||||||||||||||||||||||||
![]() ![]() ![]() |
0..1 | dateTime | Date(/time) of last known occurrence of a reaction | ||||||||||||||||||||||||||
![]() ![]() ![]() |
S | 0..1 | Annotation | Additional text not captured in other fields | |||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Individual responsible for the annotation | ||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
Reference(Practitioner | Patient | RelatedPerson | Organization) | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
string | ||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | dateTime | When the annotation was made | |||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
SOΣ | 1..1 | markdown | The annotation - text content (as markdown)
| |||||||||||||||||||||||||
![]() ![]() ![]() |
SO | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance
| |||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | ||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Specific substance or pharmaceutical product considered to be responsible for event Binding: Adverse Reaction Agent ![]() | ||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
SO | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: Clinical Finding ![]()
| |||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Description of the event as a whole | ||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
0..1 | dateTime | Date(/time) when manifestations showed | ||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
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.
| |||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | How the subject was exposed to the substance Binding: Route of Administration ![]() | ||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
0..* | Annotation | Text about event not captured in other fields | ||||||||||||||||||||||||||
![]() |
Path | Conformance | ValueSet | URI | |||
AllergyIntolerance.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages From the FHIR Standard
| ||||
AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1 From the FHIR Standard | ||||
AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1 From the FHIR Standard | ||||
AllergyIntolerance.type | required | AllergyIntoleranceTypehttp://hl7.org/fhir/ValueSet/allergy-intolerance-type|4.0.1 From the FHIR Standard | ||||
AllergyIntolerance.category | required | AllergyIntoleranceCategoryhttp://hl7.org/fhir/ValueSet/allergy-intolerance-category|4.0.1 From the FHIR Standard | ||||
AllergyIntolerance.criticality | required | AllergyIntoleranceCriticalityhttp://hl7.org/fhir/ValueSet/allergy-intolerance-criticality|4.0.1 From the FHIR Standard | ||||
AllergyIntolerance.code | extensible | IndicatorOfHypersensitivityOrIntoleranceToSubstance ![]() https://healthterminologies.gov.au/fhir/ValueSet/indicator-hypersensitivity-intolerance-to-substance-2 | ||||
AllergyIntolerance.reaction.substance | preferred | AdverseReactionAgent ![]() https://healthterminologies.gov.au/fhir/ValueSet/adverse-reaction-agent-1 | ||||
AllergyIntolerance.reaction.manifestation | preferred | ClinicalFinding ![]() https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 | ||||
AllergyIntolerance.reaction.severity | required | AllergyIntoleranceSeverityhttp://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1 From the FHIR Standard | ||||
AllergyIntolerance.reaction.exposureRoute | preferred | RouteOfAdministration ![]() https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 |
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 AUCoreAllergyIntolerance
Other representations of profile: CSV, Excel, Schematron