Australian Digital Health Agency FHIR Implementation Guide
1.2.0-ci-build - draft
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/robeastwood-agency/test-fhir-ig-2/ and changes regularly. See the Directory of published versions
| Official URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-allergyintolerance-core-1 | Version: 0.1.2 | |||
| Draft as of 2024-10-04 | Computable Name: ADHAAllergyIntoleranceCore | |||
Copyright/Legal: Copyright © 2023 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 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.
This profile is designed to set a core AllergyIntolerance standard for:
This profile is used by the following APIs:
AllergyIntolerance.verificationStatus is "unconfirmed" where a sending system does not clearly have this element or "confirmed" depending on the level of certainty.AllergyIntolerance.code.AllergyIntolerance.code and AllergyIntolerance.clinicalStatus of "confirmed" or "unconfirmed".AllergyIntolerance.code and optionally in AllergyIntolerance.reaction.substance.Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AUBaseAllergyIntolerance
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  AllergyIntolerance |
C | 0..* | AUBaseAllergyIntolerance | 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 |
  clinicalStatus |
S | 0..1 | CodeableConcept | active | inactive | resolved |
| verificationStatus |
S | 0..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error |
| 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 |
| code |
S | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance |
 patient |
SC | 1..1 | Reference(http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-patient-core-1) | Who the sensitivity is for inv-dh-ait-02: At least reference or a valid identifier shall be present |
| encounter |
S | 0..1 | Reference(http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-encounter-core-1) | Encounter when the allergy or intolerance was asserted |
  onset[x] |
S | 0..1 | When allergy or intolerance was identified | |
  onsetDateTime |
dateTime | |||
 onsetAge |
Age | |||
| onsetPeriod |
Period | |||
 onsetRange |
Range | |||
| recorder |
SC | 1..1 | Reference(http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-patient-core-1 | http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-relatedperson-author-1 | http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-practitionerrole-author-1) | Who recorded the sensitivity inv-dh-ait-03: At least reference or display or a valid identifier shall be present |
| asserter |
SC | 0..1 | Reference(http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-patient-core-1 | http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-relatedperson-core-1 | http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-practitionerrole-core-1) | Source of the information about the allergy |
| note |
S | 0..* | Annotation | Additional text not captured in other fields |
 reaction |
S | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance |
 substance |
S | 0..1 | CodeableConcept | Specific substance or pharmaceutical product considered to be responsible for event |
| manifestation |
S | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event |
| severity |
S | 0..1 | code | mild | moderate | severe (of event as a whole) |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| inv-dh-ait-01 | error | AllergyIntolerance | If 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-02 | error | AllergyIntolerance.patient | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
| inv-dh-ait-03 | error | AllergyIntolerance.recorder | At 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() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AllergyIntolerance |
C | 0..* | AUBaseAllergyIntolerance | An allergy or intolerance statement in an Australian healthcare context ait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error inv-dh-ait-01: If present, an asserter shall at least have a reference, an identifier or a display |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| clinicalStatus |
?!SΣC | 0..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. |
| verificationStatus |
?!SΣC | 0..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance. |
| type |
SΣ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk. |
| category |
SΣ | 0..* | code | food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances. |
| criticality |
SΣ | 0..1 | code | low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance. |
| code |
SΣ | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: Indicator of Hypersensitivity or Intolerance to Substance  (preferred) |
| patient |
SΣC | 1..1 | Reference(http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-patient-core-1) | Who the sensitivity is for inv-dh-ait-02: At least reference or a valid identifier shall be present |
| encounter |
S | 0..1 | Reference(http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-encounter-core-1) | Encounter when the allergy or intolerance was asserted |
| onset[x] |
S | 0..1 | When allergy or intolerance was identified | |
| onsetDateTime |
dateTime | |||
| onsetAge |
Age | |||
| onsetPeriod |
Period | |||
| onsetRange |
Range | |||
| recorder |
SC | 1..1 | Reference(http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-patient-core-1 | http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-relatedperson-author-1 | http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-practitionerrole-author-1) | Who recorded the sensitivity inv-dh-ait-03: At least reference or display or a valid identifier shall be present |
| asserter |
SΣC | 0..1 | Reference(http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-patient-core-1 | http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-relatedperson-core-1 | http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-practitionerrole-core-1) | Source of the information about the allergy |
| note |
S | 0..* | Annotation | Additional text not captured in other fields |
| reaction |
S | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| substance |
S | 0..1 | CodeableConcept | Specific substance or pharmaceutical product considered to be responsible for event Binding: Adverse Reaction Agent (preferred) |
| manifestation |
S | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: Clinical Finding (preferred) |
| severity |
S | 0..1 | code | mild | moderate | severe (of event as a whole) Binding: AllergyIntoleranceSeverity (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1from the FHIR Standard | |
| AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1from the FHIR Standard | |
| AllergyIntolerance.type | required | AllergyIntoleranceTypehttp://hl7.org/fhir/ValueSet/allergy-intolerance-type|4.0.1from the FHIR Standard | |
| AllergyIntolerance.category | required | AllergyIntoleranceCategoryhttp://hl7.org/fhir/ValueSet/allergy-intolerance-category|4.0.1from the FHIR Standard | |
| AllergyIntolerance.criticality | required | AllergyIntoleranceCriticalityhttp://hl7.org/fhir/ValueSet/allergy-intolerance-criticality|4.0.1from the FHIR Standard | |
| AllergyIntolerance.code | preferred | IndicatorOfHypersensitivityOrIntoleranceToSubstance https://healthterminologies.gov.au/fhir/ValueSet/indicator-hypersensitivity-intolerance-to-substance-2 | |
| AllergyIntolerance.reaction.substance | preferred | AdverseReactionAgent https://healthterminologies.gov.au/fhir/ValueSet/adverse-reaction-agent-1 | |
| AllergyIntolerance.reaction.manifestation | preferred | ClinicalFinding https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 | |
| AllergyIntolerance.reaction.severity | required | AllergyIntoleranceSeverityhttp://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| inv-dh-ait-01 | error | AllergyIntolerance | If 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-02 | error | AllergyIntolerance.patient | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
| inv-dh-ait-03 | error | AllergyIntolerance.recorder | At 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() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| AllergyIntolerance |
C | 0..* | AUBaseAllergyIntolerance | An allergy or intolerance statement in an Australian healthcare context ait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error inv-dh-ait-01: If present, an asserter shall at least have a reference, an identifier or a display | ||||
| 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: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | External ids for this item | ||||
| clinicalStatus |
?!SΣC | 0..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. | ||||
| verificationStatus |
?!SΣC | 0..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance. | ||||
| type |
SΣ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk. | ||||
| category |
SΣ | 0..* | code | food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances. | ||||
| criticality |
SΣ | 0..1 | code | low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance. | ||||
| code |
SΣ | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: Indicator of Hypersensitivity or Intolerance to Substance (preferred) | ||||
| patient |
SΣC | 1..1 | Reference(http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-patient-core-1) | Who the sensitivity is for inv-dh-ait-02: At least reference or a valid identifier shall be present | ||||
| encounter |
S | 0..1 | Reference(http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-encounter-core-1) | Encounter when the allergy or intolerance was asserted | ||||
| onset[x] |
S | 0..1 | When allergy or intolerance was identified | |||||
| onsetDateTime |
dateTime | |||||||
| onsetAge |
Age | |||||||
| onsetPeriod |
Period | |||||||
| onsetRange |
Range | |||||||
| recordedDate |
0..1 | dateTime | Date first version of the resource instance was recorded | |||||
| recorder |
SC | 1..1 | Reference(http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-patient-core-1 | http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-relatedperson-author-1 | http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-practitionerrole-author-1) | Who recorded the sensitivity inv-dh-ait-03: At least reference or display or a valid identifier shall be present | ||||
| asserter |
SΣC | 0..1 | Reference(http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-patient-core-1 | http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-relatedperson-core-1 | http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-practitionerrole-core-1) | Source of the information about the allergy | ||||
| lastOccurrence |
0..1 | dateTime | Date(/time) of last known occurrence of a reaction | |||||
| note |
S | 0..* | Annotation | Additional text not captured in other fields | ||||
| reaction |
S | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| substance |
S | 0..1 | CodeableConcept | Specific substance or pharmaceutical product considered to be responsible for event Binding: Adverse Reaction Agent (preferred) | ||||
| manifestation |
S | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: Clinical Finding (preferred) | ||||
| description |
0..1 | string | Description of the event as a whole | |||||
| onset |
0..1 | dateTime | Date(/time) when manifestations showed | |||||
| severity |
S | 0..1 | code | mild | moderate | severe (of event as a whole) Binding: AllergyIntoleranceSeverity (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: Route of Administration (preferred) | |||||
| note |
0..* | Annotation | Text about event not captured in other fields | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| AllergyIntolerance.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1from the FHIR Standard | ||||
| AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1from the FHIR Standard | ||||
| AllergyIntolerance.type | required | AllergyIntoleranceTypehttp://hl7.org/fhir/ValueSet/allergy-intolerance-type|4.0.1from the FHIR Standard | ||||
| AllergyIntolerance.category | required | AllergyIntoleranceCategoryhttp://hl7.org/fhir/ValueSet/allergy-intolerance-category|4.0.1from the FHIR Standard | ||||
| AllergyIntolerance.criticality | required | AllergyIntoleranceCriticalityhttp://hl7.org/fhir/ValueSet/allergy-intolerance-criticality|4.0.1from the FHIR Standard | ||||
| AllergyIntolerance.code | preferred | IndicatorOfHypersensitivityOrIntoleranceToSubstance https://healthterminologies.gov.au/fhir/ValueSet/indicator-hypersensitivity-intolerance-to-substance-2 | ||||
| AllergyIntolerance.reaction.substance | preferred | AdverseReactionAgent https://healthterminologies.gov.au/fhir/ValueSet/adverse-reaction-agent-1 | ||||
| AllergyIntolerance.reaction.manifestation | preferred | ClinicalFinding https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 | ||||
| AllergyIntolerance.reaction.severity | required | AllergyIntoleranceSeverityhttp://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1from the FHIR Standard | ||||
| AllergyIntolerance.reaction.exposureRoute | preferred | RouteOfAdministration https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 |
| Id | Grade | Path(s) | Details | Requirements |
| inv-dh-ait-01 | error | AllergyIntolerance | If 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-02 | error | AllergyIntolerance.patient | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
| inv-dh-ait-03 | error | AllergyIntolerance.recorder | At 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() |
This structure is derived from AUBaseAllergyIntolerance
Summary
Mandatory: 2 elements
Must-Support: 16 elements
Structures
This structure refers to these other structures:
Differential View
This structure is derived from AUBaseAllergyIntolerance
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AllergyIntolerance |
C | 0..* | AUBaseAllergyIntolerance | 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 |
| clinicalStatus |
S | 0..1 | CodeableConcept | active | inactive | resolved |
| verificationStatus |
S | 0..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error |
| 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 |
| code |
S | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance |
| patient |
SC | 1..1 | Reference(http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-patient-core-1) | Who the sensitivity is for inv-dh-ait-02: At least reference or a valid identifier shall be present |
| encounter |
S | 0..1 | Reference(http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-encounter-core-1) | Encounter when the allergy or intolerance was asserted |
| onset[x] |
S | 0..1 | When allergy or intolerance was identified | |
| onsetDateTime |
dateTime | |||
| onsetAge |
Age | |||
| onsetPeriod |
Period | |||
| onsetRange |
Range | |||
| recorder |
SC | 1..1 | Reference(http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-patient-core-1 | http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-relatedperson-author-1 | http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-practitionerrole-author-1) | Who recorded the sensitivity inv-dh-ait-03: At least reference or display or a valid identifier shall be present |
| asserter |
SC | 0..1 | Reference(http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-patient-core-1 | http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-relatedperson-core-1 | http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-practitionerrole-core-1) | Source of the information about the allergy |
| note |
S | 0..* | Annotation | Additional text not captured in other fields |
| reaction |
S | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance |
| substance |
S | 0..1 | CodeableConcept | Specific substance or pharmaceutical product considered to be responsible for event |
| manifestation |
S | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event |
| severity |
S | 0..1 | code | mild | moderate | severe (of event as a whole) |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| inv-dh-ait-01 | error | AllergyIntolerance | If 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-02 | error | AllergyIntolerance.patient | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
| inv-dh-ait-03 | error | AllergyIntolerance.recorder | At 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() |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AllergyIntolerance |
C | 0..* | AUBaseAllergyIntolerance | An allergy or intolerance statement in an Australian healthcare context ait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error inv-dh-ait-01: If present, an asserter shall at least have a reference, an identifier or a display |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| clinicalStatus |
?!SΣC | 0..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. |
| verificationStatus |
?!SΣC | 0..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance. |
| type |
SΣ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk. |
| category |
SΣ | 0..* | code | food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances. |
| criticality |
SΣ | 0..1 | code | low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance. |
| code |
SΣ | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: Indicator of Hypersensitivity or Intolerance to Substance (preferred) |
| patient |
SΣC | 1..1 | Reference(http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-patient-core-1) | Who the sensitivity is for inv-dh-ait-02: At least reference or a valid identifier shall be present |
| encounter |
S | 0..1 | Reference(http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-encounter-core-1) | Encounter when the allergy or intolerance was asserted |
| onset[x] |
S | 0..1 | When allergy or intolerance was identified | |
| onsetDateTime |
dateTime | |||
| onsetAge |
Age | |||
| onsetPeriod |
Period | |||
| onsetRange |
Range | |||
| recorder |
SC | 1..1 | Reference(http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-patient-core-1 | http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-relatedperson-author-1 | http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-practitionerrole-author-1) | Who recorded the sensitivity inv-dh-ait-03: At least reference or display or a valid identifier shall be present |
| asserter |
SΣC | 0..1 | Reference(http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-patient-core-1 | http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-relatedperson-core-1 | http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-practitionerrole-core-1) | Source of the information about the allergy |
| note |
S | 0..* | Annotation | Additional text not captured in other fields |
| reaction |
S | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| substance |
S | 0..1 | CodeableConcept | Specific substance or pharmaceutical product considered to be responsible for event Binding: Adverse Reaction Agent (preferred) |
| manifestation |
S | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: Clinical Finding (preferred) |
| severity |
S | 0..1 | code | mild | moderate | severe (of event as a whole) Binding: AllergyIntoleranceSeverity (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1from the FHIR Standard | |
| AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1from the FHIR Standard | |
| AllergyIntolerance.type | required | AllergyIntoleranceTypehttp://hl7.org/fhir/ValueSet/allergy-intolerance-type|4.0.1from the FHIR Standard | |
| AllergyIntolerance.category | required | AllergyIntoleranceCategoryhttp://hl7.org/fhir/ValueSet/allergy-intolerance-category|4.0.1from the FHIR Standard | |
| AllergyIntolerance.criticality | required | AllergyIntoleranceCriticalityhttp://hl7.org/fhir/ValueSet/allergy-intolerance-criticality|4.0.1from the FHIR Standard | |
| AllergyIntolerance.code | preferred | IndicatorOfHypersensitivityOrIntoleranceToSubstance https://healthterminologies.gov.au/fhir/ValueSet/indicator-hypersensitivity-intolerance-to-substance-2 | |
| AllergyIntolerance.reaction.substance | preferred | AdverseReactionAgent https://healthterminologies.gov.au/fhir/ValueSet/adverse-reaction-agent-1 | |
| AllergyIntolerance.reaction.manifestation | preferred | ClinicalFinding https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 | |
| AllergyIntolerance.reaction.severity | required | AllergyIntoleranceSeverityhttp://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| inv-dh-ait-01 | error | AllergyIntolerance | If 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-02 | error | AllergyIntolerance.patient | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
| inv-dh-ait-03 | error | AllergyIntolerance.recorder | At 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() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| AllergyIntolerance |
C | 0..* | AUBaseAllergyIntolerance | An allergy or intolerance statement in an Australian healthcare context ait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error inv-dh-ait-01: If present, an asserter shall at least have a reference, an identifier or a display | ||||
| 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: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | External ids for this item | ||||
| clinicalStatus |
?!SΣC | 0..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. | ||||
| verificationStatus |
?!SΣC | 0..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance. | ||||
| type |
SΣ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk. | ||||
| category |
SΣ | 0..* | code | food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances. | ||||
| criticality |
SΣ | 0..1 | code | low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance. | ||||
| code |
SΣ | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: Indicator of Hypersensitivity or Intolerance to Substance (preferred) | ||||
| patient |
SΣC | 1..1 | Reference(http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-patient-core-1) | Who the sensitivity is for inv-dh-ait-02: At least reference or a valid identifier shall be present | ||||
| encounter |
S | 0..1 | Reference(http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-encounter-core-1) | Encounter when the allergy or intolerance was asserted | ||||
| onset[x] |
S | 0..1 | When allergy or intolerance was identified | |||||
| onsetDateTime |
dateTime | |||||||
| onsetAge |
Age | |||||||
| onsetPeriod |
Period | |||||||
| onsetRange |
Range | |||||||
| recordedDate |
0..1 | dateTime | Date first version of the resource instance was recorded | |||||
| recorder |
SC | 1..1 | Reference(http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-patient-core-1 | http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-relatedperson-author-1 | http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-practitionerrole-author-1) | Who recorded the sensitivity inv-dh-ait-03: At least reference or display or a valid identifier shall be present | ||||
| asserter |
SΣC | 0..1 | Reference(http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-patient-core-1 | http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-relatedperson-core-1 | http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-practitionerrole-core-1) | Source of the information about the allergy | ||||
| lastOccurrence |
0..1 | dateTime | Date(/time) of last known occurrence of a reaction | |||||
| note |
S | 0..* | Annotation | Additional text not captured in other fields | ||||
| reaction |
S | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| substance |
S | 0..1 | CodeableConcept | Specific substance or pharmaceutical product considered to be responsible for event Binding: Adverse Reaction Agent (preferred) | ||||
| manifestation |
S | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: Clinical Finding (preferred) | ||||
| description |
0..1 | string | Description of the event as a whole | |||||
| onset |
0..1 | dateTime | Date(/time) when manifestations showed | |||||
| severity |
S | 0..1 | code | mild | moderate | severe (of event as a whole) Binding: AllergyIntoleranceSeverity (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: Route of Administration (preferred) | |||||
| note |
0..* | Annotation | Text about event not captured in other fields | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| AllergyIntolerance.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1from the FHIR Standard | ||||
| AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1from the FHIR Standard | ||||
| AllergyIntolerance.type | required | AllergyIntoleranceTypehttp://hl7.org/fhir/ValueSet/allergy-intolerance-type|4.0.1from the FHIR Standard | ||||
| AllergyIntolerance.category | required | AllergyIntoleranceCategoryhttp://hl7.org/fhir/ValueSet/allergy-intolerance-category|4.0.1from the FHIR Standard | ||||
| AllergyIntolerance.criticality | required | AllergyIntoleranceCriticalityhttp://hl7.org/fhir/ValueSet/allergy-intolerance-criticality|4.0.1from the FHIR Standard | ||||
| AllergyIntolerance.code | preferred | IndicatorOfHypersensitivityOrIntoleranceToSubstance https://healthterminologies.gov.au/fhir/ValueSet/indicator-hypersensitivity-intolerance-to-substance-2 | ||||
| AllergyIntolerance.reaction.substance | preferred | AdverseReactionAgent https://healthterminologies.gov.au/fhir/ValueSet/adverse-reaction-agent-1 | ||||
| AllergyIntolerance.reaction.manifestation | preferred | ClinicalFinding https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 | ||||
| AllergyIntolerance.reaction.severity | required | AllergyIntoleranceSeverityhttp://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1from the FHIR Standard | ||||
| AllergyIntolerance.reaction.exposureRoute | preferred | RouteOfAdministration https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 |
| Id | Grade | Path(s) | Details | Requirements |
| inv-dh-ait-01 | error | AllergyIntolerance | If 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-02 | error | AllergyIntolerance.patient | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
| inv-dh-ait-03 | error | AllergyIntolerance.recorder | At 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() |
This structure is derived from AUBaseAllergyIntolerance
Summary
Mandatory: 2 elements
Must-Support: 16 elements
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron
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 |
The following search parameters and search parameter combinations SHALL be supported:
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)
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)
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)
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)
IG © 2023+ Australian Digital Health Agency. Package au.digitalhealth.r4#1.2.0-ci-build based on FHIR 4.0.1. Generated 2024-10-04
Links: Table of Contents | QA Report | Version History | Report an issue or propose a change