DoctoFam Medical Clinic

GetFind clinicfree availabilityconsultation times

ListUse bookablethis appointmentwhen slotssomeone forasks onewhen tenant-ownedtheir DoctoFamdoctor's clinic.practice Onlyhas day,free slotappointment or consultation times. Returns each open online-booking slot's start, and slot end, aregrouped returned—neverby patientday, provider,for the next days with openings: up to 7 days and 100 slots (no patient or clinicaldoctor data.details). Not for booking a visit.

 ⟨5 unchanged words⟩ ,"properties":{"clinicId":{"description":"ClinicPractice id: (24-character24 hex)lowercase hexadecimal characters","pattern":"^[0-9a-f]{24}$" ⟨6 unchanged words⟩ 

 ⟨3 unchanged words⟩ additionalProperties":false,"properties":{"days":{"description":"One row per day with open online-booking slots, in date order, holding at most 100 slots in total. Slot times only; patients, doctors, services and clinical data are never included.","items":{"additionalProperties":false,"properties":{" ⟨46 unchanged words⟩ 

 ⟨4 unchanged words⟩ openWorldHint":false,"readOnlyHint":true,"title":"GetFind clinicfree availabilityconsultation times"}

GetCount clinicpatient schedulevisits summaryper day

CountUse scheduledthis recordswhen bysomeone UTCasks dayhow forbusy onetheir tenant-ownedmedical DoctoFampractice clinicis overor ahow rangemany ofpatient atvisits mostare 31booked days.each Returnsday. aggregateReturns administrativeappointment counts only—neverper appointmentUTC identifiersday orfor timesone practice, patientwhatever information,their proceduresstatus, diagnoses,for notes,the next 7 days by default and at most 31 days; counting stops at 100. Not for counting cancellations or otherseeing clinicalwhich data.patients are booked.

 ⟨5 unchanged words⟩ ,"properties":{"clinicId":{"description":"ClinicPractice id: (24-character24 hex)lowercase hexadecimal characters","pattern":"^[0-9a-f]{24}$" ⟨3 unchanged words⟩ ":{"$ref":"#/properties/startTime","description":"RangeEnd endof the range as an ISO 8601 value;date-time, after startTime and at most 31 days later; defaults to seven7 days laterafter the start"},"startTime":{"description":"RangeStart startof the range as an ISO 8601 value;

 ⟨11 unchanged words⟩ ,"type":"integer"},"appointmentCountIsLowerBound":{"description":"True when more than 100 appointments fall in the range","type":"boolean"},"days":{"description":"One row per UTC day that has appointments, canceled ones included. Aggregate counts only: appointment identifiers and times, patient information, services, diagnoses and notes are never returned.","items":{"additionalProperties":false,"properties":{ ⟨51 unchanged words⟩ 

 ⟨4 unchanged words⟩ openWorldHint":false,"readOnlyHint":true,"title":"GetCount clinicpatient schedulevisits summaryper day"}

GetCheck subscriptionDoctoFam statusplan and limits

GetUse administrativethis planwhen statussomeone andasks entitlementwhich limitsDoctoFam forplan onea tenant-ownedpractice DoctoFamis clinic.on, Billingwhether identifiers,it payment-provideris dataactive, amountsor how many appointments, currenciespatients, patientrooms recordsor users it allows. Returns the plan name, status, billing frequency and clinicalplan datacaps, areor excluded.the default Free plan when none is active. Not for invoices or amounts billed.

 ⟨5 unchanged words⟩ ,"properties":{"clinicId":{"description":"ClinicPractice id: (24-character24 hex)lowercase hexadecimal characters","pattern":"^[0-9a-f]{24}$" ⟨6 unchanged words⟩ 

 ⟨5 unchanged words⟩ properties":{"subscription":{"additionalProperties":false,"description":"The practice's active or past-due plan, or the default Free plan (isDefaultFreePlan) when neither exists. Seats are rooms; caps are limits, not usage. Billing identifiers, payment-provider data, amounts, currencies, patient records and clinical data are never returned.","properties":{"billingFrequency":{"anyOf":[{" ⟨68 unchanged words⟩ 

 ⟨4 unchanged words⟩ openWorldHint":false,"readOnlyHint":true,"title":"GetCheck subscriptionDoctoFam statusplan and limits"}

List calendarclosures, eventsholidays and blocked time

ListUse tenant-scopedthis non-appointmentwhen calendarsomeone blocksasks (courseswhen their medical practice is closed, meetingsor when a doctor or room is blocked for holidays, dayssick offleave, closures)courses, withmeetings boundedor pagination.maintenance. EventReturns identifiers,each staffblock referencesor extra opening with start, titlesend, all-day flag, scope and type (no titles or notes). areNot neverfor returned.patient appointments.

 ⟨5 unchanged words⟩ ,"properties":{"clinicId":{"description":"FilterOnly bythis clinicpractice id(24 lowercase hexadecimal characters); every practice when absent","pattern":"^[0-9a-f]{24}$","type":"string"},"cursor":{"description":"OpaqueThe cursornextCursor fromof athe priorprevious resultpage with the same filters; absent for the first page","maxLength":4096,"type":"string"},"endTime":{"$ref":"#/properties/startTime","description":"Only eventsblocks ending before this ISO 8601 timedate-time"},"limit":{"description":"Blocks per page, from 1 to 100; defaults to 20","

 ⟨3 unchanged words⟩ additionalProperties":false,"properties":{"calendarEvents":{"description":"Non-appointment calendar blocks, earliest first. Event identifiers, staff and room references, titles, notes and patient links are never returned.","items":{"additionalProperties":false,"properties":{" ⟨9 unchanged words⟩ :"string"},{"type":"null"}],"description":"BLOCK removes bookable time; OPEN adds hours on a normally closed time"},"endTime":{"anyOf":[{"$ref" ⟨10 unchanged words⟩ :"string"},{"type":"null"}],"description":"CLINIC: the whole practice; PROVIDER: one or more staff; SEAT: one room"},"startTime":{"anyOf":[{"maxLength" ⟨10 unchanged words⟩ :"string"},{"type":"null"}],"description":"Label such as COURSE, MEETING, VACATION, SICK, HOLIDAY, MAINTENANCE or OTHER"}},"required":["startTime","endTime", ⟨15 unchanged words⟩ :"string"},{"type":"null"}],"description":"Cursor for the next page; null on the last page"}},"required":["calendarEvents","nextCursor"] ⟨2 unchanged words⟩ 

 ⟨5 unchanged words⟩ :false,"readOnlyHint":true,"title":"List calendarclosures, eventsholidays and blocked time"}

List clinicsyour medical practices

ListUse thethis authenticatedwhen user'ssomeone asks which medical practices or doctor's offices they run in DoctoFam, clinicsor witha boundedpractice's id is needed. Returns each practice's id, cursor-basedname, pagination.currency, Onlydefault non-clinicallanguage clinicand metadatatimezone, is20 returned.per page by default. Not for finding a patient or a visit.

 ⟨5 unchanged words⟩ ,"properties":{"cursor":{"description":"OpaqueThe cursornextCursor fromof athe priorprevious resultpage of this listing; absent for the first page","maxLength":4096,"type":"string"},"limit":{"description":"Practices per page, from 1 to 100; defaults to 20","exclusiveMinimum":0,"maximum":100,"type": ⟨3 unchanged words⟩ 

 ⟨3 unchanged words⟩ additionalProperties":false,"properties":{"clinics":{"description":"Medical practices in the signed-in organization, administrative metadata only. Patient, appointment and clinical records are never returned.","items":{"additionalProperties":false,"properties":{" ⟨66 unchanged words⟩ :"string"},{"type":"null"}],"description":"Cursor for the next page; null on the last page"}},"required":["clinics","nextCursor"] ⟨2 unchanged words⟩ 

 ⟨5 unchanged words⟩ :false,"readOnlyHint":true,"title":"List clinicsyour medical practices"}

ListLook procedureup catalogconsultation and service prices

ListUse thethis authenticatedwhen user'ssomeone DoctoFamasks procedurewhat catalogtheir withmedical boundedpractice pagination.charges Onlyfor cataloga namesconsultation, pricescheck-up, durations,vaccination or other service. Returns catalog service names with price and last edit timestime, arealphabetically, returned;50 patientper treatmentpage databy anddefault. recordNot identifiersfor area excluded.patient's medical history or the care they received.

 ⟨5 unchanged words⟩ ,"properties":{"clinicId":{"description":"FilterOnly bythis clinicpractice id(24 lowercase hexadecimal characters); every practice when absent","pattern":"^[0-9a-f]{24}$","type":"string"},"cursor":{"description":"OpaqueThe cursornextCursor fromof athe priorprevious resultpage with the same filters; absent for the first page","maxLength":4096,"type":"string"},"limit":{"description":"Services per page, from 1 to 100; defaults to 50","exclusiveMinimum":0,"maximum":100,"type": ⟨3 unchanged words⟩ 

 ⟨11 unchanged words⟩ :"string"},{"type":"null"}],"description":"Cursor for the next page; null on the last page"},"procedures":{"description":"Service catalog entries in name order. Patient-linked treatments, diagnoses, prescriptions and record identifiers are never returned.","items":{"additionalProperties":false,"properties":{"duration":{"description":"Configured duration, or null when none was recorded","type":["number","null"]},"lastEditTime ⟨9 unchanged words⟩ 200,"type":"string"},"price":{"description":"Price in the practice's currency","type":["number","null"]}}, ⟨16 unchanged words⟩ 

 ⟨4 unchanged words⟩ openWorldHint":false,"readOnlyHint":true,"title":"ListLook procedureup catalogconsultation and service prices"}

List clinicdoctors providersand staff who take bookings

ListUse displaythis nameswhen forsomeone theasks bookablewhich providersdoctors, ofnurses oneor tenant-ownedassistants DoctoFampatients clinic.can Contactbook at their practice. Returns up to 100 staff display names for one practice (no contact details, roleor records,roles). identifiers,Not andfor clinicalstaff dataholidays areor neversick returned.days.

 ⟨5 unchanged words⟩ ,"properties":{"clinicId":{"description":"ClinicPractice id: (24-character24 hex)lowercase hexadecimal characters","pattern":"^[0-9a-f]{24}$" ⟨6 unchanged words⟩ 

 ⟨3 unchanged words⟩ additionalProperties":false,"properties":{"providers":{"description":"Display names of staff with a doctor, nurse or assistant role. Staff identifiers, contact details, role records and clinical data are never returned.","items":{"additionalProperties":false,"properties":{" ⟨17 unchanged words⟩ 

 ⟨5 unchanged words⟩ :false,"readOnlyHint":true,"title":"List clinicdoctors providersand staff who take bookings"}

List clinicconsultation rooms

ListUse administrativethis when someone asks which consultation or exam rooms their medical practice has. Returns room names with last edit time for one tenant-ownedpractice, DoctoFamalphabetically, clinic50 withper boundedpage pagination.by Recorddefault. identifiers,Not appointmentfor links,room patientschedules information,or andwhich clinicalpatient contentuses area excluded.room.

 ⟨5 unchanged words⟩ ,"properties":{"clinicId":{"description":"ClinicPractice id: (24-character24 hex)lowercase hexadecimal characters","pattern":"^[0-9a-f]{24}$","type":"string"},"cursor":{"description":"OpaqueThe cursornextCursor fromof athe priorprevious resultpage with the same filters; absent for the first page","maxLength":4096,"type":"string"},"limit":{"description":"Rooms per page, from 1 to 100; defaults to 50","exclusiveMinimum":0,"maximum":100,"type": ⟨5 unchanged words⟩ 

 ⟨11 unchanged words⟩ :"string"},{"type":"null"}],"description":"Cursor for the next page; null on the last page"},"rooms":{"description":"Rooms in name order. Record identifiers, appointment links, patient information and clinical content are never returned.","items":{"additionalProperties":false,"properties":{ ⟨27 unchanged words⟩ 

 ⟨5 unchanged words⟩ :false,"readOnlyHint":true,"title":"List clinicconsultation rooms"}

Show DoctoFammedical clinicpractice overview

RenderUse athis boundedwhen administrativesomeone wants a quick overview foror adashboard knownof DoctoFamone clinic.medical Itpractice. combinesReturns safean clinicoverview metadata,card aggregatewith seven-daythe schedulepractice's countsdetails, providerappointment counts for the next 7 days, roomstaff and availabilityroom counts, procedure-catalogopen previewsonline-booking slots, andup planto entitlements.12 Itservice neverprices returnsand individualthe appointmentcurrent records,plan (no patient information,or diagnoses,clinical treatmentdata). details,Not notes,for ora othersingle clinicalpatient data.or visit.

 ⟨3 unchanged words⟩ ,"properties":{"clinicId":{"description":"DoctoFam clinicPractice id: to24 renderlowercase hexadecimal characters","pattern":"^[0-9a-f]{24}$" ⟨6 unchanged words⟩ 

 ⟨114 unchanged words⟩ :"object"},{"type":"null"}],"description":"Administrative practice metadata; null when the practice was not found. The overview never includes individual appointment records, patient information, diagnoses, treatment details, notes or other clinical data."},"procedureCount":{"maximum":12,"minimum" ⟨222 unchanged words⟩ 

 ⟨5 unchanged words⟩ :false,"readOnlyHint":true,"title":"Show DoctoFammedical clinicpractice overview"}