Referensi API

Surat

Surat keterangan sakit, rujukan, dan sehat yang sudah diterbitkan (modul rme).

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

Unduh YAML Unduh JSON Panduan mulai

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

GET/letters

Surat yang diterbitkan untuk pasien atau kunjungan

Salah satu dari patient_id atau encounter_id wajib. Tanpa content_html.

Scope: encounters:read
Izin RBAC: encounter.read · letter.write
Modul: rme

Parameter

Parameter GET /letters
Nama	Lokasi	Tipe	Keterangan
patient_id	query	string (uuid)
encounter_id	query	string (uuid)

Contoh kode

curlJavaScriptPython

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

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

Respons

200Suratapplication/json

{
  "items": [
    {
      "id": "3f0c2a10-5b7e-4c1d-9a2e-000000004001",
      "branch_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000000b1",
      "patient_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000a0001",
      "encounter_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000e0001",
      "kind": "sick_leave",
      "number": "001/SKS/X/2026",
      "title": "Surat Keterangan Sakit",
      "data": {
        "rest_days": 3,
        "start_date": "2026-10-29"
      },
      "paper_size": "A5",
      "status": "issued",
      "issued_at": "2026-10-29T10:50:00+07:00",
      "issued_by_name": "dr. Rina Contoh",
      "void_reason": null,
      "print_url": "/api/v1/letters/3f0c2a10-5b7e-4c1d-9a2e-000000004001/print",
      "patient_name": "Pasien Contoh",
      "patient_mrn": "RM-000123"
    }
  ]
}

Skema 200

Skema 200
Nama	Tipe	Keterangan
itemswajib	array<object>
items[].id	string (uuid)
items[].branch_id	string (uuid)
items[].patient_id	string (uuid)
items[].encounter_id	string (uuid) \| null
items[].template_id	string (uuid) \| null
items[].kind	sick_leave \| referral \| health_certificate \| other
items[].number	string
items[].title	string
items[].data	object
items[].paper_size	A4 \| A5
items[].status	issued \| void
items[].issued_at	string (date-time)
items[].issued_by	string (uuid) \| null
items[].issued_by_name	string \| null
items[].void_reason	string \| null
items[].print_url	string
items[].patient_name	string
items[].patient_mrn	string

Galat

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/letters/{id}

Detail surat

Scope: encounters:read
Izin RBAC: encounter.read · letter.write
Modul: rme

Parameter

Parameter GET /letters/{id}
Nama	Lokasi	Tipe	Keterangan
idwajib	path	string (uuid)

Contoh kode

curlJavaScriptPython

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

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

Respons

200Surat (tanpa content_html)application/json

{
  "id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "branch_id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "patient_id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "encounter_id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "template_id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "kind": "sick_leave",
  "number": "string",
  "title": "string",
  "data": {},
  "paper_size": "A4",
  "status": "issued",
  "issued_at": "2026-11-02T08:00:00+07:00",
  "issued_by": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "issued_by_name": "string",
  "void_reason": "string",
  "print_url": "string",
  "patient_name": "string",
  "patient_mrn": "string"
}

Skema 200

Skema 200
Nama	Tipe	Keterangan
id	string (uuid)
branch_id	string (uuid)
patient_id	string (uuid)
encounter_id	string (uuid) \| null
template_id	string (uuid) \| null
kind	sick_leave \| referral \| health_certificate \| other
number	string
title	string
data	object
paper_size	A4 \| A5
status	issued \| void
issued_at	string (date-time)
issued_by	string (uuid) \| null
issued_by_name	string \| null
void_reason	string \| null
print_url	string
patient_name	string
patient_mrn	string

Galat

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/letters/{id}/print

Halaman cetak surat (HTML)

HTML siap cetak (@page A5/A4). Surat void diberi watermark DIBATALKAN. Bahasa mengikuti snapshot surat. Diaudit letter.print.

Scope: encounters:read
Izin RBAC: encounter.read · letter.write
Modul: rme

Parameter

Parameter GET /letters/{id}/print
Nama	Lokasi	Tipe	Keterangan
idwajib	path	string (uuid)

Contoh kode

curlJavaScriptPython

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

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

import os
import requests

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

Respons

200Dokumen HTMLtext/html

Galat

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