Referensi API
Referensi API publik
Semua operasi yang bisa dipanggil klien API, dihasilkan dari spesifikasi OpenAPI yang diuji terhadap router Medivana.
OpenAPI 3.1 · versi 1.1.0 · 127 operasi · 30 event webhook
Basis URLhttps://api.medivana.cloud/api/v1
Semua operasi
OAuth2
2 operasiPenerbitan dan pencabutan access token (client credentials). Tanpa token; autentikasi klien.
| POST | /oauth/token | Terbitkan access token (client credentials) |
|---|---|---|
| POST | /oauth/revoke | Cabut access token (RFC 7009) |
Konteks
6 operasiIdentitas token, organisasi, cabang, unit layanan, dan tenaga kesehatan untuk mengisi referensi ID.
| GET | /me | Identitas token dan izin efektif |
|---|---|---|
| GET | /me/entitlements | Paket, modul aktif, dan batas paket organisasi |
| GET | /org | Profil organisasi (klinik) |
| GET | /branches | Daftar cabang |
| GET | /units | Daftar unit layanan (poli, farmasi, laboratorium, …) |
| GET | /practitioners | Daftar tenaga kesehatan aktif |
Terminologi
2 operasiKamus kode global ICD-10, ICD-9-CM, LOINC, KFA, dan SNOMED (modul frontoffice atau rme).
| GET | /terminology/search | Cari kode terminologi |
|---|---|---|
| GET | /terminology/{system}/{code} | Lookup satu kode terminologi |
Pasien
16 operasiMaster pasien, consent, alergi, dokumen pasien, dan lookup identitas (modul frontoffice).
| GET | /patients | Cari atau daftar pasien |
|---|---|---|
| POST | /patients | Daftarkan pasien baru |
| GET | /patients/duplicate-check | Periksa kemungkinan pasien ganda |
| POST | /patients/lookup-nik | Cari NIK di data lokal lalu SATUSEHAT |
| GET | /patients/mrn-settings | Format nomor rekam medis |
| GET | /patients/{id} | Detail pasien |
| PATCH | /patients/{id} | Ubah data pasien |
| POST | /patients/{id}/satusehat-lookup | Lookup ulang IHS number SATUSEHAT dari NIK tersimpan |
| GET | /patients/{id}/merges | Riwayat penggabungan pasien |
| GET | /patients/{id}/consents | Consent pasien (terkini per jenis dan riwayat) |
| GET | /patients/{id}/allergies | Alergi pasien |
| GET | /patients/{id}/history-summary | Riwayat klinis ringkas pasien |
| GET | /patients/{id}/documents | Dokumen pasien (termasuk dokumen kunjungan) |
| POST | /patients/{id}/documents | Unggah dokumen pasien |
| GET | /clinical-documents/{id}/download | Unduh isi dokumen klinis |
| DELETE | /clinical-documents/{id} | Hapus dokumen klinis (soft delete) |
Kunjungan
13 operasiPendaftaran kunjungan dan isi rekam medis elektronik rawat jalan (modul frontoffice/rme).
| GET | /registration/payers | Penjamin aktif untuk pendaftaran kunjungan |
|---|---|---|
| GET | /encounters | Daftar kunjungan |
| POST | /encounters | Daftarkan kunjungan dan terbitkan nomor antrean |
| GET | /encounters/{id} | Detail kunjungan lengkap (RME) |
| POST | /encounters/{id}/cancel | Batalkan kunjungan |
| GET | /encounters/{id}/vitals | Tanda vital kunjungan (LOINC + UCUM) |
| GET | /encounters/{id}/note | Catatan SOAP kunjungan |
| GET | /encounters/{id}/note/versions | Riwayat versi catatan yang sudah ditandatangani |
| GET | /encounters/{id}/diagnoses | Diagnosis ICD-10 kunjungan |
| GET | /encounters/{id}/procedures | Tindakan ICD-9-CM kunjungan |
| GET | /encounters/{id}/signatures | Tanda tangan elektronik kunjungan (penutupan dan koreksi) |
| GET | /encounters/{id}/documents | Dokumen yang terkait kunjungan |
| GET | /note-templates | Template catatan SOAP |
Surat
3 operasiSurat keterangan sakit, rujukan, dan sehat yang sudah diterbitkan (modul rme).
| GET | /letters | Surat yang diterbitkan untuk pasien atau kunjungan |
|---|---|---|
| GET | /letters/{id} | Detail surat |
| GET | /letters/{id}/print | Halaman cetak surat (HTML) |
Booking
16 operasiJadwal praktik, slot, cuti/libur, dan booking pasien (modul booking).
| GET | /booking/appointments | Daftar booking |
|---|---|---|
| POST | /booking/appointments | Buat booking |
| GET | /booking/appointments/{id} | Detail booking |
| PATCH | /booking/appointments/{id} | Ubah data booking |
| POST | /booking/appointments/{id}/cancel | Batalkan booking |
| POST | /booking/appointments/{id}/check-in | Check-in pasien pada hari booking |
| POST | /booking/appointments/{id}/no-show | Tandai pasien tidak datang |
| POST | /booking/appointments/{id}/reschedule | Jadwal ulang booking |
| GET | /booking/slots | Slot praktik dan ketersediaannya |
| GET | /booking/schedules | Jadwal praktik mingguan |
| POST | /booking/schedules | Buat jadwal praktik |
| PATCH | /booking/schedules/{id} | Ubah jadwal praktik |
| DELETE | /booking/schedules/{id} | Nonaktifkan jadwal praktik |
| GET | /booking/exceptions | Cuti dokter dan libur cabang |
| POST | /booking/exceptions | Catat cuti dokter atau libur cabang |
| DELETE | /booking/exceptions/{id} | Hapus cuti/libur |
Tagihan
19 operasiTagihan, pembayaran, deposit, paket, dan master tarif kasir; hanya baca (modul cashier).
| GET | /billing/invoices | Daftar tagihan pasien |
|---|---|---|
| GET | /billing/invoices/{id} | Detail tagihan dengan baris, diskon, dan pembayaran |
| GET | /billing/invoices/{id}/receipt | Kuitansi tagihan (HTML siap cetak) |
| GET | /billing/payments | Daftar pembayaran |
| GET | /billing/payments/{id} | Detail pembayaran |
| GET | /billing/charges | Charge layanan dan barang pasien |
| GET | /billing/deposits | Saldo dan mutasi deposit pasien |
| GET | /billing/packages | Paket prabayar yang dijual klinik |
| GET | /billing/patient-packages | Paket prabayar milik pasien |
| GET | /billing/services | Master layanan dan tarif dasar |
| GET | /billing/payers | Penjamin dan aturan tanggungan |
| GET | /billing/price-lists | Daftar tarif per penjamin |
| GET | /billing/price-lists/{id}/items | Harga dalam satu daftar tarif |
| GET | /billing/prices/resolve | Harga efektif layanan/barang untuk penjamin |
| GET | /billing/settings | Pengaturan kasir (PPN, persetujuan diskon) |
| GET | /billing/cash-sessions | Sesi kas kasir |
| GET | /billing/cash-sessions/current | Sesi kas terbuka milik pemanggil |
| GET | /billing/settlements | Pencairan QRIS/kartu/gateway ke bank |
| GET | /billing/reports/ar-aging | Umur piutang pasien |
Penunjang
8 operasiOrder dan hasil laboratorium serta radiologi (modul lab/radiology).
| GET | /lab/orders | Worklist order laboratorium |
|---|---|---|
| GET | /lab/orders/{id} | Detail order lab dan hasil per parameter |
| GET | /lab/orders/{id}/print | Lembar hasil lab satu order (HTML A4) |
| GET | /lab/requests/{request_id}/print | Lembar hasil lab satu permintaan (semua order) |
| GET | /radiology/orders | Worklist order radiologi |
| GET | /radiology/orders/{id} | Detail order radiologi, ekspertise, dan berkas citra |
| GET | /radiology/orders/{id}/files/{file_id} | Unduh berkas citra/dokumen radiologi |
| GET | /diagnostics/patients/{patient_id}/results | Riwayat hasil lab dan radiologi pasien |
Integrasi
4 operasiLookup BPJS dan SATUSEHAT serta status kiriman alat lab (modul bpjs, satusehat, lis).
| GET | /integrations/bpjs/peserta | Cek kepesertaan BPJS Kesehatan |
|---|---|---|
| GET | /integrations/bpjs/ref/diagnosa | Referensi diagnosa PCare BPJS |
| GET | /integrations/satusehat/patients/lookup | Lookup pasien SATUSEHAT berdasarkan NIK |
| GET | /integrations/lis/orders/{id}/messages | Status kiriman order lab ke alat (LIS) |
Spesialis
27 operasiData paket spesialis gigi, kecantikan, KIA, dan fisioterapi; hanya baca (modul dental, beauty, kia, physio).
| GET | /dental/legend | Gigi: legenda kondisi odontogram dan permukaan |
|---|---|---|
| GET | /dental/patients/{patient_id}/odontogram | Gigi: snapshot odontogram terkini (FDI) |
| GET | /dental/patients/{patient_id}/odontogram/entries | Gigi: semua entri odontogram (terbaru dulu) |
| GET | /dental/patients/{patient_id}/odontogram/teeth/{tooth} | Gigi: riwayat satu gigi |
| GET | /dental/patients/{patient_id}/plans | Gigi: rencana perawatan pasien (tanpa item) |
| GET | /dental/plans/{id} | Gigi: detail rencana perawatan (tahap dan item) |
| GET | /dental/patients/{patient_id}/photos | Gigi: foto intraoral, ekstraoral, dan rontgen |
| GET | /dental/photos/{id}/file | Gigi: unduh berkas foto |
| GET | /beauty/patients/{patient_id}/records | Kecantikan: riwayat treatment (maks 200) |
| GET | /beauty/records/{id} | Kecantikan: detail treatment dan produk |
| GET | /beauty/patients/{patient_id}/photos | Kecantikan: foto before/after/progress |
| GET | /beauty/patients/{patient_id}/photo-consent | Kecantikan: status consent foto pasien |
| GET | /beauty/photos/{id}/file | Kecantikan: unduh berkas foto |
| GET | /kia/calc/pregnancy | KIA: hitung HPL dan usia kehamilan |
| GET | /kia/kspr-factors | KIA: faktor Kartu Skor Poedji Rochjati |
| GET | /kia/patients/{patient_id}/pregnancies | KIA: daftar kehamilan pasien |
| GET | /kia/pregnancies/{id} | KIA: detail kehamilan, kunjungan ANC, dan persalinan |
| GET | /kia/patients/{patient_id}/family-planning | KIA: kunjungan KB dan jadwal kunjungan ulang |
| GET | /kia/immunization-schedule | KIA: jadwal imunisasi rutin nasional |
| GET | /kia/patients/{patient_id}/immunizations | KIA: riwayat imunisasi dan jadwal jatuh tempo |
| GET | /kia/patients/{patient_id}/growth | KIA: pengukuran pertumbuhan anak (z-score WHO) |
| GET | /kia/patients/{patient_id}/growth/chart | KIA: data grafik pertumbuhan (kurva acuan + titik) |
| GET | /kia/growth/zscore | KIA: kalkulator z-score WHO |
| GET | /physio/patients/{patient_id}/assessments | Fisioterapi: daftar asesmen |
| GET | /physio/assessments/{id} | Fisioterapi: detail asesmen (VAS, ROM, MMT, skor fungsional) |
| GET | /physio/patients/{patient_id}/programs | Fisioterapi: daftar program terapi |
| GET | /physio/programs/{id} | Fisioterapi: detail program, sesi, dan evaluasi |
Telekonsultasi
2 operasiSesi telekonsultasi terjadwal; hanya baca (modul telecon).
| GET | /telecon/sessions | Sesi telekonsultasi |
|---|---|---|
| GET | /telecon/sessions/{id} | Detail sesi telekonsultasi |
Webhook
9 operasiLangganan event domain dan riwayat pengiriman (modul api). Langganan berlaku untuk seluruh organisasi.
| GET | /webhooks | Daftar langganan webhook organisasi |
|---|---|---|
| POST | /webhooks | Buat langganan webhook |
| GET | /webhooks/events | Katalog event dan format tanda tangan |
| PATCH | /webhooks/{id} | Ubah langganan webhook |
| DELETE | /webhooks/{id} | Hapus langganan webhook |
| POST | /webhooks/{id}/rotate-secret | Rotasi secret HMAC |
| POST | /webhooks/{id}/test | Kirim event uji ping |
| GET | /webhooks/{id}/deliveries | Riwayat pengiriman webhook |
| POST | /webhooks/deliveries/{id}/redeliver | Kirim ulang satu pengiriman |
Katalog event webhook
30 eventPayload setiap event berisi id, type, created_at, org_id, branch_id (bila ada), dan data. Ambil detail lengkap lewat API memakai data.id.
- ping
- patient.created
- patient.updated
- patient.merged
- encounter.started
- encounter.closed
- encounter.cancelled
- allergy.recorded
- queue.called
- prescription.created
- dispense.completed
- dispense.returned
- lab.order_created
- radiology.order_created
- lab.result_final
- radiology.result_final
- immunization.recorded
- appointment.booked
- appointment.cancelled
- appointment.checked_in
- invoice.finalized
- invoice.paid
- invoice.voided
- payment.received
- claim.submitted
- claim.paid
- claim.rejected
- stock.below_minimum
- subscription.activated
- subscription.changed