NZ Shared Digital Health Record API, published by Health New Zealand. This guide is not an authorized publication; it is the continuous build for version 1.1.6 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/tewhatuora/fhir-sdhr/ and changes regularly. See the Directory of published versions

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

Resource Profile: SDHRAllergyIntolerance

AllergyIntolerance FHIR resource for Shared Digital Health Record

Usages:

• Examples for this Profile: AllergyIntolerance/AllergyIntoleranceExample and AllergyIntolerance/AllergyIntoleranceExample2
• CapabilityStatements using this Profile: NZ Shared Digital Health Record API

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
AllergyIntolerance	C	0..*	AllergyIntolerance	Allergy or Intolerance (generally: Risk of adverse reaction to a substance) Constraints: ait-1, ait-2, code-or-note-required
AllergyIntolerance.meta	Σ This element is included in summaries.	1..1	Meta	Metadata about the resource
AllergyIntolerance.meta.source	Σ This element is included in summaries. C	1..1	uri	Captures the source of the record - please see description for details Constraints: hpi-location-url-format
AllergyIntolerance.meta.profile	Σ This element is included in summaries.	1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to
AllergyIntolerance.meta.tag	Σ This element is included in summaries.	0..*	Coding	Tag the resource with a code to indicate usability components of the resource Binding: ValueSet for SDHR Resource Tags (preferred)
AllergyIntolerance.Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AllergyIntolerance.Slices for extension.extension:ClientLastUpdated		1..1	dateTime	Client Last Updated URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/hnz-sdhr-client-last-updated-extension
AllergyIntolerance.identifier	Σ This element is included in summaries.	1..*	Identifier	A local identifier MUST be added to this section. If used, system MUST be specified.
AllergyIntolerance.identifier.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	The local identifier use SHOULD be set to secondary, where the SDHR resource id is considered the primary identifier. Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
AllergyIntolerance.identifier.system	Σ This element is included in summaries.	1..1	uri	System for the local identifier. This MUST be consistent per PMS/Health Application Example General: http://www.acme.com/identifiers/patient Example Local Identifier System: https://fhir.example.co.nz
AllergyIntolerance.identifier.value	Σ This element is included in summaries.	1..1	string	The actual local identifier value, e.g. ec2d6cad-1e19-46ee-accf-dc460a680710 Example General: 123456 Example Local Identifier Value: ec2d6cad-1e19-46ee-accf-dc460a680710
AllergyIntolerance.clinicalStatus	?! This element is a modifier element. Σ This element is included in summaries. C	0..1	CodeableConcept	active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
AllergyIntolerance.verificationStatus	?! This element is a modifier element. Σ This element is included in summaries. C	0..1	CodeableConcept	unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
AllergyIntolerance.code	Σ This element is included in summaries.	0..1	CodeableConcept	Preferred - a SNOMED CT code or a NZMT code. When the intolerance is referring to a medication please use the NZMT codeset. When referring to another supstance, food etc. please use SNOMED. Binding: ValueSet for AllergyIntolerance Code (preferred)
AllergyIntolerance.patient	Σ This element is included in summaries.	1..1	Reference(Patient)	Who the sensitivity is for
AllergyIntolerance.patient.reference	Σ This element is included in summaries. C	1..1	string	Must be an absolute URL reference to the patient on the NHI system. See constraints for details. Constraints: nhi-url-format
AllergyIntolerance.patient.type	Σ This element is included in summaries.	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 (extensions allowed)
AllergyIntolerance.recorder		0..1	Reference(Practitioner | PractitionerRole | Patient | RelatedPerson)	Preferred - an HPI Practitioner URL with format https://api.hip.digital.health.nz/fhir/hpi/v1/Practitioner/11AAAA
AllergyIntolerance.asserter	Σ This element is included in summaries.	0..1	Reference(Patient | RelatedPerson | Practitioner | PractitionerRole)	Preferred - an HPI Practitioner URL with format https://api.hip.digital.health.nz/fhir/hpi/v1/Practitioner/11AAAA
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
AllergyIntolerance.meta.​tag	Base	preferred	ValueSet for SDHR Resource Tags	📦1.1.6	This IG
AllergyIntolerance.identifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
AllergyIntolerance.clinicalStatus	Base	required	AllergyIntolerance Clinical Status Codes	📍4.0.1	FHIR Std.
AllergyIntolerance.verificationStatus	Base	required	AllergyIntolerance Verification Status Codes	📍4.0.1	FHIR Std.
AllergyIntolerance.code	Base	preferred	ValueSet for AllergyIntolerance Code	📦1.1.6	This IG
AllergyIntolerance.patient.​type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
ait-1	error	AllergyIntolerance	AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error.	verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists()
ait-2	error	AllergyIntolerance	AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error	verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty()
code-or-note-required	error	AllergyIntolerance	The AllergyIntolerance resource must have at least one of 'code' or 'note'.	(code.exists() or note.exists())
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()
hpi-location-url-format	error	AllergyIntolerance.meta.source	Reference must be an HPI Location URL with format https://api.hip.digital.health.nz/fhir/hpi/v1/Location/FZZ111-A	matches('^https://api.hip.digital.health.nz/fhir/hpi/v1/Location/F[A-Za-z0-9]{2}[0-9]{3}-[A-Za-z0-9]$')
nhi-url-format	error	AllergyIntolerance.patient.reference	Reference must be an NHI Patient URL with format https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZZZ1111 or ZZZ11AA	matches('^https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/[A-Z]{3}([0-9]{4}|[0-9]{2}[A-Z]{2})$')

This structure is derived from AllergyIntolerance

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
AllergyIntolerance	C	0..*	AllergyIntolerance	Allergy or Intolerance (generally: Risk of adverse reaction to a substance) Constraints: code-or-note-required
AllergyIntolerance.meta		1..1	Meta	Metadata about the resource
AllergyIntolerance.meta.source	C	1..1	uri	Captures the source of the record - please see description for details Constraints: hpi-location-url-format
AllergyIntolerance.meta.profile		1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to
AllergyIntolerance.meta.tag		0..*	Coding	Tag the resource with a code to indicate usability components of the resource Binding: ValueSet for SDHR Resource Tags (preferred)
AllergyIntolerance.implicitRules		0..0		A set of rules under which this content was created
AllergyIntolerance.language		0..0		Language of the resource content
AllergyIntolerance.contained		0..0		Contained, inline Resources
AllergyIntolerance.Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AllergyIntolerance.Slices for extension.extension:ClientLastUpdated		1..1	dateTime	Client Last Updated URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/hnz-sdhr-client-last-updated-extension
AllergyIntolerance.modifierExtension		0..0		Extension
AllergyIntolerance.identifier		1..*	Identifier	A local identifier MUST be added to this section. If used, system MUST be specified.
AllergyIntolerance.identifier.use		0..1	code	The local identifier use SHOULD be set to secondary, where the SDHR resource id is considered the primary identifier.
AllergyIntolerance.identifier.system		1..1	uri	System for the local identifier. This MUST be consistent per PMS/Health Application Example Local Identifier System: https://fhir.example.co.nz
AllergyIntolerance.identifier.value		1..1	string	The actual local identifier value, e.g. ec2d6cad-1e19-46ee-accf-dc460a680710 Example Local Identifier Value: ec2d6cad-1e19-46ee-accf-dc460a680710
AllergyIntolerance.code		0..1	CodeableConcept	Preferred - a SNOMED CT code or a NZMT code. When the intolerance is referring to a medication please use the NZMT codeset. When referring to another supstance, food etc. please use SNOMED. Binding: ValueSet for AllergyIntolerance Code (preferred)
AllergyIntolerance.code.coding
AllergyIntolerance.code.coding.userSelected		0..1	boolean	Indicates that the value has been selected by a system user
AllergyIntolerance.patient		1..1	Reference(Patient)	Who the sensitivity is for
AllergyIntolerance.patient.reference	C	1..1	string	Must be an absolute URL reference to the patient on the NHI system. See constraints for details. Constraints: nhi-url-format
AllergyIntolerance.patient.type		1..1	uri	Type the reference refers to (e.g. "Patient") Required Pattern: Patient (extensions allowed)
AllergyIntolerance.recorder		0..1	Reference(Practitioner | PractitionerRole | Patient | RelatedPerson)	Preferred - an HPI Practitioner URL with format https://api.hip.digital.health.nz/fhir/hpi/v1/Practitioner/11AAAA
AllergyIntolerance.asserter		0..1	Reference(Patient | RelatedPerson | Practitioner | PractitionerRole)	Preferred - an HPI Practitioner URL with format https://api.hip.digital.health.nz/fhir/hpi/v1/Practitioner/11AAAA
AllergyIntolerance.reaction
AllergyIntolerance.reaction.manifestation		1..*	CodeableConcept	Clinical symptoms/signs associated with the Event Binding: ValueSet for AllergyIntolerance Manifestation (preferred)
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
AllergyIntolerance.meta.​tag	Base	preferred	ValueSet for SDHR Resource Tags	📦1.1.6	This IG
AllergyIntolerance.code	Base	preferred	ValueSet for AllergyIntolerance Code	📦1.1.6	This IG
AllergyIntolerance.reaction.​manifestation	Base	preferred	ValueSet for AllergyIntolerance Manifestation	📦1.1.6	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
code-or-note-required	error	AllergyIntolerance	The AllergyIntolerance resource must have at least one of 'code' or 'note'.	(code.exists() or note.exists())
hpi-location-url-format	error	AllergyIntolerance.meta.source	Reference must be an HPI Location URL with format https://api.hip.digital.health.nz/fhir/hpi/v1/Location/FZZ111-A	matches('^https://api.hip.digital.health.nz/fhir/hpi/v1/Location/F[A-Za-z0-9]{2}[0-9]{3}-[A-Za-z0-9]$')
nhi-url-format	error	AllergyIntolerance.patient.reference	Reference must be an NHI Patient URL with format https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZZZ1111 or ZZZ11AA	matches('^https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/[A-Z]{3}([0-9]{4}|[0-9]{2}[A-Z]{2})$')

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
AllergyIntolerance	C	0..*	AllergyIntolerance	Allergy or Intolerance (generally: Risk of adverse reaction to a substance) Constraints: ait-1, ait-2, code-or-note-required
AllergyIntolerance.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
AllergyIntolerance.meta	Σ This element is included in summaries.	1..1	Meta	Metadata about the resource
AllergyIntolerance.meta.id		0..1	string	Unique id for inter-element referencing
AllergyIntolerance.meta.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
AllergyIntolerance.meta.versionId	Σ This element is included in summaries.	0..1	id	Version specific identifier
AllergyIntolerance.meta.lastUpdated	Σ This element is included in summaries.	0..1	instant	When the resource version last changed
AllergyIntolerance.meta.source	Σ This element is included in summaries. C	1..1	uri	Captures the source of the record - please see description for details Constraints: hpi-location-url-format
AllergyIntolerance.meta.profile	Σ This element is included in summaries.	1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to
AllergyIntolerance.meta.security	Σ This element is included in summaries.	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
AllergyIntolerance.meta.tag	Σ This element is included in summaries.	0..*	Coding	Tag the resource with a code to indicate usability components of the resource Binding: ValueSet for SDHR Resource Tags (preferred)
AllergyIntolerance.text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
AllergyIntolerance.Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AllergyIntolerance.Slices for extension.extension:ClientLastUpdated		1..1	dateTime	Client Last Updated URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/hnz-sdhr-client-last-updated-extension
AllergyIntolerance.identifier	Σ This element is included in summaries.	1..*	Identifier	A local identifier MUST be added to this section. If used, system MUST be specified.
AllergyIntolerance.identifier.id		0..1	string	Unique id for inter-element referencing
AllergyIntolerance.identifier.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
AllergyIntolerance.identifier.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	The local identifier use SHOULD be set to secondary, where the SDHR resource id is considered the primary identifier. Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
AllergyIntolerance.identifier.type	Σ This element is included in summaries.	0..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.
AllergyIntolerance.identifier.system	Σ This element is included in summaries.	1..1	uri	System for the local identifier. This MUST be consistent per PMS/Health Application Example General: http://www.acme.com/identifiers/patient Example Local Identifier System: https://fhir.example.co.nz
AllergyIntolerance.identifier.value	Σ This element is included in summaries.	1..1	string	The actual local identifier value, e.g. ec2d6cad-1e19-46ee-accf-dc460a680710 Example General: 123456 Example Local Identifier Value: ec2d6cad-1e19-46ee-accf-dc460a680710
AllergyIntolerance.identifier.period	Σ This element is included in summaries.	0..1	Period	Time period when id is/was valid for use
AllergyIntolerance.identifier.assigner	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that issued id (may be just text)
AllergyIntolerance.clinicalStatus	?! This element is a modifier element. Σ This element is included in summaries. C	0..1	CodeableConcept	active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
AllergyIntolerance.verificationStatus	?! This element is a modifier element. Σ This element is included in summaries. C	0..1	CodeableConcept	unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
AllergyIntolerance.type	Σ This element is included in summaries.	0..1	code	allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
AllergyIntolerance.category	Σ This element is included in summaries.	0..*	code	food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.
AllergyIntolerance.criticality	Σ This element is included in summaries.	0..1	code	low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.
AllergyIntolerance.code	Σ This element is included in summaries.	0..1	CodeableConcept	Preferred - a SNOMED CT code or a NZMT code. When the intolerance is referring to a medication please use the NZMT codeset. When referring to another supstance, food etc. please use SNOMED. Binding: ValueSet for AllergyIntolerance Code (preferred)
AllergyIntolerance.code.id		0..1	string	Unique id for inter-element referencing
AllergyIntolerance.code.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
AllergyIntolerance.code.coding	Σ This element is included in summaries.	0..*	Coding	Code defined by a terminology system
AllergyIntolerance.code.coding.id		0..1	string	Unique id for inter-element referencing
AllergyIntolerance.code.coding.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
AllergyIntolerance.code.coding.system	Σ This element is included in summaries.	0..1	uri	Identity of the terminology system
AllergyIntolerance.code.coding.version	Σ This element is included in summaries.	0..1	string	Version of the system - if relevant
AllergyIntolerance.code.coding.code	Σ This element is included in summaries.	0..1	code	Symbol in syntax defined by the system
AllergyIntolerance.code.coding.display	Σ This element is included in summaries.	0..1	string	Representation defined by the system
AllergyIntolerance.code.coding.userSelected	Σ This element is included in summaries.	0..1	boolean	Indicates that the value has been selected by a system user
AllergyIntolerance.code.text	Σ This element is included in summaries.	0..1	string	Plain text representation of the concept
AllergyIntolerance.patient	Σ This element is included in summaries.	1..1	Reference(Patient)	Who the sensitivity is for
AllergyIntolerance.patient.id		0..1	string	Unique id for inter-element referencing
AllergyIntolerance.patient.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
AllergyIntolerance.patient.reference	Σ This element is included in summaries. C	1..1	string	Must be an absolute URL reference to the patient on the NHI system. See constraints for details. Constraints: nhi-url-format
AllergyIntolerance.patient.type	Σ This element is included in summaries.	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 (extensions allowed)
AllergyIntolerance.patient.identifier	Σ This element is included in summaries.	0..1	Identifier	Logical reference, when literal reference is not known
AllergyIntolerance.patient.display	Σ This element is included in summaries.	0..1	string	Text alternative for the resource
AllergyIntolerance.encounter		0..1	Reference(Encounter)	Encounter when the allergy or intolerance was asserted
AllergyIntolerance.onset[x]		0..1		When allergy or intolerance was identified
AllergyIntolerance.onset[x].onsetDateTime			dateTime
AllergyIntolerance.onset[x].onsetAge			Age
AllergyIntolerance.onset[x].onsetPeriod			Period
AllergyIntolerance.onset[x].onsetRange			Range
AllergyIntolerance.onset[x].onsetString			string
AllergyIntolerance.recordedDate		0..1	dateTime	Date first version of the resource instance was recorded
AllergyIntolerance.recorder		0..1	Reference(Practitioner | PractitionerRole | Patient | RelatedPerson)	Preferred - an HPI Practitioner URL with format https://api.hip.digital.health.nz/fhir/hpi/v1/Practitioner/11AAAA
AllergyIntolerance.asserter	Σ This element is included in summaries.	0..1	Reference(Patient | RelatedPerson | Practitioner | PractitionerRole)	Preferred - an HPI Practitioner URL with format https://api.hip.digital.health.nz/fhir/hpi/v1/Practitioner/11AAAA
AllergyIntolerance.lastOccurrence		0..1	dateTime	Date(/time) of last known occurrence of a reaction
AllergyIntolerance.note		0..*	Annotation	Additional text not captured in other fields
AllergyIntolerance.reaction		0..*	BackboneElement	Adverse Reaction Events linked to exposure to substance
AllergyIntolerance.reaction.id		0..1	string	Unique id for inter-element referencing
AllergyIntolerance.reaction.extension		0..*	Extension	Additional content defined by implementations
AllergyIntolerance.reaction.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
AllergyIntolerance.reaction.substance		0..1	CodeableConcept	Specific substance or pharmaceutical product considered to be responsible for event Binding: SubstanceCode (example): Codes defining the type of the substance (including pharmaceutical products).
AllergyIntolerance.reaction.manifestation		1..*	CodeableConcept	Clinical symptoms/signs associated with the Event Binding: ValueSet for AllergyIntolerance Manifestation (preferred)
AllergyIntolerance.reaction.description		0..1	string	Description of the event as a whole
AllergyIntolerance.reaction.onset		0..1	dateTime	Date(/time) when manifestations showed
AllergyIntolerance.reaction.severity		0..1	code	mild | moderate | severe (of event as a whole) Binding: AllergyIntoleranceSeverity (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations.
AllergyIntolerance.reaction.exposureRoute		0..1	CodeableConcept	How the subject was exposed to the substance Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.
AllergyIntolerance.reaction.note		0..*	Annotation	Text about event not captured in other fields
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
AllergyIntolerance.meta.​security	Base	extensible	SecurityLabels	📍4.0.1	FHIR Std.
AllergyIntolerance.meta.​tag	Base	preferred	ValueSet for SDHR Resource Tags	📦1.1.6	This IG
AllergyIntolerance.identifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
AllergyIntolerance.identifier.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
AllergyIntolerance.clinicalStatus	Base	required	AllergyIntolerance Clinical Status Codes	📍4.0.1	FHIR Std.
AllergyIntolerance.verificationStatus	Base	required	AllergyIntolerance Verification Status Codes	📍4.0.1	FHIR Std.
AllergyIntolerance.type	Base	required	AllergyIntoleranceType	📍4.0.1	FHIR Std.
AllergyIntolerance.category	Base	required	AllergyIntoleranceCategory	📍4.0.1	FHIR Std.
AllergyIntolerance.criticality	Base	required	AllergyIntoleranceCriticality	📍4.0.1	FHIR Std.
AllergyIntolerance.code	Base	preferred	ValueSet for AllergyIntolerance Code	📦1.1.6	This IG
AllergyIntolerance.patient.​type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
AllergyIntolerance.reaction.​substance	Base	example	Substance Code	📍4.0.1	FHIR Std.
AllergyIntolerance.reaction.​manifestation	Base	preferred	ValueSet for AllergyIntolerance Manifestation	📦1.1.6	This IG
AllergyIntolerance.reaction.​severity	Base	required	AllergyIntoleranceSeverity	📍4.0.1	FHIR Std.
AllergyIntolerance.reaction.​exposureRoute	Base	example	SNOMED CT Route Codes	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
ait-1	error	AllergyIntolerance	AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error.	verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists()
ait-2	error	AllergyIntolerance	AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error	verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty()
code-or-note-required	error	AllergyIntolerance	The AllergyIntolerance resource must have at least one of 'code' or 'note'.	(code.exists() or note.exists())
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()
hpi-location-url-format	error	AllergyIntolerance.meta.source	Reference must be an HPI Location URL with format https://api.hip.digital.health.nz/fhir/hpi/v1/Location/FZZ111-A	matches('^https://api.hip.digital.health.nz/fhir/hpi/v1/Location/F[A-Za-z0-9]{2}[0-9]{3}-[A-Za-z0-9]$')
nhi-url-format	error	AllergyIntolerance.patient.reference	Reference must be an NHI Patient URL with format https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZZZ1111 or ZZZ11AA	matches('^https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/[A-Z]{3}([0-9]{4}|[0-9]{2}[A-Z]{2})$')

This structure is derived from AllergyIntolerance

Summary

Mandatory: 10 elements
Prohibited: 4 elements

Extensions

This structure refers to these extensions:

• https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/hnz-sdhr-client-last-updated-extension

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
AllergyIntolerance	C	0..*	AllergyIntolerance	Allergy or Intolerance (generally: Risk of adverse reaction to a substance) Constraints: ait-1, ait-2, code-or-note-required
AllergyIntolerance.meta	Σ This element is included in summaries.	1..1	Meta	Metadata about the resource
AllergyIntolerance.meta.source	Σ This element is included in summaries. C	1..1	uri	Captures the source of the record - please see description for details Constraints: hpi-location-url-format
AllergyIntolerance.meta.profile	Σ This element is included in summaries.	1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to
AllergyIntolerance.meta.tag	Σ This element is included in summaries.	0..*	Coding	Tag the resource with a code to indicate usability components of the resource Binding: ValueSet for SDHR Resource Tags (preferred)
AllergyIntolerance.Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AllergyIntolerance.Slices for extension.extension:ClientLastUpdated		1..1	dateTime	Client Last Updated URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/hnz-sdhr-client-last-updated-extension
AllergyIntolerance.identifier	Σ This element is included in summaries.	1..*	Identifier	A local identifier MUST be added to this section. If used, system MUST be specified.
AllergyIntolerance.identifier.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	The local identifier use SHOULD be set to secondary, where the SDHR resource id is considered the primary identifier. Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
AllergyIntolerance.identifier.system	Σ This element is included in summaries.	1..1	uri	System for the local identifier. This MUST be consistent per PMS/Health Application Example General: http://www.acme.com/identifiers/patient Example Local Identifier System: https://fhir.example.co.nz
AllergyIntolerance.identifier.value	Σ This element is included in summaries.	1..1	string	The actual local identifier value, e.g. ec2d6cad-1e19-46ee-accf-dc460a680710 Example General: 123456 Example Local Identifier Value: ec2d6cad-1e19-46ee-accf-dc460a680710
AllergyIntolerance.clinicalStatus	?! This element is a modifier element. Σ This element is included in summaries. C	0..1	CodeableConcept	active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
AllergyIntolerance.verificationStatus	?! This element is a modifier element. Σ This element is included in summaries. C	0..1	CodeableConcept	unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
AllergyIntolerance.code	Σ This element is included in summaries.	0..1	CodeableConcept	Preferred - a SNOMED CT code or a NZMT code. When the intolerance is referring to a medication please use the NZMT codeset. When referring to another supstance, food etc. please use SNOMED. Binding: ValueSet for AllergyIntolerance Code (preferred)
AllergyIntolerance.patient	Σ This element is included in summaries.	1..1	Reference(Patient)	Who the sensitivity is for
AllergyIntolerance.patient.reference	Σ This element is included in summaries. C	1..1	string	Must be an absolute URL reference to the patient on the NHI system. See constraints for details. Constraints: nhi-url-format
AllergyIntolerance.patient.type	Σ This element is included in summaries.	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 (extensions allowed)
AllergyIntolerance.recorder		0..1	Reference(Practitioner | PractitionerRole | Patient | RelatedPerson)	Preferred - an HPI Practitioner URL with format https://api.hip.digital.health.nz/fhir/hpi/v1/Practitioner/11AAAA
AllergyIntolerance.asserter	Σ This element is included in summaries.	0..1	Reference(Patient | RelatedPerson | Practitioner | PractitionerRole)	Preferred - an HPI Practitioner URL with format https://api.hip.digital.health.nz/fhir/hpi/v1/Practitioner/11AAAA
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
AllergyIntolerance.meta.​tag	Base	preferred	ValueSet for SDHR Resource Tags	📦1.1.6	This IG
AllergyIntolerance.identifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
AllergyIntolerance.clinicalStatus	Base	required	AllergyIntolerance Clinical Status Codes	📍4.0.1	FHIR Std.
AllergyIntolerance.verificationStatus	Base	required	AllergyIntolerance Verification Status Codes	📍4.0.1	FHIR Std.
AllergyIntolerance.code	Base	preferred	ValueSet for AllergyIntolerance Code	📦1.1.6	This IG
AllergyIntolerance.patient.​type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
ait-1	error	AllergyIntolerance	AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error.	verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists()
ait-2	error	AllergyIntolerance	AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error	verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty()
code-or-note-required	error	AllergyIntolerance	The AllergyIntolerance resource must have at least one of 'code' or 'note'.	(code.exists() or note.exists())
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()
hpi-location-url-format	error	AllergyIntolerance.meta.source	Reference must be an HPI Location URL with format https://api.hip.digital.health.nz/fhir/hpi/v1/Location/FZZ111-A	matches('^https://api.hip.digital.health.nz/fhir/hpi/v1/Location/F[A-Za-z0-9]{2}[0-9]{3}-[A-Za-z0-9]$')
nhi-url-format	error	AllergyIntolerance.patient.reference	Reference must be an NHI Patient URL with format https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZZZ1111 or ZZZ11AA	matches('^https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/[A-Z]{3}([0-9]{4}|[0-9]{2}[A-Z]{2})$')

Differential View

This structure is derived from AllergyIntolerance

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
AllergyIntolerance	C	0..*	AllergyIntolerance	Allergy or Intolerance (generally: Risk of adverse reaction to a substance) Constraints: code-or-note-required
AllergyIntolerance.meta		1..1	Meta	Metadata about the resource
AllergyIntolerance.meta.source	C	1..1	uri	Captures the source of the record - please see description for details Constraints: hpi-location-url-format
AllergyIntolerance.meta.profile		1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to
AllergyIntolerance.meta.tag		0..*	Coding	Tag the resource with a code to indicate usability components of the resource Binding: ValueSet for SDHR Resource Tags (preferred)
AllergyIntolerance.implicitRules		0..0		A set of rules under which this content was created
AllergyIntolerance.language		0..0		Language of the resource content
AllergyIntolerance.contained		0..0		Contained, inline Resources
AllergyIntolerance.Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AllergyIntolerance.Slices for extension.extension:ClientLastUpdated		1..1	dateTime	Client Last Updated URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/hnz-sdhr-client-last-updated-extension
AllergyIntolerance.modifierExtension		0..0		Extension
AllergyIntolerance.identifier		1..*	Identifier	A local identifier MUST be added to this section. If used, system MUST be specified.
AllergyIntolerance.identifier.use		0..1	code	The local identifier use SHOULD be set to secondary, where the SDHR resource id is considered the primary identifier.
AllergyIntolerance.identifier.system		1..1	uri	System for the local identifier. This MUST be consistent per PMS/Health Application Example Local Identifier System: https://fhir.example.co.nz
AllergyIntolerance.identifier.value		1..1	string	The actual local identifier value, e.g. ec2d6cad-1e19-46ee-accf-dc460a680710 Example Local Identifier Value: ec2d6cad-1e19-46ee-accf-dc460a680710
AllergyIntolerance.code		0..1	CodeableConcept	Preferred - a SNOMED CT code or a NZMT code. When the intolerance is referring to a medication please use the NZMT codeset. When referring to another supstance, food etc. please use SNOMED. Binding: ValueSet for AllergyIntolerance Code (preferred)
AllergyIntolerance.code.coding
AllergyIntolerance.code.coding.userSelected		0..1	boolean	Indicates that the value has been selected by a system user
AllergyIntolerance.patient		1..1	Reference(Patient)	Who the sensitivity is for
AllergyIntolerance.patient.reference	C	1..1	string	Must be an absolute URL reference to the patient on the NHI system. See constraints for details. Constraints: nhi-url-format
AllergyIntolerance.patient.type		1..1	uri	Type the reference refers to (e.g. "Patient") Required Pattern: Patient (extensions allowed)
AllergyIntolerance.recorder		0..1	Reference(Practitioner | PractitionerRole | Patient | RelatedPerson)	Preferred - an HPI Practitioner URL with format https://api.hip.digital.health.nz/fhir/hpi/v1/Practitioner/11AAAA
AllergyIntolerance.asserter		0..1	Reference(Patient | RelatedPerson | Practitioner | PractitionerRole)	Preferred - an HPI Practitioner URL with format https://api.hip.digital.health.nz/fhir/hpi/v1/Practitioner/11AAAA
AllergyIntolerance.reaction
AllergyIntolerance.reaction.manifestation		1..*	CodeableConcept	Clinical symptoms/signs associated with the Event Binding: ValueSet for AllergyIntolerance Manifestation (preferred)
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
AllergyIntolerance.meta.​tag	Base	preferred	ValueSet for SDHR Resource Tags	📦1.1.6	This IG
AllergyIntolerance.code	Base	preferred	ValueSet for AllergyIntolerance Code	📦1.1.6	This IG
AllergyIntolerance.reaction.​manifestation	Base	preferred	ValueSet for AllergyIntolerance Manifestation	📦1.1.6	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
code-or-note-required	error	AllergyIntolerance	The AllergyIntolerance resource must have at least one of 'code' or 'note'.	(code.exists() or note.exists())
hpi-location-url-format	error	AllergyIntolerance.meta.source	Reference must be an HPI Location URL with format https://api.hip.digital.health.nz/fhir/hpi/v1/Location/FZZ111-A	matches('^https://api.hip.digital.health.nz/fhir/hpi/v1/Location/F[A-Za-z0-9]{2}[0-9]{3}-[A-Za-z0-9]$')
nhi-url-format	error	AllergyIntolerance.patient.reference	Reference must be an NHI Patient URL with format https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZZZ1111 or ZZZ11AA	matches('^https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/[A-Z]{3}([0-9]{4}|[0-9]{2}[A-Z]{2})$')

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
AllergyIntolerance	C	0..*	AllergyIntolerance	Allergy or Intolerance (generally: Risk of adverse reaction to a substance) Constraints: ait-1, ait-2, code-or-note-required
AllergyIntolerance.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
AllergyIntolerance.meta	Σ This element is included in summaries.	1..1	Meta	Metadata about the resource
AllergyIntolerance.meta.id		0..1	string	Unique id for inter-element referencing
AllergyIntolerance.meta.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
AllergyIntolerance.meta.versionId	Σ This element is included in summaries.	0..1	id	Version specific identifier
AllergyIntolerance.meta.lastUpdated	Σ This element is included in summaries.	0..1	instant	When the resource version last changed
AllergyIntolerance.meta.source	Σ This element is included in summaries. C	1..1	uri	Captures the source of the record - please see description for details Constraints: hpi-location-url-format
AllergyIntolerance.meta.profile	Σ This element is included in summaries.	1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to
AllergyIntolerance.meta.security	Σ This element is included in summaries.	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
AllergyIntolerance.meta.tag	Σ This element is included in summaries.	0..*	Coding	Tag the resource with a code to indicate usability components of the resource Binding: ValueSet for SDHR Resource Tags (preferred)
AllergyIntolerance.text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
AllergyIntolerance.Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AllergyIntolerance.Slices for extension.extension:ClientLastUpdated		1..1	dateTime	Client Last Updated URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/hnz-sdhr-client-last-updated-extension
AllergyIntolerance.identifier	Σ This element is included in summaries.	1..*	Identifier	A local identifier MUST be added to this section. If used, system MUST be specified.
AllergyIntolerance.identifier.id		0..1	string	Unique id for inter-element referencing
AllergyIntolerance.identifier.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
AllergyIntolerance.identifier.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	The local identifier use SHOULD be set to secondary, where the SDHR resource id is considered the primary identifier. Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
AllergyIntolerance.identifier.type	Σ This element is included in summaries.	0..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.
AllergyIntolerance.identifier.system	Σ This element is included in summaries.	1..1	uri	System for the local identifier. This MUST be consistent per PMS/Health Application Example General: http://www.acme.com/identifiers/patient Example Local Identifier System: https://fhir.example.co.nz
AllergyIntolerance.identifier.value	Σ This element is included in summaries.	1..1	string	The actual local identifier value, e.g. ec2d6cad-1e19-46ee-accf-dc460a680710 Example General: 123456 Example Local Identifier Value: ec2d6cad-1e19-46ee-accf-dc460a680710
AllergyIntolerance.identifier.period	Σ This element is included in summaries.	0..1	Period	Time period when id is/was valid for use
AllergyIntolerance.identifier.assigner	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that issued id (may be just text)
AllergyIntolerance.clinicalStatus	?! This element is a modifier element. Σ This element is included in summaries. C	0..1	CodeableConcept	active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
AllergyIntolerance.verificationStatus	?! This element is a modifier element. Σ This element is included in summaries. C	0..1	CodeableConcept	unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
AllergyIntolerance.type	Σ This element is included in summaries.	0..1	code	allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
AllergyIntolerance.category	Σ This element is included in summaries.	0..*	code	food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.
AllergyIntolerance.criticality	Σ This element is included in summaries.	0..1	code	low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.
AllergyIntolerance.code	Σ This element is included in summaries.	0..1	CodeableConcept	Preferred - a SNOMED CT code or a NZMT code. When the intolerance is referring to a medication please use the NZMT codeset. When referring to another supstance, food etc. please use SNOMED. Binding: ValueSet for AllergyIntolerance Code (preferred)
AllergyIntolerance.code.id		0..1	string	Unique id for inter-element referencing
AllergyIntolerance.code.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
AllergyIntolerance.code.coding	Σ This element is included in summaries.	0..*	Coding	Code defined by a terminology system
AllergyIntolerance.code.coding.id		0..1	string	Unique id for inter-element referencing
AllergyIntolerance.code.coding.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
AllergyIntolerance.code.coding.system	Σ This element is included in summaries.	0..1	uri	Identity of the terminology system
AllergyIntolerance.code.coding.version	Σ This element is included in summaries.	0..1	string	Version of the system - if relevant
AllergyIntolerance.code.coding.code	Σ This element is included in summaries.	0..1	code	Symbol in syntax defined by the system
AllergyIntolerance.code.coding.display	Σ This element is included in summaries.	0..1	string	Representation defined by the system
AllergyIntolerance.code.coding.userSelected	Σ This element is included in summaries.	0..1	boolean	Indicates that the value has been selected by a system user
AllergyIntolerance.code.text	Σ This element is included in summaries.	0..1	string	Plain text representation of the concept
AllergyIntolerance.patient	Σ This element is included in summaries.	1..1	Reference(Patient)	Who the sensitivity is for
AllergyIntolerance.patient.id		0..1	string	Unique id for inter-element referencing
AllergyIntolerance.patient.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
AllergyIntolerance.patient.reference	Σ This element is included in summaries. C	1..1	string	Must be an absolute URL reference to the patient on the NHI system. See constraints for details. Constraints: nhi-url-format
AllergyIntolerance.patient.type	Σ This element is included in summaries.	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 (extensions allowed)
AllergyIntolerance.patient.identifier	Σ This element is included in summaries.	0..1	Identifier	Logical reference, when literal reference is not known
AllergyIntolerance.patient.display	Σ This element is included in summaries.	0..1	string	Text alternative for the resource
AllergyIntolerance.encounter		0..1	Reference(Encounter)	Encounter when the allergy or intolerance was asserted
AllergyIntolerance.onset[x]		0..1		When allergy or intolerance was identified
AllergyIntolerance.onset[x].onsetDateTime			dateTime
AllergyIntolerance.onset[x].onsetAge			Age
AllergyIntolerance.onset[x].onsetPeriod			Period
AllergyIntolerance.onset[x].onsetRange			Range
AllergyIntolerance.onset[x].onsetString			string
AllergyIntolerance.recordedDate		0..1	dateTime	Date first version of the resource instance was recorded
AllergyIntolerance.recorder		0..1	Reference(Practitioner | PractitionerRole | Patient | RelatedPerson)	Preferred - an HPI Practitioner URL with format https://api.hip.digital.health.nz/fhir/hpi/v1/Practitioner/11AAAA
AllergyIntolerance.asserter	Σ This element is included in summaries.	0..1	Reference(Patient | RelatedPerson | Practitioner | PractitionerRole)	Preferred - an HPI Practitioner URL with format https://api.hip.digital.health.nz/fhir/hpi/v1/Practitioner/11AAAA
AllergyIntolerance.lastOccurrence		0..1	dateTime	Date(/time) of last known occurrence of a reaction
AllergyIntolerance.note		0..*	Annotation	Additional text not captured in other fields
AllergyIntolerance.reaction		0..*	BackboneElement	Adverse Reaction Events linked to exposure to substance
AllergyIntolerance.reaction.id		0..1	string	Unique id for inter-element referencing
AllergyIntolerance.reaction.extension		0..*	Extension	Additional content defined by implementations
AllergyIntolerance.reaction.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
AllergyIntolerance.reaction.substance		0..1	CodeableConcept	Specific substance or pharmaceutical product considered to be responsible for event Binding: SubstanceCode (example): Codes defining the type of the substance (including pharmaceutical products).
AllergyIntolerance.reaction.manifestation		1..*	CodeableConcept	Clinical symptoms/signs associated with the Event Binding: ValueSet for AllergyIntolerance Manifestation (preferred)
AllergyIntolerance.reaction.description		0..1	string	Description of the event as a whole
AllergyIntolerance.reaction.onset		0..1	dateTime	Date(/time) when manifestations showed
AllergyIntolerance.reaction.severity		0..1	code	mild | moderate | severe (of event as a whole) Binding: AllergyIntoleranceSeverity (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations.
AllergyIntolerance.reaction.exposureRoute		0..1	CodeableConcept	How the subject was exposed to the substance Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.
AllergyIntolerance.reaction.note		0..*	Annotation	Text about event not captured in other fields
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
AllergyIntolerance.meta.​security	Base	extensible	SecurityLabels	📍4.0.1	FHIR Std.
AllergyIntolerance.meta.​tag	Base	preferred	ValueSet for SDHR Resource Tags	📦1.1.6	This IG
AllergyIntolerance.identifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
AllergyIntolerance.identifier.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
AllergyIntolerance.clinicalStatus	Base	required	AllergyIntolerance Clinical Status Codes	📍4.0.1	FHIR Std.
AllergyIntolerance.verificationStatus	Base	required	AllergyIntolerance Verification Status Codes	📍4.0.1	FHIR Std.
AllergyIntolerance.type	Base	required	AllergyIntoleranceType	📍4.0.1	FHIR Std.
AllergyIntolerance.category	Base	required	AllergyIntoleranceCategory	📍4.0.1	FHIR Std.
AllergyIntolerance.criticality	Base	required	AllergyIntoleranceCriticality	📍4.0.1	FHIR Std.
AllergyIntolerance.code	Base	preferred	ValueSet for AllergyIntolerance Code	📦1.1.6	This IG
AllergyIntolerance.patient.​type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
AllergyIntolerance.reaction.​substance	Base	example	Substance Code	📍4.0.1	FHIR Std.
AllergyIntolerance.reaction.​manifestation	Base	preferred	ValueSet for AllergyIntolerance Manifestation	📦1.1.6	This IG
AllergyIntolerance.reaction.​severity	Base	required	AllergyIntoleranceSeverity	📍4.0.1	FHIR Std.
AllergyIntolerance.reaction.​exposureRoute	Base	example	SNOMED CT Route Codes	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
ait-1	error	AllergyIntolerance	AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error.	verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists()
ait-2	error	AllergyIntolerance	AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error	verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty()
code-or-note-required	error	AllergyIntolerance	The AllergyIntolerance resource must have at least one of 'code' or 'note'.	(code.exists() or note.exists())
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()
hpi-location-url-format	error	AllergyIntolerance.meta.source	Reference must be an HPI Location URL with format https://api.hip.digital.health.nz/fhir/hpi/v1/Location/FZZ111-A	matches('^https://api.hip.digital.health.nz/fhir/hpi/v1/Location/F[A-Za-z0-9]{2}[0-9]{3}-[A-Za-z0-9]$')
nhi-url-format	error	AllergyIntolerance.patient.reference	Reference must be an NHI Patient URL with format https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZZZ1111 or ZZZ11AA	matches('^https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/[A-Z]{3}([0-9]{4}|[0-9]{2}[A-Z]{2})$')

This structure is derived from AllergyIntolerance

Summary

Mandatory: 10 elements
Prohibited: 4 elements

Extensions

This structure refers to these extensions:

• https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/hnz-sdhr-client-last-updated-extension

Other representations of profile: CSV, Excel, Schematron