Australian Base Implementation Guide (AU Base 2)
This page is part of the Australian Base IG (v2.1.0: AU Base 2 on R4) based on FHIR R4. For a full list of available versions, see the Directory of published versions 
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.
NOTE: AU Base on STU3 included the extension Author as a Related Person which is now no longer required as direct R4 support is available as recorder (RelatedPerson).
Examples
Ibuprofen allergy, with a manifestation of urticaria
Self-reported allergy to eggs
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.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  AllergyIntolerance | I | 0..* | AllergyIntolerance | An allergy or intolerance statement in an Australian healthcare context inv-ait-0: Recorder and author related party shall not coexist |
  code | 0..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: https://healthterminologies.gov.au/fhir/ValueSet/indicator-hypersensitivity-intolerance-to-substance-1 (preferred) | |
 reaction | 0..* | BackboneElement | Reaction details | |
 substance | 0..1 | CodeableConcept | Specific substance or pharmaceutical product considered to be responsible for event Binding: https://healthterminologies.gov.au/fhir/ValueSet/adverse-reaction-agent-1 (preferred) | |
| manifestation | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 (preferred) | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AllergyIntolerance | I | 0..* | AllergyIntolerance | An allergy or intolerance statement in an Australian healthcare context inv-ait-0: Recorder and author related party shall not coexist |
 id | Σ | 0..1 | string | Logical id of this artifact |
 meta | ΣI | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
| language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
 extension | I | 0..* | Extension | Additional content defined by implementations |
 modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
| identifier | ΣI | 0..* | Identifier | External ids for this item |
| clinicalStatus | ?!ΣI | 0..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required) |
| verificationStatus | ?!ΣI | 0..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatusCodes (required) |
| type | ΣI | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required) |
| category | ΣI | 0..* | code | food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required) |
| criticality | ΣI | 0..1 | code | low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required) |
| code | ΣI | 0..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: https://healthterminologies.gov.au/fhir/ValueSet/indicator-hypersensitivity-intolerance-to-substance-1 (preferred) |
 patient | ΣI | 1..1 | Reference(Patient) | Who the sensitivity is for |
| encounter | I | 0..1 | Reference(Encounter) | Encounter when the allergy or intolerance was asserted |
 onset[x] | I | 0..1 | When allergy or intolerance was identified | |
 onsetDateTime | dateTime | |||
| onsetAge | Age | |||
| onsetPeriod | Period | |||
| onsetRange | Range | |||
| onsetString | string | |||
| recordedDate | I | 0..1 | dateTime | Date first version of the resource instance was recorded |
| recorder | I | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | Who recorded the sensitivity |
| asserter | ΣI | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | Source of the information about the allergy |
| lastOccurrence | I | 0..1 | dateTime | Date(/time) of last known occurrence of a reaction |
| note | I | 0..* | Annotation | Additional text not captured in other fields |
| reaction | I | 0..* | BackboneElement | Reaction details |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| substance | I | 0..1 | CodeableConcept | Specific substance or pharmaceutical product considered to be responsible for event Binding: https://healthterminologies.gov.au/fhir/ValueSet/adverse-reaction-agent-1 (preferred) |
| manifestation | I | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 (preferred) |
| description | I | 0..1 | string | Description of the event as a whole |
| onset | I | 0..1 | dateTime | Date(/time) when manifestations showed |
| severity | I | 0..1 | code | mild | moderate | severe (of event as a whole) Binding: AllergyIntoleranceSeverity (required) |
| exposureRoute | I | 0..1 | CodeableConcept | How the subject was exposed to the substance Binding: SNOMEDCTRouteCodes (example) |
| note | I | 0..* | Annotation | Text about event not captured in other fields |
| Documentation for this format | ||||
Differential View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AllergyIntolerance | I | 0..* | AllergyIntolerance | An allergy or intolerance statement in an Australian healthcare context inv-ait-0: Recorder and author related party shall not coexist |
| code | 0..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: https://healthterminologies.gov.au/fhir/ValueSet/indicator-hypersensitivity-intolerance-to-substance-1 (preferred) | |
| reaction | 0..* | BackboneElement | Reaction details | |
| substance | 0..1 | CodeableConcept | Specific substance or pharmaceutical product considered to be responsible for event Binding: https://healthterminologies.gov.au/fhir/ValueSet/adverse-reaction-agent-1 (preferred) | |
| manifestation | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 (preferred) | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AllergyIntolerance | I | 0..* | AllergyIntolerance | An allergy or intolerance statement in an Australian healthcare context inv-ait-0: Recorder and author related party shall not coexist |
| id | Σ | 0..1 | string | Logical id of this artifact |
| meta | ΣI | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
| language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
| identifier | ΣI | 0..* | Identifier | External ids for this item |
| clinicalStatus | ?!ΣI | 0..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required) |
| verificationStatus | ?!ΣI | 0..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatusCodes (required) |
| type | ΣI | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required) |
| category | ΣI | 0..* | code | food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required) |
| criticality | ΣI | 0..1 | code | low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required) |
| code | ΣI | 0..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: https://healthterminologies.gov.au/fhir/ValueSet/indicator-hypersensitivity-intolerance-to-substance-1 (preferred) |
| patient | ΣI | 1..1 | Reference(Patient) | Who the sensitivity is for |
| encounter | I | 0..1 | Reference(Encounter) | Encounter when the allergy or intolerance was asserted |
| onset[x] | I | 0..1 | When allergy or intolerance was identified | |
| onsetDateTime | dateTime | |||
| onsetAge | Age | |||
| onsetPeriod | Period | |||
| onsetRange | Range | |||
| onsetString | string | |||
| recordedDate | I | 0..1 | dateTime | Date first version of the resource instance was recorded |
| recorder | I | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | Who recorded the sensitivity |
| asserter | ΣI | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | Source of the information about the allergy |
| lastOccurrence | I | 0..1 | dateTime | Date(/time) of last known occurrence of a reaction |
| note | I | 0..* | Annotation | Additional text not captured in other fields |
| reaction | I | 0..* | BackboneElement | Reaction details |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| substance | I | 0..1 | CodeableConcept | Specific substance or pharmaceutical product considered to be responsible for event Binding: https://healthterminologies.gov.au/fhir/ValueSet/adverse-reaction-agent-1 (preferred) |
| manifestation | I | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 (preferred) |
| description | I | 0..1 | string | Description of the event as a whole |
| onset | I | 0..1 | dateTime | Date(/time) when manifestations showed |
| severity | I | 0..1 | code | mild | moderate | severe (of event as a whole) Binding: AllergyIntoleranceSeverity (required) |
| exposureRoute | I | 0..1 | CodeableConcept | How the subject was exposed to the substance Binding: SNOMEDCTRouteCodes (example) |
| note | I | 0..* | Annotation | Text about event not captured in other fields |
| Documentation for this format | ||||
Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron
Below is an overview of the required search and read operations.
Summary of Search Criteria for StructureDefinition-au-allergyintolerance
none defined
© AU Base 2 on FHIR R4 (IG Publisher v4.0.1-a53ec6ee1b) generated on Thu, Jul 30, 2020 13:57+1000. |
