API reference

Encounters

Pendaftaran kunjungan dan isi rekam medis elektronik rawat jalan (modul frontoffice/rme).

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/registration/payers

Penjamin aktif untuk pendaftaran kunjungan

Umum dulu, lalu BPJS, asuransi, perusahaan. id dipakai sebagai payer_id di POST /encounters.

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

Code examples

curlJavaScriptPython

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

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

Responses

200Penjaminapplication/json

{
  "items": [
    {
      "id": "3f0c2a10-5b7e-4c1d-9a2e-0000000f0001",
      "code": "UMUM",
      "name": "Pasien Umum",
      "kind": "umum"
    },
    {
      "id": "3f0c2a10-5b7e-4c1d-9a2e-0000000f0002",
      "code": "BPJS",
      "name": "BPJS Kesehatan",
      "kind": "bpjs"
    }
  ]
}

Schema 200

Schema 200
Name	Type	Description
itemsrequired	array<object>
items[].id	string (uuid)
items[].code	string
items[].name	string
items[].kind	umum \| bpjs \| insurance \| company

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

Daftar kunjungan

Difilter ke cabang aktif, terbaru dulu. date default hari ini (Asia/Jakarta) dan diabaikan bila hanya patient_id yang dikirim (riwayat semua tanggal).

Scopes: encounters:read
RBAC permissions: encounter.read · queue.manage
Module: frontoffice | rme

Parameters

Parameters GET /encounters
Name	In	Type	Description
X-Branch-ID	header	string (uuid)	Cabang aktif (opsional). Nilai di luar cabang klien diabaikan.
date	query	string (date)
patient_id	query	string (uuid)
unit_id	query	string (uuid)
payer_id	query	string (uuid)
practitioner_id	query	string (uuid)
status	query	string	Dipisah koma: registered, in_progress, finished, cancelled
limit	query	integer
cursor	query	string	Nilai `next_cursor` dari halaman sebelumnya

Code examples

curlJavaScriptPython

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

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

Responses

200Kunjunganapplication/json

{
  "items": [
    {
      "id": "3f0c2a10-5b7e-4c1d-9a2e-0000000e0001",
      "branch_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000000b1",
      "patient_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000a0001",
      "unit_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000c0001",
      "unit_name": "Poli Umum",
      "practitioner_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000d0001",
      "practitioner_name": "dr. Rina Contoh",
      "payer_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000f0001",
      "payer_name": "Pasien Umum",
      "payer_kind": "umum",
      "kind": "rawat_jalan",
      "status": "in_progress",
      "queue_label": "U-003",
      "chief_complaint": "Batuk pilek 3 hari",
      "registered_at": "2026-10-29T08:30:00+07:00",
      "started_at": "2026-10-29T09:02:00+07:00",
      "finished_at": null,
      "version": 3
    }
  ],
  "next_cursor": "eyJ0IjoiMjAyNi0xMC0yOVQwODozMDowMCswNzowMCJ9"
}

Schema 200

Schema 200
Name	Type	Description
itemsrequired	array<object>
items[].id	string (uuid)
items[].branch_id	string (uuid)
items[].patient_id	string (uuid)
items[].unit_id	string (uuid)
items[].unit_name	string
items[].unit_specialty	string \| null
items[].practitioner_id	string (uuid) \| null
items[].practitioner_name	string \| null
items[].payer_id	string (uuid)
items[].payer_name	string
items[].payer_kind	umum \| bpjs \| insurance \| company
items[].payer_reference	string \| null
items[].kind	rawat_jalan \| telekonsultasi \| kunjungan_sehat
items[].status	registered \| in_progress \| finished \| cancelled
items[].appointment_id	string (uuid) \| null
items[].queue_id	string (uuid) \| null
items[].queue_label	string \| null
items[].queue_status	string \| null
items[].chief_complaint	string \| null
items[].anamnesis	object
items[].registered_at	string (date-time)
items[].started_at	string (date-time) \| null
items[].finished_at	string (date-time) \| null
items[].cancelled_at	string (date-time) \| null
items[].cancel_reason	string \| null
items[].version	integer
items[].patient	object
items[].patient.id	string (uuid)
items[].patient.name	string
items[].patient.mrn	string
items[].patient.sex	male \| female
items[].patient.birth_date	string (date) \| null
items[].patient.age_label	string
items[].patient.age_years	integer \| null
items[].patient.allergy_status	unknown \| none \| has
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/encounters

Daftarkan kunjungan dan terbitkan nomor antrean

Wajib patient_id dan unit_id (unit poli/tindakan di cabang aktif). payer_id dari GET /registration/payers; kosong → Pasien Umum. registration_fee: null = otomatis (biaya pendaftaran untuk penjamin umum). Pasien yang sudah terdaftar aktif di poli yang sama hari ini → 409. Menerbitkan event encounter.started.

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

Parameters

Parameters POST /encounters
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 /encounters
Name	Type	Description
patient_idrequired	string (uuid)
unit_idrequired	string (uuid)
practitioner_id	string (uuid) \| null
payer_id	string (uuid) \| null
payer_reference	string \| null	No. SEP/polis/jaminan
kind	rawat_jalan \| telekonsultasi \| kunjungan_sehat
priority	normal \| priority
chief_complaint	string \| null
appointment_id	string (uuid) \| null
registration_fee	boolean \| null

{
  "patient_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000a0001",
  "unit_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000c0001",
  "practitioner_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000d0001",
  "payer_id": null,
  "kind": "rawat_jalan",
  "priority": "normal",
  "chief_complaint": "Demam 2 hari"
}

Code examples

curlJavaScriptPython

curl -X POST "https://api.medivana.cloud/api/v1/encounters" \
  -H "Authorization: Bearer $MEDIVANA_TOKEN" \
  -H "X-Branch-ID: $MEDIVANA_BRANCH_ID" \
  -H "Content-Type: application/json" \
  -d '{"patient_id":"3f0c2a10-5b7e-4c1d-9a2e-0000000a0001","unit_id":"3f0c2a10-5b7e-4c1d-9a2e-0000000c0001","practitioner_id":"3f0c2a10-5b7e-4c1d-9a2e-0000000d0001","payer_id":null,"kind":"rawat_jalan","priority":"normal","chief_complaint":"Demam 2 hari"}'

const res = await fetch("https://api.medivana.cloud/api/v1/encounters", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.MEDIVANA_TOKEN}`,
    "X-Branch-ID": process.env.MEDIVANA_BRANCH_ID,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    patient_id: "3f0c2a10-5b7e-4c1d-9a2e-0000000a0001",
    unit_id: "3f0c2a10-5b7e-4c1d-9a2e-0000000c0001",
    practitioner_id: "3f0c2a10-5b7e-4c1d-9a2e-0000000d0001",
    payer_id: null,
    kind: "rawat_jalan",
    priority: "normal",
    chief_complaint: "Demam 2 hari",
  }),
});
if (!res.ok) throw new Error(`HTTP ${res.status}: ${await res.text()}`);

import os
import requests

resp = requests.post(
    "https://api.medivana.cloud/api/v1/encounters",
    headers={
        "Authorization": f"Bearer {os.environ['MEDIVANA_TOKEN']}",
        "X-Branch-ID": os.environ["MEDIVANA_BRANCH_ID"],
    },
    json={
        "patient_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000a0001",
        "unit_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000c0001",
        "practitioner_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000d0001",
        "payer_id": None,
        "kind": "rawat_jalan",
        "priority": "normal",
        "chief_complaint": "Demam 2 hari",
    },
    timeout=30,
)
resp.raise_for_status()

Responses

200Dengan appointment_id yang sudah check-in: kunjungan yang sudah ada (idempoten)

201Kunjungan dan tiket antrean dibuatapplication/json

{
  "encounter": {
    "id": "3f0c2a10-5b7e-4c1d-9a2e-0000000e0001",
    "branch_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000000b1",
    "patient_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000a0001",
    "unit_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000c0001",
    "unit_name": "Poli Umum",
    "payer_kind": "umum",
    "kind": "rawat_jalan",
    "status": "registered",
    "chief_complaint": "Demam 2 hari",
    "registered_at": "2026-10-29T08:30:00+07:00",
    "version": 1
  },
  "queue": {
    "id": "3f0c2a10-5b7e-4c1d-9a2e-000000005001",
    "unit_name": "Poli Umum",
    "label": "U-003",
    "number": 3,
    "status": "waiting",
    "priority": "normal",
    "source": "registration",
    "service_date": "2026-10-29"
  }
}

Schema 201

Schema 201
Name	Type	Description
encounter	object
encounter.id	string (uuid)
encounter.branch_id	string (uuid)
encounter.patient_id	string (uuid)
encounter.unit_id	string (uuid)
encounter.unit_name	string
encounter.unit_specialty	string \| null
encounter.practitioner_id	string (uuid) \| null
encounter.practitioner_name	string \| null
encounter.payer_id	string (uuid)
encounter.payer_name	string
encounter.payer_kind	umum \| bpjs \| insurance \| company
encounter.payer_reference	string \| null
encounter.kind	rawat_jalan \| telekonsultasi \| kunjungan_sehat
encounter.status	registered \| in_progress \| finished \| cancelled
encounter.appointment_id	string (uuid) \| null
encounter.queue_id	string (uuid) \| null
encounter.queue_label	string \| null
encounter.queue_status	string \| null
encounter.chief_complaint	string \| null
encounter.anamnesis	object
encounter.registered_at	string (date-time)
encounter.started_at	string (date-time) \| null
encounter.finished_at	string (date-time) \| null
encounter.cancelled_at	string (date-time) \| null
encounter.cancel_reason	string \| null
encounter.version	integer
encounter.patient	object
encounter.patient.id	string (uuid)
encounter.patient.name	string
encounter.patient.mrn	string
encounter.patient.sex	male \| female
encounter.patient.birth_date	string (date) \| null
encounter.patient.age_label	string
encounter.patient.age_years	integer \| null
encounter.patient.allergy_status	unknown \| none \| has
queue	object
queue.id	string (uuid)
queue.branch_id	string (uuid)
queue.unit_id	string (uuid)
queue.unit_name	string
queue.patient_id	string (uuid) \| null
queue.encounter_id	string (uuid) \| null
queue.appointment_id	string (uuid) \| null
queue.service_date	string (date)
queue.number	integer
queue.label	string
queue.status	waiting \| called \| in_service \| pharmacy \| cashier \| done \| cancelled
queue.priority	normal \| priority
queue.source	registration \| appointment \| kiosk
queue.call_count	integer
queue.created_at	string (date-time)
queue.version	integer

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

Detail kunjungan lengkap (RME)

Kunjungan beserta catatan SOAP, tanda vital, diagnosis, tindakan, alergi aktif, tanda tangan, dokumen, dan surat. Diaudit encounter.read.

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

Parameters

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

Code examples

curlJavaScriptPython

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

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

Responses

200Kunjungan lengkapapplication/json

{
  "id": "3f0c2a10-5b7e-4c1d-9a2e-0000000e0001",
  "patient_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000a0001",
  "unit_name": "Poli Umum",
  "status": "finished",
  "kind": "rawat_jalan",
  "chief_complaint": "Batuk pilek 3 hari",
  "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"
  },
  "note": {
    "id": "3f0c2a10-5b7e-4c1d-9a2e-000000006001",
    "subjective": "Batuk pilek 3 hari, demam ringan.",
    "objective": "T 37,8 °C, faring hiperemis.",
    "assessment": "ISPA",
    "plan": "Simtomatik, kontrol bila memburuk.",
    "status": "signed",
    "version": 1
  },
  "vitals": [
    {
      "key": "temperature",
      "code": "8310-5",
      "display": "Suhu tubuh",
      "value_num": 37.8,
      "unit": "Cel",
      "flag": "H",
      "observed_at": "2026-10-29T09:05:00+07:00"
    }
  ],
  "diagnoses": [
    {
      "icd10_code": "J06.9",
      "display": "Infeksi saluran napas atas akut, tidak spesifik",
      "is_primary": true,
      "kind": "new",
      "rank": 1
    }
  ],
  "procedures": [],
  "allergies": [],
  "signatures": [
    {
      "kind": "close",
      "note_version": 1,
      "signer_name": "dr. Rina Contoh",
      "signed_at": "2026-10-29T10:45:00+07:00"
    }
  ],
  "documents": [],
  "letters": [],
  "version": 4
}

Schema 200

Schema 200
Name	Type	Description
id	string (uuid)
branch_id	string (uuid)
patient_id	string (uuid)
unit_id	string (uuid)
unit_name	string
unit_specialty	string \| null
practitioner_id	string (uuid) \| null
practitioner_name	string \| null
payer_id	string (uuid)
payer_name	string
payer_kind	umum \| bpjs \| insurance \| company
payer_reference	string \| null
kind	rawat_jalan \| telekonsultasi \| kunjungan_sehat
status	registered \| in_progress \| finished \| cancelled
appointment_id	string (uuid) \| null
queue_id	string (uuid) \| null
queue_label	string \| null
queue_status	string \| null
chief_complaint	string \| null
anamnesis	object
registered_at	string (date-time)
started_at	string (date-time) \| null
finished_at	string (date-time) \| null
cancelled_at	string (date-time) \| null
cancel_reason	string \| null
version	integer
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
note	object \| null
vitals	array<object>
vitals[].id	string (uuid)
vitals[].encounter_id	string (uuid)
vitals[].patient_id	string (uuid)
vitals[].panel_id	string (uuid) \| null
vitals[].key	string (12 nilai)
vitals[].code	string	LOINC
vitals[].display	string
vitals[].value_num	number \| null
vitals[].value_text	string \| null
vitals[].unit	string \| null	UCUM
vitals[].flag	N \| L \| H \| LL \| HH \| null
vitals[].status	final \| entered_in_error
vitals[].observed_at	string (date-time)
vitals[].recorded_by	string (uuid) \| null
diagnoses	array<object>
diagnoses[].id	string (uuid)
diagnoses[].encounter_id	string (uuid)
diagnoses[].patient_id	string (uuid)
diagnoses[].icd10_code	string
diagnoses[].display	string
diagnoses[].is_primary	boolean
diagnoses[].kind	new \| old
diagnoses[].rank	integer
diagnoses[].notes	string \| null
diagnoses[].created_at	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)
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
signatures	array<object>
signatures[].id	string (uuid)
signatures[].encounter_id	string (uuid)
signatures[].note_id	string (uuid)
signatures[].note_version	integer
signatures[].kind	close \| correction
signatures[].content_hash	string	SHA-256 konten kanonik
signatures[].signer_membership_id	string (uuid)
signatures[].signer_name	string
signatures[].method	string
signatures[].reason	string \| null
signatures[].signed_at	string (date-time)
documents	array<object>
documents[].id	string (uuid)
documents[].patient_id	string (uuid)
documents[].encounter_id	string (uuid) \| null
documents[].file_id	string (uuid)
documents[].title	string
documents[].category	general \| lab_external \| imaging \| referral \| consent \| photo \| identity \| other
documents[].notes	string \| null
documents[].filename	string
documents[].content_type	string
documents[].size_bytes	integer
documents[].uploaded_by	string (uuid) \| null
documents[].created_at	string (date-time)
documents[].download_url	string	Path relatif `GET /clinical-documents/{id}/download`
letters	array<object>
letters[].id	string (uuid)
letters[].branch_id	string (uuid)
letters[].patient_id	string (uuid)
letters[].encounter_id	string (uuid) \| null
letters[].template_id	string (uuid) \| null
letters[].kind	sick_leave \| referral \| health_certificate \| other
letters[].number	string
letters[].title	string
letters[].data	object
letters[].paper_size	A4 \| A5
letters[].status	issued \| void
letters[].issued_at	string (date-time)
letters[].issued_by	string (uuid) \| null
letters[].issued_by_name	string \| null
letters[].void_reason	string \| null
letters[].print_url	string
letters[].patient_name	string
letters[].patient_mrn	string

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

Batalkan kunjungan

Membatalkan charge yang belum ditagih dan tiket antreannya. Kunjungan selesai/batal atau dengan charge yang sudah ditagih → 409. Menerbitkan event encounter.cancelled.

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

Parameters

Parameters POST /encounters/{id}/cancel
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 `application/json`

Request body POST /encounters/{id}/cancel
Name	Type	Description
reasonrequired	string

{
  "reason": "Pasien pulang sebelum diperiksa"
}

Code examples

curlJavaScriptPython

curl -X POST "https://api.medivana.cloud/api/v1/encounters/3f0c2a10-5b7e-4c1d-9a2e-000000000001/cancel" \
  -H "Authorization: Bearer $MEDIVANA_TOKEN" \
  -H "X-Branch-ID: $MEDIVANA_BRANCH_ID" \
  -H "Content-Type: application/json" \
  -d '{"reason":"Pasien pulang sebelum diperiksa"}'

const res = await fetch("https://api.medivana.cloud/api/v1/encounters/3f0c2a10-5b7e-4c1d-9a2e-000000000001/cancel", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.MEDIVANA_TOKEN}`,
    "X-Branch-ID": process.env.MEDIVANA_BRANCH_ID,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    reason: "Pasien pulang sebelum diperiksa",
  }),
});
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/encounters/3f0c2a10-5b7e-4c1d-9a2e-000000000001/cancel",
    headers={
        "Authorization": f"Bearer {os.environ['MEDIVANA_TOKEN']}",
        "X-Branch-ID": os.environ["MEDIVANA_BRANCH_ID"],
    },
    json={
        "reason": "Pasien pulang sebelum diperiksa",
    },
    timeout=30,
)
resp.raise_for_status()
data = resp.json()

Responses

200Kunjungan dibatalkanapplication/json

{
  "id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "branch_id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "patient_id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "unit_id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "unit_name": "string",
  "unit_specialty": "string",
  "practitioner_id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "practitioner_name": "string",
  "payer_id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "payer_name": "string",
  "payer_kind": "umum",
  "payer_reference": "string",
  "kind": "rawat_jalan",
  "status": "registered",
  "appointment_id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "queue_id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
  "queue_label": "string",
  "queue_status": "string",
  "chief_complaint": "string",
  "anamnesis": {},
  "registered_at": "2026-11-02T08:00:00+07:00",
  "started_at": "2026-11-02T08:00:00+07:00",
  "finished_at": "2026-11-02T08:00:00+07:00",
  "cancelled_at": "2026-11-02T08:00:00+07:00",
  "cancel_reason": "string",
  "version": 0,
  "patient": {
    "id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
    "name": "string",
    "mrn": "string",
    "sex": "male",
    "birth_date": "2026-11-02",
    "age_label": "string",
    "age_years": 0,
    "allergy_status": "unknown"
  }
}

Schema 200

Schema 200
Name	Type	Description
id	string (uuid)
branch_id	string (uuid)
patient_id	string (uuid)
unit_id	string (uuid)
unit_name	string
unit_specialty	string \| null
practitioner_id	string (uuid) \| null
practitioner_name	string \| null
payer_id	string (uuid)
payer_name	string
payer_kind	umum \| bpjs \| insurance \| company
payer_reference	string \| null
kind	rawat_jalan \| telekonsultasi \| kunjungan_sehat
status	registered \| in_progress \| finished \| cancelled
appointment_id	string (uuid) \| null
queue_id	string (uuid) \| null
queue_label	string \| null
queue_status	string \| null
chief_complaint	string \| null
anamnesis	object
registered_at	string (date-time)
started_at	string (date-time) \| null
finished_at	string (date-time) \| null
cancelled_at	string (date-time) \| null
cancel_reason	string \| null
version	integer
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

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
422validationValidasi gagal; rincian per field di errors
429rate-limitedBatas laju klien (rate_limit_per_min) terlampaui; coba lagi pada menit berikutnya

GET/encounters/{id}/vitals

Tanda vital kunjungan (LOINC + UCUM)

latest = nilai terakhir per kunci. flag: N, L/H (rendah/tinggi), LL/HH (kritis), null (tidak dinilai).

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

Parameters

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

Code examples

curlJavaScriptPython

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

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

Responses

200Observasiapplication/json

{
  "items": [
    {
      "id": "3f0c2a10-5b7e-4c1d-9a2e-000000007001",
      "encounter_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000e0001",
      "patient_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000a0001",
      "panel_id": "3f0c2a10-5b7e-4c1d-9a2e-000000007101",
      "key": "systolic",
      "code": "8480-6",
      "display": "Tekanan darah sistolik",
      "value_num": 150,
      "value_text": null,
      "unit": "mm[Hg]",
      "flag": "H",
      "status": "final",
      "observed_at": "2026-10-29T09:05:00+07:00",
      "recorded_by": "3f0c2a10-5b7e-4c1d-9a2e-0000000d1001"
    }
  ],
  "latest": {
    "systolic": {
      "key": "systolic",
      "code": "8480-6",
      "value_num": 150,
      "unit": "mm[Hg]",
      "flag": "H"
    }
  }
}

Schema 200

Schema 200
Name	Type	Description
items	array<object>
items[].id	string (uuid)
items[].encounter_id	string (uuid)
items[].patient_id	string (uuid)
items[].panel_id	string (uuid) \| null
items[].key	string (12 nilai)
items[].code	string	LOINC
items[].display	string
items[].value_num	number \| null
items[].value_text	string \| null
items[].unit	string \| null	UCUM
items[].flag	N \| L \| H \| LL \| HH \| null
items[].status	final \| entered_in_error
items[].observed_at	string (date-time)
items[].recorded_by	string (uuid) \| null
latest	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/encounters/{id}/note

Catatan SOAP kunjungan

Bila belum ada catatan, respons adalah draf virtual dari template poli (id: null, is_new: true). version = versi klinis (naik saat koreksi setelah tanda tangan). Diaudit.

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

Parameters

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

Code examples

curlJavaScriptPython

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

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

Responses

200Catatanapplication/json

{
  "id": "3f0c2a10-5b7e-4c1d-9a2e-000000006001",
  "encounter_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000e0001",
  "template_id": "3f0c2a10-5b7e-4c1d-9a2e-000000006101",
  "subjective": "Batuk pilek 3 hari, demam ringan.",
  "objective": "T 37,8 °C, faring hiperemis.",
  "assessment": "ISPA",
  "plan": "Simtomatik, kontrol bila memburuk.",
  "extra": {},
  "status": "signed",
  "version": 1,
  "revision": 6,
  "signed_at": "2026-10-29T10:45:00+07:00",
  "signed_by": "3f0c2a10-5b7e-4c1d-9a2e-0000000d1001",
  "saved_at": "2026-10-29T10:42:13+07:00",
  "saved_at_label": "Tersimpan 10.42",
  "is_new": false
}

Schema 200

Schema 200
Name	Type	Description
id	string (uuid) \| null
encounter_id	string (uuid)
template_id	string (uuid) \| null
subjective	string \| null
objective	string \| null
assessment	string \| null
plan	string \| null
extra	object
status	draft \| signed
version	integer	Versi klinis
revision	integer	Penghitung simpan
signed_at	string (date-time) \| null
signed_by	string (uuid) \| null
saved_at	string (date-time) \| null
saved_at_label	string \| null
is_new	boolean

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/encounters/{id}/note/versions

Riwayat versi catatan yang sudah ditandatangani

Versi lama tidak pernah ditimpa (koreksi berversi, append-only). Diaudit.

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

Parameters

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

Code examples

curlJavaScriptPython

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

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

Responses

200Versi (urut naik)application/json

{
  "items": [
    {
      "id": "3f0c2a10-5b7e-4c1d-9a2e-000000006201",
      "version": 1,
      "subjective": "Batuk pilek 3 hari.",
      "objective": "T 37,8 °C.",
      "assessment": "ISPA",
      "plan": "Simtomatik",
      "extra": {},
      "content_hash": "9f2c4b1e0d8a7c6b5a49382716f5e4d3c2b1a09f8e7d6c5b4a3928171605f4e3",
      "reason": null,
      "signature_id": "3f0c2a10-5b7e-4c1d-9a2e-000000006301",
      "signer_name": "dr. Rina Contoh",
      "created_by": "3f0c2a10-5b7e-4c1d-9a2e-0000000d1001",
      "created_at": "2026-10-29T10:45:00+07:00"
    }
  ]
}

Schema 200

Schema 200
Name	Type	Description
itemsrequired	array<object>
items[].id	string (uuid)
items[].version	integer
items[].subjective	string \| null
items[].objective	string \| null
items[].assessment	string \| null
items[].plan	string \| null
items[].extra	object
items[].content_hash	string
items[].reason	string \| null	Alasan koreksi (null untuk versi 1)
items[].signature_id	string (uuid)
items[].signer_name	string
items[].created_by	string (uuid)
items[].created_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/encounters/{id}/diagnoses

Diagnosis ICD-10 kunjungan

Diagnosis utama dulu.

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

Parameters

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

Code examples

curlJavaScriptPython

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

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

Responses

200Diagnosisapplication/json

{
  "items": [
    {
      "id": "3f0c2a10-5b7e-4c1d-9a2e-000000008001",
      "encounter_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000e0001",
      "patient_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000a0001",
      "icd10_code": "J06.9",
      "display": "Infeksi saluran napas atas akut, tidak spesifik",
      "is_primary": true,
      "kind": "new",
      "rank": 1,
      "notes": null,
      "created_at": "2026-10-29T10:30:00+07:00"
    }
  ]
}

Schema 200

Schema 200
Name	Type	Description
itemsrequired	array<object>
items[].id	string (uuid)
items[].encounter_id	string (uuid)
items[].patient_id	string (uuid)
items[].icd10_code	string
items[].display	string
items[].is_primary	boolean
items[].kind	new \| old
items[].rank	integer
items[].notes	string \| null
items[].created_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/encounters/{id}/procedures

Tindakan ICD-9-CM kunjungan

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

Parameters

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

Code examples

curlJavaScriptPython

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

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

Responses

200Tindakanapplication/json

{
  "items": [
    {
      "id": "3f0c2a10-5b7e-4c1d-9a2e-000000008101",
      "encounter_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000e0001",
      "patient_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000a0001",
      "icd9cm_code": "93.94",
      "display": "Pemberian obat pernapasan dengan nebulizer",
      "service_id": "3f0c2a10-5b7e-4c1d-9a2e-00000001f001",
      "service_name": "Nebulisasi",
      "quantity": 1,
      "practitioner_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000d0001",
      "charge_id": "3f0c2a10-5b7e-4c1d-9a2e-000000009001",
      "status": "done",
      "notes": null,
      "performed_at": "2026-10-29T10:20:00+07:00"
    }
  ]
}

Schema 200

Schema 200
Name	Type	Description
itemsrequired	array<object>
items[].id	string (uuid)
items[].encounter_id	string (uuid)
items[].patient_id	string (uuid)
items[].icd9cm_code	string \| null
items[].display	string \| null
items[].service_id	string (uuid) \| null
items[].service_name	string \| null
items[].quantity	number
items[].practitioner_id	string (uuid) \| null
items[].charge_id	string (uuid) \| null
items[].status	string
items[].notes	string \| null
items[].performed_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/encounters/{id}/signatures

Tanda tangan elektronik kunjungan (penutupan dan koreksi)

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

Parameters

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

Code examples

curlJavaScriptPython

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

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

Responses

200Tanda tanganapplication/json

{
  "items": [
    {
      "id": "3f0c2a10-5b7e-4c1d-9a2e-000000006301",
      "encounter_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000e0001",
      "note_id": "3f0c2a10-5b7e-4c1d-9a2e-000000006001",
      "note_version": 1,
      "kind": "close",
      "content_hash": "9f2c4b1e0d8a7c6b5a49382716f5e4d3c2b1a09f8e7d6c5b4a3928171605f4e3",
      "signer_membership_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000d0001",
      "signer_name": "dr. Rina Contoh",
      "method": "internal",
      "reason": null,
      "signed_at": "2026-10-29T10:45:00+07:00"
    }
  ]
}

Schema 200

Schema 200
Name	Type	Description
itemsrequired	array<object>
items[].id	string (uuid)
items[].encounter_id	string (uuid)
items[].note_id	string (uuid)
items[].note_version	integer
items[].kind	close \| correction
items[].content_hash	string	SHA-256 konten kanonik
items[].signer_membership_id	string (uuid)
items[].signer_name	string
items[].method	string
items[].reason	string \| null
items[].signed_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/encounters/{id}/documents

Dokumen yang terkait kunjungan

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

Parameters

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

Code examples

curlJavaScriptPython

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

const res = await fetch("https://api.medivana.cloud/api/v1/encounters/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/encounters/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-000000000001",
      "patient_id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
      "encounter_id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
      "file_id": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
      "title": "string",
      "category": "general",
      "notes": "string",
      "filename": "string",
      "content_type": "string",
      "size_bytes": 0,
      "uploaded_by": "3f0c2a10-5b7e-4c1d-9a2e-000000000001",
      "created_at": "2026-11-02T08:00:00+07:00",
      "download_url": "string"
    }
  ]
}

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

GET/note-templates

Template catatan SOAP

Bawaan: SOAP-UMUM, SOAP-GIGI, SOAP-KIA, SOAP-ESTETIK, SOAP-FISIO. fields = isian terstruktur yang tersimpan di Note.extra.

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

Parameters

Parameters GET /note-templates
Name	In	Type
specialty	query	string
unit_id	query	string (uuid)
include_inactive	query	boolean

Code examples

curlJavaScriptPython

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

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

Responses

200Templateapplication/json

{
  "items": [
    {
      "id": "3f0c2a10-5b7e-4c1d-9a2e-000000006101",
      "code": "SOAP-GIGI",
      "name": "SOAP Poli Gigi",
      "specialty": "gigi",
      "unit_id": null,
      "subjective": "Keluhan utama:\n",
      "objective": "",
      "assessment": "",
      "plan": "",
      "fields": [
        {
          "key": "tooth_elements",
          "label": "Elemen gigi (FDI)",
          "type": "text"
        }
      ],
      "is_default": true,
      "is_active": true,
      "version": 1
    }
  ]
}

Schema 200

Schema 200
Name	Type	Description
itemsrequired	array<object>
items[].id	string (uuid)
items[].code	string
items[].name	string
items[].specialty	string \| null
items[].unit_id	string (uuid) \| null
items[].subjective	string
items[].objective	string
items[].assessment	string
items[].plan	string
items[].fields	array<object>
items[].is_default	boolean
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

Encounters

Penjamin aktif untuk pendaftaran kunjungan

Code examples

Responses

Errors

Daftar kunjungan

Parameters

Code examples

Responses

Errors

Daftarkan kunjungan dan terbitkan nomor antrean

Parameters

Request body application/json

Code examples

Responses

Errors

Detail kunjungan lengkap (RME)

Parameters

Code examples

Responses

Errors

Batalkan kunjungan

Parameters

Request body application/json

Code examples

Responses

Errors

Tanda vital kunjungan (LOINC + UCUM)

Parameters

Code examples

Responses

Errors

Catatan SOAP kunjungan

Parameters

Code examples

Responses

Errors

Riwayat versi catatan yang sudah ditandatangani

Parameters

Code examples

Responses

Errors

Diagnosis ICD-10 kunjungan

Parameters

Code examples

Responses

Errors

Tindakan ICD-9-CM kunjungan

Parameters

Code examples

Responses

Errors

Tanda tangan elektronik kunjungan (penutupan dan koreksi)

Parameters

Code examples

Responses

Errors

Dokumen yang terkait kunjungan

Parameters

Code examples

Responses

Errors

Template catatan SOAP

Parameters

Code examples

Responses

Errors

Request body `application/json`

Request body `application/json`