Helix AU Core
0.1.0 - ci-build

Helix AU Core - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Helix AU Core AllergyIntolerance

Official URL: http://medicaldirector.com/fhir/helix-au-core/StructureDefinition/HelixAUCoreAllergyIntolerance Version: 0.1.0
Draft as of 2025-12-09 Computable Name: HelixAUCoreAllergyIntolerance

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance C 0..* AUCoreAllergyIntolerance An allergy or intolerance statement in an Australian healthcare context
Constraints: ait-1, ait-2
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 1..* Identifier External ids for this item
Slice: Unordered, Open At End by value:system
.... identifier:authoring-key SΣ 1..1 HelixBaseAuthoringKey External ids for this item
... 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.
... code SΣ 1..1 CodeableConcept Code that identifies the allergy or intolerance
Binding: https://healthterminologies.gov.au/fhir/ValueSet/indicator-hypersensitivity-intolerance-to-substance-2 (preferred)
... patient SΣ 1..1 Reference(AU Core Patient) Who the sensitivity is for
... encounter S 0..1 Reference(AU Core Encounter) 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 S 0..1 Reference(AU Core Practitioner | AU Core Patient | AU Core RelatedPerson | AU Core PractitionerRole) Who recorded the sensitivity
... asserter SΣ 0..1 Reference(AU Core Patient | AU Core RelatedPerson | AU Core Practitioner | AU Core PractitionerRole) 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: https://healthterminologies.gov.au/fhir/ValueSet/adverse-reaction-agent-1 (preferred)
.... manifestation S 1..* CodeableConcept Clinical symptoms/signs associated with the Event
Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 (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.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AllergyIntolerance.clinicalStatus Base required AllergyIntolerance Clinical Status Codes 📍4.0.1 FHIR Std.
AllergyIntolerance.verificationStatus Base required AllergyIntolerance Verification Status Codes 📍4.0.1 FHIR Std.
AllergyIntolerance.type Base required AllergyIntoleranceType 📍4.0.1 FHIR Std.
AllergyIntolerance.category Base required AllergyIntoleranceCategory 📍4.0.1 FHIR Std.
AllergyIntolerance.code Base preferred https://healthterminologies.gov.au/fhir/ValueSet/indicator-hypersensitivity-intolerance-to-substance-2 Not State Unknown
AllergyIntolerance.reaction.​substance Base preferred https://healthterminologies.gov.au/fhir/ValueSet/adverse-reaction-agent-1 Not State Unknown
AllergyIntolerance.reaction.​manifestation Base preferred https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 Not State Unknown
AllergyIntolerance.reaction.​severity Base required AllergyIntoleranceSeverity 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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 AUCoreAllergyIntolerance

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance 0..* AUCoreAllergyIntolerance An allergy or intolerance statement in an Australian healthcare context
... Slices for identifier S 1..* Identifier External ids for this item
Slice: Unordered, Open At End by value:system
.... identifier:authoring-key S 1..1 HelixBaseAuthoringKey External ids for this item

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance C 0..* AUCoreAllergyIntolerance An allergy or intolerance statement in an Australian healthcare context
Constraints: ait-1, ait-2
... 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
... 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
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 1..* Identifier External ids for this item
Slice: Unordered, Open At End by value:system
.... identifier:authoring-key SΣ 1..1 HelixBaseAuthoringKey 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 Σ 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: https://healthterminologies.gov.au/fhir/ValueSet/indicator-hypersensitivity-intolerance-to-substance-2 (preferred)
... patient SΣ 1..1 Reference(AU Core Patient) Who the sensitivity is for
... encounter S 0..1 Reference(AU Core Encounter) 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 S 0..1 Reference(AU Core Practitioner | AU Core Patient | AU Core RelatedPerson | AU Core PractitionerRole) Who recorded the sensitivity
... asserter SΣ 0..1 Reference(AU Core Patient | AU Core RelatedPerson | AU Core Practitioner | AU Core PractitionerRole) 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: https://healthterminologies.gov.au/fhir/ValueSet/adverse-reaction-agent-1 (preferred)
.... manifestation S 1..* CodeableConcept Clinical symptoms/signs associated with the Event
Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 (preferred)
.... description 0..1 string Description of the event as a whole
.... onset 0..1 dateTime Date(/time) when manifestations showed
.... severity 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: https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 (preferred)
.... note 0..* Annotation Text about event not captured in other fields

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AllergyIntolerance.language Base preferred Common Languages 📦4.0.1 FHIR Std.
AllergyIntolerance.clinicalStatus Base required AllergyIntolerance Clinical Status Codes 📍4.0.1 FHIR Std.
AllergyIntolerance.verificationStatus Base required AllergyIntolerance Verification Status Codes 📍4.0.1 FHIR Std.
AllergyIntolerance.type Base required AllergyIntoleranceType 📍4.0.1 FHIR Std.
AllergyIntolerance.category Base required AllergyIntoleranceCategory 📍4.0.1 FHIR Std.
AllergyIntolerance.criticality Base required AllergyIntoleranceCriticality 📍4.0.1 FHIR Std.
AllergyIntolerance.code Base preferred https://healthterminologies.gov.au/fhir/ValueSet/indicator-hypersensitivity-intolerance-to-substance-2 Not State Unknown
AllergyIntolerance.reaction.​substance Base preferred https://healthterminologies.gov.au/fhir/ValueSet/adverse-reaction-agent-1 Not State Unknown
AllergyIntolerance.reaction.​manifestation Base preferred https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 Not State Unknown
AllergyIntolerance.reaction.​severity Base required AllergyIntoleranceSeverity 📍4.0.1 FHIR Std.
AllergyIntolerance.reaction.​exposureRoute Base preferred https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 Not State Unknown

Constraints

Id Grade Path(s) Description Expression
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 AUCoreAllergyIntolerance

Summary

Mandatory: 2 elements
Must-Support: 2 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of AllergyIntolerance.identifier (Open at End)

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance C 0..* AUCoreAllergyIntolerance An allergy or intolerance statement in an Australian healthcare context
Constraints: ait-1, ait-2
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 1..* Identifier External ids for this item
Slice: Unordered, Open At End by value:system
.... identifier:authoring-key SΣ 1..1 HelixBaseAuthoringKey External ids for this item
... 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.
... code SΣ 1..1 CodeableConcept Code that identifies the allergy or intolerance
Binding: https://healthterminologies.gov.au/fhir/ValueSet/indicator-hypersensitivity-intolerance-to-substance-2 (preferred)
... patient SΣ 1..1 Reference(AU Core Patient) Who the sensitivity is for
... encounter S 0..1 Reference(AU Core Encounter) 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 S 0..1 Reference(AU Core Practitioner | AU Core Patient | AU Core RelatedPerson | AU Core PractitionerRole) Who recorded the sensitivity
... asserter SΣ 0..1 Reference(AU Core Patient | AU Core RelatedPerson | AU Core Practitioner | AU Core PractitionerRole) 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: https://healthterminologies.gov.au/fhir/ValueSet/adverse-reaction-agent-1 (preferred)
.... manifestation S 1..* CodeableConcept Clinical symptoms/signs associated with the Event
Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 (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.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AllergyIntolerance.clinicalStatus Base required AllergyIntolerance Clinical Status Codes 📍4.0.1 FHIR Std.
AllergyIntolerance.verificationStatus Base required AllergyIntolerance Verification Status Codes 📍4.0.1 FHIR Std.
AllergyIntolerance.type Base required AllergyIntoleranceType 📍4.0.1 FHIR Std.
AllergyIntolerance.category Base required AllergyIntoleranceCategory 📍4.0.1 FHIR Std.
AllergyIntolerance.code Base preferred https://healthterminologies.gov.au/fhir/ValueSet/indicator-hypersensitivity-intolerance-to-substance-2 Not State Unknown
AllergyIntolerance.reaction.​substance Base preferred https://healthterminologies.gov.au/fhir/ValueSet/adverse-reaction-agent-1 Not State Unknown
AllergyIntolerance.reaction.​manifestation Base preferred https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 Not State Unknown
AllergyIntolerance.reaction.​severity Base required AllergyIntoleranceSeverity 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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 AUCoreAllergyIntolerance

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance 0..* AUCoreAllergyIntolerance An allergy or intolerance statement in an Australian healthcare context
... Slices for identifier S 1..* Identifier External ids for this item
Slice: Unordered, Open At End by value:system
.... identifier:authoring-key S 1..1 HelixBaseAuthoringKey External ids for this item

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance C 0..* AUCoreAllergyIntolerance An allergy or intolerance statement in an Australian healthcare context
Constraints: ait-1, ait-2
... 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
... 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
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 1..* Identifier External ids for this item
Slice: Unordered, Open At End by value:system
.... identifier:authoring-key SΣ 1..1 HelixBaseAuthoringKey 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 Σ 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: https://healthterminologies.gov.au/fhir/ValueSet/indicator-hypersensitivity-intolerance-to-substance-2 (preferred)
... patient SΣ 1..1 Reference(AU Core Patient) Who the sensitivity is for
... encounter S 0..1 Reference(AU Core Encounter) 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 S 0..1 Reference(AU Core Practitioner | AU Core Patient | AU Core RelatedPerson | AU Core PractitionerRole) Who recorded the sensitivity
... asserter SΣ 0..1 Reference(AU Core Patient | AU Core RelatedPerson | AU Core Practitioner | AU Core PractitionerRole) 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: https://healthterminologies.gov.au/fhir/ValueSet/adverse-reaction-agent-1 (preferred)
.... manifestation S 1..* CodeableConcept Clinical symptoms/signs associated with the Event
Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 (preferred)
.... description 0..1 string Description of the event as a whole
.... onset 0..1 dateTime Date(/time) when manifestations showed
.... severity 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: https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 (preferred)
.... note 0..* Annotation Text about event not captured in other fields

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AllergyIntolerance.language Base preferred Common Languages 📦4.0.1 FHIR Std.
AllergyIntolerance.clinicalStatus Base required AllergyIntolerance Clinical Status Codes 📍4.0.1 FHIR Std.
AllergyIntolerance.verificationStatus Base required AllergyIntolerance Verification Status Codes 📍4.0.1 FHIR Std.
AllergyIntolerance.type Base required AllergyIntoleranceType 📍4.0.1 FHIR Std.
AllergyIntolerance.category Base required AllergyIntoleranceCategory 📍4.0.1 FHIR Std.
AllergyIntolerance.criticality Base required AllergyIntoleranceCriticality 📍4.0.1 FHIR Std.
AllergyIntolerance.code Base preferred https://healthterminologies.gov.au/fhir/ValueSet/indicator-hypersensitivity-intolerance-to-substance-2 Not State Unknown
AllergyIntolerance.reaction.​substance Base preferred https://healthterminologies.gov.au/fhir/ValueSet/adverse-reaction-agent-1 Not State Unknown
AllergyIntolerance.reaction.​manifestation Base preferred https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 Not State Unknown
AllergyIntolerance.reaction.​severity Base required AllergyIntoleranceSeverity 📍4.0.1 FHIR Std.
AllergyIntolerance.reaction.​exposureRoute Base preferred https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 Not State Unknown

Constraints

Id Grade Path(s) Description Expression
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 AUCoreAllergyIntolerance

Summary

Mandatory: 2 elements
Must-Support: 2 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of AllergyIntolerance.identifier (Open at End)

 

Other representations of profile: CSV, Excel, Schematron