New Zealand ICP Implementation Guide
1.1.0 - draft
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.1.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-case-modify | Version: 1.1.0 | |||
| Active as of 2022-11-20 | Computable Name: IcpCaseModify | |||
Copyright/Legal: ACC New Zealand© 2023+; Licensed Under Creative Commons No Rights Reserved. |
||||
This profile supports suppliers needing to inform ACC of a change to the selected Service Bundle and/or Exceptional Funding Required.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from IcpCase
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | IcpCase | An association of a Patient with an Organization and Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility Constraints: active-status-invariant |
![]() ![]() |
1..* | Resource | Contained, inline Resources | |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
1..1 | IcpPatient | Information about an individual or animal receiving health care services | |
![]() ![]() |
2..3 | Extension | Extension | |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
1..1 | (Complex) | The updated ICP service bundle for the treatment. URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-service-bundle-change | |
![]() ![]() ![]() |
0..1 | (Complex) | Indicates if exceptionalfunding is required for this treatment and the funding type. URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-exceptional-funding | |
![]() ![]() |
1..1 | code | active | finished | |
![]() ![]() |
0..0 | The type of ICP service. Currently only musculoskeletal (msk) is allowed, with more to be added in the future, e.g. concussion. | ||
![]() ![]() |
0..0 | Interval during responsibility is assumed | ||
Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| active-status-invariant | error | EpisodeOfCare | The status attribute must be set to 'active'. |
status = 'active'
|
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | IcpCase | An association of a Patient with an Organization and Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility Constraints: end-date-when-active-invariant, end-date-when-finished-invariant, active-status-invariant |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
1..* | Resource | Contained, inline Resources Slice: Unordered, Open by profile:$this | |
![]() ![]() ![]() |
1..1 | IcpPatient | Information about an individual or animal receiving health care services | |
![]() ![]() |
2..3 | 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 | (Complex) | The updated ICP service bundle for the treatment. URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-service-bundle-change | |
![]() ![]() ![]() |
0..1 | (Complex) | Indicates if exceptionalfunding is required for this treatment and the funding type. URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-exceptional-funding | |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
1..1 | Identifier | Business Identifier(s) relevant for this EpisodeOfCare Slice: Unordered, Open 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 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() |
Σ | 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. Constraints: acc-claim-number Example General: 123456 |
![]() ![]() |
?!Σ | 1..1 | code | active | finished Binding: Status (required) |
![]() ![]() |
Σ | 1..1 | Reference(ACC ICP Patient) | The patient who is the focus of this episode of care |
![]() ![]() |
Σ | 1..1 | Reference(Organization) | This is the ACC Vendor ID, in most cases this is the organisation's HPI ID. |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| EpisodeOfCare.identifier:icpclaimnumber.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| EpisodeOfCare.status | Base | required | Status | 📦1.1.0 | This IG |
| EpisodeOfCare.statusHistory.status | Base | required | EpisodeOfCareStatus | 📍4.0.1 | FHIR Std. |
| EpisodeOfCare.type.coding.code | Base | required | Service Type | 📦1.1.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| acc-claim-number | error | EpisodeOfCare.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}$')
|
| active-status-invariant | error | EpisodeOfCare | The status attribute must be set to 'active'. |
status = 'active'
|
| dom-2 | error | EpisodeOfCare | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | EpisodeOfCare | 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 | EpisodeOfCare | 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 | EpisodeOfCare | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | EpisodeOfCare | 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())
|
| end-date-when-active-invariant | error | EpisodeOfCare | End date is not allowed when status is active |
status = 'active' implies period.end.empty()
|
| end-date-when-finished-invariant | error | EpisodeOfCare | End date is required when status is finished |
status = 'finished' implies period.end.exists()
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | IcpCase | An association of a Patient with an Organization and Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility Constraints: end-date-when-active-invariant, end-date-when-finished-invariant, active-status-invariant | ||||
![]() ![]() |
Σ | 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
1..* | Resource | Contained, inline Resources Slice: Unordered, Open by profile:$this | |||||
![]() ![]() ![]() |
1..1 | IcpPatient | Information about an individual or animal receiving health care services | |||||
![]() ![]() |
2..3 | 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 | (Complex) | The updated ICP service bundle for the treatment. URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-service-bundle-change | |||||
![]() ![]() ![]() |
0..1 | (Complex) | Indicates if exceptionalfunding is required for this treatment and the funding type. URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-exceptional-funding | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
1..1 | Identifier | Business Identifier(s) relevant for this EpisodeOfCare Slice: Unordered, Open 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 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() |
?!Σ | 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. Constraints: acc-claim-number Example General: 123456 | ||||
![]() ![]() |
?!Σ | 1..1 | code | active | finished Binding: Status (required) | ||||
![]() ![]() |
Σ | 1..1 | Reference(ACC ICP Patient) | The patient who is the focus of this episode of care | ||||
![]() ![]() |
Σ | 1..1 | Reference(Organization) | This is the ACC Vendor ID, in most cases this is the organisation's HPI ID. | ||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| EpisodeOfCare.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| EpisodeOfCare.identifier:icpclaimnumber.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| EpisodeOfCare.identifier:icpclaimnumber.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| EpisodeOfCare.status | Base | required | Status | 📦1.1.0 | This IG |
| EpisodeOfCare.statusHistory.status | Base | required | EpisodeOfCareStatus | 📍4.0.1 | FHIR Std. |
| EpisodeOfCare.type.coding.code | Base | required | Service Type | 📦1.1.0 | This IG |
| EpisodeOfCare.diagnosis.role | Base | preferred | DiagnosisRole | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| acc-claim-number | error | EpisodeOfCare.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}$')
|
| active-status-invariant | error | EpisodeOfCare | The status attribute must be set to 'active'. |
status = 'active'
|
| date-invariant | error | EpisodeOfCare.period.start, EpisodeOfCare.period.end | All timestamps SHOULD be represented as Dates (YYYY-MM-DD only). |
$this.toString().matches('^[0-9]{4}-[0-9]{2}-[0-9]{2}$')
|
| date-not-in-future-invariant | error | EpisodeOfCare.period.start, EpisodeOfCare.period.end | The date value cannot be in the future |
$this <= today()
|
| dom-2 | error | EpisodeOfCare | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | EpisodeOfCare | 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 | EpisodeOfCare | 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 | EpisodeOfCare | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | EpisodeOfCare | 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())
|
| end-date-when-active-invariant | error | EpisodeOfCare | End date is not allowed when status is active |
status = 'active' implies period.end.empty()
|
| end-date-when-finished-invariant | error | EpisodeOfCare | End date is required when status is finished |
status = 'finished' implies period.end.exists()
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from IcpCase
Differential View
This structure is derived from IcpCase
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | IcpCase | An association of a Patient with an Organization and Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility Constraints: active-status-invariant |
![]() ![]() |
1..* | Resource | Contained, inline Resources | |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
1..1 | IcpPatient | Information about an individual or animal receiving health care services | |
![]() ![]() |
2..3 | Extension | Extension | |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
1..1 | (Complex) | The updated ICP service bundle for the treatment. URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-service-bundle-change | |
![]() ![]() ![]() |
0..1 | (Complex) | Indicates if exceptionalfunding is required for this treatment and the funding type. URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-exceptional-funding | |
![]() ![]() |
1..1 | code | active | finished | |
![]() ![]() |
0..0 | The type of ICP service. Currently only musculoskeletal (msk) is allowed, with more to be added in the future, e.g. concussion. | ||
![]() ![]() |
0..0 | Interval during responsibility is assumed | ||
Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| active-status-invariant | error | EpisodeOfCare | The status attribute must be set to 'active'. |
status = 'active'
|
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | IcpCase | An association of a Patient with an Organization and Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility Constraints: end-date-when-active-invariant, end-date-when-finished-invariant, active-status-invariant |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
1..* | Resource | Contained, inline Resources Slice: Unordered, Open by profile:$this | |
![]() ![]() ![]() |
1..1 | IcpPatient | Information about an individual or animal receiving health care services | |
![]() ![]() |
2..3 | 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 | (Complex) | The updated ICP service bundle for the treatment. URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-service-bundle-change | |
![]() ![]() ![]() |
0..1 | (Complex) | Indicates if exceptionalfunding is required for this treatment and the funding type. URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-exceptional-funding | |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
1..1 | Identifier | Business Identifier(s) relevant for this EpisodeOfCare Slice: Unordered, Open 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 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() |
Σ | 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. Constraints: acc-claim-number Example General: 123456 |
![]() ![]() |
?!Σ | 1..1 | code | active | finished Binding: Status (required) |
![]() ![]() |
Σ | 1..1 | Reference(ACC ICP Patient) | The patient who is the focus of this episode of care |
![]() ![]() |
Σ | 1..1 | Reference(Organization) | This is the ACC Vendor ID, in most cases this is the organisation's HPI ID. |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| EpisodeOfCare.identifier:icpclaimnumber.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| EpisodeOfCare.status | Base | required | Status | 📦1.1.0 | This IG |
| EpisodeOfCare.statusHistory.status | Base | required | EpisodeOfCareStatus | 📍4.0.1 | FHIR Std. |
| EpisodeOfCare.type.coding.code | Base | required | Service Type | 📦1.1.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| acc-claim-number | error | EpisodeOfCare.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}$')
|
| active-status-invariant | error | EpisodeOfCare | The status attribute must be set to 'active'. |
status = 'active'
|
| dom-2 | error | EpisodeOfCare | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | EpisodeOfCare | 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 | EpisodeOfCare | 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 | EpisodeOfCare | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | EpisodeOfCare | 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())
|
| end-date-when-active-invariant | error | EpisodeOfCare | End date is not allowed when status is active |
status = 'active' implies period.end.empty()
|
| end-date-when-finished-invariant | error | EpisodeOfCare | End date is required when status is finished |
status = 'finished' implies period.end.exists()
|
| 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 Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | IcpCase | An association of a Patient with an Organization and Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility Constraints: end-date-when-active-invariant, end-date-when-finished-invariant, active-status-invariant | ||||
![]() ![]() |
Σ | 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
1..* | Resource | Contained, inline Resources Slice: Unordered, Open by profile:$this | |||||
![]() ![]() ![]() |
1..1 | IcpPatient | Information about an individual or animal receiving health care services | |||||
![]() ![]() |
2..3 | 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 | (Complex) | The updated ICP service bundle for the treatment. URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-service-bundle-change | |||||
![]() ![]() ![]() |
0..1 | (Complex) | Indicates if exceptionalfunding is required for this treatment and the funding type. URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-exceptional-funding | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
1..1 | Identifier | Business Identifier(s) relevant for this EpisodeOfCare Slice: Unordered, Open 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 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() |
?!Σ | 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. Constraints: acc-claim-number Example General: 123456 | ||||
![]() ![]() |
?!Σ | 1..1 | code | active | finished Binding: Status (required) | ||||
![]() ![]() |
Σ | 1..1 | Reference(ACC ICP Patient) | The patient who is the focus of this episode of care | ||||
![]() ![]() |
Σ | 1..1 | Reference(Organization) | This is the ACC Vendor ID, in most cases this is the organisation's HPI ID. | ||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| EpisodeOfCare.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| EpisodeOfCare.identifier:icpclaimnumber.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| EpisodeOfCare.identifier:icpclaimnumber.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| EpisodeOfCare.status | Base | required | Status | 📦1.1.0 | This IG |
| EpisodeOfCare.statusHistory.status | Base | required | EpisodeOfCareStatus | 📍4.0.1 | FHIR Std. |
| EpisodeOfCare.type.coding.code | Base | required | Service Type | 📦1.1.0 | This IG |
| EpisodeOfCare.diagnosis.role | Base | preferred | DiagnosisRole | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| acc-claim-number | error | EpisodeOfCare.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}$')
|
| active-status-invariant | error | EpisodeOfCare | The status attribute must be set to 'active'. |
status = 'active'
|
| date-invariant | error | EpisodeOfCare.period.start, EpisodeOfCare.period.end | All timestamps SHOULD be represented as Dates (YYYY-MM-DD only). |
$this.toString().matches('^[0-9]{4}-[0-9]{2}-[0-9]{2}$')
|
| date-not-in-future-invariant | error | EpisodeOfCare.period.start, EpisodeOfCare.period.end | The date value cannot be in the future |
$this <= today()
|
| dom-2 | error | EpisodeOfCare | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | EpisodeOfCare | 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 | EpisodeOfCare | 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 | EpisodeOfCare | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | EpisodeOfCare | 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())
|
| end-date-when-active-invariant | error | EpisodeOfCare | End date is not allowed when status is active |
status = 'active' implies period.end.empty()
|
| end-date-when-finished-invariant | error | EpisodeOfCare | End date is required when status is finished |
status = 'finished' implies period.end.exists()
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from IcpCase
Other representations of profile: CSV, Excel, Schematron