Te Whatu Ora, Central Region Integration Hub
1.0.10-rc1 - ci-build
Te Whatu Ora, Central Region Integration Hub, published by Te Whatu Ora, Te Pae Hauora o Ruahine o Tararua, MidCentral. This guide is not an authorized publication; it is the continuous build for version 1.0.10-rc1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/tewhatuora/centralRegion-integrationHub-ig/ and changes regularly. See the Directory of published versions
Official URL: https://fhir-ig.digital.health.nz/crih/StructureDefinition/NZCentralRegionAllergyIntolerance | Version: 1.0.10-rc1 | |||
Active as of 2024-09-04 | Computable Name: NZCentralRegionAllergyIntolerance |
AllergyIntolerance resource for Te Whatu Ora, Central Region
Record of a Patient's food or drug allergy or other intolerance.
Populated from the ZAL
custom segment of ADT
messages; based upon the Alert Type field ZAL-2.1
with values from
Allergy Alert Category codes.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AllergyIntolerance
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
1..* | Extension | Extension | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | (Complex) | HL7 v2 Message URL: https://standards.digital.health.nz/ns/central-region/hl7v2-message |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | identifies the meaning of the extension | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | base64Binary | Value of extension | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | dateTime | Process TimeStamp URL: http://ibm.com/fhir/cdm/StructureDefinition/process-timestamp |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Source Event Trigger URL: http://ibm.com/fhir/cdm/StructureDefinition/source-event-trigger Binding: hl7VS-eventTypeCode (required) |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Source Record Type URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-type Binding: hl7VS-messageType (required) |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Source Record ID URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-id |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Source Data Model Version URL: http://ibm.com/fhir/cdm/StructureDefinition/source-data-model-version |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Process Client ID URL: http://ibm.com/fhir/cdm/StructureDefinition/process-client-id |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | L4H Template Version URL: https://standards.digital.health.nz/ns/central-region/l4h-template-version |
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
S | 1..1 | (Complex) | NZ Central Region Alert URL: https://standards.digital.health.nz/ns/central-region/alert |
![]() ![]() ![]() ![]() ![]() |
3..* | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | identifies the meaning of the extension | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Coding | Value of extension Binding: NZ Central Region - Allergy Alert Category Value Set (required) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Extension | Severity level in range '0'..'9' | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | identifies the meaning of the extension | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Value of extension | |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Extension | Allergy reaction code from [allergy-reaction-code](./ValueSet-nzcr-allergy-reaction-vs.html) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | identifies the meaning of the extension | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | identifies the meaning of the extension | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | date | Value of extension | |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | identifies the meaning of the extension | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | date | Value of extension | |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | identifies the meaning of the extension | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | string | Value of extension | |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | identifies the meaning of the extension | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | dateTime | Value of extension | |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | identifies the meaning of the extension | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | identifies the meaning of the extension | |
![]() ![]() ![]() |
S | 1..1 | Identifier | External ids for this item |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) | |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
S | 1..1 | uri | The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-alert-id |
![]() ![]() ![]() ![]() |
S | 1..1 | string | The value that is unique |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | active | inactive | resolved |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
S | 1..1 | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
S | 1..1 | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/allergyintolerance-verification |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
S | 1..1 | code | allergy | intolerance - Underlying mechanism (if known) |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
S | 1..1 | code | food | medication | environment | biologic |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
S | 1..1 | code | low | high | unable-to-assess |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: NZ Central Region - Allergy Alert Code Value Set (required) |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
S | 1..1 | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
S | 1..1 | Reference(Patient) | Who the sensitivity is for |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
S | 0..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() ![]() |
S | 1..1 | uri | Type the reference refers to (e.g. "Patient") Required Pattern: Patient |
![]() ![]() ![]() ![]() |
S | 1..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | usual | official | temp | secondary | old (If known) |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Description of identifier |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | uri | The namespace for the identifier value |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | The value that is unique |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
S | 0..1 | string | Text alternative for the resource |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
S | 0..1 | Use onsetDateTime when only start time is known; otherwise use onsetPeriod when both start and end time are known Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() ![]() |
Period | |||
![]() ![]() ![]() ![]() |
S | 0..1 | dateTime | When allergy or intolerance was identified |
![]() ![]() ![]() ![]() |
S | 0..1 | Period | When allergy or intolerance was identified |
![]() ![]() ![]() ![]() ![]() |
0..1 | dateTime | Starting time with inclusive boundary | |
![]() ![]() ![]() ![]() ![]() |
0..1 | dateTime | End time with inclusive boundary, if not ongoing | |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
S | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | Who recorded the sensitivity |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
S | 0..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() ![]() |
S | 1..1 | uri | Resource the reference refers to (e.g. 'Practitioner') Required Pattern: Practitioner |
![]() ![]() ![]() ![]() |
S | 1..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | usual | official | temp | secondary | old (If known) |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Description of identifier |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Symbol in syntax defined by the system Required Pattern: LR |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | Representation defined by the system Required Pattern: Local Registry ID |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | uri | The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-practitioner-id |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | The value that is unique | |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
S | 0..1 | string | Text alternative for the resource |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
S | 0..1 | Annotation | Additional text not captured in other fields |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
S | 1..1 | markdown | The annotation - text content (as markdown) |
![]() ![]() ![]() |
0..0 | |||
![]() |
Path | Conformance | ValueSet | URI |
AllergyIntolerance.extension:allergy-alert.extension:webPASCategory.value[x] | required | NZCentralRegionAllergyAlertCategoryValueSethttps://standards.digital.health.nz/fhir/central-region/ValueSet-alert-type-allergy from this IG | |
AllergyIntolerance.code | required | NZCentralRegionAllergyAlertCodeValueSethttps://standards.digital.health.nz/fhir/central-region/ValueSet-allergy-alert-code from this IG |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) ait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error |
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | (Complex) | HL7 v2 Message URL: https://standards.digital.health.nz/ns/central-region/hl7v2-message |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://standards.digital.health.nz/ns/central-region/hl7v2-message" | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | base64Binary | Value of extension | |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | dateTime | Process TimeStamp URL: http://ibm.com/fhir/cdm/StructureDefinition/process-timestamp |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Source Event Trigger URL: http://ibm.com/fhir/cdm/StructureDefinition/source-event-trigger Binding: hl7VS-eventTypeCode (required) |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Source Record Type URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-type Binding: hl7VS-messageType (required) |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Source Record ID URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-id |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Source Data Model Version URL: http://ibm.com/fhir/cdm/StructureDefinition/source-data-model-version |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Process Client ID URL: http://ibm.com/fhir/cdm/StructureDefinition/process-client-id |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | L4H Template Version URL: https://standards.digital.health.nz/ns/central-region/l4h-template-version |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
S | 1..1 | (Complex) | NZ Central Region Alert URL: https://standards.digital.health.nz/ns/central-region/alert |
![]() ![]() ![]() ![]() ![]() |
3..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Extension | Extension |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "webPASCategory" | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Coding | Value of extension Binding: NZ Central Region - Allergy Alert Category Value Set (required) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Extension | Severity level in range '0'..'9' |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "severityLevel" | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Value of extension | |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Extension | Allergy reaction code from [allergy-reaction-code](./ValueSet-nzcr-allergy-reaction-vs.html) |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "allergyReaction" | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Value of extension Binding: NZ Central Region - Allergy Reaction Value Set (required) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..* | Coding | Multiple codings possible, one is original valuee from WebPAS... |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Extension | Extension |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "inactiveDate" | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | date | Value of extension | |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Extension | Extension |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "reviewDate" | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | date | Value of extension | |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Extension | Extension |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "lastUpdatedBy" | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | string | Value of extension | |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Extension | Extension |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "lastUpdatedDateTime" | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | dateTime | Value of extension | |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Extension | Extension |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "recordingHospital" | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Value of extension Binding: NZ Central Region - Hospital Value Set (extensible) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..* | Coding | Multiple codings possible, one is original value from WebPAS... |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Describe received code values that are unable to be validated |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://standards.digital.health.nz/ns/central-region/alert" | |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
SΣ | 1..1 | Identifier | External ids for this item |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-alert-id |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() |
?!SΣC | 1..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Representation defined by the system |
![]() ![]() ![]() |
?!SΣC | 1..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance. |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/allergyintolerance-verification |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Representation defined by the system |
![]() ![]() ![]() |
SΣ | 1..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk. |
![]() ![]() ![]() |
SΣ | 1..1 | code | food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances. |
![]() ![]() ![]() |
SΣ | 1..1 | code | low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance. |
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: NZ Central Region - Allergy Alert Code Value Set (required) |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Representation defined by the system |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Patient) | Who the sensitivity is for |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Patient |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 0..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Text alternative for the resource |
![]() ![]() ![]() |
S | 0..1 | Use onsetDateTime when only start time is known; otherwise use onsetPeriod when both start and end time are known Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() ![]() |
Period | |||
![]() ![]() ![]() ![]() |
S | 0..1 | dateTime | When allergy or intolerance was identified |
![]() ![]() ![]() ![]() |
S | 0..1 | Period | When allergy or intolerance was identified |
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | dateTime | Starting time with inclusive boundary |
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing |
![]() ![]() ![]() |
S | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | Who recorded the sensitivity |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Resource the reference refers to (e.g. 'Practitioner') Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Practitioner |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 0..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: LR |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Representation defined by the system Required Pattern: Local Registry ID |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-practitioner-id |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Text alternative for the resource |
![]() ![]() ![]() |
S | 0..1 | Annotation | Additional text not captured in other fields |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | markdown | The annotation - text content (as markdown) |
![]() |
Path | Conformance | ValueSet / Code | URI |
AllergyIntolerance.extension:allergy-alert.extension:webPASCategory.value[x] | required | NZCentralRegionAllergyAlertCategoryValueSethttps://standards.digital.health.nz/fhir/central-region/ValueSet-alert-type-allergy from this IG | |
AllergyIntolerance.extension:allergy-alert.extension:allergyReaction.value[x] | required | NZCentralRegionAllergyReactionValueSethttps://standards.digital.health.nz/fhir/central-region/ValueSet-allergy-reaction from this IG | |
AllergyIntolerance.extension:allergy-alert.extension:recordingHospital.value[x] | extensible | NZCentralRegionHospitalValueSethttps://standards.digital.health.nz/fhir/central-region/ValueSet-hospital-code from this IG | |
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.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 | required | NZCentralRegionAllergyAlertCodeValueSethttps://standards.digital.health.nz/fhir/central-region/ValueSet-allergy-alert-code from this IG | |
AllergyIntolerance.patient.type | extensible | Pattern: Patienthttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | |
AllergyIntolerance.patient.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
AllergyIntolerance.patient.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
AllergyIntolerance.recorder.type | extensible | Pattern: Practitionerhttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | |
AllergyIntolerance.recorder.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
AllergyIntolerance.recorder.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
AllergyIntolerance.reaction.manifestation | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findings 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() |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) ait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error | ||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | (Complex) | HL7 v2 Message URL: https://standards.digital.health.nz/ns/central-region/hl7v2-message | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://standards.digital.health.nz/ns/central-region/hl7v2-message" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | base64Binary | Value of extension | |||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | dateTime | Process TimeStamp URL: http://ibm.com/fhir/cdm/StructureDefinition/process-timestamp | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Source Event Trigger URL: http://ibm.com/fhir/cdm/StructureDefinition/source-event-trigger Binding: hl7VS-eventTypeCode (required) | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Source Record Type URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-type Binding: hl7VS-messageType (required) | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Source Record ID URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-id | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Source Data Model Version URL: http://ibm.com/fhir/cdm/StructureDefinition/source-data-model-version | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Process Client ID URL: http://ibm.com/fhir/cdm/StructureDefinition/process-client-id | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | L4H Template Version URL: https://standards.digital.health.nz/ns/central-region/l4h-template-version | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | 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 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
S | 1..1 | (Complex) | NZ Central Region Alert URL: https://standards.digital.health.nz/ns/central-region/alert | ||||
![]() ![]() ![]() ![]() ![]() |
3..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Extension | Extension | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "webPASCategory" | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Coding | Value of extension Binding: NZ Central Region - Allergy Alert Category Value Set (required) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Extension | Severity level in range '0'..'9' | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "severityLevel" | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Value of extension | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Extension | Allergy reaction code from [allergy-reaction-code](./ValueSet-nzcr-allergy-reaction-vs.html) | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "allergyReaction" | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Value of extension Binding: NZ Central Region - Allergy Reaction Value Set (required) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..* | Coding | Multiple codings possible, one is original valuee from WebPAS... | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Extension | Extension | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "inactiveDate" | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | date | Value of extension | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Extension | Extension | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "reviewDate" | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | date | Value of extension | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Extension | Extension | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "lastUpdatedBy" | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | string | Value of extension | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Extension | Extension | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "lastUpdatedDateTime" | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | dateTime | Value of extension | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Extension | Extension | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "recordingHospital" | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Value of extension Binding: NZ Central Region - Hospital Value Set (extensible) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..* | Coding | Multiple codings possible, one is original value from WebPAS... | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Describe received code values that are unable to be validated | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://standards.digital.health.nz/ns/central-region/alert" | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Identifier | External ids for this item | ||||
![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-alert-id | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() |
?!SΣC | 1..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. | ||||
![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() |
?!SΣC | 1..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance. | ||||
![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/allergyintolerance-verification | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() |
SΣ | 1..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | code | food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | code | low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: NZ Central Region - Allergy Alert Code Value Set (required) | ||||
![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Patient) | Who the sensitivity is for | ||||
![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() |
SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Patient | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() |
?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() ![]() |
S | 0..1 | Use onsetDateTime when only start time is known; otherwise use onsetPeriod when both start and end time are known Slice: Unordered, Closed by type:$this | |||||
![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() ![]() |
S | 0..1 | dateTime | When allergy or intolerance was identified | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | Period | When allergy or intolerance was identified | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | dateTime | Starting time with inclusive boundary | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
![]() ![]() ![]() |
S | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | Who recorded the sensitivity | ||||
![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() |
SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Resource the reference refers to (e.g. 'Practitioner') Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Practitioner | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() |
?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: LR | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Representation defined by the system Required Pattern: Local Registry ID | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-practitioner-id | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() ![]() |
S | 0..1 | Annotation | Additional text not captured in other fields | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | markdown | The annotation - text content (as markdown) | ||||
![]() |
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.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
AllergyIntolerance.extension:allergy-alert.extension:webPASCategory.value[x] | required | NZCentralRegionAllergyAlertCategoryValueSethttps://standards.digital.health.nz/fhir/central-region/ValueSet-alert-type-allergy from this IG | ||||
AllergyIntolerance.extension:allergy-alert.extension:allergyReaction.value[x] | required | NZCentralRegionAllergyReactionValueSethttps://standards.digital.health.nz/fhir/central-region/ValueSet-allergy-reaction from this IG | ||||
AllergyIntolerance.extension:allergy-alert.extension:recordingHospital.value[x] | extensible | NZCentralRegionHospitalValueSethttps://standards.digital.health.nz/fhir/central-region/ValueSet-hospital-code from this IG | ||||
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.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 | required | NZCentralRegionAllergyAlertCodeValueSethttps://standards.digital.health.nz/fhir/central-region/ValueSet-allergy-alert-code from this IG | ||||
AllergyIntolerance.patient.type | extensible | Pattern: Patienthttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
AllergyIntolerance.patient.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
AllergyIntolerance.patient.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
AllergyIntolerance.recorder.type | extensible | Pattern: Practitionerhttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
AllergyIntolerance.recorder.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
AllergyIntolerance.recorder.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
AllergyIntolerance.reaction.substance | example | SubstanceCodehttp://hl7.org/fhir/ValueSet/substance-code from the FHIR Standard | ||||
AllergyIntolerance.reaction.manifestation | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findings from the FHIR Standard | ||||
AllergyIntolerance.reaction.severity | required | AllergyIntoleranceSeverityhttp://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1 from the FHIR Standard | ||||
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() |
This structure is derived from AllergyIntolerance
Summary
Mandatory: 31 elements(13 nested mandatory elements)
Must-Support: 60 elements
Prohibited: 66 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from AllergyIntolerance
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
1..* | Extension | Extension | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | (Complex) | HL7 v2 Message URL: https://standards.digital.health.nz/ns/central-region/hl7v2-message |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | identifies the meaning of the extension | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | base64Binary | Value of extension | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | dateTime | Process TimeStamp URL: http://ibm.com/fhir/cdm/StructureDefinition/process-timestamp |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Source Event Trigger URL: http://ibm.com/fhir/cdm/StructureDefinition/source-event-trigger Binding: hl7VS-eventTypeCode (required) |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Source Record Type URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-type Binding: hl7VS-messageType (required) |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Source Record ID URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-id |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Source Data Model Version URL: http://ibm.com/fhir/cdm/StructureDefinition/source-data-model-version |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Process Client ID URL: http://ibm.com/fhir/cdm/StructureDefinition/process-client-id |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | L4H Template Version URL: https://standards.digital.health.nz/ns/central-region/l4h-template-version |
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
S | 1..1 | (Complex) | NZ Central Region Alert URL: https://standards.digital.health.nz/ns/central-region/alert |
![]() ![]() ![]() ![]() ![]() |
3..* | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | identifies the meaning of the extension | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Coding | Value of extension Binding: NZ Central Region - Allergy Alert Category Value Set (required) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Extension | Severity level in range '0'..'9' | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | identifies the meaning of the extension | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Value of extension | |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Extension | Allergy reaction code from [allergy-reaction-code](./ValueSet-nzcr-allergy-reaction-vs.html) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | identifies the meaning of the extension | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | identifies the meaning of the extension | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | date | Value of extension | |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | identifies the meaning of the extension | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | date | Value of extension | |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | identifies the meaning of the extension | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | string | Value of extension | |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | identifies the meaning of the extension | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | dateTime | Value of extension | |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | identifies the meaning of the extension | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | identifies the meaning of the extension | |
![]() ![]() ![]() |
S | 1..1 | Identifier | External ids for this item |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) | |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
S | 1..1 | uri | The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-alert-id |
![]() ![]() ![]() ![]() |
S | 1..1 | string | The value that is unique |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | active | inactive | resolved |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
S | 1..1 | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
S | 1..1 | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/allergyintolerance-verification |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
S | 1..1 | code | allergy | intolerance - Underlying mechanism (if known) |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
S | 1..1 | code | food | medication | environment | biologic |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
S | 1..1 | code | low | high | unable-to-assess |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: NZ Central Region - Allergy Alert Code Value Set (required) |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
S | 1..1 | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
S | 1..1 | Reference(Patient) | Who the sensitivity is for |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
S | 0..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() ![]() |
S | 1..1 | uri | Type the reference refers to (e.g. "Patient") Required Pattern: Patient |
![]() ![]() ![]() ![]() |
S | 1..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | usual | official | temp | secondary | old (If known) |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Description of identifier |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | uri | The namespace for the identifier value |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | The value that is unique |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
S | 0..1 | string | Text alternative for the resource |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
S | 0..1 | Use onsetDateTime when only start time is known; otherwise use onsetPeriod when both start and end time are known Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() ![]() |
Period | |||
![]() ![]() ![]() ![]() |
S | 0..1 | dateTime | When allergy or intolerance was identified |
![]() ![]() ![]() ![]() |
S | 0..1 | Period | When allergy or intolerance was identified |
![]() ![]() ![]() ![]() ![]() |
0..1 | dateTime | Starting time with inclusive boundary | |
![]() ![]() ![]() ![]() ![]() |
0..1 | dateTime | End time with inclusive boundary, if not ongoing | |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
S | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | Who recorded the sensitivity |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
S | 0..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() ![]() |
S | 1..1 | uri | Resource the reference refers to (e.g. 'Practitioner') Required Pattern: Practitioner |
![]() ![]() ![]() ![]() |
S | 1..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | usual | official | temp | secondary | old (If known) |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Description of identifier |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Symbol in syntax defined by the system Required Pattern: LR |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | Representation defined by the system Required Pattern: Local Registry ID |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | uri | The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-practitioner-id |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | The value that is unique | |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
S | 0..1 | string | Text alternative for the resource |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
S | 0..1 | Annotation | Additional text not captured in other fields |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
S | 1..1 | markdown | The annotation - text content (as markdown) |
![]() ![]() ![]() |
0..0 | |||
![]() |
Path | Conformance | ValueSet | URI |
AllergyIntolerance.extension:allergy-alert.extension:webPASCategory.value[x] | required | NZCentralRegionAllergyAlertCategoryValueSethttps://standards.digital.health.nz/fhir/central-region/ValueSet-alert-type-allergy from this IG | |
AllergyIntolerance.code | required | NZCentralRegionAllergyAlertCodeValueSethttps://standards.digital.health.nz/fhir/central-region/ValueSet-allergy-alert-code from this IG |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) ait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error |
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | (Complex) | HL7 v2 Message URL: https://standards.digital.health.nz/ns/central-region/hl7v2-message |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://standards.digital.health.nz/ns/central-region/hl7v2-message" | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | base64Binary | Value of extension | |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | dateTime | Process TimeStamp URL: http://ibm.com/fhir/cdm/StructureDefinition/process-timestamp |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Source Event Trigger URL: http://ibm.com/fhir/cdm/StructureDefinition/source-event-trigger Binding: hl7VS-eventTypeCode (required) |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Source Record Type URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-type Binding: hl7VS-messageType (required) |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Source Record ID URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-id |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Source Data Model Version URL: http://ibm.com/fhir/cdm/StructureDefinition/source-data-model-version |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Process Client ID URL: http://ibm.com/fhir/cdm/StructureDefinition/process-client-id |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | L4H Template Version URL: https://standards.digital.health.nz/ns/central-region/l4h-template-version |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
S | 1..1 | (Complex) | NZ Central Region Alert URL: https://standards.digital.health.nz/ns/central-region/alert |
![]() ![]() ![]() ![]() ![]() |
3..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Extension | Extension |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "webPASCategory" | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Coding | Value of extension Binding: NZ Central Region - Allergy Alert Category Value Set (required) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Extension | Severity level in range '0'..'9' |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "severityLevel" | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Value of extension | |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Extension | Allergy reaction code from [allergy-reaction-code](./ValueSet-nzcr-allergy-reaction-vs.html) |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "allergyReaction" | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Value of extension Binding: NZ Central Region - Allergy Reaction Value Set (required) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..* | Coding | Multiple codings possible, one is original valuee from WebPAS... |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Extension | Extension |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "inactiveDate" | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | date | Value of extension | |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Extension | Extension |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "reviewDate" | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | date | Value of extension | |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Extension | Extension |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "lastUpdatedBy" | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | string | Value of extension | |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Extension | Extension |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "lastUpdatedDateTime" | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | dateTime | Value of extension | |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Extension | Extension |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "recordingHospital" | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Value of extension Binding: NZ Central Region - Hospital Value Set (extensible) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..* | Coding | Multiple codings possible, one is original value from WebPAS... |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Describe received code values that are unable to be validated |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://standards.digital.health.nz/ns/central-region/alert" | |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
SΣ | 1..1 | Identifier | External ids for this item |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-alert-id |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() |
?!SΣC | 1..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Representation defined by the system |
![]() ![]() ![]() |
?!SΣC | 1..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance. |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/allergyintolerance-verification |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Representation defined by the system |
![]() ![]() ![]() |
SΣ | 1..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk. |
![]() ![]() ![]() |
SΣ | 1..1 | code | food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances. |
![]() ![]() ![]() |
SΣ | 1..1 | code | low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance. |
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: NZ Central Region - Allergy Alert Code Value Set (required) |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Representation defined by the system |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Patient) | Who the sensitivity is for |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Patient |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 0..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Text alternative for the resource |
![]() ![]() ![]() |
S | 0..1 | Use onsetDateTime when only start time is known; otherwise use onsetPeriod when both start and end time are known Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() ![]() |
Period | |||
![]() ![]() ![]() ![]() |
S | 0..1 | dateTime | When allergy or intolerance was identified |
![]() ![]() ![]() ![]() |
S | 0..1 | Period | When allergy or intolerance was identified |
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | dateTime | Starting time with inclusive boundary |
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing |
![]() ![]() ![]() |
S | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | Who recorded the sensitivity |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Resource the reference refers to (e.g. 'Practitioner') Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Practitioner |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 0..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: LR |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Representation defined by the system Required Pattern: Local Registry ID |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-practitioner-id |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Text alternative for the resource |
![]() ![]() ![]() |
S | 0..1 | Annotation | Additional text not captured in other fields |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | markdown | The annotation - text content (as markdown) |
![]() |
Path | Conformance | ValueSet / Code | URI |
AllergyIntolerance.extension:allergy-alert.extension:webPASCategory.value[x] | required | NZCentralRegionAllergyAlertCategoryValueSethttps://standards.digital.health.nz/fhir/central-region/ValueSet-alert-type-allergy from this IG | |
AllergyIntolerance.extension:allergy-alert.extension:allergyReaction.value[x] | required | NZCentralRegionAllergyReactionValueSethttps://standards.digital.health.nz/fhir/central-region/ValueSet-allergy-reaction from this IG | |
AllergyIntolerance.extension:allergy-alert.extension:recordingHospital.value[x] | extensible | NZCentralRegionHospitalValueSethttps://standards.digital.health.nz/fhir/central-region/ValueSet-hospital-code from this IG | |
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.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 | required | NZCentralRegionAllergyAlertCodeValueSethttps://standards.digital.health.nz/fhir/central-region/ValueSet-allergy-alert-code from this IG | |
AllergyIntolerance.patient.type | extensible | Pattern: Patienthttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | |
AllergyIntolerance.patient.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
AllergyIntolerance.patient.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
AllergyIntolerance.recorder.type | extensible | Pattern: Practitionerhttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | |
AllergyIntolerance.recorder.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
AllergyIntolerance.recorder.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
AllergyIntolerance.reaction.manifestation | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findings 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() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) ait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error | ||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | (Complex) | HL7 v2 Message URL: https://standards.digital.health.nz/ns/central-region/hl7v2-message | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://standards.digital.health.nz/ns/central-region/hl7v2-message" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | base64Binary | Value of extension | |||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | dateTime | Process TimeStamp URL: http://ibm.com/fhir/cdm/StructureDefinition/process-timestamp | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Source Event Trigger URL: http://ibm.com/fhir/cdm/StructureDefinition/source-event-trigger Binding: hl7VS-eventTypeCode (required) | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Source Record Type URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-type Binding: hl7VS-messageType (required) | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Source Record ID URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-id | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Source Data Model Version URL: http://ibm.com/fhir/cdm/StructureDefinition/source-data-model-version | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Process Client ID URL: http://ibm.com/fhir/cdm/StructureDefinition/process-client-id | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | L4H Template Version URL: https://standards.digital.health.nz/ns/central-region/l4h-template-version | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | 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 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
S | 1..1 | (Complex) | NZ Central Region Alert URL: https://standards.digital.health.nz/ns/central-region/alert | ||||
![]() ![]() ![]() ![]() ![]() |
3..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Extension | Extension | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "webPASCategory" | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Coding | Value of extension Binding: NZ Central Region - Allergy Alert Category Value Set (required) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Extension | Severity level in range '0'..'9' | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "severityLevel" | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Value of extension | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Extension | Allergy reaction code from [allergy-reaction-code](./ValueSet-nzcr-allergy-reaction-vs.html) | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "allergyReaction" | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Value of extension Binding: NZ Central Region - Allergy Reaction Value Set (required) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..* | Coding | Multiple codings possible, one is original valuee from WebPAS... | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Extension | Extension | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "inactiveDate" | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | date | Value of extension | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Extension | Extension | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "reviewDate" | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | date | Value of extension | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Extension | Extension | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "lastUpdatedBy" | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | string | Value of extension | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Extension | Extension | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "lastUpdatedDateTime" | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | dateTime | Value of extension | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Extension | Extension | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "recordingHospital" | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Value of extension Binding: NZ Central Region - Hospital Value Set (extensible) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..* | Coding | Multiple codings possible, one is original value from WebPAS... | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Describe received code values that are unable to be validated | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://standards.digital.health.nz/ns/central-region/alert" | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Identifier | External ids for this item | ||||
![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-alert-id | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() |
?!SΣC | 1..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. | ||||
![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() |
?!SΣC | 1..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance. | ||||
![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/allergyintolerance-verification | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() |
SΣ | 1..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | code | food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | code | low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: NZ Central Region - Allergy Alert Code Value Set (required) | ||||
![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Patient) | Who the sensitivity is for | ||||
![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() |
SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Patient | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() |
?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() ![]() |
S | 0..1 | Use onsetDateTime when only start time is known; otherwise use onsetPeriod when both start and end time are known Slice: Unordered, Closed by type:$this | |||||
![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() ![]() |
S | 0..1 | dateTime | When allergy or intolerance was identified | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | Period | When allergy or intolerance was identified | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | dateTime | Starting time with inclusive boundary | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
![]() ![]() ![]() |
S | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | Who recorded the sensitivity | ||||
![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() |
SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Resource the reference refers to (e.g. 'Practitioner') Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Practitioner | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() |
?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: LR | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Representation defined by the system Required Pattern: Local Registry ID | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-practitioner-id | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() ![]() |
S | 0..1 | Annotation | Additional text not captured in other fields | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | markdown | The annotation - text content (as markdown) | ||||
![]() |
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.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
AllergyIntolerance.extension:allergy-alert.extension:webPASCategory.value[x] | required | NZCentralRegionAllergyAlertCategoryValueSethttps://standards.digital.health.nz/fhir/central-region/ValueSet-alert-type-allergy from this IG | ||||
AllergyIntolerance.extension:allergy-alert.extension:allergyReaction.value[x] | required | NZCentralRegionAllergyReactionValueSethttps://standards.digital.health.nz/fhir/central-region/ValueSet-allergy-reaction from this IG | ||||
AllergyIntolerance.extension:allergy-alert.extension:recordingHospital.value[x] | extensible | NZCentralRegionHospitalValueSethttps://standards.digital.health.nz/fhir/central-region/ValueSet-hospital-code from this IG | ||||
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.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 | required | NZCentralRegionAllergyAlertCodeValueSethttps://standards.digital.health.nz/fhir/central-region/ValueSet-allergy-alert-code from this IG | ||||
AllergyIntolerance.patient.type | extensible | Pattern: Patienthttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
AllergyIntolerance.patient.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
AllergyIntolerance.patient.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
AllergyIntolerance.recorder.type | extensible | Pattern: Practitionerhttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
AllergyIntolerance.recorder.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
AllergyIntolerance.recorder.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
AllergyIntolerance.reaction.substance | example | SubstanceCodehttp://hl7.org/fhir/ValueSet/substance-code from the FHIR Standard | ||||
AllergyIntolerance.reaction.manifestation | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findings from the FHIR Standard | ||||
AllergyIntolerance.reaction.severity | required | AllergyIntoleranceSeverityhttp://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1 from the FHIR Standard | ||||
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() |
This structure is derived from AllergyIntolerance
Summary
Mandatory: 31 elements(13 nested mandatory elements)
Must-Support: 60 elements
Prohibited: 66 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron