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-prom | Version: 1.0.0 | |||
Active as of 2022-11-20 | Computable Name: IcpMeasurementPROM | |||
Copyright/Legal: ACC New Zealand© 2023+; Licensed Under Creative Commons No Rights Reserved. |
This resource profile supports suppliers providing a site-specific patient reported outcome measure (PROM) to ACC.
These PROMS must be submitted through the PROM and Clinical measures API via the supplier's PMS at these time-points:
Body site | Measurement standard | Measurement |
---|---|---|
Shoulder | QuickDASH | QuickDASH values range from 0 to 100 |
Lower back | Oswestry Disability Index | Oswestry values 0 to 100 |
Knee | Knee Injury and Osteoarthritis Outcome Score (KOOS) | KOOS values 0 to 100 |
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | IcpMeasurement | Measurements and simple assertions dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management 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 require-data-absent-or-value-integer-invariant: Either DataAbsentReason or ValueInteger must exist. |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
1..* | Resource | Contained, inline Resources Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() ![]() |
1..1 | IcpPatient | Patient's date of birth. | |
![]() ![]() ![]() |
2..2 | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() |
1..1 | string | The ACC provider ID associated with the ICP case URL: http://hl7.org.nz/fhir/StructureDefinition/acc-providerid ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() |
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) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() |
Σ | 1..1 | Identifier | Business Identifier for observation Slice: Unordered, Closed by value:system ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
Σ | 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. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Fixed Value: https://standards.digital.health.nz/ns/acc-45-number |
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | string | The ACC 45 number. ele-1: All FHIR elements must have a @value or children 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 |
![]() ![]() ![]() |
?!Σ | 1..1 | code | final Binding: Observation Status (required) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: prom-msk-measurement-standard (required) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 1..1 | Reference(ACC ICP Patient) | This is the patient that the ICP case is associated with. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 1..1 | dateTime | Clinically relevant time/time-period for observation Slice: Unordered, Closed by type:$this ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
Σ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'. ele-1: All FHIR elements must have a @value or children dateTime-not-in-future-invariant: The date value cannot be in the future |
![]() ![]() ![]() |
Σ | 1..1 | Reference(Organization) | This is the ACC Vendor ID, in most cases this is the organisation's HPI ID. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
ΣC | 0..1 | Actual result Slice: Unordered, Open by type:$this ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() ![]() |
Quantity | |||
![]() ![]() ![]() ![]() |
CodeableConcept | |||
![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() ![]() |
boolean | |||
![]() ![]() ![]() ![]() |
integer | |||
![]() ![]() ![]() ![]() |
Range | |||
![]() ![]() ![]() ![]() |
Ratio | |||
![]() ![]() ![]() ![]() |
SampledData | |||
![]() ![]() ![]() ![]() |
time | |||
![]() ![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() ![]() |
Period | |||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | integer | The PROM assessment score. ele-1: All FHIR elements must have a @value or children prom-quantity-invariant: The value must be between 0 and 100. |
![]() |
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 | required | ICPPromMskMeasurementStandard (a valid code from prom-msk-measurement-standard)http://hl7.org.nz/fhir/ValueSet/acc-icp-prom-msk-measurement-standard 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 |
prom-quantity-invariant | error | Observation.value[x]:valueInteger | The value must be between 0 and 100. : $this.value.toString().matches('^(?:0*|[1-9][0-9]?|100)$') | |
require-data-absent-or-value-integer-invariant | error | Observation | Either DataAbsentReason or ValueInteger must exist. : exists(dataAbsentReason) or exists(valueInteger) |
This structure is derived from IcpMeasurement
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | IcpMeasurement | Measurements and simple assertions require-data-absent-or-value-integer-invariant: Either DataAbsentReason or ValueInteger must exist. |
![]() ![]() ![]() |
1..1 | CodeableConcept | Type of observation (code / type) Binding: prom-msk-measurement-standard (required) | |
![]() ![]() ![]() |
0..1 | Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period | Actual result Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() |
C | 0..1 | integer | The PROM assessment score. prom-quantity-invariant: The value must be between 0 and 100. |
![]() |
Path | Conformance | ValueSet | URI |
Observation.code | required | ICPPromMskMeasurementStandard (a valid code from prom-msk-measurement-standard)http://hl7.org.nz/fhir/ValueSet/acc-icp-prom-msk-measurement-standard from this IG |
Id | Grade | Path(s) | Details | Requirements |
prom-quantity-invariant | error | Observation.value[x]:valueInteger | The value must be between 0 and 100. : $this.value.toString().matches('^(?:0*|[1-9][0-9]?|100)$') | |
require-data-absent-or-value-integer-invariant | error | Observation | Either DataAbsentReason or ValueInteger must exist. : exists(dataAbsentReason) or exists(valueInteger) |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | IcpMeasurement | 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 require-data-absent-or-value-integer-invariant: Either DataAbsentReason or ValueInteger must exist. | ||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 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 | |||||
![]() ![]() ![]() |
1..* | Resource | Contained, inline Resources Slice: Unordered, Closed by type:$this | |||||
![]() ![]() ![]() ![]() |
1..1 | IcpPatient | Patient's date of birth. | |||||
![]() ![]() ![]() |
2..2 | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
1..1 | string | The ACC provider ID associated with the ICP case URL: http://hl7.org.nz/fhir/StructureDefinition/acc-providerid | |||||
![]() ![]() ![]() ![]() |
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) | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 1..1 | Identifier | Business Identifier for observation Slice: Unordered, Closed by value:system | ||||
![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/acc-45-number | ||||
![]() ![]() ![]() ![]() ![]() |
Σ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 | ||||
![]() ![]() ![]() |
?!Σ | 1..1 | code | final Binding: Observation Status (required) | ||||
![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: prom-msk-measurement-standard (required) | ||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(ACC ICP Patient) | This is the patient that the ICP case is associated with. | ||||
![]() ![]() ![]() |
Σ | 1..1 | dateTime | Clinically relevant time/time-period for observation Slice: Unordered, Closed by type:$this | ||||
![]() ![]() ![]() ![]() |
Σ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 | ||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(Organization) | This is the ACC Vendor ID, in most cases this is the organisation's HPI ID. | ||||
![]() ![]() ![]() |
ΣC | 0..1 | Actual result Slice: Unordered, Open by type:$this | |||||
![]() ![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() |
integer | |||||||
![]() ![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() ![]() |
Ratio | |||||||
![]() ![]() ![]() ![]() |
SampledData | |||||||
![]() ![]() ![]() ![]() |
time | |||||||
![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | integer | The PROM assessment score. prom-quantity-invariant: The value must be between 0 and 100. | ||||
![]() ![]() ![]() |
C | 0..1 | CodeableConcept | The reason why the ICP case Observation value is not present. Binding: data-absent-reason (required) | ||||
![]() |
Path | Conformance | ValueSet | URI | |||
Observation.language | preferred | CommonLanguageshttp://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 | required | ICPPromMskMeasurementStandard (a valid code from prom-msk-measurement-standard)http://hl7.org.nz/fhir/ValueSet/acc-icp-prom-msk-measurement-standard 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 | ||||
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 |
prom-quantity-invariant | error | Observation.value[x]:valueInteger | The value must be between 0 and 100. : $this.value.toString().matches('^(?:0*|[1-9][0-9]?|100)$') | |
require-data-absent-or-value-integer-invariant | error | Observation | Either DataAbsentReason or ValueInteger must exist. : exists(dataAbsentReason) or exists(valueInteger) |
This structure is derived from IcpMeasurement
Summary
Slices
This structure defines the following Slices:
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | IcpMeasurement | Measurements and simple assertions dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management 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 require-data-absent-or-value-integer-invariant: Either DataAbsentReason or ValueInteger must exist. |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
1..* | Resource | Contained, inline Resources Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() ![]() |
1..1 | IcpPatient | Patient's date of birth. | |
![]() ![]() ![]() |
2..2 | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() |
1..1 | string | The ACC provider ID associated with the ICP case URL: http://hl7.org.nz/fhir/StructureDefinition/acc-providerid ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() |
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) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() |
Σ | 1..1 | Identifier | Business Identifier for observation Slice: Unordered, Closed by value:system ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
Σ | 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. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Fixed Value: https://standards.digital.health.nz/ns/acc-45-number |
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | string | The ACC 45 number. ele-1: All FHIR elements must have a @value or children 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 |
![]() ![]() ![]() |
?!Σ | 1..1 | code | final Binding: Observation Status (required) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: prom-msk-measurement-standard (required) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 1..1 | Reference(ACC ICP Patient) | This is the patient that the ICP case is associated with. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 1..1 | dateTime | Clinically relevant time/time-period for observation Slice: Unordered, Closed by type:$this ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
Σ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'. ele-1: All FHIR elements must have a @value or children dateTime-not-in-future-invariant: The date value cannot be in the future |
![]() ![]() ![]() |
Σ | 1..1 | Reference(Organization) | This is the ACC Vendor ID, in most cases this is the organisation's HPI ID. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
ΣC | 0..1 | Actual result Slice: Unordered, Open by type:$this ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() ![]() |
Quantity | |||
![]() ![]() ![]() ![]() |
CodeableConcept | |||
![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() ![]() |
boolean | |||
![]() ![]() ![]() ![]() |
integer | |||
![]() ![]() ![]() ![]() |
Range | |||
![]() ![]() ![]() ![]() |
Ratio | |||
![]() ![]() ![]() ![]() |
SampledData | |||
![]() ![]() ![]() ![]() |
time | |||
![]() ![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() ![]() |
Period | |||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | integer | The PROM assessment score. ele-1: All FHIR elements must have a @value or children prom-quantity-invariant: The value must be between 0 and 100. |
![]() |
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 | required | ICPPromMskMeasurementStandard (a valid code from prom-msk-measurement-standard)http://hl7.org.nz/fhir/ValueSet/acc-icp-prom-msk-measurement-standard 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 |
prom-quantity-invariant | error | Observation.value[x]:valueInteger | The value must be between 0 and 100. : $this.value.toString().matches('^(?:0*|[1-9][0-9]?|100)$') | |
require-data-absent-or-value-integer-invariant | error | Observation | Either DataAbsentReason or ValueInteger must exist. : exists(dataAbsentReason) or exists(valueInteger) |
Differential View
This structure is derived from IcpMeasurement
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | IcpMeasurement | Measurements and simple assertions require-data-absent-or-value-integer-invariant: Either DataAbsentReason or ValueInteger must exist. |
![]() ![]() ![]() |
1..1 | CodeableConcept | Type of observation (code / type) Binding: prom-msk-measurement-standard (required) | |
![]() ![]() ![]() |
0..1 | Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period | Actual result Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() |
C | 0..1 | integer | The PROM assessment score. prom-quantity-invariant: The value must be between 0 and 100. |
![]() |
Path | Conformance | ValueSet | URI |
Observation.code | required | ICPPromMskMeasurementStandard (a valid code from prom-msk-measurement-standard)http://hl7.org.nz/fhir/ValueSet/acc-icp-prom-msk-measurement-standard from this IG |
Id | Grade | Path(s) | Details | Requirements |
prom-quantity-invariant | error | Observation.value[x]:valueInteger | The value must be between 0 and 100. : $this.value.toString().matches('^(?:0*|[1-9][0-9]?|100)$') | |
require-data-absent-or-value-integer-invariant | error | Observation | Either DataAbsentReason or ValueInteger must exist. : exists(dataAbsentReason) or exists(valueInteger) |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | IcpMeasurement | 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 require-data-absent-or-value-integer-invariant: Either DataAbsentReason or ValueInteger must exist. | ||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 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 | |||||
![]() ![]() ![]() |
1..* | Resource | Contained, inline Resources Slice: Unordered, Closed by type:$this | |||||
![]() ![]() ![]() ![]() |
1..1 | IcpPatient | Patient's date of birth. | |||||
![]() ![]() ![]() |
2..2 | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
1..1 | string | The ACC provider ID associated with the ICP case URL: http://hl7.org.nz/fhir/StructureDefinition/acc-providerid | |||||
![]() ![]() ![]() ![]() |
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) | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 1..1 | Identifier | Business Identifier for observation Slice: Unordered, Closed by value:system | ||||
![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/acc-45-number | ||||
![]() ![]() ![]() ![]() ![]() |
Σ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 | ||||
![]() ![]() ![]() |
?!Σ | 1..1 | code | final Binding: Observation Status (required) | ||||
![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: prom-msk-measurement-standard (required) | ||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(ACC ICP Patient) | This is the patient that the ICP case is associated with. | ||||
![]() ![]() ![]() |
Σ | 1..1 | dateTime | Clinically relevant time/time-period for observation Slice: Unordered, Closed by type:$this | ||||
![]() ![]() ![]() ![]() |
Σ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 | ||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(Organization) | This is the ACC Vendor ID, in most cases this is the organisation's HPI ID. | ||||
![]() ![]() ![]() |
ΣC | 0..1 | Actual result Slice: Unordered, Open by type:$this | |||||
![]() ![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() |
integer | |||||||
![]() ![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() ![]() |
Ratio | |||||||
![]() ![]() ![]() ![]() |
SampledData | |||||||
![]() ![]() ![]() ![]() |
time | |||||||
![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | integer | The PROM assessment score. prom-quantity-invariant: The value must be between 0 and 100. | ||||
![]() ![]() ![]() |
C | 0..1 | CodeableConcept | The reason why the ICP case Observation value is not present. Binding: data-absent-reason (required) | ||||
![]() |
Path | Conformance | ValueSet | URI | |||
Observation.language | preferred | CommonLanguageshttp://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 | required | ICPPromMskMeasurementStandard (a valid code from prom-msk-measurement-standard)http://hl7.org.nz/fhir/ValueSet/acc-icp-prom-msk-measurement-standard 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 | ||||
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 |
prom-quantity-invariant | error | Observation.value[x]:valueInteger | The value must be between 0 and 100. : $this.value.toString().matches('^(?:0*|[1-9][0-9]?|100)$') | |
require-data-absent-or-value-integer-invariant | error | Observation | Either DataAbsentReason or ValueInteger must exist. : exists(dataAbsentReason) or exists(valueInteger) |
This structure is derived from IcpMeasurement
Summary
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
IG © 2023+ Accident Compensation Corporation. Package hl7.org.nz.fhir.ig.icp#1.0.0 based on FHIR 4.0.1. Generated 2025-01-20
Links: Table of Contents |
QA Report