Skip to main content
POST
/
v1
/
encounters
Create encounter
curl --request POST \
  --url https://api.clinikapi.com/v1/encounters \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "class": "<string>",
  "patientId": "<string>",
  "practitionerId": "<string>",
  "participants": [
    {
      "practitionerId": "<string>",
      "role": "<string>"
    }
  ],
  "type": "<string>",
  "serviceType": "<string>",
  "priority": "<string>",
  "reasonCode": "<string>",
  "period": {
    "start": "2023-11-07T05:31:56Z",
    "end": "2023-11-07T05:31:56Z"
  },
  "lengthMinutes": 123,
  "location": "<string>",
  "serviceProvider": "<string>",
  "diagnosis": [
    {
      "condition": "<string>",
      "use": "<string>",
      "rank": 123
    }
  ],
  "appointmentId": "<string>",
  "basedOnId": "<string>",
  "partOfId": "<string>",
  "hospitalization": {
    "admitSource": "<string>",
    "dischargeDisposition": "<string>",
    "reAdmission": "<string>",
    "dietPreference": [
      "<string>"
    ],
    "specialArrangement": [
      "<string>"
    ],
    "destination": "<string>",
    "origin": "<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:
planned,
arrived,
triaged,
in-progress,
onleave,
finished,
cancelled
class
string
required

AMB (ambulatory), IMP (inpatient), EMER (emergency), HH (home health), VR (virtual)

patientId
string
required
practitionerId
string

Primary practitioner reference

participants
object[]

Additional participants (nurses, specialists)

type
string
Maximum string length: 200
serviceType
string
Maximum string length: 200
priority
string
Maximum string length: 50
reasonCode
string
Maximum string length: 500
period
object
lengthMinutes
integer
Required range: x <= 10080
location
string
Maximum string length: 200
serviceProvider
string
Maximum string length: 200
diagnosis
object[]
Maximum array length: 20
appointmentId
string

Appointment that scheduled this encounter

basedOnId
string

ServiceRequest that initiated this encounter

partOfId
string

Parent encounter ID (for sub-encounters)

hospitalization
object

Inpatient admission/discharge details

Response

Encounter created