New Zealand ICP Implementation Guide
1.1.0 - draft
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-msk-case-create | Version: 1.1.0 | |||
| Active as of 2022-11-20 | Computable Name: IcpMskCaseCreate | |||
Copyright/Legal: ACC New Zealand© 2023+; Licensed Under Creative Commons No Rights Reserved. |
||||
ICP MSK Case Create is to be used by the supplier to furnish ACC with the required information following the completion of the triage assessment and the decision to accept the patient into their ICP service.
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:   |
|---|---|---|---|---|
  EpisodeOfCare |
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, start-date-when-active-finished-invariant |
  contained |
1..* | Resource | Contained, inline Resources | |
  Slices for contained |
Content/Rules for all slices | |||
   contained:patient |
1..1 | IcpPatient | Information about an individual or animal receiving health care services | |
 extension |
5..6 | Extension | Extension | |
| Slices for extension |
Content/Rules for all slices | |||
 extension:service-bundle-msk |
1..1 | code | (icpkar1 | icpkar2 | icpkar3 | icpkrr1 | icpkrr2 | icpkrr3 | icpkrr4 | icpkrr5 | icpspr1 | icpspr2 | icpspr3 | icpspr4 | icpspr5 | icpspr6 | icpspr7 | icpspr8 | icpshr1 | icpshr2 | icpshr3 | icpshr4 | icpshr5 | icpshr6) URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-service-bundle-msk Binding: Service Bundle MSK (required) | |
| extension:exceptional-funding |
0..1 | (Complex) | Indicates if exceptional funding is required for this treatment. URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-exceptional-funding | |
| extension:referral-source |
1..1 | (Complex) | (gp | physio | specialist | allied | employer | rongoa | other | acc | patient) URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-referral-source | |
| extension:diagnoses |
1..1 | (Complex) | The diagnoses for the injury being treated. URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-diagnoses | |
 extension:triage |
1..1 | (Complex) | The triage assessment of the patient must be present when a triage has been performed. URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-triage | |
  extension |
3..4 | Extension | Extension | |
 Slices for extension |
Content/Rules for all slices | |||
| extension:complexityScores |
1..1 | Icp_complexityScores | Complexity Scores | |
| extension:client-participation-agreement |
0..1 | ClientPatricitionAgreement | Client Participation Agreement | |
 value[x] |
1..1 | boolean | Value of extension | |
| status |
1..1 | code | active | finished | |
 type |
1..1 | CodeableConcept | The type of ICP service. Currently only musculoskeletal (msk) is allowed, with more to be added in the future, e.g. concussion. | |
| coding |
||||
 code |
1..1 | code | msk | |
| 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'
|
| start-date-when-active-finished-invariant | error | EpisodeOfCare | Start date is required when status is active |
status = 'active' implies period.start.exists()
|
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| EpisodeOfCare |
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, start-date-when-active-finished-invariant |
 implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for contained |
1..* | Resource | Contained, inline Resources Slice: Unordered, Open by profile:$this | |
| contained:patient |
1..1 | IcpPatient | Information about an individual or animal receiving health care services | |
| Slices for extension |
5..6 | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:acc-providerid |
1..1 | string | The ACC provider ID associated with the ICP case URL: http://hl7.org.nz/fhir/StructureDefinition/acc-providerid | |
| extension:service-bundle-msk |
1..1 | code | (icpkar1 | icpkar2 | icpkar3 | icpkrr1 | icpkrr2 | icpkrr3 | icpkrr4 | icpkrr5 | icpspr1 | icpspr2 | icpspr3 | icpspr4 | icpspr5 | icpspr6 | icpspr7 | icpspr8 | icpshr1 | icpshr2 | icpshr3 | icpshr4 | icpshr5 | icpshr6) URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-service-bundle-msk Binding: Service Bundle MSK (required) | |
| extension:exceptional-funding |
0..1 | (Complex) | Indicates if exceptional funding is required for this treatment. URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-exceptional-funding | |
| extension:referral-source |
1..1 | (Complex) | (gp | physio | specialist | allied | employer | rongoa | other | acc | patient) URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-referral-source | |
| extension:diagnoses |
1..1 | (Complex) | The diagnoses for the injury being treated. URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-diagnoses | |
| extension:triage |
1..1 | (Complex) | The triage assessment of the patient must be present when a triage has been performed. URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-triage | |
 Slices for extension |
3..4 | Extension | Extension Slice: Unordered, Open by value:url | |
 extension:triage-assessment-date |
1..1 | date | The date the triage assessment was completed. URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-triage-assessment-date | |
| extension:acc-client-authority |
1..1 | boolean | Indicates that the Client has agreed to ACC being able to collect, store, use, & share their information. URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-client-authority | |
| extension:complexityScores |
1..1 | (Complex) | Complexity Scores URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-complexity-scores | |
| extension:client-participation-agreement |
0..1 | (Complex) | Client Participation Agreement URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-client-participation-agreement | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/acc-icp-client-participation-agreement" | |
| value[x] |
1..1 | boolean | Value of extension | |
| url |
1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/acc-icp-triage" | |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier |
1..1 | Identifier | Business Identifier(s) relevant for this EpisodeOfCare Slice: Unordered, Open 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 | Extension Slice: Unordered, Open by value:url | ||
| 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. Constraints: acc-claim-number Example General: 123456 |
| status |
?!Σ | 1..1 | code | active | finished Binding: Status (required) |
 type |
Σ | 1..1 | CodeableConcept | The type of ICP service. Currently only musculoskeletal (msk) is allowed, with more to be added in the future, e.g. concussion. Binding: EpisodeOfCareType (example): The type of the episode of care. |
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system |
| system |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://hl7.org.nz/fhir/CodeSystem/acc-icp-service-type |
| code |
Σ | 1..1 | code | msk Binding: Service Type (required) |
 patient |
Σ | 1..1 | Reference(ACC ICP Patient) | The patient who is the focus of this episode of care |
| managingOrganization |
Σ | 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 | Base | example | Episode of care type | 📍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()
|
| start-date-when-active-finished-invariant | error | EpisodeOfCare | Start date is required when status is active |
status = 'active' implies period.start.exists()
|
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| EpisodeOfCare |
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, start-date-when-active-finished-invariant | ||||
| 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| Slices for contained |
1..* | Resource | Contained, inline Resources Slice: Unordered, Open by profile:$this | |||||
| contained:patient |
1..1 | IcpPatient | Information about an individual or animal receiving health care services | |||||
| Slices for extension |
5..6 | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:acc-providerid |
1..1 | string | The ACC provider ID associated with the ICP case URL: http://hl7.org.nz/fhir/StructureDefinition/acc-providerid | |||||
| extension:service-bundle-msk |
1..1 | code | (icpkar1 | icpkar2 | icpkar3 | icpkrr1 | icpkrr2 | icpkrr3 | icpkrr4 | icpkrr5 | icpspr1 | icpspr2 | icpspr3 | icpspr4 | icpspr5 | icpspr6 | icpspr7 | icpspr8 | icpshr1 | icpshr2 | icpshr3 | icpshr4 | icpshr5 | icpshr6) URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-service-bundle-msk Binding: Service Bundle MSK (required) | |||||
| extension:exceptional-funding |
0..1 | (Complex) | Indicates if exceptional funding is required for this treatment. URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-exceptional-funding | |||||
| extension:referral-source |
1..1 | (Complex) | (gp | physio | specialist | allied | employer | rongoa | other | acc | patient) URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-referral-source | |||||
| extension:diagnoses |
1..1 | (Complex) | The diagnoses for the injury being treated. URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-diagnoses | |||||
| extension:triage |
1..1 | (Complex) | The triage assessment of the patient must be present when a triage has been performed. URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-triage | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
3..4 | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:triage-assessment-date |
1..1 | date | The date the triage assessment was completed. URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-triage-assessment-date | |||||
| extension:acc-client-authority |
1..1 | boolean | Indicates that the Client has agreed to ACC being able to collect, store, use, & share their information. URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-client-authority | |||||
| extension:complexityScores |
1..1 | (Complex) | Complexity Scores URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-complexity-scores | |||||
| extension:client-participation-agreement |
0..1 | (Complex) | Client Participation Agreement URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-client-participation-agreement | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
| url |
1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/acc-icp-client-participation-agreement" | |||||
| value[x] |
1..1 | boolean | Value of extension | |||||
| url |
1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/acc-icp-triage" | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier |
1..1 | Identifier | Business Identifier(s) relevant for this EpisodeOfCare Slice: Unordered, Open 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 | Extension Slice: Unordered, Open by value:url | ||||||
| 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. Constraints: acc-claim-number Example General: 123456 | ||||
| status |
?!Σ | 1..1 | code | active | finished Binding: Status (required) | ||||
| type |
Σ | 1..1 | CodeableConcept | The type of ICP service. Currently only musculoskeletal (msk) is allowed, with more to be added in the future, e.g. concussion. Binding: EpisodeOfCareType (example): The type of the episode of care. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://hl7.org.nz/fhir/CodeSystem/acc-icp-service-type | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
Σ | 1..1 | code | msk Binding: Service Type (required) | ||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| patient |
Σ | 1..1 | Reference(ACC ICP Patient) | The patient who is the focus of this episode of care | ||||
| managingOrganization |
Σ | 1..1 | Reference(Organization) | This is the ACC Vendor ID, in most cases this is the organisation's HPI ID. | ||||
| period |
Σ | 0..1 | Period | Interval during responsibility is assumed | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| start |
ΣC | 0..1 | dateTime | Starting time with inclusive boundary Constraints: date-invariant, date-not-in-future-invariant | ||||
| end |
ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing Constraints: date-invariant, date-not-in-future-invariant | ||||
| 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 | Base | example | Episode of care type | 📍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()
|
| start-date-when-active-finished-invariant | error | EpisodeOfCare | Start date is required when status is active |
status = 'active' implies period.start.exists()
|
This structure is derived from IcpCase
Summary
Mandatory: 8 elements(1 nested mandatory element)
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from IcpCase
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| EpisodeOfCare |
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, start-date-when-active-finished-invariant |
| contained |
1..* | Resource | Contained, inline Resources | |
| Slices for contained |
Content/Rules for all slices | |||
| contained:patient |
1..1 | IcpPatient | Information about an individual or animal receiving health care services | |
| extension |
5..6 | Extension | Extension | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:service-bundle-msk |
1..1 | code | (icpkar1 | icpkar2 | icpkar3 | icpkrr1 | icpkrr2 | icpkrr3 | icpkrr4 | icpkrr5 | icpspr1 | icpspr2 | icpspr3 | icpspr4 | icpspr5 | icpspr6 | icpspr7 | icpspr8 | icpshr1 | icpshr2 | icpshr3 | icpshr4 | icpshr5 | icpshr6) URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-service-bundle-msk Binding: Service Bundle MSK (required) | |
| extension:exceptional-funding |
0..1 | (Complex) | Indicates if exceptional funding is required for this treatment. URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-exceptional-funding | |
| extension:referral-source |
1..1 | (Complex) | (gp | physio | specialist | allied | employer | rongoa | other | acc | patient) URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-referral-source | |
| extension:diagnoses |
1..1 | (Complex) | The diagnoses for the injury being treated. URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-diagnoses | |
| extension:triage |
1..1 | (Complex) | The triage assessment of the patient must be present when a triage has been performed. URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-triage | |
| extension |
3..4 | Extension | Extension | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:complexityScores |
1..1 | Icp_complexityScores | Complexity Scores | |
| extension:client-participation-agreement |
0..1 | ClientPatricitionAgreement | Client Participation Agreement | |
| value[x] |
1..1 | boolean | Value of extension | |
| status |
1..1 | code | active | finished | |
| type |
1..1 | CodeableConcept | The type of ICP service. Currently only musculoskeletal (msk) is allowed, with more to be added in the future, e.g. concussion. | |
| coding |
||||
| code |
1..1 | code | msk | |
| 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'
|
| start-date-when-active-finished-invariant | error | EpisodeOfCare | Start date is required when status is active |
status = 'active' implies period.start.exists()
|
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| EpisodeOfCare |
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, start-date-when-active-finished-invariant |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for contained |
1..* | Resource | Contained, inline Resources Slice: Unordered, Open by profile:$this | |
| contained:patient |
1..1 | IcpPatient | Information about an individual or animal receiving health care services | |
| Slices for extension |
5..6 | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:acc-providerid |
1..1 | string | The ACC provider ID associated with the ICP case URL: http://hl7.org.nz/fhir/StructureDefinition/acc-providerid | |
| extension:service-bundle-msk |
1..1 | code | (icpkar1 | icpkar2 | icpkar3 | icpkrr1 | icpkrr2 | icpkrr3 | icpkrr4 | icpkrr5 | icpspr1 | icpspr2 | icpspr3 | icpspr4 | icpspr5 | icpspr6 | icpspr7 | icpspr8 | icpshr1 | icpshr2 | icpshr3 | icpshr4 | icpshr5 | icpshr6) URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-service-bundle-msk Binding: Service Bundle MSK (required) | |
| extension:exceptional-funding |
0..1 | (Complex) | Indicates if exceptional funding is required for this treatment. URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-exceptional-funding | |
| extension:referral-source |
1..1 | (Complex) | (gp | physio | specialist | allied | employer | rongoa | other | acc | patient) URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-referral-source | |
| extension:diagnoses |
1..1 | (Complex) | The diagnoses for the injury being treated. URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-diagnoses | |
| extension:triage |
1..1 | (Complex) | The triage assessment of the patient must be present when a triage has been performed. URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-triage | |
| Slices for extension |
3..4 | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:triage-assessment-date |
1..1 | date | The date the triage assessment was completed. URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-triage-assessment-date | |
| extension:acc-client-authority |
1..1 | boolean | Indicates that the Client has agreed to ACC being able to collect, store, use, & share their information. URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-client-authority | |
| extension:complexityScores |
1..1 | (Complex) | Complexity Scores URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-complexity-scores | |
| extension:client-participation-agreement |
0..1 | (Complex) | Client Participation Agreement URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-client-participation-agreement | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/acc-icp-client-participation-agreement" | |
| value[x] |
1..1 | boolean | Value of extension | |
| url |
1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/acc-icp-triage" | |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier |
1..1 | Identifier | Business Identifier(s) relevant for this EpisodeOfCare Slice: Unordered, Open 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 | Extension Slice: Unordered, Open by value:url | ||
| 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. Constraints: acc-claim-number Example General: 123456 |
| status |
?!Σ | 1..1 | code | active | finished Binding: Status (required) |
| type |
Σ | 1..1 | CodeableConcept | The type of ICP service. Currently only musculoskeletal (msk) is allowed, with more to be added in the future, e.g. concussion. Binding: EpisodeOfCareType (example): The type of the episode of care. |
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system |
| system |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://hl7.org.nz/fhir/CodeSystem/acc-icp-service-type |
| code |
Σ | 1..1 | code | msk Binding: Service Type (required) |
| patient |
Σ | 1..1 | Reference(ACC ICP Patient) | The patient who is the focus of this episode of care |
| managingOrganization |
Σ | 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 | Base | example | Episode of care type | 📍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()
|
| start-date-when-active-finished-invariant | error | EpisodeOfCare | Start date is required when status is active |
status = 'active' implies period.start.exists()
|
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| EpisodeOfCare |
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, start-date-when-active-finished-invariant | ||||
| 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| Slices for contained |
1..* | Resource | Contained, inline Resources Slice: Unordered, Open by profile:$this | |||||
| contained:patient |
1..1 | IcpPatient | Information about an individual or animal receiving health care services | |||||
| Slices for extension |
5..6 | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:acc-providerid |
1..1 | string | The ACC provider ID associated with the ICP case URL: http://hl7.org.nz/fhir/StructureDefinition/acc-providerid | |||||
| extension:service-bundle-msk |
1..1 | code | (icpkar1 | icpkar2 | icpkar3 | icpkrr1 | icpkrr2 | icpkrr3 | icpkrr4 | icpkrr5 | icpspr1 | icpspr2 | icpspr3 | icpspr4 | icpspr5 | icpspr6 | icpspr7 | icpspr8 | icpshr1 | icpshr2 | icpshr3 | icpshr4 | icpshr5 | icpshr6) URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-service-bundle-msk Binding: Service Bundle MSK (required) | |||||
| extension:exceptional-funding |
0..1 | (Complex) | Indicates if exceptional funding is required for this treatment. URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-exceptional-funding | |||||
| extension:referral-source |
1..1 | (Complex) | (gp | physio | specialist | allied | employer | rongoa | other | acc | patient) URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-referral-source | |||||
| extension:diagnoses |
1..1 | (Complex) | The diagnoses for the injury being treated. URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-diagnoses | |||||
| extension:triage |
1..1 | (Complex) | The triage assessment of the patient must be present when a triage has been performed. URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-triage | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
3..4 | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:triage-assessment-date |
1..1 | date | The date the triage assessment was completed. URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-triage-assessment-date | |||||
| extension:acc-client-authority |
1..1 | boolean | Indicates that the Client has agreed to ACC being able to collect, store, use, & share their information. URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-client-authority | |||||
| extension:complexityScores |
1..1 | (Complex) | Complexity Scores URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-complexity-scores | |||||
| extension:client-participation-agreement |
0..1 | (Complex) | Client Participation Agreement URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-client-participation-agreement | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
| url |
1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/acc-icp-client-participation-agreement" | |||||
| value[x] |
1..1 | boolean | Value of extension | |||||
| url |
1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/acc-icp-triage" | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier |
1..1 | Identifier | Business Identifier(s) relevant for this EpisodeOfCare Slice: Unordered, Open 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 | Extension Slice: Unordered, Open by value:url | ||||||
| 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. Constraints: acc-claim-number Example General: 123456 | ||||
| status |
?!Σ | 1..1 | code | active | finished Binding: Status (required) | ||||
| type |
Σ | 1..1 | CodeableConcept | The type of ICP service. Currently only musculoskeletal (msk) is allowed, with more to be added in the future, e.g. concussion. Binding: EpisodeOfCareType (example): The type of the episode of care. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://hl7.org.nz/fhir/CodeSystem/acc-icp-service-type | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
Σ | 1..1 | code | msk Binding: Service Type (required) | ||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| patient |
Σ | 1..1 | Reference(ACC ICP Patient) | The patient who is the focus of this episode of care | ||||
| managingOrganization |
Σ | 1..1 | Reference(Organization) | This is the ACC Vendor ID, in most cases this is the organisation's HPI ID. | ||||
| period |
Σ | 0..1 | Period | Interval during responsibility is assumed | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| start |
ΣC | 0..1 | dateTime | Starting time with inclusive boundary Constraints: date-invariant, date-not-in-future-invariant | ||||
| end |
ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing Constraints: date-invariant, date-not-in-future-invariant | ||||
| 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 | Base | example | Episode of care type | 📍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()
|
| start-date-when-active-finished-invariant | error | EpisodeOfCare | Start date is required when status is active |
status = 'active' implies period.start.exists()
|
This structure is derived from IcpCase
Summary
Mandatory: 8 elements(1 nested mandatory element)
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron