Skip to main content

​
Campos por produto

Siga as instruções abaixo por produto para garantir que os dados serão recepcionados.
Veja abaixo o mapeamento dos campos, sendo o nome na requisiçao e o detalhe do campo.
  1. Id_unico do paciente -> patient_id
    • ID que possa diferenciar cada paciente.
    • CPF, RG etc.
  2. Data de Nascimento do paciente -> patient_birthdate
    • 22/10/1985
    • d/m/y.
  3. Sexo do paciente -> patient_gender
    • Masculino, Feminino ou Indefinido
  4. Data de contato do paciente para agendar o procedimento -> patient_call_date
    • Data em que o paciente entra em contato para agendar o procedimento.
    • 02/01/2025
    • d/m/y.
  5. Data que o agendamento foi marcado para ser realizado -> appointment_date
    • Data em que o paciente escolheu realizar o procedimento.
    • 10/01/2025
    • d/m/y.
  6. Status do agendamento -> appointment_status
    • Status que define se o paciente compareceu ou não ao procedimento na data marcada.
    • Realizado ou No Show.
  7. Origem do agendamento -> appointment_source
    • Local de contato do paciente para agendar o procedimento.
    • Call Center, Online (Whatsapp, App e Web) ou Presencial.
  8. Tipo de Agendamento -> appointment_type
    • Tipo de procedimento macro a ser realizado.
    • Exame, Consulta, Tratamento etc.
  9. Categoria de Exame -> service_category
    • Categoria geral do exame realizado.
    • Ressonância, Tomografia, Ultrassonografia etc.
  10. Nome do Procedimento -> service_name
    • Nome detalhado do procedimento a ser realizado.
    • Consulta Urologista, Consulta Oftalmologista, Ressonância de Pelve, Tomografia de Tórax etc.
  11. Nome da Unidade Hospitalar ou Clínica -> service_organization_name
    • Nome que diferencie os locais de realização dos procedimentos.
    • Hospital X, Clínica Y.
  12. Unidade Federativa do Hospital ou Clínica -> service_organization_addr_state
    • Unidade Federativa onde o paciente realizará o procedimento.
    • SP, RJ, MG etc.
  13. Convênio -> service_practitioner_name
    • Convênio utilizado para a realização do procedimento.
    • Amil, Bradesco etc.
Veja abaixo o mapeamento dos campos, sendo o nome na requisiçao e o detalhe do campo.
  • customer_gender: Gênero
  • customer_birthdate: Data de Nascimento
  • service_type: Tipo de atendimento (Presencial, Remoto)
  • service_level: Nível de atendimento (Consulta, Teste, Exame, etc.)
  • event_timestamp: Data que o evento ocorreu (Ex.: 2026-01-01 23:59:59)
  • customer_zipcode: CEP do cliente
  • service_range_answer: Classificação informada (ex.: 3 estrelas)
  • service_text_answer: Texto informado pelo cliente

​
Callback

Callback, também comumente conhecido como notificação, este recurso permite que nossa API chame uma outra API para enviar o retorno caso o mesmo demore.
A API de retorno/callback deve estar preparada para receber as mesmas informações que o consumo do resultado detalhado na próxima página (Capturando Retorno)

​
Exemplo de uma requisição

​
NoShow

  {
    "patient_id": "23438238481",
    "patient_birthdate": "31/12/2100",
    "patient_gender": "feminino",
    "patient_call_date": "31/12/2100",
    "appointment_date": "31/12/2100",
    "appointment_status": "realizado",
    "appointment_source": "call center",
    "appointment_type": "consulta",
    "service_category": "ressonancia",
    "service_name": "Consulta Oftalmologista",
    "service_organization_name": "Hospital Lorem Ipsum",
    "service_organization_addr_state": "AC",
    "service_practitioner_name": "Lorem Ipsum"
  }

​
NPS

  {
    "customer_gender": "male",
    "customer_birthdate": "1990-01-12",
    "service_type": "presencial",
    "service_level": "consulta",
    "event_timestamp": "2026-01-01 23:59:59",
    "customer_zipcode": "01283123",
    "service_range_answer": "3",
    "service_text_answer": " long established fact that a reader will be distracted by the readable content of a page when looking at its layout. The point of using Lorem Ipsum is that it has a more-or-less normal distribution of letters, as opposed to using 'Content here, content here', making it look like readable English. Many desktop publishing packages and web page editors",
  }