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-referral-decline | Version: 1.0.0 | |||
Active as of 2022-11-20 | Computable Name: IcpReferralDecline | |||
Copyright/Legal: ACC New Zealand© 2023+; Licensed Under Creative Commons No Rights Reserved. |
The ICP Referral Decline profile is to be used by ICP suppliers to furnish ACC with the required information following them declining an ICP referral.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Encounter
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Encounter | 0..* | Encounter | An interaction during which services are provided to the patient | |
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 | 3..4 | Extension | Extension Slice: Unordered, Closed by value:url | |
acc-providerid | 1..1 | string | The ACC provider Id of the practioner providing this information URL: http://hl7.org.nz/fhir/StructureDefinition/acc-providerid | |
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 | |
referral-declined | 1..1 | (Complex) | The declined reason and details for declining the referral URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-referral-declined | |
triage | 0..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 | Content/Rules for all slices | |||
extension:client-participation-agreement | 0..1 | ClientPatricitionAgreement | Client Participation Agreement | |
value[x] | 0..0 | |||
Slices for identifier | 1..1 | Identifier | Identifier(s) by which this encounter is known 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 | |||
status | 1..1 | code | finished Binding: Encounter Status (required) | |
statusHistory | 0..0 | |||
class | 1..1 | Coding | PRENC Binding: Encounter Class (required) | |
classHistory | 0..0 | |||
type | 0..0 | |||
serviceType | 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 | 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) | |
priority | 0..0 | |||
subject | 1..1 | Reference(ACC ICP Patient) | The patient or group present at the encounter | |
episodeOfCare | 0..0 | |||
basedOn | 0..0 | |||
participant | 0..0 | |||
appointment | 0..0 | |||
period | 0..0 | |||
length | 0..0 | |||
reasonCode | 0..0 | |||
reasonReference | 0..0 | |||
diagnosis | 0..0 | |||
account | 0..0 | |||
hospitalization | 0..0 | |||
location | 0..0 | |||
serviceProvider | 1..1 | Reference(Organization) | This is the ACC Vendor ID, in most cases this is the organisation's HPI ID. | |
partOf | 0..0 | |||
Documentation for this format |
Path | Conformance | ValueSet | URI |
Encounter.status | required | ICPEncounterStatusVShttp://hl7.org.nz/fhir/ValueSet/acc-icp-encounter-status from this IG | |
Encounter.class | required | ICPEncounterClassVShttp://hl7.org.nz/fhir/ValueSet/acc-icp-encounter-class from this IG | |
Encounter.serviceType.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 |
acc-claim-number | error | Encounter.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}$') |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Encounter | 0..* | Encounter | An interaction during which services are provided to the patient | |
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 | 3..4 | Extension | Extension Slice: Unordered, Closed by value:url | |
acc-providerid | 1..1 | string | The ACC provider Id of the practioner providing this information URL: http://hl7.org.nz/fhir/StructureDefinition/acc-providerid | |
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 | |
referral-declined | C | 1..1 | (Complex) | The declined reason and details for declining the referral URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-referral-declined other-reason-invariant: if reason code is 'other', other-reason is required. not-other-reason-invariant: if reason code is not 'other', other-reason must not be populated. |
triage | 0..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 | |
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 | |
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 | |
complexityScores | 1..1 | (Complex) | The scores obtained from the ICP complexity assessment/tool. URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-complexity-scores | |
client-participation-agreement | 0..1 | (Complex) | Client Participation Agreement URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-client-participation-agreement | |
extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/acc-icp-client-participation-agreement" | |
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 | Identifier(s) by which this encounter is known 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 | finished Binding: Encounter Status (required) |
class | Σ | 1..1 | Coding | PRENC Binding: Encounter Class (required) |
serviceType | Σ | 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: ServiceType (example): Broad categorization of the service that is to be provided. |
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) |
subject | Σ | 1..1 | Reference(ACC ICP Patient) | The patient or group present at the encounter |
serviceProvider | 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 |
Encounter.identifier:icpclaimnumber.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Encounter.status | required | ICPEncounterStatusVShttp://hl7.org.nz/fhir/ValueSet/acc-icp-encounter-status from this IG | |
Encounter.statusHistory.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard | |
Encounter.class | required | ICPEncounterClassVShttp://hl7.org.nz/fhir/ValueSet/acc-icp-encounter-class from this IG | |
Encounter.classHistory.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | |
Encounter.serviceType | example | ServiceTypehttp://hl7.org/fhir/ValueSet/service-type from the FHIR Standard | |
Encounter.serviceType.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 |
acc-claim-number | error | Encounter.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}$') |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Encounter | 0..* | Encounter | An interaction during which services are provided to the patient | |||||
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 | 3..4 | Extension | Extension Slice: Unordered, Closed by value:url | |||||
acc-providerid | 1..1 | string | The ACC provider Id of the practioner providing this information URL: http://hl7.org.nz/fhir/StructureDefinition/acc-providerid | |||||
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 | |||||
referral-declined | C | 1..1 | (Complex) | The declined reason and details for declining the referral URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-referral-declined other-reason-invariant: if reason code is 'other', other-reason is required. not-other-reason-invariant: if reason code is not 'other', other-reason must not be populated. | ||||
triage | 0..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 | |||||
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 | |||||
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 | |||||
complexityScores | 1..1 | (Complex) | The scores obtained from the ICP complexity assessment/tool. URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-complexity-scores | |||||
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 | |||||||
url | 1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/acc-icp-client-participation-agreement" | |||||
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 | Identifier(s) by which this encounter is known 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 | finished Binding: Encounter Status (required) | ||||
class | Σ | 1..1 | Coding | PRENC Binding: Encounter Class (required) | ||||
serviceType | Σ | 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: ServiceType (example): Broad categorization of the service that is to be provided. | ||||
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 | ||||
subject | Σ | 1..1 | Reference(ACC ICP Patient) | The patient or group present at the encounter | ||||
serviceProvider | 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 | |||
Encounter.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Encounter.identifier:icpclaimnumber.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Encounter.identifier:icpclaimnumber.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Encounter.status | required | ICPEncounterStatusVShttp://hl7.org.nz/fhir/ValueSet/acc-icp-encounter-status from this IG | ||||
Encounter.statusHistory.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard | ||||
Encounter.class | required | ICPEncounterClassVShttp://hl7.org.nz/fhir/ValueSet/acc-icp-encounter-class from this IG | ||||
Encounter.classHistory.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | ||||
Encounter.serviceType | example | ServiceTypehttp://hl7.org/fhir/ValueSet/service-type from the FHIR Standard | ||||
Encounter.serviceType.coding.code | required | ICPServiceType (a valid code from Service Type)http://hl7.org.nz/fhir/ValueSet/acc-icp-service-type from this IG | ||||
Encounter.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard | ||||
Encounter.diagnosis.use | preferred | DiagnosisRolehttp://hl7.org/fhir/ValueSet/diagnosis-role from the FHIR Standard | ||||
Encounter.hospitalization.admitSource | preferred | AdmitSourcehttp://hl7.org/fhir/ValueSet/encounter-admit-source from the FHIR Standard | ||||
Encounter.hospitalization.reAdmission | example | Hl7VSReAdmissionIndicatorhttp://terminology.hl7.org/ValueSet/v2-0092 | ||||
Encounter.hospitalization.dietPreference | example | Diethttp://hl7.org/fhir/ValueSet/encounter-diet from the FHIR Standard | ||||
Encounter.hospitalization.specialCourtesy | preferred | SpecialCourtesyhttp://hl7.org/fhir/ValueSet/encounter-special-courtesy from the FHIR Standard | ||||
Encounter.hospitalization.specialArrangement | preferred | SpecialArrangementshttp://hl7.org/fhir/ValueSet/encounter-special-arrangements from the FHIR Standard | ||||
Encounter.hospitalization.dischargeDisposition | example | DischargeDispositionhttp://hl7.org/fhir/ValueSet/encounter-discharge-disposition from the FHIR Standard | ||||
Encounter.location.status | required | EncounterLocationStatushttp://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1 from the FHIR Standard | ||||
Encounter.location.physicalType | example | LocationTypehttp://hl7.org/fhir/ValueSet/location-physical-type from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
acc-claim-number | error | Encounter.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}$') |
This structure is derived from Encounter
Summary
Mandatory: 15 elements
Fixed: 1 element
Prohibited: 22 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Encounter
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Encounter | 0..* | Encounter | An interaction during which services are provided to the patient | |
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 | 3..4 | Extension | Extension Slice: Unordered, Closed by value:url | |
acc-providerid | 1..1 | string | The ACC provider Id of the practioner providing this information URL: http://hl7.org.nz/fhir/StructureDefinition/acc-providerid | |
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 | |
referral-declined | 1..1 | (Complex) | The declined reason and details for declining the referral URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-referral-declined | |
triage | 0..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 | Content/Rules for all slices | |||
extension:client-participation-agreement | 0..1 | ClientPatricitionAgreement | Client Participation Agreement | |
value[x] | 0..0 | |||
Slices for identifier | 1..1 | Identifier | Identifier(s) by which this encounter is known 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 | |||
status | 1..1 | code | finished Binding: Encounter Status (required) | |
statusHistory | 0..0 | |||
class | 1..1 | Coding | PRENC Binding: Encounter Class (required) | |
classHistory | 0..0 | |||
type | 0..0 | |||
serviceType | 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 | 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) | |
priority | 0..0 | |||
subject | 1..1 | Reference(ACC ICP Patient) | The patient or group present at the encounter | |
episodeOfCare | 0..0 | |||
basedOn | 0..0 | |||
participant | 0..0 | |||
appointment | 0..0 | |||
period | 0..0 | |||
length | 0..0 | |||
reasonCode | 0..0 | |||
reasonReference | 0..0 | |||
diagnosis | 0..0 | |||
account | 0..0 | |||
hospitalization | 0..0 | |||
location | 0..0 | |||
serviceProvider | 1..1 | Reference(Organization) | This is the ACC Vendor ID, in most cases this is the organisation's HPI ID. | |
partOf | 0..0 | |||
Documentation for this format |
Path | Conformance | ValueSet | URI |
Encounter.status | required | ICPEncounterStatusVShttp://hl7.org.nz/fhir/ValueSet/acc-icp-encounter-status from this IG | |
Encounter.class | required | ICPEncounterClassVShttp://hl7.org.nz/fhir/ValueSet/acc-icp-encounter-class from this IG | |
Encounter.serviceType.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 |
acc-claim-number | error | Encounter.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}$') |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Encounter | 0..* | Encounter | An interaction during which services are provided to the patient | |
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 | 3..4 | Extension | Extension Slice: Unordered, Closed by value:url | |
acc-providerid | 1..1 | string | The ACC provider Id of the practioner providing this information URL: http://hl7.org.nz/fhir/StructureDefinition/acc-providerid | |
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 | |
referral-declined | C | 1..1 | (Complex) | The declined reason and details for declining the referral URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-referral-declined other-reason-invariant: if reason code is 'other', other-reason is required. not-other-reason-invariant: if reason code is not 'other', other-reason must not be populated. |
triage | 0..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 | |
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 | |
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 | |
complexityScores | 1..1 | (Complex) | The scores obtained from the ICP complexity assessment/tool. URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-complexity-scores | |
client-participation-agreement | 0..1 | (Complex) | Client Participation Agreement URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-client-participation-agreement | |
extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/acc-icp-client-participation-agreement" | |
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 | Identifier(s) by which this encounter is known 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 | finished Binding: Encounter Status (required) |
class | Σ | 1..1 | Coding | PRENC Binding: Encounter Class (required) |
serviceType | Σ | 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: ServiceType (example): Broad categorization of the service that is to be provided. |
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) |
subject | Σ | 1..1 | Reference(ACC ICP Patient) | The patient or group present at the encounter |
serviceProvider | 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 |
Encounter.identifier:icpclaimnumber.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Encounter.status | required | ICPEncounterStatusVShttp://hl7.org.nz/fhir/ValueSet/acc-icp-encounter-status from this IG | |
Encounter.statusHistory.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard | |
Encounter.class | required | ICPEncounterClassVShttp://hl7.org.nz/fhir/ValueSet/acc-icp-encounter-class from this IG | |
Encounter.classHistory.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | |
Encounter.serviceType | example | ServiceTypehttp://hl7.org/fhir/ValueSet/service-type from the FHIR Standard | |
Encounter.serviceType.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 |
acc-claim-number | error | Encounter.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}$') |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Encounter | 0..* | Encounter | An interaction during which services are provided to the patient | |||||
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 | 3..4 | Extension | Extension Slice: Unordered, Closed by value:url | |||||
acc-providerid | 1..1 | string | The ACC provider Id of the practioner providing this information URL: http://hl7.org.nz/fhir/StructureDefinition/acc-providerid | |||||
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 | |||||
referral-declined | C | 1..1 | (Complex) | The declined reason and details for declining the referral URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-referral-declined other-reason-invariant: if reason code is 'other', other-reason is required. not-other-reason-invariant: if reason code is not 'other', other-reason must not be populated. | ||||
triage | 0..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 | |||||
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 | |||||
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 | |||||
complexityScores | 1..1 | (Complex) | The scores obtained from the ICP complexity assessment/tool. URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-complexity-scores | |||||
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 | |||||||
url | 1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/acc-icp-client-participation-agreement" | |||||
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 | Identifier(s) by which this encounter is known 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 | finished Binding: Encounter Status (required) | ||||
class | Σ | 1..1 | Coding | PRENC Binding: Encounter Class (required) | ||||
serviceType | Σ | 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: ServiceType (example): Broad categorization of the service that is to be provided. | ||||
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 | ||||
subject | Σ | 1..1 | Reference(ACC ICP Patient) | The patient or group present at the encounter | ||||
serviceProvider | 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 | |||
Encounter.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Encounter.identifier:icpclaimnumber.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Encounter.identifier:icpclaimnumber.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Encounter.status | required | ICPEncounterStatusVShttp://hl7.org.nz/fhir/ValueSet/acc-icp-encounter-status from this IG | ||||
Encounter.statusHistory.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard | ||||
Encounter.class | required | ICPEncounterClassVShttp://hl7.org.nz/fhir/ValueSet/acc-icp-encounter-class from this IG | ||||
Encounter.classHistory.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | ||||
Encounter.serviceType | example | ServiceTypehttp://hl7.org/fhir/ValueSet/service-type from the FHIR Standard | ||||
Encounter.serviceType.coding.code | required | ICPServiceType (a valid code from Service Type)http://hl7.org.nz/fhir/ValueSet/acc-icp-service-type from this IG | ||||
Encounter.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard | ||||
Encounter.diagnosis.use | preferred | DiagnosisRolehttp://hl7.org/fhir/ValueSet/diagnosis-role from the FHIR Standard | ||||
Encounter.hospitalization.admitSource | preferred | AdmitSourcehttp://hl7.org/fhir/ValueSet/encounter-admit-source from the FHIR Standard | ||||
Encounter.hospitalization.reAdmission | example | Hl7VSReAdmissionIndicatorhttp://terminology.hl7.org/ValueSet/v2-0092 | ||||
Encounter.hospitalization.dietPreference | example | Diethttp://hl7.org/fhir/ValueSet/encounter-diet from the FHIR Standard | ||||
Encounter.hospitalization.specialCourtesy | preferred | SpecialCourtesyhttp://hl7.org/fhir/ValueSet/encounter-special-courtesy from the FHIR Standard | ||||
Encounter.hospitalization.specialArrangement | preferred | SpecialArrangementshttp://hl7.org/fhir/ValueSet/encounter-special-arrangements from the FHIR Standard | ||||
Encounter.hospitalization.dischargeDisposition | example | DischargeDispositionhttp://hl7.org/fhir/ValueSet/encounter-discharge-disposition from the FHIR Standard | ||||
Encounter.location.status | required | EncounterLocationStatushttp://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1 from the FHIR Standard | ||||
Encounter.location.physicalType | example | LocationTypehttp://hl7.org/fhir/ValueSet/location-physical-type from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
acc-claim-number | error | Encounter.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}$') |
This structure is derived from Encounter
Summary
Mandatory: 15 elements
Fixed: 1 element
Prohibited: 22 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron