My Health Record FHIR IG
1.2.0 - active

My Health Record FHIR IG - Local Development build (v1.2.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## Resource Profile: MHR Medical Conditions View AllergyIntolerance

Official URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-allergyintolerance-mcv-1 | Version: 1.2.0
Active as of 2024-09-19 | Computable Name: DHAllergyIntoleranceMCV
Copyright/Legal: Copyright © 2024 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/.

The purpose of this profile is to support a consolidated view of allergies or intolerance in a patient's My Health Record. It is based on the AU Core AllergyIntolerance profile and describes the data structures and obligations to be met when conforming to this profile.

Usage:

- Refer to this Resource Profile: MHR Medical Conditions View Document Composition and MHR Medical Conditions View Provenance
- Examples for this Resource Profile: AllergyIntolerance/peanut-01 and AllergyIntolerance/sulfonamide-01

### 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 AUCoreAllergyIntolerance

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
AllergyIntolerance |  | 0..* | AUCoreAllergyIntolerance | An allergy or intolerance statement in an Australian healthcare context
id |  | 1..1 | id | Logical id of this artifact
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
detailedType | SO | 0..1 | CodeableConcept | The detailed type of allergy or intolerance URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-mhr-allergyintolerance-detailed-type-1 Binding: Adverse Reaction Type (preferred)
Obligations | Actor
SHALL:handle | MHR Gateway Requester
clinicalStatus |  | 1..1 | CodeableConcept | active | inactive | resolved Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: active
code | O | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance
Obligations | Actor
SHALL:handle | MHR Gateway Requester
patient | O | 1..1 | Reference(MHR Patient) | Who the sensitivity is for
Obligations | Actor
SHALL:handle | MHR Gateway Requester
recordedDate | SO | 0..1 | dateTime | Date first version of the resource instance was recorded
Obligations | Actor
SHALL:handle | MHR Gateway Requester
reaction |  | 0..1 | BackboneElement | Adverse Reaction Events linked to exposure to substance
manifestation | O | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event
Obligations | Actor
SHALL:handle | MHR Gateway Requester
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
AllergyIntolerance | C | 0..* | AUCoreAllergyIntolerance | An allergy or intolerance statement in an Australian healthcare context 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 | Σ | 1..1 | id | Logical id of this artifact
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
detailedType | SO | 0..1 | CodeableConcept | The detailed type of allergy or intolerance URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-mhr-allergyintolerance-detailed-type-1 Binding: Adverse Reaction Type (preferred)
Obligations | Actor
SHALL:handle | MHR Gateway Requester
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
clinicalStatus | ?!SO Σ C | 1..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. Required Pattern: At least the following
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: active
verificationStatus | ?!SO Σ C | 0..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
code | SO Σ | 1..1 | CodeableConcept | 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
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
SHALL:handle | MHR Gateway Requester
patient | SO Σ | 1..1 | Reference(MHR Patient) | Who the sensitivity is for
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
SHALL:handle | MHR Gateway Requester
onset[x] | SO | 0..1 |  | When allergy or intolerance was identified
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
onsetDateTime |  |  | dateTime |
onsetAge |  |  | Age |
onsetPeriod |  |  | Period |
onsetRange |  |  | Range |
recordedDate | SO | 0..1 | dateTime | Date first version of the resource instance was recorded
Obligations | Actor
SHALL:handle | MHR Gateway Requester
reaction | SO | 0..1 | BackboneElement | Adverse Reaction Events linked to exposure to substance
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
manifestation | SO | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: Clinical Finding (preferred)
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
SHALL:handle | MHR Gateway Requester
severity | SO | 0..1 | code | mild | moderate | severe (of event as a whole) Binding: AllergyIntoleranceSeverity (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations.
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
AllergyIntolerance.clinicalStatus | required | Pattern: active `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.code | extensible | IndicatorOfHypersensitivityOrIntoleranceToSubstance
Additional Bindings | Purpose | Documentation
Adverse Reaction Substances and Negated Findings | candidate | The Adverse Reaction Substances and Negated Findings value set comprises terms used to identify a predisposition to adverse reactions to substances, as well as negated findings.
`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

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
AllergyIntolerance | C | 0..* | AUCoreAllergyIntolerance | An allergy or intolerance statement in an Australian healthcare context 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 | Σ | 1..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
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
detailedType | SO | 0..1 | CodeableConcept | The detailed type of allergy or intolerance URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-mhr-allergyintolerance-detailed-type-1 Binding: Adverse Reaction Type (preferred)
Obligations | Actor
SHALL:handle | MHR Gateway Requester
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | Σ | 0..* | Identifier | External ids for this item
clinicalStatus | ?!SO Σ C | 1..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. Required Pattern: At least the following
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: active
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
verificationStatus | ?!SO Σ C | 0..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
type | Σ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
category | Σ | 0..* | code | food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.
criticality | Σ | 0..1 | code | low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.
code | SO Σ | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: Indicator of Hypersensitivity or Intolerance to Substance (extensible)
Additional Bindings | Purpose
Adverse Reaction Substances and Negated Findings | candidate
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
SHALL:handle | MHR Gateway Requester
patient | SO Σ | 1..1 | Reference(MHR Patient) | Who the sensitivity is for
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
SHALL:handle | MHR Gateway Requester
encounter |  | 0..1 | Reference(Encounter) | Encounter when the allergy or intolerance was asserted
onset[x] | SO | 0..1 |  | When allergy or intolerance was identified
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
onsetDateTime |  |  | dateTime |
onsetAge |  |  | Age |
onsetPeriod |  |  | Period |
onsetRange |  |  | Range |
recordedDate | SO | 0..1 | dateTime | Date first version of the resource instance was recorded
Obligations | Actor
SHALL:handle | MHR Gateway Requester
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 | SO | 0..1 | BackboneElement | Adverse Reaction Events linked to exposure to substance
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
substance |  | 0..1 | CodeableConcept | Specific substance or pharmaceutical product considered to be responsible for event Binding: Adverse Reaction Agent (preferred)
manifestation | SO | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: Clinical Finding (preferred)
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
SHALL:handle | MHR Gateway Requester
description |  | 0..1 | string | Description of the event as a whole
onset |  | 0..1 | dateTime | Date(/time) when manifestations showed
severity | SO | 0..1 | code | mild | moderate | severe (of event as a whole) Binding: AllergyIntoleranceSeverity (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations.
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
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 / Code | URI
AllergyIntolerance.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
`http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
AllergyIntolerance.clinicalStatus | required | Pattern: active `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
Additional Bindings | Purpose | Documentation
Adverse Reaction Substances and Negated Findings | candidate | The Adverse Reaction Substances and Negated Findings value set comprises terms used to identify a predisposition to adverse reactions to substances, as well as negated findings.
`https://healthterminologies.gov.au/fhir/ValueSet/indicator-hypersensitivity-intolerance-to-substance-2` from https://tx.ontoserver.csiro.au/fhir
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

This structure is derived from AUCoreAllergyIntolerance

Summary

Mandatory: 2 elements
Must-Support: 2 elements

Structures

This structure refers to these other structures:

- MHR Patient (http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-patient-mhr-1)

Extensions

This structure refers to these extensions:

- http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-mhr-allergyintolerance-detailed-type-1

Differential View

This structure is derived from AUCoreAllergyIntolerance

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
AllergyIntolerance |  | 0..* | AUCoreAllergyIntolerance | An allergy or intolerance statement in an Australian healthcare context
id |  | 1..1 | id | Logical id of this artifact
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
detailedType | SO | 0..1 | CodeableConcept | The detailed type of allergy or intolerance URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-mhr-allergyintolerance-detailed-type-1 Binding: Adverse Reaction Type (preferred)
Obligations | Actor
SHALL:handle | MHR Gateway Requester
clinicalStatus |  | 1..1 | CodeableConcept | active | inactive | resolved Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: active
code | O | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance
Obligations | Actor
SHALL:handle | MHR Gateway Requester
patient | O | 1..1 | Reference(MHR Patient) | Who the sensitivity is for
Obligations | Actor
SHALL:handle | MHR Gateway Requester
recordedDate | SO | 0..1 | dateTime | Date first version of the resource instance was recorded
Obligations | Actor
SHALL:handle | MHR Gateway Requester
reaction |  | 0..1 | BackboneElement | Adverse Reaction Events linked to exposure to substance
manifestation | O | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event
Obligations | Actor
SHALL:handle | MHR Gateway Requester
Documentation for this format

Key Elements View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
AllergyIntolerance | C | 0..* | AUCoreAllergyIntolerance | An allergy or intolerance statement in an Australian healthcare context 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 | Σ | 1..1 | id | Logical id of this artifact
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
detailedType | SO | 0..1 | CodeableConcept | The detailed type of allergy or intolerance URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-mhr-allergyintolerance-detailed-type-1 Binding: Adverse Reaction Type (preferred)
Obligations | Actor
SHALL:handle | MHR Gateway Requester
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
clinicalStatus | ?!SO Σ C | 1..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. Required Pattern: At least the following
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: active
verificationStatus | ?!SO Σ C | 0..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
code | SO Σ | 1..1 | CodeableConcept | 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
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
SHALL:handle | MHR Gateway Requester
patient | SO Σ | 1..1 | Reference(MHR Patient) | Who the sensitivity is for
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
SHALL:handle | MHR Gateway Requester
onset[x] | SO | 0..1 |  | When allergy or intolerance was identified
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
onsetDateTime |  |  | dateTime |
onsetAge |  |  | Age |
onsetPeriod |  |  | Period |
onsetRange |  |  | Range |
recordedDate | SO | 0..1 | dateTime | Date first version of the resource instance was recorded
Obligations | Actor
SHALL:handle | MHR Gateway Requester
reaction | SO | 0..1 | BackboneElement | Adverse Reaction Events linked to exposure to substance
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
manifestation | SO | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: Clinical Finding (preferred)
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
SHALL:handle | MHR Gateway Requester
severity | SO | 0..1 | code | mild | moderate | severe (of event as a whole) Binding: AllergyIntoleranceSeverity (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations.
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
AllergyIntolerance.clinicalStatus | required | Pattern: active `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.code | extensible | IndicatorOfHypersensitivityOrIntoleranceToSubstance
Additional Bindings | Purpose | Documentation
Adverse Reaction Substances and Negated Findings | candidate | The Adverse Reaction Substances and Negated Findings value set comprises terms used to identify a predisposition to adverse reactions to substances, as well as negated findings.
`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

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
AllergyIntolerance | C | 0..* | AUCoreAllergyIntolerance | An allergy or intolerance statement in an Australian healthcare context 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 | Σ | 1..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
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
detailedType | SO | 0..1 | CodeableConcept | The detailed type of allergy or intolerance URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-mhr-allergyintolerance-detailed-type-1 Binding: Adverse Reaction Type (preferred)
Obligations | Actor
SHALL:handle | MHR Gateway Requester
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | Σ | 0..* | Identifier | External ids for this item
clinicalStatus | ?!SO Σ C | 1..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. Required Pattern: At least the following
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: active
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
verificationStatus | ?!SO Σ C | 0..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
type | Σ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
category | Σ | 0..* | code | food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.
criticality | Σ | 0..1 | code | low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.
code | SO Σ | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: Indicator of Hypersensitivity or Intolerance to Substance (extensible)
Additional Bindings | Purpose
Adverse Reaction Substances and Negated Findings | candidate
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
SHALL:handle | MHR Gateway Requester
patient | SO Σ | 1..1 | Reference(MHR Patient) | Who the sensitivity is for
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
SHALL:handle | MHR Gateway Requester
encounter |  | 0..1 | Reference(Encounter) | Encounter when the allergy or intolerance was asserted
onset[x] | SO | 0..1 |  | When allergy or intolerance was identified
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
onsetDateTime |  |  | dateTime |
onsetAge |  |  | Age |
onsetPeriod |  |  | Period |
onsetRange |  |  | Range |
recordedDate | SO | 0..1 | dateTime | Date first version of the resource instance was recorded
Obligations | Actor
SHALL:handle | MHR Gateway Requester
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 | SO | 0..1 | BackboneElement | Adverse Reaction Events linked to exposure to substance
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
substance |  | 0..1 | CodeableConcept | Specific substance or pharmaceutical product considered to be responsible for event Binding: Adverse Reaction Agent (preferred)
manifestation | SO | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: Clinical Finding (preferred)
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
SHALL:handle | MHR Gateway Requester
description |  | 0..1 | string | Description of the event as a whole
onset |  | 0..1 | dateTime | Date(/time) when manifestations showed
severity | SO | 0..1 | code | mild | moderate | severe (of event as a whole) Binding: AllergyIntoleranceSeverity (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations.
Obligations | Actor
SHALL:populate-if-known | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error | http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
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 / Code | URI
AllergyIntolerance.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
`http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
AllergyIntolerance.clinicalStatus | required | Pattern: active `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
Additional Bindings | Purpose | Documentation
Adverse Reaction Substances and Negated Findings | candidate | The Adverse Reaction Substances and Negated Findings value set comprises terms used to identify a predisposition to adverse reactions to substances, as well as negated findings.
`https://healthterminologies.gov.au/fhir/ValueSet/indicator-hypersensitivity-intolerance-to-substance-2` from https://tx.ontoserver.csiro.au/fhir
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

This structure is derived from AUCoreAllergyIntolerance

Summary

Mandatory: 2 elements
Must-Support: 2 elements

Structures

This structure refers to these other structures:

- MHR Patient (http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-patient-mhr-1)

Extensions

This structure refers to these extensions:

- http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-mhr-allergyintolerance-detailed-type-1

Other representations of profile: CSV, Excel, Schematron