Implementation Guide for ARF/RHD Register - AU - Local Development build (v0.2.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Resource Profile: ARFAllergy

Profile of Allergy/Intolerance for ARF Patient. Only medication allergies are of interest in an ARF Register

Usage:

• Examples for this Resource Profile: AllergyIntolerance/MikePondMedicationAllergy

Formal Views of Profile Content

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

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

This structure is derived from AUCoreAllergyIntolerance

Name	Flags	Card.	Type	Description & Constraints
AllergyIntolerance		0..*	AUCoreAllergyIntolerance	An allergy or intolerance statement in an Australian healthcare context
category	S	1..*	code	food | medication | environment | biologic
criticality	S	0..1	code	low | high | unable-to-assess
patient		1..1	Reference(ARFPatient)	Who the sensitivity is for
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
AllergyIntolerance	C	0..*	AUCoreAllergyIntolerance	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
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
clinicalStatus	?!SOΣC	0..1	CodeableConcept	active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
verificationStatus	?!SOΣ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. Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
category	SΣ	1..*	code	food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.
criticality	SΣ	0..1	code	low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.
code	SOΣ	1..1	CodeableConcept	Code that identifies the allergy or intolerance Binding: Indicator of Hypersensitivity or Intolerance to Substance (extensible) Additional Bindings Purpose Adverse Reaction Substances and Negated Findings candidate Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
patient	SOΣ	1..1	Reference(ARFPatient)	Who the sensitivity is for Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
onset[x]	SO	0..1		When allergy or intolerance was identified Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
onsetDateTime			dateTime
onsetAge			Age
onsetPeriod			Period
onsetRange			Range
reaction	SO	0..*	BackboneElement	Adverse Reaction Events linked to exposure to substance Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
manifestation	SO	1..*	CodeableConcept	Clinical symptoms/signs associated with the Event Binding: Clinical Finding (preferred) Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
severity	SO	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. Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
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.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	extensible	IndicatorOfHypersensitivityOrIntoleranceToSubstance https://healthterminologies.gov.au/fhir/ValueSet/indicator-hypersensitivity-intolerance-to-substance-2 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

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()

Name	Flags	Card.	Type	Description & Constraints
AllergyIntolerance	C	0..*	AUCoreAllergyIntolerance	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	?!SOΣC	0..1	CodeableConcept	active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
verificationStatus	?!SOΣ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. Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
type	Σ	0..1	code	allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
category	SΣ	1..*	code	food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.
criticality	SΣ	0..1	code	low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.
code	SOΣ	1..1	CodeableConcept	Code that identifies the allergy or intolerance Binding: Indicator of Hypersensitivity or Intolerance to Substance (extensible) Additional Bindings Purpose Adverse Reaction Substances and Negated Findings candidate Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
patient	SOΣ	1..1	Reference(ARFPatient)	Who the sensitivity is for Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
encounter		0..1	Reference(Encounter)	Encounter when the allergy or intolerance was asserted
onset[x]	SO	0..1		When allergy or intolerance was identified Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
onsetDateTime			dateTime
onsetAge			Age
onsetPeriod			Period
onsetRange			Range
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	SO	0..*	BackboneElement	Adverse Reaction Events linked to exposure to substance Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
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	SO	1..*	CodeableConcept	Clinical symptoms/signs associated with the Event Binding: Clinical Finding (preferred) Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
description		0..1	string	Description of the event as a whole
onset		0..1	dateTime	Date(/time) when manifestations showed
severity	SO	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. Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
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 Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
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	extensible	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 AUCoreAllergyIntolerance

Summary

Mandatory: 1 element
Must-Support: 2 elements

Structures

This structure refers to these other structures:

• ARFPatient (http://fhir-arf-register.nardhc.org/StructureDefinition/ARFPatient)

Differential View

This structure is derived from AUCoreAllergyIntolerance

Name	Flags	Card.	Type	Description & Constraints
AllergyIntolerance		0..*	AUCoreAllergyIntolerance	An allergy or intolerance statement in an Australian healthcare context
category	S	1..*	code	food | medication | environment | biologic
criticality	S	0..1	code	low | high | unable-to-assess
patient		1..1	Reference(ARFPatient)	Who the sensitivity is for
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
AllergyIntolerance	C	0..*	AUCoreAllergyIntolerance	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
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
clinicalStatus	?!SOΣC	0..1	CodeableConcept	active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
verificationStatus	?!SOΣ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. Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
category	SΣ	1..*	code	food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.
criticality	SΣ	0..1	code	low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.
code	SOΣ	1..1	CodeableConcept	Code that identifies the allergy or intolerance Binding: Indicator of Hypersensitivity or Intolerance to Substance (extensible) Additional Bindings Purpose Adverse Reaction Substances and Negated Findings candidate Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
patient	SOΣ	1..1	Reference(ARFPatient)	Who the sensitivity is for Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
onset[x]	SO	0..1		When allergy or intolerance was identified Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
onsetDateTime			dateTime
onsetAge			Age
onsetPeriod			Period
onsetRange			Range
reaction	SO	0..*	BackboneElement	Adverse Reaction Events linked to exposure to substance Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
manifestation	SO	1..*	CodeableConcept	Clinical symptoms/signs associated with the Event Binding: Clinical Finding (preferred) Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
severity	SO	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. Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
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.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	extensible	IndicatorOfHypersensitivityOrIntoleranceToSubstance https://healthterminologies.gov.au/fhir/ValueSet/indicator-hypersensitivity-intolerance-to-substance-2 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

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()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
AllergyIntolerance	C	0..*	AUCoreAllergyIntolerance	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	?!SOΣC	0..1	CodeableConcept	active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
verificationStatus	?!SOΣ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. Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
type	Σ	0..1	code	allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
category	SΣ	1..*	code	food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.
criticality	SΣ	0..1	code	low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.
code	SOΣ	1..1	CodeableConcept	Code that identifies the allergy or intolerance Binding: Indicator of Hypersensitivity or Intolerance to Substance (extensible) Additional Bindings Purpose Adverse Reaction Substances and Negated Findings candidate Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
patient	SOΣ	1..1	Reference(ARFPatient)	Who the sensitivity is for Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
encounter		0..1	Reference(Encounter)	Encounter when the allergy or intolerance was asserted
onset[x]	SO	0..1		When allergy or intolerance was identified Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
onsetDateTime			dateTime
onsetAge			Age
onsetPeriod			Period
onsetRange			Range
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	SO	0..*	BackboneElement	Adverse Reaction Events linked to exposure to substance Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
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	SO	1..*	CodeableConcept	Clinical symptoms/signs associated with the Event Binding: Clinical Finding (preferred) Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
description		0..1	string	Description of the event as a whole
onset		0..1	dateTime	Date(/time) when manifestations showed
severity	SO	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. Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
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 Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
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	extensible	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 AUCoreAllergyIntolerance

Summary

Mandatory: 1 element
Must-Support: 2 elements

Structures

This structure refers to these other structures:

• ARFPatient (http://fhir-arf-register.nardhc.org/StructureDefinition/ARFPatient)

Other representations of profile: CSV, Excel, Schematron