Skip to main content
POST
/
v1
/
imaging-studies
Create imaging study
curl --request POST \
  --url https://api.clinikapi.com/v1/imaging-studies \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "patientId": "<string>",
  "encounterId": "<string>",
  "modality": [
    "<string>"
  ],
  "started": "<string>",
  "referrerId": "<string>",
  "interpreterIds": [
    "<string>"
  ],
  "numberOfSeries": 123,
  "numberOfInstances": 123,
  "procedureCode": [
    "<string>"
  ],
  "locationId": "<string>",
  "reasonCode": [
    "<string>"
  ],
  "description": "<string>",
  "note": "<string>",
  "basedOn": [
    "<string>"
  ],
  "series": [
    {
      "uid": "<string>",
      "modality": "<string>",
      "number": 123,
      "description": "<string>",
      "numberOfInstances": 123,
      "bodySite": "<string>",
      "laterality": "<string>",
      "started": "<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:
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