Skip to main content

Provider System Access ServiceRequest

Overview​

The ServiceRequest resource represents a request for a service to be performed. This includes laboratory orders, imaging orders, clinical test orders, procedure orders, and referrals to support programs or specialists.

Supported Profiles:

Use Cases:

  • Query for specific procedure or test requests (e.g., electrocardiogram orders)
  • Query for referrals to support programs or specialists
  • Query for categories of service requests (e.g., all cardiology requests)
  • Track laboratory, imaging, and clinical test orders

Relationships:

  • Patient: References the individual for whom the service is requested
  • Encounter: May be linked to the clinical encounter when the request was created
  • Practitioner: References the healthcare provider making the request
  • Provenance: Tracks the source and history of service request information

Resource Schema​

Key Fields:

FieldTypeDescriptionRequired
idstringUnique identifier for the resourceYes
statuscodeRequest status (draft, active, on-hold, revoked, completed, entered-in-error, unknown)Yes
intentcodeRequest intent (proposal, plan, directive, order, original-order, reflex-order, filler-order, instance-order, option)Yes
codeCodeableConceptWhat is being requested/orderedYes
subjectReference(Patient)Individual the service is ordered forYes
categoryCodeableConcept[]Classification of serviceNo
encounterReference(Encounter)Encounter in which the request was createdNo
occurrence[x]dateTime/Period/TimingWhen service should occurNo
authoredOndateTimeDate request signedNo
requesterReference(Practitioner/Organization/Patient/PractitionerRole/RelatedPerson/Device)Who/what is requesting serviceNo
reasonCodeCodeableConcept[]Explanation/Justification for procedure or serviceNo
reasonReferenceReference(Condition/Observation/DiagnosticReport/DocumentReference)Supporting information for the requested serviceNo

JSON Example:

{
    "resourceType": "ServiceRequest",
    "id": "bmp",
    "meta": {
        "lastUpdated": "2022-08-19T13:58:00.000+00:00"
    },
    "status": "active",
    "intent": "order",
    "category": [
        {
            "coding": [
                {
                    "system": "http://snomed.info/sct",
                    "code": "108252007",
                    "display": "Laboratory procedure"
                }
            ]
        }
    ],
    "code": {
        "coding": [
            {
                "system": "http://loinc.org",
                "code": "24323-8",
                "display": "Comprehensive metabolic 2000 panel - Serum or Plasma"
            }
        ],
        "text": "Basic Metabolic Panel"
    },
    "subject": {
        "reference": "Patient/example"
    },
    "encounter": {
        "reference": "Encounter/example"
    },
    "occurrenceDateTime": "2022-08-20T09:00:00.000Z",
    "authoredOn": "2022-08-19T13:58:00.000Z",
    "requester": {
        "reference": "Practitioner/example"
    }
}

Operations​

The Certified API ServiceRequest resource supports the following operations. However, support varies by the targeted CareRecord or solution.

CareRecord / SolutionCreateReadUpdateSearch
GEHRIMED-Yes-Yes
myAvatar-Yes-Yes
myEvolv-Yes-Yes
myUnity-Yes-Yes
TheraOffice-Yes-Yes

Read: Retrieves a specific ServiceRequest resource by its unique identifier.

  • Endpoint: GET /ServiceRequest/{id}

Search: Search for service requests using various criteria.

GET Method​

Use GET for simple searches with parameters in the query string.

GET /ServiceRequest?parameter=value

POST Method​

Use POST for complex searches with form-encoded parameters.

POST /ServiceRequest/_search

Search Parameters​

Patient-based Search:

ParameterTypeRequiredDescriptionExample
patientreferenceYesREQUIRED Search by subject - a patientpatient=Patient/patient-123
authoreddateNoDate request signedauthored=2023-12-01
categorytokenNoClassification of servicecategory=108252007
codetokenNoWhat is being requested/orderedcode=24323-8
statustokenNoRequest statusstatus=active

| _revinclude | special | No | Include Provenance resources that reference this ServiceRequest | _revinclude=Provenance:target |

ID-based Search:

ParameterTypeRequiredDescriptionExample
authoreddateNoDate request signedauthored=2023-12-01
categorytokenNoClassification of servicecategory=108252007
codetokenNoWhat is being requested/orderedcode=24323-8
statustokenNoRequest statusstatus=active

| _revinclude | special | No | Include Provenance resources that reference this ServiceRequest | _revinclude=Provenance:target |

Common Search Patterns​

Find service requests for a patient:

GET /ServiceRequest?patient=Patient/patient-123&status=active

Search by category:

GET /ServiceRequest?patient=Patient/patient-123&category=108252007

Search by date range:

GET /ServiceRequest?patient=Patient/patient-123&authored=ge2023-01-01&authored=le2023-12-31

Examples​

Read Examples:

Read ServiceRequest by ID
curl -X GET https://fhir.netsmartcloud.com/provider/system-access/v2/{tenant-id}/ServiceRequest/1032702 \
    -H "Authorization: Bearer {token}" \
    -H "Accept: application/fhir+json"
Search ServiceRequest by ID
curl -X GET "https://fhir.netsmartcloud.com/provider/system-access/v2/{tenant-id}/ServiceRequest?_id=1032702" \
    -H "Authorization: Bearer {token}" \
    -H "Accept: application/fhir+json"

Search Examples:

Search by Patient
curl -X GET "https://fhir.netsmartcloud.com/provider/system-access/v2/{tenant-id}/ServiceRequest?patient=1137192" \
    -H "Authorization: Bearer {token}" \
    -H "Accept: application/fhir+json"
Search by Patient and Category
curl -X GET "https://fhir.netsmartcloud.com/provider/system-access/v2/{tenant-id}/ServiceRequest?patient=f201&category=http://loinc.org|LG41762-2" \
    -H "Authorization: Bearer {token}" \
    -H "Accept: application/fhir+json"
Search by Patient and Code
curl -X GET "https://fhir.netsmartcloud.com/provider/system-access/v2/{tenant-id}/ServiceRequest?patient=1032702&code=http://snomed.info/sct|35637008" \
    -H "Authorization: Bearer {token}" \
    -H "Accept: application/fhir+json"
Search by Patient, Category and Authored Date
curl -X GET "https://fhir.netsmartcloud.com/provider/system-access/v2/{tenant-id}/ServiceRequest?patient=f201&category=http://loinc.org|LG41762-2&authored=ge2010-01-14T00:00:00Z" \
    -H "Authorization: Bearer {token}" \
    -H "Accept: application/fhir+json"

Integration Patterns​

Common Workflows:

  • Retrieve all service requests for a patient during care coordination
  • Filter requests by category (laboratory, imaging, clinical tests, procedures)
  • Track order status and completion
  • Include provenance data to track request information sources
  • Cross-reference with encounters to understand request context

Category Codes for USCDI Order Data Elements:

USCDI Order Data ElementCategory CodeDisplay
Laboratory Order108252007Laboratory procedure (procedure)
Imaging Order363679005Imaging (procedure)
Clinical Test Order386053000Evaluation procedure (procedure)
Procedure Order387713003Surgical procedure (procedure)

Common Search Patterns​

Find service requests for a patient:

GET /ServiceRequest?patient=Patient/patient-123&status=active

Search by category:

GET /ServiceRequest?patient=Patient/patient-123&category=108252007

Search by date range:

GET /ServiceRequest?patient=Patient/patient-123&authored=ge2023-01-01&authored=le2023-12-31

Examples​

Read Examples:

Read ServiceRequest by ID
curl -X GET https://fhir.netsmartcloud.com/provider/system-access/v2/{tenant-id}/ServiceRequest/1032702 \
    -H "Authorization: Bearer {token}" \
    -H "Accept: application/fhir+json"
Search ServiceRequest by ID
curl -X GET "https://fhir.netsmartcloud.com/provider/system-access/v2/{tenant-id}/ServiceRequest?_id=1032702" \
    -H "Authorization: Bearer {token}" \
    -H "Accept: application/fhir+json"

Search Examples:

Search by Patient
curl -X GET "https://fhir.netsmartcloud.com/provider/system-access/v2/{tenant-id}/ServiceRequest?patient=1137192" \
    -H "Authorization: Bearer {token}" \
    -H "Accept: application/fhir+json"
Search by Patient and Category
curl -X GET "https://fhir.netsmartcloud.com/provider/system-access/v2/{tenant-id}/ServiceRequest?patient=f201&category=http://loinc.org|LG41762-2" \
    -H "Authorization: Bearer {token}" \
    -H "Accept: application/fhir+json"
Search by Patient and Code
curl -X GET "https://fhir.netsmartcloud.com/provider/system-access/v2/{tenant-id}/ServiceRequest?patient=1032702&code=http://snomed.info/sct|35637008" \
    -H "Authorization: Bearer {token}" \
    -H "Accept: application/fhir+json"
Search by Patient, Category and Authored Date
curl -X GET "https://fhir.netsmartcloud.com/provider/system-access/v2/{tenant-id}/ServiceRequest?patient=f201&category=http://loinc.org|LG41762-2&authored=ge2010-01-14T00:00:00Z" \
    -H "Authorization: Bearer {token}" \
    -H "Accept: application/fhir+json"

Integration Patterns​

Common Workflows:

  • Retrieve all service requests for a patient during care coordination
  • Filter requests by category (laboratory, imaging, clinical tests, procedures)
  • Track order status and completion
  • Include provenance data to track request information sources
  • Cross-reference with encounters to understand request context

Category Codes for USCDI Order Data Elements:

USCDI Order Data ElementCategory CodeDisplay
Laboratory Order108252007Laboratory procedure (procedure)
Imaging Order363679005Imaging (procedure)
Clinical Test Order386053000Evaluation procedure (procedure)
Procedure Order387713003Surgical procedure (procedure)

Related Resources:

  • Patient - Individual for whom the service is requested
  • Encounter - Clinical encounter when request was created
  • Practitioner - Healthcare provider making the request
  • Condition - Supporting diagnosis or indication
  • Provenance - Source and history tracking

Error Handling​

For detailed error codes and handling procedures, see the Error Handling Guide.

Supported Profiles​

This resource supports the following FHIR profiles as defined in the CapabilityStatement: