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 
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 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
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 |
  extension | 0..* | Extension | Slice: Unordered, Open by value:url | |
 author-related-person | 0..1 | Reference(RelatedPerson) | Related person that authored the resource URL: http://hl7.org.au/fhir/StructureDefinition/author-related-person | |
 code | 0..1 | CodeableConcept | Binding: https://healthterminologies.gov.au/fhir/ValueSet/indicator-hypersensitivity-intolerance-to-substance-1 (preferred) | |
 reaction | 0..* | BackboneElement | Reaction details | |
 substance | 0..1 | CodeableConcept | Binding: https://healthterminologies.gov.au/fhir/ValueSet/adverse-reaction-agent-1 (preferred) | |
| manifestation | 1..* | CodeableConcept | 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 | id | Logical id of this artifact |
 meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) Max Binding: All Languages | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| author-related-person | I | 0..1 | Reference(RelatedPerson) | Related person that authored the resource URL: http://hl7.org.au/fhir/StructureDefinition/author-related-person |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..* | Identifier | External ids for this item |
| clinicalStatus | ?!ΣI | 0..1 | code | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatus (required) |
| verificationStatus | ?!ΣI | 1..1 | code | unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatus (required) |
| type | Σ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required) |
| category | Σ | 0..* | code | food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required) |
| criticality | Σ | 0..1 | code | low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required) |
| 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) |
 patient | Σ | 1..1 | Reference(Patient) | Who the sensitivity is for |
 onset[x] | 0..1 | When allergy or intolerance was identified | ||
 onsetDateTime | dateTime | |||
| onsetAge | Age | |||
| onsetPeriod | Period | |||
| onsetRange | Range | |||
| onsetString | string | |||
| assertedDate | 0..1 | dateTime | Date record was believed accurate | |
| recorder | 0..1 | Reference(Practitioner | Patient) | Who recorded the sensitivity | |
| asserter | Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner) | Source of the information about the allergy |
| lastOccurrence | 0..1 | dateTime | Date(/time) of last known occurrence of a reaction | |
| note | 0..* | Annotation | Additional text not captured in other fields | |
| reaction | I | 0..* | BackboneElement | Reaction details |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| 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) | |
| description | 0..1 | string | Description of the event as a whole | |
| onset | 0..1 | dateTime | Date(/time) when manifestations showed | |
| severity | 0..1 | code | mild | moderate | severe (of event as a whole) Binding: AllergyIntoleranceSeverity (required) | |
| exposureRoute | 0..1 | CodeableConcept | How the subject was exposed to the substance Binding: SNOMED CT Route Codes (example) | |
| note | 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 |
| extension | 0..* | Extension | Slice: Unordered, Open by value:url | |
| author-related-person | 0..1 | Reference(RelatedPerson) | Related person that authored the resource URL: http://hl7.org.au/fhir/StructureDefinition/author-related-person | |
| code | 0..1 | CodeableConcept | Binding: https://healthterminologies.gov.au/fhir/ValueSet/indicator-hypersensitivity-intolerance-to-substance-1 (preferred) | |
| reaction | 0..* | BackboneElement | Reaction details | |
| substance | 0..1 | CodeableConcept | Binding: https://healthterminologies.gov.au/fhir/ValueSet/adverse-reaction-agent-1 (preferred) | |
| manifestation | 1..* | CodeableConcept | 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 | id | Logical id of this artifact |
| meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) Max Binding: All Languages | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| author-related-person | I | 0..1 | Reference(RelatedPerson) | Related person that authored the resource URL: http://hl7.org.au/fhir/StructureDefinition/author-related-person |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..* | Identifier | External ids for this item |
| clinicalStatus | ?!ΣI | 0..1 | code | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatus (required) |
| verificationStatus | ?!ΣI | 1..1 | code | unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatus (required) |
| type | Σ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required) |
| category | Σ | 0..* | code | food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required) |
| criticality | Σ | 0..1 | code | low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required) |
| 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) |
| patient | Σ | 1..1 | Reference(Patient) | Who the sensitivity is for |
| onset[x] | 0..1 | When allergy or intolerance was identified | ||
| onsetDateTime | dateTime | |||
| onsetAge | Age | |||
| onsetPeriod | Period | |||
| onsetRange | Range | |||
| onsetString | string | |||
| assertedDate | 0..1 | dateTime | Date record was believed accurate | |
| recorder | 0..1 | Reference(Practitioner | Patient) | Who recorded the sensitivity | |
| asserter | Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner) | Source of the information about the allergy |
| lastOccurrence | 0..1 | dateTime | Date(/time) of last known occurrence of a reaction | |
| note | 0..* | Annotation | Additional text not captured in other fields | |
| reaction | I | 0..* | BackboneElement | Reaction details |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| 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) | |
| description | 0..1 | string | Description of the event as a whole | |
| onset | 0..1 | dateTime | Date(/time) when manifestations showed | |
| severity | 0..1 | code | mild | moderate | severe (of event as a whole) Binding: AllergyIntoleranceSeverity (required) | |
| exposureRoute | 0..1 | CodeableConcept | How the subject was exposed to the substance Binding: SNOMED CT Route Codes (example) | |
| note | 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 1.1.1 on FHIR STU3 (IG Publisher v3.0.2-11200) generated on Wed, Jan 22, 2020 10:17+1100. |
