New Zealand ICP Implementation Guide
1.0.0 - release

New Zealand ICP Implementation Guide, published by Accident Compensation Corporation. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/acc-fhir-publisher/icp/ and changes regularly. See the Directory of published versions

Resource Profile: ACC ICP Episode of Care Resource

Official URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-case Version: 1.0.0
Active as of 2022-11-20 Computable Name: IcpCase

Copyright/Legal: ACC New Zealand© 2023+; Licensed Under Creative Commons No Rights Reserved.

The ACC ICP Case resource based on Episode of Care

Usage:

Formal Views of Profile Content

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

This structure is derived from EpisodeOfCare

NameFlagsCard.TypeDescription & Constraintsdoco
.. EpisodeOfCare C 0..* EpisodeOfCare 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
... Slices for contained 1..* Resource Contained, inline Resources
Slice: Unordered, Closed by type:$this
.... contained:patient 1..1 IcpPatient Patient's date of birth.
... Slices for extension 1..* 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
... Slices for identifier 1..1 Identifier Business Identifier(s) relevant for this EpisodeOfCare
Slice: Unordered, Closed by value:system
.... identifier:icpclaimnumber 1..1 Identifier The ACC 45 number to be used in combination with the contained patient's date of birth, as the ICP case idenfitier.
..... id 0..0
..... extension 0..0
..... system 1..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/acc-45-number
..... value C 1..1 string The ACC 45 number.
acc-claim-number: The claim number format is invalid; it must be in the form A999999, AA99999, 9999AAA or 99999AA, where A is any capital letter, 9 is any single digit, and there are 7 characters altogether.
..... period 0..0
..... assigner 0..0
... statusHistory 0..0
... type 0..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 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)
... diagnosis 0..0
... 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
.... start C 0..1 dateTime Starting time with inclusive boundary
date-invariant: All timestamps SHOULD be represented as Dates (YYYY-MM-DD only).
date-not-in-future-invariant: The date value cannot be in the future
.... end C 0..1 dateTime End time with inclusive boundary, if not ongoing
date-invariant: All timestamps SHOULD be represented as Dates (YYYY-MM-DD only).
date-not-in-future-invariant: The date value cannot be in the future
... referralRequest 0..0
... careManager 0..0
... team 0..0
... account 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
EpisodeOfCare.statusrequiredICPStatusVS
http://hl7.org.nz/fhir/ValueSet/acc-icp-episodeofcare-status
from this IG
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
acc-claim-numbererrorEpisodeOfCare.identifier:icpclaimnumber.valueThe 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}$')
date-invarianterrorEpisodeOfCare.period.start, EpisodeOfCare.period.endAll 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-invarianterrorEpisodeOfCare.period.start, EpisodeOfCare.period.endThe date value cannot be in the future
: $this <= today()
end-date-when-active-invarianterrorEpisodeOfCareEnd date is not allowed when status is active
: status = 'active' implies period.end.empty()
end-date-when-finished-invarianterrorEpisodeOfCareEnd date is required when status is finished
: status = 'finished' implies period.end.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. EpisodeOfCare C 0..* EpisodeOfCare 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
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for contained 1..* Resource Contained, inline Resources
Slice: Unordered, Closed by type:$this
.... contained:patient 1..1 IcpPatient Patient's date of birth.
... Slices for extension 1..* 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
... Slices for identifier 1..1 Identifier Business Identifier(s) relevant for this EpisodeOfCare
Slice: Unordered, Closed by value:system
.... identifier:icpclaimnumber 1..1 Identifier The ACC 45 number to be used in combination with the contained patient's date of birth, as the ICP case idenfitier.
..... extension 0..0
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

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

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.typeexampleEpisodeOfCareType
http://hl7.org/fhir/ValueSet/episodeofcare-type
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
acc-claim-numbererrorEpisodeOfCare.identifier:icpclaimnumber.valueThe 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}$')
end-date-when-active-invarianterrorEpisodeOfCareEnd date is not allowed when status is active
: status = 'active' implies period.end.empty()
end-date-when-finished-invarianterrorEpisodeOfCareEnd date is required when status is finished
: status = 'finished' implies period.end.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. EpisodeOfCare C 0..* EpisodeOfCare 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
... 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, Closed by type:$this
.... contained:patient 1..1 IcpPatient Patient's date of birth.
... Slices for extension 1..* 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
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier 1..1 Identifier Business Identifier(s) relevant for this EpisodeOfCare
Slice: Unordered, Closed by value:system
.... identifier:icpclaimnumber 1..1 Identifier The ACC 45 number to be used in combination with the contained patient's date of birth, as the ICP case idenfitier.
..... extension 0..0
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

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

..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/acc-45-number
..... value ΣC 1..1 string The ACC 45 number.
acc-claim-number: The claim number format is invalid; it must be in the form A999999, AA99999, 9999AAA or 99999AA, where A is any capital letter, 9 is any single digit, and there are 7 characters altogether.
Example General: 123456
... status ?!Σ 1..1 code active | finished
Binding: Status (required)
... type Σ 0..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
date-invariant: All timestamps SHOULD be represented as Dates (YYYY-MM-DD only).
date-not-in-future-invariant: The date value cannot be in the future
.... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
date-invariant: All timestamps SHOULD be represented as Dates (YYYY-MM-DD only).
date-not-in-future-invariant: The date value cannot be in the future

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.typeexampleEpisodeOfCareType
http://hl7.org/fhir/ValueSet/episodeofcare-type
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
acc-claim-numbererrorEpisodeOfCare.identifier:icpclaimnumber.valueThe 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}$')
date-invarianterrorEpisodeOfCare.period.start, EpisodeOfCare.period.endAll 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-invarianterrorEpisodeOfCare.period.start, EpisodeOfCare.period.endThe date value cannot be in the future
: $this <= today()
end-date-when-active-invarianterrorEpisodeOfCareEnd date is not allowed when status is active
: status = 'active' implies period.end.empty()
end-date-when-finished-invarianterrorEpisodeOfCareEnd date is required when status is finished
: status = 'finished' implies period.end.exists()

This structure is derived from EpisodeOfCare

Summary

Mandatory: 9 elements(3 nested mandatory elements)
Fixed: 1 element
Prohibited: 10 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of EpisodeOfCare.contained (Closed)
  • The element 1 is sliced based on the value of EpisodeOfCare.identifier (Closed)

Differential View

This structure is derived from EpisodeOfCare

NameFlagsCard.TypeDescription & Constraintsdoco
.. EpisodeOfCare C 0..* EpisodeOfCare 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
... Slices for contained 1..* Resource Contained, inline Resources
Slice: Unordered, Closed by type:$this
.... contained:patient 1..1 IcpPatient Patient's date of birth.
... Slices for extension 1..* 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
... Slices for identifier 1..1 Identifier Business Identifier(s) relevant for this EpisodeOfCare
Slice: Unordered, Closed by value:system
.... identifier:icpclaimnumber 1..1 Identifier The ACC 45 number to be used in combination with the contained patient's date of birth, as the ICP case idenfitier.
..... id 0..0
..... extension 0..0
..... system 1..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/acc-45-number
..... value C 1..1 string The ACC 45 number.
acc-claim-number: The claim number format is invalid; it must be in the form A999999, AA99999, 9999AAA or 99999AA, where A is any capital letter, 9 is any single digit, and there are 7 characters altogether.
..... period 0..0
..... assigner 0..0
... statusHistory 0..0
... type 0..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 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)
... diagnosis 0..0
... 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
.... start C 0..1 dateTime Starting time with inclusive boundary
date-invariant: All timestamps SHOULD be represented as Dates (YYYY-MM-DD only).
date-not-in-future-invariant: The date value cannot be in the future
.... end C 0..1 dateTime End time with inclusive boundary, if not ongoing
date-invariant: All timestamps SHOULD be represented as Dates (YYYY-MM-DD only).
date-not-in-future-invariant: The date value cannot be in the future
... referralRequest 0..0
... careManager 0..0
... team 0..0
... account 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
EpisodeOfCare.statusrequiredICPStatusVS
http://hl7.org.nz/fhir/ValueSet/acc-icp-episodeofcare-status
from this IG
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
acc-claim-numbererrorEpisodeOfCare.identifier:icpclaimnumber.valueThe 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}$')
date-invarianterrorEpisodeOfCare.period.start, EpisodeOfCare.period.endAll 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-invarianterrorEpisodeOfCare.period.start, EpisodeOfCare.period.endThe date value cannot be in the future
: $this <= today()
end-date-when-active-invarianterrorEpisodeOfCareEnd date is not allowed when status is active
: status = 'active' implies period.end.empty()
end-date-when-finished-invarianterrorEpisodeOfCareEnd date is required when status is finished
: status = 'finished' implies period.end.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. EpisodeOfCare C 0..* EpisodeOfCare 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
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for contained 1..* Resource Contained, inline Resources
Slice: Unordered, Closed by type:$this
.... contained:patient 1..1 IcpPatient Patient's date of birth.
... Slices for extension 1..* 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
... Slices for identifier 1..1 Identifier Business Identifier(s) relevant for this EpisodeOfCare
Slice: Unordered, Closed by value:system
.... identifier:icpclaimnumber 1..1 Identifier The ACC 45 number to be used in combination with the contained patient's date of birth, as the ICP case idenfitier.
..... extension 0..0
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

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

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.typeexampleEpisodeOfCareType
http://hl7.org/fhir/ValueSet/episodeofcare-type
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
acc-claim-numbererrorEpisodeOfCare.identifier:icpclaimnumber.valueThe 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}$')
end-date-when-active-invarianterrorEpisodeOfCareEnd date is not allowed when status is active
: status = 'active' implies period.end.empty()
end-date-when-finished-invarianterrorEpisodeOfCareEnd date is required when status is finished
: status = 'finished' implies period.end.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. EpisodeOfCare C 0..* EpisodeOfCare 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
... 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, Closed by type:$this
.... contained:patient 1..1 IcpPatient Patient's date of birth.
... Slices for extension 1..* 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
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier 1..1 Identifier Business Identifier(s) relevant for this EpisodeOfCare
Slice: Unordered, Closed by value:system
.... identifier:icpclaimnumber 1..1 Identifier The ACC 45 number to be used in combination with the contained patient's date of birth, as the ICP case idenfitier.
..... extension 0..0
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

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

..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/acc-45-number
..... value ΣC 1..1 string The ACC 45 number.
acc-claim-number: The claim number format is invalid; it must be in the form A999999, AA99999, 9999AAA or 99999AA, where A is any capital letter, 9 is any single digit, and there are 7 characters altogether.
Example General: 123456
... status ?!Σ 1..1 code active | finished
Binding: Status (required)
... type Σ 0..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
date-invariant: All timestamps SHOULD be represented as Dates (YYYY-MM-DD only).
date-not-in-future-invariant: The date value cannot be in the future
.... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
date-invariant: All timestamps SHOULD be represented as Dates (YYYY-MM-DD only).
date-not-in-future-invariant: The date value cannot be in the future

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.typeexampleEpisodeOfCareType
http://hl7.org/fhir/ValueSet/episodeofcare-type
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
acc-claim-numbererrorEpisodeOfCare.identifier:icpclaimnumber.valueThe 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}$')
date-invarianterrorEpisodeOfCare.period.start, EpisodeOfCare.period.endAll 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-invarianterrorEpisodeOfCare.period.start, EpisodeOfCare.period.endThe date value cannot be in the future
: $this <= today()
end-date-when-active-invarianterrorEpisodeOfCareEnd date is not allowed when status is active
: status = 'active' implies period.end.empty()
end-date-when-finished-invarianterrorEpisodeOfCareEnd date is required when status is finished
: status = 'finished' implies period.end.exists()

This structure is derived from EpisodeOfCare

Summary

Mandatory: 9 elements(3 nested mandatory elements)
Fixed: 1 element
Prohibited: 10 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of EpisodeOfCare.contained (Closed)
  • The element 1 is sliced based on the value of EpisodeOfCare.identifier (Closed)

 

Other representations of profile: CSV, Excel, Schematron