Skip to main content
POST
/
v1
/
device-requests
Create device request
curl --request POST \
  --url https://api.clinikapi.com/v1/device-requests \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "code": "<string>",
  "patientId": "<string>",
  "encounterId": "<string>",
  "occurrenceDateTime": "<string>",
  "occurrencePeriod": {
    "start": "<string>",
    "end": "<string>"
  },
  "authoredOn": "<string>",
  "requesterId": "<string>",
  "performerId": "<string>",
  "performerType": "<string>",
  "reasonCode": [
    "<string>"
  ],
  "note": "<string>",
  "basedOn": [
    "<string>"
  ]
}
'

Authorizations

​
x-api-key
string
header
required

Your ClinikAPI secret key (clk_live_* or clk_test_*)

Body

application/json
​
intent
enum<string>
required
Available options:
proposal,
plan,
directive,
order,
original-order,
reflex-order,
filler-order,
instance-order,
option
​
code
required
​
patientId
string
required
Maximum string length: 128
​
status
enum<string>
Available options:
draft,
active,
on-hold,
revoked,
completed
​
encounterId
string
Maximum string length: 128
​
priority
enum<string>
Available options:
routine,
urgent,
asap,
stat
​
occurrenceDateTime
string
​
occurrencePeriod
object
​
authoredOn
string
​
requesterId
string
Maximum string length: 128
​
performerId
string
Maximum string length: 128
​
performerType
string
Maximum string length: 200
​
reasonCode
string[]
Maximum array length: 20
Maximum string length: 500
​
note
string
Maximum string length: 5000
​
basedOn
string[]
Maximum array length: 20
Maximum string length: 200

Response

201

Device request created