Referensi API

Telekonsultasi

Sesi telekonsultasi terjadwal; hanya baca (modul telecon).

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/telecon/sessions

Sesi telekonsultasi

Default hari ini; dengan patient_id semua tanggal. Tautan undangan pasien tidak pernah dikembalikan di sini.

Scope: encounters:read
Izin RBAC: encounter.read · telecon.manage
Modul: telecon

Parameter

Parameter GET /telecon/sessions
Nama	Lokasi	Tipe
date	query	string (date)
practitioner_id	query	string (uuid)
patient_id	query	string (uuid)
status	query	scheduled \| in_progress \| completed \| cancelled

Contoh kode

curlJavaScriptPython

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

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

Respons

200Sesiapplication/json

{
  "items": [
    {
      "id": "3f0c2a10-5b7e-4c1d-9a2e-00000001e101",
      "branch_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000000b1",
      "patient_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000a0001",
      "patient_name": "Pasien Contoh",
      "practitioner_id": "3f0c2a10-5b7e-4c1d-9a2e-0000000d0001",
      "practitioner_name": "dr. Rina Contoh",
      "encounter_id": null,
      "service_id": "3f0c2a10-5b7e-4c1d-9a2e-00000001f004",
      "service_name": "Telekonsultasi umum",
      "scheduled_start": "2026-10-29T19:00:00+07:00",
      "scheduled_end": "2026-10-29T19:20:00+07:00",
      "duration_minutes": 20,
      "status": "scheduled",
      "payment_status": "paid",
      "payment_settled": true,
      "paid_at": "2026-10-29T15:00:00+07:00",
      "payment_ref": null,
      "charge_id": "3f0c2a10-5b7e-4c1d-9a2e-000000009101",
      "consent_at": null,
      "started_at": null,
      "ended_at": null,
      "cancel_reason": null,
      "notes": null,
      "version": 2
    }
  ]
}

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[].patient_name	string
items[].practitioner_id	string (uuid)
items[].practitioner_name	string
items[].encounter_id	string (uuid) \| null
items[].service_id	string (uuid)
items[].service_name	string
items[].scheduled_start	string (date-time)
items[].scheduled_end	string (date-time)
items[].duration_minutes	integer
items[].status	scheduled \| in_progress \| completed \| cancelled
items[].payment_status	unpaid \| paid
items[].payment_settled	boolean
items[].paid_at	string (date-time) \| null
items[].payment_ref	string \| null
items[].charge_id	string (uuid) \| null
items[].consent_at	string (date-time) \| null
items[].started_at	string (date-time) \| null
items[].ended_at	string (date-time) \| null
items[].cancel_reason	string \| null
items[].notes	string \| null
items[].version	integer

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)
429rate-limitedBatas laju klien (rate_limit_per_min) terlampaui; coba lagi pada menit berikutnya

GET/telecon/sessions/{id}

Detail sesi telekonsultasi

Scope: encounters:read
Izin RBAC: encounter.read · telecon.manage
Modul: telecon