Skip to main content
POST
Create encounter

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