ServiceRequest

A request for a service to be performed for a patient, such as imaging, laboratory testing, or referral.

https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-servicerequest.html

ServiceRequest represents multiple Canvas services:

  • Imaging orders (e.g., CT, MRI, X-ray) - Ordering imaging study - Laboratory orders (e.g., hemoglobin/hematocrit) - Placing a lab order - Referrals (e.g., patient referral to specialist) - Referring a patient The ServiceRequest surface reflects these orders via standardized coding:
  • category uses SNOMED CT to represent the order category (e.g., Imaging, Laboratory procedure, Referral/Evaluation procedure) - code uses LOINC to represent the requested test/procedure

Endpoints

get
/ServiceRequest/{id}
 get
/ServiceRequest
get
/ServiceRequest/{id}

ServiceRequest read

Read a ServiceRequest resource.

Path Parameters

id required
string
The unique identifier for the ServiceRequest

Response Payload Attributes

resourceType
string

The FHIR Resource name.

id
string

The identifier of the ServiceRequest.

status
string

A code specifying the state of the ServiceRequest.

Value Options Supported:
  • active
  • completed
  • draft
  • entered-in-error
intent
string

Indicates the level of authorization/intent for the request. Canvas supports order for orders placed by a practitioner.

Value Options Supported:
  • order
category
array[json]

Categorical classification of the requested service (SNOMED CT). Common examples include Imaging, Laboratory procedure, and Referral/Evaluation procedure.

Click to view child attributes
coding
array[json]

Code defined by a terminology system.

Click to view child attributes
system
string

The system URL of the coding.

Value Options Supported:
  • http://snomed.info/sct
code
string

The code value.

Value Options Supported:
  • 363679005
  • 108252007
  • 386053000
display
string

The display name of the coding.

Value Options Supported:
  • Imaging
  • Laboratory procedure
  • Evaluation procedure (procedure)
code
json

What service is being requested in a coded form (typically LOINC).

Click to view child attributes
coding
array[json]

Code defined by a terminology system.

Click to view child attributes
system
string

The system URL of the coding.

Value Options Supported:
  • http://loinc.org
code
string

The code value that represents the respective Canvas service/order.

display
string

The display name of the coding.

subject
json

Who/what the service request is for.

Click to view child attributes
reference
string

The reference string of the subject in the format of "Patient/c4ff2ee2e41b4636b7d37ac7f9297d95".

type
string

Type the reference refers to (e.g. “Patient”).

occurrencePeriod
json

The time window during which the service is to occur.

Click to view child attributes
start
datetime

Starting time with inclusive boundary of the requested service period.

end
datetime

End time with inclusive boundary of the requested service period.

authoredOn
datetime

When the request was authored in Canvas.

requester
json

Who/what is requesting the service (a Practitioner reference).

Click to view child attributes
reference
string

The reference string of the requester in the format of "Practitioner/5eede137ecfe4124b8b773040e33be14".

type
string

Type the reference refers to (e.g. “Practitioner”).

reasonReference
array[json]

Reason for the request. References Conditions from Canvas.

Click to view child attributes
reference
string

The reference string of the reason in the format of "Condition/6700a428-6387-458d-8134-0702851da23c".

type
string

Type the reference refers to (e.g. “Condition”).

Responses

200 OK
Request was successful.

Errors

401 Unauthorized
The request requires user authentication.
403 Forbidden
The request requires user authorization.
404 Not Found
The requested resource was not found.
get
/ServiceRequest

ServiceRequest search

Search for ServiceRequest resources.

Query Parameters

_id
string

The identifier of the ServiceRequest.

patient
string

The patient reference associated to the Service Request in the format Patient/c4ff2ee2e41b4636b7d37ac7f9297d95.

authored
date

Filter by authoredOn. See Date Filtering for more information.

status
string

The status of the request. Filters by the status field.

Search Values Supported:
  • active
  • completed
  • draft
  • entered-in-error
category
string

Categorization of the request (SNOMED CT). Filters by category.coding code and/or system. You can search by code alone or system|code.

Search Values Supported:
  • http://snomed.info/sct|363679005
  • http://snomed.info/sct|108252007
  • http://snomed.info/sct|386053000
code
string

What is being requested (typically LOINC). Filters by code.coding code and/or system. You can search by code alone or system|code.

Response Payload Attributes

resourceType
string

The FHIR Resource name.

type
string

This element and value designate that the bundle is a search response. Search result bundles will always have the Bundle.type of searchset .

total
integer

The number of resources that match the search parameter.

link
array[json]

Attributes relevant to pagination, see our Pagination page for more detail.

Click to view child attributes
relation
enum [self|first|next|last]

The relation of the page search

url

The search url for the specific relation

entry
array[json]

The results bundle that lists out each object returned in the search

Click to view child attributes
resource
json

The attributes specific to the resource type, see the Attributes section below

Attributes

resourceType
string

The FHIR Resource name.

id
string

The identifier of the ServiceRequest.

status
string

A code specifying the state of the ServiceRequest.

Value Options Supported:
  • active
  • completed
  • draft
  • entered-in-error
intent
string

Indicates the level of authorization/intent for the request. Canvas supports order for orders placed by a practitioner.

Value Options Supported:
  • order
category
array[json]

Categorical classification of the requested service (SNOMED CT). Common examples include Imaging, Laboratory procedure, and Referral/Evaluation procedure.

Click to view child attributes
coding
array[json]

Code defined by a terminology system.

Click to view child attributes
system
string

The system URL of the coding.

Value Options Supported:
  • http://snomed.info/sct
code
string

The code value.

Value Options Supported:
  • 363679005
  • 108252007
  • 386053000
display
string

The display name of the coding.

Value Options Supported:
  • Imaging
  • Laboratory procedure
  • Evaluation procedure (procedure)
code
json

What service is being requested in a coded form (typically LOINC).

Click to view child attributes
coding
array[json]

Code defined by a terminology system.

Click to view child attributes
system
string

The system URL of the coding.

Value Options Supported:
  • http://loinc.org
code
string

The code value that represents the respective Canvas service/order.

display
string

The display name of the coding.

subject
json

Who/what the service request is for.

Click to view child attributes
reference
string

The reference string of the subject in the format of "Patient/c4ff2ee2e41b4636b7d37ac7f9297d95".

type
string

Type the reference refers to (e.g. “Patient”).

occurrencePeriod
json

The time window during which the service is to occur.

Click to view child attributes
start
datetime

Starting time with inclusive boundary of the requested service period.

end
datetime

End time with inclusive boundary of the requested service period.

authoredOn
datetime

When the request was authored in Canvas.

requester
json

Who/what is requesting the service (a Practitioner reference).

Click to view child attributes
reference
string

The reference string of the requester in the format of "Practitioner/5eede137ecfe4124b8b773040e33be14".

type
string

Type the reference refers to (e.g. “Practitioner”).

reasonReference
array[json]

Reason for the request. References Conditions from Canvas.

Click to view child attributes
reference
string

The reference string of the reason in the format of "Condition/6700a428-6387-458d-8134-0702851da23c".

type
string

Type the reference refers to (e.g. “Condition”).

Responses

200 OK
Request was successful.

Errors

400 Bad Request
The request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401 Unauthorized
The request requires user authentication.
403 Forbidden
The request requires user authorization.
  • curl --request GET \
     --url 'https://fumage-example.canvasmedical.com/ServiceRequest/<id>' \
     --header 'Authorization: Bearer <token>' \
     --header 'accept: application/json'

  • import requests

url = "https://fumage-example.canvasmedical.com/ServiceRequest/<id>"

headers = {
    "accept": "application/json",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

  • {
    "resourceType": "ServiceRequest",
    "id": "a47c7b0e-bbb4-42cd-bc4a-df259d148ea1",
    "status": "active",
    "intent": "order",
    "category": [
      {
        "coding": [
          {
            "system": "http://snomed.info/sct",
            "code": "363679005",
            "display": "Imaging"
          }
        ]
      }
    ],
    "code": {
      "coding": [
        {
          "system": "http://loinc.org",
          "code": "24627-2",
          "display": "CT Chest"
        }
      ]
    },
    "subject": {
      "reference": "Patient/c4ff2ee2e41b4636b7d37ac7f9297d95",
      "type": "Patient"
    },
    "occurrencePeriod": {
      "start": "2025-10-01T09:00:00+00:00",
      "end": "2025-10-01T09:30:00+00:00"
    },
    "authoredOn": "2025-09-30T19:12:25.073749+00:00",
    "requester": {
      "reference": "Practitioner/5eede137ecfe4124b8b773040e33be14",
      "type": "Practitioner"
    },
    "reasonReference": [
      {
        "reference": "Condition/6700a428-6387-458d-8134-0702851da23c"
      }
    ]
}

  • {
  "resourceType": "OperationOutcome",
  "issue": [
    {
      "severity": "error",
      "code": "unknown",
      "details": {
        "text": "Authentication failed"
      }
    }
  ]
}

  • {
  "resourceType": "OperationOutcome",
  "issue": [
    {
      "severity": "error",
      "code": "forbidden",
      "details": {
        "text": "Authorization failed"
      }
    }
  ]
}

  • {
  "resourceType": "OperationOutcome",
  "issue": [
    {
      "severity": "error",
      "code": "not-found",
      "details": {
        "text": "Unknown ServiceRequest resource 'a47c7b0e-bbb4-42cd-bc4a-df259d148ea1'"
      }
    }
  ]
}

  • curl --request GET \
     --url 'https://fumage-example.canvasmedical.com/ServiceRequest?patient=Patient/c4ff2ee2e41b4636b7d37ac7f9297d95' \
     --header 'Authorization: Bearer <token>' \
     --header 'accept: application/json'

  • import requests

url = "https://fumage-example.canvasmedical.com/ServiceRequest?patient=Patient/c4ff2ee2e41b4636b7d37ac7f9297d95"

headers = {
    "accept": "application/json",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

  • {
  "resourceType": "Bundle",
  "type": "searchset",
  "total": 3,
  "link": [
    {
      "relation": "self",
      "url": "/ServiceRequest?_count=10&_offset=0"
    },
    {
      "relation": "first",
      "url": "/ServiceRequest?_count=10&_offset=0"
    },
    {
      "relation": "last",
      "url": "/ServiceRequest?_count=10&_offset=0"
    }
  ],
  "entry": [
    {
      "resource": {
        "resourceType": "ServiceRequest",
        "id": "bef0e33b-5008-489b-aa32-873b99e1e523",
        "status": "active",
        "intent": "order",
        "category": [
          {
            "coding": [
              {
                "system": "http://snomed.info/sct",
                "code": "363679005",
                "display": "Imaging"
              }
            ]
          }
        ],
        "code": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "24627-2",
              "display": "CT Chest"
            }
          ]
        },
        "subject": {
          "reference": "Patient/c4ff2ee2e41b4636b7d37ac7f9297d95",
          "type": "Patient"
        },
        "occurrencePeriod": {
          "start": "2025-10-01T09:00:00+00:00",
          "end": "2025-10-01T09:30:00+00:00"
        },
        "authoredOn": "2025-09-30T19:12:25.073749+00:00",
        "requester": {
          "reference": "Practitioner/5eede137ecfe4124b8b773040e33be14",
          "type": "Practitioner"
        },
        "reasonReference": [
          {
            "reference": "Condition/6700a428-6387-458d-8134-0702851da23c"
          }
        ]
      }
    },
    {
      "resource": {
        "resourceType": "ServiceRequest",
        "id": "5938a56b-0239-47c5-ad31-703ca5104bb5",
        "status": "draft",
        "intent": "order",
        "category": [
          {
            "coding": [
              {
                "system": "http://snomed.info/sct",
                "code": "108252007",
                "display": "Laboratory procedure"
              }
            ]
          }
        ],
        "code": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "4544-3",
              "display": "Hematocrit"
            },
            {
              "system": "http://loinc.org",
              "code": "718-7",
              "display": "Hemoglobin"
            }
          ]
        },
        "subject": {
          "reference": "Patient/c4ff2ee2e41b4636b7d37ac7f9297d95",
          "type": "Patient"
        },
        "occurrencePeriod": {
          "start": "2025-10-01T09:00:00+00:00",
          "end": "2025-10-01T09:30:00+00:00"
        },
        "authoredOn": "2025-09-30T19:12:25.100394+00:00",
        "requester": {
          "reference": "Practitioner/5eede137ecfe4124b8b773040e33be14",
          "type": "Practitioner"
        },
        "reasonReference": [
          {
            "reference": "Condition/2db04232-de4f-4d59-8066-2e5cee1c2a1d"
          }
        ]
      }
    },
    {
      "resource": {
        "resourceType": "ServiceRequest",
        "id": "db35b108-a9f3-4d70-bc76-4c4800bce005",
        "status": "completed",
        "intent": "order",
        "category": [
          {
            "coding": [
              {
                "system": "http://snomed.info/sct",
                "code": "386053000",
                "display": "Evaluation procedure (procedure)"
              }
            ]
          }
        ],
        "code": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "103696004",
              "display": "Patient referral to specialist"
            }
          ]
        },
        "subject": {
          "reference": "Patient/c4ff2ee2e41b4636b7d37ac7f9297d95",
          "type": "Patient"
        },
        "occurrencePeriod": {
          "start": "2025-10-01T09:00:00+00:00",
          "end": "2025-10-01T09:30:00+00:00"
        },
        "authoredOn": "2025-09-30T19:12:25.121629+00:00",
        "requester": {
          "reference": "Practitioner/5eede137ecfe4124b8b773040e33be14",
          "type": "Practitioner"
        },
        "reasonReference": [
          {
            "reference": "Condition/691a6afa-a450-425e-a151-26b20f595efb"
          }
        ]
      }
    }
  ]
}

  • {
  "resourceType": "OperationOutcome",
  "issue": [
    {
      "severity": "error",
      "code": "invalid",
      "details": {
        "text": "Bad request"
      }
    }
  ]
}

  • {
  "resourceType": "OperationOutcome",
  "issue": [
    {
      "severity": "error",
      "code": "unknown",
      "details": {
        "text": "Authentication failed"
      }
    }
  ]
}

  • {
  "resourceType": "OperationOutcome",
  "issue": [
    {
      "severity": "error",
      "code": "forbidden",
      "details": {
        "text": "Authorization failed"
      }
    }
  ]
}