New Zealand ICP Implementation Guide
1.0.0 - release
New Zealand ICP Implementation Guide, published by Accident Compensation Corporation. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/acc-fhir-publisher/icp/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-case-exit | Version: 1.0.0 | |||
Active as of 2022-11-20 | Computable Name: IcpCaseExit | |||
Copyright/Legal: ACC New Zealand© 2023+; Licensed Under Creative Commons No Rights Reserved. |
This profile supports suppliers needing to inform ACC of a patient being exited from their ICP service.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from IcpCase
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
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 finished-status-invariant: The status attribute must be set to 'finished'. |
Slices for extension | 2..2 | Extension | Extension Slice: Unordered, Closed by value:url | |
exit-reason | 1..1 | (Complex) | Exit Reason URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-exit-reason | |
status | 1..1 | code | active | finished | |
type | 0..0 | |||
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
finished-status-invariant | error | EpisodeOfCare | The status attribute must be set to 'finished'. : status = 'finished' |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
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 finished-status-invariant: The status attribute must be set to '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 | 2..2 | Extension | Extension Slice: Unordered, Closed 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 | |
exit-reason | 1..1 | (Complex) | Exit Reason URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-exit-reason | |
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 . |
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. |
Documentation for this format |
Path | Conformance | ValueSet | URI |
EpisodeOfCare.identifier:icpclaimnumber.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
EpisodeOfCare.status | required | ICPStatusVShttp://hl7.org.nz/fhir/ValueSet/acc-icp-episodeofcare-status from this IG | |
EpisodeOfCare.statusHistory.status | required | EpisodeOfCareStatushttp://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1 from the FHIR Standard | |
EpisodeOfCare.type.coding.code | required | ICPServiceType (a valid code from Service Type)http://hl7.org.nz/fhir/ValueSet/acc-icp-service-type from this IG |
Id | Grade | Path(s) | Details | Requirements |
finished-status-invariant | error | EpisodeOfCare | The status attribute must be set to 'finished'. : status = 'finished' |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
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 finished-status-invariant: The status attribute must be set to '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 | ||||
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 | |||||
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 | 2..2 | Extension | Extension Slice: Unordered, Closed 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 | |||||
exit-reason | 1..1 | (Complex) | Exit Reason URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-exit-reason | |||||
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) | ||||
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 | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
EpisodeOfCare.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
EpisodeOfCare.identifier:icpclaimnumber.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
EpisodeOfCare.identifier:icpclaimnumber.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
EpisodeOfCare.status | required | ICPStatusVShttp://hl7.org.nz/fhir/ValueSet/acc-icp-episodeofcare-status from this IG | ||||
EpisodeOfCare.statusHistory.status | required | EpisodeOfCareStatushttp://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1 from the FHIR Standard | ||||
EpisodeOfCare.type.coding.code | required | ICPServiceType (a valid code from Service Type)http://hl7.org.nz/fhir/ValueSet/acc-icp-service-type from this IG | ||||
EpisodeOfCare.diagnosis.role | preferred | DiagnosisRolehttp://hl7.org/fhir/ValueSet/diagnosis-role from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
finished-status-invariant | error | EpisodeOfCare | The status attribute must be set to 'finished'. : status = 'finished' |
This structure is derived from IcpCase
Differential View
This structure is derived from IcpCase
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
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 finished-status-invariant: The status attribute must be set to 'finished'. |
Slices for extension | 2..2 | Extension | Extension Slice: Unordered, Closed by value:url | |
exit-reason | 1..1 | (Complex) | Exit Reason URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-exit-reason | |
status | 1..1 | code | active | finished | |
type | 0..0 | |||
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
finished-status-invariant | error | EpisodeOfCare | The status attribute must be set to 'finished'. : status = 'finished' |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
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 finished-status-invariant: The status attribute must be set to '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 | 2..2 | Extension | Extension Slice: Unordered, Closed 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 | |
exit-reason | 1..1 | (Complex) | Exit Reason URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-exit-reason | |
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 . |
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. |
Documentation for this format |
Path | Conformance | ValueSet | URI |
EpisodeOfCare.identifier:icpclaimnumber.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
EpisodeOfCare.status | required | ICPStatusVShttp://hl7.org.nz/fhir/ValueSet/acc-icp-episodeofcare-status from this IG | |
EpisodeOfCare.statusHistory.status | required | EpisodeOfCareStatushttp://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1 from the FHIR Standard | |
EpisodeOfCare.type.coding.code | required | ICPServiceType (a valid code from Service Type)http://hl7.org.nz/fhir/ValueSet/acc-icp-service-type from this IG |
Id | Grade | Path(s) | Details | Requirements |
finished-status-invariant | error | EpisodeOfCare | The status attribute must be set to 'finished'. : status = 'finished' |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
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 finished-status-invariant: The status attribute must be set to '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 | ||||
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 | |||||
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 | 2..2 | Extension | Extension Slice: Unordered, Closed 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 | |||||
exit-reason | 1..1 | (Complex) | Exit Reason URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-exit-reason | |||||
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) | ||||
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 | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
EpisodeOfCare.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
EpisodeOfCare.identifier:icpclaimnumber.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
EpisodeOfCare.identifier:icpclaimnumber.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
EpisodeOfCare.status | required | ICPStatusVShttp://hl7.org.nz/fhir/ValueSet/acc-icp-episodeofcare-status from this IG | ||||
EpisodeOfCare.statusHistory.status | required | EpisodeOfCareStatushttp://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1 from the FHIR Standard | ||||
EpisodeOfCare.type.coding.code | required | ICPServiceType (a valid code from Service Type)http://hl7.org.nz/fhir/ValueSet/acc-icp-service-type from this IG | ||||
EpisodeOfCare.diagnosis.role | preferred | DiagnosisRolehttp://hl7.org/fhir/ValueSet/diagnosis-role from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
finished-status-invariant | error | EpisodeOfCare | The status attribute must be set to 'finished'. : status = 'finished' |
This structure is derived from IcpCase
Other representations of profile: CSV, Excel, Schematron