AU Base Implementation Guide
5.1.0-preview - Preview

Publication Build: This will be filled in by the publication tooling

## Resource Profile: AU Base Allergy Intolerance

Official URL: http://hl7.org.au/fhir/StructureDefinition/au-allergyintolerance | Version: 5.1.0-preview
Standards status: Trial-use | Maturity Level: 1 | Computable Name: AUBaseAllergyIntolerance
Copyright/Legal: HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.

This profile defines an allergy intolerance structure that localises core concepts, including terminology, for use in an Australian context. The purpose of this profile is to provide national level agreement on core localised concepts. This profile does not force conformance to core localised concepts. It enables implementers and modellers to make their own rules, i.e. profiling, about how to support these concepts for specific implementation needs.

### Usage Notes

Usage:

- Examples for this Resource Profile: AllergyIntolerance/example0, AllergyIntolerance/example1, AllergyIntolerance/example2 and AllergyIntolerance/example3

Changes since version 5.0.0:

- No changes

### Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
AllergyIntolerance | C | 0..* | AllergyIntolerance | 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 dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
clinicalStatus | ?!Σ C | 0..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. ele-1: All FHIR elements must have a @value or children
verificationStatus | ?!Σ 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. ele-1: All FHIR elements must have a @value or children
code | Σ | 0..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: Indicator of Hypersensitivity or Intolerance to Substance (preferred) ele-1: All FHIR elements must have a @value or children
patient | Σ | 1..1 | Reference(Patient) | Who the sensitivity is for ele-1: All FHIR elements must have a @value or children
reaction |  | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance ele-1: All FHIR elements must have a @value or children
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
substance |  | 0..1 | CodeableConcept | Specific substance or pharmaceutical product considered to be responsible for event Binding: Adverse Reaction Agent (preferred) ele-1: All FHIR elements must have a @value or children
manifestation |  | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: Clinical Finding (preferred) ele-1: All FHIR elements must have a @value or children
exposureRoute |  | 0..1 | CodeableConcept | How the subject was exposed to the substance Binding: Route of Administration (preferred) ele-1: All FHIR elements must have a @value or children
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatusCodes `http://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1` from the FHIR Standard
AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatusCodes `http://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1` from the FHIR Standard
AllergyIntolerance.code | preferred | IndicatorOfHypersensitivityOrIntoleranceToSubstance `https://healthterminologies.gov.au/fhir/ValueSet/indicator-hypersensitivity-intolerance-to-substance-2` from https://tx.ontoserver.csiro.au/fhir
AllergyIntolerance.reaction.substance | preferred | AdverseReactionAgent `https://healthterminologies.gov.au/fhir/ValueSet/adverse-reaction-agent-1` from https://tx.ontoserver.csiro.au/fhir
AllergyIntolerance.reaction.manifestation | preferred | ClinicalFinding `https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1` from https://tx.ontoserver.csiro.au/fhir
AllergyIntolerance.reaction.exposureRoute | preferred | RouteOfAdministration `https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1` from https://tx.ontoserver.csiro.au/fhir

#### Constraints

Id | Grade | Path(s) | Details | Requirements
ait-1 | error | AllergyIntolerance | AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists() |
ait-2 | error | AllergyIntolerance | AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty() |
dom-2 | error | AllergyIntolerance | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | AllergyIntolerance | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() |
dom-4 | error | AllergyIntolerance | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() |
dom-5 | error | AllergyIntolerance | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | AllergyIntolerance | A resource should have narrative for robust management : text.`div`.exists() |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |

This structure is derived from AllergyIntolerance

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
AllergyIntolerance |  | 0..* | AllergyIntolerance | An allergy or intolerance statement in an Australian healthcare context
code |  | 0..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: Indicator of Hypersensitivity or Intolerance to Substance (preferred)
reaction |  | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance
substance |  | 0..1 | CodeableConcept | Specific substance or pharmaceutical product considered to be responsible for event Binding: Adverse Reaction Agent (preferred)
manifestation |  | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: Clinical Finding (preferred)
exposureRoute |  | 0..1 | CodeableConcept | How the subject was exposed to the substance Binding: Route of Administration (preferred)
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet | URI
AllergyIntolerance.code | preferred | IndicatorOfHypersensitivityOrIntoleranceToSubstance `https://healthterminologies.gov.au/fhir/ValueSet/indicator-hypersensitivity-intolerance-to-substance-2` from https://tx.ontoserver.csiro.au/fhir
AllergyIntolerance.reaction.substance | preferred | AdverseReactionAgent `https://healthterminologies.gov.au/fhir/ValueSet/adverse-reaction-agent-1` from https://tx.ontoserver.csiro.au/fhir
AllergyIntolerance.reaction.manifestation | preferred | ClinicalFinding `https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1` from https://tx.ontoserver.csiro.au/fhir
AllergyIntolerance.reaction.exposureRoute | preferred | RouteOfAdministration `https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1` from https://tx.ontoserver.csiro.au/fhir

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
AllergyIntolerance | C | 0..* | AllergyIntolerance | 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
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.
Additional Bindings | Purpose
AllLanguages | Max Binding
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 | ?!Σ C | 0..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
verificationStatus | ?!Σ 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 | Σ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
category | Σ | 0..* | code | food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.
criticality | Σ | 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 | Σ | 0..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: Indicator of Hypersensitivity or Intolerance to Substance (preferred)
patient | Σ | 1..1 | Reference(Patient) | Who the sensitivity is for
encounter |  | 0..1 | Reference(Encounter) | Encounter when the allergy or intolerance was asserted
onset[x] |  | 0..1 |  | When allergy or intolerance was identified
onsetDateTime |  |  | dateTime |
onsetAge |  |  | Age |
onsetPeriod |  |  | Period |
onsetRange |  |  | Range |
onsetString |  |  | string |
recordedDate |  | 0..1 | dateTime | Date first version of the resource instance was recorded
recorder |  | 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
lastOccurrence |  | 0..1 | dateTime | Date(/time) of last known occurrence of a reaction
note |  | 0..* | Annotation | Additional text not captured in other fields
reaction |  | 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 |  | 0..1 | CodeableConcept | Specific substance or pharmaceutical product considered to be responsible for event Binding: Adverse Reaction Agent (preferred)
manifestation |  | 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 |  | 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

#### Terminology Bindings

Path | Conformance | ValueSet | URI
AllergyIntolerance.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatusCodes `http://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1` from the FHIR Standard
AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatusCodes `http://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1` from the FHIR Standard
AllergyIntolerance.type | required | AllergyIntoleranceType `http://hl7.org/fhir/ValueSet/allergy-intolerance-type|4.0.1` from the FHIR Standard
AllergyIntolerance.category | required | AllergyIntoleranceCategory `http://hl7.org/fhir/ValueSet/allergy-intolerance-category|4.0.1` from the FHIR Standard
AllergyIntolerance.criticality | required | AllergyIntoleranceCriticality `http://hl7.org/fhir/ValueSet/allergy-intolerance-criticality|4.0.1` from the FHIR Standard
AllergyIntolerance.code | preferred | IndicatorOfHypersensitivityOrIntoleranceToSubstance `https://healthterminologies.gov.au/fhir/ValueSet/indicator-hypersensitivity-intolerance-to-substance-2` from https://tx.ontoserver.csiro.au/fhir
AllergyIntolerance.reaction.substance | preferred | AdverseReactionAgent `https://healthterminologies.gov.au/fhir/ValueSet/adverse-reaction-agent-1` from https://tx.ontoserver.csiro.au/fhir
AllergyIntolerance.reaction.manifestation | preferred | ClinicalFinding `https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1` from https://tx.ontoserver.csiro.au/fhir
AllergyIntolerance.reaction.severity | required | AllergyIntoleranceSeverity `http://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1` from the FHIR Standard
AllergyIntolerance.reaction.exposureRoute | preferred | RouteOfAdministration `https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1` from https://tx.ontoserver.csiro.au/fhir

#### Constraints

Id | Grade | Path(s) | Details | Requirements
ait-1 | error | AllergyIntolerance | AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists() |
ait-2 | error | AllergyIntolerance | AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty() |
dom-2 | error | AllergyIntolerance | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | AllergyIntolerance | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() |
dom-4 | error | AllergyIntolerance | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() |
dom-5 | error | AllergyIntolerance | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | AllergyIntolerance | A resource should have narrative for robust management : text.`div`.exists() |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |

This structure is derived from AllergyIntolerance

Summary

Maturity: 1

Key Elements View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
AllergyIntolerance | C | 0..* | AllergyIntolerance | 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 dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
clinicalStatus | ?!Σ C | 0..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. ele-1: All FHIR elements must have a @value or children
verificationStatus | ?!Σ 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. ele-1: All FHIR elements must have a @value or children
code | Σ | 0..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: Indicator of Hypersensitivity or Intolerance to Substance (preferred) ele-1: All FHIR elements must have a @value or children
patient | Σ | 1..1 | Reference(Patient) | Who the sensitivity is for ele-1: All FHIR elements must have a @value or children
reaction |  | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance ele-1: All FHIR elements must have a @value or children
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
substance |  | 0..1 | CodeableConcept | Specific substance or pharmaceutical product considered to be responsible for event Binding: Adverse Reaction Agent (preferred) ele-1: All FHIR elements must have a @value or children
manifestation |  | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: Clinical Finding (preferred) ele-1: All FHIR elements must have a @value or children
exposureRoute |  | 0..1 | CodeableConcept | How the subject was exposed to the substance Binding: Route of Administration (preferred) ele-1: All FHIR elements must have a @value or children
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatusCodes `http://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1` from the FHIR Standard
AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatusCodes `http://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1` from the FHIR Standard
AllergyIntolerance.code | preferred | IndicatorOfHypersensitivityOrIntoleranceToSubstance `https://healthterminologies.gov.au/fhir/ValueSet/indicator-hypersensitivity-intolerance-to-substance-2` from https://tx.ontoserver.csiro.au/fhir
AllergyIntolerance.reaction.substance | preferred | AdverseReactionAgent `https://healthterminologies.gov.au/fhir/ValueSet/adverse-reaction-agent-1` from https://tx.ontoserver.csiro.au/fhir
AllergyIntolerance.reaction.manifestation | preferred | ClinicalFinding `https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1` from https://tx.ontoserver.csiro.au/fhir
AllergyIntolerance.reaction.exposureRoute | preferred | RouteOfAdministration `https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1` from https://tx.ontoserver.csiro.au/fhir

#### Constraints

Id | Grade | Path(s) | Details | Requirements
ait-1 | error | AllergyIntolerance | AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists() |
ait-2 | error | AllergyIntolerance | AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty() |
dom-2 | error | AllergyIntolerance | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | AllergyIntolerance | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() |
dom-4 | error | AllergyIntolerance | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() |
dom-5 | error | AllergyIntolerance | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | AllergyIntolerance | A resource should have narrative for robust management : text.`div`.exists() |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |

Differential View

This structure is derived from AllergyIntolerance

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
AllergyIntolerance |  | 0..* | AllergyIntolerance | An allergy or intolerance statement in an Australian healthcare context
code |  | 0..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: Indicator of Hypersensitivity or Intolerance to Substance (preferred)
reaction |  | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance
substance |  | 0..1 | CodeableConcept | Specific substance or pharmaceutical product considered to be responsible for event Binding: Adverse Reaction Agent (preferred)
manifestation |  | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: Clinical Finding (preferred)
exposureRoute |  | 0..1 | CodeableConcept | How the subject was exposed to the substance Binding: Route of Administration (preferred)
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet | URI
AllergyIntolerance.code | preferred | IndicatorOfHypersensitivityOrIntoleranceToSubstance `https://healthterminologies.gov.au/fhir/ValueSet/indicator-hypersensitivity-intolerance-to-substance-2` from https://tx.ontoserver.csiro.au/fhir
AllergyIntolerance.reaction.substance | preferred | AdverseReactionAgent `https://healthterminologies.gov.au/fhir/ValueSet/adverse-reaction-agent-1` from https://tx.ontoserver.csiro.au/fhir
AllergyIntolerance.reaction.manifestation | preferred | ClinicalFinding `https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1` from https://tx.ontoserver.csiro.au/fhir
AllergyIntolerance.reaction.exposureRoute | preferred | RouteOfAdministration `https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1` from https://tx.ontoserver.csiro.au/fhir

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
AllergyIntolerance | C | 0..* | AllergyIntolerance | 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
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.
Additional Bindings | Purpose
AllLanguages | Max Binding
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 | ?!Σ C | 0..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
verificationStatus | ?!Σ 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 | Σ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
category | Σ | 0..* | code | food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.
criticality | Σ | 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 | Σ | 0..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: Indicator of Hypersensitivity or Intolerance to Substance (preferred)
patient | Σ | 1..1 | Reference(Patient) | Who the sensitivity is for
encounter |  | 0..1 | Reference(Encounter) | Encounter when the allergy or intolerance was asserted
onset[x] |  | 0..1 |  | When allergy or intolerance was identified
onsetDateTime |  |  | dateTime |
onsetAge |  |  | Age |
onsetPeriod |  |  | Period |
onsetRange |  |  | Range |
onsetString |  |  | string |
recordedDate |  | 0..1 | dateTime | Date first version of the resource instance was recorded
recorder |  | 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
lastOccurrence |  | 0..1 | dateTime | Date(/time) of last known occurrence of a reaction
note |  | 0..* | Annotation | Additional text not captured in other fields
reaction |  | 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 |  | 0..1 | CodeableConcept | Specific substance or pharmaceutical product considered to be responsible for event Binding: Adverse Reaction Agent (preferred)
manifestation |  | 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 |  | 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

#### Terminology Bindings

Path | Conformance | ValueSet | URI
AllergyIntolerance.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatusCodes `http://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1` from the FHIR Standard
AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatusCodes `http://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1` from the FHIR Standard
AllergyIntolerance.type | required | AllergyIntoleranceType `http://hl7.org/fhir/ValueSet/allergy-intolerance-type|4.0.1` from the FHIR Standard
AllergyIntolerance.category | required | AllergyIntoleranceCategory `http://hl7.org/fhir/ValueSet/allergy-intolerance-category|4.0.1` from the FHIR Standard
AllergyIntolerance.criticality | required | AllergyIntoleranceCriticality `http://hl7.org/fhir/ValueSet/allergy-intolerance-criticality|4.0.1` from the FHIR Standard
AllergyIntolerance.code | preferred | IndicatorOfHypersensitivityOrIntoleranceToSubstance `https://healthterminologies.gov.au/fhir/ValueSet/indicator-hypersensitivity-intolerance-to-substance-2` from https://tx.ontoserver.csiro.au/fhir
AllergyIntolerance.reaction.substance | preferred | AdverseReactionAgent `https://healthterminologies.gov.au/fhir/ValueSet/adverse-reaction-agent-1` from https://tx.ontoserver.csiro.au/fhir
AllergyIntolerance.reaction.manifestation | preferred | ClinicalFinding `https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1` from https://tx.ontoserver.csiro.au/fhir
AllergyIntolerance.reaction.severity | required | AllergyIntoleranceSeverity `http://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1` from the FHIR Standard
AllergyIntolerance.reaction.exposureRoute | preferred | RouteOfAdministration `https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1` from https://tx.ontoserver.csiro.au/fhir

#### Constraints

Id | Grade | Path(s) | Details | Requirements
ait-1 | error | AllergyIntolerance | AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists() |
ait-2 | error | AllergyIntolerance | AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty() |
dom-2 | error | AllergyIntolerance | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | AllergyIntolerance | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() |
dom-4 | error | AllergyIntolerance | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() |
dom-5 | error | AllergyIntolerance | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | AllergyIntolerance | A resource should have narrative for robust management : text.`div`.exists() |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |

This structure is derived from AllergyIntolerance

Summary

Maturity: 1

Other representations of profile: CSV, Excel, Schematron