Skip to main content
POST
Create imaging study

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:
registered,
available,
cancelled
patientId
string
required
Maximum string length: 128
encounterId
string
Maximum string length: 128
modality
string[]
Maximum array length: 20
Maximum string length: 50
started
string
Maximum string length: 50
referrerId
string
Maximum string length: 128
interpreterIds
string[]
Maximum array length: 10
Maximum string length: 128
numberOfSeries
integer
numberOfInstances
integer
procedureCode
string[]
Maximum array length: 10
Maximum string length: 500
locationId
string
Maximum string length: 128
reasonCode
string[]
Maximum array length: 10
Maximum string length: 500
description
string
Maximum string length: 2000
note
string
Maximum string length: 5000
basedOn
string[]
Maximum array length: 10
Maximum string length: 128
series
object[]
Maximum array length: 50

Response

201

Imaging study created