Skip to main content
POST
/
v1
/
service-requests
Create service request
curl --request POST \
  --url https://api.clinikapi.com/v1/service-requests \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "patientId": "<string>",
  "encounterId": "<string>",
  "code": "<string>",
  "category": [
    "<string>"
  ],
  "doNotPerform": true,
  "occurrenceDateTime": "2023-11-07T05:31:56Z",
  "occurrencePeriod": {
    "start": "<string>",
    "end": "<string>"
  },
  "asNeeded": true,
  "authoredOn": "2023-11-07T05:31:56Z",
  "requesterId": "<string>",
  "performerType": "<string>",
  "performerIds": [
    "<string>"
  ],
  "reasonCode": [
    "<string>"
  ],
  "bodySite": [
    "<string>"
  ],
  "note": "<string>",
  "patientInstruction": "<string>",
  "basedOn": [
    "<string>"
  ],
  "replaces": [
    "<string>"
  ]
}
'
{
  "error": "<string>",
  "message": "<string>",
  "code": "<string>",
  "requestId": "<string>",
  "issues": [
    {
      "severity": "<string>",
      "code": "<string>",
      "diagnostics": "<string>"
    }
  ]
}

Authorizations

x-api-key
string
header
required

Your ClinikAPI secret key (clk_live_* or clk_test_*)

Body

application/json
status
enum<string>
required
Available options:
draft,
active,
on-hold,
revoked,
completed
intent
enum<string>
required
Available options:
proposal,
plan,
directive,
order,
original-order,
reflex-order,
filler-order,
instance-order,
option
patientId
string
required
encounterId
string
code
category
string[]
priority
enum<string>
Available options:
routine,
urgent,
asap,
stat
doNotPerform
boolean
occurrenceDateTime
string<date-time>
occurrencePeriod
object
asNeeded
boolean
authoredOn
string<date-time>
requesterId
string
performerType
string
performerIds
string[]
reasonCode
string[]
bodySite
string[]
note
string
Maximum string length: 2000
patientInstruction
string
Maximum string length: 2000
basedOn
string[]
replaces
string[]

Response

Service request created