Skip to main content

ServiceRequest

Overview​

The ServiceRequest resource represents requests for services such as diagnostic investigations, treatments, or operations to be performed. This resource supports referral management and care coordination workflows.

Important: Always validate ServiceRequest resource support and available operations by retrieving the current CapabilityStatement from /metadata before implementing integrations.

Resource Schema​

The ServiceRequest resource follows the HL7 FHIR R4 ServiceRequest specification.

Key elements include:

  • identifier - Identifiers assigned to this order
  • instantiatesCanonical - Instantiates FHIR protocol or definition
  • instantiatesUri - Instantiates external protocol or definition
  • basedOn - What request fulfills
  • replaces - What request replaces
  • requisition - Composite Request ID
  • status - Draft, active, on-hold, revoked, completed, entered-in-error, unknown
  • intent - Proposal, plan, directive, order, original-order, reflex-order, filler-order, instance-order, option
  • category - Classification of service
  • priority - Routine, urgent, asap, stat
  • doNotPerform - True if service/procedure should not be performed
  • code - What is being requested/ordered
  • orderDetail - Additional order information
  • quantityQuantity - Service amount
  • quantityRatio - Service amount
  • quantityRange - Service amount
  • subject - Individual or Entity the service is ordered for
  • encounter - Encounter in which the request was created
  • occurrenceDateTime - When service should occur
  • occurrencePeriod - When service should occur
  • occurrenceTiming - When service should occur
  • asNeededBoolean - Preconditions for service
  • asNeededCodeableConcept - Preconditions for service
  • authoredOn - Date request signed
  • requester - Who/what is requesting service
  • performerType - Performer role
  • performer - Requested performer
  • locationCode - Requested location
  • locationReference - Requested location
  • reasonCode - Explanation/Justification for procedure or service
  • reasonReference - Explanation/Justification for service or service
  • insurance - Associated insurance coverage
  • supportingInfo - Additional clinical information
  • specimen - Procedure Samples
  • bodySite - Location on Body
  • note - Comments
  • patientInstruction - Patient or consumer-oriented instructions
  • relevantHistory - Request provenance

Example ServiceRequest Resource​

{
  "resourceType": "ServiceRequest",
  "id": "12345",
  "identifier": [{
    "use": "official",
    "system": "http://hospital.example.org/service-requests",
    "value": "SR-2024-001"
  }],
  "status": "active",
  "intent": "order",
  "category": [{
    "coding": [{
      "system": "http://snomed.info/sct",
      "code": "103693007",
      "display": "Diagnostic procedure"
    }]
  }],
  "priority": "routine",
  "code": {
    "coding": [{
      "system": "http://loinc.org",
      "code": "24323-8",
      "display": "Comprehensive metabolic panel"
    }]
  },
  "subject": {
    "reference": "Patient/12345"
  },
  "encounter": {
    "reference": "Encounter/67890"
  },
  "occurrenceDateTime": "2024-01-20T09:00:00Z",
  "authoredOn": "2024-01-15T14:30:00Z",
  "requester": {
    "reference": "Practitioner/67890",
    "display": "Dr. John Smith"
  },
  "performerType": {
    "coding": [{
      "system": "http://snomed.info/sct",
      "code": "159033005",
      "display": "Medical laboratory"
    }]
  },
  "reasonCode": [{
    "coding": [{
      "system": "http://snomed.info/sct",
      "code": "73211009",
      "display": "Diabetes mellitus"
    }]
  }],
  "note": [{
    "text": "Fasting labs - patient should fast for 12 hours prior to collection"
  }]
}

Supported Profiles​

This API supports the following FHIR profiles:

Operations​

The General Purpose FHIR R4 ServiceRequest resource supports the following standard operations. However, support varies by the targeted CareRecord or solution.

CareRecord / SolutionCreateReadUpdateSearch
GEHRIMED----
myAvatar----
myEvolv----
myUnity----
Referral Manager----
info

Not all Netsmart solutions support ServiceRequest search. See supported operations table above and consult your target solution's documentation for more information.

This resource supports a combination of standard and custom search parameters in addition to the common parameters.

Standard Parameters​

NameTypeDescription
authoreddateDate request signed
categorytokenClassification of service
codetokenWhat is being request/ordered
identifiertokenIdentifiers assigned to this order
patientreferenceSearch by subject - a patient
statustokenThe status of the service

Search Examples​

The POST method is recommended as it keeps health information out of the URL.

Search Service Requests by Patient
curl -X POST https://fhir.netsmartcloud.com/v4/ServiceRequest/_search \
    -H "Authorization: {Bearer Token}" \
    -H "Accept: application/fhir+json" \
    -H "Content-Type: application/x-form-urlencoded" \
    -d "patient=Patient/678" \

Error Handling​

For information about error responses when working with ServiceRequest resources, see Common Errors.

Common ServiceRequest-related errors include:

  • Missing required patient reference
  • Invalid service codes or LOINC codes
  • Malformed request dates
  • Invalid requester or performer references

Integration Patterns​

Referral Management​

Track service requests and referrals:

# Get active service requests for patient
curl -X GET "https://fhir.netsmartcloud.com/v4/ServiceRequest?patient=12345&status=active" \
    -H "Authorization: Bearer {token}" \
    -H "Accept: application/fhir+json"

Laboratory Orders​

Manage diagnostic test orders:

# Get lab orders by category
curl -X GET "https://fhir.netsmartcloud.com/v4/ServiceRequest?patient=12345&category=103693007" \
    -H "Authorization: Bearer {token}" \
    -H "Accept: application/fhir+json"

Care Coordination​

Track requests by date range:

# Get recent service requests
curl -X GET "https://fhir.netsmartcloud.com/v4/ServiceRequest?patient=12345&authored=ge2024-01-01" \
    -H "Authorization: Bearer {token}" \
    -H "Accept: application/fhir+json"

Provider Workflows​

Find requests by specific codes:

# Get specific test orders
curl -X GET "https://fhir.netsmartcloud.com/v4/ServiceRequest?patient=12345&code=24323-8" \
    -H "Authorization: Bearer {token}" \
    -H "Accept: application/fhir+json"

Relationships to Other Resources​

The ServiceRequest resource connects to many clinical and administrative resources:

  • Patient - The individual for whom services are requested
  • Practitioner - Healthcare providers requesting services
  • Encounter - Clinical encounters during which requests are made
  • Condition - Health conditions justifying service requests
  • Procedure - Procedures that fulfill service requests
  • Observation - Results from diagnostic service requests
  • Organization - Healthcare organizations processing requests

Support​

For questions about ServiceRequest resource implementation or referral management workflows, contact Netsmart support through your designated support channels.