Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.5 - release
Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.5 - release
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
| Official URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/OutreachServiceRequest | Version: 0.1.3 | |||
| Active as of 2026-07-20 | Computable Name: OutreachServiceRequest | |||
Service request FHIR resource for outreach referral service
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 |
  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 | |
  extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
 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) | |
 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. |
| 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 |
| 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 facility the the procedure is performed at |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ServiceRequest.extension:statusReason.value[x] | Base | required | Status Reason for ServiceRequest | 📦1.0.0 | This IG |
| ServiceRequest.status | Base | required | RequestStatus | 📍4.0.1 | FHIR Std. |
| ServiceRequest.intent | Base | required | RequestIntent | 📍4.0.1 | FHIR Std. |
| ServiceRequest.code | Base | required | Codes for Task code | 📦1.0.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| 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
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ServiceRequest |
0..* | ServiceRequest | A request for a service to be performed | |
 implicitRules |
0..0 | A set of rules under which this content was created | ||
| language |
0..0 | Language of the resource content | ||
| contained |
0..0 | Contained, inline Resources | ||
| 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 | Extension | ||
| instantiatesCanonical |
0..0 | Instantiates FHIR protocol or definition | ||
| instantiatesUri |
0..0 | Instantiates external protocol or definition | ||
| replaces |
0..0 | What request replaces | ||
| requisition |
0..0 | Composite Request ID | ||
| category |
0..0 | Classification of service | ||
| doNotPerform |
0..0 | True if service/procedure should not be performed | ||
| code |
1..1 | CodeableConcept | What is being requested/ordered Binding: Codes for Task code (required) | |
| orderDetail |
0..0 | Additional order information | ||
| quantity[x] |
0..0 | Service amount | ||
| subject |
1..1 | Reference(Patient) | Individual or Entity the service is ordered for | |
| encounter |
0..0 | Encounter in which the request was created | ||
| asNeeded[x] |
0..0 | Preconditions for service | ||
| requester |
1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/what is requesting service | |
| performerType |
0..0 | Performer role | ||
| performer |
0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | The filler of the request | |
| locationCode |
0..0 | Requested location | ||
| locationReference |
0..1 | Reference(Location) | The facility the the procedure is performed at | |
| reasonCode |
0..0 | Explanation/Justification for procedure or service | ||
| reasonReference |
0..0 | Explanation/Justification for service or service | ||
| insurance |
0..0 | Associated insurance coverage | ||
| specimen |
0..0 | Procedure Samples | ||
| bodySite |
0..0 | Location on Body | ||
| patientInstruction |
0..0 | Patient or consumer-oriented instructions | ||
| relevantHistory |
0..0 | Request provenance | ||
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ServiceRequest.extension:statusReason.value[x] | Base | required | Status Reason for ServiceRequest | 📦1.0.0 | This IG |
| ServiceRequest.code | Base | required | Codes for Task code | 📦1.0.0 | This IG |
| 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 |
| 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 | |
| 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 | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| 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) | |
| identifier |
Σ | 0..* | Identifier | Identifiers assigned to this order |
| 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 facility the the procedure is performed at |
| supportingInfo |
0..* | Reference(Resource) | Additional clinical information | |
| note |
0..* | Annotation | Comments | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ServiceRequest.extension:statusReason.value[x] | Base | required | Status Reason for ServiceRequest | 📦1.0.0 | This IG |
| ServiceRequest.status | Base | required | RequestStatus | 📍4.0.1 | FHIR Std. |
| ServiceRequest.intent | Base | required | RequestIntent | 📍4.0.1 | FHIR Std. |
| ServiceRequest.priority | Base | required | Request priority | 📍4.0.1 | FHIR Std. |
| ServiceRequest.code | Base | required | Codes for Task code | 📦1.0.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| 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
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 |
| 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 | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| 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) | |
| 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. |
| 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 |
| 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 facility the the procedure is performed at |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ServiceRequest.extension:statusReason.value[x] | Base | required | Status Reason for ServiceRequest | 📦1.0.0 | This IG |
| ServiceRequest.status | Base | required | RequestStatus | 📍4.0.1 | FHIR Std. |
| ServiceRequest.intent | Base | required | RequestIntent | 📍4.0.1 | FHIR Std. |
| ServiceRequest.code | Base | required | Codes for Task code | 📦1.0.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| 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()
|
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 | |
| implicitRules |
0..0 | A set of rules under which this content was created | ||
| language |
0..0 | Language of the resource content | ||
| contained |
0..0 | Contained, inline Resources | ||
| 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 | Extension | ||
| instantiatesCanonical |
0..0 | Instantiates FHIR protocol or definition | ||
| instantiatesUri |
0..0 | Instantiates external protocol or definition | ||
| replaces |
0..0 | What request replaces | ||
| requisition |
0..0 | Composite Request ID | ||
| category |
0..0 | Classification of service | ||
| doNotPerform |
0..0 | True if service/procedure should not be performed | ||
| code |
1..1 | CodeableConcept | What is being requested/ordered Binding: Codes for Task code (required) | |
| orderDetail |
0..0 | Additional order information | ||
| quantity[x] |
0..0 | Service amount | ||
| subject |
1..1 | Reference(Patient) | Individual or Entity the service is ordered for | |
| encounter |
0..0 | Encounter in which the request was created | ||
| asNeeded[x] |
0..0 | Preconditions for service | ||
| requester |
1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/what is requesting service | |
| performerType |
0..0 | Performer role | ||
| performer |
0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | The filler of the request | |
| locationCode |
0..0 | Requested location | ||
| locationReference |
0..1 | Reference(Location) | The facility the the procedure is performed at | |
| reasonCode |
0..0 | Explanation/Justification for procedure or service | ||
| reasonReference |
0..0 | Explanation/Justification for service or service | ||
| insurance |
0..0 | Associated insurance coverage | ||
| specimen |
0..0 | Procedure Samples | ||
| bodySite |
0..0 | Location on Body | ||
| patientInstruction |
0..0 | Patient or consumer-oriented instructions | ||
| relevantHistory |
0..0 | Request provenance | ||
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ServiceRequest.extension:statusReason.value[x] | Base | required | Status Reason for ServiceRequest | 📦1.0.0 | This IG |
| ServiceRequest.code | Base | required | Codes for Task code | 📦1.0.0 | This IG |
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 |
| 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 | |
| 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 | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| 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) | |
| identifier |
Σ | 0..* | Identifier | Identifiers assigned to this order |
| 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 facility the the procedure is performed at |
| supportingInfo |
0..* | Reference(Resource) | Additional clinical information | |
| note |
0..* | Annotation | Comments | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ServiceRequest.extension:statusReason.value[x] | Base | required | Status Reason for ServiceRequest | 📦1.0.0 | This IG |
| ServiceRequest.status | Base | required | RequestStatus | 📍4.0.1 | FHIR Std. |
| ServiceRequest.intent | Base | required | RequestIntent | 📍4.0.1 | FHIR Std. |
| ServiceRequest.priority | Base | required | Request priority | 📍4.0.1 | FHIR Std. |
| ServiceRequest.code | Base | required | Codes for Task code | 📦1.0.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| 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
Other representations of profile: CSV, Excel, Schematron