| Name | Value | Comments |
|---|
 abstract | false | |
| baseDefinition | http://hl7.org/fhir/StructureDefinition/AllergyIntolerance | http://hl7.org.au/fhir/core/StructureDefinition/au-core-allergyintolerance | |
| copyright | | Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2022+; Licensed Under Creative Commons No Rights Reserved. | - Added the item 'Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2022+; Licensed Under Creative Commons No Rights Reserved.'
|
| date | 2024-06-19T10:50:07-05:00 | 2025-10-14T20:27:28+00:00 | |
| description | This profile represents the constraints applied to the AllergyIntolerance resource by the International Patient Summary (IPS) FHIR Implementation Guide. A record of an allergy or intolerance is represented in the patient summary as an instance of an AllergyIntolerance resource constrained by this profile.
It documents the relevant allergies or intolerances for a patient, describing the kind of reaction (e.g. rash, anaphylaxis,..); preferably the agents that cause it; and optionally the criticality and the certainty of the allergy. | This profile sets minimum expectations for an AllergyIntolerance resource in the context of a patient summary in an Australian context. It is based on the [AU Core AllergyIntolerance](https://build.fhir.org/ig/hl7au/au-fhir-core/StructureDefinition-au-core-allergyintolerance.html) profile, and applies the additional requirements from [AllergyIntolerance (IPS)](http://hl7.org/fhir/uv/ips/StructureDefinition/AllergyIntolerance-uv-ips). | |
| experimental | | |
| fhirVersion | 4.0.1 | |
| jurisdiction | | |
 jurisdiction[0] | http://unstats.un.org/unsd/methods/m49/m49.htm#001 | | - Removed the item 'http://unstats.un.org/unsd/methods/m49/m49.htm#001'
|
 jurisdiction[1] | | urn:iso:std:iso:3166#AU | - Added the item 'urn:iso:std:iso:3166#AU'
|
| kind | resource | |
| name | AllergyIntoleranceUvIps | AUPSAllergyIntolerance | |
| publisher | HL7 International / Patient Care | HL7 Australia | |
| purpose | This profile constrains the representation of a record of an allergy or intolerance of the patient, in the context of the international patient summary as specified by the IPS project of HL7 International. | | - Removed the item 'This profile constrains the representation of a record of an allergy or intolerance of the patient, in the context of the international patient summary as specified by the IPS project of HL7 International.'
|
| status | active | draft | |
| title | AllergyIntolerance (IPS) | AU PS AllergyIntolerance | |
| type | AllergyIntolerance | |
| url | http://hl7.org/fhir/uv/ips/StructureDefinition/AllergyIntolerance-uv-ips | http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-allergyintolerance | |
| version | 2.0.0 | 0.5.0-cibuild | |
| Name | L Flags | L Card. | L Type | L Description & Constraints | R Flags | R Card. | R Type | R Description & Constraints | Comments |
|---|
 AllergyIntolerance | C | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
| C | 0..* | AUCoreAllergyIntolerance | An allergy or intolerance statement in an Australian healthcare context
This profile also complies with the profile AllergyIntolerance (IPS)
| |
| id | Σ | 0..1 | id | Logical id of this artifact | Σ | 0..1 | id | Logical id of this artifact | |
| meta | Σ | 0..1 | Meta | Metadata about the resource | Σ | 0..1 | Meta | Metadata about the resource | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ?!Σ | 0..1 | uri | A set of rules under which this content was created | |
| language | | 0..1 | code | Language of the resource content
Binding: ?? (preferred): A human language. | | 0..1 | code | Language of the resource content
Binding: ?? (preferred): A human language. | - Example/preferred bindings differ at AllergyIntolerance.language using binding from AllergyIntoleranceUvIps
|
| text | | 0..1 | Narrative | Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements | | 0..1 | Narrative | Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |
| contained | | 0..* | Resource | Contained, inline Resources
| | 0..* | Resource | Contained, inline Resources
| |
 Slices for extension | | 0..* | Extension | Extension
Slice: Unordered, Open by value:url
| | 0..* | Extension | Additional content defined by implementations
| |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
| ?! | 0..* | Extension | Extensions that cannot be ignored
| |
| identifier | Σ | 0..* | Identifier | External ids for this item
| Σ | 0..* | Identifier | External ids for this item
| |
| clinicalStatus | ?!SOΣC | 0..1 | ?? | active | inactive | resolved
Binding: ?? (required): The clinical status of the allergy or intolerance.| Obligations | Actor | | SHALL:populate-if-known | Creator (IPS) | | SHALL:handle | Consumer (IPS) | | SHOULD:display | Consumer (IPS) |
| ?!SOΣC | 0..1 | ?? | active | inactive | resolved
Binding: ?? (required): The clinical status of the allergy or intolerance. | |
| verificationStatus | ?!ΣC | 0..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error
Binding: ?? (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance. | ?!SOΣC | 0..1 | ?? | unconfirmed | confirmed | refuted | entered-in-error
Binding: ?? (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance. | - Elements differ in definition for mustSupport: 'false' vs 'true'
|
| type | SOΣ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known)
Binding: ?? (required): Identification of the underlying physiological mechanism for a Reaction Risk.| Obligations | Actor | | SHALL:populate-if-known | Creator (IPS) | | SHALL:handle | Consumer (IPS) | | SHOULD:display | Consumer (IPS) |
| SOΣ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known)
Binding: ?? (required): Identification of the underlying physiological mechanism for a Reaction Risk. | |
| category | Σ | 0..* | code | food | medication | environment | biologic
Binding: ?? (required): Category of an identified substance associated with allergies or intolerances.
| Σ | 0..* | code | food | medication | environment | biologic
Binding: ?? (required): Category of an identified substance associated with allergies or intolerances.
| |
| criticality | Σ | 0..1 | code | low | high | unable-to-assess
Binding: ?? (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance. | Σ | 0..1 | code | low | high | unable-to-assess
Binding: ?? (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance. | |
| code | SOΣ | 1..1 | ?? | Code that identifies the allergy or intolerance
Binding: ?? (preferred): Type of the substance/product, allergy or intolerance condition or a code for absent/unknown allergy.| Additional Bindings | Purpose | | ?? | candidate |
| Obligations | Actor | | SHALL:populate-if-known | Creator (IPS) | | SHALL:handle | Consumer (IPS) | | SHOULD:display | Consumer (IPS) |
| SOΣ | 1..1 | ?? | Code that identifies the allergy or intolerance
Binding: ?? (extensible)| Additional Bindings | Purpose | | ?? | candidate |
| |
 patient | SOΣ | 1..1 | Reference(Patient (IPS)) | Who the sensitivity is for| Obligations | Actor | | SHALL:populate-if-known | Creator (IPS) | | SHALL:handle | Consumer (IPS) | | SHOULD:display | Consumer (IPS) |
| SOΣ | 1..1 | Reference(AU PS Patient) | Who the sensitivity is for | |
 id | | 0..1 | string | Unique id for inter-element referencing | | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | | 0..* | Extension | Additional content defined by implementations
Slice: Unordered, Open by value:url
| | 0..* | Extension | Additional content defined by implementations
Slice: Unordered, Open by value:url
| |
| reference | SOΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL| Obligations | Actor | | SHALL:populate-if-known | Creator (IPS) | | SHALL:handle | Consumer (IPS) |
| SOΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | |
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient")
Binding: ?? (extensible): Aa resource (or, for logical models, the URI of the logical model). | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient")
Binding: ?? (extensible): Aa resource (or, for logical models, the URI of the logical model). | |
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | |
| display | Σ | 0..1 | string | Text alternative for the resource | Σ | 0..1 | string | Text alternative for the resource | |
| encounter | | 0..1 | Reference(Encounter) | Encounter when the allergy or intolerance was asserted | | 0..1 | Reference(Encounter) | Encounter when the allergy or intolerance was asserted | |
| Slices for onset[x] | SO | 0..1 | dateTime, Age, Period, Range, string | When allergy or intolerance was identified
Slice: Unordered, Open by type:$this| Obligations | Actor | | SHALL:populate-if-known | Creator (IPS) | | SHALL:handle | Consumer (IPS) | | SHOULD:display | Consumer (IPS) |
| SO | 0..1 | dateTime S, Age, Period, Range | When allergy or intolerance was identified | |
| recordedDate | | 0..1 | dateTime | Date first version of the resource instance was recorded | | 0..1 | dateTime | Date first version of the resource instance was recorded | |
| recorder | | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | Who recorded the sensitivity | | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | Who recorded the sensitivity | |
| asserter | Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | Source of the information about the allergy | Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | Source of the information about the allergy | |
| lastOccurrence | | 0..1 | dateTime | Date(/time) of last known occurrence of a reaction | | 0..1 | dateTime | Date(/time) of last known occurrence of a reaction | |
| note | | 0..* | Annotation | Additional text not captured in other fields
| SO | 0..* | Annotation | Additional text not captured in other fields
| - Elements differ in definition for mustSupport: 'false' vs 'true'
|
 reaction | SO | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance
| Obligations | Actor | | SHALL:populate-if-known | Creator (IPS) | | SHALL:handle | Consumer (IPS) | | SHOULD:display | Consumer (IPS) |
| SO | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance
| |
 id | | 0..1 | string | Unique id for inter-element referencing | | 0..1 | string | Unique id for inter-element referencing | |
| extension | | 0..* | Extension | Additional content defined by implementations
| | 0..* | Extension | Additional content defined by implementations
| |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
| ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
| |
| substance | | 0..1 | CodeableConcept | Specific substance or pharmaceutical product considered to be responsible for event
Binding: ?? (example): Codes defining the type of the substance (including pharmaceutical products). | | 0..1 | CodeableConcept | Specific substance or pharmaceutical product considered to be responsible for event
Binding: ?? (preferred) | - Example/preferred bindings differ at AllergyIntolerance.reaction.substance using binding from AUPSAllergyIntolerance
|
| manifestation | SO | 1..* | ?? | Clinical symptoms/signs associated with the Event
Binding: ?? (preferred): Code for the allergy or intolerance reaction manifestation from SNOMED CT.
| Obligations | Actor | | SHALL:populate-if-known | Creator (IPS) | | SHALL:handle | Consumer (IPS) | | SHOULD:display | Consumer (IPS) |
| SO | 1..* | ?? | Clinical symptoms/signs associated with the Event
Binding: ?? (preferred)
| - Example/preferred bindings differ at AllergyIntolerance.reaction.manifestation using binding from AllergyIntoleranceUvIps
|
| description | | 0..1 | string | Description of the event as a whole | | 0..1 | string | Description of the event as a whole | |
| onset | | 0..1 | dateTime | Date(/time) when manifestations showed | | 0..1 | dateTime | Date(/time) when manifestations showed | |
| severity | SO | 0..1 | code | mild | moderate | severe (of event as a whole)
Binding: ?? (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations.| Obligations | Actor | | SHALL:populate-if-known | Creator (IPS) | | SHALL:handle | Consumer (IPS) | | SHOULD:display | Consumer (IPS) |
| SO | 0..1 | code | mild | moderate | severe (of event as a whole)
Binding: ?? (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations. | |
| exposureRoute | | 0..1 | CodeableConcept | How the subject was exposed to the substance
Binding: ?? (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. | | 0..1 | CodeableConcept | How the subject was exposed to the substance
Binding: ?? (preferred) | - Example/preferred bindings differ at AllergyIntolerance.reaction.exposureRoute using binding from AUPSAllergyIntolerance
|
| note | | 0..* | Annotation | Text about event not captured in other fields
| | 0..* | Annotation | Text about event not captured in other fields
| |
Documentation for this format |