The medical records API stores the clinical content produced during each patient visit. Records support general vitals and diagnosis fields, and extend to specialty-specific modules: OB/GYN (gynoRecord), dental charting (dentalRecords), and prescriptions. All authenticated endpoints require a validDocumentation Index
Fetch the complete documentation index at: https://mintlify.com/FerchoSG/healthcare-web/llms.txt
Use this file to discover all available pages before exploring further.
Authorization bearer token and x-clinic-id header. PDF generation requires an explicit manual fetch because the binary response is handled outside the standard JSON client.
GET /patients/:id/medical-records
Retrieve all medical records for a patient. Path parametersUUID of the patient.
MedicalRecord[]
UUID of the medical record.
UUID of the owning clinic.
UUID of the patient.
UUID of the attending doctor.
UUID of the linked appointment, or
null if the record was created independently.Free-form object containing vital signs (e.g., blood pressure, heart rate, temperature, weight). Structure is not enforced by the API.
Free-text diagnosis.
Free-text treatment plan.
ISO 8601 creation timestamp.
ISO 8601 last-updated timestamp.
OB/GYN data, or
null if not applicable.Array of dental chart entries. Empty array when not applicable.
Array of prescriptions issued on this record. Empty array when none.
POST /medical-records
Create a new medical record for a patient. The record supports specialty-specific nested objects; include only the fields relevant to the clinic’s active specialty modules. Request bodyUUID of the patient.
UUID of the attending doctor.
UUID of the appointment this record is associated with.
Free-form object for vital signs (e.g.,
{ "blood_pressure": "120/80", "temperature_c": 36.5 }).Free-text clinical diagnosis.
Free-text treatment plan.
OB/GYN-specific data. Include when the clinic has the OB/GYN specialty module enabled.
Dental chart entries. Include when the clinic has the dental specialty module enabled.
Prescription to attach to this record.
MedicalRecord
The newly created medical record. See field definitions in the GET /patients/:id/medical-records section above.
GET /medical-records/:id/pdf
Download a medical record as a PDF file. This endpoint returns a binary blob and must be called with a manualfetch — it is not handled by the standard JSON API client.
The PDF endpoint requires the same
Authorization: Bearer <token> and x-clinic-id headers as authenticated JSON endpoints, but you must call it with a raw fetch request and read the response as a Blob.UUID of the medical record.
Blob (application/pdf)
A binary PDF file suitable for downloading or opening in the browser.