New Zealand ICP Implementation Guide
1.0.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.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

Resource Profile: ACC ICP Episode of Care Service Bundle Update Resource

Official URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-case-modify Version: 1.0.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.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from IcpCase

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
active-status-invariant: The status attribute must be set to 'active'.
... 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 2..3 Extension Extension
.... service-bundle-change 1..1 (Complex) The updated ICP service bundle for the treatment.
URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-service-bundle-change
.... exceptional-funding 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
... status 1..1 code active | finished
... type 0..0
... period 0..0

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
active-status-invarianterrorEpisodeOfCareThe status attribute must be set to 'active'.
: status = 'active'
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
end-date-when-active-invariant: End date is not allowed when status is active
end-date-when-finished-invariant: End date is required when status is finished
active-status-invariant: The status attribute must be set to 'active'.
... 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 2..3 Extension Extension
Slice: Unordered, Open by value:url
.... acc-providerid 1..1 string The ACC provider ID associated with the ICP case
URL: http://hl7.org.nz/fhir/StructureDefinition/acc-providerid
.... service-bundle-change 1..1 (Complex) The updated ICP service bundle for the treatment.
URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-service-bundle-change
.... exceptional-funding 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
... 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
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/acc-45-number
..... value ΣC 1..1 string The ACC 45 number.
acc-claim-number: The claim number format is invalid; it must be in the form A999999, AA99999, 9999AAA or 99999AA, where A is any capital letter, 9 is any single digit, and there are 7 characters altogether.
Example General: 123456
... status ?!Σ 1..1 code active | finished
Binding: Status (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.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
EpisodeOfCare.identifier:icpclaimnumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
EpisodeOfCare.statusrequiredICPStatusVS
http://hl7.org.nz/fhir/ValueSet/acc-icp-episodeofcare-status
from this IG
EpisodeOfCare.statusHistory.statusrequiredEpisodeOfCareStatus
http://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1
from the FHIR Standard
EpisodeOfCare.type.coding.coderequiredICPServiceType (a valid code from Service Type)
http://hl7.org.nz/fhir/ValueSet/acc-icp-service-type
from this IG

Constraints

IdGradePath(s)DetailsRequirements
active-status-invarianterrorEpisodeOfCareThe status attribute must be set to 'active'.
: status = 'active'
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
end-date-when-active-invariant: End date is not allowed when status is active
end-date-when-finished-invariant: End date is required when status is finished
active-status-invariant: The status attribute must be set to 'active'.
... 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
... 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 2..3 Extension Extension
Slice: Unordered, Open by value:url
.... acc-providerid 1..1 string The ACC provider ID associated with the ICP case
URL: http://hl7.org.nz/fhir/StructureDefinition/acc-providerid
.... service-bundle-change 1..1 (Complex) The updated ICP service bundle for the treatment.
URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-service-bundle-change
.... exceptional-funding 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
... 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
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/acc-45-number
..... value ΣC 1..1 string The ACC 45 number.
acc-claim-number: The claim number format is invalid; it must be in the form A999999, AA99999, 9999AAA or 99999AA, where A is any capital letter, 9 is any single digit, and there are 7 characters altogether.
Example General: 123456
... status ?!Σ 1..1 code active | finished
Binding: Status (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.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
EpisodeOfCare.languagepreferredCommonLanguages
Additional Bindings Purpose
​ AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
EpisodeOfCare.identifier:icpclaimnumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
EpisodeOfCare.identifier:icpclaimnumber.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
EpisodeOfCare.statusrequiredICPStatusVS
http://hl7.org.nz/fhir/ValueSet/acc-icp-episodeofcare-status
from this IG
EpisodeOfCare.statusHistory.statusrequiredEpisodeOfCareStatus
http://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1
from the FHIR Standard
EpisodeOfCare.type.coding.coderequiredICPServiceType (a valid code from Service Type)
http://hl7.org.nz/fhir/ValueSet/acc-icp-service-type
from this IG
EpisodeOfCare.diagnosis.rolepreferredDiagnosisRole
http://hl7.org/fhir/ValueSet/diagnosis-role
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
active-status-invarianterrorEpisodeOfCareThe status attribute must be set to 'active'.
: status = 'active'

This structure is derived from IcpCase

Summary

Mandatory: 3 elements
Prohibited: 2 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from IcpCase

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
active-status-invariant: The status attribute must be set to 'active'.
... 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 2..3 Extension Extension
.... service-bundle-change 1..1 (Complex) The updated ICP service bundle for the treatment.
URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-service-bundle-change
.... exceptional-funding 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
... status 1..1 code active | finished
... type 0..0
... period 0..0

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
active-status-invarianterrorEpisodeOfCareThe status attribute must be set to 'active'.
: status = 'active'

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
end-date-when-active-invariant: End date is not allowed when status is active
end-date-when-finished-invariant: End date is required when status is finished
active-status-invariant: The status attribute must be set to 'active'.
... 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 2..3 Extension Extension
Slice: Unordered, Open by value:url
.... acc-providerid 1..1 string The ACC provider ID associated with the ICP case
URL: http://hl7.org.nz/fhir/StructureDefinition/acc-providerid
.... service-bundle-change 1..1 (Complex) The updated ICP service bundle for the treatment.
URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-service-bundle-change
.... exceptional-funding 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
... 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
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/acc-45-number
..... value ΣC 1..1 string The ACC 45 number.
acc-claim-number: The claim number format is invalid; it must be in the form A999999, AA99999, 9999AAA or 99999AA, where A is any capital letter, 9 is any single digit, and there are 7 characters altogether.
Example General: 123456
... status ?!Σ 1..1 code active | finished
Binding: Status (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.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
EpisodeOfCare.identifier:icpclaimnumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
EpisodeOfCare.statusrequiredICPStatusVS
http://hl7.org.nz/fhir/ValueSet/acc-icp-episodeofcare-status
from this IG
EpisodeOfCare.statusHistory.statusrequiredEpisodeOfCareStatus
http://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1
from the FHIR Standard
EpisodeOfCare.type.coding.coderequiredICPServiceType (a valid code from Service Type)
http://hl7.org.nz/fhir/ValueSet/acc-icp-service-type
from this IG

Constraints

IdGradePath(s)DetailsRequirements
active-status-invarianterrorEpisodeOfCareThe status attribute must be set to 'active'.
: status = 'active'

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
end-date-when-active-invariant: End date is not allowed when status is active
end-date-when-finished-invariant: End date is required when status is finished
active-status-invariant: The status attribute must be set to 'active'.
... 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
... 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 2..3 Extension Extension
Slice: Unordered, Open by value:url
.... acc-providerid 1..1 string The ACC provider ID associated with the ICP case
URL: http://hl7.org.nz/fhir/StructureDefinition/acc-providerid
.... service-bundle-change 1..1 (Complex) The updated ICP service bundle for the treatment.
URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-service-bundle-change
.... exceptional-funding 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
... 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
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/acc-45-number
..... value ΣC 1..1 string The ACC 45 number.
acc-claim-number: The claim number format is invalid; it must be in the form A999999, AA99999, 9999AAA or 99999AA, where A is any capital letter, 9 is any single digit, and there are 7 characters altogether.
Example General: 123456
... status ?!Σ 1..1 code active | finished
Binding: Status (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.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
EpisodeOfCare.languagepreferredCommonLanguages
Additional Bindings Purpose
​ AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
EpisodeOfCare.identifier:icpclaimnumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
EpisodeOfCare.identifier:icpclaimnumber.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
EpisodeOfCare.statusrequiredICPStatusVS
http://hl7.org.nz/fhir/ValueSet/acc-icp-episodeofcare-status
from this IG
EpisodeOfCare.statusHistory.statusrequiredEpisodeOfCareStatus
http://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1
from the FHIR Standard
EpisodeOfCare.type.coding.coderequiredICPServiceType (a valid code from Service Type)
http://hl7.org.nz/fhir/ValueSet/acc-icp-service-type
from this IG
EpisodeOfCare.diagnosis.rolepreferredDiagnosisRole
http://hl7.org/fhir/ValueSet/diagnosis-role
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
active-status-invarianterrorEpisodeOfCareThe status attribute must be set to 'active'.
: status = 'active'

This structure is derived from IcpCase

Summary

Mandatory: 3 elements
Prohibited: 2 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron