Australian Digital Health Agency FHIR Implementation Guide, published by Australian Digital Health Agency. This guide is not an authorized publication; it is the continuous build for version 1.2.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/ci-fhir-r4/ and changes regularly. See the Directory of published versions

Resource Profile: ADHA Core AllergyIntolerance

Official URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-allergyintolerance-core-1 Version: 0.1.3
Draft as of 2024-12-19 Computable Name: ADHAAllergyIntoleranceCore

Copyright/Legal: Copyright © 2022 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 provide a core representation of an allergy or intolerance for the electronic exchange of health information between individuals, healthcare providers, and the My Health Record system infrastructure in Australia. This profile supports a summary statement relating to an allergy or intolerance including asserting negation for a specific allergy or intolerance, a category, or that a patient has no known allergies or intolerances.

This profile identifies the additional constraints, extensions, and value sets that build on and extend AllergyIntolerance that are supported.

Usage:

Formal Views of Profile Content

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

This structure is derived from AUCoreAllergyIntolerance

NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance C 0..* AUCoreAllergyIntolerance An allergy or intolerance statement in an Australian healthcare context
inv-dh-ait-01: If present, an asserter shall at least have a reference, an identifier or a display
... type S 0..1 code allergy | intolerance - Underlying mechanism (if known)
... category S 0..* code food | medication | environment | biologic
... criticality S 0..1 code low | high | unable-to-assess
... encounter C 0..1 Reference(AU Core Encounter) Encounter when the allergy or intolerance was asserted
inv-dh-ait-02: At least reference or a valid identifier shall be present
... recorder C 1..1 Reference(AU Core Patient | AU Base Related Person | AU Core PractitionerRole) Who recorded the sensitivity
inv-dh-ait-03: At least reference or display or a valid identifier shall be present
... asserter C 0..1 Reference(AU Core Patient | AU Base Related Person | AU Core PractitionerRole) Source of the information about the allergy
... reaction
.... substance S 0..1 CodeableConcept Specific substance or pharmaceutical product considered to be responsible for event

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
inv-dh-ait-01errorAllergyIntoleranceIf present, an asserter shall at least have a reference, an identifier or a display
: asserter.exists() implies asserter.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists())
inv-dh-ait-02errorAllergyIntolerance.encounterAt least reference or a valid identifier shall be present
: reference.exists() or identifier.where(system.count() + value.count() >1).exists()
inv-dh-ait-03errorAllergyIntolerance.recorderAt least reference or display or a valid identifier shall be present
: reference.exists() or display.exists() or identifier.where(system.count() + value.count() >1).exists()

 

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
category token SHALL food | medication | environment | biologic AllergyIntolerance.category
patient:identifier token SHALL Who the sensitivity is for by patient identifier AllergyIntolerance.patient.identifier
code token SHALL Code that identifies the allergy or intolerance AllergyIntolerance.code | AllergyIntolerance.reaction.substance
clinical-status token SHALL active | inactive | resolved AllergyIntolerance.code | AllergyIntolerance.reaction.substance

Mandatory Search Parameters

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

  1. SHALL support searching for all allergies for a patient using the patient:identifier search parameter:

    GET [base]/AllergyIntolerance?patient:identifier={system|}[code]

    Example:

     GET [base]/AllergyIntolerance?patient:identifier=http://ns.electronichealth.net.au/id/hi/ihi/1.0|8003608000228437
    

    Implementation Notes: Fetches a bundle of all AllergyIntolerance resources for the specified patient (how to search by :identifier)

  2. SHALL support searching using the combination patient:identifier and category search parameter:

    GET [base]/AllergyIntolerance?patient:identifier={system|}[code]&category[code]

    Example:

     GET [base]/AllergyIntolerance?patient:identifier=http://ns.electronichealth.net.au/id/hi/ihi/1.0|8003608000228437&category=medication
    

    Implementation Notes: Fetches a bundle of all AllergyIntolerance resources with the category of "medication" for the specified patient (how to search by :identifier)

  3. SHALL support searching using the combination patient:identifier and code search parameter:

    GET [base]/AllergyIntolerance?patient:identifier={system|}[code]&code={system|}[code]

    Example:

     GET [base]/AllergyIntolerance?patient:identifier=http://ns.electronichealth.net.au/id/hi/ihi/1.0|8003608000228437&code=http://snomed.info/sct|293619005
    

    Implementation Notes: Fetches a bundle of all AllergyIntolerance resources with the code of an 293619005 (Ibuprofen allergy) for the specified patient (how to search by :identifier and how to search by token)

  4. SHALL support searching using the combination patient:identifier and clinical-status search parameter:

    GET [base]/AllergyIntolerance?patient:identifier={system|}[code]&clinical-status={system|}[code]

    Example:

     GET [base]/AllergyIntolerance?patient:identifier=http://ns.electronichealth.net.au/id/hi/ihi/1.0|8003608000228437&clinical-status=http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical|active
    

    Implementation Notes: Fetches a bundle of all AllergyIntolerance resources for the specified patient and status code. This will not return any "entered in error" resources because of the conditional presence of the clinicalStatus element. (how to search by :identifier and how to search by token)