---
title: 'ServiceRequest (FHIR R4)'
description: 'FHIR R4 ServiceRequest resource.'
nav: 'API / R4 / ServiceRequest'
order: 90
version: v1
fhir: r4
source: generated
updated: '2026-09-23'
---
# ServiceRequest (FHIR R4)
FHIR R4 ServiceRequest resource.
> This reference is generated from the canonical Huli Public API OpenAPI specification and the server's FHIR R4 CapabilityStatement — do not edit it directly.
## FHIR R4 Specification
Official spec: [ServiceRequest — HL7 FHIR R4](https://hl7.org/fhir/R4/servicerequest.html)
## Supported Interactions
- **read** — Read a single resource by ID (`GET /fhir/R4/{Resource}/{id}`)
- **search-type** — Search resources with query parameters (`GET /fhir/R4/{Resource}?...`)
- **create** — Create a new resource (`POST /fhir/R4/{Resource}`)
- **update** — Update an existing resource (`PUT /fhir/R4/{Resource}/{id}`)
## Scopes
Scopes are shared across FHIR releases — the same `system/ServiceRequest.*` scope grants ServiceRequest access on both `/fhir/R4` and `/fhir/R5`.
- — see [scope reference](/v1/scopes#system-servicerequest-rs)
- — see [scope reference](/v1/scopes#system-servicerequest-cru)
## Search Parameters
| Parameter | Type | Notes |
|-----------|------|-------|
| `patient` | reference | Resource reference — supply the UUID of the referenced resource. |
| `encounter` | reference | Resource reference — supply the UUID of the referenced resource. |
| `_count` | number | Integer. For `_count`: default 20, max 100. |
| `_cursor` | string | Case-insensitive partial match. |
## Endpoints
### Read ServiceRequest
Retrieve a single ServiceRequest resource by its ID.
**Required scope:**
#### Code Samples
:::CodeGroup
```bash {label="cURL"}
TOKEN=$(curl -s -X POST https://api.huli.ai/auth/token \
-d "grant_type=client_credentials" \
-d "client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer" \
-d "client_assertion=${CLIENT_ASSERTION}" \
-d "scope=system/ServiceRequest.rs" \
| jq -r .access_token)
curl -X GET https://api.huli.ai/fhir/R4/ServiceRequest/${RESOURCE_ID} \
-H "Authorization: Bearer ${TOKEN}"
```
```typescript {label="TypeScript"}
const token = process.env.HULI_ACCESS_TOKEN ?? "";
const response = await fetch(
`https://api.huli.ai/fhir/R4/ServiceRequest/${id}`,
{
method: "GET",
headers: {
"Authorization": `Bearer ${token}`,
},
}
);
if (!response.ok) throw new Error(`HTTP ${String(response.status)}`);
const data: unknown = await response.json();
```
```python {label="Python"}
import os
import requests
token = os.environ["HULI_ACCESS_TOKEN"]
headers = {"Authorization": f"Bearer {token}"}
resp = requests.get(
f"https://api.huli.ai/fhir/R4/ServiceRequest/{resource_id}",
headers=headers,
)
resp.raise_for_status()
print(resp.json())
```
```java {label="Java"}
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class getServiceRequestExample {
public static void main(String[] args) throws Exception {
String token = System.getenv("HULI_ACCESS_TOKEN");
String resourceId = "RESOURCE_ID";
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.huli.ai/fhir/R4/ServiceRequest/" + resourceId))
.header("Authorization", "Bearer " + token)
.header("Accept", "application/fhir+json")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response =
client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println("status: " + response.statusCode());
System.out.println(response.body());
}
}
```
```go {label="Go"}
import (
"fmt"
"net/http"
"os"
)
func getServiceRequestExample() {
token := os.Getenv("HULI_ACCESS_TOKEN")
req, _ := http.NewRequest("GET", "https://api.huli.ai/fhir/R4/ServiceRequest/"+resourceID+"", nil)
req.Header.Set("Authorization", "Bearer "+token)
resp, err := http.DefaultClient.Do(req)
if err != nil {
fmt.Println("error:", err)
return
}
defer resp.Body.Close()
fmt.Println("status:", resp.Status)
}
```
:::
#### Errors
| Code | Status | Description |
|------|--------|-------------|
| [HPB-00106](/v1/errors#hpb-00106) | 401 | Authentication failed |
| [HPB-00104](/v1/errors#hpb-00104) | 403 | Insufficient scope |
| [HPB-00102](/v1/errors#hpb-00102) | 404 | Resource not found |
| [HPB-00105](/v1/errors#hpb-00105) | 429 | Rate limit exceeded |
---
### Update ServiceRequest
Update an existing ServiceRequest as a full-resource replace with
read-then-merge semantics: the FHIR-owned fields (priority, `code` +
`category` — the order's primary study — `reasonCode`, `note`) overlay
the stored draft order, while app-only fields not represented in FHIR
(the requisition grouping, the requesting practitioner, and per-study
clinical order data such as specimen requirements or body site) are
preserved. `reasonCode` and `note` follow faithful replace semantics
(absent means removed); a body that omits `priority` preserves the
stored value — priority is a clinical triage decision, never silently
reset to `routine`.
The update is draft-gated: an order whose backing clinical document is
already signed or cancelled cannot be modified (`409`, HPB-00135). An
order holding more than one study is read-only on this surface — a
replace would drop clinician-authored studies (`409`, HPB-00136), and a
body carrying `orderDetail` is rejected as on create. `status` must be
`active` (lifecycle transitions are not exposed here); `subject` and
`encounter` are immutable (`422`).
Supports optimistic concurrency: supply the `If-Match` header with the
`ETag` from the last read to make the update conditional. A stale
validator is rejected with a `409` version conflict (HPB-00103),
re-checked against the locked row inside the write transaction. The
response carries the `ETag` of the new version.
**Required scope:**
#### Request Body
#### Request Example
```json
{
"resourceType": "ServiceRequest",
"status": "active",
"intent": "order",
"priority": "urgent",
"category": [
{
"coding": [
{
"code": "laboratory"
}
]
}
],
"code": {
"text": "Urinalysis (EGO)"
},
"subject": {
"reference": "Patient/550e8400-e29b-41d4-a716-446655440001"
}
}
```
#### Code Samples
:::CodeGroup
```bash {label="cURL"}
TOKEN=$(curl -s -X POST https://api.huli.ai/auth/token \
-d "grant_type=client_credentials" \
-d "client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer" \
-d "client_assertion=${CLIENT_ASSERTION}" \
-d "scope=system/ServiceRequest.cru" \
| jq -r .access_token)
curl -X PUT https://api.huli.ai/fhir/R4/ServiceRequest/${RESOURCE_ID} \
-H "Authorization: Bearer ${TOKEN}" \
-H "Content-Type: application/fhir+json" \
-d @resource.json
```
```typescript {label="TypeScript"}
const token = process.env.HULI_ACCESS_TOKEN ?? "";
const response = await fetch(
`https://api.huli.ai/fhir/R4/ServiceRequest/${id}`,
{
method: "PUT",
headers: {
"Authorization": `Bearer ${token}`,
"Content-Type": "application/fhir+json",
},
body: JSON.stringify(payload),
}
);
if (!response.ok) throw new Error(`HTTP ${String(response.status)}`);
const data: unknown = await response.json();
```
```python {label="Python"}
import os
import requests
token = os.environ["HULI_ACCESS_TOKEN"]
headers = {"Authorization": f"Bearer {token}", "Content-Type": "application/fhir+json"}
resp = requests.put(
f"https://api.huli.ai/fhir/R4/ServiceRequest/{resource_id}",
headers=headers,
json=payload,
)
resp.raise_for_status()
print(resp.json())
```
```java {label="Java"}
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class updateServiceRequestExample {
public static void main(String[] args) throws Exception {
String token = System.getenv("HULI_ACCESS_TOKEN");
String resourceId = "RESOURCE_ID";
String payload = "{}"; // your serialized FHIR resource
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.huli.ai/fhir/R4/ServiceRequest/" + resourceId))
.header("Authorization", "Bearer " + token)
.header("Accept", "application/fhir+json")
.header("Content-Type", "application/fhir+json")
.method("PUT", HttpRequest.BodyPublishers.ofString(payload))
.build();
HttpResponse response =
client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println("status: " + response.statusCode());
System.out.println(response.body());
}
}
```
```go {label="Go"}
import (
"fmt"
"net/http"
"os"
)
func updateServiceRequestExample() {
token := os.Getenv("HULI_ACCESS_TOKEN")
req, _ := http.NewRequest("PUT", "https://api.huli.ai/fhir/R4/ServiceRequest/"+resourceID+"", body)
req.Header.Set("Authorization", "Bearer "+token)
req.Header.Set("Content-Type", "application/fhir+json")
// set req.Body to your serialized resource
resp, err := http.DefaultClient.Do(req)
if err != nil {
fmt.Println("error:", err)
return
}
defer resp.Body.Close()
fmt.Println("status:", resp.Status)
}
```
:::
#### Errors
| Code | Status | Description |
|------|--------|-------------|
| [HPB-00101](/v1/errors#hpb-00101) | 400 | Validation error |
| [HPB-00106](/v1/errors#hpb-00106) | 401 | Authentication failed |
| [HPB-00104](/v1/errors#hpb-00104) | 403 | Insufficient scope |
| [HPB-00102](/v1/errors#hpb-00102) | 404 | Resource not found |
| [HPB-00103](/v1/errors#hpb-00103) | 409 | Version conflict |
| [HPB-00101](/v1/errors#hpb-00101) | 422 | Unprocessable entity |
| [HPB-00105](/v1/errors#hpb-00105) | 429 | Rate limit exceeded |
---
### Search ServiceRequests
Search for ServiceRequest resources. Requires a `patient` or `encounter` parameter.
Paginated with `_count` and a numeric offset `_cursor`.
**Required scope:**
#### Query Parameters
#### Code Samples
:::CodeGroup
```bash {label="cURL"}
TOKEN=$(curl -s -X POST https://api.huli.ai/auth/token \
-d "grant_type=client_credentials" \
-d "client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer" \
-d "client_assertion=${CLIENT_ASSERTION}" \
-d "scope=system/ServiceRequest.rs" \
| jq -r .access_token)
curl -X GET https://api.huli.ai/fhir/R4/ServiceRequest \
-H "Authorization: Bearer ${TOKEN}"
```
```typescript {label="TypeScript"}
const token = process.env.HULI_ACCESS_TOKEN ?? "";
const response = await fetch(
`https://api.huli.ai/fhir/R4/ServiceRequest`,
{
method: "GET",
headers: {
"Authorization": `Bearer ${token}`,
},
}
);
if (!response.ok) throw new Error(`HTTP ${String(response.status)}`);
const data: unknown = await response.json();
```
```python {label="Python"}
import os
import requests
token = os.environ["HULI_ACCESS_TOKEN"]
headers = {"Authorization": f"Bearer {token}"}
resp = requests.get(
f"https://api.huli.ai/fhir/R4/ServiceRequest",
headers=headers,
)
resp.raise_for_status()
print(resp.json())
```
```java {label="Java"}
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class searchServiceRequestsExample {
public static void main(String[] args) throws Exception {
String token = System.getenv("HULI_ACCESS_TOKEN");
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.huli.ai/fhir/R4/ServiceRequest"))
.header("Authorization", "Bearer " + token)
.header("Accept", "application/fhir+json")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response =
client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println("status: " + response.statusCode());
System.out.println(response.body());
}
}
```
```go {label="Go"}
import (
"fmt"
"net/http"
"os"
)
func searchServiceRequestsExample() {
token := os.Getenv("HULI_ACCESS_TOKEN")
req, _ := http.NewRequest("GET", "https://api.huli.ai/fhir/R4/ServiceRequest", nil)
req.Header.Set("Authorization", "Bearer "+token)
resp, err := http.DefaultClient.Do(req)
if err != nil {
fmt.Println("error:", err)
return
}
defer resp.Body.Close()
fmt.Println("status:", resp.Status)
}
```
:::
#### Errors
| Code | Status | Description |
|------|--------|-------------|
| [HPB-00101](/v1/errors#hpb-00101) | 400 | Validation error |
| [HPB-00106](/v1/errors#hpb-00106) | 401 | Authentication failed |
| [HPB-00104](/v1/errors#hpb-00104) | 403 | Insufficient scope |
| [HPB-00105](/v1/errors#hpb-00105) | 429 | Rate limit exceeded |
---
### Create ServiceRequest
Create a new ServiceRequest (a single-item service order). The server assigns the resource
ID and stamps the requesting practitioner from the authenticated session.
**Required scope:**
#### Request Body
#### Request Example
```json
{
"resourceType": "ServiceRequest",
"status": "active",
"intent": "order",
"priority": "routine",
"category": [
{
"coding": [
{
"code": "laboratory"
}
]
}
],
"code": {
"text": "Complete blood count (CBC)"
},
"subject": {
"reference": "Patient/550e8400-e29b-41d4-a716-446655440001"
}
}
```
#### Code Samples
:::CodeGroup
```bash {label="cURL"}
TOKEN=$(curl -s -X POST https://api.huli.ai/auth/token \
-d "grant_type=client_credentials" \
-d "client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer" \
-d "client_assertion=${CLIENT_ASSERTION}" \
-d "scope=system/ServiceRequest.c" \
| jq -r .access_token)
curl -X POST https://api.huli.ai/fhir/R4/ServiceRequest \
-H "Authorization: Bearer ${TOKEN}" \
-H "Content-Type: application/fhir+json" \
-d @servicerequest.json
```
```typescript {label="TypeScript"}
const token = process.env.HULI_ACCESS_TOKEN ?? "";
const response = await fetch(
`https://api.huli.ai/fhir/R4/ServiceRequest`,
{
method: "POST",
headers: {
"Authorization": `Bearer ${token}`,
"Content-Type": "application/fhir+json",
},
body: JSON.stringify(payload),
}
);
if (!response.ok) throw new Error(`HTTP ${String(response.status)}`);
const data: unknown = await response.json();
```
```python {label="Python"}
import os
import requests
token = os.environ["HULI_ACCESS_TOKEN"]
headers = {"Authorization": f"Bearer {token}", "Content-Type": "application/fhir+json"}
resp = requests.post(
f"https://api.huli.ai/fhir/R4/ServiceRequest",
headers=headers,
json=payload,
)
resp.raise_for_status()
print(resp.json())
```
```java {label="Java"}
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class createServiceRequestExample {
public static void main(String[] args) throws Exception {
String token = System.getenv("HULI_ACCESS_TOKEN");
String payload = "{}"; // your serialized FHIR resource
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.huli.ai/fhir/R4/ServiceRequest"))
.header("Authorization", "Bearer " + token)
.header("Accept", "application/fhir+json")
.header("Content-Type", "application/fhir+json")
.method("POST", HttpRequest.BodyPublishers.ofString(payload))
.build();
HttpResponse response =
client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println("status: " + response.statusCode());
System.out.println(response.body());
}
}
```
```go {label="Go"}
import (
"fmt"
"net/http"
"os"
)
func createServiceRequestExample() {
token := os.Getenv("HULI_ACCESS_TOKEN")
req, _ := http.NewRequest("POST", "https://api.huli.ai/fhir/R4/ServiceRequest", body)
req.Header.Set("Authorization", "Bearer "+token)
req.Header.Set("Content-Type", "application/fhir+json")
// set req.Body to your serialized resource
resp, err := http.DefaultClient.Do(req)
if err != nil {
fmt.Println("error:", err)
return
}
defer resp.Body.Close()
fmt.Println("status:", resp.Status)
}
```
:::
#### Errors
| Code | Status | Description |
|------|--------|-------------|
| [HPB-00101](/v1/errors#hpb-00101) | 400 | Validation error |
| [HPB-00106](/v1/errors#hpb-00106) | 401 | Authentication failed |
| [HPB-00104](/v1/errors#hpb-00104) | 403 | Insufficient scope |
| [HPB-00101](/v1/errors#hpb-00101) | 422 | Unprocessable entity |
| [HPB-00105](/v1/errors#hpb-00105) | 429 | Rate limit exceeded |
---