AU Core Implementation Guide
1.1.0-ci-build - CI Build
AU Core Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 1.1.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/au-fhir-core/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org.au/fhir/core/StructureDefinition/au-core-allergyintolerance | Version: 1.1.0-ci-build | |||
Standards status: Trial-use | Maturity Level: 2 | Computable Name: AUCoreAllergyIntolerance | ||
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2022+; 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.
See Comparison with other national and international IGs for a comparison between AU Core profiles and profiles in other implementation guides.
The following are supported usage scenarios for this profile:
AllergyIntolerance.code
AllergyIntolerance.code.text
and/or AllergyIntolerance.code.coding.display
so that requesters can at least display the condition even if the requester does not recognise the code supplied.AllergyIntolerance.code
and AllergyIntolerance.verificationStatus
of “confirmed” or “unconfirmed”AllergyIntolerance.code
Usage:
Changes since version 1.0.0:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Other representations of profile: CSV, Excel, Schematron
Below is an overview of the mandatory and optional search parameters and combined search parameters. See the AU Core CapabilityStatements for a complete list of supported RESTful interactions for this IG.
FHIR search operations are described here and the syntax used to describe AU Core interactions is defined here.
Any search parameter defined in FHIR may be ‘allowed’ by the system unless explicitly marked as “SHALL NOT”. A few items are marked as MAY in this implementation guide to highlight their potential relevance.
Parameter(s) | Conformance | Type(s) | Requirements (when used alone or in combination) |
---|---|---|---|
patient | SHALL | reference |
The requester SHALL provide at least an id value and MAY provide both the Type and id values. The responder SHALL support both. The requester SHOULD support chained search patient.identifier using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. The responder SHOULD support chained search patient.identifier using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. |
patient+clinical-status | SHOULD | reference +token |
|
clinical-status | MAY | token |
The requester SHALL provide at least a code value and MAY provide both the system and code values. The responder SHALL support both. |
The following search parameters and search parameter combinations SHALL be supported:
patient
search parameter:
patient.identifier
(e.g. patient.identifier=[system|][code]
)GET [base]/AllergyIntolerance?patient={Type/}[id]
or optionally GET [base]/AllergyIntolerance?patient.identifier=[system|][code]
Example:
Implementation Notes: Fetches a bundle of all AllergyIntolerance resources for the specified patient (how to search by reference and how to search by token)
The following search parameters and search parameter combinations SHOULD be supported:
patient
and clinical-status
search parameters:
patient.identifier
(e.g. patient.identifier=[system|][code]
)GET [base]/AllergyIntolerance?patient={Type/}[id]&clinical-status={system|}[code]{,{system|}[code],...}
Example:
Implementation Notes: Fetches a bundle of all AllergyIntolerance resources for the specified patient and status (how to search by reference and how to search by token)