Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.7 - release
Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.7 - release
Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.7) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOServiceRequest | Version: 0.0.1 | |||
| Draft as of 2026-10-13 | Computable Name: DHOServiceRequest | |||
This profile derives from the ServiceRequest Resource, providing a lightweight referral/order resource for use in the Dunedin Hospital Outpatients context.
Lightweight Dunedin Hospital Outpatient Service Request used to represent referrals/orders for outpatient services
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  ServiceRequest |
C | 0..* | ServiceRequest | A request for a service to be performed Constraints: prr-1 |
  identifier |
0..* | Identifier | External (provider) and Health NZ business identifiers | |
   use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
| system |
0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |
 value |
1..1 | string | The value that is unique Example General: 123456 | |
| status |
1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. | |
| intent |
1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. | |
| category |
0..1 | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. | |
| priority |
0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | |
| code |
1..1 | CodeableConcept | The specialty or service being requested Binding: DHO Health Speciality ValueSet (extensible) | |
 subject |
1..1 | Reference(DHO Patient Profile | NZ Patient | Patient) | Individual or Entity the service is ordered for | |
| type |
1..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Patient | |
 identifier |
1..1 | Identifier | Logical reference, when literal reference is not known | |
 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/nhi-id | |
| value |
C | 1..1 | string | Must be an absolute URL reference to the patient on the NHI system. See constraints for details. Constraints: dho-nhi-value-format Example General: 123456 |
| encounter |
0..1 | Reference(DHO Encounter profile | Encounter) | Encounter in which the request was created | |
 occurrence[x] |
0..1 | When service should occur | ||
| occurrenceDateTime |
dateTime | |||
| occurrencePeriod |
Period | |||
| authoredOn |
0..1 | dateTime | Date request signed | |
| requester |
0..1 | Reference(Practitioner resource for use in NZ | PractitionerRole resource for use in NZ | Organization resource for use in NZ) | The clinician or organisation making the referral | |
| performer |
0..* | Reference(Practitioner resource for use in NZ | PractitionerRole resource for use in NZ | HealthcareService resource for use in NZ | Organization resource for use in NZ) | The clinician, team or service the referral is directed to | |
| locationReference |
0..1 | Reference(DHO Location Profile) | The location the referred service will be delivered at | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ServiceRequest.identifier.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. |
| 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 | extensible | DHO Health Speciality ValueSet | 📦0.4.7 | This IG |
| ServiceRequest.subject.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| ServiceRequest.subject.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dho-nhi-value-format | error | ServiceRequest.subject.identifier.value | Reference must be an NHI Patient URL with format ZZZ1111 or ZZZ11AA |
matches('^[A-Z]{3}([0-9]{4}|[0-9]{2}[A-Z]{2})$')
|
This structure is derived from ServiceRequest
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ServiceRequest |
0..* | ServiceRequest | A request for a service to be performed | |
 meta |
||||
| source |
1..1 | uri | HPI Facility ID from where the record is sourced | |
 Slices for tag |
1..* | Coding | Correlation-id where the record is sourced Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
  tag:correlationId |
1..1 | Coding | Tags applied to this resource | |
 system |
1..1 | uri | Identity of the terminology system Fixed Value: https://hub.services.digital.health.nz/ns/correlation-id | |
 code |
1..1 | code | Symbol in syntax defined by the system | |
| implicitRules |
0..0 | A set of rules under which this content was created | ||
| language |
0..0 | Language of the resource content | ||
 modifierExtension |
0..0 | Extension | ||
| identifier |
0..* | Identifier | External (provider) and Health NZ business identifiers | |
| id |
0..0 | Unique id for inter-element referencing | ||
| use |
0..1 | code | usual | official | temp | secondary | old (If known) | |
| system |
0..1 | uri | The namespace for the identifier value | |
| value |
1..1 | string | The value that is unique | |
| period |
0..0 | Time period when id is/was valid for use | ||
| instantiatesCanonical |
0..0 | Instantiates FHIR protocol or definition | ||
| instantiatesUri |
0..0 | Instantiates external protocol or definition | ||
| basedOn |
0..0 | What request fulfills | ||
| replaces |
0..0 | What request replaces | ||
| requisition |
0..0 | Composite Request ID | ||
| status |
1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown | |
| intent |
1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option | |
| category |
0..1 | CodeableConcept | Classification of service | |
| priority |
0..1 | code | routine | urgent | asap | stat | |
| doNotPerform |
0..0 | True if service/procedure should not be performed | ||
| code |
1..1 | CodeableConcept | The specialty or service being requested Binding: DHO Health Speciality ValueSet (extensible) | |
| orderDetail |
0..0 | Additional order information | ||
| quantity[x] |
0..0 | Service amount | ||
| subject |
1..1 | Reference(DHO Patient Profile | NZ Patient | Patient) | Individual or Entity the service is ordered for | |
| type |
1..1 | uri | Type the reference refers to (e.g. "Patient") Required Pattern: Patient | |
| identifier |
1..1 | Identifier | Logical reference, when literal reference is not known | |
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id | |
| value |
C | 1..1 | string | Must be an absolute URL reference to the patient on the NHI system. See constraints for details. Constraints: dho-nhi-value-format |
| encounter |
0..1 | Reference(DHO Encounter profile | Encounter) | Encounter in which the request was created | |
| occurrence[x] |
0..1 | When service should occur | ||
| occurrenceDateTime |
dateTime | |||
| occurrencePeriod |
Period | |||
| asNeeded[x] |
0..0 | Preconditions for service | ||
| authoredOn |
0..1 | dateTime | Date request signed | |
| requester |
0..1 | Reference(Practitioner resource for use in NZ | PractitionerRole resource for use in NZ | Organization resource for use in NZ) | The clinician or organisation making the referral | |
| performerType |
0..0 | Performer role | ||
| performer |
0..* | Reference(Practitioner resource for use in NZ | PractitionerRole resource for use in NZ | HealthcareService resource for use in NZ | Organization resource for use in NZ) | The clinician, team or service the referral is directed to | |
| locationCode |
0..0 | Requested location | ||
| locationReference |
0..1 | Reference(DHO Location Profile) | The location the referred service will be delivered at | |
| insurance |
0..0 | Associated insurance coverage | ||
| supportingInfo |
0..0 | Additional clinical information | ||
| specimen |
0..0 | Procedure Samples | ||
| bodySite |
0..0 | Location on Body | ||
| relevantHistory |
0..0 | Request provenance | ||
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ServiceRequest.code | Base | extensible | DHO Health Speciality ValueSet | 📦0.4.7 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| dho-nhi-value-format | error | ServiceRequest.subject.identifier.value | Reference must be an NHI Patient URL with format ZZZ1111 or ZZZ11AA |
matches('^[A-Z]{3}([0-9]{4}|[0-9]{2}[A-Z]{2})$')
|
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ServiceRequest |
C | 0..* | ServiceRequest | A request for a service to be performed Constraints: prr-1 |
| id |
0..1 | id | Logical id of this artifact | |
| meta |
0..1 | Meta | Metadata about the resource | |
| id |
0..1 | string | Unique id for inter-element referencing | |
 extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| versionId |
0..1 | id | Version specific identifier | |
| lastUpdated |
0..1 | instant | When the resource version last changed | |
| source |
1..1 | uri | HPI Facility ID from where the record is sourced | |
| profile |
0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | |
| security |
0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |
| Slices for tag |
1..* | Coding | Correlation-id where the record is sourced Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| tag:correlationId |
1..1 | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | |
| 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 Fixed Value: https://hub.services.digital.health.nz/ns/correlation-id | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system | |
| 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 | 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 | |
| contained |
0..* | Resource | Contained, inline Resources | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| identifier |
0..* | Identifier | External (provider) and Health NZ business identifiers | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| 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 |
0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |
| value |
1..1 | string | The value that is unique Example General: 123456 | |
| assigner |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |
| status |
1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. | |
| intent |
1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. | |
| category |
0..1 | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. | |
| priority |
0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | |
| code |
1..1 | CodeableConcept | The specialty or service being requested Binding: DHO Health Speciality ValueSet (extensible) | |
| subject |
1..1 | Reference(DHO Patient Profile | NZ Patient | Patient) | Individual or Entity the service is ordered for | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type |
1..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Patient | |
| identifier |
1..1 | Identifier | Logical reference, when literal reference is not known | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| 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/nhi-id | |
| value |
C | 1..1 | string | Must be an absolute URL reference to the patient on the NHI system. See constraints for details. Constraints: dho-nhi-value-format Example General: 123456 |
| period |
0..1 | Period | Time period when id is/was valid for use | |
| assigner |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |
| display |
0..1 | string | Text alternative for the resource | |
| encounter |
0..1 | Reference(DHO Encounter profile | Encounter) | Encounter in which the request was created | |
| occurrence[x] |
0..1 | When service should occur | ||
| occurrenceDateTime |
dateTime | |||
| occurrencePeriod |
Period | |||
| authoredOn |
0..1 | dateTime | Date request signed | |
| requester |
0..1 | Reference(Practitioner resource for use in NZ | PractitionerRole resource for use in NZ | Organization resource for use in NZ) | The clinician or organisation making the referral | |
| performer |
0..* | Reference(Practitioner resource for use in NZ | PractitionerRole resource for use in NZ | HealthcareService resource for use in NZ | Organization resource for use in NZ) | The clinician, team or service the referral is directed to | |
| locationReference |
0..1 | Reference(DHO Location Profile) | The location the referred service will be delivered at | |
| reasonCode |
0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation. | |
| reasonReference |
0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service | |
| note |
0..* | Annotation | Comments | |
| patientInstruction |
0..1 | string | Patient or consumer-oriented instructions | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ServiceRequest.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| ServiceRequest.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| ServiceRequest.meta.tag:correlationId | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| ServiceRequest.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| ServiceRequest.identifier.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 | extensible | DHO Health Speciality ValueSet | 📦0.4.7 | This IG |
| ServiceRequest.subject.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| ServiceRequest.subject.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| ServiceRequest.subject.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| ServiceRequest.reasonCode | Base | example | Procedure Reason Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dho-nhi-value-format | error | ServiceRequest.subject.identifier.value | Reference must be an NHI Patient URL with format ZZZ1111 or ZZZ11AA |
matches('^[A-Z]{3}([0-9]{4}|[0-9]{2}[A-Z]{2})$')
|
This structure is derived from ServiceRequest
Summary
Mandatory: 5 elements(6 nested mandatory elements)
Must-Support: 10 elements
Fixed: 2 elements
Prohibited: 21 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ServiceRequest |
C | 0..* | ServiceRequest | A request for a service to be performed Constraints: prr-1 |
| identifier |
0..* | Identifier | External (provider) and Health NZ business identifiers | |
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
| system |
0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |
| value |
1..1 | string | The value that is unique Example General: 123456 | |
| status |
1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. | |
| intent |
1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. | |
| category |
0..1 | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. | |
| priority |
0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | |
| code |
1..1 | CodeableConcept | The specialty or service being requested Binding: DHO Health Speciality ValueSet (extensible) | |
| subject |
1..1 | Reference(DHO Patient Profile | NZ Patient | Patient) | Individual or Entity the service is ordered for | |
| type |
1..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Patient | |
| identifier |
1..1 | Identifier | Logical reference, when literal reference is not known | |
| 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/nhi-id | |
| value |
C | 1..1 | string | Must be an absolute URL reference to the patient on the NHI system. See constraints for details. Constraints: dho-nhi-value-format Example General: 123456 |
| encounter |
0..1 | Reference(DHO Encounter profile | Encounter) | Encounter in which the request was created | |
| occurrence[x] |
0..1 | When service should occur | ||
| occurrenceDateTime |
dateTime | |||
| occurrencePeriod |
Period | |||
| authoredOn |
0..1 | dateTime | Date request signed | |
| requester |
0..1 | Reference(Practitioner resource for use in NZ | PractitionerRole resource for use in NZ | Organization resource for use in NZ) | The clinician or organisation making the referral | |
| performer |
0..* | Reference(Practitioner resource for use in NZ | PractitionerRole resource for use in NZ | HealthcareService resource for use in NZ | Organization resource for use in NZ) | The clinician, team or service the referral is directed to | |
| locationReference |
0..1 | Reference(DHO Location Profile) | The location the referred service will be delivered at | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ServiceRequest.identifier.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. |
| 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 | extensible | DHO Health Speciality ValueSet | 📦0.4.7 | This IG |
| ServiceRequest.subject.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| ServiceRequest.subject.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dho-nhi-value-format | error | ServiceRequest.subject.identifier.value | Reference must be an NHI Patient URL with format ZZZ1111 or ZZZ11AA |
matches('^[A-Z]{3}([0-9]{4}|[0-9]{2}[A-Z]{2})$')
|
Differential View
This structure is derived from ServiceRequest
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ServiceRequest |
0..* | ServiceRequest | A request for a service to be performed | |
| meta |
||||
| source |
1..1 | uri | HPI Facility ID from where the record is sourced | |
| Slices for tag |
1..* | Coding | Correlation-id where the record is sourced Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| tag:correlationId |
1..1 | Coding | Tags applied to this resource | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: https://hub.services.digital.health.nz/ns/correlation-id | |
| code |
1..1 | code | Symbol in syntax defined by the system | |
| implicitRules |
0..0 | A set of rules under which this content was created | ||
| language |
0..0 | Language of the resource content | ||
| modifierExtension |
0..0 | Extension | ||
| identifier |
0..* | Identifier | External (provider) and Health NZ business identifiers | |
| id |
0..0 | Unique id for inter-element referencing | ||
| use |
0..1 | code | usual | official | temp | secondary | old (If known) | |
| system |
0..1 | uri | The namespace for the identifier value | |
| value |
1..1 | string | The value that is unique | |
| period |
0..0 | Time period when id is/was valid for use | ||
| instantiatesCanonical |
0..0 | Instantiates FHIR protocol or definition | ||
| instantiatesUri |
0..0 | Instantiates external protocol or definition | ||
| basedOn |
0..0 | What request fulfills | ||
| replaces |
0..0 | What request replaces | ||
| requisition |
0..0 | Composite Request ID | ||
| status |
1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown | |
| intent |
1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option | |
| category |
0..1 | CodeableConcept | Classification of service | |
| priority |
0..1 | code | routine | urgent | asap | stat | |
| doNotPerform |
0..0 | True if service/procedure should not be performed | ||
| code |
1..1 | CodeableConcept | The specialty or service being requested Binding: DHO Health Speciality ValueSet (extensible) | |
| orderDetail |
0..0 | Additional order information | ||
| quantity[x] |
0..0 | Service amount | ||
| subject |
1..1 | Reference(DHO Patient Profile | NZ Patient | Patient) | Individual or Entity the service is ordered for | |
| type |
1..1 | uri | Type the reference refers to (e.g. "Patient") Required Pattern: Patient | |
| identifier |
1..1 | Identifier | Logical reference, when literal reference is not known | |
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id | |
| value |
C | 1..1 | string | Must be an absolute URL reference to the patient on the NHI system. See constraints for details. Constraints: dho-nhi-value-format |
| encounter |
0..1 | Reference(DHO Encounter profile | Encounter) | Encounter in which the request was created | |
| occurrence[x] |
0..1 | When service should occur | ||
| occurrenceDateTime |
dateTime | |||
| occurrencePeriod |
Period | |||
| asNeeded[x] |
0..0 | Preconditions for service | ||
| authoredOn |
0..1 | dateTime | Date request signed | |
| requester |
0..1 | Reference(Practitioner resource for use in NZ | PractitionerRole resource for use in NZ | Organization resource for use in NZ) | The clinician or organisation making the referral | |
| performerType |
0..0 | Performer role | ||
| performer |
0..* | Reference(Practitioner resource for use in NZ | PractitionerRole resource for use in NZ | HealthcareService resource for use in NZ | Organization resource for use in NZ) | The clinician, team or service the referral is directed to | |
| locationCode |
0..0 | Requested location | ||
| locationReference |
0..1 | Reference(DHO Location Profile) | The location the referred service will be delivered at | |
| insurance |
0..0 | Associated insurance coverage | ||
| supportingInfo |
0..0 | Additional clinical information | ||
| specimen |
0..0 | Procedure Samples | ||
| bodySite |
0..0 | Location on Body | ||
| relevantHistory |
0..0 | Request provenance | ||
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ServiceRequest.code | Base | extensible | DHO Health Speciality ValueSet | 📦0.4.7 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| dho-nhi-value-format | error | ServiceRequest.subject.identifier.value | Reference must be an NHI Patient URL with format ZZZ1111 or ZZZ11AA |
matches('^[A-Z]{3}([0-9]{4}|[0-9]{2}[A-Z]{2})$')
|
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ServiceRequest |
C | 0..* | ServiceRequest | A request for a service to be performed Constraints: prr-1 |
| id |
0..1 | id | Logical id of this artifact | |
| meta |
0..1 | Meta | Metadata about the resource | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| versionId |
0..1 | id | Version specific identifier | |
| lastUpdated |
0..1 | instant | When the resource version last changed | |
| source |
1..1 | uri | HPI Facility ID from where the record is sourced | |
| profile |
0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | |
| security |
0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |
| Slices for tag |
1..* | Coding | Correlation-id where the record is sourced Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| tag:correlationId |
1..1 | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | |
| 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 Fixed Value: https://hub.services.digital.health.nz/ns/correlation-id | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system | |
| 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 | 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 | |
| contained |
0..* | Resource | Contained, inline Resources | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| identifier |
0..* | Identifier | External (provider) and Health NZ business identifiers | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| 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 |
0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |
| value |
1..1 | string | The value that is unique Example General: 123456 | |
| assigner |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |
| status |
1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. | |
| intent |
1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. | |
| category |
0..1 | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. | |
| priority |
0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | |
| code |
1..1 | CodeableConcept | The specialty or service being requested Binding: DHO Health Speciality ValueSet (extensible) | |
| subject |
1..1 | Reference(DHO Patient Profile | NZ Patient | Patient) | Individual or Entity the service is ordered for | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type |
1..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Patient | |
| identifier |
1..1 | Identifier | Logical reference, when literal reference is not known | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| 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/nhi-id | |
| value |
C | 1..1 | string | Must be an absolute URL reference to the patient on the NHI system. See constraints for details. Constraints: dho-nhi-value-format Example General: 123456 |
| period |
0..1 | Period | Time period when id is/was valid for use | |
| assigner |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |
| display |
0..1 | string | Text alternative for the resource | |
| encounter |
0..1 | Reference(DHO Encounter profile | Encounter) | Encounter in which the request was created | |
| occurrence[x] |
0..1 | When service should occur | ||
| occurrenceDateTime |
dateTime | |||
| occurrencePeriod |
Period | |||
| authoredOn |
0..1 | dateTime | Date request signed | |
| requester |
0..1 | Reference(Practitioner resource for use in NZ | PractitionerRole resource for use in NZ | Organization resource for use in NZ) | The clinician or organisation making the referral | |
| performer |
0..* | Reference(Practitioner resource for use in NZ | PractitionerRole resource for use in NZ | HealthcareService resource for use in NZ | Organization resource for use in NZ) | The clinician, team or service the referral is directed to | |
| locationReference |
0..1 | Reference(DHO Location Profile) | The location the referred service will be delivered at | |
| reasonCode |
0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation. | |
| reasonReference |
0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service | |
| note |
0..* | Annotation | Comments | |
| patientInstruction |
0..1 | string | Patient or consumer-oriented instructions | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ServiceRequest.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| ServiceRequest.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| ServiceRequest.meta.tag:correlationId | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| ServiceRequest.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| ServiceRequest.identifier.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 | extensible | DHO Health Speciality ValueSet | 📦0.4.7 | This IG |
| ServiceRequest.subject.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| ServiceRequest.subject.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| ServiceRequest.subject.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| ServiceRequest.reasonCode | Base | example | Procedure Reason Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dho-nhi-value-format | error | ServiceRequest.subject.identifier.value | Reference must be an NHI Patient URL with format ZZZ1111 or ZZZ11AA |
matches('^[A-Z]{3}([0-9]{4}|[0-9]{2}[A-Z]{2})$')
|
This structure is derived from ServiceRequest
Summary
Mandatory: 5 elements(6 nested mandatory elements)
Must-Support: 10 elements
Fixed: 2 elements
Prohibited: 21 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron