AU Patient Summary Implementation Guide
0.1.0-preview - Preview

Publication Build: This will be filled in by the publication tooling

## Resource Profile: AU PS AllergyIntolerance

Official URL: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-allergyintolerance | Version: 0.1.0-preview
Standards status: Draft | Maturity Level: 0 | Computable Name: AUPSAllergyIntolerance
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 in the context of a patient summary in an Australian context. It is based on the AU Base AllergyIntolerance profile, and applies the constraints of AU Core AllergyIntolerance and AllergyIntolerance (IPS).

See Comparison with other national and international IGs for a comparison between AU Core profiles and profiles in other implementation guides.

### Profile specific implementation guidance

- See the guidance on implementing the AllergyIntolerance resource in AU Core.

Usage:

- Use this Resource Profile: AU PS Bundle
- Refer to this Resource Profile: AU PS Composition

### Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

- Differential Table
- Key Elements Table
- Snapshot Table
- Statistics/References
- All

This structure is derived from AUBaseAllergyIntolerance

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
AllergyIntolerance |  | 0..* | AUBaseAllergyIntolerance | An allergy or intolerance statement in an Australian healthcare context This profile also complies with the profiles Allergy Intolerance (IPS) and AU Core AllergyIntolerance
clinicalStatus | S | 0..1 | CodeableConceptIPS | active | inactive | resolved
verificationStatus | S | 0..1 | CodeableConceptIPS | unconfirmed | confirmed | refuted | entered-in-error
type | S | 0..1 | code | allergy | intolerance - Underlying mechanism (if known)
code | S | 1..1 | CodeableConceptIPS | Code that identifies the allergy or intolerance Binding: Indicator of Hypersensitivity or Intolerance to Substance (extensible)
Additional Bindings | Purpose
Adverse Reaction Substances and Negated Findings | candidate
patient | S | 1..1 | Reference(AU PS Patient) | Who the sensitivity is for
reference | S | 1..1 | string | Literal reference, Relative, internal or absolute URL
onset[x] | S | 0..1 |  | When allergy or intolerance was identified
onsetDateTime |  |  | dateTime S |
onsetAge |  |  | Age |
onsetPeriod |  |  | Period |
onsetRange |  |  | Range |
reaction | S | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance
manifestation | S | 1..* | CodeableConceptIPS | Clinical symptoms/signs associated with the Event
severity | S | 0..1 | code | mild | moderate | severe (of event as a whole)
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet | URI
AllergyIntolerance.code | extensible | IndicatorOfHypersensitivityOrIntoleranceToSubstance `https://healthterminologies.gov.au/fhir/ValueSet/indicator-hypersensitivity-intolerance-to-substance-2` from https://tx.ontoserver.csiro.au/fhir

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
AllergyIntolerance | C | 0..* | AUBaseAllergyIntolerance | An allergy or intolerance statement in an Australian healthcare context This profile also complies with the profiles Allergy Intolerance (IPS) and AU Core AllergyIntolerance ait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
clinicalStatus | ?!S Σ C | 0..1 | CodeableConceptIPS | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. ele-1: All FHIR elements must have a @value or children
verificationStatus | ?!S Σ 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. ele-1: All FHIR elements must have a @value or children
type | S Σ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk. ele-1: All FHIR elements must have a @value or children
code | S Σ | 1..1 | CodeableConceptIPS | Code that identifies the allergy or intolerance Binding: Indicator of Hypersensitivity or Intolerance to Substance (extensible)
Additional Bindings | Purpose
Adverse Reaction Substances and Negated Findings | candidate
ele-1: All FHIR elements must have a @value or children
patient | S Σ | 1..1 | Reference(AU PS Patient) | Who the sensitivity is for ele-1: All FHIR elements must have a @value or children
reference | S Σ C | 1..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children
onset[x] | S | 0..1 |  | When allergy or intolerance was identified ele-1: All FHIR elements must have a @value or children
onsetDateTime |  |  | dateTime |
reaction | S | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance ele-1: All FHIR elements must have a @value or children
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
manifestation | S | 1..* | CodeableConceptIPS | Clinical symptoms/signs associated with the Event Binding: Clinical Finding (preferred) ele-1: All FHIR elements must have a @value or children
severity | S | 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. ele-1: All FHIR elements must have a @value or children
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatusCodes `http://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1` from the FHIR Standard
AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatusCodes `http://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1` from the FHIR Standard
AllergyIntolerance.type | required | AllergyIntoleranceType `http://hl7.org/fhir/ValueSet/allergy-intolerance-type|4.0.1` from the FHIR Standard
AllergyIntolerance.code | extensible | IndicatorOfHypersensitivityOrIntoleranceToSubstance `https://healthterminologies.gov.au/fhir/ValueSet/indicator-hypersensitivity-intolerance-to-substance-2` from https://tx.ontoserver.csiro.au/fhir
AllergyIntolerance.reaction.manifestation | preferred | ClinicalFinding `https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1` from https://tx.ontoserver.csiro.au/fhir
AllergyIntolerance.reaction.severity | required | AllergyIntoleranceSeverity `http://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
ait-1 | error | AllergyIntolerance | AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists() |
ait-2 | error | AllergyIntolerance | AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty() |
dom-2 | error | AllergyIntolerance | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | AllergyIntolerance | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() |
dom-4 | error | AllergyIntolerance | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() |
dom-5 | error | AllergyIntolerance | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | AllergyIntolerance | A resource should have narrative for robust management : text.`div`.exists() |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
AllergyIntolerance | C | 0..* | AUBaseAllergyIntolerance | An allergy or intolerance statement in an Australian healthcare context This profile also complies with the profiles Allergy Intolerance (IPS) and AU Core AllergyIntolerance ait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation
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 | ?!S Σ C | 0..1 | CodeableConceptIPS | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
verificationStatus | ?!S Σ 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 | S Σ | 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 | S Σ | 1..1 | CodeableConceptIPS | Code that identifies the allergy or intolerance Binding: Indicator of Hypersensitivity or Intolerance to Substance (extensible)
Additional Bindings | Purpose
Adverse Reaction Substances and Negated Findings | candidate
patient | S Σ | 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 | S Σ 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] | S | 0..1 |  | When allergy or intolerance was identified
onsetDateTime |  |  | dateTime S |
onsetAge |  |  | Age |
onsetPeriod |  |  | Period |
onsetRange |  |  | Range |
recordedDate |  | 0..1 | dateTime | Date first version of the resource instance was recorded
recorder |  | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | Who recorded the sensitivity
asserter | Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | Source of the information about the allergy
lastOccurrence |  | 0..1 | dateTime | Date(/time) of last known occurrence of a reaction
note |  | 0..* | Annotation | Additional text not captured in other fields
reaction | S | 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 | S | 1..* | CodeableConceptIPS | Clinical symptoms/signs associated with the Event Binding: Clinical Finding (preferred)
description |  | 0..1 | string | Description of the event as a whole
onset |  | 0..1 | dateTime | Date(/time) when manifestations showed
severity | S | 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

#### Terminology Bindings

Path | Conformance | ValueSet | URI
AllergyIntolerance.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatusCodes `http://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1` from the FHIR Standard
AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatusCodes `http://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1` from the FHIR Standard
AllergyIntolerance.type | required | AllergyIntoleranceType `http://hl7.org/fhir/ValueSet/allergy-intolerance-type|4.0.1` from the FHIR Standard
AllergyIntolerance.category | required | AllergyIntoleranceCategory `http://hl7.org/fhir/ValueSet/allergy-intolerance-category|4.0.1` from the FHIR Standard
AllergyIntolerance.criticality | required | AllergyIntoleranceCriticality `http://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` from https://tx.ontoserver.csiro.au/fhir
AllergyIntolerance.patient.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
AllergyIntolerance.reaction.substance | preferred | AdverseReactionAgent `https://healthterminologies.gov.au/fhir/ValueSet/adverse-reaction-agent-1` from https://tx.ontoserver.csiro.au/fhir
AllergyIntolerance.reaction.manifestation | preferred | ClinicalFinding `https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1` from https://tx.ontoserver.csiro.au/fhir
AllergyIntolerance.reaction.severity | required | AllergyIntoleranceSeverity `http://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` from https://tx.ontoserver.csiro.au/fhir

#### Constraints

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 AUBaseAllergyIntolerance

Summary

Mandatory: 2 elements
Must-Support: 10 elements

Structures

This structure refers to these other structures:

- Codeable Concept (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips)
- AU PS Patient (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-patient)

Maturity: 0

Differential View

This structure is derived from AUBaseAllergyIntolerance

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
AllergyIntolerance |  | 0..* | AUBaseAllergyIntolerance | An allergy or intolerance statement in an Australian healthcare context This profile also complies with the profiles Allergy Intolerance (IPS) and AU Core AllergyIntolerance
clinicalStatus | S | 0..1 | CodeableConceptIPS | active | inactive | resolved
verificationStatus | S | 0..1 | CodeableConceptIPS | unconfirmed | confirmed | refuted | entered-in-error
type | S | 0..1 | code | allergy | intolerance - Underlying mechanism (if known)
code | S | 1..1 | CodeableConceptIPS | Code that identifies the allergy or intolerance Binding: Indicator of Hypersensitivity or Intolerance to Substance (extensible)
Additional Bindings | Purpose
Adverse Reaction Substances and Negated Findings | candidate
patient | S | 1..1 | Reference(AU PS Patient) | Who the sensitivity is for
reference | S | 1..1 | string | Literal reference, Relative, internal or absolute URL
onset[x] | S | 0..1 |  | When allergy or intolerance was identified
onsetDateTime |  |  | dateTime S |
onsetAge |  |  | Age |
onsetPeriod |  |  | Period |
onsetRange |  |  | Range |
reaction | S | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance
manifestation | S | 1..* | CodeableConceptIPS | Clinical symptoms/signs associated with the Event
severity | S | 0..1 | code | mild | moderate | severe (of event as a whole)
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet | URI
AllergyIntolerance.code | extensible | IndicatorOfHypersensitivityOrIntoleranceToSubstance `https://healthterminologies.gov.au/fhir/ValueSet/indicator-hypersensitivity-intolerance-to-substance-2` from https://tx.ontoserver.csiro.au/fhir

Key Elements View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
AllergyIntolerance | C | 0..* | AUBaseAllergyIntolerance | An allergy or intolerance statement in an Australian healthcare context This profile also complies with the profiles Allergy Intolerance (IPS) and AU Core AllergyIntolerance ait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
clinicalStatus | ?!S Σ C | 0..1 | CodeableConceptIPS | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. ele-1: All FHIR elements must have a @value or children
verificationStatus | ?!S Σ 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. ele-1: All FHIR elements must have a @value or children
type | S Σ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk. ele-1: All FHIR elements must have a @value or children
code | S Σ | 1..1 | CodeableConceptIPS | Code that identifies the allergy or intolerance Binding: Indicator of Hypersensitivity or Intolerance to Substance (extensible)
Additional Bindings | Purpose
Adverse Reaction Substances and Negated Findings | candidate
ele-1: All FHIR elements must have a @value or children
patient | S Σ | 1..1 | Reference(AU PS Patient) | Who the sensitivity is for ele-1: All FHIR elements must have a @value or children
reference | S Σ C | 1..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children
onset[x] | S | 0..1 |  | When allergy or intolerance was identified ele-1: All FHIR elements must have a @value or children
onsetDateTime |  |  | dateTime |
reaction | S | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance ele-1: All FHIR elements must have a @value or children
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
manifestation | S | 1..* | CodeableConceptIPS | Clinical symptoms/signs associated with the Event Binding: Clinical Finding (preferred) ele-1: All FHIR elements must have a @value or children
severity | S | 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. ele-1: All FHIR elements must have a @value or children
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatusCodes `http://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1` from the FHIR Standard
AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatusCodes `http://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1` from the FHIR Standard
AllergyIntolerance.type | required | AllergyIntoleranceType `http://hl7.org/fhir/ValueSet/allergy-intolerance-type|4.0.1` from the FHIR Standard
AllergyIntolerance.code | extensible | IndicatorOfHypersensitivityOrIntoleranceToSubstance `https://healthterminologies.gov.au/fhir/ValueSet/indicator-hypersensitivity-intolerance-to-substance-2` from https://tx.ontoserver.csiro.au/fhir
AllergyIntolerance.reaction.manifestation | preferred | ClinicalFinding `https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1` from https://tx.ontoserver.csiro.au/fhir
AllergyIntolerance.reaction.severity | required | AllergyIntoleranceSeverity `http://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
ait-1 | error | AllergyIntolerance | AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists() |
ait-2 | error | AllergyIntolerance | AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty() |
dom-2 | error | AllergyIntolerance | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | AllergyIntolerance | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() |
dom-4 | error | AllergyIntolerance | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() |
dom-5 | error | AllergyIntolerance | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | AllergyIntolerance | A resource should have narrative for robust management : text.`div`.exists() |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
AllergyIntolerance | C | 0..* | AUBaseAllergyIntolerance | An allergy or intolerance statement in an Australian healthcare context This profile also complies with the profiles Allergy Intolerance (IPS) and AU Core AllergyIntolerance ait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation
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 | ?!S Σ C | 0..1 | CodeableConceptIPS | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
verificationStatus | ?!S Σ 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 | S Σ | 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 | S Σ | 1..1 | CodeableConceptIPS | Code that identifies the allergy or intolerance Binding: Indicator of Hypersensitivity or Intolerance to Substance (extensible)
Additional Bindings | Purpose
Adverse Reaction Substances and Negated Findings | candidate
patient | S Σ | 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 | S Σ 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] | S | 0..1 |  | When allergy or intolerance was identified
onsetDateTime |  |  | dateTime S |
onsetAge |  |  | Age |
onsetPeriod |  |  | Period |
onsetRange |  |  | Range |
recordedDate |  | 0..1 | dateTime | Date first version of the resource instance was recorded
recorder |  | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | Who recorded the sensitivity
asserter | Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | Source of the information about the allergy
lastOccurrence |  | 0..1 | dateTime | Date(/time) of last known occurrence of a reaction
note |  | 0..* | Annotation | Additional text not captured in other fields
reaction | S | 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 | S | 1..* | CodeableConceptIPS | Clinical symptoms/signs associated with the Event Binding: Clinical Finding (preferred)
description |  | 0..1 | string | Description of the event as a whole
onset |  | 0..1 | dateTime | Date(/time) when manifestations showed
severity | S | 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

#### Terminology Bindings

Path | Conformance | ValueSet | URI
AllergyIntolerance.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatusCodes `http://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1` from the FHIR Standard
AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatusCodes `http://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1` from the FHIR Standard
AllergyIntolerance.type | required | AllergyIntoleranceType `http://hl7.org/fhir/ValueSet/allergy-intolerance-type|4.0.1` from the FHIR Standard
AllergyIntolerance.category | required | AllergyIntoleranceCategory `http://hl7.org/fhir/ValueSet/allergy-intolerance-category|4.0.1` from the FHIR Standard
AllergyIntolerance.criticality | required | AllergyIntoleranceCriticality `http://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` from https://tx.ontoserver.csiro.au/fhir
AllergyIntolerance.patient.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
AllergyIntolerance.reaction.substance | preferred | AdverseReactionAgent `https://healthterminologies.gov.au/fhir/ValueSet/adverse-reaction-agent-1` from https://tx.ontoserver.csiro.au/fhir
AllergyIntolerance.reaction.manifestation | preferred | ClinicalFinding `https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1` from https://tx.ontoserver.csiro.au/fhir
AllergyIntolerance.reaction.severity | required | AllergyIntoleranceSeverity `http://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` from https://tx.ontoserver.csiro.au/fhir

#### Constraints

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 AUBaseAllergyIntolerance

Summary

Mandatory: 2 elements
Must-Support: 10 elements

Structures

This structure refers to these other structures:

- Codeable Concept (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips)
- AU PS Patient (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-patient)

Maturity: 0

Other representations of profile: CSV, Excel, Schematron