API reference

Patients

Master pasien, consent, alergi, dokumen pasien, dan lookup identitas (modul frontoffice).

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/patients

Cari atau daftar pasien

q dikenali otomatis: 16 digit → NIK (persis), 13 digit → No. BPJS, 08…/628… → telepon, berisi angka tanpa spasi → No. RM, selain itu nama (substring lalu kemiripan ejaan). Filter eksplisit boleh digabung. Tanpa q/filter: pasien terbaru berhalaman cursor; pencarian tidak berhalaman (maks limit). Identitas di daftar selalu tersamar (*_masked); nilai penuh hanya di detail.

Scopes: patients:readpatients:write(any one of)
RBAC permissions: patient.read
Module: frontoffice

Parameters

Parameters GET /patients
Name	In	Type	Description
q	query	string	NIK, No. BPJS, telepon, No. RM, atau nama
nik	query	string
mrn	query	string
name	query	string
phone	query	string
bpjs_no	query	string
birth_date	query	string (date)
include_merged	query	boolean
include_inactive	query	boolean
limit	query	integer
cursor	query	string	Nilai `next_cursor` dari halaman sebelumnya

Code examples

curlJavaScriptPython

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

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

Responses

200Daftar pasien (identitas tersamar)application/json

{
  "items": [
    {
      "id": "3f0c2a10-5b7e-4c1d-9a2e-0000000a0001",
      "mrn": "RM-000123",
      "name": "Pasien Contoh",
      "sex": "female",
      "birth_date": "1990-05-12",
      "age_label": "36 th 5 bl",
      "age_years": 36,
      "nik_masked": "9999********0001",
      "phone_masked": "6281******001",
      "bpjs_no_masked": "*********0001",
      "allergy_status": "has",
      "is_active": true,
      "merged_into": null
    }
  ],
  "next_cursor": "eyJ0IjoiMjAyNi0xMC0yOVQwODoxNTowMiswNzowMCJ9"
}

Schema 200

Schema 200
Name	Type	Description
itemsrequired	array<object>
items[].id	string (uuid)
items[].mrn	string
items[].name	string
items[].sex	male \| female
items[].birth_date	string (date) \| null
items[].age_label	string
items[].age_years	integer \| null
items[].nik_masked	string \| null
items[].phone_masked	string \| null
items[].bpjs_no_masked	string \| null
items[].allergy_status	unknown \| none \| has
items[].is_active	boolean
items[].merged_into	string (uuid) \| null
next_cursor	string

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/patients

Daftarkan pasien baru

Wajib name dan sex. mrn kosong → nomor RM otomatis sesuai pengaturan RM klinik. Telepon dinormalkan ke 62…. Bila nik diisi dan satusehat_ihs kosong, server mencari IHS number ke SATUSEHAT (maks 3 detik; kegagalan tidak menghalangi pendaftaran, lihat satusehat_lookup). NIK yang sudah terdaftar → 409 dengan existing_patient_id; baca pasien itu alih-alih membuat baru. Menerbitkan event patient.created.

Scopes: patients:write
RBAC permissions: patient.write
Module: frontoffice
X-Branch-ID: X-Branch-ID required

Parameters

Parameters POST /patients
Name	In	Type	Description
X-Branch-IDrequired	header	string (uuid)	Cabang aktif. Wajib kecuali klien API hanya punya satu cabang (dipakai otomatis); tanpa cabang aktif → `400`.

Request body `application/json`

Request body POST /patients
Name	Type	Description
name	string
sex	male \| female \| L \| P
birth_date	string (date)
birth_place	string
nik	string
phone	string
bpjs_no	string
email	string
address	string
village	string
district	string
city	string
province	string
postal_code	string
religion	string
marital_status	single \| married \| divorced \| widowed
occupation	string
education	string
blood_type	string
nationality	string
mother_name	string
emergency_name	string
emergency_relation	string
emergency_phone	string
satusehat_ihs	string \| null
notes	string \| null
mrn	string \| null	Kosong = nomor RM otomatis
skip_satusehat_lookup	boolean

{
  "name": "Pasien Contoh",
  "sex": "female",
  "birth_date": "1990-05-12",
  "birth_place": "Semarang",
  "nik": "9999010101900001",
  "phone": "0812-0000-0001",
  "email": "pasien@contoh.test",
  "address": "Jl. Contoh No. 10",
  "city": "Semarang",
  "province": "Jawa Tengah",
  "skip_satusehat_lookup": false
}

Code examples

curlJavaScriptPython

curl -X POST "https://api.medivana.cloud/api/v1/patients" \
  -H "Authorization: Bearer $MEDIVANA_TOKEN" \
  -H "X-Branch-ID: $MEDIVANA_BRANCH_ID" \
  -H "Content-Type: application/json" \
  -d '{"name":"Pasien Contoh","sex":"female","birth_date":"1990-05-12","birth_place":"Semarang","nik":"9999010101900001","phone":"0812-0000-0001","email":"pasien@contoh.test","address":"Jl. Contoh No. 10","city":"Semarang","province":"Jawa Tengah","skip_satusehat_lookup":false}'

const res = await fetch("https://api.medivana.cloud/api/v1/patients", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.MEDIVANA_TOKEN}`,
    "X-Branch-ID": process.env.MEDIVANA_BRANCH_ID,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    name: "Pasien Contoh",
    sex: "female",
    birth_date: "1990-05-12",
    birth_place: "Semarang",
    nik: "9999010101900001",
    phone: "0812-0000-0001",
    email: "pasien@contoh.test",
    address: "Jl. Contoh No. 10",
    city: "Semarang",
    province: "Jawa Tengah",
    skip_satusehat_lookup: 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/patients",
    headers={
        "Authorization": f"Bearer {os.environ['MEDIVANA_TOKEN']}",
        "X-Branch-ID": os.environ["MEDIVANA_BRANCH_ID"],
    },
    json={
        "name": "Pasien Contoh",
        "sex": "female",
        "birth_date": "1990-05-12",
        "birth_place": "Semarang",
        "nik": "9999010101900001",
        "phone": "0812-0000-0001",
        "email": "pasien@contoh.test",
        "address": "Jl. Contoh No. 10",
        "city": "Semarang",
        "province": "Jawa Tengah",
        "skip_satusehat_lookup": False,
    },
    timeout=30,
)
resp.raise_for_status()
data = resp.json()

Responses

201Pasien dibuatapplication/json

{
  "id": "3f0c2a10-5b7e-4c1d-9a2e-0000000a0001",
  "mrn": "RM-000123",
  "name": "Pasien Contoh",
  "sex": "female",
  "birth_date": "1990-05-12",
  "birth_place": "Semarang",
  "age_label": "36 th 5 bl",
  "age_years": 36,
  "nik_masked": "9999********0001",
  "nik": "9999010101900001",
  "phone_masked": "6281******001",
  "phone": "6281200000001",
  "bpjs_no_masked": null,
  "bpjs_no": null,
  "email": "pasien@contoh.test",
  "address": "Jl. Contoh No. 10",
  "city": "Semarang",
  "province": "Jawa Tengah",
  "satusehat_ihs": "P00000000001",
  "allergy_status": "unknown",
  "is_active": true,
  "merged_into": null,
  "registered_branch_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000000b1",
  "notes": null,
  "created_at": "2026-10-29T08:15:02+07:00",
  "updated_at": "2026-10-29T08:15:02+07:00",
  "version": 1,
  "satusehat_lookup": "found"
}

Schema 201

Schema 201
Name	Type	Description
id	string (uuid)
mrn	string
name	string
sex	male \| female
birth_date	string (date) \| null
age_label	string
age_years	integer \| null
nik_masked	string \| null
phone_masked	string \| null
bpjs_no_masked	string \| null
allergy_status	unknown \| none \| has
is_active	boolean
merged_into	string (uuid) \| null
nik	string \| null
phone	string \| null
bpjs_no	string \| null
birth_place	string \| null
email	string \| null
address	string \| null
village	string \| null
district	string \| null
city	string \| null
province	string \| null
postal_code	string \| null
religion	string \| null
marital_status	single \| married \| divorced \| widowed \| null
occupation	string \| null
education	string \| null
blood_type	string \| null
nationality	string \| null
mother_name	string \| null
emergency_name	string \| null
emergency_relation	string \| null
emergency_phone	string \| null
satusehat_ihs	string \| null
registered_branch_id	string (uuid) \| null
notes	string \| null
created_at	string (date-time)
updated_at	string (date-time)
version	integer
satusehat_lookup	found \| not_found \| unavailable \| skipped	Hanya pada respons create/lookup

Errors

400bad-requestCabang aktif belum dipilih (X-Branch-ID)
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)
409conflictNIK sudah terdaftar
422validationValidasi gagal; rincian per field di errors
429rate-limitedBatas laju klien (rate_limit_per_min) terlampaui; coba lagi pada menit berikutnya

GET/patients/duplicate-check

Periksa kemungkinan pasien ganda

Panggil sebelum membuat pasien. Kriteria NIK sama (skor 1), telepon sama (0,6), tanggal lahir sama + nama mirip, atau nama sangat mirip.

Scopes: patients:readpatients:write(any one of)
RBAC permissions: patient.read
Module: frontoffice

Parameters

Parameters GET /patients/duplicate-check
Name	In	Type	Description
name	query	string
birth_date	query	string (date)
nik	query	string
phone	query	string
exclude_id	query	string (uuid)	Abaikan pasien ini (saat mengubah data)

Code examples

curlJavaScriptPython

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

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

Responses

200Kandidat duplikat (skor tertinggi dulu)application/json

{
  "items": [
    {
      "id": "3f0c2a10-5b7e-4c1d-9a2e-0000000a0001",
      "mrn": "RM-000123",
      "name": "Pasien Contoh",
      "sex": "female",
      "birth_date": "1990-05-12",
      "nik_masked": "9999********0001",
      "reasons": [
        "name_birth_date"
      ],
      "score": 0.8
    }
  ]
}

Schema 200

Schema 200
Name	Type	Description
itemsrequired	array<object>
items[].id	string (uuid)
items[].mrn	string
items[].name	string
items[].sex	male \| female
items[].birth_date	string (date) \| null
items[].age_label	string
items[].age_years	integer \| null
items[].nik_masked	string \| null
items[].phone_masked	string \| null
items[].bpjs_no_masked	string \| null
items[].allergy_status	unknown \| none \| has
items[].is_active	boolean
items[].merged_into	string (uuid) \| null
items[].reasons	array<nik \| phone \| name_birth_date \| name>
items[].score	number

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/patients/lookup-nik

Cari NIK di data lokal lalu SATUSEHAT

local berisi pasien tersamar bila NIK sudah terdaftar. SATUSEHAT dilewati (skipped) bila pasien lokal sudah punya IHS number. unavailable = integrasi belum dikonfigurasi, galat, atau timeout.

Scopes: patients:write
RBAC permissions: patient.write
Module: frontoffice

Request body `application/json`

Request body POST /patients/lookup-nik
Name	Type	Description
nikrequired	string

{
  "nik": "9999010101900001"
}

Code examples

curlJavaScriptPython

curl -X POST "https://api.medivana.cloud/api/v1/patients/lookup-nik" \
  -H "Authorization: Bearer $MEDIVANA_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"nik":"9999010101900001"}'

const res = await fetch("https://api.medivana.cloud/api/v1/patients/lookup-nik", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.MEDIVANA_TOKEN}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    nik: "9999010101900001",
  }),
});
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/patients/lookup-nik",
    headers={"Authorization": f"Bearer {os.environ['MEDIVANA_TOKEN']}"},
    json={
        "nik": "9999010101900001",
    },
    timeout=30,
)
resp.raise_for_status()
data = resp.json()

Responses

200Hasil lookupapplication/json

{
  "local": null,
  "satusehat": {
    "status": "found",
    "patient": {
      "ihs_number": "P00000000001",
      "nik": "9999010101900001",
      "name": "PASIEN CONTOH",
      "birth_date": "1990-05-12T00:00:00Z",
      "gender": "female",
      "address": "Jl. Contoh No. 10"
    }
  }
}

Schema 200

Schema 200
Name	Type	Description
local	object \| null
satusehat	object
satusehat.status	found \| not_found \| unavailable \| skipped
satusehat.patient	object \| 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/patients/mrn-settings

Format nomor rekam medis

Scopes: patients:readpatients:write(any one of)
RBAC permissions: patient.read
Module: frontoffice

Code examples

curlJavaScriptPython

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

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

Responses

200Pengaturan nomor RMapplication/json

{
  "prefix": "RM-",
  "pad_length": 6,
  "last_value": 122,
  "example": "RM-000123"
}

Schema 200

Schema 200
Name	Type	Description
prefix	string
pad_length	integer
last_value	integer
example	string

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

GET/patients/{id}

Detail pasien

Identitas lengkap (NIK, telepon, BPJS penuh). Setiap pembacaan dicatat di audit log (patient.read). Pasien yang sudah digabung punya merged_into; ikuti ke pasien tujuan.

Scopes: patients:readpatients:write(any one of)
RBAC permissions: patient.read
Module: frontoffice

Parameters

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

Code examples

curlJavaScriptPython

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

const res = await fetch("https://api.medivana.cloud/api/v1/patients/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/patients/3f0c2a10-5b7e-4c1d-9a2e-000000000001",
    headers={"Authorization": f"Bearer {os.environ['MEDIVANA_TOKEN']}"},
    timeout=30,
)
resp.raise_for_status()
data = resp.json()

Responses

200Pasienapplication/json

{
  "id": "3f0c2a10-5b7e-4c1d-9a2e-0000000a0001",
  "mrn": "RM-000123",
  "name": "Pasien Contoh",
  "sex": "female",
  "birth_date": "1990-05-12",
  "birth_place": "Semarang",
  "age_label": "36 th 5 bl",
  "age_years": 36,
  "nik_masked": "9999********0001",
  "nik": "9999010101900001",
  "phone_masked": "6281******001",
  "phone": "6281200000001",
  "bpjs_no_masked": null,
  "bpjs_no": null,
  "email": "pasien@contoh.test",
  "address": "Jl. Contoh No. 10",
  "city": "Semarang",
  "province": "Jawa Tengah",
  "satusehat_ihs": "P00000000001",
  "allergy_status": "unknown",
  "is_active": true,
  "merged_into": null,
  "registered_branch_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000000b1",
  "notes": null,
  "created_at": "2026-10-29T08:15:02+07:00",
  "updated_at": "2026-10-29T08:15:02+07:00",
  "version": 1,
  "satusehat_lookup": "found"
}

Schema 200

Schema 200
Name	Type	Description
id	string (uuid)
mrn	string
name	string
sex	male \| female
birth_date	string (date) \| null
age_label	string
age_years	integer \| null
nik_masked	string \| null
phone_masked	string \| null
bpjs_no_masked	string \| null
allergy_status	unknown \| none \| has
is_active	boolean
merged_into	string (uuid) \| null
nik	string \| null
phone	string \| null
bpjs_no	string \| null
birth_place	string \| null
email	string \| null
address	string \| null
village	string \| null
district	string \| null
city	string \| null
province	string \| null
postal_code	string \| null
religion	string \| null
marital_status	single \| married \| divorced \| widowed \| null
occupation	string \| null
education	string \| null
blood_type	string \| null
nationality	string \| null
mother_name	string \| null
emergency_name	string \| null
emergency_relation	string \| null
emergency_phone	string \| null
satusehat_ihs	string \| null
registered_branch_id	string (uuid) \| null
notes	string \| null
created_at	string (date-time)
updated_at	string (date-time)
version	integer
satusehat_lookup	found \| not_found \| unavailable \| skipped	Hanya pada respons create/lookup

Errors

401unauthorizedToken tidak ada, tidak valid, kedaluwarsa, atau dicabut
402module-lockedModul tidak aktif di paket organisasi
403forbiddenconfidential-recordScope tidak memberi izin (forbidden), rekam medis ditandai rahasia (confidential-record), atau baca-saja (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/patients/{id}

Ubah data pasien

Kirim hanya field yang berubah; string kosong "" mengosongkan field opsional. Mengubah nik dicek duplikat (409 + existing_patient_id). Pasien yang sudah digabung → 409. Menerbitkan event patient.updated.

Scopes: patients:write
RBAC permissions: patient.write
Module: frontoffice
X-Branch-ID: X-Branch-ID required

Parameters

Parameters PATCH /patients/{id}
Name	In	Type	Description
idrequired	path	string (uuid)
X-Branch-IDrequired	header	string (uuid)	Cabang aktif. Wajib kecuali klien API hanya punya satu cabang (dipakai otomatis); tanpa cabang aktif → `400`.
If-Match	header	string	Versi dari `ETag` (mis. `"3"`). Bila tidak cocok → `412 stale`.

Request body `application/json`

Request body PATCH /patients/{id}
Name	Type	Description
name	string
sex	male \| female \| L \| P
birth_date	string (date)
birth_place	string
nik	string
phone	string
bpjs_no	string
email	string
address	string
village	string
district	string
city	string
province	string
postal_code	string
religion	string
marital_status	single \| married \| divorced \| widowed
occupation	string
education	string
blood_type	string
nationality	string
mother_name	string
emergency_name	string
emergency_relation	string
emergency_phone	string
satusehat_ihs	string \| null
notes	string \| null
mrn	string \| null	Kosong = nomor RM otomatis
skip_satusehat_lookup	boolean

{
  "phone": "0812-0000-0002",
  "address": "Jl. Contoh Baru No. 2",
  "email": ""
}

Code examples

curlJavaScriptPython

curl -X PATCH "https://api.medivana.cloud/api/v1/patients/3f0c2a10-5b7e-4c1d-9a2e-000000000001" \
  -H "Authorization: Bearer $MEDIVANA_TOKEN" \
  -H "X-Branch-ID: $MEDIVANA_BRANCH_ID" \
  -H "Content-Type: application/json" \
  -d '{"phone":"0812-0000-0002","address":"Jl. Contoh Baru No. 2","email":""}'

const res = await fetch("https://api.medivana.cloud/api/v1/patients/3f0c2a10-5b7e-4c1d-9a2e-000000000001", {
  method: "PATCH",
  headers: {
    Authorization: `Bearer ${process.env.MEDIVANA_TOKEN}`,
    "X-Branch-ID": process.env.MEDIVANA_BRANCH_ID,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    phone: "0812-0000-0002",
    address: "Jl. Contoh Baru No. 2",
    email: "",
  }),
});
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/patients/3f0c2a10-5b7e-4c1d-9a2e-000000000001",
    headers={
        "Authorization": f"Bearer {os.environ['MEDIVANA_TOKEN']}",
        "X-Branch-ID": os.environ["MEDIVANA_BRANCH_ID"],
    },
    json={
        "phone": "0812-0000-0002",
        "address": "Jl. Contoh Baru No. 2",
        "email": "",
    },
    timeout=30,
)
resp.raise_for_status()
data = resp.json()

Responses

200Pasien terbaruapplication/json

{
  "id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "mrn": "string",
  "name": "string",
  "sex": "male",
  "birth_date": "2026-11-02",
  "age_label": "string",
  "age_years": 0,
  "nik_masked": "string",
  "phone_masked": "string",
  "bpjs_no_masked": "string",
  "allergy_status": "unknown",
  "is_active": true,
  "merged_into": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "nik": "string",
  "phone": "string",
  "bpjs_no": "string",
  "birth_place": "string",
  "email": "string",
  "address": "string",
  "village": "string",
  "district": "string",
  "city": "string",
  "province": "string",
  "postal_code": "string",
  "religion": "string",
  "marital_status": "single",
  "occupation": "string",
  "education": "string",
  "blood_type": "string",
  "nationality": "string",
  "mother_name": "string",
  "emergency_name": "string",
  "emergency_relation": "string",
  "emergency_phone": "string",
  "satusehat_ihs": "string",
  "registered_branch_id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "notes": "string",
  "created_at": "2026-11-02T08:00:00+07:00",
  "updated_at": "2026-11-02T08:00:00+07:00",
  "version": 0,
  "satusehat_lookup": "found"
}

Schema 200

Schema 200
Name	Type	Description
id	string (uuid)
mrn	string
name	string
sex	male \| female
birth_date	string (date) \| null
age_label	string
age_years	integer \| null
nik_masked	string \| null
phone_masked	string \| null
bpjs_no_masked	string \| null
allergy_status	unknown \| none \| has
is_active	boolean
merged_into	string (uuid) \| null
nik	string \| null
phone	string \| null
bpjs_no	string \| null
birth_place	string \| null
email	string \| null
address	string \| null
village	string \| null
district	string \| null
city	string \| null
province	string \| null
postal_code	string \| null
religion	string \| null
marital_status	single \| married \| divorced \| widowed \| null
occupation	string \| null
education	string \| null
blood_type	string \| null
nationality	string \| null
mother_name	string \| null
emergency_name	string \| null
emergency_relation	string \| null
emergency_phone	string \| null
satusehat_ihs	string \| null
registered_branch_id	string (uuid) \| null
notes	string \| null
created_at	string (date-time)
updated_at	string (date-time)
version	integer
satusehat_lookup	found \| not_found \| unavailable \| skipped	Hanya pada respons create/lookup

Errors

400bad-requestCabang aktif belum dipilih (X-Branch-ID)
401unauthorizedToken tidak ada, tidak valid, kedaluwarsa, atau dicabut
402module-lockedModul tidak aktif di paket organisasi
403forbiddenconfidential-recordScope tidak memberi izin (forbidden), rekam medis ditandai rahasia (confidential-record), atau baca-saja (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/patients/{id}/satusehat-lookup

Lookup ulang IHS number SATUSEHAT dari NIK tersimpan

Tanpa body. 422 bila pasien belum punya NIK. Respons memuat satusehat_lookup.

Scopes: patients:write
RBAC permissions: patient.write
Module: frontoffice
X-Branch-ID: X-Branch-ID required

Parameters

Parameters POST /patients/{id}/satusehat-lookup
Name	In	Type	Description
idrequired	path	string (uuid)
X-Branch-IDrequired	header	string (uuid)	Cabang aktif. Wajib kecuali klien API hanya punya satu cabang (dipakai otomatis); tanpa cabang aktif → `400`.

Code examples

curlJavaScriptPython

curl -X POST "https://api.medivana.cloud/api/v1/patients/3f0c2a10-5b7e-4c1d-9a2e-000000000001/satusehat-lookup" \
  -H "Authorization: Bearer $MEDIVANA_TOKEN" \
  -H "X-Branch-ID: $MEDIVANA_BRANCH_ID"

const res = await fetch("https://api.medivana.cloud/api/v1/patients/3f0c2a10-5b7e-4c1d-9a2e-000000000001/satusehat-lookup", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.MEDIVANA_TOKEN}`,
    "X-Branch-ID": process.env.MEDIVANA_BRANCH_ID,
  },
});
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/patients/3f0c2a10-5b7e-4c1d-9a2e-000000000001/satusehat-lookup",
    headers={
        "Authorization": f"Bearer {os.environ['MEDIVANA_TOKEN']}",
        "X-Branch-ID": os.environ["MEDIVANA_BRANCH_ID"],
    },
    timeout=30,
)
resp.raise_for_status()
data = resp.json()

Responses

200Pasienapplication/json

{
  "id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "mrn": "string",
  "name": "string",
  "sex": "male",
  "birth_date": "2026-11-02",
  "age_label": "string",
  "age_years": 0,
  "nik_masked": "string",
  "phone_masked": "string",
  "bpjs_no_masked": "string",
  "allergy_status": "unknown",
  "is_active": true,
  "merged_into": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "nik": "string",
  "phone": "string",
  "bpjs_no": "string",
  "birth_place": "string",
  "email": "string",
  "address": "string",
  "village": "string",
  "district": "string",
  "city": "string",
  "province": "string",
  "postal_code": "string",
  "religion": "string",
  "marital_status": "single",
  "occupation": "string",
  "education": "string",
  "blood_type": "string",
  "nationality": "string",
  "mother_name": "string",
  "emergency_name": "string",
  "emergency_relation": "string",
  "emergency_phone": "string",
  "satusehat_ihs": "string",
  "registered_branch_id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "notes": "string",
  "created_at": "2026-11-02T08:00:00+07:00",
  "updated_at": "2026-11-02T08:00:00+07:00",
  "version": 0,
  "satusehat_lookup": "found"
}

Schema 200

Schema 200
Name	Type	Description
id	string (uuid)
mrn	string
name	string
sex	male \| female
birth_date	string (date) \| null
age_label	string
age_years	integer \| null
nik_masked	string \| null
phone_masked	string \| null
bpjs_no_masked	string \| null
allergy_status	unknown \| none \| has
is_active	boolean
merged_into	string (uuid) \| null
nik	string \| null
phone	string \| null
bpjs_no	string \| null
birth_place	string \| null
email	string \| null
address	string \| null
village	string \| null
district	string \| null
city	string \| null
province	string \| null
postal_code	string \| null
religion	string \| null
marital_status	single \| married \| divorced \| widowed \| null
occupation	string \| null
education	string \| null
blood_type	string \| null
nationality	string \| null
mother_name	string \| null
emergency_name	string \| null
emergency_relation	string \| null
emergency_phone	string \| null
satusehat_ihs	string \| null
registered_branch_id	string (uuid) \| null
notes	string \| null
created_at	string (date-time)
updated_at	string (date-time)
version	integer
satusehat_lookup	found \| not_found \| unavailable \| skipped	Hanya pada respons create/lookup

Errors

400bad-requestCabang aktif belum dipilih (X-Branch-ID)
401unauthorizedToken tidak ada, tidak valid, kedaluwarsa, atau dicabut
402module-lockedModul tidak aktif di paket organisasi
403forbiddenconfidential-recordScope tidak memberi izin (forbidden), rekam medis ditandai rahasia (confidential-record), atau baca-saja (read-only)
404not-foundData tidak ada, milik organisasi lain, atau di luar cakupan cabang klien
422validationValidasi gagal; rincian per field di errors
429rate-limitedBatas laju klien (rate_limit_per_min) terlampaui; coba lagi pada menit berikutnya

GET/patients/{id}/merges

Riwayat penggabungan pasien

Penggabungan di mana pasien menjadi tujuan atau sumber. Penggabungan dilakukan petugas di aplikasi (event patient.merged).

Scopes: patients:readpatients:write(any one of)
RBAC permissions: patient.read
Module: frontoffice

Parameters

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

Code examples

curlJavaScriptPython

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

const res = await fetch("https://api.medivana.cloud/api/v1/patients/3f0c2a10-5b7e-4c1d-9a2e-000000000001/merges", {
  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/patients/3f0c2a10-5b7e-4c1d-9a2e-000000000001/merges",
    headers={"Authorization": f"Bearer {os.environ['MEDIVANA_TOKEN']}"},
    timeout=30,
)
resp.raise_for_status()
data = resp.json()

Responses

200Riwayat gabungapplication/json

{
  "items": [
    {
      "id": "3f0c2a10-5b7e-4c1d-9a2e-0000000a9001",
      "target_patient_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000a0001",
      "source_patient_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000a0002",
      "reason": "Pasien terdaftar dua kali",
      "source_snapshot": {
        "mrn": "RM-000124",
        "name": "Pasien Contoh",
        "sex": "female",
        "birth_date": "1990-05-12",
        "had_nik": false
      },
      "moved": {
        "encounters": 1,
        "queues": 1,
        "observations": 6,
        "diagnoses": 1,
        "procedures": 0,
        "allergies": 0,
        "consents": 0,
        "letters": 0,
        "clinical_documents": 0,
        "charges": 2,
        "files": 0
      },
      "merged_by": "3f0c2a10-5b7e-4c1d-9a2e-0000000d1001",
      "merged_at": "2026-10-29T09:00:00+07:00"
    }
  ]
}

Schema 200

Schema 200
Name	Type	Description
itemsrequired	array<object>
items[].id	string (uuid)
items[].target_patient_id	string (uuid)
items[].source_patient_id	string (uuid)
items[].reason	string
items[].source_snapshot	object
items[].moved	object
items[].merged_by	string (uuid)
items[].merged_at	string (date-time)

Errors

401unauthorizedToken tidak ada, tidak valid, kedaluwarsa, atau dicabut
402module-lockedModul tidak aktif di paket organisasi
403forbiddenconfidential-recordScope tidak memberi izin (forbidden), rekam medis ditandai rahasia (confidential-record), atau baca-saja (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/patients/{id}/consents

Consent pasien (terkini per jenis dan riwayat)

current[kind] = consent terbaru per jenis (bisa withdrawn), null bila belum pernah. Jenis: data_processing, photo, recording, telemedicine, broadcast.

Scopes: patients:readpatients:write(any one of)
RBAC permissions: patient.read
Module: frontoffice

Parameters

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

Code examples

curlJavaScriptPython

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

const res = await fetch("https://api.medivana.cloud/api/v1/patients/3f0c2a10-5b7e-4c1d-9a2e-000000000001/consents", {
  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/patients/3f0c2a10-5b7e-4c1d-9a2e-000000000001/consents",
    headers={"Authorization": f"Bearer {os.environ['MEDIVANA_TOKEN']}"},
    timeout=30,
)
resp.raise_for_status()
data = resp.json()

Responses

200Consentapplication/json

{
  "current": {
    "data_processing": null,
    "photo": {
      "id": "3f0c2a10-5b7e-4c1d-9a2e-0000000a7001",
      "kind": "photo",
      "status": "granted"
    },
    "recording": null,
    "telemedicine": null,
    "broadcast": null
  },
  "items": [
    {
      "id": "3f0c2a10-5b7e-4c1d-9a2e-0000000a7001",
      "patient_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000a0001",
      "kind": "photo",
      "status": "granted",
      "consent_version": "1.0",
      "consent_text": "Saya setuju foto klinis diambil untuk rekam medis.",
      "method": "written",
      "signer_name": null,
      "signer_relation": "self",
      "witness_name": null,
      "evidence_file_id": null,
      "encounter_id": null,
      "granted_at": "2026-10-29T08:20:00+07:00",
      "granted_by": "3f0c2a10-5b7e-4c1d-9a2e-0000000d1001",
      "withdrawn_at": null,
      "withdrawn_by": null,
      "withdraw_reason": null
    }
  ]
}

Schema 200

Schema 200
Name	Type	Description
current	object
items	array<object>
items[].id	string (uuid)
items[].patient_id	string (uuid)
items[].kind	data_processing \| photo \| recording \| telemedicine \| broadcast
items[].status	granted \| withdrawn
items[].consent_version	string
items[].consent_text	string
items[].method	written \| verbal \| digital \| kiosk
items[].signer_name	string \| null
items[].signer_relation	string
items[].witness_name	string \| null
items[].evidence_file_id	string (uuid) \| null
items[].encounter_id	string (uuid) \| null
items[].granted_at	string (date-time)
items[].granted_by	string (uuid) \| null
items[].withdrawn_at	string (date-time) \| null
items[].withdrawn_by	string (uuid) \| null
items[].withdraw_reason	string \| null

Errors

401unauthorizedToken tidak ada, tidak valid, kedaluwarsa, atau dicabut
402module-lockedModul tidak aktif di paket organisasi
403forbiddenconfidential-recordScope tidak memberi izin (forbidden), rekam medis ditandai rahasia (confidential-record), atau baca-saja (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/patients/{id}/allergies

Alergi pasien

allergy_status: unknown (belum dikaji), none (tidak ada alergi), has. Alergi resolved disembunyikan kecuali include_resolved=true.

Scopes: encounters:readpatients:readpatients:write(any one of)
RBAC permissions: encounter.read · patient.read
Module: rme

Parameters

Parameters GET /patients/{id}/allergies
Name	In	Type	Description
idrequired	path	string (uuid)
include_resolved	query	boolean

Code examples

curlJavaScriptPython

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

const res = await fetch("https://api.medivana.cloud/api/v1/patients/3f0c2a10-5b7e-4c1d-9a2e-000000000001/allergies", {
  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/patients/3f0c2a10-5b7e-4c1d-9a2e-000000000001/allergies",
    headers={"Authorization": f"Bearer {os.environ['MEDIVANA_TOKEN']}"},
    timeout=30,
)
resp.raise_for_status()
data = resp.json()

Responses

200Alergiapplication/json

{
  "allergy_status": "has",
  "items": [
    {
      "id": "3f0c2a10-5b7e-4c1d-9a2e-0000000a8001",
      "patient_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000a0001",
      "encounter_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000e0001",
      "substance": "Amoksisilin",
      "substance_code": null,
      "code_system": null,
      "item_id": null,
      "category": "obat",
      "reaction": "Urtikaria",
      "severity": "berat",
      "status": "active",
      "onset": "2019",
      "notes": null,
      "recorded_at": "2026-10-29T09:10:00+07:00",
      "recorded_by": "3f0c2a10-5b7e-4c1d-9a2e-0000000d1001",
      "resolved_at": null,
      "version": 1
    }
  ]
}

Schema 200

Schema 200
Name	Type	Description
allergy_status	unknown \| none \| has
items	array<object>
items[].id	string (uuid)
items[].patient_id	string (uuid)
items[].encounter_id	string (uuid) \| null
items[].substance	string
items[].substance_code	string \| null
items[].code_system	string \| null
items[].item_id	string (uuid) \| null
items[].category	obat \| makanan \| lingkungan
items[].reaction	string \| null
items[].severity	ringan \| sedang \| berat \| null
items[].status	active \| resolved \| entered_in_error
items[].onset	string \| null
items[].notes	string \| null
items[].recorded_at	string (date-time)
items[].recorded_by	string (uuid) \| null
items[].resolved_at	string (date-time) \| null
items[].version	integer

Errors

401unauthorizedToken tidak ada, tidak valid, kedaluwarsa, atau dicabut
402module-lockedModul tidak aktif di paket organisasi
403forbiddenconfidential-recordScope tidak memberi izin (forbidden), rekam medis ditandai rahasia (confidential-record), atau baca-saja (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/patients/{id}/history-summary

Riwayat klinis ringkas pasien

Kunjungan terakhir, diagnosis berulang, tindakan, alergi aktif, dan tren tanda vital (≤10 nilai per kunci, lama → baru). Diaudit.

Scopes: encounters:read
RBAC permissions: encounter.read
Module: rme

Parameters

Parameters GET /patients/{id}/history-summary
Name	In	Type	Description
idrequired	path	string (uuid)
encounters	query	integer	Jumlah kunjungan terakhir

Code examples

curlJavaScriptPython

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

const res = await fetch("https://api.medivana.cloud/api/v1/patients/3f0c2a10-5b7e-4c1d-9a2e-000000000001/history-summary", {
  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/patients/3f0c2a10-5b7e-4c1d-9a2e-000000000001/history-summary",
    headers={"Authorization": f"Bearer {os.environ['MEDIVANA_TOKEN']}"},
    timeout=30,
)
resp.raise_for_status()
data = resp.json()

Responses

200Ringkasan riwayatapplication/json

{
  "patient": {
    "id": "3f0c2a10-5b7e-4c1d-9a2e-0000000a0001",
    "name": "Pasien Contoh",
    "mrn": "RM-000123",
    "sex": "female",
    "birth_date": "1990-05-12",
    "age_label": "36 th 5 bl",
    "age_years": 36,
    "allergy_status": "has"
  },
  "allergies": [],
  "recent_encounters": [
    {
      "id": "3f0c2a10-5b7e-4c1d-9a2e-0000000e0001",
      "branch_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000000b1",
      "registered_at": "2026-10-29T08:30:00+07:00",
      "status": "finished",
      "unit_name": "Poli Umum",
      "practitioner_name": "dr. Rina Contoh",
      "chief_complaint": "Batuk pilek 3 hari",
      "primary_diagnosis": {
        "code": "J06.9",
        "display": "Infeksi saluran napas atas akut, tidak spesifik"
      }
    }
  ],
  "diagnoses": [
    {
      "code": "J06.9",
      "display": "Infeksi saluran napas atas akut, tidak spesifik",
      "count": 3,
      "last_seen": "2026-10-29T10:45:00+07:00"
    }
  ],
  "procedures": [],
  "vitals_trend": {
    "systolic": [
      {
        "value": 150,
        "flag": "H",
        "observed_at": "2026-10-29T09:05:00+07:00"
      }
    ]
  }
}

Schema 200

Schema 200
Name	Type	Description
patient	object
patient.id	string (uuid)
patient.name	string
patient.mrn	string
patient.sex	male \| female
patient.birth_date	string (date) \| null
patient.age_label	string
patient.age_years	integer \| null
patient.allergy_status	unknown \| none \| has
allergies	array<object>
allergies[].id	string (uuid)
allergies[].patient_id	string (uuid)
allergies[].encounter_id	string (uuid) \| null
allergies[].substance	string
allergies[].substance_code	string \| null
allergies[].code_system	string \| null
allergies[].item_id	string (uuid) \| null
allergies[].category	obat \| makanan \| lingkungan
allergies[].reaction	string \| null
allergies[].severity	ringan \| sedang \| berat \| null
allergies[].status	active \| resolved \| entered_in_error
allergies[].onset	string \| null
allergies[].notes	string \| null
allergies[].recorded_at	string (date-time)
allergies[].recorded_by	string (uuid) \| null
allergies[].resolved_at	string (date-time) \| null
allergies[].version	integer
recent_encounters	array<object>
recent_encounters[].id	string (uuid)
recent_encounters[].branch_id	string (uuid)
recent_encounters[].registered_at	string (date-time)
recent_encounters[].status	string
recent_encounters[].unit_name	string
recent_encounters[].practitioner_name	string \| null
recent_encounters[].chief_complaint	string \| null
recent_encounters[].primary_diagnosis	object \| null
recent_encounters[].primary_diagnosis.code	string
recent_encounters[].primary_diagnosis.display	string
diagnoses	array<object>
diagnoses[].code	string
diagnoses[].display	string
diagnoses[].count	integer
diagnoses[].last_seen	string (date-time)
procedures	array<object>
procedures[].id	string (uuid)
procedures[].encounter_id	string (uuid)
procedures[].patient_id	string (uuid)
procedures[].icd9cm_code	string \| null
procedures[].display	string \| null
procedures[].service_id	string (uuid) \| null
procedures[].service_name	string \| null
procedures[].quantity	number
procedures[].practitioner_id	string (uuid) \| null
procedures[].charge_id	string (uuid) \| null
procedures[].status	string
procedures[].notes	string \| null
procedures[].performed_at	string (date-time)
vitals_trend	object

Errors

401unauthorizedToken tidak ada, tidak valid, kedaluwarsa, atau dicabut
402module-lockedModul tidak aktif di paket organisasi
403forbiddenconfidential-recordScope tidak memberi izin (forbidden), rekam medis ditandai rahasia (confidential-record), atau baca-saja (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/patients/{id}/documents

Dokumen pasien (termasuk dokumen kunjungan)

Scopes: encounters:readpatients:write(any one of)
RBAC permissions: encounter.read · patient.write
Module: frontoffice

Parameters

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

Code examples

curlJavaScriptPython

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

const res = await fetch("https://api.medivana.cloud/api/v1/patients/3f0c2a10-5b7e-4c1d-9a2e-000000000001/documents", {
  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/patients/3f0c2a10-5b7e-4c1d-9a2e-000000000001/documents",
    headers={"Authorization": f"Bearer {os.environ['MEDIVANA_TOKEN']}"},
    timeout=30,
)
resp.raise_for_status()
data = resp.json()

Responses

200Dokumenapplication/json

{
  "items": [
    {
      "id": "3f0c2a10-5b7e-4c1d-9a2e-0000000a6001",
      "patient_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000a0001",
      "encounter_id": null,
      "file_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000a6101",
      "title": "Hasil lab luar",
      "category": "lab_external",
      "notes": null,
      "filename": "hasil-lab.pdf",
      "content_type": "application/pdf",
      "size_bytes": 182311,
      "uploaded_by": "3f0c2a10-5b7e-4c1d-9a2e-000000000a11",
      "created_at": "2026-10-29T08:40:00+07:00",
      "download_url": "/api/v1/clinical-documents/3f0c2a10-5b7e-4c1d-9a2e-0000000a6001/download"
    }
  ]
}

Schema 200

Schema 200
Name	Type	Description
itemsrequired	array<object>
items[].id	string (uuid)
items[].patient_id	string (uuid)
items[].encounter_id	string (uuid) \| null
items[].file_id	string (uuid)
items[].title	string
items[].category	general \| lab_external \| imaging \| referral \| consent \| photo \| identity \| other
items[].notes	string \| null
items[].filename	string
items[].content_type	string
items[].size_bytes	integer
items[].uploaded_by	string (uuid) \| null
items[].created_at	string (date-time)
items[].download_url	string	Path relatif `GET /clinical-documents/{id}/download`

Errors

401unauthorizedToken tidak ada, tidak valid, kedaluwarsa, atau dicabut
402module-lockedModul tidak aktif di paket organisasi
403forbiddenconfidential-recordScope tidak memberi izin (forbidden), rekam medis ditandai rahasia (confidential-record), atau baca-saja (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

POST/patients/{id}/documents

Unggah dokumen pasien

multipart/form-data, maks 20 MB. Tipe: PDF, JPG, PNG, WEBP, audio, DICOM, CSV, ZIP, JSON. file_id hasil unggahan bisa dipakai sebagai bukti consent di aplikasi.

Scopes: patients:write
RBAC permissions: encounter.write · patient.write
Module: frontoffice
X-Branch-ID: X-Branch-ID required

Parameters

Parameters POST /patients/{id}/documents
Name	In	Type	Description
idrequired	path	string (uuid)
X-Branch-IDrequired	header	string (uuid)	Cabang aktif. Wajib kecuali klien API hanya punya satu cabang (dipakai otomatis); tanpa cabang aktif → `400`.

Request body `multipart/form-data`

Request body POST /patients/{id}/documents
Name	Type	Description
filerequired	string (binary)
title	string	Default nama berkas
category	general \| lab_external \| imaging \| referral \| consent \| photo \| identity \| other
notes	string

Code examples

curlJavaScriptPython

curl -X POST "https://api.medivana.cloud/api/v1/patients/3f0c2a10-5b7e-4c1d-9a2e-000000000001/documents" \
  -H "Authorization: Bearer $MEDIVANA_TOKEN" \
  -H "X-Branch-ID: $MEDIVANA_BRANCH_ID" \
  -F "file=@dokumen.pdf" \
  -F 'title=…' \
  -F 'category=…' \
  -F 'notes=…'

import { readFile } from "node:fs/promises";

const form = new FormData();
form.append("file", new Blob([await readFile("dokumen.pdf")]), "dokumen.pdf");
form.append("title", "…");
form.append("category", "…");
form.append("notes", "…");
const res = await fetch("https://api.medivana.cloud/api/v1/patients/3f0c2a10-5b7e-4c1d-9a2e-000000000001/documents", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.MEDIVANA_TOKEN}`,
    "X-Branch-ID": process.env.MEDIVANA_BRANCH_ID,
  },
  body: form,
});
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/patients/3f0c2a10-5b7e-4c1d-9a2e-000000000001/documents",
    headers={
        "Authorization": f"Bearer {os.environ['MEDIVANA_TOKEN']}",
        "X-Branch-ID": os.environ["MEDIVANA_BRANCH_ID"],
    },
    files={"file": open("dokumen.pdf", "rb")},
    data={"title": "…", "category": "…", "notes": "…"},
    timeout=30,
)
resp.raise_for_status()
data = resp.json()

Responses

201Dokumen dibuatapplication/json

{
  "id": "3f0c2a10-5b7e-4c1d-9a2e-0000000a6001",
  "patient_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000a0001",
  "encounter_id": null,
  "file_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000a6101",
  "title": "Hasil lab luar",
  "category": "lab_external",
  "notes": null,
  "filename": "hasil-lab.pdf",
  "content_type": "application/pdf",
  "size_bytes": 182311,
  "uploaded_by": "3f0c2a10-5b7e-4c1d-9a2e-000000000a11",
  "created_at": "2026-10-29T08:40:00+07:00",
  "download_url": "/api/v1/clinical-documents/3f0c2a10-5b7e-4c1d-9a2e-0000000a6001/download"
}

Schema 201

Schema 201
Name	Type	Description
id	string (uuid)
patient_id	string (uuid)
encounter_id	string (uuid) \| null
file_id	string (uuid)
title	string
category	general \| lab_external \| imaging \| referral \| consent \| photo \| identity \| other
notes	string \| null
filename	string
content_type	string
size_bytes	integer
uploaded_by	string (uuid) \| null
created_at	string (date-time)
download_url	string	Path relatif `GET /clinical-documents/{id}/download`

Errors

400bad-requestCabang aktif belum dipilih (X-Branch-ID)
401unauthorizedToken tidak ada, tidak valid, kedaluwarsa, atau dicabut
402module-lockedModul tidak aktif di paket organisasi
403forbiddenconfidential-recordScope tidak memberi izin (forbidden), rekam medis ditandai rahasia (confidential-record), atau baca-saja (read-only)
404not-foundData tidak ada, milik organisasi lain, atau di luar cakupan cabang klien
422validationValidasi gagal; rincian per field di errors
429rate-limitedBatas laju klien (rate_limit_per_min) terlampaui; coba lagi pada menit berikutnya

GET/clinical-documents/{id}/download

Unduh isi dokumen klinis

Isi berkas apa adanya (Content-Disposition: inline). Diaudit document.read.

Scopes: encounters:readpatients:write(any one of)
RBAC permissions: encounter.read · patient.write
Module: frontoffice

Parameters

Parameters GET /clinical-documents/{id}/download
Name	In	Type	Description
idrequired	path	string (uuid)

Code examples

curlJavaScriptPython

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

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

import os
import requests

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

Responses

200Isi berkasapplication/octet-stream

Errors

401unauthorizedToken tidak ada, tidak valid, kedaluwarsa, atau dicabut
402module-lockedModul tidak aktif di paket organisasi
403forbiddenconfidential-recordScope tidak memberi izin (forbidden), rekam medis ditandai rahasia (confidential-record), atau baca-saja (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

DELETE/clinical-documents/{id}

Hapus dokumen klinis (soft delete)

Dokumen kunjungan yang sudah ditandatangani tidak bisa dihapus (409).

Scopes: patients:write
RBAC permissions: encounter.write · patient.write
Module: frontoffice
X-Branch-ID: X-Branch-ID required

Parameters

Parameters DELETE /clinical-documents/{id}
Name	In	Type	Description
idrequired	path	string (uuid)
X-Branch-IDrequired	header	string (uuid)	Cabang aktif. Wajib kecuali klien API hanya punya satu cabang (dipakai otomatis); tanpa cabang aktif → `400`.

Code examples

curlJavaScriptPython

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

const res = await fetch("https://api.medivana.cloud/api/v1/clinical-documents/3f0c2a10-5b7e-4c1d-9a2e-000000000001", {
  method: "DELETE",
  headers: {
    Authorization: `Bearer ${process.env.MEDIVANA_TOKEN}`,
    "X-Branch-ID": process.env.MEDIVANA_BRANCH_ID,
  },
});
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/clinical-documents/3f0c2a10-5b7e-4c1d-9a2e-000000000001",
    headers={
        "Authorization": f"Bearer {os.environ['MEDIVANA_TOKEN']}",
        "X-Branch-ID": os.environ["MEDIVANA_BRANCH_ID"],
    },
    timeout=30,
)
resp.raise_for_status()

Responses

204Dihapus

Errors

400bad-requestCabang aktif belum dipilih (X-Branch-ID)
401unauthorizedToken tidak ada, tidak valid, kedaluwarsa, atau dicabut
402module-lockedModul tidak aktif di paket organisasi
403forbiddenconfidential-recordScope tidak memberi izin (forbidden), rekam medis ditandai rahasia (confidential-record), atau baca-saja (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

Patients

Cari atau daftar pasien

Parameters

Code examples

Responses

Errors

Daftarkan pasien baru

Parameters

Request body application/json

Code examples

Responses

Errors

Periksa kemungkinan pasien ganda

Parameters

Code examples

Responses

Errors

Cari NIK di data lokal lalu SATUSEHAT

Request body application/json

Code examples

Responses

Errors

Format nomor rekam medis

Code examples

Responses

Errors

Detail pasien

Parameters

Code examples

Responses

Errors

Ubah data pasien

Parameters

Request body application/json

Code examples

Responses

Errors

Lookup ulang IHS number SATUSEHAT dari NIK tersimpan

Parameters

Code examples

Responses

Errors

Riwayat penggabungan pasien

Parameters

Code examples

Responses

Errors

Consent pasien (terkini per jenis dan riwayat)

Parameters

Code examples

Responses

Errors

Alergi pasien

Parameters

Code examples

Responses

Errors

Riwayat klinis ringkas pasien

Parameters

Code examples

Responses

Errors

Dokumen pasien (termasuk dokumen kunjungan)

Parameters

Code examples

Responses

Errors

Unggah dokumen pasien

Parameters

Request body multipart/form-data

Code examples

Responses

Errors

Unduh isi dokumen klinis

Parameters

Code examples

Responses

Errors

Hapus dokumen klinis (soft delete)

Parameters

Request body `application/json`

Request body `application/json`

Request body `application/json`

Request body `multipart/form-data`