NZ Shared Digital Health Record API
0.5.0 - ballot
NZ Shared Digital Health Record API - Local Development build (v0.5.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Official URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/SDHRAllergyIntolerance | Version: 0.5.0 | |||
Draft as of 2025-06-10 | Computable Name: SDHRAllergyIntolerance |
AllergyIntolerance FHIR resource for Shared Digital Health Record
Usages:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() Bindings Constraints Obligations ![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) Constraints: ait-1, ait-2 |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..1 | dateTime | Client Last Updated URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/hnz-sdhr-client-last-updated-extension | |
![]() ![]() ![]() |
Σ | 1..* | Identifier | A local identifier MAY be added to this section. If used, system MUST be specified. |
![]() ![]() ![]() ![]() |
?!Σ | 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 . |
![]() ![]() ![]() ![]() |
Σ | 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 |
![]() ![]() ![]() ![]() |
Σ | 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 |
![]() ![]() ![]() |
?!ΣC | 0..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. |
![]() ![]() ![]() |
?!Σ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. |
![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes (preferred) |
![]() ![]() ![]() |
Σ | 1..1 | Reference(Patient) | Who the sensitivity is for |
![]() ![]() ![]() ![]() |
Σ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 |
![]() ![]() ![]() ![]() |
Σ | 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 |
![]() |
Path | Conformance | ValueSet / Code | URI |
AllergyIntolerance.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard | |
AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1 From the FHIR Standard | |
AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1 From the FHIR Standard | |
AllergyIntolerance.code | preferred | AllergyIntoleranceSubstance/Product,ConditionAndNegationCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-code From the FHIR Standard | |
AllergyIntolerance.patient.type | extensible | Pattern Value: Patienthttp://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
ait-1 | error | AllergyIntolerance | AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists() | |
ait-2 | error | AllergyIntolerance | AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty() | |
dom-2 | error | AllergyIntolerance | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | AllergyIntolerance | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | AllergyIntolerance | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | AllergyIntolerance | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | AllergyIntolerance | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
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 ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
1..1 | uri | Captures the source of the record - please see description for details | |
![]() ![]() ![]() ![]() |
1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..1 | dateTime | Client Last Updated URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/hnz-sdhr-client-last-updated-extension | |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
1..* | Identifier | A local identifier MAY be added to this section. If used, system MUST be specified. | |
![]() ![]() ![]() ![]() |
0..1 | code | The local identifier use SHOULD be set to secondary, where the SDHR resource id is considered the primary identifier. | |
![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() |
1..1 | string | The actual local identifier value, e.g. ec2d6cad-1e19-46ee-accf-dc460a680710 Example Local Identifier Value: ec2d6cad-1e19-46ee-accf-dc460a680710 | |
![]() ![]() ![]() |
1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes (preferred) | |
![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | Indicates that the value has been selected by a system user | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() |
1..1 | uri | Type the reference refers to (e.g. "Patient") Required Pattern: Patient | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: ValueSet for AllergyIntolerance Manifestation (required) | |
![]() ![]() ![]() ![]() |
0..1 | code | mild | moderate | severe (of event as a whole) Binding: ValueSet for AllergyIntolerance Severity (required) | |
![]() |
Path | Conformance | ValueSet | URI |
AllergyIntolerance.code | preferred | AllergyIntoleranceSubstance/Product,ConditionAndNegationCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-code From the FHIR Standard | |
AllergyIntolerance.reaction.manifestation | required | SDHRAllergyIntoleranceManifestationValueSethttps://fhir-ig.digital.health.nz/sdhr/ValueSet/sdhr-allergyintolerance-manifestation-valueset From this IG | |
AllergyIntolerance.reaction.severity | required | SDHRAllergyIntoleranceSeverityValueSethttps://fhir-ig.digital.health.nz/sdhr/ValueSet/sdhr-allergyintolerance-severity-valueset From this IG |
Id | Grade | Path(s) | Details | Requirements |
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 ![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) Constraints: ait-1, ait-2 |
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact |
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
Σ | 0..1 | id | Version specific identifier |
![]() ![]() ![]() ![]() |
Σ | 0..1 | instant | When the resource version last changed |
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Captures the source of the record - please see description for details |
![]() ![]() ![]() ![]() |
Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to |
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..1 | dateTime | Client Last Updated URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/hnz-sdhr-client-last-updated-extension | |
![]() ![]() ![]() |
Σ | 1..* | Identifier | A local identifier MAY be added to this section. If used, system MUST be specified. |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
?!Σ | 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 . |
![]() ![]() ![]() ![]() |
Σ | 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. |
![]() ![]() ![]() ![]() |
Σ | 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 |
![]() ![]() ![]() ![]() |
Σ | 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 |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() |
?!ΣC | 0..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. |
![]() ![]() ![]() |
?!Σ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. |
![]() ![]() ![]() |
Σ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk. |
![]() ![]() ![]() |
Σ | 0..* | code | food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances. |
![]() ![]() ![]() |
Σ | 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. |
![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes (preferred) |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | Indicates that the value has been selected by a system user |
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept |
![]() ![]() ![]() |
Σ | 1..1 | Reference(Patient) | Who the sensitivity is for |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
Σ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 |
![]() ![]() ![]() ![]() |
Σ | 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 |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource |
![]() ![]() ![]() |
0..1 | Reference(Encounter) | Encounter when the allergy or intolerance was asserted | |
![]() ![]() ![]() |
0..1 | When allergy or intolerance was identified | ||
![]() ![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() ![]() |
Age | |||
![]() ![]() ![]() ![]() |
Period | |||
![]() ![]() ![]() ![]() |
Range | |||
![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() |
0..1 | dateTime | Date first version of the resource instance was recorded | |
![]() ![]() ![]() |
0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | Who recorded the sensitivity | |
![]() ![]() ![]() |
Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | Source of the information about the allergy |
![]() ![]() ![]() |
0..1 | dateTime | Date(/time) of last known occurrence of a reaction | |
![]() ![]() ![]() |
0..* | Annotation | Additional text not captured in other fields | |
![]() ![]() ![]() |
0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance | |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
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). | |
![]() ![]() ![]() ![]() |
1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: ValueSet for AllergyIntolerance Manifestation (required) | |
![]() ![]() ![]() ![]() |
0..1 | string | Description of the event as a whole | |
![]() ![]() ![]() ![]() |
0..1 | dateTime | Date(/time) when manifestations showed | |
![]() ![]() ![]() ![]() |
0..1 | code | mild | moderate | severe (of event as a whole) Binding: ValueSet for AllergyIntolerance Severity (required) | |
![]() ![]() ![]() ![]() |
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. | |
![]() ![]() ![]() ![]() |
0..* | Annotation | Text about event not captured in other fields | |
![]() |
Path | Conformance | ValueSet / Code | URI |
AllergyIntolerance.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels From the FHIR Standard | |
AllergyIntolerance.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags From the FHIR Standard | |
AllergyIntolerance.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard | |
AllergyIntolerance.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard | |
AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1 From the FHIR Standard | |
AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1 From the FHIR Standard | |
AllergyIntolerance.type | required | AllergyIntoleranceTypehttp://hl7.org/fhir/ValueSet/allergy-intolerance-type|4.0.1 From the FHIR Standard | |
AllergyIntolerance.category | required | AllergyIntoleranceCategoryhttp://hl7.org/fhir/ValueSet/allergy-intolerance-category|4.0.1 From the FHIR Standard | |
AllergyIntolerance.criticality | required | AllergyIntoleranceCriticalityhttp://hl7.org/fhir/ValueSet/allergy-intolerance-criticality|4.0.1 From the FHIR Standard | |
AllergyIntolerance.code | preferred | AllergyIntoleranceSubstance/Product,ConditionAndNegationCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-code From the FHIR Standard | |
AllergyIntolerance.patient.type | extensible | Pattern Value: Patienthttp://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard | |
AllergyIntolerance.reaction.substance | example | SubstanceCodehttp://hl7.org/fhir/ValueSet/substance-code From the FHIR Standard | |
AllergyIntolerance.reaction.manifestation | required | SDHRAllergyIntoleranceManifestationValueSethttps://fhir-ig.digital.health.nz/sdhr/ValueSet/sdhr-allergyintolerance-manifestation-valueset From this IG | |
AllergyIntolerance.reaction.severity | required | SDHRAllergyIntoleranceSeverityValueSethttps://fhir-ig.digital.health.nz/sdhr/ValueSet/sdhr-allergyintolerance-severity-valueset From this IG | |
AllergyIntolerance.reaction.exposureRoute | example | SNOMEDCTRouteCodeshttp://hl7.org/fhir/ValueSet/route-codes From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
ait-1 | error | AllergyIntolerance | AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists() | |
ait-2 | error | AllergyIntolerance | AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty() | |
dom-2 | error | AllergyIntolerance | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | AllergyIntolerance | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | AllergyIntolerance | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | AllergyIntolerance | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | AllergyIntolerance | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
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
Key Elements View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() Bindings Constraints Obligations ![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) Constraints: ait-1, ait-2 |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..1 | dateTime | Client Last Updated URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/hnz-sdhr-client-last-updated-extension | |
![]() ![]() ![]() |
Σ | 1..* | Identifier | A local identifier MAY be added to this section. If used, system MUST be specified. |
![]() ![]() ![]() ![]() |
?!Σ | 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 . |
![]() ![]() ![]() ![]() |
Σ | 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 |
![]() ![]() ![]() ![]() |
Σ | 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 |
![]() ![]() ![]() |
?!ΣC | 0..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. |
![]() ![]() ![]() |
?!Σ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. |
![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes (preferred) |
![]() ![]() ![]() |
Σ | 1..1 | Reference(Patient) | Who the sensitivity is for |
![]() ![]() ![]() ![]() |
Σ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 |
![]() ![]() ![]() ![]() |
Σ | 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 |
![]() |
Path | Conformance | ValueSet / Code | URI |
AllergyIntolerance.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard | |
AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1 From the FHIR Standard | |
AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1 From the FHIR Standard | |
AllergyIntolerance.code | preferred | AllergyIntoleranceSubstance/Product,ConditionAndNegationCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-code From the FHIR Standard | |
AllergyIntolerance.patient.type | extensible | Pattern Value: Patienthttp://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
ait-1 | error | AllergyIntolerance | AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists() | |
ait-2 | error | AllergyIntolerance | AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty() | |
dom-2 | error | AllergyIntolerance | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | AllergyIntolerance | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | AllergyIntolerance | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | AllergyIntolerance | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | AllergyIntolerance | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
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 ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
1..1 | uri | Captures the source of the record - please see description for details | |
![]() ![]() ![]() ![]() |
1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..1 | dateTime | Client Last Updated URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/hnz-sdhr-client-last-updated-extension | |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
1..* | Identifier | A local identifier MAY be added to this section. If used, system MUST be specified. | |
![]() ![]() ![]() ![]() |
0..1 | code | The local identifier use SHOULD be set to secondary, where the SDHR resource id is considered the primary identifier. | |
![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() |
1..1 | string | The actual local identifier value, e.g. ec2d6cad-1e19-46ee-accf-dc460a680710 Example Local Identifier Value: ec2d6cad-1e19-46ee-accf-dc460a680710 | |
![]() ![]() ![]() |
1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes (preferred) | |
![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | Indicates that the value has been selected by a system user | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() |
1..1 | uri | Type the reference refers to (e.g. "Patient") Required Pattern: Patient | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: ValueSet for AllergyIntolerance Manifestation (required) | |
![]() ![]() ![]() ![]() |
0..1 | code | mild | moderate | severe (of event as a whole) Binding: ValueSet for AllergyIntolerance Severity (required) | |
![]() |
Path | Conformance | ValueSet | URI |
AllergyIntolerance.code | preferred | AllergyIntoleranceSubstance/Product,ConditionAndNegationCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-code From the FHIR Standard | |
AllergyIntolerance.reaction.manifestation | required | SDHRAllergyIntoleranceManifestationValueSethttps://fhir-ig.digital.health.nz/sdhr/ValueSet/sdhr-allergyintolerance-manifestation-valueset From this IG | |
AllergyIntolerance.reaction.severity | required | SDHRAllergyIntoleranceSeverityValueSethttps://fhir-ig.digital.health.nz/sdhr/ValueSet/sdhr-allergyintolerance-severity-valueset From this IG |
Id | Grade | Path(s) | Details | Requirements |
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 ![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) Constraints: ait-1, ait-2 |
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact |
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
Σ | 0..1 | id | Version specific identifier |
![]() ![]() ![]() ![]() |
Σ | 0..1 | instant | When the resource version last changed |
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Captures the source of the record - please see description for details |
![]() ![]() ![]() ![]() |
Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to |
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..1 | dateTime | Client Last Updated URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/hnz-sdhr-client-last-updated-extension | |
![]() ![]() ![]() |
Σ | 1..* | Identifier | A local identifier MAY be added to this section. If used, system MUST be specified. |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
?!Σ | 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 . |
![]() ![]() ![]() ![]() |
Σ | 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. |
![]() ![]() ![]() ![]() |
Σ | 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 |
![]() ![]() ![]() ![]() |
Σ | 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 |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() |
?!ΣC | 0..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. |
![]() ![]() ![]() |
?!Σ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. |
![]() ![]() ![]() |
Σ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk. |
![]() ![]() ![]() |
Σ | 0..* | code | food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances. |
![]() ![]() ![]() |
Σ | 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. |
![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes (preferred) |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | Indicates that the value has been selected by a system user |
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept |
![]() ![]() ![]() |
Σ | 1..1 | Reference(Patient) | Who the sensitivity is for |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
Σ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 |
![]() ![]() ![]() ![]() |
Σ | 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 |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource |
![]() ![]() ![]() |
0..1 | Reference(Encounter) | Encounter when the allergy or intolerance was asserted | |
![]() ![]() ![]() |
0..1 | When allergy or intolerance was identified | ||
![]() ![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() ![]() |
Age | |||
![]() ![]() ![]() ![]() |
Period | |||
![]() ![]() ![]() ![]() |
Range | |||
![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() |
0..1 | dateTime | Date first version of the resource instance was recorded | |
![]() ![]() ![]() |
0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | Who recorded the sensitivity | |
![]() ![]() ![]() |
Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | Source of the information about the allergy |
![]() ![]() ![]() |
0..1 | dateTime | Date(/time) of last known occurrence of a reaction | |
![]() ![]() ![]() |
0..* | Annotation | Additional text not captured in other fields | |
![]() ![]() ![]() |
0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance | |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
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). | |
![]() ![]() ![]() ![]() |
1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: ValueSet for AllergyIntolerance Manifestation (required) | |
![]() ![]() ![]() ![]() |
0..1 | string | Description of the event as a whole | |
![]() ![]() ![]() ![]() |
0..1 | dateTime | Date(/time) when manifestations showed | |
![]() ![]() ![]() ![]() |
0..1 | code | mild | moderate | severe (of event as a whole) Binding: ValueSet for AllergyIntolerance Severity (required) | |
![]() ![]() ![]() ![]() |
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. | |
![]() ![]() ![]() ![]() |
0..* | Annotation | Text about event not captured in other fields | |
![]() |
Path | Conformance | ValueSet / Code | URI |
AllergyIntolerance.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels From the FHIR Standard | |
AllergyIntolerance.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags From the FHIR Standard | |
AllergyIntolerance.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard | |
AllergyIntolerance.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard | |
AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1 From the FHIR Standard | |
AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1 From the FHIR Standard | |
AllergyIntolerance.type | required | AllergyIntoleranceTypehttp://hl7.org/fhir/ValueSet/allergy-intolerance-type|4.0.1 From the FHIR Standard | |
AllergyIntolerance.category | required | AllergyIntoleranceCategoryhttp://hl7.org/fhir/ValueSet/allergy-intolerance-category|4.0.1 From the FHIR Standard | |
AllergyIntolerance.criticality | required | AllergyIntoleranceCriticalityhttp://hl7.org/fhir/ValueSet/allergy-intolerance-criticality|4.0.1 From the FHIR Standard | |
AllergyIntolerance.code | preferred | AllergyIntoleranceSubstance/Product,ConditionAndNegationCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-code From the FHIR Standard | |
AllergyIntolerance.patient.type | extensible | Pattern Value: Patienthttp://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard | |
AllergyIntolerance.reaction.substance | example | SubstanceCodehttp://hl7.org/fhir/ValueSet/substance-code From the FHIR Standard | |
AllergyIntolerance.reaction.manifestation | required | SDHRAllergyIntoleranceManifestationValueSethttps://fhir-ig.digital.health.nz/sdhr/ValueSet/sdhr-allergyintolerance-manifestation-valueset From this IG | |
AllergyIntolerance.reaction.severity | required | SDHRAllergyIntoleranceSeverityValueSethttps://fhir-ig.digital.health.nz/sdhr/ValueSet/sdhr-allergyintolerance-severity-valueset From this IG | |
AllergyIntolerance.reaction.exposureRoute | example | SNOMEDCTRouteCodeshttp://hl7.org/fhir/ValueSet/route-codes From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
ait-1 | error | AllergyIntolerance | AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists() | |
ait-2 | error | AllergyIntolerance | AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty() | |
dom-2 | error | AllergyIntolerance | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | AllergyIntolerance | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | AllergyIntolerance | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | AllergyIntolerance | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | AllergyIntolerance | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
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
Other representations of profile: CSV, Excel, Schematron
IG © 2025+ Health New Zealand. Package tewhatuora.fhir.nz-shared-digital-health-record#0.5.0 based on FHIR 4.0.1. Generated 2025-06-10
Links: Table of Contents |
QA Report