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/ManaakiNgaTahiServiceRequest | Version: 0.1.3 | |||
| Active as of 2026-10-13 | Computable Name: ManaakiNgaTahiServiceRequest | |||
Service request FHIR resource for Manaaki Nga Tahi
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 |
  instantiatesCanonical |
0..* | canonical(ActivityDefinition) | Instantiates FHIR protocol or definition | |
 basedOn |
0..* | Reference(CarePlan) | 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. | |
| doNotPerform |
0..1 | boolean | True if service/procedure should not be performed | |
| subject |
1..1 | Reference(Patient) | Individual or Entity the service is ordered for | |
  Slices for occurrence[x] |
1..1 | When service should occur Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view | ||
  occurrenceDateTime |
dateTime | |||
 occurrencePeriod |
Period | |||
| occurrenceTiming |
Timing | |||
 occurrence[x]:occurrenceDateTime |
0..1 | dateTime | Must be in UTC timezone on the FHIR server | |
 occurrence[x]:occurrencePeriod |
0..1 | Period | Start | end value must be in UTC timezone on the FHIR server | |
| performerType |
0..1 | CodeableConcept | Performer role Binding: ParticipantRoles (required) | |
 performer |
0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Requested performer | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ServiceRequest.status | Base | required | RequestStatus | 📍4.0.1 | FHIR Std. |
| ServiceRequest.intent | Base | required | RequestIntent | 📍4.0.1 | FHIR Std. |
| ServiceRequest.performerType | Base | required | Participant Roles | 📦4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
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 | ||
 modifierExtension |
0..0 | Extension | ||
| identifier |
0..0 | Identifiers assigned to this order | ||
| instantiatesCanonical |
0..* | canonical(ActivityDefinition) | Instantiates FHIR protocol or definition | |
| instantiatesUri |
0..0 | Instantiates external protocol or definition | ||
| basedOn |
0..* | Reference(CarePlan) | What request fulfills | |
| replaces |
0..0 | What request replaces | ||
| requisition |
0..0 | Composite Request ID | ||
| category |
0..0 | Classification of service | ||
| 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 | ||
| Slices for occurrence[x] |
1..1 | dateTime, Period, Timing | When service should occur Slice: Unordered, Open by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view | |
| occurrence[x]:occurrenceDateTime |
0..1 | dateTime | Must be in UTC timezone on the FHIR server | |
| occurrence[x]:occurrencePeriod |
0..1 | Period | Start | end value must be in UTC timezone on the FHIR server | |
| asNeeded[x] |
0..0 | Preconditions for service | ||
| performerType |
0..1 | CodeableConcept | Performer role Binding: ParticipantRoles (required) | |
| performer |
0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Requested performer | |
| locationCode |
0..0 | Requested location | ||
| locationReference |
0..0 | Requested location | ||
| reasonCode |
0..0 | Explanation/Justification for procedure or service | ||
| reasonReference |
0..0 | Explanation/Justification for service or service | ||
| insurance |
0..0 | Associated insurance coverage | ||
| supportingInfo |
0..0 | Additional clinical information | ||
| specimen |
0..0 | Procedure Samples | ||
| bodySite |
0..0 | Location on Body | ||
| note |
0..0 | Comments | ||
| patientInstruction |
0..0 | Patient or consumer-oriented instructions | ||
| relevantHistory |
0..0 | Request provenance | ||
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ServiceRequest.performerType | Base | required | Participant Roles | 📦4.0.1 | FHIR Std. |
| 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 | |
| contained |
0..* | Resource | Contained, inline Resources | |
 extension |
0..* | Extension | Additional content defined by implementations | |
| instantiatesCanonical |
0..* | canonical(ActivityDefinition) | Instantiates FHIR protocol or definition | |
| basedOn |
0..* | Reference(CarePlan) | 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. | |
| doNotPerform |
0..1 | boolean | True if service/procedure should not be performed | |
| code |
0..1 | CodeableConcept | What is being requested/ordered Binding: ProcedureCodes(SNOMEDCT) (example): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is preferred. | |
| subject |
1..1 | Reference(Patient) | Individual or Entity the service is ordered for | |
| Slices for occurrence[x] |
1..1 | When service should occur Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view | ||
| occurrenceDateTime |
dateTime | |||
| occurrencePeriod |
Period | |||
| occurrenceTiming |
Timing | |||
| occurrence[x]:occurrenceDateTime |
0..1 | dateTime | Must be in UTC timezone on the FHIR server | |
| occurrence[x]:occurrencePeriod |
0..1 | Period | Start | end value must be in UTC timezone on the FHIR server | |
| authoredOn |
0..1 | dateTime | Date request signed | |
| requester |
0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/what is requesting service | |
| performerType |
0..1 | CodeableConcept | Performer role Binding: ParticipantRoles (required) | |
| performer |
0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Requested performer | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| 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 | example | Procedure Codes (SNOMED CT) | 📍4.0.1 | FHIR Std. |
| ServiceRequest.performerType | Base | required | Participant Roles | 📦4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from ServiceRequest
Summary
Mandatory: 1 element
Prohibited: 23 elements
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 |
| instantiatesCanonical |
0..* | canonical(ActivityDefinition) | Instantiates FHIR protocol or definition | |
| basedOn |
0..* | Reference(CarePlan) | 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. | |
| doNotPerform |
0..1 | boolean | True if service/procedure should not be performed | |
| subject |
1..1 | Reference(Patient) | Individual or Entity the service is ordered for | |
| Slices for occurrence[x] |
1..1 | When service should occur Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view | ||
| occurrenceDateTime |
dateTime | |||
| occurrencePeriod |
Period | |||
| occurrenceTiming |
Timing | |||
| occurrence[x]:occurrenceDateTime |
0..1 | dateTime | Must be in UTC timezone on the FHIR server | |
| occurrence[x]:occurrencePeriod |
0..1 | Period | Start | end value must be in UTC timezone on the FHIR server | |
| performerType |
0..1 | CodeableConcept | Performer role Binding: ParticipantRoles (required) | |
| performer |
0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Requested performer | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ServiceRequest.status | Base | required | RequestStatus | 📍4.0.1 | FHIR Std. |
| ServiceRequest.intent | Base | required | RequestIntent | 📍4.0.1 | FHIR Std. |
| ServiceRequest.performerType | Base | required | Participant Roles | 📦4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
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 | ||
| modifierExtension |
0..0 | Extension | ||
| identifier |
0..0 | Identifiers assigned to this order | ||
| instantiatesCanonical |
0..* | canonical(ActivityDefinition) | Instantiates FHIR protocol or definition | |
| instantiatesUri |
0..0 | Instantiates external protocol or definition | ||
| basedOn |
0..* | Reference(CarePlan) | What request fulfills | |
| replaces |
0..0 | What request replaces | ||
| requisition |
0..0 | Composite Request ID | ||
| category |
0..0 | Classification of service | ||
| 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 | ||
| Slices for occurrence[x] |
1..1 | dateTime, Period, Timing | When service should occur Slice: Unordered, Open by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view | |
| occurrence[x]:occurrenceDateTime |
0..1 | dateTime | Must be in UTC timezone on the FHIR server | |
| occurrence[x]:occurrencePeriod |
0..1 | Period | Start | end value must be in UTC timezone on the FHIR server | |
| asNeeded[x] |
0..0 | Preconditions for service | ||
| performerType |
0..1 | CodeableConcept | Performer role Binding: ParticipantRoles (required) | |
| performer |
0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Requested performer | |
| locationCode |
0..0 | Requested location | ||
| locationReference |
0..0 | Requested location | ||
| reasonCode |
0..0 | Explanation/Justification for procedure or service | ||
| reasonReference |
0..0 | Explanation/Justification for service or service | ||
| insurance |
0..0 | Associated insurance coverage | ||
| supportingInfo |
0..0 | Additional clinical information | ||
| specimen |
0..0 | Procedure Samples | ||
| bodySite |
0..0 | Location on Body | ||
| note |
0..0 | Comments | ||
| patientInstruction |
0..0 | Patient or consumer-oriented instructions | ||
| relevantHistory |
0..0 | Request provenance | ||
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ServiceRequest.performerType | Base | required | Participant Roles | 📦4.0.1 | FHIR Std. |
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 | |
| contained |
0..* | Resource | Contained, inline Resources | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| instantiatesCanonical |
0..* | canonical(ActivityDefinition) | Instantiates FHIR protocol or definition | |
| basedOn |
0..* | Reference(CarePlan) | 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. | |
| doNotPerform |
0..1 | boolean | True if service/procedure should not be performed | |
| code |
0..1 | CodeableConcept | What is being requested/ordered Binding: ProcedureCodes(SNOMEDCT) (example): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is preferred. | |
| subject |
1..1 | Reference(Patient) | Individual or Entity the service is ordered for | |
| Slices for occurrence[x] |
1..1 | When service should occur Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view | ||
| occurrenceDateTime |
dateTime | |||
| occurrencePeriod |
Period | |||
| occurrenceTiming |
Timing | |||
| occurrence[x]:occurrenceDateTime |
0..1 | dateTime | Must be in UTC timezone on the FHIR server | |
| occurrence[x]:occurrencePeriod |
0..1 | Period | Start | end value must be in UTC timezone on the FHIR server | |
| authoredOn |
0..1 | dateTime | Date request signed | |
| requester |
0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/what is requesting service | |
| performerType |
0..1 | CodeableConcept | Performer role Binding: ParticipantRoles (required) | |
| performer |
0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Requested performer | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| 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 | example | Procedure Codes (SNOMED CT) | 📍4.0.1 | FHIR Std. |
| ServiceRequest.performerType | Base | required | Participant Roles | 📦4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from ServiceRequest
Summary
Mandatory: 1 element
Prohibited: 23 elements
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron