Te Whatu Ora, Central Region Integration Hub, published by Te Whatu Ora, Te Pae Hauora o Ruahine o Tararua, MidCentral. This guide is not an authorized publication; it is the continuous build for version 1.0.10-rc1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/tewhatuora/centralRegion-integrationHub-ig/ and changes regularly. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• JSON

Resource Profile: NZCentralRegionAllergyIntolerance

AllergyIntolerance resource for Te Whatu Ora, Central Region

Usage:

• Examples for this Resource Profile: AllergyIntolerance/PeanutAllergy

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 AllergyIntolerance

Name	Flags	Card.	Type	Description & Constraints
AllergyIntolerance		0..*	AllergyIntolerance	Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
meta
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
hl7v2Message	S	1..1	(Complex)	HL7 v2 Message URL: https://standards.digital.health.nz/ns/central-region/hl7v2-message
url		1..1	uri	identifies the meaning of the extension
value[x]		0..1	base64Binary	Value of extension
Slices for extension				Content/Rules for all slices
process-timestamp	S	0..1	dateTime	Process TimeStamp URL: http://ibm.com/fhir/cdm/StructureDefinition/process-timestamp
Slices for extension				Content/Rules for all slices
source-event-trigger	S	0..1	CodeableConcept	Source Event Trigger URL: http://ibm.com/fhir/cdm/StructureDefinition/source-event-trigger Binding: hl7VS-eventTypeCode (required)
Slices for extension				Content/Rules for all slices
source-record-type	S	0..1	CodeableConcept	Source Record Type URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-type Binding: hl7VS-messageType (required)
Slices for extension				Content/Rules for all slices
source-record-id	S	0..1	string	Source Record ID URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-id
Slices for extension				Content/Rules for all slices
source-data-mode-version	S	0..1	string	Source Data Model Version URL: http://ibm.com/fhir/cdm/StructureDefinition/source-data-model-version
Slices for extension				Content/Rules for all slices
process-client-id	S	0..1	string	Process Client ID URL: http://ibm.com/fhir/cdm/StructureDefinition/process-client-id
Slices for extension				Content/Rules for all slices
l4h-template-version	S	0..1	string	L4H Template Version URL: https://standards.digital.health.nz/ns/central-region/l4h-template-version
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
allergy-alert	S	1..1	(Complex)	NZ Central Region Alert URL: https://standards.digital.health.nz/ns/central-region/alert
extension		3..*	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:webPASCategory		1..1	Extension	Extension
url		1..1	uri	identifies the meaning of the extension
value[x]		1..1	Coding	Value of extension Binding: NZ Central Region - Allergy Alert Category Value Set (required)
system		1..1	uri	Identity of the terminology system
code		1..1	code	Symbol in syntax defined by the system
display		1..1	string	Representation defined by the system
Slices for extension				Content/Rules for all slices
extension:severityLevel		0..1	Extension	Severity level in range '0'..'9'
url		1..1	uri	identifies the meaning of the extension
value[x]		0..1	string	Value of extension
Slices for extension				Content/Rules for all slices
extension:allergyReaction		1..1	Extension	Allergy reaction code from [allergy-reaction-code](./ValueSet-nzcr-allergy-reaction-vs.html)
url		1..1	uri	identifies the meaning of the extension
value[x]
coding
system		1..1	uri	Identity of the terminology system
code		1..1	code	Symbol in syntax defined by the system
display		1..1	string	Representation defined by the system
Slices for extension				Content/Rules for all slices
extension:inactiveDate		0..1	Extension	Extension
url		1..1	uri	identifies the meaning of the extension
value[x]		1..1	date	Value of extension
Slices for extension				Content/Rules for all slices
extension:reviewDate		0..1	Extension	Extension
url		1..1	uri	identifies the meaning of the extension
value[x]		1..1	date	Value of extension
Slices for extension				Content/Rules for all slices
extension:lastUpdatedBy		0..1	Extension	Extension
url		1..1	uri	identifies the meaning of the extension
value[x]		1..1	string	Value of extension
Slices for extension				Content/Rules for all slices
extension:lastUpdatedDateTime		0..1	Extension	Extension
url		1..1	uri	identifies the meaning of the extension
value[x]		1..1	dateTime	Value of extension
Slices for extension				Content/Rules for all slices
extension:recordingHospital		1..1	Extension	Extension
url		1..1	uri	identifies the meaning of the extension
value[x]
coding
system		1..1	uri	Identity of the terminology system
code		1..1	code	Symbol in syntax defined by the system
display		0..1	string	Representation defined by the system
Slices for extension				Content/Rules for all slices
extension:comments		0..0
url		1..1	uri	identifies the meaning of the extension
identifier	S	1..1	Identifier	External ids for this item
id		0..0
extension		0..0
use		0..1	code	usual | official | temp | secondary | old (If known)
type		0..0
system	S	1..1	uri	The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-alert-id
value	S	1..1	string	The value that is unique
period		0..0
assigner		0..0
clinicalStatus	S	1..1	CodeableConcept	active | inactive | resolved
id		0..0
extension		0..0
coding	S	1..1	Coding	Code defined by a terminology system
id		0..0
extension		0..0
system	S	1..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical
version		0..0
code	S	1..1	code	Symbol in syntax defined by the system
display	S	1..1	string	Representation defined by the system
userSelected		0..0
verificationStatus	S	1..1	CodeableConcept	unconfirmed | confirmed | refuted | entered-in-error
id		0..0
extension		0..0
coding	S	1..1	Coding	Code defined by a terminology system
id		0..0
extension		0..0
system	S	1..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/allergyintolerance-verification
version		0..0
code	S	1..1	code	Symbol in syntax defined by the system
display	S	1..1	string	Representation defined by the system
userSelected		0..0
type	S	1..1	code	allergy | intolerance - Underlying mechanism (if known)
id		0..0
extension		0..0
value		0..0
category	S	1..1	code	food | medication | environment | biologic
id		0..0
extension		0..0
value		0..0
criticality	S	1..1	code	low | high | unable-to-assess
id		0..0
extension		0..0
value		0..0
code	S	1..1	CodeableConcept	Code that identifies the allergy or intolerance Binding: NZ Central Region - Allergy Alert Code Value Set (required)
id		0..0
extension		0..0
coding	S	1..1	Coding	Code defined by a terminology system
id		0..0
extension		0..0
system	S	1..1	uri	Identity of the terminology system
version		0..0
code	S	1..1	code	Symbol in syntax defined by the system
display	S	1..1	string	Representation defined by the system
userSelected		0..0
patient	S	1..1	Reference(Patient)	Who the sensitivity is for
id		0..0
extension		0..0
reference	S	0..1	string	Literal reference, Relative, internal or absolute URL
type	S	1..1	uri	Type the reference refers to (e.g. "Patient") Required Pattern: Patient
identifier	S	1..1	Identifier	Logical reference, when literal reference is not known
id		0..0
extension		0..0
use	S	1..1	code	usual | official | temp | secondary | old (If known)
type	S	1..1	CodeableConcept	Description of identifier
id		0..0
extension		0..0
coding	S	0..*	Coding	Code defined by a terminology system
id		0..0
extension		0..0
system	S	1..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
version		0..0
code	S	1..1	code	Symbol in syntax defined by the system
display	S	1..1	string	Representation defined by the system
userSelected		0..0
text		0..0
system	S	1..1	uri	The namespace for the identifier value
value	S	1..1	string	The value that is unique
period		0..0
assigner		0..0
display	S	0..1	string	Text alternative for the resource
encounter		0..0
Slices for onset[x]	S	0..1		Use onsetDateTime when only start time is known; otherwise use onsetPeriod when both start and end time are known Slice: Unordered, Open by type:$this
onsetDateTime			dateTime
onsetPeriod			Period
onset[x]:onsetDateTime	S	0..1	dateTime	When allergy or intolerance was identified
onset[x]:onsetPeriod	S	0..1	Period	When allergy or intolerance was identified
start		0..1	dateTime	Starting time with inclusive boundary
end		0..1	dateTime	End time with inclusive boundary, if not ongoing
recordedDate		0..0
recorder	S	0..1	Reference(Practitioner | PractitionerRole | Patient | RelatedPerson)	Who recorded the sensitivity
id		0..0
extension		0..0
reference	S	0..1	string	Literal reference, Relative, internal or absolute URL
type	S	1..1	uri	Resource the reference refers to (e.g. 'Practitioner') Required Pattern: Practitioner
identifier	S	1..1	Identifier	Logical reference, when literal reference is not known
id		0..0
extension		0..0
use	S	1..1	code	usual | official | temp | secondary | old (If known)
type	S	1..1	CodeableConcept	Description of identifier
id		0..0
extension		0..0
coding	S	0..*	Coding	Code defined by a terminology system
id		0..0
extension		0..0
system	S	1..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
version		0..0
code	S	1..1	code	Symbol in syntax defined by the system Required Pattern: LR
display	S	1..1	string	Representation defined by the system Required Pattern: Local Registry ID
userSelected		0..0
text		0..0
system	S	1..1	uri	The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-practitioner-id
value		0..1	string	The value that is unique
period		0..0
assigner		0..0
display	S	0..1	string	Text alternative for the resource
asserter		0..0
lastOccurrence		0..0
note	S	0..1	Annotation	Additional text not captured in other fields
author[x]		0..0
time		0..0
text	S	1..1	markdown	The annotation - text content (as markdown)
reaction		0..0
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
AllergyIntolerance.extension:allergy-alert.extension:webPASCategory.value[x]	required	NZCentralRegionAllergyAlertCategoryValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-alert-type-allergy from this IG
AllergyIntolerance.code	required	NZCentralRegionAllergyAlertCodeValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-allergy-alert-code from this IG

Name	Flags	Card.	Type	Description & Constraints
AllergyIntolerance	C	0..*	AllergyIntolerance	Allergy or Intolerance (generally: Risk of adverse reaction to a substance) 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
meta	Σ	0..1	Meta	Metadata about the resource
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
hl7v2Message	S	1..1	(Complex)	HL7 v2 Message URL: https://standards.digital.health.nz/ns/central-region/hl7v2-message
extension		0..0
url		1..1	uri	"https://standards.digital.health.nz/ns/central-region/hl7v2-message"
value[x]		0..1	base64Binary	Value of extension
process-timestamp	S	0..1	dateTime	Process TimeStamp URL: http://ibm.com/fhir/cdm/StructureDefinition/process-timestamp
source-event-trigger	S	0..1	CodeableConcept	Source Event Trigger URL: http://ibm.com/fhir/cdm/StructureDefinition/source-event-trigger Binding: hl7VS-eventTypeCode (required)
source-record-type	S	0..1	CodeableConcept	Source Record Type URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-type Binding: hl7VS-messageType (required)
source-record-id	S	0..1	string	Source Record ID URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-id
source-data-mode-version	S	0..1	string	Source Data Model Version URL: http://ibm.com/fhir/cdm/StructureDefinition/source-data-model-version
process-client-id	S	0..1	string	Process Client ID URL: http://ibm.com/fhir/cdm/StructureDefinition/process-client-id
l4h-template-version	S	0..1	string	L4H Template Version URL: https://standards.digital.health.nz/ns/central-region/l4h-template-version
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
allergy-alert	S	1..1	(Complex)	NZ Central Region Alert URL: https://standards.digital.health.nz/ns/central-region/alert
Slices for extension		3..*	Extension	Extension Slice: Unordered, Open by value:url
extension:webPASCategory	S	1..1	Extension	Extension
extension		0..0
url		1..1	uri	"webPASCategory"
value[x]		1..1	Coding	Value of extension Binding: NZ Central Region - Allergy Alert Category Value Set (required)
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
extension:severityLevel	S	0..1	Extension	Severity level in range '0'..'9'
extension		0..0
url		1..1	uri	"severityLevel"
value[x]		0..1	string	Value of extension
extension:allergyReaction	S	1..1	Extension	Allergy reaction code from [allergy-reaction-code](./ValueSet-nzcr-allergy-reaction-vs.html)
extension		0..0
url		1..1	uri	"allergyReaction"
value[x]		0..1	CodeableConcept	Value of extension Binding: NZ Central Region - Allergy Reaction Value Set (required)
extension		0..0
coding	SΣ	1..*	Coding	Multiple codings possible, one is original valuee from WebPAS...
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
extension:inactiveDate	S	0..1	Extension	Extension
extension		0..0
url		1..1	uri	"inactiveDate"
value[x]		1..1	date	Value of extension
extension:reviewDate	S	0..1	Extension	Extension
extension		0..0
url		1..1	uri	"reviewDate"
value[x]		1..1	date	Value of extension
extension:lastUpdatedBy	S	0..1	Extension	Extension
extension		0..0
url		1..1	uri	"lastUpdatedBy"
value[x]		1..1	string	Value of extension
extension:lastUpdatedDateTime	S	0..1	Extension	Extension
extension		0..0
url		1..1	uri	"lastUpdatedDateTime"
value[x]		1..1	dateTime	Value of extension
extension:recordingHospital	S	1..1	Extension	Extension
extension		0..0
url		1..1	uri	"recordingHospital"
value[x]		0..1	CodeableConcept	Value of extension Binding: NZ Central Region - Hospital Value Set (extensible)
extension		0..0
coding	SΣ	1..*	Coding	Multiple codings possible, one is original value from WebPAS...
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	0..1	string	Representation defined by the system
text	SΣ	0..1	string	Describe received code values that are unable to be validated
url		1..1	uri	"https://standards.digital.health.nz/ns/central-region/alert"
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	1..1	Identifier	External ids for this item
extension		0..0
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	SΣ	1..1	uri	The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-alert-id
value	SΣ	1..1	string	The value that is unique Example General: 123456
clinicalStatus	?!SΣC	1..1	CodeableConcept	active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
extension		0..0
coding	SΣ	1..1	Coding	Code defined by a terminology system
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
verificationStatus	?!SΣC	1..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.
extension		0..0
coding	SΣ	1..1	Coding	Code defined by a terminology system
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/allergyintolerance-verification
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
type	SΣ	1..1	code	allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
category	SΣ	1..1	code	food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.
criticality	SΣ	1..1	code	low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.
code	SΣ	1..1	CodeableConcept	Code that identifies the allergy or intolerance Binding: NZ Central Region - Allergy Alert Code Value Set (required)
extension		0..0
coding	SΣ	1..1	Coding	Code defined by a terminology system
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
patient	SΣ	1..1	Reference(Patient)	Who the sensitivity is for
extension		0..0
reference	SΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	SΣ	1..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). Required Pattern: Patient
identifier	SΣ	1..1	Identifier	Logical reference, when literal reference is not known
extension		0..0
use	?!SΣ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	SΣ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
extension		0..0
coding	SΣ	0..*	Coding	Code defined by a terminology system
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
system	SΣ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique Example General: 123456
display	SΣ	0..1	string	Text alternative for the resource
Slices for onset[x]	S	0..1		Use onsetDateTime when only start time is known; otherwise use onsetPeriod when both start and end time are known Slice: Unordered, Closed by type:$this
onsetDateTime			dateTime
onsetPeriod			Period
onset[x]:onsetDateTime	S	0..1	dateTime	When allergy or intolerance was identified
onset[x]:onsetPeriod	S	0..1	Period	When allergy or intolerance was identified
start	ΣC	0..1	dateTime	Starting time with inclusive boundary
end	ΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing
recorder	S	0..1	Reference(Practitioner | PractitionerRole | Patient | RelatedPerson)	Who recorded the sensitivity
extension		0..0
reference	SΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	SΣ	1..1	uri	Resource the reference refers to (e.g. 'Practitioner') Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Practitioner
identifier	SΣ	1..1	Identifier	Logical reference, when literal reference is not known
extension		0..0
use	?!SΣ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	SΣ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
extension		0..0
coding	SΣ	0..*	Coding	Code defined by a terminology system
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
code	SΣ	1..1	code	Symbol in syntax defined by the system Required Pattern: LR
display	SΣ	1..1	string	Representation defined by the system Required Pattern: Local Registry ID
system	SΣ	1..1	uri	The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-practitioner-id
value	Σ	0..1	string	The value that is unique Example General: 123456
display	SΣ	0..1	string	Text alternative for the resource
note	S	0..1	Annotation	Additional text not captured in other fields
text	SΣ	1..1	markdown	The annotation - text content (as markdown)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
AllergyIntolerance.extension:allergy-alert.extension:webPASCategory.value[x]	required	NZCentralRegionAllergyAlertCategoryValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-alert-type-allergy from this IG
AllergyIntolerance.extension:allergy-alert.extension:allergyReaction.value[x]	required	NZCentralRegionAllergyReactionValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-allergy-reaction from this IG
AllergyIntolerance.extension:allergy-alert.extension:recordingHospital.value[x]	extensible	NZCentralRegionHospitalValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-hospital-code from this IG
AllergyIntolerance.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 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	required	NZCentralRegionAllergyAlertCodeValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-allergy-alert-code from this IG
AllergyIntolerance.patient.type	extensible	Pattern: Patient http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
AllergyIntolerance.patient.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
AllergyIntolerance.patient.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
AllergyIntolerance.recorder.type	extensible	Pattern: Practitioner http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
AllergyIntolerance.recorder.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
AllergyIntolerance.recorder.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
AllergyIntolerance.reaction.manifestation	example	SNOMEDCTClinicalFindings http://hl7.org/fhir/ValueSet/clinical-findings 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..*	AllergyIntolerance	Allergy or Intolerance (generally: Risk of adverse reaction to a substance) 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
id		0..1	string	Unique id for inter-element referencing
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
hl7v2Message	S	1..1	(Complex)	HL7 v2 Message URL: https://standards.digital.health.nz/ns/central-region/hl7v2-message
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"https://standards.digital.health.nz/ns/central-region/hl7v2-message"
value[x]		0..1	base64Binary	Value of extension
process-timestamp	S	0..1	dateTime	Process TimeStamp URL: http://ibm.com/fhir/cdm/StructureDefinition/process-timestamp
source-event-trigger	S	0..1	CodeableConcept	Source Event Trigger URL: http://ibm.com/fhir/cdm/StructureDefinition/source-event-trigger Binding: hl7VS-eventTypeCode (required)
source-record-type	S	0..1	CodeableConcept	Source Record Type URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-type Binding: hl7VS-messageType (required)
source-record-id	S	0..1	string	Source Record ID URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-id
source-data-mode-version	S	0..1	string	Source Data Model Version URL: http://ibm.com/fhir/cdm/StructureDefinition/source-data-model-version
process-client-id	S	0..1	string	Process Client ID URL: http://ibm.com/fhir/cdm/StructureDefinition/process-client-id
l4h-template-version	S	0..1	string	L4H Template Version URL: https://standards.digital.health.nz/ns/central-region/l4h-template-version
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	0..1	instant	When the resource version last changed
source	Σ	0..1	uri	Identifies where the resource comes from
profile	Σ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag	Σ	0..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
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
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
allergy-alert	S	1..1	(Complex)	NZ Central Region Alert URL: https://standards.digital.health.nz/ns/central-region/alert
Slices for extension		3..*	Extension	Extension Slice: Unordered, Open by value:url
extension:webPASCategory	S	1..1	Extension	Extension
extension		0..0
url		1..1	uri	"webPASCategory"
value[x]		1..1	Coding	Value of extension Binding: NZ Central Region - Allergy Alert Category Value Set (required)
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
extension:severityLevel	S	0..1	Extension	Severity level in range '0'..'9'
extension		0..0
url		1..1	uri	"severityLevel"
value[x]		0..1	string	Value of extension
extension:allergyReaction	S	1..1	Extension	Allergy reaction code from [allergy-reaction-code](./ValueSet-nzcr-allergy-reaction-vs.html)
extension		0..0
url		1..1	uri	"allergyReaction"
value[x]		0..1	CodeableConcept	Value of extension Binding: NZ Central Region - Allergy Reaction Value Set (required)
extension		0..0
coding	SΣ	1..*	Coding	Multiple codings possible, one is original valuee from WebPAS...
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
extension:inactiveDate	S	0..1	Extension	Extension
extension		0..0
url		1..1	uri	"inactiveDate"
value[x]		1..1	date	Value of extension
extension:reviewDate	S	0..1	Extension	Extension
extension		0..0
url		1..1	uri	"reviewDate"
value[x]		1..1	date	Value of extension
extension:lastUpdatedBy	S	0..1	Extension	Extension
extension		0..0
url		1..1	uri	"lastUpdatedBy"
value[x]		1..1	string	Value of extension
extension:lastUpdatedDateTime	S	0..1	Extension	Extension
extension		0..0
url		1..1	uri	"lastUpdatedDateTime"
value[x]		1..1	dateTime	Value of extension
extension:recordingHospital	S	1..1	Extension	Extension
extension		0..0
url		1..1	uri	"recordingHospital"
value[x]		0..1	CodeableConcept	Value of extension Binding: NZ Central Region - Hospital Value Set (extensible)
extension		0..0
coding	SΣ	1..*	Coding	Multiple codings possible, one is original value from WebPAS...
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	0..1	string	Representation defined by the system
text	SΣ	0..1	string	Describe received code values that are unable to be validated
url		1..1	uri	"https://standards.digital.health.nz/ns/central-region/alert"
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	1..1	Identifier	External ids for this item
extension		0..0
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	SΣ	1..1	uri	The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-alert-id
value	SΣ	1..1	string	The value that is unique Example General: 123456
clinicalStatus	?!SΣC	1..1	CodeableConcept	active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
extension		0..0
coding	SΣ	1..1	Coding	Code defined by a terminology system
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
text	Σ	0..1	string	Plain text representation of the concept
verificationStatus	?!SΣC	1..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.
extension		0..0
coding	SΣ	1..1	Coding	Code defined by a terminology system
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/allergyintolerance-verification
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
text	Σ	0..1	string	Plain text representation of the concept
type	SΣ	1..1	code	allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
category	SΣ	1..1	code	food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.
criticality	SΣ	1..1	code	low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.
code	SΣ	1..1	CodeableConcept	Code that identifies the allergy or intolerance Binding: NZ Central Region - Allergy Alert Code Value Set (required)
extension		0..0
coding	SΣ	1..1	Coding	Code defined by a terminology system
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
text	Σ	0..1	string	Plain text representation of the concept
patient	SΣ	1..1	Reference(Patient)	Who the sensitivity is for
extension		0..0
reference	SΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	SΣ	1..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). Required Pattern: Patient
identifier	SΣ	1..1	Identifier	Logical reference, when literal reference is not known
extension		0..0
use	?!SΣ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	SΣ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
extension		0..0
coding	SΣ	0..*	Coding	Code defined by a terminology system
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
system	SΣ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique Example General: 123456
display	SΣ	0..1	string	Text alternative for the resource
Slices for onset[x]	S	0..1		Use onsetDateTime when only start time is known; otherwise use onsetPeriod when both start and end time are known Slice: Unordered, Closed by type:$this
onsetDateTime			dateTime
onsetPeriod			Period
onset[x]:onsetDateTime	S	0..1	dateTime	When allergy or intolerance was identified
onset[x]:onsetPeriod	S	0..1	Period	When allergy or intolerance was identified
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
start	ΣC	0..1	dateTime	Starting time with inclusive boundary
end	ΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing
recorder	S	0..1	Reference(Practitioner | PractitionerRole | Patient | RelatedPerson)	Who recorded the sensitivity
extension		0..0
reference	SΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	SΣ	1..1	uri	Resource the reference refers to (e.g. 'Practitioner') Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Practitioner
identifier	SΣ	1..1	Identifier	Logical reference, when literal reference is not known
extension		0..0
use	?!SΣ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	SΣ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
extension		0..0
coding	SΣ	0..*	Coding	Code defined by a terminology system
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
code	SΣ	1..1	code	Symbol in syntax defined by the system Required Pattern: LR
display	SΣ	1..1	string	Representation defined by the system Required Pattern: Local Registry ID
system	SΣ	1..1	uri	The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-practitioner-id
value	Σ	0..1	string	The value that is unique Example General: 123456
display	SΣ	0..1	string	Text alternative for the resource
note	S	0..1	Annotation	Additional text not captured in other fields
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
text	SΣ	1..1	markdown	The annotation - text content (as markdown)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
AllergyIntolerance.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
AllergyIntolerance.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
AllergyIntolerance.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
AllergyIntolerance.extension:allergy-alert.extension:webPASCategory.value[x]	required	NZCentralRegionAllergyAlertCategoryValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-alert-type-allergy from this IG
AllergyIntolerance.extension:allergy-alert.extension:allergyReaction.value[x]	required	NZCentralRegionAllergyReactionValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-allergy-reaction from this IG
AllergyIntolerance.extension:allergy-alert.extension:recordingHospital.value[x]	extensible	NZCentralRegionHospitalValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-hospital-code from this IG
AllergyIntolerance.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 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	required	NZCentralRegionAllergyAlertCodeValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-allergy-alert-code from this IG
AllergyIntolerance.patient.type	extensible	Pattern: Patient http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
AllergyIntolerance.patient.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
AllergyIntolerance.patient.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
AllergyIntolerance.recorder.type	extensible	Pattern: Practitioner http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
AllergyIntolerance.recorder.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
AllergyIntolerance.recorder.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
AllergyIntolerance.reaction.substance	example	SubstanceCode http://hl7.org/fhir/ValueSet/substance-code from the FHIR Standard
AllergyIntolerance.reaction.manifestation	example	SNOMEDCTClinicalFindings http://hl7.org/fhir/ValueSet/clinical-findings from the FHIR Standard
AllergyIntolerance.reaction.severity	required	AllergyIntoleranceSeverity http://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1 from the FHIR Standard
AllergyIntolerance.reaction.exposureRoute	example	SNOMEDCTRouteCodes http://hl7.org/fhir/ValueSet/route-codes 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()

This structure is derived from AllergyIntolerance

Summary

Mandatory: 31 elements(13 nested mandatory elements)
Must-Support: 60 elements
Prohibited: 66 elements

Extensions

This structure refers to these extensions:

• https://standards.digital.health.nz/ns/central-region/hl7v2-message
• http://ibm.com/fhir/cdm/StructureDefinition/process-timestamp
• http://ibm.com/fhir/cdm/StructureDefinition/source-event-trigger
• http://ibm.com/fhir/cdm/StructureDefinition/source-record-type
• http://ibm.com/fhir/cdm/StructureDefinition/source-record-id
• http://ibm.com/fhir/cdm/StructureDefinition/source-data-model-version
• http://ibm.com/fhir/cdm/StructureDefinition/process-client-id
• https://standards.digital.health.nz/ns/central-region/l4h-template-version
• https://standards.digital.health.nz/ns/central-region/alert

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of AllergyIntolerance.onset[x]

Differential View

This structure is derived from AllergyIntolerance

Name	Flags	Card.	Type	Description & Constraints
AllergyIntolerance		0..*	AllergyIntolerance	Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
meta
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
hl7v2Message	S	1..1	(Complex)	HL7 v2 Message URL: https://standards.digital.health.nz/ns/central-region/hl7v2-message
url		1..1	uri	identifies the meaning of the extension
value[x]		0..1	base64Binary	Value of extension
Slices for extension				Content/Rules for all slices
process-timestamp	S	0..1	dateTime	Process TimeStamp URL: http://ibm.com/fhir/cdm/StructureDefinition/process-timestamp
Slices for extension				Content/Rules for all slices
source-event-trigger	S	0..1	CodeableConcept	Source Event Trigger URL: http://ibm.com/fhir/cdm/StructureDefinition/source-event-trigger Binding: hl7VS-eventTypeCode (required)
Slices for extension				Content/Rules for all slices
source-record-type	S	0..1	CodeableConcept	Source Record Type URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-type Binding: hl7VS-messageType (required)
Slices for extension				Content/Rules for all slices
source-record-id	S	0..1	string	Source Record ID URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-id
Slices for extension				Content/Rules for all slices
source-data-mode-version	S	0..1	string	Source Data Model Version URL: http://ibm.com/fhir/cdm/StructureDefinition/source-data-model-version
Slices for extension				Content/Rules for all slices
process-client-id	S	0..1	string	Process Client ID URL: http://ibm.com/fhir/cdm/StructureDefinition/process-client-id
Slices for extension				Content/Rules for all slices
l4h-template-version	S	0..1	string	L4H Template Version URL: https://standards.digital.health.nz/ns/central-region/l4h-template-version
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
allergy-alert	S	1..1	(Complex)	NZ Central Region Alert URL: https://standards.digital.health.nz/ns/central-region/alert
extension		3..*	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:webPASCategory		1..1	Extension	Extension
url		1..1	uri	identifies the meaning of the extension
value[x]		1..1	Coding	Value of extension Binding: NZ Central Region - Allergy Alert Category Value Set (required)
system		1..1	uri	Identity of the terminology system
code		1..1	code	Symbol in syntax defined by the system
display		1..1	string	Representation defined by the system
Slices for extension				Content/Rules for all slices
extension:severityLevel		0..1	Extension	Severity level in range '0'..'9'
url		1..1	uri	identifies the meaning of the extension
value[x]		0..1	string	Value of extension
Slices for extension				Content/Rules for all slices
extension:allergyReaction		1..1	Extension	Allergy reaction code from [allergy-reaction-code](./ValueSet-nzcr-allergy-reaction-vs.html)
url		1..1	uri	identifies the meaning of the extension
value[x]
coding
system		1..1	uri	Identity of the terminology system
code		1..1	code	Symbol in syntax defined by the system
display		1..1	string	Representation defined by the system
Slices for extension				Content/Rules for all slices
extension:inactiveDate		0..1	Extension	Extension
url		1..1	uri	identifies the meaning of the extension
value[x]		1..1	date	Value of extension
Slices for extension				Content/Rules for all slices
extension:reviewDate		0..1	Extension	Extension
url		1..1	uri	identifies the meaning of the extension
value[x]		1..1	date	Value of extension
Slices for extension				Content/Rules for all slices
extension:lastUpdatedBy		0..1	Extension	Extension
url		1..1	uri	identifies the meaning of the extension
value[x]		1..1	string	Value of extension
Slices for extension				Content/Rules for all slices
extension:lastUpdatedDateTime		0..1	Extension	Extension
url		1..1	uri	identifies the meaning of the extension
value[x]		1..1	dateTime	Value of extension
Slices for extension				Content/Rules for all slices
extension:recordingHospital		1..1	Extension	Extension
url		1..1	uri	identifies the meaning of the extension
value[x]
coding
system		1..1	uri	Identity of the terminology system
code		1..1	code	Symbol in syntax defined by the system
display		0..1	string	Representation defined by the system
Slices for extension				Content/Rules for all slices
extension:comments		0..0
url		1..1	uri	identifies the meaning of the extension
identifier	S	1..1	Identifier	External ids for this item
id		0..0
extension		0..0
use		0..1	code	usual | official | temp | secondary | old (If known)
type		0..0
system	S	1..1	uri	The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-alert-id
value	S	1..1	string	The value that is unique
period		0..0
assigner		0..0
clinicalStatus	S	1..1	CodeableConcept	active | inactive | resolved
id		0..0
extension		0..0
coding	S	1..1	Coding	Code defined by a terminology system
id		0..0
extension		0..0
system	S	1..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical
version		0..0
code	S	1..1	code	Symbol in syntax defined by the system
display	S	1..1	string	Representation defined by the system
userSelected		0..0
verificationStatus	S	1..1	CodeableConcept	unconfirmed | confirmed | refuted | entered-in-error
id		0..0
extension		0..0
coding	S	1..1	Coding	Code defined by a terminology system
id		0..0
extension		0..0
system	S	1..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/allergyintolerance-verification
version		0..0
code	S	1..1	code	Symbol in syntax defined by the system
display	S	1..1	string	Representation defined by the system
userSelected		0..0
type	S	1..1	code	allergy | intolerance - Underlying mechanism (if known)
id		0..0
extension		0..0
value		0..0
category	S	1..1	code	food | medication | environment | biologic
id		0..0
extension		0..0
value		0..0
criticality	S	1..1	code	low | high | unable-to-assess
id		0..0
extension		0..0
value		0..0
code	S	1..1	CodeableConcept	Code that identifies the allergy or intolerance Binding: NZ Central Region - Allergy Alert Code Value Set (required)
id		0..0
extension		0..0
coding	S	1..1	Coding	Code defined by a terminology system
id		0..0
extension		0..0
system	S	1..1	uri	Identity of the terminology system
version		0..0
code	S	1..1	code	Symbol in syntax defined by the system
display	S	1..1	string	Representation defined by the system
userSelected		0..0
patient	S	1..1	Reference(Patient)	Who the sensitivity is for
id		0..0
extension		0..0
reference	S	0..1	string	Literal reference, Relative, internal or absolute URL
type	S	1..1	uri	Type the reference refers to (e.g. "Patient") Required Pattern: Patient
identifier	S	1..1	Identifier	Logical reference, when literal reference is not known
id		0..0
extension		0..0
use	S	1..1	code	usual | official | temp | secondary | old (If known)
type	S	1..1	CodeableConcept	Description of identifier
id		0..0
extension		0..0
coding	S	0..*	Coding	Code defined by a terminology system
id		0..0
extension		0..0
system	S	1..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
version		0..0
code	S	1..1	code	Symbol in syntax defined by the system
display	S	1..1	string	Representation defined by the system
userSelected		0..0
text		0..0
system	S	1..1	uri	The namespace for the identifier value
value	S	1..1	string	The value that is unique
period		0..0
assigner		0..0
display	S	0..1	string	Text alternative for the resource
encounter		0..0
Slices for onset[x]	S	0..1		Use onsetDateTime when only start time is known; otherwise use onsetPeriod when both start and end time are known Slice: Unordered, Open by type:$this
onsetDateTime			dateTime
onsetPeriod			Period
onset[x]:onsetDateTime	S	0..1	dateTime	When allergy or intolerance was identified
onset[x]:onsetPeriod	S	0..1	Period	When allergy or intolerance was identified
start		0..1	dateTime	Starting time with inclusive boundary
end		0..1	dateTime	End time with inclusive boundary, if not ongoing
recordedDate		0..0
recorder	S	0..1	Reference(Practitioner | PractitionerRole | Patient | RelatedPerson)	Who recorded the sensitivity
id		0..0
extension		0..0
reference	S	0..1	string	Literal reference, Relative, internal or absolute URL
type	S	1..1	uri	Resource the reference refers to (e.g. 'Practitioner') Required Pattern: Practitioner
identifier	S	1..1	Identifier	Logical reference, when literal reference is not known
id		0..0
extension		0..0
use	S	1..1	code	usual | official | temp | secondary | old (If known)
type	S	1..1	CodeableConcept	Description of identifier
id		0..0
extension		0..0
coding	S	0..*	Coding	Code defined by a terminology system
id		0..0
extension		0..0
system	S	1..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
version		0..0
code	S	1..1	code	Symbol in syntax defined by the system Required Pattern: LR
display	S	1..1	string	Representation defined by the system Required Pattern: Local Registry ID
userSelected		0..0
text		0..0
system	S	1..1	uri	The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-practitioner-id
value		0..1	string	The value that is unique
period		0..0
assigner		0..0
display	S	0..1	string	Text alternative for the resource
asserter		0..0
lastOccurrence		0..0
note	S	0..1	Annotation	Additional text not captured in other fields
author[x]		0..0
time		0..0
text	S	1..1	markdown	The annotation - text content (as markdown)
reaction		0..0
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
AllergyIntolerance.extension:allergy-alert.extension:webPASCategory.value[x]	required	NZCentralRegionAllergyAlertCategoryValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-alert-type-allergy from this IG
AllergyIntolerance.code	required	NZCentralRegionAllergyAlertCodeValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-allergy-alert-code from this IG

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
AllergyIntolerance	C	0..*	AllergyIntolerance	Allergy or Intolerance (generally: Risk of adverse reaction to a substance) 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
meta	Σ	0..1	Meta	Metadata about the resource
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
hl7v2Message	S	1..1	(Complex)	HL7 v2 Message URL: https://standards.digital.health.nz/ns/central-region/hl7v2-message
extension		0..0
url		1..1	uri	"https://standards.digital.health.nz/ns/central-region/hl7v2-message"
value[x]		0..1	base64Binary	Value of extension
process-timestamp	S	0..1	dateTime	Process TimeStamp URL: http://ibm.com/fhir/cdm/StructureDefinition/process-timestamp
source-event-trigger	S	0..1	CodeableConcept	Source Event Trigger URL: http://ibm.com/fhir/cdm/StructureDefinition/source-event-trigger Binding: hl7VS-eventTypeCode (required)
source-record-type	S	0..1	CodeableConcept	Source Record Type URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-type Binding: hl7VS-messageType (required)
source-record-id	S	0..1	string	Source Record ID URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-id
source-data-mode-version	S	0..1	string	Source Data Model Version URL: http://ibm.com/fhir/cdm/StructureDefinition/source-data-model-version
process-client-id	S	0..1	string	Process Client ID URL: http://ibm.com/fhir/cdm/StructureDefinition/process-client-id
l4h-template-version	S	0..1	string	L4H Template Version URL: https://standards.digital.health.nz/ns/central-region/l4h-template-version
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
allergy-alert	S	1..1	(Complex)	NZ Central Region Alert URL: https://standards.digital.health.nz/ns/central-region/alert
Slices for extension		3..*	Extension	Extension Slice: Unordered, Open by value:url
extension:webPASCategory	S	1..1	Extension	Extension
extension		0..0
url		1..1	uri	"webPASCategory"
value[x]		1..1	Coding	Value of extension Binding: NZ Central Region - Allergy Alert Category Value Set (required)
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
extension:severityLevel	S	0..1	Extension	Severity level in range '0'..'9'
extension		0..0
url		1..1	uri	"severityLevel"
value[x]		0..1	string	Value of extension
extension:allergyReaction	S	1..1	Extension	Allergy reaction code from [allergy-reaction-code](./ValueSet-nzcr-allergy-reaction-vs.html)
extension		0..0
url		1..1	uri	"allergyReaction"
value[x]		0..1	CodeableConcept	Value of extension Binding: NZ Central Region - Allergy Reaction Value Set (required)
extension		0..0
coding	SΣ	1..*	Coding	Multiple codings possible, one is original valuee from WebPAS...
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
extension:inactiveDate	S	0..1	Extension	Extension
extension		0..0
url		1..1	uri	"inactiveDate"
value[x]		1..1	date	Value of extension
extension:reviewDate	S	0..1	Extension	Extension
extension		0..0
url		1..1	uri	"reviewDate"
value[x]		1..1	date	Value of extension
extension:lastUpdatedBy	S	0..1	Extension	Extension
extension		0..0
url		1..1	uri	"lastUpdatedBy"
value[x]		1..1	string	Value of extension
extension:lastUpdatedDateTime	S	0..1	Extension	Extension
extension		0..0
url		1..1	uri	"lastUpdatedDateTime"
value[x]		1..1	dateTime	Value of extension
extension:recordingHospital	S	1..1	Extension	Extension
extension		0..0
url		1..1	uri	"recordingHospital"
value[x]		0..1	CodeableConcept	Value of extension Binding: NZ Central Region - Hospital Value Set (extensible)
extension		0..0
coding	SΣ	1..*	Coding	Multiple codings possible, one is original value from WebPAS...
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	0..1	string	Representation defined by the system
text	SΣ	0..1	string	Describe received code values that are unable to be validated
url		1..1	uri	"https://standards.digital.health.nz/ns/central-region/alert"
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	1..1	Identifier	External ids for this item
extension		0..0
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	SΣ	1..1	uri	The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-alert-id
value	SΣ	1..1	string	The value that is unique Example General: 123456
clinicalStatus	?!SΣC	1..1	CodeableConcept	active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
extension		0..0
coding	SΣ	1..1	Coding	Code defined by a terminology system
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
verificationStatus	?!SΣC	1..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.
extension		0..0
coding	SΣ	1..1	Coding	Code defined by a terminology system
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/allergyintolerance-verification
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
type	SΣ	1..1	code	allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
category	SΣ	1..1	code	food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.
criticality	SΣ	1..1	code	low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.
code	SΣ	1..1	CodeableConcept	Code that identifies the allergy or intolerance Binding: NZ Central Region - Allergy Alert Code Value Set (required)
extension		0..0
coding	SΣ	1..1	Coding	Code defined by a terminology system
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
patient	SΣ	1..1	Reference(Patient)	Who the sensitivity is for
extension		0..0
reference	SΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	SΣ	1..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). Required Pattern: Patient
identifier	SΣ	1..1	Identifier	Logical reference, when literal reference is not known
extension		0..0
use	?!SΣ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	SΣ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
extension		0..0
coding	SΣ	0..*	Coding	Code defined by a terminology system
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
system	SΣ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique Example General: 123456
display	SΣ	0..1	string	Text alternative for the resource
Slices for onset[x]	S	0..1		Use onsetDateTime when only start time is known; otherwise use onsetPeriod when both start and end time are known Slice: Unordered, Closed by type:$this
onsetDateTime			dateTime
onsetPeriod			Period
onset[x]:onsetDateTime	S	0..1	dateTime	When allergy or intolerance was identified
onset[x]:onsetPeriod	S	0..1	Period	When allergy or intolerance was identified
start	ΣC	0..1	dateTime	Starting time with inclusive boundary
end	ΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing
recorder	S	0..1	Reference(Practitioner | PractitionerRole | Patient | RelatedPerson)	Who recorded the sensitivity
extension		0..0
reference	SΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	SΣ	1..1	uri	Resource the reference refers to (e.g. 'Practitioner') Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Practitioner
identifier	SΣ	1..1	Identifier	Logical reference, when literal reference is not known
extension		0..0
use	?!SΣ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	SΣ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
extension		0..0
coding	SΣ	0..*	Coding	Code defined by a terminology system
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
code	SΣ	1..1	code	Symbol in syntax defined by the system Required Pattern: LR
display	SΣ	1..1	string	Representation defined by the system Required Pattern: Local Registry ID
system	SΣ	1..1	uri	The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-practitioner-id
value	Σ	0..1	string	The value that is unique Example General: 123456
display	SΣ	0..1	string	Text alternative for the resource
note	S	0..1	Annotation	Additional text not captured in other fields
text	SΣ	1..1	markdown	The annotation - text content (as markdown)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
AllergyIntolerance.extension:allergy-alert.extension:webPASCategory.value[x]	required	NZCentralRegionAllergyAlertCategoryValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-alert-type-allergy from this IG
AllergyIntolerance.extension:allergy-alert.extension:allergyReaction.value[x]	required	NZCentralRegionAllergyReactionValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-allergy-reaction from this IG
AllergyIntolerance.extension:allergy-alert.extension:recordingHospital.value[x]	extensible	NZCentralRegionHospitalValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-hospital-code from this IG
AllergyIntolerance.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 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	required	NZCentralRegionAllergyAlertCodeValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-allergy-alert-code from this IG
AllergyIntolerance.patient.type	extensible	Pattern: Patient http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
AllergyIntolerance.patient.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
AllergyIntolerance.patient.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
AllergyIntolerance.recorder.type	extensible	Pattern: Practitioner http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
AllergyIntolerance.recorder.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
AllergyIntolerance.recorder.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
AllergyIntolerance.reaction.manifestation	example	SNOMEDCTClinicalFindings http://hl7.org/fhir/ValueSet/clinical-findings 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..*	AllergyIntolerance	Allergy or Intolerance (generally: Risk of adverse reaction to a substance) 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
id		0..1	string	Unique id for inter-element referencing
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
hl7v2Message	S	1..1	(Complex)	HL7 v2 Message URL: https://standards.digital.health.nz/ns/central-region/hl7v2-message
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"https://standards.digital.health.nz/ns/central-region/hl7v2-message"
value[x]		0..1	base64Binary	Value of extension
process-timestamp	S	0..1	dateTime	Process TimeStamp URL: http://ibm.com/fhir/cdm/StructureDefinition/process-timestamp
source-event-trigger	S	0..1	CodeableConcept	Source Event Trigger URL: http://ibm.com/fhir/cdm/StructureDefinition/source-event-trigger Binding: hl7VS-eventTypeCode (required)
source-record-type	S	0..1	CodeableConcept	Source Record Type URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-type Binding: hl7VS-messageType (required)
source-record-id	S	0..1	string	Source Record ID URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-id
source-data-mode-version	S	0..1	string	Source Data Model Version URL: http://ibm.com/fhir/cdm/StructureDefinition/source-data-model-version
process-client-id	S	0..1	string	Process Client ID URL: http://ibm.com/fhir/cdm/StructureDefinition/process-client-id
l4h-template-version	S	0..1	string	L4H Template Version URL: https://standards.digital.health.nz/ns/central-region/l4h-template-version
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	0..1	instant	When the resource version last changed
source	Σ	0..1	uri	Identifies where the resource comes from
profile	Σ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag	Σ	0..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
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
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
allergy-alert	S	1..1	(Complex)	NZ Central Region Alert URL: https://standards.digital.health.nz/ns/central-region/alert
Slices for extension		3..*	Extension	Extension Slice: Unordered, Open by value:url
extension:webPASCategory	S	1..1	Extension	Extension
extension		0..0
url		1..1	uri	"webPASCategory"
value[x]		1..1	Coding	Value of extension Binding: NZ Central Region - Allergy Alert Category Value Set (required)
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
extension:severityLevel	S	0..1	Extension	Severity level in range '0'..'9'
extension		0..0
url		1..1	uri	"severityLevel"
value[x]		0..1	string	Value of extension
extension:allergyReaction	S	1..1	Extension	Allergy reaction code from [allergy-reaction-code](./ValueSet-nzcr-allergy-reaction-vs.html)
extension		0..0
url		1..1	uri	"allergyReaction"
value[x]		0..1	CodeableConcept	Value of extension Binding: NZ Central Region - Allergy Reaction Value Set (required)
extension		0..0
coding	SΣ	1..*	Coding	Multiple codings possible, one is original valuee from WebPAS...
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
extension:inactiveDate	S	0..1	Extension	Extension
extension		0..0
url		1..1	uri	"inactiveDate"
value[x]		1..1	date	Value of extension
extension:reviewDate	S	0..1	Extension	Extension
extension		0..0
url		1..1	uri	"reviewDate"
value[x]		1..1	date	Value of extension
extension:lastUpdatedBy	S	0..1	Extension	Extension
extension		0..0
url		1..1	uri	"lastUpdatedBy"
value[x]		1..1	string	Value of extension
extension:lastUpdatedDateTime	S	0..1	Extension	Extension
extension		0..0
url		1..1	uri	"lastUpdatedDateTime"
value[x]		1..1	dateTime	Value of extension
extension:recordingHospital	S	1..1	Extension	Extension
extension		0..0
url		1..1	uri	"recordingHospital"
value[x]		0..1	CodeableConcept	Value of extension Binding: NZ Central Region - Hospital Value Set (extensible)
extension		0..0
coding	SΣ	1..*	Coding	Multiple codings possible, one is original value from WebPAS...
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	0..1	string	Representation defined by the system
text	SΣ	0..1	string	Describe received code values that are unable to be validated
url		1..1	uri	"https://standards.digital.health.nz/ns/central-region/alert"
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	1..1	Identifier	External ids for this item
extension		0..0
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	SΣ	1..1	uri	The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-alert-id
value	SΣ	1..1	string	The value that is unique Example General: 123456
clinicalStatus	?!SΣC	1..1	CodeableConcept	active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
extension		0..0
coding	SΣ	1..1	Coding	Code defined by a terminology system
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
text	Σ	0..1	string	Plain text representation of the concept
verificationStatus	?!SΣC	1..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.
extension		0..0
coding	SΣ	1..1	Coding	Code defined by a terminology system
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/allergyintolerance-verification
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
text	Σ	0..1	string	Plain text representation of the concept
type	SΣ	1..1	code	allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
category	SΣ	1..1	code	food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.
criticality	SΣ	1..1	code	low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.
code	SΣ	1..1	CodeableConcept	Code that identifies the allergy or intolerance Binding: NZ Central Region - Allergy Alert Code Value Set (required)
extension		0..0
coding	SΣ	1..1	Coding	Code defined by a terminology system
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
text	Σ	0..1	string	Plain text representation of the concept
patient	SΣ	1..1	Reference(Patient)	Who the sensitivity is for
extension		0..0
reference	SΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	SΣ	1..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). Required Pattern: Patient
identifier	SΣ	1..1	Identifier	Logical reference, when literal reference is not known
extension		0..0
use	?!SΣ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	SΣ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
extension		0..0
coding	SΣ	0..*	Coding	Code defined by a terminology system
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
system	SΣ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique Example General: 123456
display	SΣ	0..1	string	Text alternative for the resource
Slices for onset[x]	S	0..1		Use onsetDateTime when only start time is known; otherwise use onsetPeriod when both start and end time are known Slice: Unordered, Closed by type:$this
onsetDateTime			dateTime
onsetPeriod			Period
onset[x]:onsetDateTime	S	0..1	dateTime	When allergy or intolerance was identified
onset[x]:onsetPeriod	S	0..1	Period	When allergy or intolerance was identified
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
start	ΣC	0..1	dateTime	Starting time with inclusive boundary
end	ΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing
recorder	S	0..1	Reference(Practitioner | PractitionerRole | Patient | RelatedPerson)	Who recorded the sensitivity
extension		0..0
reference	SΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	SΣ	1..1	uri	Resource the reference refers to (e.g. 'Practitioner') Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Practitioner
identifier	SΣ	1..1	Identifier	Logical reference, when literal reference is not known
extension		0..0
use	?!SΣ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	SΣ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
extension		0..0
coding	SΣ	0..*	Coding	Code defined by a terminology system
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
code	SΣ	1..1	code	Symbol in syntax defined by the system Required Pattern: LR
display	SΣ	1..1	string	Representation defined by the system Required Pattern: Local Registry ID
system	SΣ	1..1	uri	The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-practitioner-id
value	Σ	0..1	string	The value that is unique Example General: 123456
display	SΣ	0..1	string	Text alternative for the resource
note	S	0..1	Annotation	Additional text not captured in other fields
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
text	SΣ	1..1	markdown	The annotation - text content (as markdown)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
AllergyIntolerance.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
AllergyIntolerance.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
AllergyIntolerance.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
AllergyIntolerance.extension:allergy-alert.extension:webPASCategory.value[x]	required	NZCentralRegionAllergyAlertCategoryValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-alert-type-allergy from this IG
AllergyIntolerance.extension:allergy-alert.extension:allergyReaction.value[x]	required	NZCentralRegionAllergyReactionValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-allergy-reaction from this IG
AllergyIntolerance.extension:allergy-alert.extension:recordingHospital.value[x]	extensible	NZCentralRegionHospitalValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-hospital-code from this IG
AllergyIntolerance.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 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	required	NZCentralRegionAllergyAlertCodeValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-allergy-alert-code from this IG
AllergyIntolerance.patient.type	extensible	Pattern: Patient http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
AllergyIntolerance.patient.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
AllergyIntolerance.patient.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
AllergyIntolerance.recorder.type	extensible	Pattern: Practitioner http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
AllergyIntolerance.recorder.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
AllergyIntolerance.recorder.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
AllergyIntolerance.reaction.substance	example	SubstanceCode http://hl7.org/fhir/ValueSet/substance-code from the FHIR Standard
AllergyIntolerance.reaction.manifestation	example	SNOMEDCTClinicalFindings http://hl7.org/fhir/ValueSet/clinical-findings from the FHIR Standard
AllergyIntolerance.reaction.severity	required	AllergyIntoleranceSeverity http://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1 from the FHIR Standard
AllergyIntolerance.reaction.exposureRoute	example	SNOMEDCTRouteCodes http://hl7.org/fhir/ValueSet/route-codes 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()

This structure is derived from AllergyIntolerance

Summary

Mandatory: 31 elements(13 nested mandatory elements)
Must-Support: 60 elements
Prohibited: 66 elements

Extensions

This structure refers to these extensions:

• https://standards.digital.health.nz/ns/central-region/hl7v2-message
• http://ibm.com/fhir/cdm/StructureDefinition/process-timestamp
• http://ibm.com/fhir/cdm/StructureDefinition/source-event-trigger
• http://ibm.com/fhir/cdm/StructureDefinition/source-record-type
• http://ibm.com/fhir/cdm/StructureDefinition/source-record-id
• http://ibm.com/fhir/cdm/StructureDefinition/source-data-model-version
• http://ibm.com/fhir/cdm/StructureDefinition/process-client-id
• https://standards.digital.health.nz/ns/central-region/l4h-template-version
• https://standards.digital.health.nz/ns/central-region/alert

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of AllergyIntolerance.onset[x]