Australian Base Implementation Guide (AU Base 1.1.1)

This page is part of the Australian Base IG (v1.1.1: AU Base 1.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 Allergy Intolerance [FMM Level 1]

This profile defines an allergy intolerance structure including core localisation concepts for use in an Australian context.

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.

Extensions

Extensions used in this profile:

  • AllergyInterolerance: Author as a Related Person [1]

  • AllergyIntolerance: Encounter reference[1] (R4 pre-adopt) Consider use of encounter reference using version conversion extensions [2]

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

This profile defines an allergy intolerance structure including core localisation concepts for use in an Australian context.

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.

NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance I0..*AllergyIntoleranceAn allergy or intolerance statement in an Australian healthcare context
inv-ait-0: Recorder and author related party shall not coexist
... 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)
Max Binding: All Languages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... author-related-person I0..1Reference(RelatedPerson)Related person that authored the resource
URL: http://hl7.org.au/fhir/StructureDefinition/author-related-person
... 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: https://healthterminologies.gov.au/fhir/ValueSet/indicator-hypersensitivity-intolerance-to-substance-1 (preferred)
... patient Σ1..1Reference(Patient)Who the sensitivity is for
... onset[x] 0..1When allergy or intolerance was identified
.... onsetDateTimedateTime
.... onsetAgeAge
.... onsetPeriodPeriod
.... onsetRangeRange
.... onsetStringstring
... assertedDate 0..1dateTimeDate record was believed accurate
... recorder 0..1Reference(Practitioner | Patient)Who recorded the sensitivity
... asserter Σ0..1Reference(Patient | RelatedPerson | Practitioner)Source of the information about the allergy
... lastOccurrence 0..1dateTimeDate(/time) of last known occurrence of a reaction
... note 0..*AnnotationAdditional text not captured in other fields
... reaction I0..*BackboneElementReaction details
.... 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: https://healthterminologies.gov.au/fhir/ValueSet/adverse-reaction-agent-1 (preferred)
.... manifestation 1..*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 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

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance I0..*AllergyIntoleranceAn allergy or intolerance statement in an Australian healthcare context
inv-ait-0: Recorder and author related party shall not coexist
... 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)
Max Binding: All Languages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... author-related-person I0..1Reference(RelatedPerson)Related person that authored the resource
URL: http://hl7.org.au/fhir/StructureDefinition/author-related-person
... 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: https://healthterminologies.gov.au/fhir/ValueSet/indicator-hypersensitivity-intolerance-to-substance-1 (preferred)
... patient Σ1..1Reference(Patient)Who the sensitivity is for
... onset[x] 0..1When allergy or intolerance was identified
.... onsetDateTimedateTime
.... onsetAgeAge
.... onsetPeriodPeriod
.... onsetRangeRange
.... onsetStringstring
... assertedDate 0..1dateTimeDate record was believed accurate
... recorder 0..1Reference(Practitioner | Patient)Who recorded the sensitivity
... asserter Σ0..1Reference(Patient | RelatedPerson | Practitioner)Source of the information about the allergy
... lastOccurrence 0..1dateTimeDate(/time) of last known occurrence of a reaction
... note 0..*AnnotationAdditional text not captured in other fields
... reaction I0..*BackboneElementReaction details
.... 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: https://healthterminologies.gov.au/fhir/ValueSet/adverse-reaction-agent-1 (preferred)
.... manifestation 1..*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 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