Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.5 - release New Zealand flag

Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.5) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: DHO Service Request Profile

Official URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOServiceRequest Version: 0.0.1
Draft as of 2026-08-12 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

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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 ?!SΣ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... system SΣ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 1..1 string The value that is unique
Example General: 123456
... status ?!SΣ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.
... intent ?!SΣ 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of service request.
... priority SΣ 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
... code SΣ 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 SΣ 0..1 dateTime Date request signed
... requester SΣ 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 SΣ 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

doco Documentation for this format

Terminology Bindings

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.5 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.

Constraints

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
..... 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 S 0..1 code usual | official | temp | secondary | old (If known)
.... system S 0..1 uri The namespace for the identifier value
.... value S 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 S 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
... intent S 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
... category 0..1 CodeableConcept Classification of service
... priority S 0..1 code routine | urgent | asap | stat
... doNotPerform 0..0 True if service/procedure should not be performed
... code S 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 S 0..1 dateTime Date request signed
... requester S 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 S 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

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
ServiceRequest.code Base extensible DHO Health Speciality ValueSet 📦0.4.5 This IG

Constraints

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})$')
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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".
..... 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
... 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 ?!SΣ 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 SΣ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 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 ?!SΣ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.
... intent ?!SΣ 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 SΣ 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
... code SΣ 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 SΣ 0..1 dateTime Date request signed
... requester SΣ 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 SΣ 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

doco Documentation for this format

Terminology Bindings

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.5 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.

Constraints

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})$')

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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 ?!SΣ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... system SΣ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 1..1 string The value that is unique
Example General: 123456
... status ?!SΣ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.
... intent ?!SΣ 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of service request.
... priority SΣ 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
... code SΣ 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 SΣ 0..1 dateTime Date request signed
... requester SΣ 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 SΣ 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

doco Documentation for this format

Terminology Bindings

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.5 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.

Constraints

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
..... 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 S 0..1 code usual | official | temp | secondary | old (If known)
.... system S 0..1 uri The namespace for the identifier value
.... value S 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 S 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
... intent S 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
... category 0..1 CodeableConcept Classification of service
... priority S 0..1 code routine | urgent | asap | stat
... doNotPerform 0..0 True if service/procedure should not be performed
... code S 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 S 0..1 dateTime Date request signed
... requester S 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 S 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

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
ServiceRequest.code Base extensible DHO Health Speciality ValueSet 📦0.4.5 This IG

Constraints

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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".
..... 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
... 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 ?!SΣ 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 SΣ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 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 ?!SΣ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.
... intent ?!SΣ 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 SΣ 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
... code SΣ 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 SΣ 0..1 dateTime Date request signed
... requester SΣ 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 SΣ 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

doco Documentation for this format

Terminology Bindings

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.5 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.

Constraints

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})$')

 

Other representations of profile: CSV, Excel, Schematron