AU Core Implementation Guide
3.0.0-ci-build - CI Build
AU Core Implementation Guide
3.0.0-ci-build - CI Build
AU Core Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 3.0.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7au/au-fhir-core/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org.au/fhir/core/StructureDefinition/au-core-allergyintolerance | Version: 3.0.0-ci-build | |||
| Standards status: Trial-use | Maturity Level: 2 | Computable Name: AUCoreAllergyIntolerance | ||
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2022+; Licensed Under Creative Commons No Rights Reserved. |
||||
This profile sets minimum expectations for an AllergyIntolerance resource to record, search, and fetch allergies/adverse reactions associated with a patient. It is based on the AU Base AllergyIntolerance profile and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the AllergyIntolerance resource when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.
See Comparison with other national and international IGs for a comparison between AU Core profiles and profiles in other implementation guides.
The following are supported usage scenarios for this profile:
AllergyIntolerance.codeAllergyIntolerance.code.text and/or AllergyIntolerance.code.coding.display so that requesters can at least display the allergy or intolerance even if the requester does not recognise the code supplied.AllergyIntolerance.code and AllergyIntolerance.verificationStatus of "confirmed" or "unconfirmed"AllergyIntolerance.codeThe additional obligation for AllergyIntolerance.onsetDateTime for AU Core Responder is SHOULD:populate. There is no additional obligation for AU Core Requester, the obligation of SHALL:no-error applies.
This obligation is present in the underlying structure but due to a tooling limitation is not currently rendered in the Formal Views of Profile Content. See Zulip discussion for more information.
Usages:
You can also check for usages in the FHIR IG Statistics
Changes since version 2.0.0:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:  | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
  AllergyIntolerance |
C | 0..* | AUBaseAllergyIntolerance | An allergy or intolerance statement in an Australian healthcare context Constraints: ait-1, ait-2 | ||||||||||
  implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||||||||
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||||||||
 clinicalStatus |
C | 0..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
| ||||||||||
| verificationStatus |
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 |
1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: https://healthterminologies.gov.au/fhir/ValueSet/indicator-hypersensitivity-intolerance-to-substance-2 (extensible)
| |||||||||||
 patient |
1..1 | Reference(AU Core Patient) | Who the sensitivity is for
| |||||||||||
  onset[x] |
0..1 | When allergy or intolerance was identified
| ||||||||||||
 onsetDateTime |
dateTime | |||||||||||||
| onsetAge |
Age | |||||||||||||
| onsetPeriod |
Period | |||||||||||||
 onsetRange |
Range | |||||||||||||
| note |
0..* | Annotation | Additional text not captured in other fields
| |||||||||||
 reaction |
0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance
| |||||||||||
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||
| manifestation |
1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: https://healthterminologies.gov.au/fhir/ValueSet/adverse-reaction-clinical-manifestation-1 (preferred)
| |||||||||||
| severity |
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 | AllergyIntolerance Clinical Status Codes | 📍4.0.1 | FHIR Std. |
| AllergyIntolerance.verificationStatus | Base | required | AllergyIntolerance Verification Status Codes | 📍4.0.1 | FHIR Std. |
| AllergyIntolerance.code | Base | extensible | https://healthterminologies.gov.au/fhir/ValueSet/indicator-hypersensitivity-intolerance-to-substance-2 | Not State | Unknown |
| AllergyIntolerance.reaction.manifestation | Base | preferred | https://healthterminologies.gov.au/fhir/ValueSet/adverse-reaction-clinical-manifestation-1 | Not State | Unknown |
| 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 AUBaseAllergyIntolerance
| Path | Status | Usage | ValueSet | Version | Source |
| AllergyIntolerance.code | Base | extensible | https://healthterminologies.gov.au/fhir/ValueSet/indicator-hypersensitivity-intolerance-to-substance-2 | Not State | Unknown |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| AllergyIntolerance |
C | 0..* | AUBaseAllergyIntolerance | An allergy or intolerance statement in an Australian healthcare context Constraints: ait-1, ait-2 | ||||||||||
| 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 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 |
C | 0..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
| ||||||||||
| verificationStatus |
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 |
1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: https://healthterminologies.gov.au/fhir/ValueSet/indicator-hypersensitivity-intolerance-to-substance-2 (extensible)
| |||||||||||
| patient |
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] |
0..1 | When allergy or intolerance was identified
| ||||||||||||
| onsetDateTime |
dateTime | |||||||||||||
| 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 |
0..* | Annotation | Additional text not captured in other fields
| |||||||||||
| reaction |
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: https://healthterminologies.gov.au/fhir/ValueSet/adverse-reaction-agent-1 (preferred) | |||||||||||
| manifestation |
1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: https://healthterminologies.gov.au/fhir/ValueSet/adverse-reaction-clinical-manifestation-1 (preferred)
| |||||||||||
| description |
0..1 | string | Description of the event as a whole | |||||||||||
| onset |
0..1 | dateTime | Date(/time) when manifestations showed | |||||||||||
| severity |
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: https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 (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 | AllergyIntolerance Clinical Status Codes | 📍4.0.1 | FHIR Std. |
| 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 | https://healthterminologies.gov.au/fhir/ValueSet/indicator-hypersensitivity-intolerance-to-substance-2 | Not State | Unknown |
| AllergyIntolerance.reaction.substance | Base | preferred | https://healthterminologies.gov.au/fhir/ValueSet/adverse-reaction-agent-1 | Not State | Unknown |
| AllergyIntolerance.reaction.manifestation | Base | preferred | https://healthterminologies.gov.au/fhir/ValueSet/adverse-reaction-clinical-manifestation-1 | Not State | Unknown |
| AllergyIntolerance.reaction.severity | Base | required | AllergyIntoleranceSeverity | 📍4.0.1 | FHIR Std. |
| AllergyIntolerance.reaction.exposureRoute | Base | preferred | https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 | Not State | Unknown |
| 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 AUBaseAllergyIntolerance
Summary
Mandatory: 1 element
Must-Support: 9 elements
Structures
This structure refers to these other structures:
Maturity: 2
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| AllergyIntolerance |
C | 0..* | AUBaseAllergyIntolerance | An allergy or intolerance statement in an Australian healthcare context Constraints: ait-1, ait-2 | ||||||||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||||||||
| clinicalStatus |
C | 0..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
| ||||||||||
| verificationStatus |
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 |
1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: https://healthterminologies.gov.au/fhir/ValueSet/indicator-hypersensitivity-intolerance-to-substance-2 (extensible)
| |||||||||||
| patient |
1..1 | Reference(AU Core Patient) | Who the sensitivity is for
| |||||||||||
| onset[x] |
0..1 | When allergy or intolerance was identified
| ||||||||||||
| onsetDateTime |
dateTime | |||||||||||||
| onsetAge |
Age | |||||||||||||
| onsetPeriod |
Period | |||||||||||||
| onsetRange |
Range | |||||||||||||
| note |
0..* | Annotation | Additional text not captured in other fields
| |||||||||||
| reaction |
0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance
| |||||||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||
| manifestation |
1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: https://healthterminologies.gov.au/fhir/ValueSet/adverse-reaction-clinical-manifestation-1 (preferred)
| |||||||||||
| severity |
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 | AllergyIntolerance Clinical Status Codes | 📍4.0.1 | FHIR Std. |
| AllergyIntolerance.verificationStatus | Base | required | AllergyIntolerance Verification Status Codes | 📍4.0.1 | FHIR Std. |
| AllergyIntolerance.code | Base | extensible | https://healthterminologies.gov.au/fhir/ValueSet/indicator-hypersensitivity-intolerance-to-substance-2 | Not State | Unknown |
| AllergyIntolerance.reaction.manifestation | Base | preferred | https://healthterminologies.gov.au/fhir/ValueSet/adverse-reaction-clinical-manifestation-1 | Not State | Unknown |
| 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 AUBaseAllergyIntolerance
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| AllergyIntolerance |
0..* | AUBaseAllergyIntolerance | An allergy or intolerance statement in an Australian healthcare context | |||||||||||
 clinicalStatus |
0..1 | CodeableConcept | active | inactive | resolved
| |||||||||||
| verificationStatus |
0..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error
| |||||||||||
| code |
1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: https://healthterminologies.gov.au/fhir/ValueSet/indicator-hypersensitivity-intolerance-to-substance-2 (extensible)
| |||||||||||
| patient |
1..1 | Reference(AU Core Patient) | Who the sensitivity is for
| |||||||||||
| onset[x] |
0..1 | When allergy or intolerance was identified
| ||||||||||||
| onsetDateTime |
dateTime | |||||||||||||
| onsetAge |
Age | |||||||||||||
| onsetPeriod |
Period | |||||||||||||
| onsetRange |
Range | |||||||||||||
| note |
0..* | Annotation | Additional text not captured in other fields
| |||||||||||
| reaction |
0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance
| |||||||||||
| manifestation |
1..* | CodeableConcept | Clinical symptoms/signs associated with the Event
| |||||||||||
| severity |
0..1 | code | mild | moderate | severe (of event as a whole)
| |||||||||||
| Documentation for this format | ||||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| AllergyIntolerance.code | Base | extensible | https://healthterminologies.gov.au/fhir/ValueSet/indicator-hypersensitivity-intolerance-to-substance-2 | Not State | Unknown |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| AllergyIntolerance |
C | 0..* | AUBaseAllergyIntolerance | An allergy or intolerance statement in an Australian healthcare context Constraints: ait-1, ait-2 | ||||||||||
| 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 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 |
C | 0..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
| ||||||||||
| verificationStatus |
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 |
1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: https://healthterminologies.gov.au/fhir/ValueSet/indicator-hypersensitivity-intolerance-to-substance-2 (extensible)
| |||||||||||
| patient |
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] |
0..1 | When allergy or intolerance was identified
| ||||||||||||
| onsetDateTime |
dateTime | |||||||||||||
| 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 |
0..* | Annotation | Additional text not captured in other fields
| |||||||||||
| reaction |
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: https://healthterminologies.gov.au/fhir/ValueSet/adverse-reaction-agent-1 (preferred) | |||||||||||
| manifestation |
1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: https://healthterminologies.gov.au/fhir/ValueSet/adverse-reaction-clinical-manifestation-1 (preferred)
| |||||||||||
| description |
0..1 | string | Description of the event as a whole | |||||||||||
| onset |
0..1 | dateTime | Date(/time) when manifestations showed | |||||||||||
| severity |
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: https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 (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 | AllergyIntolerance Clinical Status Codes | 📍4.0.1 | FHIR Std. |
| 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 | https://healthterminologies.gov.au/fhir/ValueSet/indicator-hypersensitivity-intolerance-to-substance-2 | Not State | Unknown |
| AllergyIntolerance.reaction.substance | Base | preferred | https://healthterminologies.gov.au/fhir/ValueSet/adverse-reaction-agent-1 | Not State | Unknown |
| AllergyIntolerance.reaction.manifestation | Base | preferred | https://healthterminologies.gov.au/fhir/ValueSet/adverse-reaction-clinical-manifestation-1 | Not State | Unknown |
| AllergyIntolerance.reaction.severity | Base | required | AllergyIntoleranceSeverity | 📍4.0.1 | FHIR Std. |
| AllergyIntolerance.reaction.exposureRoute | Base | preferred | https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 | Not State | Unknown |
| 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 AUBaseAllergyIntolerance
Summary
Mandatory: 1 element
Must-Support: 9 elements
Structures
This structure refers to these other structures:
Maturity: 2
Other representations of profile: CSV, Excel, Schematron
Below is an overview of the mandatory and optional search parameters and combined search parameters. See the AU Core CapabilityStatements for a complete list of supported RESTful interactions for this IG.
FHIR search operations are described here and the syntax used to describe AU Core interactions is defined here.
Any search parameter defined in FHIR may be 'allowed' by the system unless explicitly marked as "SHALL NOT". A few items are marked as MAY in this implementation guide to highlight their potential relevance.
| Parameter(s) | Conformance | Type(s) | Requirements (when used alone or in combination) |
|---|---|---|---|
| patient | SHALL | reference |
The requester SHALL provide at least an id value and MAY provide both the type and id values. The responder SHALL support both. The requester SHOULD support chained search patient.identifier using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. The responder SHOULD support chained search patient.identifier using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. |
| patient+clinical-status | SHOULD | reference+token |
|
| clinical-status | MAY | token |
The requester SHALL provide at least a code value and MAY provide both the system and code values. The responder SHALL support both. |
The following search parameters and search parameter combinations SHALL be supported:
patient search parameter:
patient.identifier (e.g. patient.identifier=[system|][code])GET [base]/AllergyIntolerance?patient={type/}[id] or optionally GET [base]/AllergyIntolerance?patient.identifier=[system|][code]
Example:
Implementation Notes: Fetches a bundle of all AllergyIntolerance resources for the specified patient (how to search by reference and how to search by token)
The following search parameters and search parameter combinations SHOULD be supported:
patient and clinical-status search parameters:
patient.identifier (e.g. patient.identifier=[system|][code])GET [base]/AllergyIntolerance?patient={Type/}[id]&clinical-status={system|}[code]
Example:
Implementation Notes: Fetches a bundle of all AllergyIntolerance resources for the specified patient and clinical status (how to search by reference and how to search by token)
IG © 2022+ HL7 Australia. Package hl7.fhir.au.core#3.0.0-ci-build based on FHIR 4.0.1. Generated 2026-10-28
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change