Referensi API

Konteks

Identitas token, organisasi, cabang, unit layanan, dan tenaga kesehatan untuk mengisi referensi ID.

OpenAPI 3.1 · versi 1.1.0 · 127 operasi · 30 event webhook

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

GET/me

Identitas token dan izin efektif

Identitas teknis klien API (pengguna API: <nama>), izin RBAC hasil scope token, cabang aktif, dan entitlement paket. Berguna untuk memeriksa scope sebelum memanggil endpoint lain.

Scope: Token apa pun

Parameter

Parameter GET /me
Nama	Lokasi	Tipe	Keterangan
X-Branch-ID	header	string (uuid)	Cabang aktif (opsional). Nilai di luar cabang klien diabaikan.

Contoh kode

curlJavaScriptPython

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

const res = await fetch("https://api.medivana.cloud/api/v1/me", {
  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/me",
    headers={"Authorization": f"Bearer {os.environ['MEDIVANA_TOKEN']}"},
    timeout=30,
)
resp.raise_for_status()
data = resp.json()

Respons

200Konteks tokenapplication/json

{
  "user_id": "3f0c2a10-5b7e-4c1d-9a2e-000000000a11",
  "email": "mdn_ci_7f3k2q9x",
  "name": "API: Integrasi HIS",
  "org": {
    "id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
    "name": "Klinik Sehat Contoh",
    "slug": "klinik-sehat-contoh",
    "clinic_kind": "pratama",
    "status": "active",
    "demo_expires_at": null,
    "default_locale": "id"
  },
  "branch_id": null,
  "branches": [],
  "roles": [
    "api_client"
  ],
  "permissions": [
    "encounter.read",
    "patient.read",
    "webhook.manage"
  ],
  "data_scope": "org",
  "two_factor": true,
  "entitlements": {
    "plan": "klinik_pro",
    "plan_name": "Klinik Pro",
    "status": "active",
    "modules": {
      "api": true,
      "frontoffice": true,
      "rme": true,
      "booking": true
    }
  },
  "is_demo": false,
  "break_glass": false,
  "locale": "id",
  "effective_locale": "id"
}

Skema 200

Skema 200
Nama	Tipe	Keterangan
user_id	string (uuid)	Identitas teknis klien API
email	string	`client_id` klien
name	string
org	object
branch_id	string (uuid) \| null	Cabang aktif permintaan ini
branches	array<object>
branches[].id	string (uuid)
branches[].code	string
branches[].name	string
branches[].address	string \| null
branches[].city	string \| null
branches[].phone	string \| null
branches[].latitude	number \| null
branches[].longitude	number \| null
branches[].geofence_m	integer
branches[].satusehat_location_ihs	string \| null
branches[].bpjs_ppk_code	string \| null
branches[].is_active	boolean
branches[].version	integer
roles	array<string>
permissions	array<string>	Izin RBAC hasil scope token
data_scope	string
two_factor	boolean
entitlements	object
entitlements.org_id	string (uuid)
entitlements.plan	string
entitlements.plan_name	string
entitlements.status	active \| grace \| read_only \| cancelled \| none
entitlements.billing_cycle	string
entitlements.branches	integer
entitlements.modules	object
entitlements.limits	object
entitlements.addons	array<string>
entitlements.bi_level	string
entitlements.accounting_level	string
entitlements.current_period_end	string (date-time)
entitlements.grace_until	string (date-time)
entitlements.is_demo	boolean
is_demo	boolean
break_glass	boolean
locale	string
effective_locale	string

Galat

401unauthorizedToken tidak ada, tidak valid, kedaluwarsa, atau dicabut
429rate-limitedBatas laju klien (rate_limit_per_min) terlampaui; coba lagi pada menit berikutnya

GET/me/entitlements

Paket, modul aktif, dan batas paket organisasi

Gunakan modules untuk mengetahui endpoint mana yang akan menjawab 402 module-locked.

Scope: Token apa pun

Contoh kode

curlJavaScriptPython

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

const res = await fetch("https://api.medivana.cloud/api/v1/me/entitlements", {
  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/me/entitlements",
    headers={"Authorization": f"Bearer {os.environ['MEDIVANA_TOKEN']}"},
    timeout=30,
)
resp.raise_for_status()
data = resp.json()

Respons

200Entitlementapplication/json

{
  "org_id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "plan": "klinik_pro",
  "plan_name": "Klinik Pro",
  "status": "active",
  "billing_cycle": "annual",
  "branches": 3,
  "modules": {
    "api": true,
    "frontoffice": true,
    "rme": true,
    "booking": true,
    "cashier": true,
    "lab": true,
    "satusehat": true,
    "bpjs": true
  },
  "limits": {
    "users": 50,
    "branches": 3
  },
  "addons": [],
  "bi_level": "basic",
  "accounting_level": "basic",
  "current_period_end": "2027-10-31T23:59:59+07:00",
  "is_demo": false
}

Skema 200

Skema 200
Nama	Tipe	Keterangan
org_id	string (uuid)
plan	string
plan_name	string
status	active \| grace \| read_only \| cancelled \| none
billing_cycle	string
branches	integer
modules	object
limits	object
addons	array<string>
bi_level	string
accounting_level	string
current_period_end	string (date-time)
grace_until	string (date-time)
is_demo	boolean

Galat

401unauthorizedToken tidak ada, tidak valid, kedaluwarsa, atau dicabut
429rate-limitedBatas laju klien (rate_limit_per_min) terlampaui; coba lagi pada menit berikutnya

GET/org

Profil organisasi (klinik)

Scope: Token apa pun

Contoh kode

curlJavaScriptPython

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

const res = await fetch("https://api.medivana.cloud/api/v1/org", {
  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/org",
    headers={"Authorization": f"Bearer {os.environ['MEDIVANA_TOKEN']}"},
    timeout=30,
)
resp.raise_for_status()
data = resp.json()

Respons

200Organisasi (ETag)application/json

{
  "id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "name": "Klinik Sehat Contoh",
  "slug": "klinik-sehat-contoh",
  "legal_name": "PT Sehat Contoh Sejahtera",
  "npwp": null,
  "is_pkp": false,
  "clinic_kind": "pratama",
  "status": "active",
  "is_demo": false,
  "satusehat_org_ihs": "100000000",
  "settings": {},
  "default_locale": "id",
  "version": 4
}

Skema 200

Skema 200
Nama	Tipe	Keterangan
id	string (uuid)
name	string
slug	string
legal_name	string \| null
npwp	string \| null
is_pkp	boolean
clinic_kind	string
status	string
is_demo	boolean
satusehat_org_ihs	string \| null
settings	object
default_locale	id \| en
version	integer

Galat

401unauthorizedToken tidak ada, tidak valid, kedaluwarsa, atau dicabut
429rate-limitedBatas laju klien (rate_limit_per_min) terlampaui; coba lagi pada menit berikutnya

GET/branches

Daftar cabang

Nilai id dipakai sebagai header X-Branch-ID.

Scope: Token apa pun

Contoh kode

curlJavaScriptPython

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

const res = await fetch("https://api.medivana.cloud/api/v1/branches", {
  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/branches",
    headers={"Authorization": f"Bearer {os.environ['MEDIVANA_TOKEN']}"},
    timeout=30,
)
resp.raise_for_status()
data = resp.json()

Respons

200Cabang (urut kode)application/json

{
  "items": [
    {
      "id": "3f0c2a10-5b7e-4c1d-9a2e-0000000000b1",
      "code": "PST",
      "name": "Klinik Sehat Contoh Pusat",
      "address": "Jl. Contoh No. 1",
      "city": "Semarang",
      "phone": "6224000001",
      "latitude": -6.99,
      "longitude": 110.42,
      "geofence_m": 150,
      "satusehat_location_ihs": null,
      "bpjs_ppk_code": "0000X001",
      "is_active": true,
      "version": 2
    }
  ]
}

Skema 200

Skema 200
Nama	Tipe	Keterangan
itemswajib	array<object>
items[].id	string (uuid)
items[].code	string
items[].name	string
items[].address	string \| null
items[].city	string \| null
items[].phone	string \| null
items[].latitude	number \| null
items[].longitude	number \| null
items[].geofence_m	integer
items[].satusehat_location_ihs	string \| null
items[].bpjs_ppk_code	string \| null
items[].is_active	boolean
items[].version	integer

Galat

401unauthorizedToken tidak ada, tidak valid, kedaluwarsa, atau dicabut
429rate-limitedBatas laju klien (rate_limit_per_min) terlampaui; coba lagi pada menit berikutnya

GET/units

Daftar unit layanan (poli, farmasi, laboratorium, …)

id dipakai sebagai unit_id saat mendaftarkan kunjungan atau membaca jadwal. Tanpa branch_id: cabang aktif, atau semua cabang bila tidak ada cabang aktif.

Scope: Token apa pun

Parameter

Parameter GET /units
Nama	Lokasi	Tipe	Keterangan
X-Branch-ID	header	string (uuid)	Cabang aktif (opsional). Nilai di luar cabang klien diabaikan.
branch_id	query	string (uuid)
kind	query	string (9 nilai)

Contoh kode

curlJavaScriptPython

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

const res = await fetch("https://api.medivana.cloud/api/v1/units", {
  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/units",
    headers={"Authorization": f"Bearer {os.environ['MEDIVANA_TOKEN']}"},
    timeout=30,
)
resp.raise_for_status()
data = resp.json()

Respons

200Unit layananapplication/json

{
  "items": [
    {
      "id": "3f0c2a10-5b7e-4c1d-9a2e-0000000c0001",
      "branch_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000000b1",
      "kind": "poli",
      "code": "UMUM",
      "name": "Poli Umum",
      "specialty": "umum",
      "satusehat_location_ihs": null,
      "bpjs_poli_code": "001",
      "is_active": true
    }
  ]
}

Skema 200

Skema 200
Nama	Tipe	Keterangan
itemswajib	array<object>
items[].id	string (uuid)
items[].branch_id	string (uuid)
items[].kind	string
items[].code	string
items[].name	string
items[].specialty	string \| null
items[].satusehat_location_ihs	string \| null
items[].bpjs_poli_code	string \| null
items[].is_active	boolean

Galat

400bad-requestParameter atau format permintaan tidak valid
401unauthorizedToken tidak ada, tidak valid, kedaluwarsa, atau dicabut
429rate-limitedBatas laju klien (rate_limit_per_min) terlampaui; coba lagi pada menit berikutnya

GET/practitioners

Daftar tenaga kesehatan aktif

id adalah ID keanggotaan yang dipakai sebagai practitioner_id di kunjungan, jadwal, dan booking. Difilter ke cabang aktif bila X-Branch-ID dikirim. Tidak memuat NIK/STR.

Scope: Token apa pun

Parameter

Parameter GET /practitioners
Nama	Lokasi	Tipe	Keterangan
X-Branch-ID	header	string (uuid)	Cabang aktif (opsional). Nilai di luar cabang klien diabaikan.

Contoh kode

curlJavaScriptPython

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

const res = await fetch("https://api.medivana.cloud/api/v1/practitioners", {
  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/practitioners",
    headers={"Authorization": f"Bearer {os.environ['MEDIVANA_TOKEN']}"},
    timeout=30,
)
resp.raise_for_status()
data = resp.json()

Respons

200Tenaga kesehatan (urut nama)application/json

{
  "items": [
    {
      "id": "3f0c2a10-5b7e-4c1d-9a2e-0000000d0001",
      "user_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000d1001",
      "name": "dr. Rina Contoh",
      "display_title": "dr.",
      "profession": "dokter",
      "practitioner_ihs": null,
      "branch_ids": [],
      "all_branches": true
    }
  ]
}

Skema 200

Skema 200
Nama	Tipe	Keterangan
itemswajib	array<object>
items[].id	string (uuid)	ID keanggotaan (practitioner_id)
items[].user_id	string (uuid)
items[].name	string
items[].display_title	string \| null
items[].profession	string
items[].practitioner_ihs	string \| null
items[].branch_ids	array<string (uuid)>
items[].all_branches	boolean

Galat

401unauthorizedToken tidak ada, tidak valid, kedaluwarsa, atau dicabut
429rate-limitedBatas laju klien (rate_limit_per_min) terlampaui; coba lagi pada menit berikutnya