Australian Base Profiles Implementation Guide

This page is part of the Australian Base IG (v0.9.3: AU Base 1 on STU3 Draft) based on FHIR R3. The current version which supercedes this version is 1.0.2. For a full list of available versions, see the Directory of published versions

1.0 StructureDefinition-au-allergyintolerance

AU Base AllergyIntolerance [FMM Level 0]

This profile defines an allergy intolerance information structure including core localisation concepts for Australia.

Note: The value set Indicator of Hypersensitivity or Intolerance to Substance is part of a staged approach to offering meaningful localised coding. There is significant redesign occurring in SNOMED CT content relating to allergies, adverse reactions and intolerances. Once the redesign is realised, projected to be 2019, a more focused value set reducing the clinical finding noise will be proposed.

Examples

Ibuprofen allergy, with a manifestation of urticaria

Self-reported allergy to eggs

1.0.1 Formal Views of Profile Content

The official URL for this profile is: 

http://hl7.org.au/fhir/StructureDefinition/au-allergyintolerance

Base profile for Australian context AllergyIntolerance

This profile builds on AllergyIntolerance.

This profile was published on Mon Aug 20 00:00:00 AEST 2018 as a draft by Health Level Seven Australia.

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

This profile contains the following variations from AllergyIntolerance:

  1. at most one code
    • at most one coding Allergy or intolerance to substance (SNOMED CT)
  2. exactly one patient Patient with allergy/intolerance (Reference as: au-patient)
  3. at most one recorder Condition recorded by (Reference as: au-patient | au-practitioner | au-relatedperson)
  4. at most one asserter Condition asserted by (Reference as: au-patient | au-practitioner | au-relatedperson)
  5. zero or more reaction
    • at most one coding Substance or Agent (SNOMED CT)
    • zero or more coding Clinical Finding (SNOMED CT)
NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance 0..*An allergy or intolerance statement in an Australian healthcare context
... code 0..1CodeableConcept
.... coding CodingSlice: Unordered, Open by value:system
.... coding 0..1CodingAllergy or intolerance to substance (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/indicator-hypersensitivity-intolerance-to-substance-1 (required)
... patient 1..1Reference(AU Base Patient)Patient with allergy/intolerance
... recorder 0..1Reference(AU Base Patient | AU Base Practitioner | AU Base Related Person)Condition recorded by
... asserter 0..1Reference(AU Base Patient | AU Base Practitioner | AU Base Related Person)Condition asserted by
... reaction 0..*BackboneElement
.... substance 0..1CodeableConcept
..... coding CodingSlice: Unordered, Open by value:system
..... coding 0..1CodingSubstance or Agent (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/adverse-reaction-agent-1 (required)
.... manifestation 1..*CodeableConcept
..... coding CodingSlice: Unordered, Open by value:system
..... coding 0..*CodingClinical Finding (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 (required)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance I0..*An 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
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..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 ?!ΣI0..1codeactive | inactive | resolved
Binding: AllergyIntoleranceClinicalStatus (required)
... verificationStatus ?!ΣI1..1codeunconfirmed | confirmed | refuted | entered-in-error
Binding: AllergyIntoleranceVerificationStatus (required)
... type Σ0..1codeallergy | intolerance - Underlying mechanism (if known)
Binding: AllergyIntoleranceType (required)
... category Σ0..*codefood | medication | environment | biologic
Binding: AllergyIntoleranceCategory (required)
... criticality Σ0..1codelow | high | unable-to-assess
Binding: AllergyIntoleranceCriticality (required)
... code Σ0..1CodeableConceptCode that identifies the allergy or intolerance
Binding: AllergyIntolerance Substance/Product, Condition and Negation Codes (example)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... coding ΣCodingCode defined by a terminology system
Slice: Unordered, Open by value:system
.... coding Σ0..1CodingAllergy or intolerance to substance (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/indicator-hypersensitivity-intolerance-to-substance-1 (required)
.... text Σ0..1stringPlain text representation of the concept
... patient Σ1..1Reference(AU Base Patient)Patient with allergy/intolerance
... onset[x] 0..1dateTime, Age, Period, Range, stringWhen allergy or intolerance was identified
... assertedDate 0..1dateTimeDate record was believed accurate
... recorder 0..1Reference(AU Base Patient | AU Base Practitioner | AU Base Related Person)Condition recorded by
... asserter Σ0..1Reference(AU Base Patient | AU Base Practitioner | AU Base Related Person)Condition asserted by
... lastOccurrence 0..1dateTimeDate(/time) of last known occurrence of a reaction
... note 0..*AnnotationAdditional text not captured in other fields
... reaction I0..*BackboneElementAdverse Reaction Events linked to exposure to substance
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... substance 0..1CodeableConceptSpecific substance or pharmaceutical product considered to be responsible for event
Binding: Substance Code (example)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding ΣCodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding Σ0..1CodingSubstance or Agent (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/adverse-reaction-agent-1 (required)
..... text Σ0..1stringPlain text representation of the concept
.... manifestation 1..*CodeableConceptClinical symptoms/signs associated with the Event
Binding: SNOMED CT Clinical Findings (example)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding ΣCodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding Σ0..*CodingClinical Finding (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 (required)
..... text Σ0..1stringPlain text representation of the concept
.... description 0..1stringDescription of the event as a whole
.... onset 0..1dateTimeDate(/time) when manifestations showed
.... severity 0..1codemild | moderate | severe (of event as a whole)
Binding: AllergyIntoleranceSeverity (required)
.... exposureRoute 0..1CodeableConceptHow the subject was exposed to the substance
Binding: SNOMED CT Route Codes (example)
.... note 0..*AnnotationText about event not captured in other fields

doco Documentation for this format

This profile contains the following variations from AllergyIntolerance:

  1. at most one code
    • at most one coding Allergy or intolerance to substance (SNOMED CT)
  2. exactly one patient Patient with allergy/intolerance (Reference as: au-patient)
  3. at most one recorder Condition recorded by (Reference as: au-patient | au-practitioner | au-relatedperson)
  4. at most one asserter Condition asserted by (Reference as: au-patient | au-practitioner | au-relatedperson)
  5. zero or more reaction
    • at most one coding Substance or Agent (SNOMED CT)
    • zero or more coding Clinical Finding (SNOMED CT)

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance 0..*An allergy or intolerance statement in an Australian healthcare context
... code 0..1CodeableConcept
.... coding CodingSlice: Unordered, Open by value:system
.... coding 0..1CodingAllergy or intolerance to substance (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/indicator-hypersensitivity-intolerance-to-substance-1 (required)
... patient 1..1Reference(AU Base Patient)Patient with allergy/intolerance
... recorder 0..1Reference(AU Base Patient | AU Base Practitioner | AU Base Related Person)Condition recorded by
... asserter 0..1Reference(AU Base Patient | AU Base Practitioner | AU Base Related Person)Condition asserted by
... reaction 0..*BackboneElement
.... substance 0..1CodeableConcept
..... coding CodingSlice: Unordered, Open by value:system
..... coding 0..1CodingSubstance or Agent (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/adverse-reaction-agent-1 (required)
.... manifestation 1..*CodeableConcept
..... coding CodingSlice: Unordered, Open by value:system
..... coding 0..*CodingClinical Finding (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 (required)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance I0..*An 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
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..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 ?!ΣI0..1codeactive | inactive | resolved
Binding: AllergyIntoleranceClinicalStatus (required)
... verificationStatus ?!ΣI1..1codeunconfirmed | confirmed | refuted | entered-in-error
Binding: AllergyIntoleranceVerificationStatus (required)
... type Σ0..1codeallergy | intolerance - Underlying mechanism (if known)
Binding: AllergyIntoleranceType (required)
... category Σ0..*codefood | medication | environment | biologic
Binding: AllergyIntoleranceCategory (required)
... criticality Σ0..1codelow | high | unable-to-assess
Binding: AllergyIntoleranceCriticality (required)
... code Σ0..1CodeableConceptCode that identifies the allergy or intolerance
Binding: AllergyIntolerance Substance/Product, Condition and Negation Codes (example)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... coding ΣCodingCode defined by a terminology system
Slice: Unordered, Open by value:system
.... coding Σ0..1CodingAllergy or intolerance to substance (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/indicator-hypersensitivity-intolerance-to-substance-1 (required)
.... text Σ0..1stringPlain text representation of the concept
... patient Σ1..1Reference(AU Base Patient)Patient with allergy/intolerance
... onset[x] 0..1dateTime, Age, Period, Range, stringWhen allergy or intolerance was identified
... assertedDate 0..1dateTimeDate record was believed accurate
... recorder 0..1Reference(AU Base Patient | AU Base Practitioner | AU Base Related Person)Condition recorded by
... asserter Σ0..1Reference(AU Base Patient | AU Base Practitioner | AU Base Related Person)Condition asserted by
... lastOccurrence 0..1dateTimeDate(/time) of last known occurrence of a reaction
... note 0..*AnnotationAdditional text not captured in other fields
... reaction I0..*BackboneElementAdverse Reaction Events linked to exposure to substance
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... substance 0..1CodeableConceptSpecific substance or pharmaceutical product considered to be responsible for event
Binding: Substance Code (example)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding ΣCodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding Σ0..1CodingSubstance or Agent (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/adverse-reaction-agent-1 (required)
..... text Σ0..1stringPlain text representation of the concept
.... manifestation 1..*CodeableConceptClinical symptoms/signs associated with the Event
Binding: SNOMED CT Clinical Findings (example)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding ΣCodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding Σ0..*CodingClinical Finding (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 (required)
..... text Σ0..1stringPlain text representation of the concept
.... description 0..1stringDescription of the event as a whole
.... onset 0..1dateTimeDate(/time) when manifestations showed
.... severity 0..1codemild | moderate | severe (of event as a whole)
Binding: AllergyIntoleranceSeverity (required)
.... exposureRoute 0..1CodeableConceptHow the subject was exposed to the substance
Binding: SNOMED CT Route Codes (example)
.... note 0..*AnnotationText about event not captured in other fields

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron

 

1.0.2 Quick Start

Below is an overview of the required search and read operations.

Summary of Search Criteria for StructureDefinition-au-allergyintolerance

none defined