Te Whatu Ora, Central Region Integration Hub
1.0.12-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.12-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://standards.digital.health.nz/ns/central-region/alert | Version: 1.0.12-rc1 | |||
Active as of 2024-09-17 | Computable Name: NZCentralRegionAlert |
Complex extension recording meta data about all alerts, on who recorded the Flag and AllergyIntolerance flavours of Alert and when.
Context of Use
This extension may be used on the following element(s):
Usage info
Usage:
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Extension
Summary
Complex Extension: Complex extension recording meta data about all alerts, on who recorded the Flag and AllergyIntolerance flavours of Alert and when.
This structure is derived from Extension
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Extension | 0..* | Extension | NZ Central Region Alert | |
id | 0..0 | |||
extension | 1..* | Extension | Container holding the individual elements of the Alert extension. | |
Slices for extension | Content/Rules for all slices | |||
extension:webPASCategory | S | 1..1 | Extension | Raw alert category |
id | 0..0 | |||
extension | 0..0 | |||
url | 1..1 | uri | "webPASCategory" | |
value[x] | 1..1 | Coding | Value of extension Binding: NZ Central Region - Combined Alert Category Value Set (required) | |
id | 0..0 | |||
extension | 0..0 | |||
system | S | 1..1 | uri | Identity of the terminology system |
version | 0..0 | |||
code | S | 1..1 | code | Symbol in syntax defined by the system |
display | S | 1..1 | string | Representation defined by the system |
userSelected | 0..0 | |||
extension:severityLevel | S | 0..1 | Extension | Severity Level in range 0-9 for Allergy/Intolerance; 'W' for Alert/Flag |
id | 0..0 | |||
extension | 0..0 | |||
url | 1..1 | uri | "severityLevel" | |
value[x] | 0..1 | string | Value of extension | |
extension:allergyReaction | S | 0..1 | Extension | Allergy Reaction |
id | 0..0 | |||
extension | 0..0 | |||
url | 1..1 | uri | "allergyReaction" | |
value[x] | 0..1 | CodeableConcept | Value of extension Binding: NZ Central Region - Allergy Reaction Value Set (required) | |
id | 0..0 | |||
extension | 0..0 | |||
coding | S | 1..* | Coding | Multiple codings possible, one is original valuee from WebPAS... |
id | 0..0 | |||
extension | 0..0 | |||
system | S | 1..1 | uri | Identity of the terminology system |
version | 0..0 | |||
code | S | 1..1 | code | Symbol in syntax defined by the system |
display | S | 1..1 | string | Representation defined by the system |
userSelected | 0..0 | |||
text | 0..0 | |||
extension:inactiveDate | S | 0..1 | Extension | When will/did this alert stop being active? |
id | 0..0 | |||
extension | 0..0 | |||
url | 1..1 | uri | "inactiveDate" | |
value[x] | 1..1 | date | Value of extension | |
extension:reviewDate | S | 0..1 | Extension | When is this alert to be next reviewed? |
id | 0..0 | |||
extension | 0..0 | |||
url | 1..1 | uri | "reviewDate" | |
value[x] | 1..1 | date | Value of extension | |
extension:lastUpdatedBy | S | 0..1 | Extension | Who has updated the alert? (Not usually the authorising clinician) |
id | 0..0 | |||
extension | 0..0 | |||
url | 1..1 | uri | "lastUpdatedBy" | |
value[x] | 1..1 | string | Value of extension | |
extension:lastUpdatedDateTime | S | 0..1 | Extension | When was the alert last updated |
id | 0..0 | |||
extension | 0..0 | |||
url | 1..1 | uri | "lastUpdatedDateTime" | |
value[x] | 1..1 | dateTime | Value of extension | |
extension:recordingHospital | S | 0..1 | Extension | Which hospital/facility recorded the alert? |
id | 0..0 | |||
extension | 0..0 | |||
url | 1..1 | uri | "recordingHospital" | |
value[x] | 0..1 | CodeableConcept | Value of extension Binding: NZ Central Region - Hospital Value Set (extensible) | |
id | 0..0 | |||
extension | 0..0 | |||
coding | S | 1..* | Coding | Multiple codings possible, one is original value from WebPAS... |
id | 0..0 | |||
extension | 0..0 | |||
system | S | 1..1 | uri | Identity of the terminology system |
version | 0..0 | |||
code | S | 1..1 | code | Symbol in syntax defined by the system |
display | S | 0..1 | string | Representation defined by the system |
userSelected | 0..0 | |||
text | S | 0..1 | string | Describe received code values that are unable to be validated |
extension:comments | S | 0..1 | Extension | Free text comments |
id | 0..0 | |||
extension | 0..0 | |||
url | 1..1 | uri | "comments" | |
value[x] | 1..1 | string | Value of extension | |
url | 1..1 | uri | "https://standards.digital.health.nz/ns/central-region/alert" | |
value[x] | 0..0 | |||
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Extension | 0..* | Extension | NZ Central Region Alert | |
Slices for extension | 1..* | Extension | Container holding the individual elements of the Alert extension. Slice: Unordered, Open by value:url | |
extension:webPASCategory | S | 1..1 | Extension | Raw alert category |
extension | 0..0 | |||
url | 1..1 | uri | "webPASCategory" | |
value[x] | 1..1 | Coding | Value of extension Binding: NZ Central Region - Combined Alert Category Value Set (required) | |
extension | 0..0 | |||
system | SΣ | 1..1 | uri | Identity of the terminology system |
code | SΣ | 1..1 | code | Symbol in syntax defined by the system |
display | SΣ | 1..1 | string | Representation defined by the system |
extension:severityLevel | S | 0..1 | Extension | Severity Level in range 0-9 for Allergy/Intolerance; 'W' for Alert/Flag |
extension | 0..0 | |||
url | 1..1 | uri | "severityLevel" | |
value[x] | 0..1 | string | Value of extension | |
extension:allergyReaction | S | 0..1 | Extension | Allergy Reaction |
extension | 0..0 | |||
url | 1..1 | uri | "allergyReaction" | |
value[x] | 0..1 | CodeableConcept | Value of extension Binding: NZ Central Region - Allergy Reaction Value Set (required) | |
extension | 0..0 | |||
coding | SΣ | 1..* | Coding | Multiple codings possible, one is original valuee from WebPAS... |
extension | 0..0 | |||
system | SΣ | 1..1 | uri | Identity of the terminology system |
code | SΣ | 1..1 | code | Symbol in syntax defined by the system |
display | SΣ | 1..1 | string | Representation defined by the system |
extension:inactiveDate | S | 0..1 | Extension | When will/did this alert stop being active? |
extension | 0..0 | |||
url | 1..1 | uri | "inactiveDate" | |
value[x] | 1..1 | date | Value of extension | |
extension:reviewDate | S | 0..1 | Extension | When is this alert to be next reviewed? |
extension | 0..0 | |||
url | 1..1 | uri | "reviewDate" | |
value[x] | 1..1 | date | Value of extension | |
extension:lastUpdatedBy | S | 0..1 | Extension | Who has updated the alert? (Not usually the authorising clinician) |
extension | 0..0 | |||
url | 1..1 | uri | "lastUpdatedBy" | |
value[x] | 1..1 | string | Value of extension | |
extension:lastUpdatedDateTime | S | 0..1 | Extension | When was the alert last updated |
extension | 0..0 | |||
url | 1..1 | uri | "lastUpdatedDateTime" | |
value[x] | 1..1 | dateTime | Value of extension | |
extension:recordingHospital | S | 0..1 | Extension | Which hospital/facility recorded the alert? |
extension | 0..0 | |||
url | 1..1 | uri | "recordingHospital" | |
value[x] | 0..1 | CodeableConcept | Value of extension Binding: NZ Central Region - Hospital Value Set (extensible) | |
extension | 0..0 | |||
coding | SΣ | 1..* | Coding | Multiple codings possible, one is original value from WebPAS... |
extension | 0..0 | |||
system | SΣ | 1..1 | uri | Identity of the terminology system |
code | SΣ | 1..1 | code | Symbol in syntax defined by the system |
display | SΣ | 0..1 | string | Representation defined by the system |
text | SΣ | 0..1 | string | Describe received code values that are unable to be validated |
extension:comments | S | 0..1 | Extension | Free text comments |
extension | 0..0 | |||
url | 1..1 | uri | "comments" | |
value[x] | 1..1 | string | Value of extension | |
url | 1..1 | uri | "https://standards.digital.health.nz/ns/central-region/alert" | |
Documentation for this format |
This structure is derived from Extension
Summary
Complex Extension: Complex extension recording meta data about all alerts, on who recorded the Flag and AllergyIntolerance flavours of Alert and when.
Differential View
This structure is derived from Extension
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Extension | 0..* | Extension | NZ Central Region Alert | |
id | 0..0 | |||
extension | 1..* | Extension | Container holding the individual elements of the Alert extension. | |
Slices for extension | Content/Rules for all slices | |||
extension:webPASCategory | S | 1..1 | Extension | Raw alert category |
id | 0..0 | |||
extension | 0..0 | |||
url | 1..1 | uri | "webPASCategory" | |
value[x] | 1..1 | Coding | Value of extension Binding: NZ Central Region - Combined Alert Category Value Set (required) | |
id | 0..0 | |||
extension | 0..0 | |||
system | S | 1..1 | uri | Identity of the terminology system |
version | 0..0 | |||
code | S | 1..1 | code | Symbol in syntax defined by the system |
display | S | 1..1 | string | Representation defined by the system |
userSelected | 0..0 | |||
extension:severityLevel | S | 0..1 | Extension | Severity Level in range 0-9 for Allergy/Intolerance; 'W' for Alert/Flag |
id | 0..0 | |||
extension | 0..0 | |||
url | 1..1 | uri | "severityLevel" | |
value[x] | 0..1 | string | Value of extension | |
extension:allergyReaction | S | 0..1 | Extension | Allergy Reaction |
id | 0..0 | |||
extension | 0..0 | |||
url | 1..1 | uri | "allergyReaction" | |
value[x] | 0..1 | CodeableConcept | Value of extension Binding: NZ Central Region - Allergy Reaction Value Set (required) | |
id | 0..0 | |||
extension | 0..0 | |||
coding | S | 1..* | Coding | Multiple codings possible, one is original valuee from WebPAS... |
id | 0..0 | |||
extension | 0..0 | |||
system | S | 1..1 | uri | Identity of the terminology system |
version | 0..0 | |||
code | S | 1..1 | code | Symbol in syntax defined by the system |
display | S | 1..1 | string | Representation defined by the system |
userSelected | 0..0 | |||
text | 0..0 | |||
extension:inactiveDate | S | 0..1 | Extension | When will/did this alert stop being active? |
id | 0..0 | |||
extension | 0..0 | |||
url | 1..1 | uri | "inactiveDate" | |
value[x] | 1..1 | date | Value of extension | |
extension:reviewDate | S | 0..1 | Extension | When is this alert to be next reviewed? |
id | 0..0 | |||
extension | 0..0 | |||
url | 1..1 | uri | "reviewDate" | |
value[x] | 1..1 | date | Value of extension | |
extension:lastUpdatedBy | S | 0..1 | Extension | Who has updated the alert? (Not usually the authorising clinician) |
id | 0..0 | |||
extension | 0..0 | |||
url | 1..1 | uri | "lastUpdatedBy" | |
value[x] | 1..1 | string | Value of extension | |
extension:lastUpdatedDateTime | S | 0..1 | Extension | When was the alert last updated |
id | 0..0 | |||
extension | 0..0 | |||
url | 1..1 | uri | "lastUpdatedDateTime" | |
value[x] | 1..1 | dateTime | Value of extension | |
extension:recordingHospital | S | 0..1 | Extension | Which hospital/facility recorded the alert? |
id | 0..0 | |||
extension | 0..0 | |||
url | 1..1 | uri | "recordingHospital" | |
value[x] | 0..1 | CodeableConcept | Value of extension Binding: NZ Central Region - Hospital Value Set (extensible) | |
id | 0..0 | |||
extension | 0..0 | |||
coding | S | 1..* | Coding | Multiple codings possible, one is original value from WebPAS... |
id | 0..0 | |||
extension | 0..0 | |||
system | S | 1..1 | uri | Identity of the terminology system |
version | 0..0 | |||
code | S | 1..1 | code | Symbol in syntax defined by the system |
display | S | 0..1 | string | Representation defined by the system |
userSelected | 0..0 | |||
text | S | 0..1 | string | Describe received code values that are unable to be validated |
extension:comments | S | 0..1 | Extension | Free text comments |
id | 0..0 | |||
extension | 0..0 | |||
url | 1..1 | uri | "comments" | |
value[x] | 1..1 | string | Value of extension | |
url | 1..1 | uri | "https://standards.digital.health.nz/ns/central-region/alert" | |
value[x] | 0..0 | |||
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Extension | 0..* | Extension | NZ Central Region Alert | |
Slices for extension | 1..* | Extension | Container holding the individual elements of the Alert extension. Slice: Unordered, Open by value:url | |
extension:webPASCategory | S | 1..1 | Extension | Raw alert category |
extension | 0..0 | |||
url | 1..1 | uri | "webPASCategory" | |
value[x] | 1..1 | Coding | Value of extension Binding: NZ Central Region - Combined Alert Category Value Set (required) | |
extension | 0..0 | |||
system | SΣ | 1..1 | uri | Identity of the terminology system |
code | SΣ | 1..1 | code | Symbol in syntax defined by the system |
display | SΣ | 1..1 | string | Representation defined by the system |
extension:severityLevel | S | 0..1 | Extension | Severity Level in range 0-9 for Allergy/Intolerance; 'W' for Alert/Flag |
extension | 0..0 | |||
url | 1..1 | uri | "severityLevel" | |
value[x] | 0..1 | string | Value of extension | |
extension:allergyReaction | S | 0..1 | Extension | Allergy Reaction |
extension | 0..0 | |||
url | 1..1 | uri | "allergyReaction" | |
value[x] | 0..1 | CodeableConcept | Value of extension Binding: NZ Central Region - Allergy Reaction Value Set (required) | |
extension | 0..0 | |||
coding | SΣ | 1..* | Coding | Multiple codings possible, one is original valuee from WebPAS... |
extension | 0..0 | |||
system | SΣ | 1..1 | uri | Identity of the terminology system |
code | SΣ | 1..1 | code | Symbol in syntax defined by the system |
display | SΣ | 1..1 | string | Representation defined by the system |
extension:inactiveDate | S | 0..1 | Extension | When will/did this alert stop being active? |
extension | 0..0 | |||
url | 1..1 | uri | "inactiveDate" | |
value[x] | 1..1 | date | Value of extension | |
extension:reviewDate | S | 0..1 | Extension | When is this alert to be next reviewed? |
extension | 0..0 | |||
url | 1..1 | uri | "reviewDate" | |
value[x] | 1..1 | date | Value of extension | |
extension:lastUpdatedBy | S | 0..1 | Extension | Who has updated the alert? (Not usually the authorising clinician) |
extension | 0..0 | |||
url | 1..1 | uri | "lastUpdatedBy" | |
value[x] | 1..1 | string | Value of extension | |
extension:lastUpdatedDateTime | S | 0..1 | Extension | When was the alert last updated |
extension | 0..0 | |||
url | 1..1 | uri | "lastUpdatedDateTime" | |
value[x] | 1..1 | dateTime | Value of extension | |
extension:recordingHospital | S | 0..1 | Extension | Which hospital/facility recorded the alert? |
extension | 0..0 | |||
url | 1..1 | uri | "recordingHospital" | |
value[x] | 0..1 | CodeableConcept | Value of extension Binding: NZ Central Region - Hospital Value Set (extensible) | |
extension | 0..0 | |||
coding | SΣ | 1..* | Coding | Multiple codings possible, one is original value from WebPAS... |
extension | 0..0 | |||
system | SΣ | 1..1 | uri | Identity of the terminology system |
code | SΣ | 1..1 | code | Symbol in syntax defined by the system |
display | SΣ | 0..1 | string | Representation defined by the system |
text | SΣ | 0..1 | string | Describe received code values that are unable to be validated |
extension:comments | S | 0..1 | Extension | Free text comments |
extension | 0..0 | |||
url | 1..1 | uri | "comments" | |
value[x] | 1..1 | string | Value of extension | |
url | 1..1 | uri | "https://standards.digital.health.nz/ns/central-region/alert" | |
Documentation for this format |
Other representations of profile: CSV, Excel, Schematron
Path | Conformance | ValueSet | URI |
Extension.extension:webPASCategory.value[x] | required | NZCentralRegionCombinedAlertCategoryValueSet (a valid code from NZ Central Region - Alert Category Code System)https://standards.digital.health.nz/fhir/central-region/ValueSet-combined-alert-type from this IG | |
Extension.extension:allergyReaction.value[x] | required | NZCentralRegionAllergyReactionValueSethttps://standards.digital.health.nz/fhir/central-region/ValueSet-allergy-reaction from this IG | |
Extension.extension:recordingHospital.value[x] | extensible | NZCentralRegionHospitalValueSethttps://standards.digital.health.nz/fhir/central-region/ValueSet-hospital-code from this IG |
Id | Grade | Path(s) | Details | Requirements |
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() |