AU Patient Summary Implementation Guide
1.0.1-ci-build - CI Build
AU Patient Summary Implementation Guide
1.0.1-ci-build - CI Build
AU Patient Summary Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 1.0.1-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-ps/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-allergyintolerance | Version: 1.0.1-ci-build | |||
| Standards status: Trial-use | Maturity Level: 2 | Computable Name: AUPSAllergyIntolerance | ||
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2024+; Licensed Under Creative Commons No Rights Reserved. |
||||
This profile sets minimum expectations for an AllergyIntolerance resource in the context of a patient summary in an Australian context. It is based on the AU Core AllergyIntolerance profile, and applies the additional requirements from AllergyIntolerance (IPS).
See Comparison With Other National and International IGs for a comparison between AU Patient Summary (AU PS) profiles and profiles in other implementation guides.
The additional obligation on AllergyIntolerance.onsetDateTime for AU PS Producer is SHOULD:able-to-populate. This obligation is in addition to the obligation of SHALL:populate-if-known. There is no additional obligation for AU PS Consumer, the obligations of SHALL:handle and SHOULD:display apply.
This additional 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.
Examples for this Profile: Bundle/aups-basicsummary, Bundle/aups-gpvisit-retrieval, Bundle/aups-noknownx, Bundle/aups-referral-endoconsult-autogen and Bundle/aups-referral-endoconsult-curated
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:  | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
  AllergyIntolerance |
C | 0..* | AUCoreAllergyIntolerance | An allergy or intolerance statement in an Australian healthcare context This profile also complies with the profile AllergyIntolerance (IPS) 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 | CodeableConceptIPS | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
| ||||||||||||
| verificationStatus |
C | 0..1 | CodeableConceptIPS | 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.
| |||||||||||||
| code |
1..1 | CodeableConceptIPS | Code that identifies the allergy or intolerance Binding: Indicator of Hypersensitivity or Intolerance to Substance  (extensible)
| |||||||||||||
  patient |
1..1 | Reference(AU PS Patient) | Who the sensitivity is for
| |||||||||||||
  reference |
C | 1..1 | string | Literal reference, Relative, internal or absolute URL
| ||||||||||||
 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..* | CodeableConceptIPS | Clinical symptoms/signs associated with the Event Binding: Adverse Reaction Clinical Manifestation (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.type | Base | required | AllergyIntoleranceType | 📍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 This profile also complies with the profile AllergyIntolerance (IPS) | |||||||||
| clinicalStatus |
0..1 | CodeableConceptIPS | active | inactive | resolved
| |||||||||
| verificationStatus |
0..1 | CodeableConceptIPS | unconfirmed | confirmed | refuted | entered-in-error
| |||||||||
 type |
0..1 | code | allergy | intolerance - Underlying mechanism (if known)
| |||||||||
| code |
1..1 | CodeableConceptIPS | Code that identifies the allergy or intolerance
| |||||||||
| patient |
1..1 | Reference(AU PS Patient) | Who the sensitivity is for
| |||||||||
| reference |
1..1 | string | Literal reference, Relative, internal or absolute URL
| |||||||||
| 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..* | CodeableConceptIPS | Clinical symptoms/signs associated with the Event
| |||||||||
| severity |
0..1 | code | mild | moderate | severe (of event as a whole)
| |||||||||
| Documentation for this format | ||||||||||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| AllergyIntolerance |
C | 0..* | AUCoreAllergyIntolerance | An allergy or intolerance statement in an Australian healthcare context This profile also complies with the profile AllergyIntolerance (IPS) 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 | CodeableConceptIPS | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
| ||||||||||||
| verificationStatus |
C | 0..1 | CodeableConceptIPS | 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 | CodeableConceptIPS | Code that identifies the allergy or intolerance Binding: Indicator of Hypersensitivity or Intolerance to Substance (extensible)
| |||||||||||||
| patient |
1..1 | Reference(AU PS Patient) | Who the sensitivity is for
| |||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| reference |
C | 1..1 | string | Literal reference, Relative, internal or absolute URL
| ||||||||||||
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||||||||||
| identifier |
0..1 | Identifier | Logical reference, when literal reference is not known | |||||||||||||
| display |
0..1 | string | Text alternative for the resource | |||||||||||||
| 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: Adverse Reaction Agent (preferred) | |||||||||||||
| manifestation |
1..* | CodeableConceptIPS | 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 |
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 | 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 |
Indicator of Hypersensitivity or Intolerance to Substance
|
⏿2.1.0 | tx.hl7.org.au |
| AllergyIntolerance.patient.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| 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
Summary
Mandatory: 1 element
Must-Support: 2 elements
Structures
This structure refers to these other structures:
Maturity: 2
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| AllergyIntolerance |
C | 0..* | AUCoreAllergyIntolerance | An allergy or intolerance statement in an Australian healthcare context This profile also complies with the profile AllergyIntolerance (IPS) 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 | CodeableConceptIPS | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
| ||||||||||||
| verificationStatus |
C | 0..1 | CodeableConceptIPS | 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.
| |||||||||||||
| code |
1..1 | CodeableConceptIPS | Code that identifies the allergy or intolerance Binding: Indicator of Hypersensitivity or Intolerance to Substance (extensible)
| |||||||||||||
| patient |
1..1 | Reference(AU PS Patient) | Who the sensitivity is for
| |||||||||||||
| reference |
C | 1..1 | string | Literal reference, Relative, internal or absolute URL
| ||||||||||||
| 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..* | CodeableConceptIPS | Clinical symptoms/signs associated with the Event Binding: Adverse Reaction Clinical Manifestation (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.type | Base | required | AllergyIntoleranceType | 📍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 This profile also complies with the profile AllergyIntolerance (IPS) | |||||||||
| clinicalStatus |
0..1 | CodeableConceptIPS | active | inactive | resolved
| |||||||||
| verificationStatus |
0..1 | CodeableConceptIPS | unconfirmed | confirmed | refuted | entered-in-error
| |||||||||
| type |
0..1 | code | allergy | intolerance - Underlying mechanism (if known)
| |||||||||
| code |
1..1 | CodeableConceptIPS | Code that identifies the allergy or intolerance
| |||||||||
| patient |
1..1 | Reference(AU PS Patient) | Who the sensitivity is for
| |||||||||
| reference |
1..1 | string | Literal reference, Relative, internal or absolute URL
| |||||||||
| 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..* | CodeableConceptIPS | Clinical symptoms/signs associated with the Event
| |||||||||
| severity |
0..1 | code | mild | moderate | severe (of event as a whole)
| |||||||||
| Documentation for this format | ||||||||||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| AllergyIntolerance |
C | 0..* | AUCoreAllergyIntolerance | An allergy or intolerance statement in an Australian healthcare context This profile also complies with the profile AllergyIntolerance (IPS) 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 | CodeableConceptIPS | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
| ||||||||||||
| verificationStatus |
C | 0..1 | CodeableConceptIPS | 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 | CodeableConceptIPS | Code that identifies the allergy or intolerance Binding: Indicator of Hypersensitivity or Intolerance to Substance (extensible)
| |||||||||||||
| patient |
1..1 | Reference(AU PS Patient) | Who the sensitivity is for
| |||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| reference |
C | 1..1 | string | Literal reference, Relative, internal or absolute URL
| ||||||||||||
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||||||||||
| identifier |
0..1 | Identifier | Logical reference, when literal reference is not known | |||||||||||||
| display |
0..1 | string | Text alternative for the resource | |||||||||||||
| 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: Adverse Reaction Agent (preferred) | |||||||||||||
| manifestation |
1..* | CodeableConceptIPS | 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 |
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 | 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 |
Indicator of Hypersensitivity or Intolerance to Substance
|
⏿2.1.0 | tx.hl7.org.au |
| AllergyIntolerance.patient.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| 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
Summary
Mandatory: 1 element
Must-Support: 2 elements
Structures
This structure refers to these other structures:
Maturity: 2
Other representations of profile: CSV, Excel, Schematron
IG © 2024+ HL7 Australia. Package hl7.fhir.au.ps#1.0.1-ci-build based on FHIR 4.0.1. Generated 2026-10-11
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change