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

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

Resource Profile: OutreachServiceRequest

Official URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/OutreachServiceRequest Version: 0.1.3
Active as of 2025-03-30 Computable Name: OutreachServiceRequest

Service request FHIR resource for outreach referral service

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest C 0..* ServiceRequest A request for a service to be performed
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: 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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
prr-1: orderDetail SHALL only be present if code is present
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:statusReason 1..1 (Complex) Reason for current status
URL: http://hl7.org/fhir/StructureDefinition/request-statusReason
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... extension 0..0
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/request-statusReason"
..... value[x] 1..1 CodeableConcept Value of extension
Binding: Status Reason for ServiceRequest (required)
ele-1: All FHIR elements must have a @value or children
... status ?!Σ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.


ele-1: All FHIR elements must have a @value or children
... 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.


ele-1: All FHIR elements must have a @value or children
... subject Σ 1..1 Reference(Patient) Individual or Entity the service is ordered for
ele-1: All FHIR elements must have a @value or children
... requester Σ 1..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) Who/what is requesting service
ele-1: All FHIR elements must have a @value or children
... performer Σ 0..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) The filler of the request
ele-1: All FHIR elements must have a @value or children
... locationReference Σ 0..1 Reference(Location) The desired facility
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ServiceRequest.extension:statusReason.value[x]requiredServiceRequestStatusReason (a valid code from Status Reason for ServiceRequest)
https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-service-request-status-reason-valueset
from this IG
ServiceRequest.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|4.0.1
from the FHIR Standard
ServiceRequest.intentrequiredRequestIntent
http://hl7.org/fhir/ValueSet/request-intent|4.0.1
from the FHIR Standard
ServiceRequest.coderequiredTaskCode (a valid code from Codes for Task code)
https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-task-code-valueset
from this IG

This structure is derived from ServiceRequest

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest 0..* ServiceRequest A request for a service to be performed
... implicitRules 0..0
... language 0..0
... contained 0..0
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:statusReason 1..1 (Complex) Reason for current status
URL: http://hl7.org/fhir/StructureDefinition/request-statusReason
..... value[x] 1..1 CodeableConcept Value of extension
Binding: Status Reason for ServiceRequest (required)
... modifierExtension 0..0
... identifier 0..0
... instantiatesCanonical 0..0
... instantiatesUri 0..0
... replaces 0..0
... requisition 0..0
... category 0..0
... doNotPerform 0..0
... code 1..1 CodeableConcept What is being requested/ordered
Binding: Codes for Task code (required)
... orderDetail 0..0
... quantity[x] 0..0
... subject 1..1 Reference(Patient) Individual or Entity the service is ordered for
... encounter 0..0
... asNeeded[x] 0..0
... requester 1..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) Who/what is requesting service
... performerType 0..0
... performer 0..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) The filler of the request
... locationCode 0..0
... locationReference 0..1 Reference(Location) The desired facility
... reasonCode 0..0
... reasonReference 0..0
... insurance 0..0
... specimen 0..0
... bodySite 0..0
... patientInstruction 0..0
... relevantHistory 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
ServiceRequest.extension:statusReason.value[x]requiredServiceRequestStatusReason (a valid code from Status Reason for ServiceRequest)
https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-service-request-status-reason-valueset
from this IG
ServiceRequest.coderequiredTaskCode (a valid code from Codes for Task code)
https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-task-code-valueset
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest C 0..* ServiceRequest A request for a service to be performed
prr-1: orderDetail SHALL only be present if code is present
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... text 0..1 Narrative Text summary of the resource, for human interpretation
.... extension:statusReason 1..1 (Complex) Reason for current status
URL: http://hl7.org/fhir/StructureDefinition/request-statusReason
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/request-statusReason"
..... value[x] 1..1 CodeableConcept Value of extension
Binding: Status Reason for ServiceRequest (required)
... basedOn Σ 0..* Reference(CarePlan | ServiceRequest | MedicationRequest) What request fulfills
... 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.

... 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 What is being requested/ordered
Binding: Codes for Task code (required)
... subject Σ 1..1 Reference(Patient) Individual or Entity the service is ordered for
... occurrence[x] Σ 0..1 When service should occur
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
.... occurrenceTiming Timing
... authoredOn Σ 0..1 dateTime Date request signed
... requester Σ 1..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) Who/what is requesting service
... performer Σ 0..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) The filler of the request
... locationReference Σ 0..1 Reference(Location) The desired facility
... supportingInfo 0..* Reference(Resource) Additional clinical information
... note 0..* Annotation Comments

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ServiceRequest.extension:statusReason.value[x]requiredServiceRequestStatusReason (a valid code from Status Reason for ServiceRequest)
https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-service-request-status-reason-valueset
from this IG
ServiceRequest.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|4.0.1
from the FHIR Standard
ServiceRequest.intentrequiredRequestIntent
http://hl7.org/fhir/ValueSet/request-intent|4.0.1
from the FHIR Standard
ServiceRequest.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|4.0.1
from the FHIR Standard
ServiceRequest.coderequiredTaskCode (a valid code from Codes for Task code)
https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-task-code-valueset
from this IG

This structure is derived from ServiceRequest

Summary

Mandatory: 4 elements
Prohibited: 24 elements

Extensions

This structure refers to these extensions:

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest C 0..* ServiceRequest A request for a service to be performed
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: 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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
prr-1: orderDetail SHALL only be present if code is present
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:statusReason 1..1 (Complex) Reason for current status
URL: http://hl7.org/fhir/StructureDefinition/request-statusReason
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... extension 0..0
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/request-statusReason"
..... value[x] 1..1 CodeableConcept Value of extension
Binding: Status Reason for ServiceRequest (required)
ele-1: All FHIR elements must have a @value or children
... status ?!Σ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.


ele-1: All FHIR elements must have a @value or children
... 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.


ele-1: All FHIR elements must have a @value or children
... subject Σ 1..1 Reference(Patient) Individual or Entity the service is ordered for
ele-1: All FHIR elements must have a @value or children
... requester Σ 1..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) Who/what is requesting service
ele-1: All FHIR elements must have a @value or children
... performer Σ 0..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) The filler of the request
ele-1: All FHIR elements must have a @value or children
... locationReference Σ 0..1 Reference(Location) The desired facility
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ServiceRequest.extension:statusReason.value[x]requiredServiceRequestStatusReason (a valid code from Status Reason for ServiceRequest)
https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-service-request-status-reason-valueset
from this IG
ServiceRequest.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|4.0.1
from the FHIR Standard
ServiceRequest.intentrequiredRequestIntent
http://hl7.org/fhir/ValueSet/request-intent|4.0.1
from the FHIR Standard
ServiceRequest.coderequiredTaskCode (a valid code from Codes for Task code)
https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-task-code-valueset
from this IG

Differential View

This structure is derived from ServiceRequest

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest 0..* ServiceRequest A request for a service to be performed
... implicitRules 0..0
... language 0..0
... contained 0..0
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:statusReason 1..1 (Complex) Reason for current status
URL: http://hl7.org/fhir/StructureDefinition/request-statusReason
..... value[x] 1..1 CodeableConcept Value of extension
Binding: Status Reason for ServiceRequest (required)
... modifierExtension 0..0
... identifier 0..0
... instantiatesCanonical 0..0
... instantiatesUri 0..0
... replaces 0..0
... requisition 0..0
... category 0..0
... doNotPerform 0..0
... code 1..1 CodeableConcept What is being requested/ordered
Binding: Codes for Task code (required)
... orderDetail 0..0
... quantity[x] 0..0
... subject 1..1 Reference(Patient) Individual or Entity the service is ordered for
... encounter 0..0
... asNeeded[x] 0..0
... requester 1..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) Who/what is requesting service
... performerType 0..0
... performer 0..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) The filler of the request
... locationCode 0..0
... locationReference 0..1 Reference(Location) The desired facility
... reasonCode 0..0
... reasonReference 0..0
... insurance 0..0
... specimen 0..0
... bodySite 0..0
... patientInstruction 0..0
... relevantHistory 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
ServiceRequest.extension:statusReason.value[x]requiredServiceRequestStatusReason (a valid code from Status Reason for ServiceRequest)
https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-service-request-status-reason-valueset
from this IG
ServiceRequest.coderequiredTaskCode (a valid code from Codes for Task code)
https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-task-code-valueset
from this IG

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest C 0..* ServiceRequest A request for a service to be performed
prr-1: orderDetail SHALL only be present if code is present
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... text 0..1 Narrative Text summary of the resource, for human interpretation
.... extension:statusReason 1..1 (Complex) Reason for current status
URL: http://hl7.org/fhir/StructureDefinition/request-statusReason
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/request-statusReason"
..... value[x] 1..1 CodeableConcept Value of extension
Binding: Status Reason for ServiceRequest (required)
... basedOn Σ 0..* Reference(CarePlan | ServiceRequest | MedicationRequest) What request fulfills
... 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.

... 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 What is being requested/ordered
Binding: Codes for Task code (required)
... subject Σ 1..1 Reference(Patient) Individual or Entity the service is ordered for
... occurrence[x] Σ 0..1 When service should occur
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
.... occurrenceTiming Timing
... authoredOn Σ 0..1 dateTime Date request signed
... requester Σ 1..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) Who/what is requesting service
... performer Σ 0..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) The filler of the request
... locationReference Σ 0..1 Reference(Location) The desired facility
... supportingInfo 0..* Reference(Resource) Additional clinical information
... note 0..* Annotation Comments

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ServiceRequest.extension:statusReason.value[x]requiredServiceRequestStatusReason (a valid code from Status Reason for ServiceRequest)
https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-service-request-status-reason-valueset
from this IG
ServiceRequest.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|4.0.1
from the FHIR Standard
ServiceRequest.intentrequiredRequestIntent
http://hl7.org/fhir/ValueSet/request-intent|4.0.1
from the FHIR Standard
ServiceRequest.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|4.0.1
from the FHIR Standard
ServiceRequest.coderequiredTaskCode (a valid code from Codes for Task code)
https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-task-code-valueset
from this IG

This structure is derived from ServiceRequest

Summary

Mandatory: 4 elements
Prohibited: 24 elements

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron