Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.1 - release
Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.1 - release
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
| Official URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/OutreachServiceRequest | Version: 0.1.3 | |||
| Active as of 2025-06-05 | Computable Name: OutreachServiceRequest | |||
Service request FHIR resource for outreach referral service
Usages:
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 | |||
 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 | Conformance | ValueSet | URI |
| ServiceRequest.extension:statusReason.value[x] | required | ServiceRequestStatusReason(a valid code from Status Reason for ServiceRequest)https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-service-request-status-reason-valuesetFrom this IG | |
| ServiceRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1From the FHIR Standard | |
| ServiceRequest.intent | required | RequestIntenthttp://hl7.org/fhir/ValueSet/request-intent|4.0.1From the FHIR Standard | |
| ServiceRequest.code | required | TaskCode(a valid code from Codes for ServiceRequest code)https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-task-code-valuesetFrom this IG |
| 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
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| 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 | |||
| 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 facility the the procedure is performed at | |
| reasonCode |
0..0 | |||
| reasonReference |
0..0 | |||
| insurance |
0..0 | |||
| specimen |
0..0 | |||
| bodySite |
0..0 | |||
| patientInstruction |
0..0 | |||
| relevantHistory |
0..0 | |||
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| ServiceRequest.extension:statusReason.value[x] | required | ServiceRequestStatusReason(a valid code from Status Reason for ServiceRequest)https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-service-request-status-reason-valuesetFrom this IG | |
| ServiceRequest.code | required | TaskCode(a valid code from Codes for ServiceRequest code)https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-task-code-valuesetFrom 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 | |
| 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 | 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) | |
| 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 | Conformance | ValueSet | URI |
| ServiceRequest.extension:statusReason.value[x] | required | ServiceRequestStatusReason(a valid code from Status Reason for ServiceRequest)https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-service-request-status-reason-valuesetFrom this IG | |
| ServiceRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1From the FHIR Standard | |
| ServiceRequest.intent | required | RequestIntenthttp://hl7.org/fhir/ValueSet/request-intent|4.0.1From the FHIR Standard | |
| ServiceRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1From the FHIR Standard | |
| ServiceRequest.code | required | TaskCode(a valid code from Codes for ServiceRequest code)https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-task-code-valuesetFrom this IG |
| 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
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 | |||
| 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 | Conformance | ValueSet | URI |
| ServiceRequest.extension:statusReason.value[x] | required | ServiceRequestStatusReason(a valid code from Status Reason for ServiceRequest)https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-service-request-status-reason-valuesetFrom this IG | |
| ServiceRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1From the FHIR Standard | |
| ServiceRequest.intent | required | RequestIntenthttp://hl7.org/fhir/ValueSet/request-intent|4.0.1From the FHIR Standard | |
| ServiceRequest.code | required | TaskCode(a valid code from Codes for ServiceRequest code)https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-task-code-valuesetFrom this IG |
| 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() |
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 | |||
| 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 | |||
| 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 facility the the procedure is performed at | |
| reasonCode |
0..0 | |||
| reasonReference |
0..0 | |||
| insurance |
0..0 | |||
| specimen |
0..0 | |||
| bodySite |
0..0 | |||
| patientInstruction |
0..0 | |||
| relevantHistory |
0..0 | |||
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| ServiceRequest.extension:statusReason.value[x] | required | ServiceRequestStatusReason(a valid code from Status Reason for ServiceRequest)https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-service-request-status-reason-valuesetFrom this IG | |
| ServiceRequest.code | required | TaskCode(a valid code from Codes for ServiceRequest code)https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-task-code-valuesetFrom 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 | |
| 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 | 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) | |
| 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 | Conformance | ValueSet | URI |
| ServiceRequest.extension:statusReason.value[x] | required | ServiceRequestStatusReason(a valid code from Status Reason for ServiceRequest)https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-service-request-status-reason-valuesetFrom this IG | |
| ServiceRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1From the FHIR Standard | |
| ServiceRequest.intent | required | RequestIntenthttp://hl7.org/fhir/ValueSet/request-intent|4.0.1From the FHIR Standard | |
| ServiceRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1From the FHIR Standard | |
| ServiceRequest.code | required | TaskCode(a valid code from Codes for ServiceRequest code)https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-task-code-valuesetFrom this IG |
| 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
Other representations of profile: CSV, Excel, Schematron