AU Base Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 7.0.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7au/au-fhir-base/ and changes regularly. See the Directory of published versions

• Content
• Detailed Descriptions
• Examples
• XML
• JSON
• TTL

Resource Profile: AU Base AllergyIntolerance

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.

Usages:

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

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.

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
AllergyIntolerance	C	0..*	AllergyIntolerance	An allergy or intolerance statement in an Australian healthcare context Constraints: ait-1, ait-2
AllergyIntolerance.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
AllergyIntolerance.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
AllergyIntolerance.clinicalStatus	?! This element is a modifier element. Σ This element is included in summaries. C	0..1	CodeableConcept	active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
AllergyIntolerance.verificationStatus	?! This element is a modifier element. Σ This element is included in summaries. 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.
AllergyIntolerance.code	Σ This element is included in summaries.	0..1	CodeableConcept	Code that identifies the allergy or intolerance Binding: Indicator of Hypersensitivity or Intolerance to Substance (preferred)
AllergyIntolerance.patient	Σ This element is included in summaries.	1..1	Reference(Patient)	Who the sensitivity is for
AllergyIntolerance.reaction		0..*	BackboneElement	Adverse Reaction Events linked to exposure to substance
AllergyIntolerance.reaction.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
AllergyIntolerance.reaction.substance		0..1	CodeableConcept	Specific substance or pharmaceutical product considered to be responsible for event Binding: Adverse Reaction Agent (preferred)
AllergyIntolerance.reaction.manifestation		1..*	CodeableConcept	Clinical symptoms/signs associated with the Event Binding: Adverse Reaction Clinical Manifestation (preferred)
AllergyIntolerance.reaction.exposureRoute		0..1	CodeableConcept	How the subject was exposed to the substance Binding: Route of Administration (preferred)
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.code	Base	preferred	Indicator of Hypersensitivity or Intolerance to Substance	⏿2.1.0	tx.hl7.org.au
AllergyIntolerance.reaction.​substance	Base	preferred	Adverse Reaction Agent	⏿1.1.1	tx.hl7.org.au
AllergyIntolerance.reaction.​manifestation	Base	preferred	Adverse Reaction Clinical Manifestation	⏿1.0.0	tx.hl7.org.au
AllergyIntolerance.reaction.​exposureRoute	Base	preferred	Route of Administration	⏿1.0.2	tx.hl7.org.au

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 AllergyIntolerance

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
AllergyIntolerance		0..*	AllergyIntolerance	An allergy or intolerance statement in an Australian healthcare context
AllergyIntolerance.code		0..1	CodeableConcept	Code that identifies the allergy or intolerance Binding: Indicator of Hypersensitivity or Intolerance to Substance (preferred)
AllergyIntolerance.reaction		0..*	BackboneElement	Adverse Reaction Events linked to exposure to substance
AllergyIntolerance.reaction.substance		0..1	CodeableConcept	Specific substance or pharmaceutical product considered to be responsible for event Binding: Adverse Reaction Agent (preferred)
AllergyIntolerance.reaction.manifestation		1..*	CodeableConcept	Clinical symptoms/signs associated with the Event Binding: Adverse Reaction Clinical Manifestation (preferred)
AllergyIntolerance.reaction.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	Status	Usage	ValueSet	Version	Source
AllergyIntolerance.code	Base	preferred	Indicator of Hypersensitivity or Intolerance to Substance	⏿2.1.0	tx.hl7.org.au
AllergyIntolerance.reaction.​substance	Base	preferred	Adverse Reaction Agent	⏿1.1.1	tx.hl7.org.au
AllergyIntolerance.reaction.​manifestation	Base	preferred	Adverse Reaction Clinical Manifestation	⏿1.0.0	tx.hl7.org.au
AllergyIntolerance.reaction.​exposureRoute	Base	preferred	Route of Administration	⏿1.0.2	tx.hl7.org.au

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
AllergyIntolerance	C	0..*	AllergyIntolerance	An allergy or intolerance statement in an Australian healthcare context Constraints: ait-1, ait-2
AllergyIntolerance.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
AllergyIntolerance.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
AllergyIntolerance.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
AllergyIntolerance.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
AllergyIntolerance.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
AllergyIntolerance.contained		0..*	Resource	Contained, inline Resources
AllergyIntolerance.extension		0..*	Extension	Additional content defined by implementations
AllergyIntolerance.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
AllergyIntolerance.identifier	Σ This element is included in summaries.	0..*	Identifier	External ids for this item
AllergyIntolerance.clinicalStatus	?! This element is a modifier element. Σ This element is included in summaries. C	0..1	CodeableConcept	active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
AllergyIntolerance.verificationStatus	?! This element is a modifier element. Σ This element is included in summaries. 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.
AllergyIntolerance.type	Σ This element is included in summaries.	0..1	code	allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
AllergyIntolerance.category	Σ This element is included in summaries.	0..*	code	food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.
AllergyIntolerance.criticality	Σ This element is included in summaries.	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.
AllergyIntolerance.code	Σ This element is included in summaries.	0..1	CodeableConcept	Code that identifies the allergy or intolerance Binding: Indicator of Hypersensitivity or Intolerance to Substance (preferred)
AllergyIntolerance.patient	Σ This element is included in summaries.	1..1	Reference(Patient)	Who the sensitivity is for
AllergyIntolerance.encounter		0..1	Reference(Encounter)	Encounter when the allergy or intolerance was asserted
AllergyIntolerance.onset[x]		0..1		When allergy or intolerance was identified
AllergyIntolerance.onset[x].onsetDateTime			dateTime
AllergyIntolerance.onset[x].onsetAge			Age
AllergyIntolerance.onset[x].onsetPeriod			Period
AllergyIntolerance.onset[x].onsetRange			Range
AllergyIntolerance.onset[x].onsetString			string
AllergyIntolerance.recordedDate		0..1	dateTime	Date first version of the resource instance was recorded
AllergyIntolerance.recorder		0..1	Reference(Practitioner | PractitionerRole | Patient | RelatedPerson)	Who recorded the sensitivity
AllergyIntolerance.asserter	Σ This element is included in summaries.	0..1	Reference(Patient | RelatedPerson | Practitioner | PractitionerRole)	Source of the information about the allergy
AllergyIntolerance.lastOccurrence		0..1	dateTime	Date(/time) of last known occurrence of a reaction
AllergyIntolerance.note		0..*	Annotation	Additional text not captured in other fields
AllergyIntolerance.reaction		0..*	BackboneElement	Adverse Reaction Events linked to exposure to substance
AllergyIntolerance.reaction.id		0..1	string	Unique id for inter-element referencing
AllergyIntolerance.reaction.extension		0..*	Extension	Additional content defined by implementations
AllergyIntolerance.reaction.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
AllergyIntolerance.reaction.substance		0..1	CodeableConcept	Specific substance or pharmaceutical product considered to be responsible for event Binding: Adverse Reaction Agent (preferred)
AllergyIntolerance.reaction.manifestation		1..*	CodeableConcept	Clinical symptoms/signs associated with the Event Binding: Adverse Reaction Clinical Manifestation (preferred)
AllergyIntolerance.reaction.description		0..1	string	Description of the event as a whole
AllergyIntolerance.reaction.onset		0..1	dateTime	Date(/time) when manifestations showed
AllergyIntolerance.reaction.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.
AllergyIntolerance.reaction.exposureRoute		0..1	CodeableConcept	How the subject was exposed to the substance Binding: Route of Administration (preferred)
AllergyIntolerance.reaction.note		0..*	Annotation	Text about event not captured in other fields
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	Indicator of Hypersensitivity or Intolerance to Substance	⏿2.1.0	tx.hl7.org.au
AllergyIntolerance.reaction.​substance	Base	preferred	Adverse Reaction Agent	⏿1.1.1	tx.hl7.org.au
AllergyIntolerance.reaction.​manifestation	Base	preferred	Adverse Reaction Clinical Manifestation	⏿1.0.0	tx.hl7.org.au
AllergyIntolerance.reaction.​severity	Base	required	AllergyIntoleranceSeverity	📍4.0.1	FHIR Std.
AllergyIntolerance.reaction.​exposureRoute	Base	preferred	Route of Administration	⏿1.0.2	tx.hl7.org.au

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 AllergyIntolerance

Summary

Maturity: 1

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
AllergyIntolerance	C	0..*	AllergyIntolerance	An allergy or intolerance statement in an Australian healthcare context Constraints: ait-1, ait-2
AllergyIntolerance.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
AllergyIntolerance.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
AllergyIntolerance.clinicalStatus	?! This element is a modifier element. Σ This element is included in summaries. C	0..1	CodeableConcept	active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
AllergyIntolerance.verificationStatus	?! This element is a modifier element. Σ This element is included in summaries. 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.
AllergyIntolerance.code	Σ This element is included in summaries.	0..1	CodeableConcept	Code that identifies the allergy or intolerance Binding: Indicator of Hypersensitivity or Intolerance to Substance (preferred)
AllergyIntolerance.patient	Σ This element is included in summaries.	1..1	Reference(Patient)	Who the sensitivity is for
AllergyIntolerance.reaction		0..*	BackboneElement	Adverse Reaction Events linked to exposure to substance
AllergyIntolerance.reaction.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
AllergyIntolerance.reaction.substance		0..1	CodeableConcept	Specific substance or pharmaceutical product considered to be responsible for event Binding: Adverse Reaction Agent (preferred)
AllergyIntolerance.reaction.manifestation		1..*	CodeableConcept	Clinical symptoms/signs associated with the Event Binding: Adverse Reaction Clinical Manifestation (preferred)
AllergyIntolerance.reaction.exposureRoute		0..1	CodeableConcept	How the subject was exposed to the substance Binding: Route of Administration (preferred)
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.code	Base	preferred	Indicator of Hypersensitivity or Intolerance to Substance	⏿2.1.0	tx.hl7.org.au
AllergyIntolerance.reaction.​substance	Base	preferred	Adverse Reaction Agent	⏿1.1.1	tx.hl7.org.au
AllergyIntolerance.reaction.​manifestation	Base	preferred	Adverse Reaction Clinical Manifestation	⏿1.0.0	tx.hl7.org.au
AllergyIntolerance.reaction.​exposureRoute	Base	preferred	Route of Administration	⏿1.0.2	tx.hl7.org.au

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 AllergyIntolerance

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
AllergyIntolerance		0..*	AllergyIntolerance	An allergy or intolerance statement in an Australian healthcare context
AllergyIntolerance.code		0..1	CodeableConcept	Code that identifies the allergy or intolerance Binding: Indicator of Hypersensitivity or Intolerance to Substance (preferred)
AllergyIntolerance.reaction		0..*	BackboneElement	Adverse Reaction Events linked to exposure to substance
AllergyIntolerance.reaction.substance		0..1	CodeableConcept	Specific substance or pharmaceutical product considered to be responsible for event Binding: Adverse Reaction Agent (preferred)
AllergyIntolerance.reaction.manifestation		1..*	CodeableConcept	Clinical symptoms/signs associated with the Event Binding: Adverse Reaction Clinical Manifestation (preferred)
AllergyIntolerance.reaction.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	Status	Usage	ValueSet	Version	Source
AllergyIntolerance.code	Base	preferred	Indicator of Hypersensitivity or Intolerance to Substance	⏿2.1.0	tx.hl7.org.au
AllergyIntolerance.reaction.​substance	Base	preferred	Adverse Reaction Agent	⏿1.1.1	tx.hl7.org.au
AllergyIntolerance.reaction.​manifestation	Base	preferred	Adverse Reaction Clinical Manifestation	⏿1.0.0	tx.hl7.org.au
AllergyIntolerance.reaction.​exposureRoute	Base	preferred	Route of Administration	⏿1.0.2	tx.hl7.org.au

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
AllergyIntolerance	C	0..*	AllergyIntolerance	An allergy or intolerance statement in an Australian healthcare context Constraints: ait-1, ait-2
AllergyIntolerance.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
AllergyIntolerance.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
AllergyIntolerance.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
AllergyIntolerance.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
AllergyIntolerance.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
AllergyIntolerance.contained		0..*	Resource	Contained, inline Resources
AllergyIntolerance.extension		0..*	Extension	Additional content defined by implementations
AllergyIntolerance.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
AllergyIntolerance.identifier	Σ This element is included in summaries.	0..*	Identifier	External ids for this item
AllergyIntolerance.clinicalStatus	?! This element is a modifier element. Σ This element is included in summaries. C	0..1	CodeableConcept	active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
AllergyIntolerance.verificationStatus	?! This element is a modifier element. Σ This element is included in summaries. 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.
AllergyIntolerance.type	Σ This element is included in summaries.	0..1	code	allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
AllergyIntolerance.category	Σ This element is included in summaries.	0..*	code	food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.
AllergyIntolerance.criticality	Σ This element is included in summaries.	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.
AllergyIntolerance.code	Σ This element is included in summaries.	0..1	CodeableConcept	Code that identifies the allergy or intolerance Binding: Indicator of Hypersensitivity or Intolerance to Substance (preferred)
AllergyIntolerance.patient	Σ This element is included in summaries.	1..1	Reference(Patient)	Who the sensitivity is for
AllergyIntolerance.encounter		0..1	Reference(Encounter)	Encounter when the allergy or intolerance was asserted
AllergyIntolerance.onset[x]		0..1		When allergy or intolerance was identified
AllergyIntolerance.onset[x].onsetDateTime			dateTime
AllergyIntolerance.onset[x].onsetAge			Age
AllergyIntolerance.onset[x].onsetPeriod			Period
AllergyIntolerance.onset[x].onsetRange			Range
AllergyIntolerance.onset[x].onsetString			string
AllergyIntolerance.recordedDate		0..1	dateTime	Date first version of the resource instance was recorded
AllergyIntolerance.recorder		0..1	Reference(Practitioner | PractitionerRole | Patient | RelatedPerson)	Who recorded the sensitivity
AllergyIntolerance.asserter	Σ This element is included in summaries.	0..1	Reference(Patient | RelatedPerson | Practitioner | PractitionerRole)	Source of the information about the allergy
AllergyIntolerance.lastOccurrence		0..1	dateTime	Date(/time) of last known occurrence of a reaction
AllergyIntolerance.note		0..*	Annotation	Additional text not captured in other fields
AllergyIntolerance.reaction		0..*	BackboneElement	Adverse Reaction Events linked to exposure to substance
AllergyIntolerance.reaction.id		0..1	string	Unique id for inter-element referencing
AllergyIntolerance.reaction.extension		0..*	Extension	Additional content defined by implementations
AllergyIntolerance.reaction.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
AllergyIntolerance.reaction.substance		0..1	CodeableConcept	Specific substance or pharmaceutical product considered to be responsible for event Binding: Adverse Reaction Agent (preferred)
AllergyIntolerance.reaction.manifestation		1..*	CodeableConcept	Clinical symptoms/signs associated with the Event Binding: Adverse Reaction Clinical Manifestation (preferred)
AllergyIntolerance.reaction.description		0..1	string	Description of the event as a whole
AllergyIntolerance.reaction.onset		0..1	dateTime	Date(/time) when manifestations showed
AllergyIntolerance.reaction.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.
AllergyIntolerance.reaction.exposureRoute		0..1	CodeableConcept	How the subject was exposed to the substance Binding: Route of Administration (preferred)
AllergyIntolerance.reaction.note		0..*	Annotation	Text about event not captured in other fields
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	Indicator of Hypersensitivity or Intolerance to Substance	⏿2.1.0	tx.hl7.org.au
AllergyIntolerance.reaction.​substance	Base	preferred	Adverse Reaction Agent	⏿1.1.1	tx.hl7.org.au
AllergyIntolerance.reaction.​manifestation	Base	preferred	Adverse Reaction Clinical Manifestation	⏿1.0.0	tx.hl7.org.au
AllergyIntolerance.reaction.​severity	Base	required	AllergyIntoleranceSeverity	📍4.0.1	FHIR Std.
AllergyIntolerance.reaction.​exposureRoute	Base	preferred	Route of Administration	⏿1.0.2	tx.hl7.org.au

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 AllergyIntolerance

Summary

Maturity: 1

Other representations of profile: CSV, Excel, Schematron