AU Core Implementation Guide
0.1.0-draft - Draft Australia flag

This page is part of the AU Core Implementation Guide 0.1.0 Draft. It is based on AU Base 4.1.0. For a full list of available versions, see the Directory of published versions

Resource Profile: AU Core AllergyIntolerance

Official URL: http://hl7.org.au/fhir/core/StructureDefinition/au-core-allergyintolerance Version: 0.1.0-draft
Standards status: Draft Maturity Level: 0 Computable Name: AUCoreAllergyIntolerance

Copyright/Legal: HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.

​This profile sets minimum expectations for an AllergyIntolerance resource to record, search, and fetch allergies/adverse reactions associated with a patient. It is based on the AU Base Allergy Intolerance profile and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the AllergyIntolerance resource when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.

Usage scenarios

The following are supported usage scenarios for this profile:

  • Query for a patient’s allergies/adverse reactions
  • Record or update a patient’s allergies/adverse reactions

Profile specific implementation guidance

  • AllergyIntolerance.verificationStatus is “unconfirmed” where a sending system does not clearly have this element or “confirmed” depending on the level of certainty
  • To represent that a patient does not have an allergy or category of allergies, an appropriate negation code (e.g. 716186003 |No known allergy| or 716184000 |No known latex allergy|) is used in AllergyIntolerance.code
  • Refutation is not expected to be handled except as above - an appropriate negation code in AllergyIntolerance.code and AllergyIntolerance.clinicalStatus of “confirmed” or “unconfirmed”
  • Where only substance is known (e.g. 111088007 |Latex|) and not a statement of allergy or intolerance (e.g. 300916003 |Allergy to latex|), the substance will be sent in AllergyIntolerance.code and optionally in AllergyIntolerance.reaction.substance

Usage:

Formal Views of Profile Content

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

This structure is derived from AUBaseAllergyIntolerance

NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance 0..*AUBaseAllergyIntoleranceAn allergy or intolerance statement in an Australian healthcare context
... clinicalStatus S0..1CodeableConceptactive | inactive | resolved
... verificationStatus S0..1CodeableConceptunconfirmed | confirmed | refuted | entered-in-error
... type S0..1codeallergy | intolerance - Underlying mechanism (if known)
... code S1..1CodeableConceptCode that identifies the allergy or intolerance
... patient S1..1Reference(AU Core Patient)Who the sensitivity is for
... encounter S0..1Reference(AU Core Encounter)Encounter when the allergy or intolerance was asserted
... onset[x] S0..1When allergy or intolerance was identified
.... onsetDateTimedateTime
.... onsetAgeAge
.... onsetPeriodPeriod
.... onsetRangeRange
... recorder S0..1Reference(AU Core Practitioner | AU Core Patient | AU Core RelatedPerson | AU Core PractitionerRole)Who recorded the sensitivity
... asserter S0..1Reference(AU Core Patient | AU Core RelatedPerson | AU Core Practitioner | AU Core PractitionerRole)Source of the information about the allergy
... note S0..*AnnotationAdditional text not captured in other fields
... reaction S0..*BackboneElementAdverse Reaction Events linked to exposure to substance
.... substance S0..1CodeableConceptSpecific substance or pharmaceutical product considered to be responsible for event
.... manifestation S1..*CodeableConceptClinical symptoms/signs associated with the Event
.... severity S0..1codemild | moderate | severe (of event as a whole)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance C0..*AUBaseAllergyIntoleranceAn allergy or intolerance statement in an Australian healthcare context
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... clinicalStatus ?!SΣC0..1CodeableConceptactive | inactive | resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.

... type SΣ0..1codeallergy | intolerance - Underlying mechanism (if known)
Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.

... category SΣ0..*codefood | medication | environment | biologic
Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.


... code SΣ1..1CodeableConceptCode that identifies the allergy or intolerance
Binding: https://healthterminologies.gov.au/fhir/ValueSet/indicator-hypersensitivity-intolerance-to-substance-2 (preferred)
... patient SΣ1..1Reference(AU Core Patient)Who the sensitivity is for
... encounter S0..1Reference(AU Core Encounter)Encounter when the allergy or intolerance was asserted
... onset[x] S0..1When allergy or intolerance was identified
.... onsetDateTimedateTime
.... onsetAgeAge
.... onsetPeriodPeriod
.... onsetRangeRange
... recorder S0..1Reference(AU Core Practitioner | AU Core Patient | AU Core RelatedPerson | AU Core PractitionerRole)Who recorded the sensitivity
... asserter SΣ0..1Reference(AU Core Patient | AU Core RelatedPerson | AU Core Practitioner | AU Core PractitionerRole)Source of the information about the allergy
... note S0..*AnnotationAdditional text not captured in other fields
... reaction S0..*BackboneElementAdverse Reaction Events linked to exposure to substance
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... substance S0..1CodeableConceptSpecific substance or pharmaceutical product considered to be responsible for event
Binding: https://healthterminologies.gov.au/fhir/ValueSet/adverse-reaction-agent-1 (preferred)
.... manifestation S1..*CodeableConceptClinical symptoms/signs associated with the Event
Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 (preferred)
.... severity S0..1codemild | 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.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
AllergyIntolerance.clinicalStatusrequiredAllergyIntoleranceClinicalStatusCodes
AllergyIntolerance.verificationStatusrequiredAllergyIntoleranceVerificationStatusCodes
AllergyIntolerance.typerequiredAllergyIntoleranceType
AllergyIntolerance.categoryrequiredAllergyIntoleranceCategory
AllergyIntolerance.codepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/indicator-hypersensitivity-intolerance-to-substance-2
AllergyIntolerance.reaction.substancepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/adverse-reaction-agent-1
AllergyIntolerance.reaction.manifestationpreferredhttps://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1
AllergyIntolerance.reaction.severityrequiredAllergyIntoleranceSeverity
NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance C0..*AUBaseAllergyIntoleranceAn allergy or intolerance statement in an Australian healthcare context
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal ids for this item
... clinicalStatus ?!SΣC0..1CodeableConceptactive | inactive | resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.

... verificationStatus ?!SΣC0..1CodeableConceptunconfirmed | 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..1codeallergy | intolerance - Underlying mechanism (if known)
Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.

... category SΣ0..*codefood | medication | environment | biologic
Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.


... criticality Σ0..1codelow | 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..1CodeableConceptCode that identifies the allergy or intolerance
Binding: https://healthterminologies.gov.au/fhir/ValueSet/indicator-hypersensitivity-intolerance-to-substance-2 (preferred)
... patient SΣ1..1Reference(AU Core Patient)Who the sensitivity is for
... encounter S0..1Reference(AU Core Encounter)Encounter when the allergy or intolerance was asserted
... onset[x] S0..1When allergy or intolerance was identified
.... onsetDateTimedateTime
.... onsetAgeAge
.... onsetPeriodPeriod
.... onsetRangeRange
... recordedDate 0..1dateTimeDate first version of the resource instance was recorded
... recorder S0..1Reference(AU Core Practitioner | AU Core Patient | AU Core RelatedPerson | AU Core PractitionerRole)Who recorded the sensitivity
... asserter SΣ0..1Reference(AU Core Patient | AU Core RelatedPerson | AU Core Practitioner | AU Core PractitionerRole)Source of the information about the allergy
... lastOccurrence 0..1dateTimeDate(/time) of last known occurrence of a reaction
... note S0..*AnnotationAdditional text not captured in other fields
... reaction S0..*BackboneElementAdverse Reaction Events linked to exposure to substance
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... substance S0..1CodeableConceptSpecific substance or pharmaceutical product considered to be responsible for event
Binding: https://healthterminologies.gov.au/fhir/ValueSet/adverse-reaction-agent-1 (preferred)
.... manifestation S1..*CodeableConceptClinical symptoms/signs associated with the Event
Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 (preferred)
.... description 0..1stringDescription of the event as a whole
.... onset 0..1dateTimeDate(/time) when manifestations showed
.... severity S0..1codemild | 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..1CodeableConceptHow the subject was exposed to the substance
Binding: https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 (preferred)
.... note 0..*AnnotationText about event not captured in other fields

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
AllergyIntolerance.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
AllergyIntolerance.clinicalStatusrequiredAllergyIntoleranceClinicalStatusCodes
AllergyIntolerance.verificationStatusrequiredAllergyIntoleranceVerificationStatusCodes
AllergyIntolerance.typerequiredAllergyIntoleranceType
AllergyIntolerance.categoryrequiredAllergyIntoleranceCategory
AllergyIntolerance.criticalityrequiredAllergyIntoleranceCriticality
AllergyIntolerance.codepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/indicator-hypersensitivity-intolerance-to-substance-2
AllergyIntolerance.reaction.substancepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/adverse-reaction-agent-1
AllergyIntolerance.reaction.manifestationpreferredhttps://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1
AllergyIntolerance.reaction.severityrequiredAllergyIntoleranceSeverity
AllergyIntolerance.reaction.exposureRoutepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1

Differential View

This structure is derived from AUBaseAllergyIntolerance

NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance 0..*AUBaseAllergyIntoleranceAn allergy or intolerance statement in an Australian healthcare context
... clinicalStatus S0..1CodeableConceptactive | inactive | resolved
... verificationStatus S0..1CodeableConceptunconfirmed | confirmed | refuted | entered-in-error
... type S0..1codeallergy | intolerance - Underlying mechanism (if known)
... code S1..1CodeableConceptCode that identifies the allergy or intolerance
... patient S1..1Reference(AU Core Patient)Who the sensitivity is for
... encounter S0..1Reference(AU Core Encounter)Encounter when the allergy or intolerance was asserted
... onset[x] S0..1When allergy or intolerance was identified
.... onsetDateTimedateTime
.... onsetAgeAge
.... onsetPeriodPeriod
.... onsetRangeRange
... recorder S0..1Reference(AU Core Practitioner | AU Core Patient | AU Core RelatedPerson | AU Core PractitionerRole)Who recorded the sensitivity
... asserter S0..1Reference(AU Core Patient | AU Core RelatedPerson | AU Core Practitioner | AU Core PractitionerRole)Source of the information about the allergy
... note S0..*AnnotationAdditional text not captured in other fields
... reaction S0..*BackboneElementAdverse Reaction Events linked to exposure to substance
.... substance S0..1CodeableConceptSpecific substance or pharmaceutical product considered to be responsible for event
.... manifestation S1..*CodeableConceptClinical symptoms/signs associated with the Event
.... severity S0..1codemild | moderate | severe (of event as a whole)

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance C0..*AUBaseAllergyIntoleranceAn allergy or intolerance statement in an Australian healthcare context
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... clinicalStatus ?!SΣC0..1CodeableConceptactive | inactive | resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.

... type SΣ0..1codeallergy | intolerance - Underlying mechanism (if known)
Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.

... category SΣ0..*codefood | medication | environment | biologic
Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.


... code SΣ1..1CodeableConceptCode that identifies the allergy or intolerance
Binding: https://healthterminologies.gov.au/fhir/ValueSet/indicator-hypersensitivity-intolerance-to-substance-2 (preferred)
... patient SΣ1..1Reference(AU Core Patient)Who the sensitivity is for
... encounter S0..1Reference(AU Core Encounter)Encounter when the allergy or intolerance was asserted
... onset[x] S0..1When allergy or intolerance was identified
.... onsetDateTimedateTime
.... onsetAgeAge
.... onsetPeriodPeriod
.... onsetRangeRange
... recorder S0..1Reference(AU Core Practitioner | AU Core Patient | AU Core RelatedPerson | AU Core PractitionerRole)Who recorded the sensitivity
... asserter SΣ0..1Reference(AU Core Patient | AU Core RelatedPerson | AU Core Practitioner | AU Core PractitionerRole)Source of the information about the allergy
... note S0..*AnnotationAdditional text not captured in other fields
... reaction S0..*BackboneElementAdverse Reaction Events linked to exposure to substance
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... substance S0..1CodeableConceptSpecific substance or pharmaceutical product considered to be responsible for event
Binding: https://healthterminologies.gov.au/fhir/ValueSet/adverse-reaction-agent-1 (preferred)
.... manifestation S1..*CodeableConceptClinical symptoms/signs associated with the Event
Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 (preferred)
.... severity S0..1codemild | 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.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
AllergyIntolerance.clinicalStatusrequiredAllergyIntoleranceClinicalStatusCodes
AllergyIntolerance.verificationStatusrequiredAllergyIntoleranceVerificationStatusCodes
AllergyIntolerance.typerequiredAllergyIntoleranceType
AllergyIntolerance.categoryrequiredAllergyIntoleranceCategory
AllergyIntolerance.codepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/indicator-hypersensitivity-intolerance-to-substance-2
AllergyIntolerance.reaction.substancepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/adverse-reaction-agent-1
AllergyIntolerance.reaction.manifestationpreferredhttps://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1
AllergyIntolerance.reaction.severityrequiredAllergyIntoleranceSeverity

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance C0..*AUBaseAllergyIntoleranceAn allergy or intolerance statement in an Australian healthcare context
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal ids for this item
... clinicalStatus ?!SΣC0..1CodeableConceptactive | inactive | resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.

... verificationStatus ?!SΣC0..1CodeableConceptunconfirmed | 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..1codeallergy | intolerance - Underlying mechanism (if known)
Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.

... category SΣ0..*codefood | medication | environment | biologic
Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.


... criticality Σ0..1codelow | 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..1CodeableConceptCode that identifies the allergy or intolerance
Binding: https://healthterminologies.gov.au/fhir/ValueSet/indicator-hypersensitivity-intolerance-to-substance-2 (preferred)
... patient SΣ1..1Reference(AU Core Patient)Who the sensitivity is for
... encounter S0..1Reference(AU Core Encounter)Encounter when the allergy or intolerance was asserted
... onset[x] S0..1When allergy or intolerance was identified
.... onsetDateTimedateTime
.... onsetAgeAge
.... onsetPeriodPeriod
.... onsetRangeRange
... recordedDate 0..1dateTimeDate first version of the resource instance was recorded
... recorder S0..1Reference(AU Core Practitioner | AU Core Patient | AU Core RelatedPerson | AU Core PractitionerRole)Who recorded the sensitivity
... asserter SΣ0..1Reference(AU Core Patient | AU Core RelatedPerson | AU Core Practitioner | AU Core PractitionerRole)Source of the information about the allergy
... lastOccurrence 0..1dateTimeDate(/time) of last known occurrence of a reaction
... note S0..*AnnotationAdditional text not captured in other fields
... reaction S0..*BackboneElementAdverse Reaction Events linked to exposure to substance
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... substance S0..1CodeableConceptSpecific substance or pharmaceutical product considered to be responsible for event
Binding: https://healthterminologies.gov.au/fhir/ValueSet/adverse-reaction-agent-1 (preferred)
.... manifestation S1..*CodeableConceptClinical symptoms/signs associated with the Event
Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 (preferred)
.... description 0..1stringDescription of the event as a whole
.... onset 0..1dateTimeDate(/time) when manifestations showed
.... severity S0..1codemild | 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..1CodeableConceptHow the subject was exposed to the substance
Binding: https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 (preferred)
.... note 0..*AnnotationText about event not captured in other fields

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
AllergyIntolerance.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
AllergyIntolerance.clinicalStatusrequiredAllergyIntoleranceClinicalStatusCodes
AllergyIntolerance.verificationStatusrequiredAllergyIntoleranceVerificationStatusCodes
AllergyIntolerance.typerequiredAllergyIntoleranceType
AllergyIntolerance.categoryrequiredAllergyIntoleranceCategory
AllergyIntolerance.criticalityrequiredAllergyIntoleranceCriticality
AllergyIntolerance.codepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/indicator-hypersensitivity-intolerance-to-substance-2
AllergyIntolerance.reaction.substancepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/adverse-reaction-agent-1
AllergyIntolerance.reaction.manifestationpreferredhttps://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1
AllergyIntolerance.reaction.severityrequiredAllergyIntoleranceSeverity
AllergyIntolerance.reaction.exposureRoutepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Below is an overview of the mandatory and optional search parameters. FHIR search operations and the syntax used to describe the interactions is described here.

Name Type Conformance Description Path
TBD TBD TBD TBD TBD

Mandatory Search Parameters

The following search parameters and search parameter combinations SHALL be supported:

Optional Search Parameters

The following search parameters and search parameter combinations SHOULD be supported: