v1

latestOpenAPI 3.0.0raw.githubusercontent.com2026-06-08720548.0 KB
Patient Management

/people

  1. first_name: Nombre del paciente, obligatorio

  2. last_name: Apellido del paciente, obligatorio

  3. born_at: Utilizar el formato "aaa-mm-dd"

  4. gender: puedes utilizar los valores "f", "m" u "o" (f= fenemino, m=masculino y o= Otro)

  5. telephone2: Celular del paciente

    1. Los dígitos deben coincidir con el código del país agregado en phone_country_id.

    2. El campo es obligatorio u opcional, está condicionado al campo "without_cellphone":

      1. without_cellphone = false, entonces telephone2; obligatorio

      2. without_cellphone = true, entonces telephone2; opcional

  6. email: Campo obligatorio u opcional, condicionado al campo "send_welcome_email"

    1. send_welcome_email= true, por lo tanto email: obligatorio

    2. send_welcome_email= false, por lo tanto email: opcional

  7. notes: Opcional, puede ir vacío. Notas medicas del paciente

  8. send_welcome_email: Valores "true" o "false". Define si el campo email es obligatorio

  9. Person attributes

    1. "send_reminders": Valores "true" o "false". Define si el paciente acepta recibir notificaciones por whatsApp

    2. "identity_number": Opcional, curp del paciente

  10. without_cellphone: Obligatorio, valores: "true" o "false". Define si el campo email es obligatorio

  11. patient_group_ids: Opcional, arreglo con el id de los grupos al que el paciente pertenece. Se obtiene del catálogo de grupos de pacientes.
    (Catalogo mencionado en prerequisistos)

  12. account_id: ID del médico tratante, obtenido del catálogo de médicos. Define si el campo email es obligatorio (Catalogo mencionado en prerrequisistos)

  13. address_state_id: ID del estado de la dirección del paciente, obtenido del catálogo de estados (Catalogo mencionado en prerrequisistos)

  14. phone_country_id: Código del país al que pertenece el numero celular agregado en el campo phone_country_id (Ejemplo para agregar número de México: "142")

post/people

Request body

Response

/people