status, a visit class (e.g. ambulatory or inpatient), and the patientId. Optionally link a practitioner, specify timing, location, and attach diagnosis codes.
Request
POST https://api.clinikapi.com/v1/encounters
Headers
Your ClinikAPI secret key (
clk_live_* or clk_test_*).Must be
application/json.Body
Encounter status. One of:
planned, arrived, triaged, in-progress, onleave, finished, cancelled.Visit class code. Use
AMB (ambulatory), IMP (inpatient), EMER (emergency), HH (home health), or VR (virtual).ID of the patient for this encounter.
ID of the practitioner responsible for the encounter.
Encounter type description. Maximum 200 characters.
Service type (e.g.
General Practice). Maximum 200 characters.Clinical priority. Maximum 50 characters.
Reason for the encounter. Maximum 500 characters.
Encounter time period.
Duration of the encounter in minutes. Maximum 10080 (one week).
Location where the encounter took place. Maximum 200 characters.
Providing organization name. Maximum 200 characters.
Diagnoses associated with this encounter. Maximum 20 items.
Response
Returns201 Created with the new encounter resource.
Generated encounter ID.
Encounter status.
Visit class code.
Patient ID linked to this encounter.
Standard response metadata.