New Zealand ICP Implementation Guide
1.1.0 - draft
New Zealand ICP Implementation Guide, published by Accident Compensation Corporation. This guide is not an authorized publication; it is the continuous build for version 1.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/acc-fhir-publisher/icp/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org.nz/fhir/StructureDefinition/acc-patient-referral | Version: 1.1.0 | |||
| Active as of 2022-11-20 | Computable Name: ACCPatientReferral | |||
Copyright/Legal: ACC New Zealand© 2023+; Licensed Under Creative Commons No Rights Reserved. |
||||
The ACC Patient Referral resource.
A Patient Referral resource.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ServiceRequest
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | ServiceRequest | A request for a service to be performed | |
![]() ![]() |
0..* | Resource | Contained, inline Resources Slice: Unordered, Open by profile:$this | |
![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
1..1 | string | ACC Vendor ID URL: http://hl7.org.nz/fhir/StructureDefinition/acc-vendorid | |
![]() ![]() |
1..1 | Identifier | Identifiers assigned to this order Slice: Unordered, Open by value:system | |
![]() ![]() ![]() |
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. | |
![]() ![]() ![]() ![]() |
0..0 | Unique id for inter-element referencing | ||
![]() ![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/acc-45-number | |
![]() ![]() ![]() ![]() |
C | 1..1 | string | The ACC 45 number. Constraints: acc-claim-number |
![]() ![]() ![]() ![]() |
0..0 | Time period when id is/was valid for use | ||
![]() ![]() ![]() ![]() |
0..0 | Organization that issued id (may be just text) | ||
![]() ![]() |
0..0 | Instantiates FHIR protocol or definition | ||
![]() ![]() |
0..0 | Instantiates external protocol or definition | ||
![]() ![]() |
0..0 | What request fulfills | ||
![]() ![]() |
0..0 | What request replaces | ||
![]() ![]() |
0..0 | Composite Request ID | ||
![]() ![]() |
0..0 | True if service/procedure should not be performed | ||
![]() ![]() |
0..0 | Additional order information | ||
![]() ![]() |
0..0 | Service amount | ||
![]() ![]() |
1..1 | Reference(ACC ICP Patient) | Individual or Entity the service is ordered for | |
![]() ![]() |
0..0 | Encounter in which the request was created | ||
![]() ![]() |
0..0 | When service should occur | ||
![]() ![]() |
0..0 | Preconditions for service | ||
![]() ![]() |
C | 1..1 | dateTime | The date and time that the Patient referral to an IDT assessment is created. This must be in UTC yyyy-MM-dd'T'HH:mm:ss'Z'. Constraints: dateTime-not-in-future-invariant |
![]() ![]() |
1..1 | Reference(ACC Provider) | This represents the pracitioner referring the patient to a concussion supplier. | |
![]() ![]() |
0..0 | Requested location | ||
![]() ![]() |
0..0 | Requested location | ||
![]() ![]() |
0..0 | Associated insurance coverage | ||
![]() ![]() |
0..0 | Procedure Samples | ||
![]() ![]() |
0..0 | Location on Body | ||
![]() ![]() |
0..0 | Comments | ||
![]() ![]() |
0..0 | Patient or consumer-oriented instructions | ||
![]() ![]() |
0..0 | Request provenance | ||
Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| acc-claim-number | error | ServiceRequest.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}$')
|
| dateTime-not-in-future-invariant | error | ServiceRequest.authoredOn | The date value cannot be in the future |
$this <= now()
|
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | ServiceRequest | A request for a service to be performed Constraints: prr-1 |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
0..* | Resource | Contained, inline Resources Slice: Unordered, Open by profile:$this | |
![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
1..1 | string | ACC Vendor ID URL: http://hl7.org.nz/fhir/StructureDefinition/acc-vendorid | |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
Σ | 1..1 | Identifier | Identifiers assigned to this order Slice: Unordered, Open by value:system |
![]() ![]() ![]() |
Σ | 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. |
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/acc-45-number |
![]() ![]() ![]() ![]() |
ΣC | 1..1 | string | The ACC 45 number. Constraints: acc-claim-number Example General: 123456 |
![]() ![]() |
?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. |
![]() ![]() |
?!Σ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. |
![]() ![]() |
Σ | 1..1 | Reference(ACC ICP Patient) | Individual or Entity the service is ordered for |
![]() ![]() |
ΣC | 1..1 | dateTime | The date and time that the Patient referral to an IDT assessment is created. This must be in UTC yyyy-MM-dd'T'HH:mm:ss'Z'. Constraints: dateTime-not-in-future-invariant |
![]() ![]() |
Σ | 1..1 | Reference(ACC Provider) | This represents the pracitioner referring the patient to a concussion supplier. |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ServiceRequest.identifier:icpclaimnumber.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| ServiceRequest.status | Base | required | RequestStatus | 📍4.0.1 | FHIR Std. |
| ServiceRequest.intent | Base | required | RequestIntent | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| acc-claim-number | error | ServiceRequest.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}$')
|
| dateTime-not-in-future-invariant | error | ServiceRequest.authoredOn | The date value cannot be in the future |
$this <= now()
|
| dom-2 | error | ServiceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ServiceRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | ServiceRequest | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| prr-1 | error | ServiceRequest | orderDetail SHALL only be present if code is present |
orderDetail.empty() or code.exists()
|
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | ServiceRequest | A request for a service to be performed Constraints: prr-1 | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources Slice: Unordered, Open by profile:$this | |||||
![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
1..1 | string | ACC Vendor ID URL: http://hl7.org.nz/fhir/StructureDefinition/acc-vendorid | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
Σ | 1..1 | Identifier | Identifiers assigned to this order Slice: Unordered, Open by value:system | ||||
![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/acc-45-number | ||||
![]() ![]() ![]() ![]() |
ΣC | 1..1 | string | The ACC 45 number. Constraints: acc-claim-number Example General: 123456 | ||||
![]() ![]() |
?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. | ||||
![]() ![]() |
?!Σ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. | ||||
![]() ![]() |
Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | What is being requested/ordered Binding: ProcedureCodes(SNOMEDCT) (example): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is preferred. | ||||
![]() ![]() |
Σ | 1..1 | Reference(ACC ICP Patient) | Individual or Entity the service is ordered for | ||||
![]() ![]() |
ΣC | 1..1 | dateTime | The date and time that the Patient referral to an IDT assessment is created. This must be in UTC yyyy-MM-dd'T'HH:mm:ss'Z'. Constraints: dateTime-not-in-future-invariant | ||||
![]() ![]() |
Σ | 1..1 | Reference(ACC Provider) | This represents the pracitioner referring the patient to a concussion supplier. | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | Performer role Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. | ||||
![]() ![]() |
Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Requested performer | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation. | ||||
![]() ![]() |
Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service | ||||
![]() ![]() |
0..* | Reference(Resource) | Additional clinical information | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| ServiceRequest.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| ServiceRequest.identifier:icpclaimnumber.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| ServiceRequest.identifier:icpclaimnumber.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| ServiceRequest.status | Base | required | RequestStatus | 📍4.0.1 | FHIR Std. |
| ServiceRequest.intent | Base | required | RequestIntent | 📍4.0.1 | FHIR Std. |
| ServiceRequest.category | Base | example | Service Request Category Codes | 📍4.0.1 | FHIR Std. |
| ServiceRequest.priority | Base | required | Request priority | 📍4.0.1 | FHIR Std. |
| ServiceRequest.code | Base | example | Procedure Codes (SNOMED CT) | 📍4.0.1 | FHIR Std. |
| ServiceRequest.performerType | Base | example | Participant Roles | 📍4.0.1 | FHIR Std. |
| ServiceRequest.reasonCode | Base | example | Procedure Reason Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| acc-claim-number | error | ServiceRequest.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}$')
|
| dateTime-not-in-future-invariant | error | ServiceRequest.authoredOn | The date value cannot be in the future |
$this <= now()
|
| dom-2 | error | ServiceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ServiceRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | ServiceRequest | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| prr-1 | error | ServiceRequest | orderDetail SHALL only be present if code is present |
orderDetail.empty() or code.exists()
|
This structure is derived from ServiceRequest
Summary
Mandatory: 8 elements
Fixed: 1 element
Prohibited: 23 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 ServiceRequest
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | ServiceRequest | A request for a service to be performed | |
![]() ![]() |
0..* | Resource | Contained, inline Resources Slice: Unordered, Open by profile:$this | |
![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
1..1 | string | ACC Vendor ID URL: http://hl7.org.nz/fhir/StructureDefinition/acc-vendorid | |
![]() ![]() |
1..1 | Identifier | Identifiers assigned to this order Slice: Unordered, Open by value:system | |
![]() ![]() ![]() |
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. | |
![]() ![]() ![]() ![]() |
0..0 | Unique id for inter-element referencing | ||
![]() ![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/acc-45-number | |
![]() ![]() ![]() ![]() |
C | 1..1 | string | The ACC 45 number. Constraints: acc-claim-number |
![]() ![]() ![]() ![]() |
0..0 | Time period when id is/was valid for use | ||
![]() ![]() ![]() ![]() |
0..0 | Organization that issued id (may be just text) | ||
![]() ![]() |
0..0 | Instantiates FHIR protocol or definition | ||
![]() ![]() |
0..0 | Instantiates external protocol or definition | ||
![]() ![]() |
0..0 | What request fulfills | ||
![]() ![]() |
0..0 | What request replaces | ||
![]() ![]() |
0..0 | Composite Request ID | ||
![]() ![]() |
0..0 | True if service/procedure should not be performed | ||
![]() ![]() |
0..0 | Additional order information | ||
![]() ![]() |
0..0 | Service amount | ||
![]() ![]() |
1..1 | Reference(ACC ICP Patient) | Individual or Entity the service is ordered for | |
![]() ![]() |
0..0 | Encounter in which the request was created | ||
![]() ![]() |
0..0 | When service should occur | ||
![]() ![]() |
0..0 | Preconditions for service | ||
![]() ![]() |
C | 1..1 | dateTime | The date and time that the Patient referral to an IDT assessment is created. This must be in UTC yyyy-MM-dd'T'HH:mm:ss'Z'. Constraints: dateTime-not-in-future-invariant |
![]() ![]() |
1..1 | Reference(ACC Provider) | This represents the pracitioner referring the patient to a concussion supplier. | |
![]() ![]() |
0..0 | Requested location | ||
![]() ![]() |
0..0 | Requested location | ||
![]() ![]() |
0..0 | Associated insurance coverage | ||
![]() ![]() |
0..0 | Procedure Samples | ||
![]() ![]() |
0..0 | Location on Body | ||
![]() ![]() |
0..0 | Comments | ||
![]() ![]() |
0..0 | Patient or consumer-oriented instructions | ||
![]() ![]() |
0..0 | Request provenance | ||
Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| acc-claim-number | error | ServiceRequest.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}$')
|
| dateTime-not-in-future-invariant | error | ServiceRequest.authoredOn | The date value cannot be in the future |
$this <= now()
|
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | ServiceRequest | A request for a service to be performed Constraints: prr-1 |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
0..* | Resource | Contained, inline Resources Slice: Unordered, Open by profile:$this | |
![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
1..1 | string | ACC Vendor ID URL: http://hl7.org.nz/fhir/StructureDefinition/acc-vendorid | |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
Σ | 1..1 | Identifier | Identifiers assigned to this order Slice: Unordered, Open by value:system |
![]() ![]() ![]() |
Σ | 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. |
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/acc-45-number |
![]() ![]() ![]() ![]() |
ΣC | 1..1 | string | The ACC 45 number. Constraints: acc-claim-number Example General: 123456 |
![]() ![]() |
?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. |
![]() ![]() |
?!Σ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. |
![]() ![]() |
Σ | 1..1 | Reference(ACC ICP Patient) | Individual or Entity the service is ordered for |
![]() ![]() |
ΣC | 1..1 | dateTime | The date and time that the Patient referral to an IDT assessment is created. This must be in UTC yyyy-MM-dd'T'HH:mm:ss'Z'. Constraints: dateTime-not-in-future-invariant |
![]() ![]() |
Σ | 1..1 | Reference(ACC Provider) | This represents the pracitioner referring the patient to a concussion supplier. |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ServiceRequest.identifier:icpclaimnumber.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| ServiceRequest.status | Base | required | RequestStatus | 📍4.0.1 | FHIR Std. |
| ServiceRequest.intent | Base | required | RequestIntent | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| acc-claim-number | error | ServiceRequest.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}$')
|
| dateTime-not-in-future-invariant | error | ServiceRequest.authoredOn | The date value cannot be in the future |
$this <= now()
|
| dom-2 | error | ServiceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ServiceRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | ServiceRequest | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| prr-1 | error | ServiceRequest | orderDetail SHALL only be present if code is present |
orderDetail.empty() or code.exists()
|
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | ServiceRequest | A request for a service to be performed Constraints: prr-1 | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources Slice: Unordered, Open by profile:$this | |||||
![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
1..1 | string | ACC Vendor ID URL: http://hl7.org.nz/fhir/StructureDefinition/acc-vendorid | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
Σ | 1..1 | Identifier | Identifiers assigned to this order Slice: Unordered, Open by value:system | ||||
![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/acc-45-number | ||||
![]() ![]() ![]() ![]() |
ΣC | 1..1 | string | The ACC 45 number. Constraints: acc-claim-number Example General: 123456 | ||||
![]() ![]() |
?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. | ||||
![]() ![]() |
?!Σ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. | ||||
![]() ![]() |
Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | What is being requested/ordered Binding: ProcedureCodes(SNOMEDCT) (example): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is preferred. | ||||
![]() ![]() |
Σ | 1..1 | Reference(ACC ICP Patient) | Individual or Entity the service is ordered for | ||||
![]() ![]() |
ΣC | 1..1 | dateTime | The date and time that the Patient referral to an IDT assessment is created. This must be in UTC yyyy-MM-dd'T'HH:mm:ss'Z'. Constraints: dateTime-not-in-future-invariant | ||||
![]() ![]() |
Σ | 1..1 | Reference(ACC Provider) | This represents the pracitioner referring the patient to a concussion supplier. | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | Performer role Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. | ||||
![]() ![]() |
Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Requested performer | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation. | ||||
![]() ![]() |
Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service | ||||
![]() ![]() |
0..* | Reference(Resource) | Additional clinical information | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| ServiceRequest.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| ServiceRequest.identifier:icpclaimnumber.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| ServiceRequest.identifier:icpclaimnumber.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| ServiceRequest.status | Base | required | RequestStatus | 📍4.0.1 | FHIR Std. |
| ServiceRequest.intent | Base | required | RequestIntent | 📍4.0.1 | FHIR Std. |
| ServiceRequest.category | Base | example | Service Request Category Codes | 📍4.0.1 | FHIR Std. |
| ServiceRequest.priority | Base | required | Request priority | 📍4.0.1 | FHIR Std. |
| ServiceRequest.code | Base | example | Procedure Codes (SNOMED CT) | 📍4.0.1 | FHIR Std. |
| ServiceRequest.performerType | Base | example | Participant Roles | 📍4.0.1 | FHIR Std. |
| ServiceRequest.reasonCode | Base | example | Procedure Reason Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| acc-claim-number | error | ServiceRequest.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}$')
|
| dateTime-not-in-future-invariant | error | ServiceRequest.authoredOn | The date value cannot be in the future |
$this <= now()
|
| dom-2 | error | ServiceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ServiceRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | ServiceRequest | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| prr-1 | error | ServiceRequest | orderDetail SHALL only be present if code is present |
orderDetail.empty() or code.exists()
|
This structure is derived from ServiceRequest
Summary
Mandatory: 8 elements
Fixed: 1 element
Prohibited: 23 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