NZ Shared Digital Health Record API
1.0.0 - release

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.0.0 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

## Resource Profile: SDHRAllergyIntolerance

Official URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/SDHRAllergyIntolerance | Version: 1.0.0
Active as of 2025-11-18 | Computable Name: 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
meta | Σ | 1..1 | Meta | Metadata about the resource
source | Σ C | 1..1 | uri | Captures the source of the record - please see description for details Constraints: hpi-location-url-format
profile | Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to
tag | Σ | 0..* | Coding | Tag the resource with a code to indicate usability components of the resource Binding: ValueSet for SDHR Resource Tags (preferred)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:ClientLastUpdated |  | 0..1 | dateTime | Client Last Updated URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/hnz-sdhr-client-last-updated-extension
identifier | Σ | 1..* | Identifier | A local identifier MUST be added to this section. If used, system MUST be specified.
use | ?!Σ | 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 .
system | Σ | 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
value | Σ | 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
clinicalStatus | ?!Σ C | 0..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
verificationStatus | ?!Σ 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.
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)
patient | Σ | 1..1 | Reference(Patient) | Who the sensitivity is for
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
type | Σ | 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
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
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
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
AllergyIntolerance.meta.​tag | Base | preferred | ValueSet for SDHR Resource Tags | 📦1.0.0 | 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.0.0 | 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
meta |  | 1..1 | Meta | Metadata about the resource
source | C | 1..1 | uri | Captures the source of the record - please see description for details Constraints: hpi-location-url-format
profile |  | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to
tag |  | 0..* | Coding | Tag the resource with a code to indicate usability components of the resource Binding: ValueSet for SDHR Resource Tags (preferred)
implicitRules |  | 0..0 |  | A set of rules under which this content was created
language |  | 0..0 |  | Language of the resource content
contained |  | 0..0 |  | Contained, inline Resources
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:ClientLastUpdated |  | 0..1 | dateTime | Client Last Updated URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/hnz-sdhr-client-last-updated-extension
modifierExtension |  | 0..0 |  | Extension
identifier |  | 1..* | Identifier | A local identifier MUST be added to this section. If used, system MUST be specified.
use |  | 0..1 | code | The local identifier use SHOULD be set to secondary, where the SDHR resource id is considered the primary 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
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
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)
coding |  |  |  |
userSelected |  | 0..1 | boolean | Indicates that the value has been selected by a system user
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
type |  | 1..1 | uri | Type the reference refers to (e.g. "Patient") Required Pattern: Patient
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
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
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.0.0 | This IG
AllergyIntolerance.code | Base | preferred | ValueSet for AllergyIntolerance Code | 📦1.0.0 | This IG
AllergyIntolerance.reaction.​manifestation | Base | preferred | ValueSet for AllergyIntolerance Manifestation | 📦1.0.0 | 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
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 1..1 | Meta | Metadata about the resource
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
versionId | Σ | 0..1 | id | Version specific identifier
lastUpdated | Σ | 0..1 | instant | When the resource version last changed
source | Σ C | 1..1 | uri | Captures the source of the record - please see description for details Constraints: hpi-location-url-format
profile | Σ | 1..1 | 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 | Tag the resource with a code to indicate usability components of the resource Binding: ValueSet for SDHR Resource Tags (preferred)
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
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:ClientLastUpdated |  | 0..1 | dateTime | Client Last Updated URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/hnz-sdhr-client-last-updated-extension
identifier | Σ | 1..* | Identifier | A local identifier MUST be added to this section. If used, system MUST be specified.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 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 .
type | Σ | 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.
system | Σ | 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
value | Σ | 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
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
clinicalStatus | ?!Σ C | 0..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
verificationStatus | ?!Σ 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.
type | Σ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
category | Σ | 0..* | code | food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.
criticality | Σ | 0..1 | code | low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.
code | Σ | 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)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | Σ | 0..* | Coding | Code defined by a terminology system
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
system | Σ | 0..1 | uri | Identity of the terminology system
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ | 0..1 | code | Symbol in syntax defined by the system
display | Σ | 0..1 | string | Representation defined by the system
userSelected | Σ | 0..1 | boolean | Indicates that the value has been selected by a system user
text | Σ | 0..1 | string | Plain text representation of the concept
patient | Σ | 1..1 | Reference(Patient) | Who the sensitivity is for
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
reference | Σ 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
type | Σ | 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 | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
display | Σ | 0..1 | string | Text alternative for the resource
encounter |  | 0..1 | Reference(Encounter) | Encounter when the allergy or intolerance was asserted
onset[x] |  | 0..1 |  | When allergy or intolerance was identified
onsetDateTime |  |  | dateTime |
onsetAge |  |  | Age |
onsetPeriod |  |  | Period |
onsetRange |  |  | Range |
onsetString |  |  | string |
recordedDate |  | 0..1 | dateTime | Date first version of the resource instance was recorded
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
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
lastOccurrence |  | 0..1 | dateTime | Date(/time) of last known occurrence of a reaction
note |  | 0..* | Annotation | Additional text not captured in other fields
reaction |  | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
substance |  | 0..1 | CodeableConcept | Specific substance or pharmaceutical product considered to be responsible for event Binding: SubstanceCode (example): Codes defining the type of the substance (including pharmaceutical products).
manifestation |  | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: ValueSet for AllergyIntolerance Manifestation (preferred)
description |  | 0..1 | string | Description of the event as a whole
onset |  | 0..1 | dateTime | Date(/time) when manifestations showed
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.
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.
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.0.0 | 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.0.0 | 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.0.0 | 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: 8 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
meta | Σ | 1..1 | Meta | Metadata about the resource
source | Σ C | 1..1 | uri | Captures the source of the record - please see description for details Constraints: hpi-location-url-format
profile | Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to
tag | Σ | 0..* | Coding | Tag the resource with a code to indicate usability components of the resource Binding: ValueSet for SDHR Resource Tags (preferred)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:ClientLastUpdated |  | 0..1 | dateTime | Client Last Updated URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/hnz-sdhr-client-last-updated-extension
identifier | Σ | 1..* | Identifier | A local identifier MUST be added to this section. If used, system MUST be specified.
use | ?!Σ | 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 .
system | Σ | 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
value | Σ | 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
clinicalStatus | ?!Σ C | 0..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
verificationStatus | ?!Σ 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.
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)
patient | Σ | 1..1 | Reference(Patient) | Who the sensitivity is for
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
type | Σ | 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
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
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
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
AllergyIntolerance.meta.​tag | Base | preferred | ValueSet for SDHR Resource Tags | 📦1.0.0 | 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.0.0 | 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
meta |  | 1..1 | Meta | Metadata about the resource
source | C | 1..1 | uri | Captures the source of the record - please see description for details Constraints: hpi-location-url-format
profile |  | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to
tag |  | 0..* | Coding | Tag the resource with a code to indicate usability components of the resource Binding: ValueSet for SDHR Resource Tags (preferred)
implicitRules |  | 0..0 |  | A set of rules under which this content was created
language |  | 0..0 |  | Language of the resource content
contained |  | 0..0 |  | Contained, inline Resources
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:ClientLastUpdated |  | 0..1 | dateTime | Client Last Updated URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/hnz-sdhr-client-last-updated-extension
modifierExtension |  | 0..0 |  | Extension
identifier |  | 1..* | Identifier | A local identifier MUST be added to this section. If used, system MUST be specified.
use |  | 0..1 | code | The local identifier use SHOULD be set to secondary, where the SDHR resource id is considered the primary 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
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
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)
coding |  |  |  |
userSelected |  | 0..1 | boolean | Indicates that the value has been selected by a system user
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
type |  | 1..1 | uri | Type the reference refers to (e.g. "Patient") Required Pattern: Patient
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
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
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.0.0 | This IG
AllergyIntolerance.code | Base | preferred | ValueSet for AllergyIntolerance Code | 📦1.0.0 | This IG
AllergyIntolerance.reaction.​manifestation | Base | preferred | ValueSet for AllergyIntolerance Manifestation | 📦1.0.0 | 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
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 1..1 | Meta | Metadata about the resource
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
versionId | Σ | 0..1 | id | Version specific identifier
lastUpdated | Σ | 0..1 | instant | When the resource version last changed
source | Σ C | 1..1 | uri | Captures the source of the record - please see description for details Constraints: hpi-location-url-format
profile | Σ | 1..1 | 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 | Tag the resource with a code to indicate usability components of the resource Binding: ValueSet for SDHR Resource Tags (preferred)
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
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:ClientLastUpdated |  | 0..1 | dateTime | Client Last Updated URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/hnz-sdhr-client-last-updated-extension
identifier | Σ | 1..* | Identifier | A local identifier MUST be added to this section. If used, system MUST be specified.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 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 .
type | Σ | 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.
system | Σ | 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
value | Σ | 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
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
clinicalStatus | ?!Σ C | 0..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
verificationStatus | ?!Σ 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.
type | Σ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
category | Σ | 0..* | code | food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.
criticality | Σ | 0..1 | code | low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.
code | Σ | 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)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | Σ | 0..* | Coding | Code defined by a terminology system
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
system | Σ | 0..1 | uri | Identity of the terminology system
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ | 0..1 | code | Symbol in syntax defined by the system
display | Σ | 0..1 | string | Representation defined by the system
userSelected | Σ | 0..1 | boolean | Indicates that the value has been selected by a system user
text | Σ | 0..1 | string | Plain text representation of the concept
patient | Σ | 1..1 | Reference(Patient) | Who the sensitivity is for
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
reference | Σ 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
type | Σ | 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 | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
display | Σ | 0..1 | string | Text alternative for the resource
encounter |  | 0..1 | Reference(Encounter) | Encounter when the allergy or intolerance was asserted
onset[x] |  | 0..1 |  | When allergy or intolerance was identified
onsetDateTime |  |  | dateTime |
onsetAge |  |  | Age |
onsetPeriod |  |  | Period |
onsetRange |  |  | Range |
onsetString |  |  | string |
recordedDate |  | 0..1 | dateTime | Date first version of the resource instance was recorded
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
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
lastOccurrence |  | 0..1 | dateTime | Date(/time) of last known occurrence of a reaction
note |  | 0..* | Annotation | Additional text not captured in other fields
reaction |  | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
substance |  | 0..1 | CodeableConcept | Specific substance or pharmaceutical product considered to be responsible for event Binding: SubstanceCode (example): Codes defining the type of the substance (including pharmaceutical products).
manifestation |  | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: ValueSet for AllergyIntolerance Manifestation (preferred)
description |  | 0..1 | string | Description of the event as a whole
onset |  | 0..1 | dateTime | Date(/time) when manifestations showed
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.
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.
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.0.0 | 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.0.0 | 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.0.0 | 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: 8 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