GET/admin/offices/{office_id}/ownerGet Admin Medical Office Owner
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
office_id | path | string | Sí |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | MedicalOfficeOwnerOut |
| 422 | Error de validación | HTTPValidationError |
PATCH/admin/offices/{office_id}/ownerUpdate Admin Medical Office Owner
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
office_id | path | string | Sí |
Cuerpo obligatorio AdminMedicalOfficeOwnerIn
| Campo | Tipo | Obl. |
|---|
userId | string o nulo | No |
status | string | No |
reason | string o nulo | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | MedicalOfficeOwnerOut |
| 422 | Error de validación | HTTPValidationError |
PATCH/admin/offices/{office_id}/statusUpdate Medical Office Status
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
office_id | path | string | Sí |
Cuerpo obligatorio MedicalOfficeStatusIn
| Campo | Tipo | Obl. |
|---|
status | string | Sí |
reason | string o nulo | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | MedicalOfficeTenantOut |
| 422 | Error de validación | HTTPValidationError |
GET/oficina-medica/analytics/appointmentsGet Medical Office Analytics Appointments
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
dateFrom | query | string (date-time) o nulo | No |
dateTo | query | string (date-time) o nulo | No |
doctorId | query | string o nulo | No |
serviceId | query | string o nulo | No |
status | query | string o nulo | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | MedicalOfficeAnalyticsOut |
| 422 | Error de validación | HTTPValidationError |
GET/oficina-medica/analytics/billingGet Medical Office Analytics Billing
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
dateFrom | query | string (date-time) o nulo | No |
dateTo | query | string (date-time) o nulo | No |
doctorId | query | string o nulo | No |
serviceId | query | string o nulo | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | MedicalOfficeAnalyticsOut |
| 422 | Error de validación | HTTPValidationError |
GET/oficina-medica/analytics/doctorsGet Medical Office Analytics Doctors
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
dateFrom | query | string (date-time) o nulo | No |
dateTo | query | string (date-time) o nulo | No |
doctorId | query | string o nulo | No |
serviceId | query | string o nulo | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | MedicalOfficeAnalyticsOut |
| 422 | Error de validación | HTTPValidationError |
GET/oficina-medica/analytics/exportExport Medical Office Analytics
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
section | query | string | No |
format | query | string | No |
dateFrom | query | string (date-time) o nulo | No |
dateTo | query | string (date-time) o nulo | No |
doctorId | query | string o nulo | No |
serviceId | query | string o nulo | No |
status | query | string o nulo | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | MedicalOfficeAnalyticsExportOut |
| 422 | Error de validación | HTTPValidationError |
GET/oficina-medica/analytics/summaryGet Medical Office Analytics Summary
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
dateFrom | query | string (date-time) o nulo | No |
dateTo | query | string (date-time) o nulo | No |
doctorId | query | string o nulo | No |
serviceId | query | string o nulo | No |
status | query | string o nulo | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | MedicalOfficeAnalyticsOut |
| 422 | Error de validación | HTTPValidationError |
GET/oficina-medica/appointmentsList Medical Office Appointments
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
doctorId | query | string o nulo | No |
patientId | query | string o nulo | No |
locationId | query | string o nulo | No |
fromDate | query | string (date-time) o nulo | No |
toDate | query | string (date-time) o nulo | No |
status | query | string o nulo | No |
modality | query | string o nulo | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | lista de MedicalOfficeAppointmentOut |
| 422 | Error de validación | HTTPValidationError |
POST/oficina-medica/appointmentsCreate Medical Office Appointment
Cuerpo obligatorio MedicalOfficeAppointmentCreateIn
| Campo | Tipo | Obl. |
|---|
patientId | string | Sí |
doctorId | string | Sí |
locationId | string o nulo | No |
serviceId | string o nulo | No |
modality | string | No |
startsAt | string (date-time) | Sí |
endsAt | string (date-time) | Sí |
status | string | No |
reason | string | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 201 | Respuesta correcta | MedicalOfficeAppointmentOut |
| 422 | Error de validación | HTTPValidationError |
GET/oficina-medica/appointments/{appointment_id}Get Medical Office Appointment
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
appointment_id | path | string | Sí |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | MedicalOfficeAppointmentOut |
| 422 | Error de validación | HTTPValidationError |
PATCH/oficina-medica/appointments/{appointment_id}Update Medical Office Appointment
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
appointment_id | path | string | Sí |
Cuerpo obligatorio MedicalOfficeAppointmentUpdateIn
| Campo | Tipo | Obl. |
|---|
patientId | string o nulo | No |
doctorId | string o nulo | No |
locationId | string o nulo | No |
serviceId | string o nulo | No |
modality | string o nulo | No |
startsAt | string (date-time) o nulo | No |
endsAt | string (date-time) o nulo | No |
status | string o nulo | No |
reason | string o nulo | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | MedicalOfficeAppointmentOut |
| 422 | Error de validación | HTTPValidationError |
PATCH/oficina-medica/appointments/{appointment_id}/cancelCancel Medical Office Appointment
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
appointment_id | path | string | Sí |
Cuerpo obligatorio MedicalOfficeAppointmentCancelIn
| Campo | Tipo | Obl. |
|---|
cancellationReason | string | Sí |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | MedicalOfficeAppointmentOut |
| 422 | Error de validación | HTTPValidationError |
PATCH/oficina-medica/appointments/{appointment_id}/completeComplete Medical Office Appointment
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
appointment_id | path | string | Sí |
Cuerpo opcional MedicalOfficeAppointmentReasonIn o nulo
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | MedicalOfficeAppointmentOut |
| 422 | Error de validación | HTTPValidationError |
PATCH/oficina-medica/appointments/{appointment_id}/confirmConfirm Medical Office Appointment
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
appointment_id | path | string | Sí |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | MedicalOfficeAppointmentOut |
| 422 | Error de validación | HTTPValidationError |
GET/oficina-medica/audit-logsList Medical Office Audit Logs
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
tenantId | query | string o nulo | No |
actorId | query | string o nulo | No |
module | query | string o nulo | No |
entityType | query | string o nulo | No |
entityId | query | string o nulo | No |
action | query | string o nulo | No |
result | query | string o nulo | No |
dateFrom | query | string (date-time) o nulo | No |
dateTo | query | string (date-time) o nulo | No |
page | query | integer | No |
pageSize | query | integer | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | MedicalOfficeAuditLogListOut |
| 422 | Error de validación | HTTPValidationError |
GET/oficina-medica/audit-logs/exportExport Medical Office Audit Logs
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
tenantId | query | string o nulo | No |
actorId | query | string o nulo | No |
module | query | string o nulo | No |
entityType | query | string o nulo | No |
entityId | query | string o nulo | No |
action | query | string o nulo | No |
result | query | string o nulo | No |
dateFrom | query | string (date-time) o nulo | No |
dateTo | query | string (date-time) o nulo | No |
format | query | string | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | MedicalOfficeAuditExportOut |
| 422 | Error de validación | HTTPValidationError |
GET/oficina-medica/audit-logs/{audit_log_id}Get Medical Office Audit Log
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
audit_log_id | path | integer | Sí |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | MedicalOfficeAuditLogOut |
| 422 | Error de validación | HTTPValidationError |
POST/oficina-medica/audit-logs/{audit_log_id}/flagFlag Medical Office Audit Log
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
audit_log_id | path | integer | Sí |
Cuerpo obligatorio MedicalOfficeAuditFlagIn
| Campo | Tipo | Obl. |
|---|
reason | string | Sí |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | MedicalOfficeAuditLogOut |
| 422 | Error de validación | HTTPValidationError |
GET/oficina-medica/billing/chargesList Medical Office Charges
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
patientId | query | string o nulo | No |
doctorId | query | string o nulo | No |
appointmentId | query | string o nulo | No |
status | query | string o nulo | No |
includePaid | query | boolean | No |
pendingOnly | query | boolean | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | lista de MedicalOfficeChargeOut |
| 422 | Error de validación | HTTPValidationError |
POST/oficina-medica/billing/chargesCreate Medical Office Charge
Cuerpo obligatorio MedicalOfficeChargeCreateIn
| Campo | Tipo | Obl. |
|---|
patientId | string | Sí |
doctorId | string o nulo | No |
appointmentId | string o nulo | No |
serviceId | string o nulo | No |
description | string | Sí |
amountCents | integer | Sí |
status | string | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 201 | Respuesta correcta | MedicalOfficeChargeOut |
| 422 | Error de validación | HTTPValidationError |
GET/oficina-medica/billing/charges/{charge_id}Get Medical Office Charge
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
charge_id | path | string | Sí |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | MedicalOfficeChargeOut |
| 422 | Error de validación | HTTPValidationError |
PATCH/oficina-medica/billing/charges/{charge_id}Update Medical Office Charge
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
charge_id | path | string | Sí |
Cuerpo obligatorio MedicalOfficeChargeUpdateIn
| Campo | Tipo | Obl. |
|---|
doctorId | string o nulo | No |
appointmentId | string o nulo | No |
serviceId | string o nulo | No |
description | string o nulo | No |
amountCents | integer o nulo | No |
status | string o nulo | No |
cancellationReason | string o nulo | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | MedicalOfficeChargeOut |
| 422 | Error de validación | HTTPValidationError |
POST/oficina-medica/billing/charges/{charge_id}/paymentsRecord Medical Office Payment
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
charge_id | path | string | Sí |
Cuerpo obligatorio MedicalOfficePaymentCreateIn
| Campo | Tipo | Obl. |
|---|
amountCents | integer | Sí |
paymentMethod | string | Sí |
paidAt | string (date-time) o nulo | No |
reference | string o nulo | No |
notes | string o nulo | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 201 | Respuesta correcta | MedicalOfficeChargeOut |
| 422 | Error de validación | HTTPValidationError |
GET/oficina-medica/billing/receipts/{receipt_id}Get Medical Office Receipt
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
receipt_id | path | string | Sí |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | MedicalOfficeReceiptOut |
| 422 | Error de validación | HTTPValidationError |
GET/oficina-medica/marketplace-profileGet Medical Office Marketplace Profile
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
tenantId | query | string o nulo | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | MedicalOfficeMarketplaceProfileOut |
| 422 | Error de validación | HTTPValidationError |
PATCH/oficina-medica/marketplace-profileUpdate Medical Office Marketplace Profile
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
tenantId | query | string o nulo | No |
Cuerpo obligatorio MedicalOfficeMarketplaceProfilePatchIn
| Campo | Tipo | Obl. |
|---|
displayName | string o nulo | No |
slug | string o nulo | No |
description | string o nulo | No |
services | lista de string o nulo | No |
specialties | lista de string o nulo | No |
locations | lista de object o nulo | No |
photos | lista de string o nulo | No |
hours | lista de object o nulo | No |
doctorIds | lista de string o nulo | No |
reason | string o nulo | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | MedicalOfficeMarketplaceProfileOut |
| 422 | Error de validación | HTTPValidationError |
POST/oficina-medica/marketplace-profile/publishPublish Medical Office Marketplace Profile
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
tenantId | query | string o nulo | No |
Cuerpo opcional MedicalOfficeMarketplaceTransitionIn o nulo
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | MedicalOfficeMarketplaceProfileOut |
| 422 | Error de validación | HTTPValidationError |
POST/oficina-medica/marketplace-profile/submitSubmit Medical Office Marketplace Profile
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
tenantId | query | string o nulo | No |
Cuerpo opcional MedicalOfficeMarketplaceTransitionIn o nulo
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | MedicalOfficeMarketplaceProfileOut |
| 422 | Error de validación | HTTPValidationError |
POST/oficina-medica/marketplace-profile/unpublishUnpublish Medical Office Marketplace Profile
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
tenantId | query | string o nulo | No |
Cuerpo opcional MedicalOfficeMarketplaceTransitionIn o nulo
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | MedicalOfficeMarketplaceProfileOut |
| 422 | Error de validación | HTTPValidationError |
GET/oficina-medica/membersList Medical Office Members
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
status | query | string o nulo | No |
activeOnly | query | boolean | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | lista de MedicalOfficeMembershipOut |
| 422 | Error de validación | HTTPValidationError |
POST/oficina-medica/members/invitationsInvite Medical Office Doctor
Cuerpo obligatorio MedicalOfficeMembershipInviteIn
| Campo | Tipo | Obl. |
|---|
invitedEmail | string (email) | Sí |
doctorId | string o nulo | No |
role | string | No |
locations | lista de object | No |
permissions | lista de string | No |
expiresAt | string (date-time) o nulo | No |
reason | string o nulo | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 201 | Respuesta correcta | MedicalOfficeMembershipOut |
| 422 | Error de validación | HTTPValidationError |
POST/oficina-medica/members/invitations/{membership_id}/acceptAccept Medical Office Doctor Invitation
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
membership_id | path | string | Sí |
Cuerpo opcional MedicalOfficeMembershipDecisionIn o nulo
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | MedicalOfficeMembershipOut |
| 422 | Error de validación | HTTPValidationError |
POST/oficina-medica/members/invitations/{membership_id}/declineDecline Medical Office Doctor Invitation
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
membership_id | path | string | Sí |
Cuerpo opcional MedicalOfficeMembershipDecisionIn o nulo
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | MedicalOfficeMembershipOut |
| 422 | Error de validación | HTTPValidationError |
PATCH/oficina-medica/members/{membership_id}Update Medical Office Membership
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
membership_id | path | string | Sí |
Cuerpo obligatorio MedicalOfficeMembershipUpdateIn
| Campo | Tipo | Obl. |
|---|
role | string o nulo | No |
status | string o nulo | No |
locations | lista de object o nulo | No |
permissions | lista de string o nulo | No |
reason | string o nulo | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | MedicalOfficeMembershipOut |
| 422 | Error de validación | HTTPValidationError |
DELETE/oficina-medica/members/{membership_id}Remove Medical Office Membership
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
membership_id | path | string | Sí |
Cuerpo opcional MedicalOfficeMembershipDecisionIn o nulo
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | MedicalOfficeMembershipOut |
| 422 | Error de validación | HTTPValidationError |
GET/oficina-medica/modulesGet Medical Office Modules
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
tenantId | query | string o nulo | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | lista de MedicalOfficeModuleOut |
| 422 | Error de validación | HTTPValidationError |
GET/oficina-medica/modules/catalogGet Medical Office Module Catalog
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
tenantId | query | string o nulo | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | lista de MedicalOfficeModuleOut |
| 422 | Error de validación | HTTPValidationError |
PATCH/oficina-medica/modules/{module_key}Update Medical Office Module
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
module_key | path | string | Sí |
tenantId | query | string o nulo | No |
Cuerpo obligatorio MedicalOfficeModulePatchIn
| Campo | Tipo | Obl. |
|---|
enabled | boolean | Sí |
reason | string o nulo | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | MedicalOfficeModuleOut |
| 422 | Error de validación | HTTPValidationError |
GET/oficina-medica/navigationGet Medical Office Navigation
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
tenantId | query | string o nulo | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | MedicalOfficeNavigationOut |
| 422 | Error de validación | HTTPValidationError |
POST/oficina-medica/orders/externalCreate Medical Office External Order
Cuerpo obligatorio MedicalOfficeExternalOrderCreateIn
| Campo | Tipo | Obl. |
|---|
patientId | string | Sí |
doctorId | string o nulo | No |
appointmentId | string o nulo | No |
orderType | string | Sí |
destinationType | string | Sí |
destinationId | string o nulo | No |
destinationName | string o nulo | No |
priority | string | No |
diagnosis | string o nulo | No |
notes | string o nulo | No |
modality | string o nulo | No |
bodyPart | string o nulo | No |
items | lista de MedicalOfficeExternalOrderItemIn | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 201 | Respuesta correcta | MedicalOfficeExternalOrderOut |
| 422 | Error de validación | HTTPValidationError |
Get Current Medical Office Owner
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | MedicalOfficeOwnerOut |
GET/oficina-medica/owner/permissionsGet Current Medical Office Owner Permissions
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | MedicalOfficeOwnerPermissionsOut |
PATCH/oficina-medica/owner/transferTransfer Current Medical Office Owner
Cuerpo obligatorio MedicalOfficeOwnerTransferIn
| Campo | Tipo | Obl. |
|---|
transferredToUserId | string | Sí |
reason | string | Sí |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | MedicalOfficeOwnerOut |
| 422 | Error de validación | HTTPValidationError |
GET/oficina-medica/patientsList Medical Office Patients
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
q | query | string o nulo | No |
status | query | string o nulo | No |
primaryDoctorId | query | string o nulo | No |
includeArchived | query | boolean | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | lista de MedicalOfficePatientOut |
| 422 | Error de validación | HTTPValidationError |
POST/oficina-medica/patientsCreate Medical Office Patient
Cuerpo obligatorio MedicalOfficePatientCreateIn
| Campo | Tipo | Obl. |
|---|
patientId | string o nulo | No |
medicalRecordNo | string o nulo | No |
firstName | string o nulo | No |
lastName | string o nulo | No |
documentId | string o nulo | No |
email | string o nulo | No |
phone | string o nulo | No |
birthDate | string (date-time) o nulo | No |
gender | string o nulo | No |
relationshipType | string | No |
status | string | No |
primaryDoctorId | string o nulo | No |
notesSummary | string o nulo | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 201 | Respuesta correcta | MedicalOfficePatientOut |
| 422 | Error de validación | HTTPValidationError |
GET/oficina-medica/patients/{patient_id}Get Medical Office Patient
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
patient_id | path | string | Sí |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | MedicalOfficePatientOut |
| 422 | Error de validación | HTTPValidationError |
PATCH/oficina-medica/patients/{patient_id}Update Medical Office Patient
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
patient_id | path | string | Sí |
Cuerpo obligatorio MedicalOfficePatientUpdateIn
| Campo | Tipo | Obl. |
|---|
firstName | string o nulo | No |
lastName | string o nulo | No |
documentId | string o nulo | No |
email | string o nulo | No |
phone | string o nulo | No |
birthDate | string (date-time) o nulo | No |
gender | string o nulo | No |
relationshipType | string o nulo | No |
status | string o nulo | No |
primaryDoctorId | string o nulo | No |
notesSummary | string o nulo | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | MedicalOfficePatientOut |
| 422 | Error de validación | HTTPValidationError |
PATCH/oficina-medica/patients/{patient_id}/archiveArchive Medical Office Patient
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
patient_id | path | string | Sí |
Cuerpo opcional MedicalOfficePatientArchiveIn o nulo
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | MedicalOfficePatientOut |
| 422 | Error de validación | HTTPValidationError |
POST/oficina-medica/patients/{patient_id}/linkLink Medical Office Patient
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
patient_id | path | string | Sí |
Cuerpo obligatorio MedicalOfficePatientLinkIn
| Campo | Tipo | Obl. |
|---|
relationshipType | string | No |
primaryDoctorId | string o nulo | No |
notesSummary | string o nulo | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | MedicalOfficePatientOut |
| 422 | Error de validación | HTTPValidationError |
GET/oficina-medica/prescriptionsList Medical Office Prescriptions
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
patientId | query | string o nulo | No |
doctorId | query | string o nulo | No |
status | query | string o nulo | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | lista de MedicalOfficePrescriptionOut |
| 422 | Error de validación | HTTPValidationError |
POST/oficina-medica/prescriptionsCreate Medical Office Prescription
Cuerpo obligatorio MedicalOfficePrescriptionCreateIn
| Campo | Tipo | Obl. |
|---|
patientId | string | Sí |
doctorId | string o nulo | No |
appointmentId | string o nulo | No |
diagnosis | string o nulo | No |
notes | string o nulo | No |
status | string | No |
expiresAt | string (date-time) o nulo | No |
items | lista de MedicalOfficePrescriptionItemIn | Sí |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 201 | Respuesta correcta | MedicalOfficePrescriptionOut |
| 422 | Error de validación | HTTPValidationError |
PATCH/oficina-medica/prescriptions/{prescription_id}/cancelCancel Medical Office Prescription
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
prescription_id | path | string | Sí |
Cuerpo opcional MedicalOfficeCancelIn o nulo
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | MedicalOfficePrescriptionOut |
| 422 | Error de validación | HTTPValidationError |
POST/oficina-medica/prescriptions/{prescription_id}/signSign Medical Office Prescription
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
prescription_id | path | string | Sí |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | MedicalOfficePrescriptionOut |
| 422 | Error de validación | HTTPValidationError |
GET/oficina-medica/referralsList Medical Office Referrals
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
patientId | query | string o nulo | No |
doctorId | query | string o nulo | No |
status | query | string o nulo | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | lista de MedicalOfficeReferralOut |
| 422 | Error de validación | HTTPValidationError |
POST/oficina-medica/referralsCreate Medical Office Referral
Cuerpo obligatorio MedicalOfficeReferralCreateIn
| Campo | Tipo | Obl. |
|---|
patientId | string | Sí |
doctorId | string o nulo | No |
appointmentId | string o nulo | No |
destinationType | string | Sí |
destinationId | string o nulo | No |
specialty | string o nulo | No |
urgency | string | No |
diagnosis | string o nulo | No |
notes | string o nulo | No |
reason | string | Sí |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 201 | Respuesta correcta | MedicalOfficeReferralOut |
| 422 | Error de validación | HTTPValidationError |
GET/oficina-medica/sessionGet Medical Office Session
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | MedicalOfficeSessionOut |
List Medical Office Staff
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
q | query | string o nulo | No |
role | query | string o nulo | No |
status | query | string o nulo | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | lista de MedicalOfficeStaffOut |
| 422 | Error de validación | HTTPValidationError |
POST/oficina-medica/staffCreate Medical Office Staff
Cuerpo obligatorio MedicalOfficeStaffCreateIn
| Campo | Tipo | Obl. |
|---|
fullName | string | Sí |
email | string (email) | Sí |
phone | string o nulo | No |
role | string | Sí |
staffProfileId | string o nulo | No |
permissions | lista de string | No |
status | string | No |
password | string o nulo | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 201 | Respuesta correcta | MedicalOfficeStaffOut |
| 422 | Error de validación | HTTPValidationError |
GET/oficina-medica/staff/{staff_user_id}Get Medical Office Staff
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
staff_user_id | path | string | Sí |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | MedicalOfficeStaffOut |
| 422 | Error de validación | HTTPValidationError |
PATCH/oficina-medica/staff/{staff_user_id}Update Medical Office Staff
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
staff_user_id | path | string | Sí |
Cuerpo obligatorio MedicalOfficeStaffUpdateIn
| Campo | Tipo | Obl. |
|---|
fullName | string o nulo | No |
email | string (email) o nulo | No |
phone | string o nulo | No |
role | string o nulo | No |
staffProfileId | string o nulo | No |
permissions | lista de string o nulo | No |
status | string o nulo | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | MedicalOfficeStaffOut |
| 422 | Error de validación | HTTPValidationError |
PATCH/oficina-medica/staff/{staff_user_id}/deactivateDeactivate Medical Office Staff
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
staff_user_id | path | string | Sí |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | MedicalOfficeStaffOut |
| 422 | Error de validación | HTTPValidationError |
POST/oficina-medica/staff/{staff_user_id}/reset-passwordReset Medical Office Staff Password
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
staff_user_id | path | string | Sí |
Cuerpo opcional MedicalOfficeStaffResetPasswordIn o nulo
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | MedicalOfficeStaffOut |
| 422 | Error de validación | HTTPValidationError |
GET/oficina-medica/telemedicine/sessionsList Medical Office Telemedicine Sessions
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
status | query | string o nulo | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | lista de MedicalOfficeTelemedicineSessionOut |
| 422 | Error de validación | HTTPValidationError |
POST/oficina-medica/telemedicine/sessionsCreate Medical Office Telemedicine Session
Cuerpo obligatorio MedicalOfficeTelemedicineSessionCreateIn
| Campo | Tipo | Obl. |
|---|
appointmentId | string | Sí |
provider | string | No |
status | string | No |
accessTokenExpiresAt | string (date-time) o nulo | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 201 | Respuesta correcta | MedicalOfficeTelemedicineSessionOut |
| 422 | Error de validación | HTTPValidationError |
GET/oficina-medica/telemedicine/sessions/{session_id}Get Medical Office Telemedicine Session
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
session_id | path | string | Sí |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | MedicalOfficeTelemedicineSessionOut |
| 422 | Error de validación | HTTPValidationError |
POST/oficina-medica/telemedicine/sessions/{session_id}/endEnd Medical Office Telemedicine Session
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
session_id | path | string | Sí |
Cuerpo opcional MedicalOfficeTelemedicineSessionTransitionIn o nulo
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | MedicalOfficeTelemedicineSessionOut |
| 422 | Error de validación | HTTPValidationError |
GET/oficina-medica/telemedicine/sessions/{session_id}/joinJoin Medical Office Telemedicine Session
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
session_id | path | string | Sí |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | MedicalOfficeTelemedicineSessionOut |
| 422 | Error de validación | HTTPValidationError |
GET/oficina-medica/telemedicine/sessions/{session_id}/provider-statusGet Medical Office Telemedicine Provider Status
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
session_id | path | string | Sí |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | MedicalOfficeTelemedicineProviderStatusOut |
| 422 | Error de validación | HTTPValidationError |
POST/oficina-medica/telemedicine/sessions/{session_id}/startStart Medical Office Telemedicine Session
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
session_id | path | string | Sí |
Cuerpo opcional MedicalOfficeTelemedicineSessionTransitionIn o nulo
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | MedicalOfficeTelemedicineSessionOut |
| 422 | Error de validación | HTTPValidationError |
GET/oficina-medica/tenantGet Current Medical Office Tenant
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | MedicalOfficeTenantOut |
GET/public/offices/{slug}Get Public Medical Office Profile
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
slug | path | string | Sí |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | PublicMedicalOfficeProfileOut |
| 422 | Error de validación | HTTPValidationError |
List Medical Offices
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
tenantId | query | string o nulo | No |
status | query | string o nulo | No |
q | query | string o nulo | No |
sortBy | query | string | No |
sortOrder | query | string | No |
page | query | integer | No |
pageSize | query | integer | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | MedicalOfficeTenantListOut |
| 422 | Error de validación | HTTPValidationError |
Create Medical Office
Cuerpo obligatorio MedicalOfficeCreateIn
| Campo | Tipo | Obl. |
|---|
legalName | string | Sí |
displayName | string | Sí |
email | string (email) | Sí |
phone | string | Sí |
ownerUserId | string o nulo | No |
officeType | string | No |
status | string | No |
verificationStatus | string | No |
moduleConfig | lista de string | No |
rnc | string o nulo | No |
address | string o nulo | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 201 | Respuesta correcta | MedicalOfficeTenantOut |
| 422 | Error de validación | HTTPValidationError |
GET/v1/offices/api-contractsGet Medical Office Api Contracts
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | lista de MedicalOfficeApiContractOut |
List Medical Office Members V1
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
status | query | string o nulo | No |
activeOnly | query | boolean | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | lista de MedicalOfficeMembershipOut |
| 422 | Error de validación | HTTPValidationError |
Invite Medical Office Member V1
Cuerpo obligatorio MedicalOfficeMembershipInviteIn
| Campo | Tipo | Obl. |
|---|
invitedEmail | string (email) | Sí |
doctorId | string o nulo | No |
role | string | No |
locations | lista de object | No |
permissions | lista de string | No |
expiresAt | string (date-time) o nulo | No |
reason | string o nulo | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 201 | Respuesta correcta | MedicalOfficeMembershipOut |
| 422 | Error de validación | HTTPValidationError |
Get Medical Office Modules V1
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | lista de MedicalOfficeModuleOut |
PATCH/v1/offices/modules/{module_key}Update Medical Office Module V1
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
module_key | path | string | Sí |
Cuerpo obligatorio MedicalOfficeModulePatchIn
| Campo | Tipo | Obl. |
|---|
enabled | boolean | Sí |
reason | string o nulo | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | MedicalOfficeModuleOut |
| 422 | Error de validación | HTTPValidationError |
Get Medical Office Session V1
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | MedicalOfficeSessionOut |
GET/v1/offices/{office_id}Get Medical Office
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
office_id | path | string | Sí |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | MedicalOfficeTenantOut |
| 422 | Error de validación | HTTPValidationError |
PATCH/v1/offices/{office_id}Update Medical Office
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
office_id | path | string | Sí |
Cuerpo obligatorio MedicalOfficeUpdateIn
| Campo | Tipo | Obl. |
|---|
legalName | string o nulo | No |
displayName | string o nulo | No |
email | string (email) o nulo | No |
phone | string o nulo | No |
ownerUserId | string o nulo | No |
officeType | string o nulo | No |
verificationStatus | string o nulo | No |
moduleConfig | lista de string o nulo | No |
rnc | string o nulo | No |
address | string o nulo | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | MedicalOfficeTenantOut |
| 422 | Error de validación | HTTPValidationError |
POST/webhooks/daily/telemedicineDaily Telemedicine Webhook
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
X-Daily-Webhook-Secret | header | string o nulo | No |
authorization | header | string o nulo | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | objeto |
| 422 | Error de validación | HTTPValidationError |