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

• Content
• Detailed Descriptions
• XML
• JSON
• TTL

Resource Profile: AU PS AllergyIntolerance

This profile sets minimum expectations for an AllergyIntolerance resource in the context of a patient summary in an Australian context. It is based on the AU Core AllergyIntolerance profile, and applies the additional requirements from AllergyIntolerance (IPS).

Usages:

• Use this Profile: AU PS Bundle
• Refer to this Profile: AU PS Composition

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.

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

This structure is derived from AUCoreAllergyIntolerance

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
AllergyIntolerance		0..*	AUCoreAllergyIntolerance	An allergy or intolerance statement in an Australian healthcare context This profile also complies with the profile AllergyIntolerance (IPS)
clinicalStatus	O	0..1	CodeableConceptIPS	active | inactive | resolved Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
verificationStatus	O	0..1	CodeableConceptIPS	unconfirmed | confirmed | refuted | entered-in-error Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
type	SO	0..1	code	allergy | intolerance - Underlying mechanism (if known) Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
code	O	1..1	CodeableConceptIPS	Code that identifies the allergy or intolerance Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
patient	O	1..1	Reference(AU PS Patient)	Who the sensitivity is for Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
reference	SO	1..1	string	Literal reference, Relative, internal or absolute URL Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer
onset[x]	O	0..1		When allergy or intolerance was identified Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
onsetDateTime			dateTime
onsetAge			Age
onsetPeriod			Period
onsetRange			Range
note	O	0..*	Annotation	Additional text not captured in other fields Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
reaction	O	0..*	BackboneElement	Adverse Reaction Events linked to exposure to substance Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
manifestation	O	1..*	CodeableConceptIPS	Clinical symptoms/signs associated with the Event Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
severity	O	0..1	code	mild | moderate | severe (of event as a whole) Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
AllergyIntolerance	C	0..*	AUCoreAllergyIntolerance	An allergy or intolerance statement in an Australian healthcare context This profile also complies with the profile AllergyIntolerance (IPS) 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
clinicalStatus	?!SOΣC	0..1	CodeableConceptIPS	active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
verificationStatus	?!SOΣC	0..1	CodeableConceptIPS	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 AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
type	SOΣ	0..1	code	allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk. Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
code	SOΣ	1..1	CodeableConceptIPS	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 AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
patient	SOΣ	1..1	Reference(AU PS Patient)	Who the sensitivity is for Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
reference	SOΣC	1..1	string	Literal reference, Relative, internal or absolute URL Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer
onset[x]	SO	0..1		When allergy or intolerance was identified Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
onsetDateTime			dateTime S
onsetAge			Age
onsetPeriod			Period
onsetRange			Range
note	SO	0..*	Annotation	Additional text not captured in other fields Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
reaction	SO	0..*	BackboneElement	Adverse Reaction Events linked to exposure to substance Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
manifestation	SO	1..*	CodeableConceptIPS	Clinical symptoms/signs associated with the Event Binding: Clinical Finding (preferred) Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
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 AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
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.type	required	AllergyIntoleranceType http://hl7.org/fhir/ValueSet/allergy-intolerance-type|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    Filter: Bindings Constraints Obligations
AllergyIntolerance	C	0..*	AUCoreAllergyIntolerance	An allergy or intolerance statement in an Australian healthcare context This profile also complies with the profile AllergyIntolerance (IPS) 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
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 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
identifier	Σ	0..*	Identifier	External ids for this item
clinicalStatus	?!SOΣC	0..1	CodeableConceptIPS	active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
verificationStatus	?!SOΣC	0..1	CodeableConceptIPS	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 AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
type	SOΣ	0..1	code	allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk. Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
category	Σ	0..*	code	food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.
criticality	Σ	0..1	code	low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.
code	SOΣ	1..1	CodeableConceptIPS	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 AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
patient	SOΣ	1..1	Reference(AU PS Patient)	Who the sensitivity is for Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	SOΣC	1..1	string	Literal reference, Relative, internal or absolute URL Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
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 AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
onsetDateTime			dateTime S
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	SO	0..*	Annotation	Additional text not captured in other fields Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
reaction	SO	0..*	BackboneElement	Adverse Reaction Events linked to exposure to substance Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
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..*	CodeableConceptIPS	Clinical symptoms/signs associated with the Event Binding: Clinical Finding (preferred) Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
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 AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
exposureRoute		0..1	CodeableConcept	How the subject was exposed to the substance Binding: Route of Administration (preferred)
note		0..*	Annotation	Text about event not captured in other fields
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
AllergyIntolerance.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
AllergyIntolerance.clinicalStatus	required	AllergyIntoleranceClinicalStatusCodes http://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1 From the FHIR Standard
AllergyIntolerance.verificationStatus	required	AllergyIntoleranceVerificationStatusCodes http://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1 From the FHIR Standard
AllergyIntolerance.type	required	AllergyIntoleranceType http://hl7.org/fhir/ValueSet/allergy-intolerance-type|4.0.1 From the FHIR Standard
AllergyIntolerance.category	required	AllergyIntoleranceCategory http://hl7.org/fhir/ValueSet/allergy-intolerance-category|4.0.1 From the FHIR Standard
AllergyIntolerance.criticality	required	AllergyIntoleranceCriticality http://hl7.org/fhir/ValueSet/allergy-intolerance-criticality|4.0.1 From the FHIR Standard
AllergyIntolerance.code	extensible	IndicatorOfHypersensitivityOrIntoleranceToSubstance https://healthterminologies.gov.au/fhir/ValueSet/indicator-hypersensitivity-intolerance-to-substance-2 From https://tx.ontoserver.csiro.au/fhir
AllergyIntolerance.patient.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
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:

• Codeable Concept (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips)
• AU PS Patient (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-patient)

Maturity: 0

Differential View

This structure is derived from AUCoreAllergyIntolerance

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
AllergyIntolerance		0..*	AUCoreAllergyIntolerance	An allergy or intolerance statement in an Australian healthcare context This profile also complies with the profile AllergyIntolerance (IPS)
clinicalStatus	O	0..1	CodeableConceptIPS	active | inactive | resolved Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
verificationStatus	O	0..1	CodeableConceptIPS	unconfirmed | confirmed | refuted | entered-in-error Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
type	SO	0..1	code	allergy | intolerance - Underlying mechanism (if known) Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
code	O	1..1	CodeableConceptIPS	Code that identifies the allergy or intolerance Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
patient	O	1..1	Reference(AU PS Patient)	Who the sensitivity is for Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
reference	SO	1..1	string	Literal reference, Relative, internal or absolute URL Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer
onset[x]	O	0..1		When allergy or intolerance was identified Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
onsetDateTime			dateTime
onsetAge			Age
onsetPeriod			Period
onsetRange			Range
note	O	0..*	Annotation	Additional text not captured in other fields Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
reaction	O	0..*	BackboneElement	Adverse Reaction Events linked to exposure to substance Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
manifestation	O	1..*	CodeableConceptIPS	Clinical symptoms/signs associated with the Event Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
severity	O	0..1	code	mild | moderate | severe (of event as a whole) Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
AllergyIntolerance	C	0..*	AUCoreAllergyIntolerance	An allergy or intolerance statement in an Australian healthcare context This profile also complies with the profile AllergyIntolerance (IPS) 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
clinicalStatus	?!SOΣC	0..1	CodeableConceptIPS	active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
verificationStatus	?!SOΣC	0..1	CodeableConceptIPS	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 AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
type	SOΣ	0..1	code	allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk. Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
code	SOΣ	1..1	CodeableConceptIPS	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 AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
patient	SOΣ	1..1	Reference(AU PS Patient)	Who the sensitivity is for Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
reference	SOΣC	1..1	string	Literal reference, Relative, internal or absolute URL Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer
onset[x]	SO	0..1		When allergy or intolerance was identified Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
onsetDateTime			dateTime S
onsetAge			Age
onsetPeriod			Period
onsetRange			Range
note	SO	0..*	Annotation	Additional text not captured in other fields Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
reaction	SO	0..*	BackboneElement	Adverse Reaction Events linked to exposure to substance Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
manifestation	SO	1..*	CodeableConceptIPS	Clinical symptoms/signs associated with the Event Binding: Clinical Finding (preferred) Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
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 AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
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.type	required	AllergyIntoleranceType http://hl7.org/fhir/ValueSet/allergy-intolerance-type|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    Filter: Bindings Constraints Obligations
AllergyIntolerance	C	0..*	AUCoreAllergyIntolerance	An allergy or intolerance statement in an Australian healthcare context This profile also complies with the profile AllergyIntolerance (IPS) 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
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 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
identifier	Σ	0..*	Identifier	External ids for this item
clinicalStatus	?!SOΣC	0..1	CodeableConceptIPS	active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
verificationStatus	?!SOΣC	0..1	CodeableConceptIPS	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 AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
type	SOΣ	0..1	code	allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk. Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
category	Σ	0..*	code	food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.
criticality	Σ	0..1	code	low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.
code	SOΣ	1..1	CodeableConceptIPS	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 AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
patient	SOΣ	1..1	Reference(AU PS Patient)	Who the sensitivity is for Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	SOΣC	1..1	string	Literal reference, Relative, internal or absolute URL Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
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 AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
onsetDateTime			dateTime S
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	SO	0..*	Annotation	Additional text not captured in other fields Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
reaction	SO	0..*	BackboneElement	Adverse Reaction Events linked to exposure to substance Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
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..*	CodeableConceptIPS	Clinical symptoms/signs associated with the Event Binding: Clinical Finding (preferred) Obligations Actor SHALL:populate-if-known AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
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 AU PS Producer SHALL:handle AU PS Consumer SHOULD:display AU PS Consumer
exposureRoute		0..1	CodeableConcept	How the subject was exposed to the substance Binding: Route of Administration (preferred)
note		0..*	Annotation	Text about event not captured in other fields
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
AllergyIntolerance.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
AllergyIntolerance.clinicalStatus	required	AllergyIntoleranceClinicalStatusCodes http://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1 From the FHIR Standard
AllergyIntolerance.verificationStatus	required	AllergyIntoleranceVerificationStatusCodes http://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1 From the FHIR Standard
AllergyIntolerance.type	required	AllergyIntoleranceType http://hl7.org/fhir/ValueSet/allergy-intolerance-type|4.0.1 From the FHIR Standard
AllergyIntolerance.category	required	AllergyIntoleranceCategory http://hl7.org/fhir/ValueSet/allergy-intolerance-category|4.0.1 From the FHIR Standard
AllergyIntolerance.criticality	required	AllergyIntoleranceCriticality http://hl7.org/fhir/ValueSet/allergy-intolerance-criticality|4.0.1 From the FHIR Standard
AllergyIntolerance.code	extensible	IndicatorOfHypersensitivityOrIntoleranceToSubstance https://healthterminologies.gov.au/fhir/ValueSet/indicator-hypersensitivity-intolerance-to-substance-2 From https://tx.ontoserver.csiro.au/fhir
AllergyIntolerance.patient.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
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:

• Codeable Concept (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips)
• AU PS Patient (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-patient)

Maturity: 0

Other representations of profile: CSV, Excel, Schematron