API reference

Booking

Jadwal praktik, slot, cuti/libur, dan booking pasien (modul booking).

OpenAPI 3.1 · version 1.1.0 · 127 operations · 30 webhook events

Download YAML Download JSON Getting started

Base URLhttps://api.medivana.cloud/api/v1

Endpoint descriptions come from the OpenAPI specification and are written in Indonesian.

GET/booking/appointments

Daftar booking

Default hari ini di cabang aktif. Pakai date atau rentang from/to. status boleh dipisah koma.

Scopes: appointments:readappointments:writeencounters:read(any one of)
RBAC permissions: appointment.manage · appointment.read · encounter.read · queue.manage
Module: booking

Parameters

Parameters GET /booking/appointments
Name	In	Type	Description
X-Branch-ID	header	string (uuid)	Cabang aktif (opsional). Nilai di luar cabang klien diabaikan.
date	query	string (date)
from	query	string (date)
to	query	string (date)
patient_id	query	string (uuid)
practitioner_id	query	string (uuid)
unit_id	query	string (uuid)
branch_id	query	string (uuid)
status	query	string	booked, checked_in, cancelled, no_show, done (pisah koma)

Code examples

curlJavaScriptPython

curl -X GET "https://api.medivana.cloud/api/v1/booking/appointments" \
  -H "Authorization: Bearer $MEDIVANA_TOKEN"

const res = await fetch("https://api.medivana.cloud/api/v1/booking/appointments", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.MEDIVANA_TOKEN}`,
  },
});
if (!res.ok) throw new Error(`HTTP ${res.status}: ${await res.text()}`);
const data = await res.json();

import os
import requests

resp = requests.get(
    "https://api.medivana.cloud/api/v1/booking/appointments",
    headers={"Authorization": f"Bearer {os.environ['MEDIVANA_TOKEN']}"},
    timeout=30,
)
resp.raise_for_status()
data = resp.json()

Responses

200Booking (urut waktu mulai)application/json

{
  "items": [
    {
      "id": "3f0c2a10-5b7e-4c1d-9a2e-00000001a001",
      "code": "BK-7KQ2MZ",
      "branch_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000000b1",
      "unit_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000c0001",
      "unit_name": "Poli Umum",
      "patient_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000a0001",
      "patient_name": "Pasien Contoh",
      "practitioner_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000d0001",
      "practitioner_name": "dr. Rina Contoh",
      "start_at": "2026-11-02T08:15:00+07:00",
      "end_at": "2026-11-02T08:30:00+07:00",
      "status": "booked",
      "source": "admin",
      "payer_kind": "umum",
      "complaint": "Demam 3 hari",
      "version": 1
    }
  ]
}

Schema 200

Schema 200
Name	Type	Description
itemsrequired	array<object>
items[].id	string (uuid)
items[].code	string
items[].branch_id	string (uuid)
items[].unit_id	string (uuid)
items[].unit_name	string
items[].patient_id	string (uuid) \| null
items[].patient_name	string
items[].patient_phone_masked	string \| null
items[].patient_sex	string \| null
items[].patient_birth_date	string (date) \| null
items[].is_new_patient	boolean
items[].practitioner_id	string (uuid)
items[].practitioner_name	string
items[].schedule_id	string (uuid) \| null
items[].service_id	string (uuid) \| null
items[].start_at	string (date-time)
items[].end_at	string (date-time)
items[].status	booked \| checked_in \| cancelled \| no_show \| done
items[].source	portal \| whatsapp \| admin \| bpjs
items[].payer_kind	umum \| bpjs \| insurance \| company
items[].payer_id	string (uuid) \| null
items[].complaint	string \| null
items[].encounter_id	string (uuid) \| null
items[].checked_in_at	string (date-time) \| null
items[].cancelled_at	string (date-time) \| null
items[].cancel_reason	string \| null
items[].reminder_sent_at	string (date-time) \| null
items[].created_at	string (date-time)
items[].version	integer

Errors

400bad-requestParameter atau format permintaan tidak valid
401unauthorizedToken tidak ada, tidak valid, kedaluwarsa, atau dicabut
402module-lockedModul tidak aktif di paket organisasi
403forbiddenScope token tidak memberi izin (forbidden), atau langganan klinik baca-saja untuk operasi tulis (read-only)
429rate-limitedBatas laju klien (rate_limit_per_min) terlampaui; coba lagi pada menit berikutnya

POST/booking/appointments

Buat booking

Isi patient_id (pasien terdaftar) atau patient (pasien baru; identitas disimpan terenkripsi dan pasien didaftarkan saat check-in). start_at harus tepat pada grid slot jadwal (GET /booking/slots): di luar jadwal, tidak sejajar slot, atau sudah lewat → 422; slot terisi, kuota penuh, atau cuti/libur → 409. notify: true mengirim konfirmasi WhatsApp bila nomor diketahui. Menerbitkan event appointment.booked.

Scopes: appointments:write
RBAC permissions: appointment.manage
Module: booking

Parameters

Parameters POST /booking/appointments
Name	In	Type	Description
X-Branch-ID	header	string (uuid)	Cabang aktif (opsional). Nilai di luar cabang klien diabaikan.

Request body `application/json`

Request body POST /booking/appointments
Name	Type	Description
patient_id	string (uuid) \| null
patient	object \| null
patient.name	string
patient.phone	string
patient.nik	string
patient.birth_date	string (date)
patient.sex	male \| female
practitioner_idrequired	string (uuid)
unit_id	string (uuid) \| null
service_id	string (uuid) \| null
start_atrequired	string (date-time)
source	admin \| whatsapp \| bpjs
payer_kind	umum \| bpjs \| insurance \| company
payer_id	string (uuid) \| null
complaint	string \| null
notify	boolean

{
  "patient_id": null,
  "patient": {
    "name": "Pasien Baru Contoh",
    "phone": "0812-0000-0003",
    "birth_date": "1999-09-09",
    "sex": "female"
  },
  "practitioner_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000d0001",
  "start_at": "2026-11-02T08:15:00+07:00",
  "source": "admin",
  "payer_kind": "umum",
  "complaint": "Demam 3 hari",
  "notify": false
}

Code examples

curlJavaScriptPython

curl -X POST "https://api.medivana.cloud/api/v1/booking/appointments" \
  -H "Authorization: Bearer $MEDIVANA_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"patient_id":null,"patient":{"name":"Pasien Baru Contoh","phone":"0812-0000-0003","birth_date":"1999-09-09","sex":"female"},"practitioner_id":"3f0c2a10-5b7e-4c1d-9a2e-0000000d0001","start_at":"2026-11-02T08:15:00+07:00","source":"admin","payer_kind":"umum","complaint":"Demam 3 hari","notify":false}'

const res = await fetch("https://api.medivana.cloud/api/v1/booking/appointments", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.MEDIVANA_TOKEN}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    patient_id: null,
    patient: {
      name: "Pasien Baru Contoh",
      phone: "0812-0000-0003",
      birth_date: "1999-09-09",
      sex: "female",
    },
    practitioner_id: "3f0c2a10-5b7e-4c1d-9a2e-0000000d0001",
    start_at: "2026-11-02T08:15:00+07:00",
    source: "admin",
    payer_kind: "umum",
    complaint: "Demam 3 hari",
    notify: false,
  }),
});
if (!res.ok) throw new Error(`HTTP ${res.status}: ${await res.text()}`);
const data = await res.json();

import os
import requests

resp = requests.post(
    "https://api.medivana.cloud/api/v1/booking/appointments",
    headers={"Authorization": f"Bearer {os.environ['MEDIVANA_TOKEN']}"},
    json={
        "patient_id": None,
        "patient": {
            "name": "Pasien Baru Contoh",
            "phone": "0812-0000-0003",
            "birth_date": "1999-09-09",
            "sex": "female",
        },
        "practitioner_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000d0001",
        "start_at": "2026-11-02T08:15:00+07:00",
        "source": "admin",
        "payer_kind": "umum",
        "complaint": "Demam 3 hari",
        "notify": False,
    },
    timeout=30,
)
resp.raise_for_status()
data = resp.json()

Responses

201Booking dibuatapplication/json

{
  "id": "3f0c2a10-5b7e-4c1d-9a2e-00000001a001",
  "code": "BK-7KQ2MZ",
  "branch_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000000b1",
  "unit_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000c0001",
  "unit_name": "Poli Umum",
  "patient_id": null,
  "patient_name": "Pasien Baru Contoh",
  "patient_phone_masked": "62812****0003",
  "patient_sex": "female",
  "patient_birth_date": "1999-09-09",
  "is_new_patient": true,
  "practitioner_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000d0001",
  "practitioner_name": "dr. Rina Contoh",
  "schedule_id": "3f0c2a10-5b7e-4c1d-9a2e-00000001a101",
  "service_id": null,
  "start_at": "2026-11-02T08:15:00+07:00",
  "end_at": "2026-11-02T08:30:00+07:00",
  "status": "booked",
  "source": "admin",
  "payer_kind": "umum",
  "payer_id": null,
  "complaint": "Demam 3 hari",
  "encounter_id": null,
  "checked_in_at": null,
  "cancelled_at": null,
  "cancel_reason": null,
  "reminder_sent_at": null,
  "created_at": "2026-10-30T14:02:00+07:00",
  "version": 1
}

Schema 201

Schema 201
Name	Type	Description
id	string (uuid)
code	string
branch_id	string (uuid)
unit_id	string (uuid)
unit_name	string
patient_id	string (uuid) \| null
patient_name	string
patient_phone_masked	string \| null
patient_sex	string \| null
patient_birth_date	string (date) \| null
is_new_patient	boolean
practitioner_id	string (uuid)
practitioner_name	string
schedule_id	string (uuid) \| null
service_id	string (uuid) \| null
start_at	string (date-time)
end_at	string (date-time)
status	booked \| checked_in \| cancelled \| no_show \| done
source	portal \| whatsapp \| admin \| bpjs
payer_kind	umum \| bpjs \| insurance \| company
payer_id	string (uuid) \| null
complaint	string \| null
encounter_id	string (uuid) \| null
checked_in_at	string (date-time) \| null
cancelled_at	string (date-time) \| null
cancel_reason	string \| null
reminder_sent_at	string (date-time) \| null
created_at	string (date-time)
version	integer

Errors

401unauthorizedToken tidak ada, tidak valid, kedaluwarsa, atau dicabut
402module-lockedModul tidak aktif di paket organisasi
403forbiddenScope token tidak memberi izin (forbidden), atau langganan klinik baca-saja untuk operasi tulis (read-only)
409conflictKonflik data atau status tidak mengizinkan aksi
422validationValidasi gagal; rincian per field di errors
429rate-limitedBatas laju klien (rate_limit_per_min) terlampaui; coba lagi pada menit berikutnya

GET/booking/appointments/{id}

Detail booking

encounter_id terisi setelah check-in.

Scopes: appointments:readappointments:writeencounters:read(any one of)
RBAC permissions: appointment.manage · appointment.read · encounter.read · queue.manage
Module: booking

Parameters

Parameters GET /booking/appointments/{id}
Name	In	Type	Description
idrequired	path	string (uuid)

Code examples

curlJavaScriptPython

curl -X GET "https://api.medivana.cloud/api/v1/booking/appointments/3f0c2a10-5b7e-4c1d-9a2e-000000000001" \
  -H "Authorization: Bearer $MEDIVANA_TOKEN"

const res = await fetch("https://api.medivana.cloud/api/v1/booking/appointments/3f0c2a10-5b7e-4c1d-9a2e-000000000001", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.MEDIVANA_TOKEN}`,
  },
});
if (!res.ok) throw new Error(`HTTP ${res.status}: ${await res.text()}`);
const data = await res.json();

import os
import requests

resp = requests.get(
    "https://api.medivana.cloud/api/v1/booking/appointments/3f0c2a10-5b7e-4c1d-9a2e-000000000001",
    headers={"Authorization": f"Bearer {os.environ['MEDIVANA_TOKEN']}"},
    timeout=30,
)
resp.raise_for_status()
data = resp.json()

Responses

200Bookingapplication/json

{
  "id": "3f0c2a10-5b7e-4c1d-9a2e-00000001a001",
  "code": "BK-7KQ2MZ",
  "branch_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000000b1",
  "unit_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000c0001",
  "unit_name": "Poli Umum",
  "patient_id": null,
  "patient_name": "Pasien Baru Contoh",
  "patient_phone_masked": "62812****0003",
  "patient_sex": "female",
  "patient_birth_date": "1999-09-09",
  "is_new_patient": true,
  "practitioner_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000d0001",
  "practitioner_name": "dr. Rina Contoh",
  "schedule_id": "3f0c2a10-5b7e-4c1d-9a2e-00000001a101",
  "service_id": null,
  "start_at": "2026-11-02T08:15:00+07:00",
  "end_at": "2026-11-02T08:30:00+07:00",
  "status": "booked",
  "source": "admin",
  "payer_kind": "umum",
  "payer_id": null,
  "complaint": "Demam 3 hari",
  "encounter_id": null,
  "checked_in_at": null,
  "cancelled_at": null,
  "cancel_reason": null,
  "reminder_sent_at": null,
  "created_at": "2026-10-30T14:02:00+07:00",
  "version": 1
}

Schema 200

Schema 200
Name	Type	Description
id	string (uuid)
code	string
branch_id	string (uuid)
unit_id	string (uuid)
unit_name	string
patient_id	string (uuid) \| null
patient_name	string
patient_phone_masked	string \| null
patient_sex	string \| null
patient_birth_date	string (date) \| null
is_new_patient	boolean
practitioner_id	string (uuid)
practitioner_name	string
schedule_id	string (uuid) \| null
service_id	string (uuid) \| null
start_at	string (date-time)
end_at	string (date-time)
status	booked \| checked_in \| cancelled \| no_show \| done
source	portal \| whatsapp \| admin \| bpjs
payer_kind	umum \| bpjs \| insurance \| company
payer_id	string (uuid) \| null
complaint	string \| null
encounter_id	string (uuid) \| null
checked_in_at	string (date-time) \| null
cancelled_at	string (date-time) \| null
cancel_reason	string \| null
reminder_sent_at	string (date-time) \| null
created_at	string (date-time)
version	integer

Errors

401unauthorizedToken tidak ada, tidak valid, kedaluwarsa, atau dicabut
402module-lockedModul tidak aktif di paket organisasi
403forbiddenScope token tidak memberi izin (forbidden), atau langganan klinik baca-saja untuk operasi tulis (read-only)
404not-foundData tidak ada, milik organisasi lain, atau di luar cakupan cabang klien
429rate-limitedBatas laju klien (rate_limit_per_min) terlampaui; coba lagi pada menit berikutnya

PATCH/booking/appointments/{id}

Ubah data booking

Hanya untuk status booked. Untuk mengganti waktu/dokter pakai reschedule.

Scopes: appointments:write
RBAC permissions: appointment.manage
Module: booking

Parameters

Parameters PATCH /booking/appointments/{id}
Name	In	Type	Description
idrequired	path	string (uuid)
If-Match	header	string	Versi dari `ETag` (mis. `"3"`). Bila tidak cocok → `412 stale`.

Request body `application/json`

Request body PATCH /booking/appointments/{id}
Name	Type	Description
patient_id	string (uuid) \| null	Hubungkan ke pasien terdaftar
complaint	string \| null
payer_kind	umum \| bpjs \| insurance \| company
payer_id	string (uuid) \| null
service_id	string (uuid) \| null

{
  "patient_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000a0001",
  "complaint": "Demam 3 hari, batuk"
}

Code examples

curlJavaScriptPython

curl -X PATCH "https://api.medivana.cloud/api/v1/booking/appointments/3f0c2a10-5b7e-4c1d-9a2e-000000000001" \
  -H "Authorization: Bearer $MEDIVANA_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"patient_id":"3f0c2a10-5b7e-4c1d-9a2e-0000000a0001","complaint":"Demam 3 hari, batuk"}'

const res = await fetch("https://api.medivana.cloud/api/v1/booking/appointments/3f0c2a10-5b7e-4c1d-9a2e-000000000001", {
  method: "PATCH",
  headers: {
    Authorization: `Bearer ${process.env.MEDIVANA_TOKEN}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    patient_id: "3f0c2a10-5b7e-4c1d-9a2e-0000000a0001",
    complaint: "Demam 3 hari, batuk",
  }),
});
if (!res.ok) throw new Error(`HTTP ${res.status}: ${await res.text()}`);
const data = await res.json();

import os
import requests

resp = requests.patch(
    "https://api.medivana.cloud/api/v1/booking/appointments/3f0c2a10-5b7e-4c1d-9a2e-000000000001",
    headers={"Authorization": f"Bearer {os.environ['MEDIVANA_TOKEN']}"},
    json={
        "patient_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000a0001",
        "complaint": "Demam 3 hari, batuk",
    },
    timeout=30,
)
resp.raise_for_status()
data = resp.json()

Responses

200Bookingapplication/json

{
  "id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "code": "string",
  "branch_id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "unit_id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "unit_name": "string",
  "patient_id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "patient_name": "string",
  "patient_phone_masked": "string",
  "patient_sex": "string",
  "patient_birth_date": "2026-11-02",
  "is_new_patient": true,
  "practitioner_id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "practitioner_name": "string",
  "schedule_id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "service_id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "start_at": "2026-11-02T08:00:00+07:00",
  "end_at": "2026-11-02T08:00:00+07:00",
  "status": "booked",
  "source": "portal",
  "payer_kind": "umum",
  "payer_id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "complaint": "string",
  "encounter_id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "checked_in_at": "2026-11-02T08:00:00+07:00",
  "cancelled_at": "2026-11-02T08:00:00+07:00",
  "cancel_reason": "string",
  "reminder_sent_at": "2026-11-02T08:00:00+07:00",
  "created_at": "2026-11-02T08:00:00+07:00",
  "version": 0
}

Schema 200

Schema 200
Name	Type	Description
id	string (uuid)
code	string
branch_id	string (uuid)
unit_id	string (uuid)
unit_name	string
patient_id	string (uuid) \| null
patient_name	string
patient_phone_masked	string \| null
patient_sex	string \| null
patient_birth_date	string (date) \| null
is_new_patient	boolean
practitioner_id	string (uuid)
practitioner_name	string
schedule_id	string (uuid) \| null
service_id	string (uuid) \| null
start_at	string (date-time)
end_at	string (date-time)
status	booked \| checked_in \| cancelled \| no_show \| done
source	portal \| whatsapp \| admin \| bpjs
payer_kind	umum \| bpjs \| insurance \| company
payer_id	string (uuid) \| null
complaint	string \| null
encounter_id	string (uuid) \| null
checked_in_at	string (date-time) \| null
cancelled_at	string (date-time) \| null
cancel_reason	string \| null
reminder_sent_at	string (date-time) \| null
created_at	string (date-time)
version	integer

Errors

401unauthorizedToken tidak ada, tidak valid, kedaluwarsa, atau dicabut
402module-lockedModul tidak aktif di paket organisasi
403forbiddenScope token tidak memberi izin (forbidden), atau langganan klinik baca-saja untuk operasi tulis (read-only)
404not-foundData tidak ada, milik organisasi lain, atau di luar cakupan cabang klien
409conflictKonflik data atau status tidak mengizinkan aksi
412staleIf-Match tidak cocok dengan versi terbaru
422validationValidasi gagal; rincian per field di errors
429rate-limitedBatas laju klien (rate_limit_per_min) terlampaui; coba lagi pada menit berikutnya

POST/booking/appointments/{id}/cancel

Batalkan booking

Menerbitkan event appointment.cancelled; notify mengirim pemberitahuan WhatsApp ke pasien.

Scopes: appointments:write
RBAC permissions: appointment.manage
Module: booking

Parameters

Parameters POST /booking/appointments/{id}/cancel
Name	In	Type	Description
idrequired	path	string (uuid)

Request body `application/json`

Request body POST /booking/appointments/{id}/cancel
Name	Type	Description
reasonrequired	string
notify	boolean

{
  "reason": "Pasien berhalangan",
  "notify": false
}

Code examples

curlJavaScriptPython

curl -X POST "https://api.medivana.cloud/api/v1/booking/appointments/3f0c2a10-5b7e-4c1d-9a2e-000000000001/cancel" \
  -H "Authorization: Bearer $MEDIVANA_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"reason":"Pasien berhalangan","notify":false}'

const res = await fetch("https://api.medivana.cloud/api/v1/booking/appointments/3f0c2a10-5b7e-4c1d-9a2e-000000000001/cancel", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.MEDIVANA_TOKEN}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    reason: "Pasien berhalangan",
    notify: false,
  }),
});
if (!res.ok) throw new Error(`HTTP ${res.status}: ${await res.text()}`);
const data = await res.json();

import os
import requests

resp = requests.post(
    "https://api.medivana.cloud/api/v1/booking/appointments/3f0c2a10-5b7e-4c1d-9a2e-000000000001/cancel",
    headers={"Authorization": f"Bearer {os.environ['MEDIVANA_TOKEN']}"},
    json={
        "reason": "Pasien berhalangan",
        "notify": False,
    },
    timeout=30,
)
resp.raise_for_status()
data = resp.json()

Responses

200Booking dibatalkanapplication/json

{
  "id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "code": "string",
  "branch_id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "unit_id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "unit_name": "string",
  "patient_id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "patient_name": "string",
  "patient_phone_masked": "string",
  "patient_sex": "string",
  "patient_birth_date": "2026-11-02",
  "is_new_patient": true,
  "practitioner_id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "practitioner_name": "string",
  "schedule_id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "service_id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "start_at": "2026-11-02T08:00:00+07:00",
  "end_at": "2026-11-02T08:00:00+07:00",
  "status": "booked",
  "source": "portal",
  "payer_kind": "umum",
  "payer_id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "complaint": "string",
  "encounter_id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "checked_in_at": "2026-11-02T08:00:00+07:00",
  "cancelled_at": "2026-11-02T08:00:00+07:00",
  "cancel_reason": "string",
  "reminder_sent_at": "2026-11-02T08:00:00+07:00",
  "created_at": "2026-11-02T08:00:00+07:00",
  "version": 0
}

Schema 200

Schema 200
Name	Type	Description
id	string (uuid)
code	string
branch_id	string (uuid)
unit_id	string (uuid)
unit_name	string
patient_id	string (uuid) \| null
patient_name	string
patient_phone_masked	string \| null
patient_sex	string \| null
patient_birth_date	string (date) \| null
is_new_patient	boolean
practitioner_id	string (uuid)
practitioner_name	string
schedule_id	string (uuid) \| null
service_id	string (uuid) \| null
start_at	string (date-time)
end_at	string (date-time)
status	booked \| checked_in \| cancelled \| no_show \| done
source	portal \| whatsapp \| admin \| bpjs
payer_kind	umum \| bpjs \| insurance \| company
payer_id	string (uuid) \| null
complaint	string \| null
encounter_id	string (uuid) \| null
checked_in_at	string (date-time) \| null
cancelled_at	string (date-time) \| null
cancel_reason	string \| null
reminder_sent_at	string (date-time) \| null
created_at	string (date-time)
version	integer

Errors

401unauthorizedToken tidak ada, tidak valid, kedaluwarsa, atau dicabut
402module-lockedModul tidak aktif di paket organisasi
403forbiddenScope token tidak memberi izin (forbidden), atau langganan klinik baca-saja untuk operasi tulis (read-only)
404not-foundData tidak ada, milik organisasi lain, atau di luar cakupan cabang klien
409conflictKonflik data atau status tidak mengizinkan aksi
422validationValidasi gagal; rincian per field di errors
429rate-limitedBatas laju klien (rate_limit_per_min) terlampaui; coba lagi pada menit berikutnya

POST/booking/appointments/{id}/check-in

Check-in pasien pada hari booking

Hanya status booked pada tanggal booking (selain itu 409). Pasien baru wajib didaftarkan dulu (POST /patients) lalu dikirim patient_id (422 bila kosong). Menerbitkan event appointment.checked_in; kunjungan dan nomor antrean dibuat otomatis (encounter_id).

Scopes: appointments:write
RBAC permissions: appointment.manage · queue.manage
Module: booking

Parameters

Parameters POST /booking/appointments/{id}/check-in
Name	In	Type	Description
idrequired	path	string (uuid)

Request body `application/json`

Request body POST /booking/appointments/{id}/check-in
Name	Type	Description
patient_id	string (uuid) \| null
payer_kind	umum \| bpjs \| insurance \| company
payer_id	string (uuid) \| null

{
  "patient_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000a0001",
  "payer_kind": "bpjs",
  "payer_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000f0002"
}

Code examples

curlJavaScriptPython

curl -X POST "https://api.medivana.cloud/api/v1/booking/appointments/3f0c2a10-5b7e-4c1d-9a2e-000000000001/check-in" \
  -H "Authorization: Bearer $MEDIVANA_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"patient_id":"3f0c2a10-5b7e-4c1d-9a2e-0000000a0001","payer_kind":"bpjs","payer_id":"3f0c2a10-5b7e-4c1d-9a2e-0000000f0002"}'

const res = await fetch("https://api.medivana.cloud/api/v1/booking/appointments/3f0c2a10-5b7e-4c1d-9a2e-000000000001/check-in", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.MEDIVANA_TOKEN}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    patient_id: "3f0c2a10-5b7e-4c1d-9a2e-0000000a0001",
    payer_kind: "bpjs",
    payer_id: "3f0c2a10-5b7e-4c1d-9a2e-0000000f0002",
  }),
});
if (!res.ok) throw new Error(`HTTP ${res.status}: ${await res.text()}`);
const data = await res.json();

import os
import requests

resp = requests.post(
    "https://api.medivana.cloud/api/v1/booking/appointments/3f0c2a10-5b7e-4c1d-9a2e-000000000001/check-in",
    headers={"Authorization": f"Bearer {os.environ['MEDIVANA_TOKEN']}"},
    json={
        "patient_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000a0001",
        "payer_kind": "bpjs",
        "payer_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000f0002",
    },
    timeout=30,
)
resp.raise_for_status()
data = resp.json()

Responses

200Booking checked_in dengan encounter_idapplication/json

{
  "id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "code": "string",
  "branch_id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "unit_id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "unit_name": "string",
  "patient_id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "patient_name": "string",
  "patient_phone_masked": "string",
  "patient_sex": "string",
  "patient_birth_date": "2026-11-02",
  "is_new_patient": true,
  "practitioner_id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "practitioner_name": "string",
  "schedule_id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "service_id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "start_at": "2026-11-02T08:00:00+07:00",
  "end_at": "2026-11-02T08:00:00+07:00",
  "status": "booked",
  "source": "portal",
  "payer_kind": "umum",
  "payer_id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "complaint": "string",
  "encounter_id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "checked_in_at": "2026-11-02T08:00:00+07:00",
  "cancelled_at": "2026-11-02T08:00:00+07:00",
  "cancel_reason": "string",
  "reminder_sent_at": "2026-11-02T08:00:00+07:00",
  "created_at": "2026-11-02T08:00:00+07:00",
  "version": 0
}

Schema 200

Schema 200
Name	Type	Description
id	string (uuid)
code	string
branch_id	string (uuid)
unit_id	string (uuid)
unit_name	string
patient_id	string (uuid) \| null
patient_name	string
patient_phone_masked	string \| null
patient_sex	string \| null
patient_birth_date	string (date) \| null
is_new_patient	boolean
practitioner_id	string (uuid)
practitioner_name	string
schedule_id	string (uuid) \| null
service_id	string (uuid) \| null
start_at	string (date-time)
end_at	string (date-time)
status	booked \| checked_in \| cancelled \| no_show \| done
source	portal \| whatsapp \| admin \| bpjs
payer_kind	umum \| bpjs \| insurance \| company
payer_id	string (uuid) \| null
complaint	string \| null
encounter_id	string (uuid) \| null
checked_in_at	string (date-time) \| null
cancelled_at	string (date-time) \| null
cancel_reason	string \| null
reminder_sent_at	string (date-time) \| null
created_at	string (date-time)
version	integer

Errors

401unauthorizedToken tidak ada, tidak valid, kedaluwarsa, atau dicabut
402module-lockedModul tidak aktif di paket organisasi
403forbiddenScope token tidak memberi izin (forbidden), atau langganan klinik baca-saja untuk operasi tulis (read-only)
404not-foundData tidak ada, milik organisasi lain, atau di luar cakupan cabang klien
409conflictKonflik data atau status tidak mengizinkan aksi
422validationValidasi gagal; rincian per field di errors
429rate-limitedBatas laju klien (rate_limit_per_min) terlampaui; coba lagi pada menit berikutnya

POST/booking/appointments/{id}/no-show

Tandai pasien tidak datang

Hanya setelah jam booking lewat dan status booked.

Scopes: appointments:write
RBAC permissions: appointment.manage · queue.manage
Module: booking

Parameters

Parameters POST /booking/appointments/{id}/no-show
Name	In	Type	Description
idrequired	path	string (uuid)

Code examples

curlJavaScriptPython

curl -X POST "https://api.medivana.cloud/api/v1/booking/appointments/3f0c2a10-5b7e-4c1d-9a2e-000000000001/no-show" \
  -H "Authorization: Bearer $MEDIVANA_TOKEN"

const res = await fetch("https://api.medivana.cloud/api/v1/booking/appointments/3f0c2a10-5b7e-4c1d-9a2e-000000000001/no-show", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.MEDIVANA_TOKEN}`,
  },
});
if (!res.ok) throw new Error(`HTTP ${res.status}: ${await res.text()}`);
const data = await res.json();

import os
import requests

resp = requests.post(
    "https://api.medivana.cloud/api/v1/booking/appointments/3f0c2a10-5b7e-4c1d-9a2e-000000000001/no-show",
    headers={"Authorization": f"Bearer {os.environ['MEDIVANA_TOKEN']}"},
    timeout=30,
)
resp.raise_for_status()
data = resp.json()

Responses

200Booking no_showapplication/json

{
  "id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "code": "string",
  "branch_id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "unit_id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "unit_name": "string",
  "patient_id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "patient_name": "string",
  "patient_phone_masked": "string",
  "patient_sex": "string",
  "patient_birth_date": "2026-11-02",
  "is_new_patient": true,
  "practitioner_id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "practitioner_name": "string",
  "schedule_id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "service_id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "start_at": "2026-11-02T08:00:00+07:00",
  "end_at": "2026-11-02T08:00:00+07:00",
  "status": "booked",
  "source": "portal",
  "payer_kind": "umum",
  "payer_id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "complaint": "string",
  "encounter_id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "checked_in_at": "2026-11-02T08:00:00+07:00",
  "cancelled_at": "2026-11-02T08:00:00+07:00",
  "cancel_reason": "string",
  "reminder_sent_at": "2026-11-02T08:00:00+07:00",
  "created_at": "2026-11-02T08:00:00+07:00",
  "version": 0
}

Schema 200

Schema 200
Name	Type	Description
id	string (uuid)
code	string
branch_id	string (uuid)
unit_id	string (uuid)
unit_name	string
patient_id	string (uuid) \| null
patient_name	string
patient_phone_masked	string \| null
patient_sex	string \| null
patient_birth_date	string (date) \| null
is_new_patient	boolean
practitioner_id	string (uuid)
practitioner_name	string
schedule_id	string (uuid) \| null
service_id	string (uuid) \| null
start_at	string (date-time)
end_at	string (date-time)
status	booked \| checked_in \| cancelled \| no_show \| done
source	portal \| whatsapp \| admin \| bpjs
payer_kind	umum \| bpjs \| insurance \| company
payer_id	string (uuid) \| null
complaint	string \| null
encounter_id	string (uuid) \| null
checked_in_at	string (date-time) \| null
cancelled_at	string (date-time) \| null
cancel_reason	string \| null
reminder_sent_at	string (date-time) \| null
created_at	string (date-time)
version	integer

Errors

401unauthorizedToken tidak ada, tidak valid, kedaluwarsa, atau dicabut
402module-lockedModul tidak aktif di paket organisasi
403forbiddenScope token tidak memberi izin (forbidden), atau langganan klinik baca-saja untuk operasi tulis (read-only)
404not-foundData tidak ada, milik organisasi lain, atau di luar cakupan cabang klien
409conflictKonflik data atau status tidak mengizinkan aksi
429rate-limitedBatas laju klien (rate_limit_per_min) terlampaui; coba lagi pada menit berikutnya

POST/booking/appointments/{id}/reschedule

Jadwal ulang booking

Aturan slot sama dengan pembuatan booking. Menerbitkan appointment.booked dengan rescheduled: true.

Scopes: appointments:write
RBAC permissions: appointment.manage
Module: booking

Parameters

Parameters POST /booking/appointments/{id}/reschedule
Name	In	Type	Description
idrequired	path	string (uuid)

Request body `application/json`

Request body POST /booking/appointments/{id}/reschedule
Name	Type	Description
start_atrequired	string (date-time)
practitioner_id	string (uuid) \| null
unit_id	string (uuid) \| null

{
  "start_at": "2026-11-03T09:00:00+07:00"
}

Code examples

curlJavaScriptPython

curl -X POST "https://api.medivana.cloud/api/v1/booking/appointments/3f0c2a10-5b7e-4c1d-9a2e-000000000001/reschedule" \
  -H "Authorization: Bearer $MEDIVANA_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"start_at":"2026-11-03T09:00:00+07:00"}'

const res = await fetch("https://api.medivana.cloud/api/v1/booking/appointments/3f0c2a10-5b7e-4c1d-9a2e-000000000001/reschedule", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.MEDIVANA_TOKEN}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    start_at: "2026-11-03T09:00:00+07:00",
  }),
});
if (!res.ok) throw new Error(`HTTP ${res.status}: ${await res.text()}`);
const data = await res.json();

import os
import requests

resp = requests.post(
    "https://api.medivana.cloud/api/v1/booking/appointments/3f0c2a10-5b7e-4c1d-9a2e-000000000001/reschedule",
    headers={"Authorization": f"Bearer {os.environ['MEDIVANA_TOKEN']}"},
    json={
        "start_at": "2026-11-03T09:00:00+07:00",
    },
    timeout=30,
)
resp.raise_for_status()
data = resp.json()

Responses

200Booking dengan waktu baruapplication/json

{
  "id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "code": "string",
  "branch_id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "unit_id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "unit_name": "string",
  "patient_id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "patient_name": "string",
  "patient_phone_masked": "string",
  "patient_sex": "string",
  "patient_birth_date": "2026-11-02",
  "is_new_patient": true,
  "practitioner_id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "practitioner_name": "string",
  "schedule_id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "service_id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "start_at": "2026-11-02T08:00:00+07:00",
  "end_at": "2026-11-02T08:00:00+07:00",
  "status": "booked",
  "source": "portal",
  "payer_kind": "umum",
  "payer_id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "complaint": "string",
  "encounter_id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "checked_in_at": "2026-11-02T08:00:00+07:00",
  "cancelled_at": "2026-11-02T08:00:00+07:00",
  "cancel_reason": "string",
  "reminder_sent_at": "2026-11-02T08:00:00+07:00",
  "created_at": "2026-11-02T08:00:00+07:00",
  "version": 0
}

Schema 200

Schema 200
Name	Type	Description
id	string (uuid)
code	string
branch_id	string (uuid)
unit_id	string (uuid)
unit_name	string
patient_id	string (uuid) \| null
patient_name	string
patient_phone_masked	string \| null
patient_sex	string \| null
patient_birth_date	string (date) \| null
is_new_patient	boolean
practitioner_id	string (uuid)
practitioner_name	string
schedule_id	string (uuid) \| null
service_id	string (uuid) \| null
start_at	string (date-time)
end_at	string (date-time)
status	booked \| checked_in \| cancelled \| no_show \| done
source	portal \| whatsapp \| admin \| bpjs
payer_kind	umum \| bpjs \| insurance \| company
payer_id	string (uuid) \| null
complaint	string \| null
encounter_id	string (uuid) \| null
checked_in_at	string (date-time) \| null
cancelled_at	string (date-time) \| null
cancel_reason	string \| null
reminder_sent_at	string (date-time) \| null
created_at	string (date-time)
version	integer

Errors

401unauthorizedToken tidak ada, tidak valid, kedaluwarsa, atau dicabut
402module-lockedModul tidak aktif di paket organisasi
403forbiddenScope token tidak memberi izin (forbidden), atau langganan klinik baca-saja untuk operasi tulis (read-only)
404not-foundData tidak ada, milik organisasi lain, atau di luar cakupan cabang klien
409conflictKonflik data atau status tidak mengizinkan aksi
422validationValidasi gagal; rincian per field di errors
429rate-limitedBatas laju klien (rate_limit_per_min) terlampaui; coba lagi pada menit berikutnya

GET/booking/slots

Slot praktik dan ketersediaannya

Dari jadwal mingguan dikurangi cuti/libur, booking aktif, kuota sesi, dan waktu lewat. Pakai date atau rentang from/to (maks 31 hari). reason bila tidak tersedia: booked, quota_full, leave, closed, past.

Scopes: appointments:readappointments:writeencounters:read(any one of)
RBAC permissions: appointment.manage · appointment.read · encounter.read · queue.manage
Module: booking

Parameters

Parameters GET /booking/slots
Name	In	Type	Description
practitioner_id	query	string (uuid)
branch_id	query	string (uuid)
unit_id	query	string (uuid)
date	query	string (date)
from	query	string (date)
to	query	string (date)
online_only	query	boolean	Hanya jadwal yang boleh dipesan daring
available_only	query	boolean

Code examples

curlJavaScriptPython

curl -X GET "https://api.medivana.cloud/api/v1/booking/slots" \
  -H "Authorization: Bearer $MEDIVANA_TOKEN"

const res = await fetch("https://api.medivana.cloud/api/v1/booking/slots", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.MEDIVANA_TOKEN}`,
  },
});
if (!res.ok) throw new Error(`HTTP ${res.status}: ${await res.text()}`);
const data = await res.json();

import os
import requests

resp = requests.get(
    "https://api.medivana.cloud/api/v1/booking/slots",
    headers={"Authorization": f"Bearer {os.environ['MEDIVANA_TOKEN']}"},
    timeout=30,
)
resp.raise_for_status()
data = resp.json()

Responses

200Slotapplication/json

{
  "items": [
    {
      "schedule_id": "3f0c2a10-5b7e-4c1d-9a2e-00000001a101",
      "practitioner_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000d0001",
      "branch_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000000b1",
      "unit_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000c0001",
      "date": "2026-11-02",
      "start_at": "2026-11-02T08:00:00+07:00",
      "end_at": "2026-11-02T08:15:00+07:00",
      "time": "08:00",
      "available": false,
      "reason": "booked",
      "remaining_quota": 9
    },
    {
      "schedule_id": "3f0c2a10-5b7e-4c1d-9a2e-00000001a101",
      "practitioner_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000d0001",
      "branch_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000000b1",
      "unit_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000c0001",
      "date": "2026-11-02",
      "start_at": "2026-11-02T08:15:00+07:00",
      "end_at": "2026-11-02T08:30:00+07:00",
      "time": "08:15",
      "available": true,
      "reason": null,
      "remaining_quota": 9
    }
  ]
}

Schema 200

Schema 200
Name	Type	Description
itemsrequired	array<object>
items[].schedule_id	string (uuid)
items[].practitioner_id	string (uuid)
items[].branch_id	string (uuid)
items[].unit_id	string (uuid)
items[].date	string (date)
items[].start_at	string (date-time)
items[].end_at	string (date-time)
items[].time	string
items[].available	boolean
items[].reason	booked \| quota_full \| leave \| closed \| past \| null
items[].remaining_quota	integer \| null

Errors

401unauthorizedToken tidak ada, tidak valid, kedaluwarsa, atau dicabut
402module-lockedModul tidak aktif di paket organisasi
403forbiddenScope token tidak memberi izin (forbidden), atau langganan klinik baca-saja untuk operasi tulis (read-only)
422validationValidasi gagal; rincian per field di errors
429rate-limitedBatas laju klien (rate_limit_per_min) terlampaui; coba lagi pada menit berikutnya

GET/booking/schedules

Jadwal praktik mingguan

weekday ISO (1 = Senin … 7 = Minggu); jam HH:MM WIB.

Scopes: appointments:readappointments:writeencounters:read(any one of)
RBAC permissions: appointment.manage · appointment.read · encounter.read · queue.manage
Module: booking

Parameters

Parameters GET /booking/schedules
Name	In	Type
practitioner_id	query	string (uuid)
branch_id	query	string (uuid)
unit_id	query	string (uuid)
include_inactive	query	boolean

Code examples

curlJavaScriptPython

curl -X GET "https://api.medivana.cloud/api/v1/booking/schedules" \
  -H "Authorization: Bearer $MEDIVANA_TOKEN"

const res = await fetch("https://api.medivana.cloud/api/v1/booking/schedules", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.MEDIVANA_TOKEN}`,
  },
});
if (!res.ok) throw new Error(`HTTP ${res.status}: ${await res.text()}`);
const data = await res.json();

import os
import requests

resp = requests.get(
    "https://api.medivana.cloud/api/v1/booking/schedules",
    headers={"Authorization": f"Bearer {os.environ['MEDIVANA_TOKEN']}"},
    timeout=30,
)
resp.raise_for_status()
data = resp.json()

Responses

200Jadwalapplication/json

{
  "items": [
    {
      "id": "3f0c2a10-5b7e-4c1d-9a2e-00000001a101",
      "branch_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000000b1",
      "unit_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000c0001",
      "unit_name": "Poli Umum",
      "practitioner_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000d0001",
      "practitioner_name": "dr. Rina Contoh",
      "weekday": 1,
      "weekday_label": "Senin",
      "start_time": "08:00",
      "end_time": "12:00",
      "slot_minutes": 15,
      "quota": 12,
      "slot_count": 16,
      "allow_online": true,
      "valid_from": "2026-11-01",
      "valid_until": null,
      "is_active": true,
      "note": "Poli umum pagi",
      "version": 1
    }
  ]
}

Schema 200

Schema 200
Name	Type	Description
itemsrequired	array<object>
items[].practitioner_id	string (uuid)
items[].branch_id	string (uuid) \| null
items[].unit_id	string (uuid)
items[].weekday	integer
items[].start_time	string
items[].end_time	string
items[].slot_minutes	integer
items[].quota	integer \| null
items[].allow_online	boolean
items[].valid_from	string (date) \| null
items[].valid_until	string (date) \| null
items[].note	string \| null
items[].id	string (uuid)
items[].unit_name	string
items[].practitioner_name	string
items[].weekday_label	string
items[].slot_count	integer
items[].is_active	boolean
items[].version	integer

Errors

401unauthorizedToken tidak ada, tidak valid, kedaluwarsa, atau dicabut
402module-lockedModul tidak aktif di paket organisasi
403forbiddenScope token tidak memberi izin (forbidden), atau langganan klinik baca-saja untuk operasi tulis (read-only)
429rate-limitedBatas laju klien (rate_limit_per_min) terlampaui; coba lagi pada menit berikutnya

POST/booking/schedules

Buat jadwal praktik

branch_id default cabang aktif; unit harus di cabang itu dan dokter bertugas di cabang itu. Jadwal bertumpuk untuk dokter yang sama di hari yang sama → 409. quota ≤ jumlah slot; allow_online: false menyembunyikan jadwal dari portal pasien.

Scopes: appointments:write
RBAC permissions: appointment.manage
Module: booking

Parameters

Parameters POST /booking/schedules
Name	In	Type	Description
X-Branch-ID	header	string (uuid)	Cabang aktif (opsional). Nilai di luar cabang klien diabaikan.

Request body `application/json`

Request body POST /booking/schedules
Name	Type	Description
practitioner_id	string (uuid)
branch_id	string (uuid) \| null
unit_id	string (uuid)
weekday	integer
start_time	string
end_time	string
slot_minutes	integer
quota	integer \| null
allow_online	boolean
valid_from	string (date) \| null
valid_until	string (date) \| null
note	string \| null

{
  "practitioner_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000d0001",
  "branch_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000000b1",
  "unit_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000c0001",
  "weekday": 1,
  "start_time": "08:00",
  "end_time": "12:00",
  "slot_minutes": 15,
  "quota": 12,
  "allow_online": true,
  "valid_from": "2026-11-01",
  "valid_until": null,
  "note": "Poli umum pagi"
}

Code examples

curlJavaScriptPython

curl -X POST "https://api.medivana.cloud/api/v1/booking/schedules" \
  -H "Authorization: Bearer $MEDIVANA_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"practitioner_id":"3f0c2a10-5b7e-4c1d-9a2e-0000000d0001","branch_id":"3f0c2a10-5b7e-4c1d-9a2e-0000000000b1","unit_id":"3f0c2a10-5b7e-4c1d-9a2e-0000000c0001","weekday":1,"start_time":"08:00","end_time":"12:00","slot_minutes":15,"quota":12,"allow_online":true,"valid_from":"2026-11-01","valid_until":null,"note":"Poli umum pagi"}'

const res = await fetch("https://api.medivana.cloud/api/v1/booking/schedules", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.MEDIVANA_TOKEN}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    practitioner_id: "3f0c2a10-5b7e-4c1d-9a2e-0000000d0001",
    branch_id: "3f0c2a10-5b7e-4c1d-9a2e-0000000000b1",
    unit_id: "3f0c2a10-5b7e-4c1d-9a2e-0000000c0001",
    weekday: 1,
    start_time: "08:00",
    end_time: "12:00",
    slot_minutes: 15,
    quota: 12,
    allow_online: true,
    valid_from: "2026-11-01",
    valid_until: null,
    note: "Poli umum pagi",
  }),
});
if (!res.ok) throw new Error(`HTTP ${res.status}: ${await res.text()}`);
const data = await res.json();

import os
import requests

resp = requests.post(
    "https://api.medivana.cloud/api/v1/booking/schedules",
    headers={"Authorization": f"Bearer {os.environ['MEDIVANA_TOKEN']}"},
    json={
        "practitioner_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000d0001",
        "branch_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000000b1",
        "unit_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000c0001",
        "weekday": 1,
        "start_time": "08:00",
        "end_time": "12:00",
        "slot_minutes": 15,
        "quota": 12,
        "allow_online": True,
        "valid_from": "2026-11-01",
        "valid_until": None,
        "note": "Poli umum pagi",
    },
    timeout=30,
)
resp.raise_for_status()
data = resp.json()

Responses

201Jadwal dibuatapplication/json

{
  "id": "3f0c2a10-5b7e-4c1d-9a2e-00000001a101",
  "branch_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000000b1",
  "unit_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000c0001",
  "unit_name": "Poli Umum",
  "practitioner_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000d0001",
  "practitioner_name": "dr. Rina Contoh",
  "weekday": 1,
  "weekday_label": "Senin",
  "start_time": "08:00",
  "end_time": "12:00",
  "slot_minutes": 15,
  "quota": 12,
  "slot_count": 16,
  "allow_online": true,
  "valid_from": "2026-11-01",
  "valid_until": null,
  "is_active": true,
  "note": "Poli umum pagi",
  "version": 1
}

Schema 201

Schema 201
Name	Type	Description
practitioner_id	string (uuid)
branch_id	string (uuid) \| null
unit_id	string (uuid)
weekday	integer
start_time	string
end_time	string
slot_minutes	integer
quota	integer \| null
allow_online	boolean
valid_from	string (date) \| null
valid_until	string (date) \| null
note	string \| null
id	string (uuid)
unit_name	string
practitioner_name	string
weekday_label	string
slot_count	integer
is_active	boolean
version	integer

Errors

401unauthorizedToken tidak ada, tidak valid, kedaluwarsa, atau dicabut
402module-lockedModul tidak aktif di paket organisasi
403forbiddenScope token tidak memberi izin (forbidden), atau langganan klinik baca-saja untuk operasi tulis (read-only)
409conflictKonflik data atau status tidak mengizinkan aksi
422validationValidasi gagal; rincian per field di errors
429rate-limitedBatas laju klien (rate_limit_per_min) terlampaui; coba lagi pada menit berikutnya

PATCH/booking/schedules/{id}

Ubah jadwal praktik

Parsial. quota: 0 menghapus kuota; valid_from/valid_until: "" mengosongkan masa berlaku.

Scopes: appointments:write
RBAC permissions: appointment.manage
Module: booking

Parameters

Parameters PATCH /booking/schedules/{id}
Name	In	Type	Description
idrequired	path	string (uuid)
If-Match	header	string	Versi dari `ETag` (mis. `"3"`). Bila tidak cocok → `412 stale`.

Request body `application/json`

Request body PATCH /booking/schedules/{id}
Name	Type	Description
practitioner_id	string (uuid)
branch_id	string (uuid) \| null
unit_id	string (uuid)
weekday	integer
start_time	string
end_time	string
slot_minutes	integer
quota	integer \| null
allow_online	boolean
valid_from	string (date) \| null
valid_until	string (date) \| null
note	string \| null

{
  "end_time": "13:00",
  "quota": 16
}

Code examples

curlJavaScriptPython

curl -X PATCH "https://api.medivana.cloud/api/v1/booking/schedules/3f0c2a10-5b7e-4c1d-9a2e-000000000001" \
  -H "Authorization: Bearer $MEDIVANA_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"end_time":"13:00","quota":16}'

const res = await fetch("https://api.medivana.cloud/api/v1/booking/schedules/3f0c2a10-5b7e-4c1d-9a2e-000000000001", {
  method: "PATCH",
  headers: {
    Authorization: `Bearer ${process.env.MEDIVANA_TOKEN}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    end_time: "13:00",
    quota: 16,
  }),
});
if (!res.ok) throw new Error(`HTTP ${res.status}: ${await res.text()}`);
const data = await res.json();

import os
import requests

resp = requests.patch(
    "https://api.medivana.cloud/api/v1/booking/schedules/3f0c2a10-5b7e-4c1d-9a2e-000000000001",
    headers={"Authorization": f"Bearer {os.environ['MEDIVANA_TOKEN']}"},
    json={
        "end_time": "13:00",
        "quota": 16,
    },
    timeout=30,
)
resp.raise_for_status()
data = resp.json()

Responses

200Jadwalapplication/json

{
  "practitioner_id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "branch_id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "unit_id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "weekday": 0,
  "start_time": "08:00",
  "end_time": "12:00",
  "slot_minutes": 0,
  "quota": 0,
  "allow_online": true,
  "valid_from": "2026-11-02",
  "valid_until": "2026-11-02",
  "note": "string",
  "id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "unit_name": "string",
  "practitioner_name": "string",
  "weekday_label": "string",
  "slot_count": 0,
  "is_active": true,
  "version": 0
}

Schema 200

Schema 200
Name	Type	Description
practitioner_id	string (uuid)
branch_id	string (uuid) \| null
unit_id	string (uuid)
weekday	integer
start_time	string
end_time	string
slot_minutes	integer
quota	integer \| null
allow_online	boolean
valid_from	string (date) \| null
valid_until	string (date) \| null
note	string \| null
id	string (uuid)
unit_name	string
practitioner_name	string
weekday_label	string
slot_count	integer
is_active	boolean
version	integer

Errors

401unauthorizedToken tidak ada, tidak valid, kedaluwarsa, atau dicabut
402module-lockedModul tidak aktif di paket organisasi
403forbiddenScope token tidak memberi izin (forbidden), atau langganan klinik baca-saja untuk operasi tulis (read-only)
404not-foundData tidak ada, milik organisasi lain, atau di luar cakupan cabang klien
409conflictKonflik data atau status tidak mengizinkan aksi
412staleIf-Match tidak cocok dengan versi terbaru
422validationValidasi gagal; rincian per field di errors
429rate-limitedBatas laju klien (rate_limit_per_min) terlampaui; coba lagi pada menit berikutnya

DELETE/booking/schedules/{id}

Nonaktifkan jadwal praktik

Booking yang sudah ada tidak dibatalkan.

Scopes: appointments:write
RBAC permissions: appointment.manage
Module: booking

Parameters

Parameters DELETE /booking/schedules/{id}
Name	In	Type	Description
idrequired	path	string (uuid)

Code examples

curlJavaScriptPython

curl -X DELETE "https://api.medivana.cloud/api/v1/booking/schedules/3f0c2a10-5b7e-4c1d-9a2e-000000000001" \
  -H "Authorization: Bearer $MEDIVANA_TOKEN"

const res = await fetch("https://api.medivana.cloud/api/v1/booking/schedules/3f0c2a10-5b7e-4c1d-9a2e-000000000001", {
  method: "DELETE",
  headers: {
    Authorization: `Bearer ${process.env.MEDIVANA_TOKEN}`,
  },
});
if (!res.ok) throw new Error(`HTTP ${res.status}: ${await res.text()}`);

import os
import requests

resp = requests.delete(
    "https://api.medivana.cloud/api/v1/booking/schedules/3f0c2a10-5b7e-4c1d-9a2e-000000000001",
    headers={"Authorization": f"Bearer {os.environ['MEDIVANA_TOKEN']}"},
    timeout=30,
)
resp.raise_for_status()

Responses

204Jadwal nonaktif

Errors

401unauthorizedToken tidak ada, tidak valid, kedaluwarsa, atau dicabut
402module-lockedModul tidak aktif di paket organisasi
403forbiddenScope token tidak memberi izin (forbidden), atau langganan klinik baca-saja untuk operasi tulis (read-only)
404not-foundData tidak ada, milik organisasi lain, atau di luar cakupan cabang klien
429rate-limitedBatas laju klien (rate_limit_per_min) terlampaui; coba lagi pada menit berikutnya

GET/booking/exceptions

Cuti dokter dan libur cabang

Scopes: appointments:readappointments:writeencounters:read(any one of)
RBAC permissions: appointment.manage · appointment.read · encounter.read · queue.manage
Module: booking

Parameters

Parameters GET /booking/exceptions
Name	In	Type
from	query	string (date)
to	query	string (date)
practitioner_id	query	string (uuid)

Code examples

curlJavaScriptPython

curl -X GET "https://api.medivana.cloud/api/v1/booking/exceptions" \
  -H "Authorization: Bearer $MEDIVANA_TOKEN"

const res = await fetch("https://api.medivana.cloud/api/v1/booking/exceptions", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.MEDIVANA_TOKEN}`,
  },
});
if (!res.ok) throw new Error(`HTTP ${res.status}: ${await res.text()}`);
const data = await res.json();

import os
import requests

resp = requests.get(
    "https://api.medivana.cloud/api/v1/booking/exceptions",
    headers={"Authorization": f"Bearer {os.environ['MEDIVANA_TOKEN']}"},
    timeout=30,
)
resp.raise_for_status()
data = resp.json()

Responses

200Pengecualian jadwalapplication/json

{
  "items": [
    {
      "id": "3f0c2a10-5b7e-4c1d-9a2e-00000001a201",
      "branch_id": null,
      "practitioner_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000d0001",
      "date_from": "2026-11-10",
      "date_to": "2026-11-12",
      "start_time": null,
      "end_time": null,
      "kind": "leave",
      "reason": "Seminar"
    }
  ]
}

Schema 200

Schema 200
Name	Type	Description
itemsrequired	array<object>
items[].id	string (uuid)
items[].branch_id	string (uuid) \| null
items[].practitioner_id	string (uuid) \| null
items[].date_from	string (date)
items[].date_to	string (date)
items[].start_time	string \| null
items[].end_time	string \| null
items[].kind	leave \| closed \| other
items[].reason	string \| null

Errors

401unauthorizedToken tidak ada, tidak valid, kedaluwarsa, atau dicabut
402module-lockedModul tidak aktif di paket organisasi
403forbiddenScope token tidak memberi izin (forbidden), atau langganan klinik baca-saja untuk operasi tulis (read-only)
429rate-limitedBatas laju klien (rate_limit_per_min) terlampaui; coba lagi pada menit berikutnya

POST/booking/exceptions

Catat cuti dokter atau libur cabang

Isi practitioner_id (cuti, kind: leave) atau branch_id saja (libur cabang, kind: closed). Jam opsional (sebagian hari). Booking aktif yang terdampak dikembalikan agar pasien dihubungi; tidak dibatalkan otomatis.

Scopes: appointments:write
RBAC permissions: appointment.manage
Module: booking

Request body `application/json`

Request body POST /booking/exceptions
Name	Type	Description
practitioner_id	string (uuid) \| null
branch_id	string (uuid) \| null
date_fromrequired	string (date)
date_torequired	string (date)
start_time	string \| null
end_time	string \| null
kindrequired	leave \| closed \| other
reason	string \| null

{
  "practitioner_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000d0001",
  "branch_id": null,
  "date_from": "2026-11-10",
  "date_to": "2026-11-12",
  "kind": "leave",
  "reason": "Seminar"
}

Code examples

curlJavaScriptPython

curl -X POST "https://api.medivana.cloud/api/v1/booking/exceptions" \
  -H "Authorization: Bearer $MEDIVANA_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"practitioner_id":"3f0c2a10-5b7e-4c1d-9a2e-0000000d0001","branch_id":null,"date_from":"2026-11-10","date_to":"2026-11-12","kind":"leave","reason":"Seminar"}'

const res = await fetch("https://api.medivana.cloud/api/v1/booking/exceptions", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.MEDIVANA_TOKEN}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    practitioner_id: "3f0c2a10-5b7e-4c1d-9a2e-0000000d0001",
    branch_id: null,
    date_from: "2026-11-10",
    date_to: "2026-11-12",
    kind: "leave",
    reason: "Seminar",
  }),
});
if (!res.ok) throw new Error(`HTTP ${res.status}: ${await res.text()}`);
const data = await res.json();

import os
import requests

resp = requests.post(
    "https://api.medivana.cloud/api/v1/booking/exceptions",
    headers={"Authorization": f"Bearer {os.environ['MEDIVANA_TOKEN']}"},
    json={
        "practitioner_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000d0001",
        "branch_id": None,
        "date_from": "2026-11-10",
        "date_to": "2026-11-12",
        "kind": "leave",
        "reason": "Seminar",
    },
    timeout=30,
)
resp.raise_for_status()
data = resp.json()

Responses

201Pengecualian dibuatapplication/json

{
  "exception": {
    "id": "3f0c2a10-5b7e-4c1d-9a2e-00000001a201",
    "branch_id": null,
    "practitioner_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000d0001",
    "date_from": "2026-11-10",
    "date_to": "2026-11-12",
    "start_time": null,
    "end_time": null,
    "kind": "leave",
    "reason": "Seminar"
  },
  "affected_appointments": []
}

Schema 201

Schema 201
Name	Type	Description
exception	object
exception.id	string (uuid)
exception.branch_id	string (uuid) \| null
exception.practitioner_id	string (uuid) \| null
exception.date_from	string (date)
exception.date_to	string (date)
exception.start_time	string \| null
exception.end_time	string \| null
exception.kind	leave \| closed \| other
exception.reason	string \| null
affected_appointments	array<object>
affected_appointments[].id	string (uuid)
affected_appointments[].code	string
affected_appointments[].branch_id	string (uuid)
affected_appointments[].unit_id	string (uuid)
affected_appointments[].unit_name	string
affected_appointments[].patient_id	string (uuid) \| null
affected_appointments[].patient_name	string
affected_appointments[].patient_phone_masked	string \| null
affected_appointments[].patient_sex	string \| null
affected_appointments[].patient_birth_date	string (date) \| null
affected_appointments[].is_new_patient	boolean
affected_appointments[].practitioner_id	string (uuid)
affected_appointments[].practitioner_name	string
affected_appointments[].schedule_id	string (uuid) \| null
affected_appointments[].service_id	string (uuid) \| null
affected_appointments[].start_at	string (date-time)
affected_appointments[].end_at	string (date-time)
affected_appointments[].status	booked \| checked_in \| cancelled \| no_show \| done
affected_appointments[].source	portal \| whatsapp \| admin \| bpjs
affected_appointments[].payer_kind	umum \| bpjs \| insurance \| company
affected_appointments[].payer_id	string (uuid) \| null
affected_appointments[].complaint	string \| null
affected_appointments[].encounter_id	string (uuid) \| null
affected_appointments[].checked_in_at	string (date-time) \| null
affected_appointments[].cancelled_at	string (date-time) \| null
affected_appointments[].cancel_reason	string \| null
affected_appointments[].reminder_sent_at	string (date-time) \| null
affected_appointments[].created_at	string (date-time)
affected_appointments[].version	integer

Errors

401unauthorizedToken tidak ada, tidak valid, kedaluwarsa, atau dicabut
402module-lockedModul tidak aktif di paket organisasi
403forbiddenScope token tidak memberi izin (forbidden), atau langganan klinik baca-saja untuk operasi tulis (read-only)
422validationValidasi gagal; rincian per field di errors
429rate-limitedBatas laju klien (rate_limit_per_min) terlampaui; coba lagi pada menit berikutnya

DELETE/booking/exceptions/{id}

Hapus cuti/libur

Scopes: appointments:write
RBAC permissions: appointment.manage
Module: booking

Parameters

Parameters DELETE /booking/exceptions/{id}
Name	In	Type	Description
idrequired	path	string (uuid)

Code examples

curlJavaScriptPython

curl -X DELETE "https://api.medivana.cloud/api/v1/booking/exceptions/3f0c2a10-5b7e-4c1d-9a2e-000000000001" \
  -H "Authorization: Bearer $MEDIVANA_TOKEN"

const res = await fetch("https://api.medivana.cloud/api/v1/booking/exceptions/3f0c2a10-5b7e-4c1d-9a2e-000000000001", {
  method: "DELETE",
  headers: {
    Authorization: `Bearer ${process.env.MEDIVANA_TOKEN}`,
  },
});
if (!res.ok) throw new Error(`HTTP ${res.status}: ${await res.text()}`);

import os
import requests

resp = requests.delete(
    "https://api.medivana.cloud/api/v1/booking/exceptions/3f0c2a10-5b7e-4c1d-9a2e-000000000001",
    headers={"Authorization": f"Bearer {os.environ['MEDIVANA_TOKEN']}"},
    timeout=30,
)
resp.raise_for_status()

Responses

204Dihapus

Errors

401unauthorizedToken tidak ada, tidak valid, kedaluwarsa, atau dicabut
402module-lockedModul tidak aktif di paket organisasi
403forbiddenScope token tidak memberi izin (forbidden), atau langganan klinik baca-saja untuk operasi tulis (read-only)
404not-foundData tidak ada, milik organisasi lain, atau di luar cakupan cabang klien
429rate-limitedBatas laju klien (rate_limit_per_min) terlampaui; coba lagi pada menit berikutnya

Booking

Daftar booking

Parameters

Code examples

Responses

Errors

Buat booking

Parameters

Request body application/json

Code examples

Responses

Errors

Detail booking

Parameters

Code examples

Responses

Errors

Ubah data booking

Parameters

Request body application/json

Code examples

Responses

Errors

Batalkan booking

Parameters

Request body application/json

Code examples

Responses

Errors

Check-in pasien pada hari booking

Parameters

Request body application/json

Code examples

Responses

Errors

Tandai pasien tidak datang

Parameters

Code examples

Responses

Errors

Jadwal ulang booking

Parameters

Request body application/json

Code examples

Responses

Errors

Slot praktik dan ketersediaannya

Parameters

Code examples

Responses

Errors

Jadwal praktik mingguan

Parameters

Code examples

Responses

Errors

Buat jadwal praktik

Parameters

Request body application/json

Code examples

Responses

Errors

Ubah jadwal praktik

Parameters

Request body application/json

Code examples

Responses

Errors

Nonaktifkan jadwal praktik

Parameters

Code examples

Responses

Errors

Cuti dokter dan libur cabang

Parameters

Code examples

Responses

Errors

Catat cuti dokter atau libur cabang

Request body application/json

Request body `application/json`

Request body `application/json`

Request body `application/json`

Request body `application/json`

Request body `application/json`

Request body `application/json`

Request body `application/json`

Request body `application/json`