Models

All models are inferred from Zod schemas. Imports are per-model:

import type { Appointment } from "@mediquo/core/models/appointment";
import type { Document } from "@mediquo/core/models/document";
import type { Professional } from "@mediquo/core/models/professional";
import type { PatientProfile } from "@mediquo/core/models/patient-profile";
import type { ScheduleSlot } from "@mediquo/core/models/schedule-slot";
import type { Gap } from "@mediquo/core/models/gap";

Appointment

import type {
  Appointment,
  AppointmentStatus,
  AppointmentChannel,
  ConsultationType,
} from "@mediquo/core/models/appointment";

`AppointmentStatus`

Value	Description
`"pending"`	Created, awaiting professional acceptance
`"accepted"`	Accepted, not yet started
`"inCall"`	Active call in progress
`"finished"`	Completed successfully
`"cancelled"`	Cancelled by patient or professional
`"declined"`	Declined by professional
`"expired"`	Not answered within the time window
`"free_of_charge"`	Completed without charge
`"owed"`	Payment required after completion
`"unpaid"`	Payment pending
`"reporting"`	Professional is filing post-consultation report

`AppointmentChannel`

Value	Description
`"videocall"`	Video consultation
`"chat"`	Async chat
`"phonecall"`	Phone call

`ConsultationType`

Value	Description
`"appointment"`	Scheduled appointment
`"chat"`	Chat-only consultation
`"immediate"`	On-demand (flash) appointment

`Appointment` fields

Field	Type	Description
`id`	`string` (UUID)	Unique appointment identifier
`room_id`	`string`	Associated chat room ID
`channel`	`AppointmentChannel`	Communication channel
`status`	`AppointmentStatus`	Current lifecycle state
`start_date`	`string`	Scheduled start (ISO 8601)
`started_at`	`string \| null`	Actual start time
`expires_at`	`string \| null`	Expiry time for pending appointments
`created_at`	`string`	Creation timestamp
`duration`	`number`	Duration in minutes
`seconds_to_open`	`number`	Seconds until the appointment opens (non-negative)
`consultation_reason`	`string \| null`	Patient-provided reason
`service_id`	`string \| null`	UUID of the associated service
`speciality_id`	`number \| null`	Medical specialty ID
`call_id`	`string`	Video call URL
`consultation_short_url`	`string \| null`	Short URL for the consultation
`from`	`object`	Professional details (see below)
`to`	`object`	Patient details (see below)
`preconsultation_documents`	`Array<{ file_path, file_name, id }> \| null`	Attached pre-consultation files

from (professional)

Field	Type
`hash`	`string`
`name`	`string \| null`
`avatar`	`string \| null`
`speciality`	`string \| null`
`collegiate_number`	`string \| null`
`languages`	`string[]`
`description`	`string \| null`
`is_dismissed`	`boolean`

to (patient)

Field	Type
`id`	`string`
`hash`	`string`
`name`	`string \| null`
`avatar`	`string \| null`
`is_dismissed`	`boolean`

Document

import type {
  Document,
  DocumentType,
  DocumentStatus,
} from "@mediquo/core/models/document";

`DocumentType`

Value	Description
`"prescription"`	Medication prescription
`"report"`	Clinical report
`"diagnosticTestPrescription"`	Diagnostic test order

`DocumentStatus`

Value	Description
`"published"`	Visible to the patient
`"draft"`	Not yet published

`Document` fields

Field	Type	Description
`document_id`	`string` (UUID)	Unique document identifier
`document_type`	`DocumentType`	Category of the document
`name`	`string`	Document display name
`status`	`DocumentStatus`	Publication state
`url`	`string`	Download URL
`created_at`	`string`	Creation timestamp
`professional`	`{ speciality_id: number }`	Issuing professional's specialty

Professional

import type { Professional } from "@mediquo/core/models/professional";

Field	Type	Description
`id`	`string`	Unique professional identifier
`name`	`string`	Full name
`avatar`	`string \| null`	Avatar image URL
`description`	`string \| null`	Bio or professional summary
`collegiate_number`	`string \| null`	Medical license number
`languages`	`string[]`	Spoken languages
`speciality`	`{ id: number }`	Primary medical specialty

PatientProfile

import type { PatientProfile } from "@mediquo/core/models/patient-profile";

Field	Type	Description
`hash`	`string`	Unique patient identifier
`profile.first_name`	`string \| null`	First name
`profile.last_name`	`string \| null`	Last name
`profile.birth_date`	`string \| null`	Date of birth
`profile.gender`	`"male" \| "female" \| null`	Gender
`profile.email`	`string \| null`	Email address
`profile.phone_prefix`	`string \| null`	Phone country prefix
`profile.phone`	`string \| null`	Phone number
`profile.billing.tax_id`	`string \| null`	Tax / VAT identifier
`profile.billing.address`	`string \| null`	Billing address
`profile.billing.country_code`	`string \| null`	ISO country code
`profile.billing.region`	`string \| null`	Region or state
`profile.billing.postal_code`	`string \| null`	Postal code

ScheduleSlot

import type {
  ScheduleSlot,
  ScheduleSlotStatus,
} from "@mediquo/core/models/schedule-slot";

`ScheduleSlotStatus`

Value	Description
`"available"`	Can be booked
`"reserved"`	Already taken

`ScheduleSlot` fields

Field	Type	Description
`id`	`string` (UUID)	Unique slot identifier
`channel`	`AppointmentChannel`	Consultation channel for this slot
`duration`	`number`	Duration in minutes
`starts_at`	`string`	Slot start time (ISO 8601)
`finishes_at`	`string`	Slot end time (ISO 8601)
`status`	`ScheduleSlotStatus`	Availability state
`professional`	`{ id: string, name: string }`	Assigned professional
`services`	`Array<{ id: string, name: string }>`	Associated services
`speciality`	`{ id: number }`	Medical specialty

Gap

Represents a recurring time window in a professional's availability schedule.

import type { Gap, DaysOfWeek } from "@mediquo/core/models/gap";

`DaysOfWeek`

Value	Description
`"monday"` – `"sunday"`	Specific day of the week
`"working_week"`	Monday through Friday
`"weekend"`	Saturday and Sunday
`"all_week"`	Every day

`Gap` fields

Field	Type	Description
`days_of_week`	`DaysOfWeek`	Which days the gap applies to
`from_time`	`string`	Start time (e.g. `"09:00"`)
`to_time`	`string`	End time (e.g. `"17:00"`)

On this page