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

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

## Resource Profile: ManaakiNgaTahiServiceRequest

Official URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/ManaakiNgaTahiServiceRequest | Version: 0.1.3
Active as of 2025-12-11 | Computable Name: ManaakiNgaTahiServiceRequest

Service request FHIR resource for Manaaki Nga Tahi

Usages:

- Examples for this Profile: ServiceRequest/ObservationsServiceRequestExample

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.

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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, Open by type:$this
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

#### Terminology Bindings

Path | Conformance | ValueSet | URI
ServiceRequest.status | required | RequestStatus `http://hl7.org/fhir/ValueSet/request-status|4.0.1` From the FHIR Standard
ServiceRequest.intent | required | RequestIntent `http://hl7.org/fhir/ValueSet/request-intent|4.0.1` From the FHIR Standard
ServiceRequest.performerType | required | ParticipantRoles `http://hl7.org/fhir/ValueSet/participant-role` From the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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()) |
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: Bindings Constraints Obligations
--- | --- | --- | --- | ---
ServiceRequest |  | 0..* | ServiceRequest | A request for a service to be performed
implicitRules |  | 0..0 |  |
language |  | 0..0 |  |
modifierExtension |  | 0..0 |  |
identifier |  | 0..0 |  |
instantiatesCanonical |  | 0..* | canonical(ActivityDefinition) | Instantiates FHIR protocol or definition
instantiatesUri |  | 0..0 |  |
basedOn |  | 0..* | Reference(CarePlan) | What request fulfills
replaces |  | 0..0 |  |
requisition |  | 0..0 |  |
category |  | 0..0 |  |
orderDetail |  | 0..0 |  |
quantity[x] |  | 0..0 |  |
subject |  | 1..1 | Reference(Patient) | Individual or Entity the service is ordered for
encounter |  | 0..0 |  |
Slices for occurrence[x] |  | 1..1 | dateTime, Period, Timing | When service should occur Slice: Unordered, Open by type:$this
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 |  |
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 |  |
locationReference |  | 0..0 |  |
reasonCode |  | 0..0 |  |
reasonReference |  | 0..0 |  |
insurance |  | 0..0 |  |
supportingInfo |  | 0..0 |  |
specimen |  | 0..0 |  |
bodySite |  | 0..0 |  |
note |  | 0..0 |  |
patientInstruction |  | 0..0 |  |
relevantHistory |  | 0..0 |  |
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet | URI
ServiceRequest.performerType | required | ParticipantRoles `http://hl7.org/fhir/ValueSet/participant-role` From the FHIR Standard

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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, Open by type:$this
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

#### Terminology Bindings

Path | Conformance | ValueSet | URI
ServiceRequest.status | required | RequestStatus `http://hl7.org/fhir/ValueSet/request-status|4.0.1` From the FHIR Standard
ServiceRequest.intent | required | RequestIntent `http://hl7.org/fhir/ValueSet/request-intent|4.0.1` From the FHIR Standard
ServiceRequest.priority | required | RequestPriority `http://hl7.org/fhir/ValueSet/request-priority|4.0.1` From the FHIR Standard
ServiceRequest.code | example | ProcedureCodes(SNOMEDCT) `http://hl7.org/fhir/ValueSet/procedure-code` From the FHIR Standard
ServiceRequest.performerType | required | ParticipantRoles `http://hl7.org/fhir/ValueSet/participant-role` From the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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

Summary

Mandatory: 1 element
Prohibited: 23 elements

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of ServiceRequest.occurrence[x]

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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, Open by type:$this
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

#### Terminology Bindings

Path | Conformance | ValueSet | URI
ServiceRequest.status | required | RequestStatus `http://hl7.org/fhir/ValueSet/request-status|4.0.1` From the FHIR Standard
ServiceRequest.intent | required | RequestIntent `http://hl7.org/fhir/ValueSet/request-intent|4.0.1` From the FHIR Standard
ServiceRequest.performerType | required | ParticipantRoles `http://hl7.org/fhir/ValueSet/participant-role` From the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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()) |
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: Bindings Constraints Obligations
--- | --- | --- | --- | ---
ServiceRequest |  | 0..* | ServiceRequest | A request for a service to be performed
implicitRules |  | 0..0 |  |
language |  | 0..0 |  |
modifierExtension |  | 0..0 |  |
identifier |  | 0..0 |  |
instantiatesCanonical |  | 0..* | canonical(ActivityDefinition) | Instantiates FHIR protocol or definition
instantiatesUri |  | 0..0 |  |
basedOn |  | 0..* | Reference(CarePlan) | What request fulfills
replaces |  | 0..0 |  |
requisition |  | 0..0 |  |
category |  | 0..0 |  |
orderDetail |  | 0..0 |  |
quantity[x] |  | 0..0 |  |
subject |  | 1..1 | Reference(Patient) | Individual or Entity the service is ordered for
encounter |  | 0..0 |  |
Slices for occurrence[x] |  | 1..1 | dateTime, Period, Timing | When service should occur Slice: Unordered, Open by type:$this
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 |  |
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 |  |
locationReference |  | 0..0 |  |
reasonCode |  | 0..0 |  |
reasonReference |  | 0..0 |  |
insurance |  | 0..0 |  |
supportingInfo |  | 0..0 |  |
specimen |  | 0..0 |  |
bodySite |  | 0..0 |  |
note |  | 0..0 |  |
patientInstruction |  | 0..0 |  |
relevantHistory |  | 0..0 |  |
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet | URI
ServiceRequest.performerType | required | ParticipantRoles `http://hl7.org/fhir/ValueSet/participant-role` From the FHIR Standard

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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, Open by type:$this
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

#### Terminology Bindings

Path | Conformance | ValueSet | URI
ServiceRequest.status | required | RequestStatus `http://hl7.org/fhir/ValueSet/request-status|4.0.1` From the FHIR Standard
ServiceRequest.intent | required | RequestIntent `http://hl7.org/fhir/ValueSet/request-intent|4.0.1` From the FHIR Standard
ServiceRequest.priority | required | RequestPriority `http://hl7.org/fhir/ValueSet/request-priority|4.0.1` From the FHIR Standard
ServiceRequest.code | example | ProcedureCodes(SNOMEDCT) `http://hl7.org/fhir/ValueSet/procedure-code` From the FHIR Standard
ServiceRequest.performerType | required | ParticipantRoles `http://hl7.org/fhir/ValueSet/participant-role` From the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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

Summary

Mandatory: 1 element
Prohibited: 23 elements

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of ServiceRequest.occurrence[x]

Other representations of profile: CSV, Excel, Schematron