New Zealand ICP Implementation Guide
1.0.0 - release
New Zealand ICP Implementation Guide, published by Accident Compensation Corporation. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/acc-fhir-publisher/icp/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-measurement | Version: 1.0.0 | |||
Active as of 2022-11-20 | Computable Name: IcpMeasurement | |||
Copyright/Legal: ACC New Zealand© 2023+; Licensed Under Creative Commons No Rights Reserved. |
ACC Integrated Care Pathway Observation
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Observation
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | 0..* | Observation | Measurements and simple assertions | |
Slices for contained | 1..* | Resource | Contained, inline Resources Slice: Unordered, Closed by type:$this | |
contained:patient | 1..1 | IcpPatient | Patient's date of birth. | |
Slices for extension | 2..2 | Extension | Extension Slice: Unordered, Open by value:url | |
acc-providerid | 1..1 | string | The ACC provider ID associated with the ICP case URL: http://hl7.org.nz/fhir/StructureDefinition/acc-providerid | |
stage | 1..1 | code | The stage of the ICP case Observation. URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-recorded-outcome-stage Binding: ICP Recorded Outcome Stage (required) | |
Slices for identifier | 1..1 | Identifier | Business Identifier for observation Slice: Unordered, Closed by value:system | |
identifier:icpclaimnumber | 1..1 | Identifier | The ACC 45 number to be used in combination with the contained patient's date of birth, as the ICP case idenfitier. | |
id | 0..0 | |||
extension | 0..0 | |||
system | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/acc-45-number | |
value | C | 1..1 | string | The ACC 45 number. acc-claim-number: The claim number format is invalid; it must be in the form A999999, AA99999, 9999AAA or 99999AA, where A is any capital letter, 9 is any single digit, and there are 7 characters altogether. |
period | 0..0 | |||
assigner | 0..0 | |||
basedOn | 0..0 | |||
partOf | 0..0 | |||
status | 1..1 | code | final Binding: Observation Status (required) | |
category | 0..0 | |||
subject | 1..1 | Reference(ACC ICP Patient) | This is the patient that the ICP case is associated with. | |
focus | 0..0 | |||
encounter | 0..0 | |||
Slices for effective[x] | 1..1 | dateTime | Clinically relevant time/time-period for observation Slice: Unordered, Open by type:$this | |
effective[x]:effectiveDateTime | C | 1..1 | dateTime | The date and time that the ICP case Observation was created. This must be in UTC yyyy-MM-dd'T'HH:mm:ss'Z'. dateTime-not-in-future-invariant: The date value cannot be in the future |
issued | 0..0 | |||
performer | 1..1 | Reference(Organization) | This is the ACC Vendor ID, in most cases this is the organisation's HPI ID. | |
dataAbsentReason | 0..1 | CodeableConcept | The reason why the ICP case Observation value is not present. Binding: data-absent-reason (required) | |
interpretation | 0..0 | |||
note | 0..0 | |||
bodySite | 0..0 | |||
method | 0..0 | |||
specimen | 0..0 | |||
device | 0..0 | |||
referenceRange | 0..0 | |||
hasMember | 0..0 | |||
derivedFrom | 0..0 | |||
component | 0..0 | |||
Documentation for this format |
Path | Conformance | ValueSet | URI |
Observation.status | required | ICPObservationStatusVShttp://hl7.org.nz/fhir/ValueSet/acc-icp-observation-status from this IG | |
Observation.dataAbsentReason | required | ACCDataAbsentReason (a valid code from ACC Data Absent Reason)http://hl7.org.nz/fhir/ValueSet/acc-icp-data-absent-reason from this IG |
Id | Grade | Path(s) | Details | Requirements |
acc-claim-number | error | Observation.identifier:icpclaimnumber.value | The claim number format is invalid; it must be in the form A999999, AA99999, 9999AAA or 99999AA, where A is any capital letter, 9 is any single digit, and there are 7 characters altogether. : $this.toString().matches('^[A-Z][0-9]{6}$|^[A-Z]{2}[0-9]{5}$|^[0-9]{4}[A-Z]{3}$|^[0-9]{5}[A-Z]{2}$') | |
dateTime-not-in-future-invariant | error | Observation.effective[x]:effectiveDateTime | The date value cannot be in the future : $this <= now() |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | C | 0..* | Observation | Measurements and simple assertions obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for contained | 1..* | Resource | Contained, inline Resources Slice: Unordered, Closed by type:$this | |
contained:patient | 1..1 | IcpPatient | Patient's date of birth. | |
Slices for extension | 2..2 | Extension | Extension Slice: Unordered, Open by value:url | |
acc-providerid | 1..1 | string | The ACC provider ID associated with the ICP case URL: http://hl7.org.nz/fhir/StructureDefinition/acc-providerid | |
stage | 1..1 | code | The stage of the ICP case Observation. URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-recorded-outcome-stage Binding: ICP Recorded Outcome Stage (required) | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
Slices for identifier | Σ | 1..1 | Identifier | Business Identifier for observation Slice: Unordered, Closed by value:system |
identifier:icpclaimnumber | Σ | 1..1 | Identifier | The ACC 45 number to be used in combination with the contained patient's date of birth, as the ICP case idenfitier. |
extension | 0..0 | |||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/acc-45-number |
value | ΣC | 1..1 | string | The ACC 45 number. acc-claim-number: The claim number format is invalid; it must be in the form A999999, AA99999, 9999AAA or 99999AA, where A is any capital letter, 9 is any single digit, and there are 7 characters altogether. Example General: 123456 |
status | ?!Σ | 1..1 | code | final Binding: Observation Status (required) |
code | Σ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. |
subject | Σ | 1..1 | Reference(ACC ICP Patient) | This is the patient that the ICP case is associated with. |
Slices for effective[x] | Σ | 1..1 | dateTime | Clinically relevant time/time-period for observation Slice: Unordered, Closed by type:$this |
effective[x]:effectiveDateTime | ΣC | 1..1 | dateTime | The date and time that the ICP case Observation was created. This must be in UTC yyyy-MM-dd'T'HH:mm:ss'Z'. dateTime-not-in-future-invariant: The date value cannot be in the future |
performer | Σ | 1..1 | Reference(Organization) | This is the ACC Vendor ID, in most cases this is the organisation's HPI ID. |
dataAbsentReason | C | 0..1 | CodeableConcept | The reason why the ICP case Observation value is not present. Binding: data-absent-reason (required) |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Observation.identifier:icpclaimnumber.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Observation.status | required | ICPObservationStatusVShttp://hl7.org.nz/fhir/ValueSet/acc-icp-observation-status from this IG | |
Observation.code | example | LOINCCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codes from the FHIR Standard | |
Observation.dataAbsentReason | required | ACCDataAbsentReason (a valid code from ACC Data Absent Reason)http://hl7.org.nz/fhir/ValueSet/acc-icp-data-absent-reason from this IG | |
Observation.component.code | example | LOINCCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codes from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
acc-claim-number | error | Observation.identifier:icpclaimnumber.value | The claim number format is invalid; it must be in the form A999999, AA99999, 9999AAA or 99999AA, where A is any capital letter, 9 is any single digit, and there are 7 characters altogether. : $this.toString().matches('^[A-Z][0-9]{6}$|^[A-Z]{2}[0-9]{5}$|^[0-9]{4}[A-Z]{3}$|^[0-9]{5}[A-Z]{2}$') | |
dateTime-not-in-future-invariant | error | Observation.effective[x]:effectiveDateTime | The date value cannot be in the future : $this <= now() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Observation | C | 0..* | Observation | Measurements and simple assertions obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
Slices for contained | 1..* | Resource | Contained, inline Resources Slice: Unordered, Closed by type:$this | |||||
contained:patient | 1..1 | IcpPatient | Patient's date of birth. | |||||
Slices for extension | 2..2 | Extension | Extension Slice: Unordered, Open by value:url | |||||
acc-providerid | 1..1 | string | The ACC provider ID associated with the ICP case URL: http://hl7.org.nz/fhir/StructureDefinition/acc-providerid | |||||
stage | 1..1 | code | The stage of the ICP case Observation. URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-recorded-outcome-stage Binding: ICP Recorded Outcome Stage (required) | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | Σ | 1..1 | Identifier | Business Identifier for observation Slice: Unordered, Closed by value:system | ||||
identifier:icpclaimnumber | Σ | 1..1 | Identifier | The ACC 45 number to be used in combination with the contained patient's date of birth, as the ICP case idenfitier. | ||||
extension | 0..0 | |||||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/acc-45-number | ||||
value | ΣC | 1..1 | string | The ACC 45 number. acc-claim-number: The claim number format is invalid; it must be in the form A999999, AA99999, 9999AAA or 99999AA, where A is any capital letter, 9 is any single digit, and there are 7 characters altogether. Example General: 123456 | ||||
status | ?!Σ | 1..1 | code | final Binding: Observation Status (required) | ||||
code | Σ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. | ||||
subject | Σ | 1..1 | Reference(ACC ICP Patient) | This is the patient that the ICP case is associated with. | ||||
Slices for effective[x] | Σ | 1..1 | dateTime | Clinically relevant time/time-period for observation Slice: Unordered, Closed by type:$this | ||||
effective[x]:effectiveDateTime | ΣC | 1..1 | dateTime | The date and time that the ICP case Observation was created. This must be in UTC yyyy-MM-dd'T'HH:mm:ss'Z'. dateTime-not-in-future-invariant: The date value cannot be in the future | ||||
performer | Σ | 1..1 | Reference(Organization) | This is the ACC Vendor ID, in most cases this is the organisation's HPI ID. | ||||
value[x] | ΣC | 0..1 | Actual result | |||||
valueQuantity | Quantity | |||||||
valueCodeableConcept | CodeableConcept | |||||||
valueString | string | |||||||
valueBoolean | boolean | |||||||
valueInteger | integer | |||||||
valueRange | Range | |||||||
valueRatio | Ratio | |||||||
valueSampledData | SampledData | |||||||
valueTime | time | |||||||
valueDateTime | dateTime | |||||||
valuePeriod | Period | |||||||
dataAbsentReason | C | 0..1 | CodeableConcept | The reason why the ICP case Observation value is not present. Binding: data-absent-reason (required) | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Observation.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Observation.identifier:icpclaimnumber.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Observation.identifier:icpclaimnumber.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Observation.status | required | ICPObservationStatusVShttp://hl7.org.nz/fhir/ValueSet/acc-icp-observation-status from this IG | ||||
Observation.code | example | LOINCCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codes from the FHIR Standard | ||||
Observation.dataAbsentReason | required | ACCDataAbsentReason (a valid code from ACC Data Absent Reason)http://hl7.org.nz/fhir/ValueSet/acc-icp-data-absent-reason from this IG | ||||
Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodeshttp://hl7.org/fhir/ValueSet/referencerange-meaning from the FHIR Standard | ||||
Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodeshttp://hl7.org/fhir/ValueSet/referencerange-appliesto from the FHIR Standard | ||||
Observation.component.code | example | LOINCCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codes from the FHIR Standard | ||||
Observation.component.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard | ||||
Observation.component.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretation from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
acc-claim-number | error | Observation.identifier:icpclaimnumber.value | The claim number format is invalid; it must be in the form A999999, AA99999, 9999AAA or 99999AA, where A is any capital letter, 9 is any single digit, and there are 7 characters altogether. : $this.toString().matches('^[A-Z][0-9]{6}$|^[A-Z]{2}[0-9]{5}$|^[0-9]{4}[A-Z]{3}$|^[0-9]{5}[A-Z]{2}$') | |
dateTime-not-in-future-invariant | error | Observation.effective[x]:effectiveDateTime | The date value cannot be in the future : $this <= now() |
This structure is derived from Observation
Summary
Mandatory: 12 elements
Fixed: 1 element
Prohibited: 20 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Observation
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | 0..* | Observation | Measurements and simple assertions | |
Slices for contained | 1..* | Resource | Contained, inline Resources Slice: Unordered, Closed by type:$this | |
contained:patient | 1..1 | IcpPatient | Patient's date of birth. | |
Slices for extension | 2..2 | Extension | Extension Slice: Unordered, Open by value:url | |
acc-providerid | 1..1 | string | The ACC provider ID associated with the ICP case URL: http://hl7.org.nz/fhir/StructureDefinition/acc-providerid | |
stage | 1..1 | code | The stage of the ICP case Observation. URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-recorded-outcome-stage Binding: ICP Recorded Outcome Stage (required) | |
Slices for identifier | 1..1 | Identifier | Business Identifier for observation Slice: Unordered, Closed by value:system | |
identifier:icpclaimnumber | 1..1 | Identifier | The ACC 45 number to be used in combination with the contained patient's date of birth, as the ICP case idenfitier. | |
id | 0..0 | |||
extension | 0..0 | |||
system | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/acc-45-number | |
value | C | 1..1 | string | The ACC 45 number. acc-claim-number: The claim number format is invalid; it must be in the form A999999, AA99999, 9999AAA or 99999AA, where A is any capital letter, 9 is any single digit, and there are 7 characters altogether. |
period | 0..0 | |||
assigner | 0..0 | |||
basedOn | 0..0 | |||
partOf | 0..0 | |||
status | 1..1 | code | final Binding: Observation Status (required) | |
category | 0..0 | |||
subject | 1..1 | Reference(ACC ICP Patient) | This is the patient that the ICP case is associated with. | |
focus | 0..0 | |||
encounter | 0..0 | |||
Slices for effective[x] | 1..1 | dateTime | Clinically relevant time/time-period for observation Slice: Unordered, Open by type:$this | |
effective[x]:effectiveDateTime | C | 1..1 | dateTime | The date and time that the ICP case Observation was created. This must be in UTC yyyy-MM-dd'T'HH:mm:ss'Z'. dateTime-not-in-future-invariant: The date value cannot be in the future |
issued | 0..0 | |||
performer | 1..1 | Reference(Organization) | This is the ACC Vendor ID, in most cases this is the organisation's HPI ID. | |
dataAbsentReason | 0..1 | CodeableConcept | The reason why the ICP case Observation value is not present. Binding: data-absent-reason (required) | |
interpretation | 0..0 | |||
note | 0..0 | |||
bodySite | 0..0 | |||
method | 0..0 | |||
specimen | 0..0 | |||
device | 0..0 | |||
referenceRange | 0..0 | |||
hasMember | 0..0 | |||
derivedFrom | 0..0 | |||
component | 0..0 | |||
Documentation for this format |
Path | Conformance | ValueSet | URI |
Observation.status | required | ICPObservationStatusVShttp://hl7.org.nz/fhir/ValueSet/acc-icp-observation-status from this IG | |
Observation.dataAbsentReason | required | ACCDataAbsentReason (a valid code from ACC Data Absent Reason)http://hl7.org.nz/fhir/ValueSet/acc-icp-data-absent-reason from this IG |
Id | Grade | Path(s) | Details | Requirements |
acc-claim-number | error | Observation.identifier:icpclaimnumber.value | The claim number format is invalid; it must be in the form A999999, AA99999, 9999AAA or 99999AA, where A is any capital letter, 9 is any single digit, and there are 7 characters altogether. : $this.toString().matches('^[A-Z][0-9]{6}$|^[A-Z]{2}[0-9]{5}$|^[0-9]{4}[A-Z]{3}$|^[0-9]{5}[A-Z]{2}$') | |
dateTime-not-in-future-invariant | error | Observation.effective[x]:effectiveDateTime | The date value cannot be in the future : $this <= now() |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | C | 0..* | Observation | Measurements and simple assertions obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for contained | 1..* | Resource | Contained, inline Resources Slice: Unordered, Closed by type:$this | |
contained:patient | 1..1 | IcpPatient | Patient's date of birth. | |
Slices for extension | 2..2 | Extension | Extension Slice: Unordered, Open by value:url | |
acc-providerid | 1..1 | string | The ACC provider ID associated with the ICP case URL: http://hl7.org.nz/fhir/StructureDefinition/acc-providerid | |
stage | 1..1 | code | The stage of the ICP case Observation. URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-recorded-outcome-stage Binding: ICP Recorded Outcome Stage (required) | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
Slices for identifier | Σ | 1..1 | Identifier | Business Identifier for observation Slice: Unordered, Closed by value:system |
identifier:icpclaimnumber | Σ | 1..1 | Identifier | The ACC 45 number to be used in combination with the contained patient's date of birth, as the ICP case idenfitier. |
extension | 0..0 | |||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/acc-45-number |
value | ΣC | 1..1 | string | The ACC 45 number. acc-claim-number: The claim number format is invalid; it must be in the form A999999, AA99999, 9999AAA or 99999AA, where A is any capital letter, 9 is any single digit, and there are 7 characters altogether. Example General: 123456 |
status | ?!Σ | 1..1 | code | final Binding: Observation Status (required) |
code | Σ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. |
subject | Σ | 1..1 | Reference(ACC ICP Patient) | This is the patient that the ICP case is associated with. |
Slices for effective[x] | Σ | 1..1 | dateTime | Clinically relevant time/time-period for observation Slice: Unordered, Closed by type:$this |
effective[x]:effectiveDateTime | ΣC | 1..1 | dateTime | The date and time that the ICP case Observation was created. This must be in UTC yyyy-MM-dd'T'HH:mm:ss'Z'. dateTime-not-in-future-invariant: The date value cannot be in the future |
performer | Σ | 1..1 | Reference(Organization) | This is the ACC Vendor ID, in most cases this is the organisation's HPI ID. |
dataAbsentReason | C | 0..1 | CodeableConcept | The reason why the ICP case Observation value is not present. Binding: data-absent-reason (required) |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Observation.identifier:icpclaimnumber.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Observation.status | required | ICPObservationStatusVShttp://hl7.org.nz/fhir/ValueSet/acc-icp-observation-status from this IG | |
Observation.code | example | LOINCCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codes from the FHIR Standard | |
Observation.dataAbsentReason | required | ACCDataAbsentReason (a valid code from ACC Data Absent Reason)http://hl7.org.nz/fhir/ValueSet/acc-icp-data-absent-reason from this IG | |
Observation.component.code | example | LOINCCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codes from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
acc-claim-number | error | Observation.identifier:icpclaimnumber.value | The claim number format is invalid; it must be in the form A999999, AA99999, 9999AAA or 99999AA, where A is any capital letter, 9 is any single digit, and there are 7 characters altogether. : $this.toString().matches('^[A-Z][0-9]{6}$|^[A-Z]{2}[0-9]{5}$|^[0-9]{4}[A-Z]{3}$|^[0-9]{5}[A-Z]{2}$') | |
dateTime-not-in-future-invariant | error | Observation.effective[x]:effectiveDateTime | The date value cannot be in the future : $this <= now() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Observation | C | 0..* | Observation | Measurements and simple assertions obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
Slices for contained | 1..* | Resource | Contained, inline Resources Slice: Unordered, Closed by type:$this | |||||
contained:patient | 1..1 | IcpPatient | Patient's date of birth. | |||||
Slices for extension | 2..2 | Extension | Extension Slice: Unordered, Open by value:url | |||||
acc-providerid | 1..1 | string | The ACC provider ID associated with the ICP case URL: http://hl7.org.nz/fhir/StructureDefinition/acc-providerid | |||||
stage | 1..1 | code | The stage of the ICP case Observation. URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-recorded-outcome-stage Binding: ICP Recorded Outcome Stage (required) | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | Σ | 1..1 | Identifier | Business Identifier for observation Slice: Unordered, Closed by value:system | ||||
identifier:icpclaimnumber | Σ | 1..1 | Identifier | The ACC 45 number to be used in combination with the contained patient's date of birth, as the ICP case idenfitier. | ||||
extension | 0..0 | |||||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/acc-45-number | ||||
value | ΣC | 1..1 | string | The ACC 45 number. acc-claim-number: The claim number format is invalid; it must be in the form A999999, AA99999, 9999AAA or 99999AA, where A is any capital letter, 9 is any single digit, and there are 7 characters altogether. Example General: 123456 | ||||
status | ?!Σ | 1..1 | code | final Binding: Observation Status (required) | ||||
code | Σ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. | ||||
subject | Σ | 1..1 | Reference(ACC ICP Patient) | This is the patient that the ICP case is associated with. | ||||
Slices for effective[x] | Σ | 1..1 | dateTime | Clinically relevant time/time-period for observation Slice: Unordered, Closed by type:$this | ||||
effective[x]:effectiveDateTime | ΣC | 1..1 | dateTime | The date and time that the ICP case Observation was created. This must be in UTC yyyy-MM-dd'T'HH:mm:ss'Z'. dateTime-not-in-future-invariant: The date value cannot be in the future | ||||
performer | Σ | 1..1 | Reference(Organization) | This is the ACC Vendor ID, in most cases this is the organisation's HPI ID. | ||||
value[x] | ΣC | 0..1 | Actual result | |||||
valueQuantity | Quantity | |||||||
valueCodeableConcept | CodeableConcept | |||||||
valueString | string | |||||||
valueBoolean | boolean | |||||||
valueInteger | integer | |||||||
valueRange | Range | |||||||
valueRatio | Ratio | |||||||
valueSampledData | SampledData | |||||||
valueTime | time | |||||||
valueDateTime | dateTime | |||||||
valuePeriod | Period | |||||||
dataAbsentReason | C | 0..1 | CodeableConcept | The reason why the ICP case Observation value is not present. Binding: data-absent-reason (required) | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Observation.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Observation.identifier:icpclaimnumber.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Observation.identifier:icpclaimnumber.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Observation.status | required | ICPObservationStatusVShttp://hl7.org.nz/fhir/ValueSet/acc-icp-observation-status from this IG | ||||
Observation.code | example | LOINCCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codes from the FHIR Standard | ||||
Observation.dataAbsentReason | required | ACCDataAbsentReason (a valid code from ACC Data Absent Reason)http://hl7.org.nz/fhir/ValueSet/acc-icp-data-absent-reason from this IG | ||||
Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodeshttp://hl7.org/fhir/ValueSet/referencerange-meaning from the FHIR Standard | ||||
Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodeshttp://hl7.org/fhir/ValueSet/referencerange-appliesto from the FHIR Standard | ||||
Observation.component.code | example | LOINCCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codes from the FHIR Standard | ||||
Observation.component.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard | ||||
Observation.component.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretation from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
acc-claim-number | error | Observation.identifier:icpclaimnumber.value | The claim number format is invalid; it must be in the form A999999, AA99999, 9999AAA or 99999AA, where A is any capital letter, 9 is any single digit, and there are 7 characters altogether. : $this.toString().matches('^[A-Z][0-9]{6}$|^[A-Z]{2}[0-9]{5}$|^[0-9]{4}[A-Z]{3}$|^[0-9]{5}[A-Z]{2}$') | |
dateTime-not-in-future-invariant | error | Observation.effective[x]:effectiveDateTime | The date value cannot be in the future : $this <= now() |
This structure is derived from Observation
Summary
Mandatory: 12 elements
Fixed: 1 element
Prohibited: 20 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron