Conexa logo
Documentation Powered by ReDoc

Conexa API - Enterprise (1.0.0)

Download OpenAPI specification:Download

E-mail: suporte.ti@conexasaude.com.br URL: https://www.conexasaude.com.br/ License: Apache 2.0 Terms of Service

Serviços para integração entre empresas e a plataforma de telemedicina da Conexa Saúde.

Para saber mais sobre a Conexa: https://www.conexasaude.com.br/.

Introdução

Conexa API - Enterprise está organizada através dos conceitos de arquitetura REST. A API possui URLs orientadas a recursos, aceita requisições HTTPS e retorna respostas em formato JSON, além de utilizar códigos HTTP padrão, autenticação e verbos.

Autenticação

Conexa API - Enterprise oferece a forma de autenticação via token API fixo em header de nome token. Para obter um token de autenticação, entre em contato com nosso time técnico.

Atendimento

Representa os endpoints de atendimentos na plataforma Conexa

Obter atendimento por ID

Obtém informações de um atendimento informando o ID do atendimento.

path Parameters
id
required
integer

ID do atendimento a ser retornado

query Parameters
professionalType
required
string
Enum: "NURSE" "PSYCHOLOGIST" "PHYSIOTHERAPIST" "PHONOAUDIOLOGIST" "NUTRITIONIST" "SOCIAL_ASSISTANT" "DOCTOR"

Tipo de profissional

header Parameters
token
required
string

token API

Responses

Request samples 

curl "https://api.conexasaude.com.br/integration/enterprise/v2/appointment/1?professionalType=NURSE" \
-H "token: SEU_API_TOKEN"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": {
    },
  • "timestamp": 1591458128186
}

Obter URL do atendimento

Obtém a URL para realizar o acesso ao atendimento pelo seu ID

path Parameters
id
required
integer

ID do atendimento a ser retornado

header Parameters
token
required
string

token API

Responses

Request samples 

curl "https://api.conexasaude.com.br/integration/enterprise/appointment/{id}/url" \
-H "token: SEU_API_TOKEN"

Response samples

Content type
application/json
{}

Salvar informações do prontuário do atendimento

Atualiza algumas informações de dados do prontuário de um atendimento

path Parameters
id
required
integer

ID do atendimento a ser alterado

header Parameters
token
required
string

token API

Request Body schema: application/json

Objeto com informações de alteração no prontuário do atendimento

historyPhysicalExamination
required
string

Histórico de exame físico

prescription
required
string

Prescrição

previousDiagnosis
required
string

Diagnóstico prévio

screening
required
string

Campo de texto livre para triagem

Responses

Request samples

Content type
application/json
{
  • "historyPhysicalExamination": "Paciente vem a consulta solicitar exames de rotina.",
  • "prescription": "Dieta e atividade fisica.",
  • "previousDiagnosis": "Dor de cabeça e cansaço",
  • "screening": "Dor de cabeça"
}

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": {
    },
  • "timestamp": 1591458128186
}

Listar últimos atendimentos do paciente

Retorna as informações dos últimos 50 atendimentos (independente do status) de um paciente

path Parameters
patientId
required
integer

ID do paciente

query Parameters
professionalType
string
Enum: "NURSE" "PSYCHOLOGIST" "PHYSIOTHERAPIST" "PHONOAUDIOLOGIST" "NUTRITIONIST" "SOCIAL_ASSISTANT" "DOCTOR"

Tipo de profissional

header Parameters
token
required
string

token API

Responses

Request samples 

curl "https://api.conexasaude.com.br/integration/enterprise/v2/appointment/all/12?professionalType=PSYCHOLOGIST" \
-H "token: SEU_API_TOKEN"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": [
    ],
  • "timestamp": 1591458128186
}

Listar próximos atendimentos do paciente

Retorna as informações dos próximos atendimentos PENDENTES de um paciente(tanto atendimento agendado com um profissional ou atendimento agendado sem preferência)

path Parameters
patientId
required
integer

ID do paciente

header Parameters
token
required
string

token API

Responses

Request samples 

curl "https://api.conexasaude.com.br/integration/enterprise/v2/appointment/next/12" \
-H "token: SEU_API_TOKEN"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": [],
  • "timestamp": 1591458128186
}

Listar atendimentos do paciente já realizados

Retorna informações dos últimos 50 atendimentos já realizados pelo paciente (com status diferente de Cancelado e Pendente e desfechos diferentes de Demonstração, Atendimento Interrompido e Paciente Faltou)

path Parameters
patientId
required
integer

ID do paciente

query Parameters
professionalType
string
Enum: "NURSE" "PSYCHOLOGIST" "PHYSIOTHERAPIST" "PHONOAUDIOLOGIST" "NUTRITIONIST" "SOCIAL_ASSISTANT" "DOCTOR"

Tipo de profissional

header Parameters
token
required
string

token API

Responses

Request samples 

curl "https://api.conexasaude.com.br/integration/enterprise/v2/appointment/realized/{patientId}?professionalType=PSYCHOLOGIST" \
-H "token: SEU_API_TOKEN"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": [],
  • "timestamp": 1591458128186
}

Criar atendimento imediato

Cria um atendimento imediato (fila de atendimentos) para o paciente

header Parameters
token
required
string

token API

Request Body schema: application/json

Objeto com informações para a criação de um atendimento imediato

patientId
required
integer

ID do paciente

specialtyId
integer

ID da especialidade

object
professionalType
string
Default: ["DOCTOR"]
Enum: "DOCTOR" "NURSE" "PSYCHOLOGIST" "NUTRITIONIST" "DENTIST" "PHYSIOTHERAPIST" "PHONOAUDIOLOGIST" "SOCIAL_ASSISTANT" "HEALTH_COACH" "PHYSICAL_EDUCATOR"

Tipo de médico

symptoms
Array of strings

Lista com os sintomas

medicines
Array of integers

Lista com os medicamentos

screening
string

Campo de texto livre para triagem

urlExternalPrescription
string

URL de acesso a prescrição externa (Física ou de outro sistema, já autenticada para consulta do profissional de saúde)

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": "b3g0eecc02200012212010009750c5e5",
  • "timestamp": 1591458128186
}

Anexar arquivos ao atendimento imediato

Envia um arquivo (base64) para ficar anexado ao atendimento imediato informado. (Arquivo não pode ser maior que 10MB)

path Parameters
idProtocol
required
string

Protocolo (id) da solicitação do atendimento imediato

header Parameters
token
required
string

token API

Request Body schema: application/json

Objeto com informações de envio de arquivo para o atendimento imediato

base64Content
required
string

Campo destinado a o conteúdo base64 do arquivo que deseja anexar

describe
string

Campo destinado à descrição do arquivo anexado

extension
required
string
Enum: "pdf" "png" "jpg" "jpeg" "xls" "xlsx" "mp3" "mp4" "mpga" "wav" "flac" "m4a" "ogg" "acc" "wma" "aiff" "amr"

Campo destinado à extensão do arquivo enviado

tipoAnexoSibs
string
Enum: "EXAME" "OUTROS"

Tipo do Anexo no Sibs

dataExame
LocalDate

Data do exame

Responses

Request samples

Content type
application/json
{
  • "base64Content": "conteudo do arquivo base64",
  • "describe": "Exame de sangue",
  • "extension": "pdf",
  • "tipoAnexoSibs": "EXAME",
  • "dataExame": "2021-01-01"
}

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": true,
  • "timestamp": 1591458128186
}

Anexar arquivos ao atendimento

Envia um arquivo (base64) para ficar anexado ao atendimento informado. (Arquivo não pode ser maior que 10MB)

path Parameters
appointmentId
required
string

ID do atendimento que será anexado o arquivo

header Parameters
token
required
string

token API

Request Body schema: application/json

Objeto com informações de envio de arquivo para o atendimento imediato

conteudoBase64
required
string

Campo destinado a o conteúdo base64 do arquivo que deseja anexar

legenda
string

Campo destinado à descrição do arquivo anexado

nomeExtensao
required
string
Enum: "pdf" "png" "jpg" "jpeg" "xls" "xlsx" "mp3" "mp4" "mpga" "wav" "flac" "m4a" "ogg" "acc" "wma" "aiff" "amr"

Campo destinado à extensão do arquivo enviado

tipoAnexoSibs
string
Enum: "EXAME" "OUTROS"

Tipo do Anexo no Sibs

dataExame
LocalDate

Data do exame

Responses

Request samples

Content type
application/json
{
  • "conteudoBase64": "conteudo do arquivo base64",
  • "legenda": "Exame de sangue",
  • "nomeExtensao": "pdf",
  • "tipoAnexoSibs": "EXAME",
  • "dataExame": "01/01/2021"
}

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": true,
  • "timestamp": 1591458128186
}

Obter atendimento imediato do paciente

Obtém informações do atendimento imediato (fila) por ID do paciente

path Parameters
patientId
required
integer

ID do paciente

header Parameters
token
required
string

token API

Responses

Request samples 

curl "https://api.conexasaude.com.br/integration/enterprise/appointment/immediate/active/{patientId}" \
-H "token: SEU_API_TOKEN"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": {
    },
  • "timestamp": 1591458128186
}

Cancelar atendimento imediato por ID do paciente

Cancela o atendimento imediato (da fila de atendimentos) de um paciente pelo seu ID

path Parameters
patientId
required
integer

ID do paciente

header Parameters
token
required
string

token API

Responses

Request samples 

curl -X POST "https://api.conexasaude.com.br/integration/enterprise/appointment/immediate/cancel/{patientId}" \
-H "token: SEU_API_TOKEN"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": true,
  • "timestamp": 1591458128186
}

Obter última chamada ativa do paciente

Obtém informações da última chamada ativa pelo paciente informado (ID)

path Parameters
patientId
required
integer

ID do paciente

header Parameters
token
required
string

token API

Responses

Request samples 

curl "https://api.conexasaude.com.br/integration/enterprise/v2/appointment/last/call/{patientId}" \
-H "token: SEU_API_TOKEN"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": {},
  • "timestamp": 1591458128186
}

Listar tipos de desfechos de consulta

Lista todos os tipos de desfechos para consultas

header Parameters
token
required
string

token API

Responses

Request samples 

curl "https://api.conexasaude.com.br/integration/enterprise/appointment/outcomes" \
-H "token: SEU_API_TOKEN"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": [
    ],
  • "timestamp": 1591458128186
}

Listar relatório de atendimentos

Lista informações de relatório de atendimentos (agendados ou já realizados) por período, profissional de saúde, paciente. Só pode ser consultado um período de 7 dias

query Parameters
startDate
required
string

Data de inicial (Formato yyyy-MM-dd)

endDate
required
string

Data de final (Formato yyyy-MM-dd)

cpfDoctor
string

CPF do profissional de saúde

cpfPatient
string

CPF do paciente

header Parameters
token
required
string

token API

Responses

Request samples 

curl "https://api.conexasaude.com.br/integration/enterprise/appointment/report?startDate=2020-04-01&endDate=2020-04-10" \
-H "token: SEU_API_TOKEN"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": [
    ],
  • "timestamp": 1591458128186
}

Listar atendimentos agendados sem preferência

Lista informações dos atendimentos agendados sem preferência de um profissional baseado em filtro de busca de forma paginada, sendo permitido a busca de no máximo um período de 30 dias.

query Parameters
startDate
required
string

Data inicial (Formato yyyy-MM-dd)

endDate
required
string

Data final (Formato yyyy-MM-dd)

page
integer

Número da página da listagem de relatório de pacientes

header Parameters
token
required
string

token API

Responses

Request samples 

curl "https://api.conexasaude.com.br/integration/enterprise/appointment/scheduled/without-specialist/report?startDate=2020-04-01&endDate=2020-04-10&page=1" \
-H "token: SEU_API_TOKEN"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": [
    ],
  • "timestamp": 1591458128186
}

Obter listagem de sintomas

Retorna a lista dos sintomas para ser relacionados aos atendimentos

header Parameters
token
required
string

token API

Responses

Request samples 

curl "https://api.conexasaude.com.br/integration/enterprise/appointment/symptoms" \
-H "token: SEU_API_TOKEN"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": [
    ],
  • "timestamp": 1591458128186
}

Obter URL de acesso do atendimento por ID da chamada

Obtém a URL de acesso do atendimento por ID da chamada

path Parameters
callId
required
integer

ID da meeting do atendimento

header Parameters
token
required
string

token API

Responses

Request samples 

curl "https://api.conexasaude.com.br/integration/enterprise/appointment/url/call/{callId}" \
-H "token: SEU_API_TOKEN"

Response samples

Content type
application/json
{}

Obter URL de acesso da sala de espera por ID atendimento

Obter a URL de acesso do atendimento ou da sala de espera por ID do atendimento

path Parameters
appointmentID
required
integer

ID do atendimento

header Parameters
token
required
string

token API

Responses

Request samples 

curl --request GET "https://api.conexasaude.com.br/integration/enterprise/v2/appointment/waiting/call/{appointmentID}" \
-H "token: SEU_API_TOKEN"

Response samples

Content type
application/json
{}

Concluir atendimento

Serviço para concluir um atendimento pendente

header Parameters
token
required
string

token API

Request Body schema: application/json

Objeto com informações de atendimento para ser concluído

appointmentId
required
integer

ID do atendimento

outcome
required
string
Enum: "NAO_INFORMADO" "ALTA_CONSULTA" "AMBULATORIAL" "ENCAMINHADO_PS" "ATENDIMENTO_INTERROMPIDO" "FOLLOW_UP_TELEMEDICINA" "PACIENTE_FALTOU" "DEMONSTRACAO" "INTERCONSULTA" "REGISTRO_ATESTADO" "ENCAMINHAMENTO_MEDICO_IMEDIATO"

Desfecho do atendimento

patientOrientation
string

Orientação passada ao paciente

screening
string

Campo de texto livre para triagem

Responses

Request samples

Content type
application/json
{
  • "appointmentId": 938340,
  • "outcome": "NAO_INFORMADO",
  • "patientOrientation": "Retornar ao cirurgião Vascular caso haja piora do quadro.",
  • "screening": "Dor de cabeça"
}

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": true,
  • "timestamp": 1591458128186
}

Concluir atendimento por ID do atendimento

Conclui um atendimento pendente pelo seu ID com desfecho AMBULATORIAL por padrão, serviço usado para conclusão de atendimento padrão.

path Parameters
id
required
integer

ID do atendimento

header Parameters
token
required
string

token API

Responses

Request samples 

curl -X POST "https://api.conexasaude.com.br/integration/enterprise/appointment/conclude/{id}" \
-H "token: SEU_API_TOKEN"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": true,
  • "timestamp": 1591458128186
}

Cancelar atendimento agendado

Cancela um atendimento agendado com um profissional ou sem preferência. Lembrando que é obrigatório informar o "appointmentId" ou o "protocolId", por se tratar de formas diferentes de agendamento. Se mandar os dois juntos não irá cancelar os 2.

query Parameters
professionalType
required
string
Enum: "NURSE" "PSYCHOLOGIST" "PHYSIOTHERAPIST" "PHONOAUDIOLOGIST" "NUTRITIONIST" "SOCIAL_ASSISTANT" "DOCTOR"

Tipo de profissional

header Parameters
token
required
string

token API

notifyClinic
boolean
Default:

Flag para indicar notificação de clínica

Request Body schema: application/json

Objeto com informações para cancelamento de atendimento agendado

appointmentId
required
integer

ID do atendimento agendado, deverá ser enviado para cancelar atendimentos agendados com escolha profissional

patientId
required
integer

ID do paciente do atendimento agendado

protocolId
string

Protocolo do atendimento

notifyClinic
required
boolean

Indica se deve notificar a clínica

reasonForCancellation
string

Motivo do cancelamento

Responses

Request samples

Content type
application/json
{
  • "appointmentId": 10432657,
  • "patientId": 23027344,
  • "protocolId": 232,
  • "notifyClinic": false,
  • "reasonForCancellation": "Eu quis cancelar"
}

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": true,
  • "timestamp": 1591458128186
}

Inserir atendimento agendado completo

Cria um atendimento médico agendado com as informações de atendimento, médico e paciente

header Parameters
token
required
string

token API

Request Body schema: application/json

Objeto com informações de atendimento agendado

appointmentDate
required
string

Data de agendamento do atendimento. Formato dd/MM/yyyy HH:mm

required
object (DoctorRequest)
required
object (PatientRequest)
historyPhysicalExamination
string

Histórico de exame físico

prescription
string

Prescrição

previousDiagnosis
string

Diagnóstico prévio

screening
string

Campo de texto livre para triagem

object
urlExternalPrescription
string

URL de acesso a prescrição externa (Física ou de outro sistema, já autenticada para consulta do profissional de saúde)

Responses

Request samples

Content type
application/json
{
  • "appointmentDate": "20/12/2020 16:00",
  • "doctor": {
    },
  • "patient": {
    },
  • "historyPhysicalExamination": "Paciente vem a consulta solicitar exames de rotina.",
  • "prescription": "Dieta e atividade fisica.",
  • "previousDiagnosis": "Dor de cabeça e cansaço",
  • "screening": "Dor de cabeça",
  • "payment": {
    },
  • "urlExternalPrescription": "https://prescricao.cliente.com/assinatura_caminho/acesso/tokenblaabla"
}

Response samples

Content type
application/json
{}

Criar atendimento agendado semi completo

Cria um atendimento agendado com as informações completas de paciente, cpf do profissional e dados basico de atendimento

header Parameters
token
required
string

token API

Request Body schema: application/json

Objeto com informações de atendimento agendado

doctorCpf
required
string

CPF do médico

appointmentDate
required
string

Data/Hora de Agendamento do Atendimento. Formato dd/MM/yyyy HH:mm

required
object (PatientRequest)
object
previousDiagnosis
string

Diagnóstico prévio

historyPhysicalExamination
string

Exame Físico

screening
string

Triagem

prescription
string

Prescrição

urlExternalPrescription
string

URL de acesso a prescrição externa (Física ou de outro sistema, já autenticada para consulta do profissional de saúde)

Responses

Request samples

Content type
application/json
{
  • "doctorCpf": 11122233344,
  • "appointmentDate": "15/04/2021 17:00",
  • "patient": {
    },
  • "payment": {
    },
  • "previousDiagnosis": "Dor de cabeça, Dor no Corpo, Tosse",
  • "historyPhysicalExamination": "string",
  • "screening": "string",
  • "prescription": "string",
  • "urlExternalPrescription": "https://prescricao.cliente.com/assinatura_caminho/acesso/tokenblaabla"
}

Response samples

Content type
application/json
{}

Criar atendimento agendado com cadastro semi completo

Cria um atendimento agendado com as informações completas de paciente, ID do slot de agendamento e dados basicos de atendimento e profissional

header Parameters
token
required
string

token API

Request Body schema: application/json

Objeto com informações de atendimento agendado

idSlot
required
integer

ID do slot de agendamento

appointmentDate
required
string

Data/Hora de Agendamento do Atendimento. Formato dd/MM/yyyy HH:mm

required
object (PatientRequest)
professionalId
integer

ID do profissional de saúde

object
previousDiagnosis
string

Diagnóstico prévio

historyPhysicalExamination
string

Exame Físico

screening
string

Triagem

prescription
string

Prescrição

urlExternalPrescription
string

URL de acesso a prescrição externa (Física ou de outro sistema, já autenticada para consulta do profissional de saúde)

Responses

Request samples

Content type
application/json
{
  • "idSlot": 12345,
  • "appointmentDate": "12/08/2025 14:30",
  • "patient": {
    },
  • "professionalId": 86009,
  • "payment": {
    },
  • "previousDiagnosis": "Dor de cabeça e tontura",
  • "historyPhysicalExamination": "Paciente apresenta pressão arterial normal e sem febre",
  • "screening": "Triagem inicial realizada",
  • "prescription": "Paracetamol 500mg, 1 comprimido a cada 8h por 3 dias",
  • "urlExternalPrescription": "https://prescricao.cliente.com/assinatura_caminho/acesso/tokenblaabla"
}

Response samples

Content type
application/json
{}

Criar atendimento agendado sem preferência de profissional

Cria um agendamento de um atendimento sem preferência de um profissional de saúde para o(a) paciente

header Parameters
token
required
string

token API

Request Body schema: application/json

Objeto com informações de solicitação de agendamento do paciente

patientId
required
integer

ID do paciente

dateTimeAppointment
required
string

Data/hora em que o paciente deseja agendar o atendimento

specialistType
string
Enum: "MEDICO" "DENTISTA" "ENFERMEIRO" "NUTRICIONISTA" "PSICOLOGO"

Tipo de profissional de saúde

specialtyId
integer

ID da especialidade do profissional de saúde

urlExternalPrescription
string

URL de acesso a prescrição externa (Física ou de outro sistema, já autenticada para consulta do profissional de saúde)

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": "82ec82ec82ec82ec82ec82ec82ec82ec",
  • "timestamp": 1591458128186
}

Criar atendimento agendado simples

Cria um atendimento agendado de um paciente para um profissional de saúde. Necessário já possuir profissional de saúde e paciente previamente cadastrados.

query Parameters
professionalType
required
string
Enum: "NURSE" "PSYCHOLOGIST" "PHYSIOTHERAPIST" "PHONOAUDIOLOGIST" "NUTRITIONIST" "SOCIAL_ASSISTANT" "DOCTOR"

Tipo de profissional

header Parameters
token
required
string

token API

Request Body schema: application/json

Objeto com informações de atendimento agendado

appointmentDate
required
string

Data de agendamento do atendimento. Formato dd/MM/yyyy HH:mm

doctorId
required
integer

ID do profissional de saúde

patientId
required
integer

ID do paciente

historyPhysicalExamination
string

Histórico de exame físico

prescription
string

Prescrição

previousDiagnosis
string

Diagnóstico prévio

screening
string

Campo de texto livre para triagem

object
urlExternalPrescription
string

URL de acesso a prescrição externa (Física ou de outro sistema, já autenticada para consulta do profissional de saúde)

Responses

Request samples

Content type
application/json
{
  • "appointmentDate": "20/12/2020 16:00",
  • "doctorId": 65492,
  • "patientId": 392,
  • "historyPhysicalExamination": "Paciente vem a consulta solicitar exames de rotina.",
  • "prescription": "Dieta e atividade fisica.",
  • "previousDiagnosis": "Dor de cabeça e cansaço",
  • "screening": "Dor de cabeça",
  • "payment": {
    },
  • "urlExternalPrescription": "https://prescricao.cliente.com/assinatura_caminho/acesso/tokenblaabla"
}

Response samples

Content type
application/json
{}

Listagem de medicamentos

Lista os medicamentos, podendo ser filtrado por nome

path Parameters
name
required
string

Nome do medicamento

header Parameters
token
required
string

token API

Responses

Request samples 

curl "https://hml-api.conexasaude.com.br/integration/enterprise/appointment/medicines/NOVAL" \
-H "token: SEU_API_TOKEN"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": [
    ],
  • "timestamp": 1591458128186
}

Listar especialidades médicas disponíveis

Lista todas as especialidades médicas disponíveis para atendimento

header Parameters
token
required
string

token API

Responses

Request samples 

curl "https://api.conexasaude.com.br/integration/enterprise/appointment/specialties" \
-H "token: SEU_API_TOKEN"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": [
    ],
  • "timestamp": 1591458128186
}

Listar relatório de chamadas de atendimento

Lista um relatório com as informações de chamadas de atendimentos por período. Só pode ser consultado um período de 7 dias e esse serviço só pode ser chamado em um horário (00:00h às 06:00)

path Parameters
page
required
integer

Página do relátorio

query Parameters
startDate
required
string

Data de inicial (Formato yyyy-MM-dd)

endDate
required
string

Data de final (Formato yyyy-MM-dd)

header Parameters
token
required
string

token API

Responses

Request samples 

curl "https://api.conexasaude.com.br/integration/enterprise/appointment/calls/report/1?startDate=2020-04-01&endDate=2020-04-10" \
-H "token: SEU_API_TOKEN"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": [
    ],
  • "timestamp": 1591458128186
}

Obter quantidade prescrições do atendimento

Retorna a quantidade de prescrições de um paciente atrelada ao atendimento informado na busca.

path Parameters
appointmentID
required
integer

ID do atendimento que será retornado a quantidade de prescrições

header Parameters
token
required
string

token API

Responses

Request samples 

curl "https://api.conexasaude.com.br/integration/enterprise/appointment/prescriptions/amount/1234" \
-H "token: SEU_API_TOKEN"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": 2,
  • "timestamp": 1591458128186
}

Reenviar prescrições do atendimento

Reenvia para o paciente por Email todas as prescrições do atendimento informado na busca

path Parameters
appointmentID
required
integer

ID do atendimento que será reenviado as prescrições para o paciente

header Parameters
token
required
string

token API

Responses

Request samples 

curl -X POST "https://api.conexasaude.com.br/integration/enterprise/v2/appointment/resend/prescriptions/1234" \
-H "token: SEU_API_TOKEN"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": true,
  • "timestamp": 1591458128186
}

Fila de Atendimento

Representa os endpoints de fila de atendimento na plataforma Conexa

Recupera o tamanho da fila de atendimento para o tipo de profissional especificado

Recupera o tamanho da fila de atendimento para o tipo de profissional especificado

query Parameters
professionalType
required
string
Enum: "NURSE" "PSYCHOLOGIST" "PHYSIOTHERAPIST" "PHONOAUDIOLOGIST" "NUTRITIONIST" "SOCIAL_ASSISTANT" "DOCTOR"

Tipo de profissional

header Parameters
token
required
string

token API

Responses

Request samples 

curl --location --request GET 'https://api.conexasaude.com.br/integration/appointment-queue/size?professionalType=DOCTOR' \
-H "token: SEU_API_TOKEN" \
-H "Content-Type: application/json" \

Response samples

Content type
application/json
{
  • "status": "202",
  • "msg": "Sucesso",
  • "object": {
    },
  • "timestamp": 1591458128186
}

Médico

Representa os endpoints de médicos na plataforma Conexa

Listar horários disponíveis do médico

Lista horários disponíveis da agenda do médico

query Parameters
id
required
integer
Example: id=65492

ID do médico

date
required
string
Example: date=10/10/2020

Data base para horários disponíveis. Formato dd/MM/yyyy

header Parameters
token
required
string

token API

Responses

Request samples 

curl -X GET "https://api.conexasaude.com.br/integration/enterprise/v2/doctor/availabletimes?id=65492&date=10/10/2020" \
-H "token: SEU_API_TOKEN" \
-H "Content-Type: application/json"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": [
    ],
  • "timestamp": 1591458128186
}

Inserir médico

Cria médico na base para ser utilizado na plataforma

header Parameters
token
required
string

token API

Request Body schema: application/json

Objeto com informações do médico a ser inserido

id
integer

ID do médico

name
required
string

Nome do médico

lastname
required
string

Sobrenome do médico

mail
required
string

E-mail do médico

cellphone
required
string

Celular do médico

specialtyId
required
integer

ID da especialidade

sex
required
string
Enum: "MALE" "FEMALE" "OTHERS" "UNINFORMED"

Sexo do médico

isBrazilian
required
boolean

true para médico brasileiro

cpf
required
string

CPF do médico

crm
required
string

CRM do médico

crmUf
required
string
Enum: "RO" "AC" "AM" "RR" "PA" "AP" "TO" "MA" "PI" "CE" "RN" "PB" "PE" "AL" "SE" "BA" "MG" "ES" "RJ" "SP" "PR" "SC" "RS" "MS" "MT" "GO" "DF"

UF do CRM do médico

dateBirth
required
string

Data de nascimento do médico (Formato dd/MM/yyyy)

cep
string

Campo para informar o cep do profissional

city
string

Campo para informar a cidade do profissional

uf
string
Enum: "RO" "AC" "AM" "RR" "PA" "AP" "TO" "MA" "PI" "CE" "RN" "PB" "PE" "AL" "SE" "BA" "MG" "ES" "RJ" "SP" "PR" "SC" "RS" "MS" "MT" "GO" "DF"

UF do endereço do profissional

neighborhood
string

Campo para informar o bairro do profissional

address
string

Campo para informar o endereço do profissional

complement
string

Campo para informar o complemento do endereço do profissional (caso tenha)

socialName
string

Campo para informar o nome social do profissional (O campo deve conter no máximo 80 caracteres)

motherName
string

Campo para informar o nome da mãe do profissional (O campo deve conter no máximo 80 caracteres)

unknowMother
boolean

Campo para sinalizar que a mãe do profissional é desconhecida.

idGender
long

Campo para indicar o gênero do profissional (código recuperado no endpoint da aba Dominio -> Listar as informações de Gênero)

idRaceColor
integer

ID da cor da raça do profissional (código recuperado no endpoint da aba Dominio -> Listar as informações de Raça/cor)

idNationality
integer

ID da nacionalidade do profissional (código recuperado no endpoint da aba Dominio -> Listar as informações de Nacionalidades)

birthCounty
string

Campo para informar o município de nascimento do profissional

idBirthUF
long

Campo para indicar a UF de nascimento do profissional (código recuperado no endpoint da aba Dominio -> Listar as informações de UF)

naturalizationDate
string

Data de naturalização

idBirthCountry
long

Campo para indicar o país de nascimento do profissional (código recuperado no endpoint da aba Dominio -> Listar as informações de País)

passport
String

Campo para informar o número do passaporte do profissional

idPassportIssuingCountry
long

Campo para indicar o país de nascimento do paciente (código recuperado no endpoint da aba Dominio -> Listar as informações de País)

passportIssuingDate
string

Campo para informar a data de emissão do passaporte do profissional

passportExpiryDate
string

Campo para informar a data de expiração do passaporte do profissional

residencialPhone
string

Campo para informar a telefone residencial do profissional

idAddressCountry
integer

Campo para indicar o pais do endereço do profissional

cns
string

Número da cns do profissional (O campo deve conter no máximo 15 caracteres)

identity
string

Número da identidade do profissional (O campo deve conter no máximo 20 caracteres)

idIdentityUF
long

Campo para indicar a UF da identidade do profissional (código recuperado no endpoint da aba Dominio -> Listar as informações de UF)

identityIssuingDate
string

Campo para informar a data de emissão da identidade do profissional

identityIssuingBody
string

Campo para informar o orgão emissor da identidade do profissional (O campo deve conter no máximo 50 caracteres)

nisNumber
string

Campo para informar o número de NIS (Número de Identificação Social) do profissional (O campo deve conter no máximo 11 caracteres)

idCbo
long

ID do CBO do profissional

blockAppointmentQueue
boolean
Default: false

Flag para que o profissional não realize atendimentos imediados. (PA)

Responses

Request samples

Content type
application/json
{
  • "id": 2343,
  • "name": "John",
  • "lastname": "Doe",
  • "mail": "john.doe@gmail.com",
  • "cellphone": "21999888777",
  • "specialtyId": 12,
  • "sex": "MALE",
  • "isBrazilian": true,
  • "cpf": "11122277788",
  • "crm": "776622",
  • "crmUf": "RO",
  • "dateBirth": "10/01/1980",
  • "cep": 21341225,
  • "city": "Rio de Janeiro",
  • "uf": "RO",
  • "neighborhood": "Copacabana",
  • "address": "Rua Teste, n 123",
  • "complement": "Casa",
  • "socialName": "Steve",
  • "motherName": "Maria Silva",
  • "unknowMother": false,
  • "idGender": 1,
  • "idRaceColor": 1,
  • "idNationality": 1,
  • "birthCounty": "Rio de Janeiro",
  • "idBirthUF": 1,
  • "naturalizationDate": "26/09/2005",
  • "idBirthCountry": 1,
  • "passport": 1278172831,
  • "idPassportIssuingCountry": 1,
  • "passportIssuingDate": "17/10/2015",
  • "passportExpiryDate": "17/10/2020",
  • "residencialPhone": "(21) 3873-8437",
  • "idAddressCountry": "(21) 3873-8437",
  • "cns": 123456789101213,
  • "identity": 123456789,
  • "idIdentityUF": 1,
  • "identityIssuingDate": "17/10/2002",
  • "identityIssuingBody": "Detran",
  • "nisNumber": 72673612,
  • "idCbo": 2,
  • "blockAppointmentQueue": false
}

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": {
    },
  • "timestamp": 1591458128186
}

Obter médico por ID

Obtém médico por ID

path Parameters
id
required
integer

ID do médico

query Parameters
appointmentId
integer

Id do atendimento em que o profissional foi responsável (Casos de profissional responsável com visualização privada)

header Parameters
token
required
string

token API

Responses

Request samples 

curl "https://api.conexasaude.com.br/integration/enterprise/doctors/2343?appointmentId=1234567" \
-H "token: SEU_API_TOKEN"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": {
    },
  • "timestamp": 1591458128186
}

Ativar médico por ID

Ativa médico na plataforma por ID

path Parameters
id
required
integer

ID do médico

header Parameters
token
required
string

token API

Responses

Request samples 

curl -X POST "https://api.conexasaude.com.br/integration/enterprise/v2/doctors/2343/activate" \
-H "token: SEU_API_TOKEN"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": true,
  • "timestamp": 1591458128186
}

Inativar médico por ID

Inativa um médico na plataforma por ID

path Parameters
id
required
integer

ID do médico

header Parameters
token
required
string

token API

Responses

Request samples 

curl -X POST "https://api.conexasaude.com.br/integration/enterprise/v2/doctors/2343/inactivate" \
-H "token: SEU_API_TOKEN"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": true,
  • "timestamp": 1591458128186
}

Obter médico por CPF

Obtém médico da plataforma por CPF

path Parameters
cpf
required
integer

CPF do médico

query Parameters
onlyActive
integer

Campo para sinalizar a busca apenas de médicos ativo na plataforma.

header Parameters
token
required
string

token API

Responses

Request samples 

curl "https://api.conexasaude.com.br/integration/enterprise/doctors/cpf/11122277788?onlyActive=1"\
-H "token: SEU_API_TOKEN"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": {
    },
  • "timestamp": 1591458128186
}

Listar especialidades médicas

Lista todas as especialidades médicas disponíveis na plataforma

header Parameters
token
required
string

token API

Responses

Request samples 

curl "https://api.conexasaude.com.br/integration/enterprise/doctors/specialties" \
-H "token: SEU_API_TOKEN"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": [
    ],
  • "timestamp": 1591458128186
}

Listar médicos pelo nome

Lista os médicos disponíveis para agendamento para o paciente

path Parameters
page
required
integer

Página requerida

query Parameters
name
string

Nome do médico

patientId
integer

ID do paciente

sortType
string
Enum: "NAME" "NEAREST_DATE"

Tipo de ordenação da listagem

header Parameters
token
required
string

token API

Responses

Request samples 

curl "https://api.conexasaude.com.br/integration/enterprise/doctors/name/1?name=JOAO&patientId=111" \
-H "token: SEU_API_TOKEN"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": [
    ],
  • "timestamp": 1591458128186
}

Listar médicos de uma especialidade pelo nome

Lista os médicos disponíveis de determinada especialidade pelo nome para agendamento para o paciente

path Parameters
specialtyId
required
integer

ID da especialidade médica

page
required
integer

Página requerida

query Parameters
name
string

Nome do médico

patientId
integer

ID do paciente

sortType
string
Enum: "NAME" "NEAREST_DATE"

Tipo de ordenação da listagem

header Parameters
token
required
string

token API

Responses

Request samples 

curl "https://api.conexasaude.com.br/integration/enterprise/doctors/specialty/2/1?name=JOAO&patientId=111" \
-H "token: SEU_API_TOKEN"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": [
    ],
  • "timestamp": 1591458128186
}

Listar os horários disponíveis para agendamento com um médico

Lista os horários disponíveis para agendamento com um médico. Limitado a um retorno de 4 dias. Seguido a isso pode ser chamado novamente o serviço a partir da última data no retorno para obter mais 4 dias.

path Parameters
doctorId
required
integer

ID do médico

query Parameters
startDate
required
integer

Data base para horários disponíveis. Formato dd/MM/yyyy

header Parameters
token
required
string

token API

Responses

Request samples 

curl "https://api.conexasaude.com.br/integration/enterprise/doctors/1036/schedule/available?startDate=30%2F09%2F2020" \
-H "token: SEU_API_TOKEN"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": [
    ],
  • "timestamp": 1591458128186
}

Listar relatório de médicos

Lista informações de relatórios relacionadas a aos médicos da clínica baseado em filtro de busca

query Parameters
active
required
boolean

true para listar relatório de médicos ativos

inactive
required
boolean

true para listar relatóro de médicos inativos

blocked
required
boolean

true para listar relatóro de médicos bloqueados

page
integer

Número da página da listagem de relatório de médicos

header Parameters
token
required
string

token API

Responses

Request samples 

curl "https://api.conexasaude.com.br/integration/enterprise/doctors/report?active=false&inactive=false&blocked=false&page=1" \
-H "token: SEU_API_TOKEN"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": [
    ],
  • "timestamp": 1591458128186
}

Bloquear médico por ID

Bloqueia o acesso do médico à plataforma pelo seu ID

path Parameters
id
required
integer

ID do médico

header Parameters
token
required
string

token API

Responses

Request samples 

curl -X POST "https://api.conexasaude.com.br/integration/enterprise/v2/doctors/401/block" \
-H "token: SEU_API_TOKEN"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": true,
  • "timestamp": 1591458128186
}

Desbloquear médico por ID

Desbloqueia o médico pelo seu ID para poder acessar à plataforma

path Parameters
id
required
integer

ID do médico

header Parameters
token
required
string

token API

Responses

Request samples 

curl -X POST "https://api.conexasaude.com.br/integration/enterprise/v2/doctors/401/unblock" \
-H "token: SEU_API_TOKEN"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": true,
  • "timestamp": 1591458128186
}

Profissional de saúde

Representa os endpoints de profissionais de saúde (não médicos) na plataforma Conexa

Inserir profissional de saúde

Insere profissional de saúde para ser utilizado na plataforma

header Parameters
token
required
string

token API

Request Body schema: application/json

Objeto com informações do profissional de saúde a ser inserido

id
integer

ID do profissional de saúde

name
required
string

Nome do profissional de saúde

lastname
required
string

Sobrenome do profissional de saúde

mail
required
string

E-mail do profissional de saúde

cellphone
required
string

Celular do profissional de saúde

sex
required
string
Enum: "MALE" "FEMALE"

Sexo do profissional de saúde

isBrazilian
required
boolean

true para profissional de saúde brasileiro

cpf
required
string

CPF do profissional de saúde

professionalType
required
string
Enum: "NURSE" "PSYCHOLOGIST" "PHYSIOTHERAPIST" "PHONOAUDIOLOGIST" "NUTRITIONIST" "SOCIAL_ASSISTANT"

Tipo de profissional de saúde

councilNumber
required
string

Número do conselho do profissional de saúde

councilUf
required
string
Enum: "RO" "AC" "AM" "RR" "PA" "AP" "TO" "MA" "PI" "CE" "RN" "PB" "PE" "AL" "SE" "BA" "MG" "ES" "RJ" "SP" "PR" "SC" "RS" "MS" "MT" "GO" "DF"

UF do conselho do profissional de saúde

dateBirth
required
string

Data de nascimento do profissional de saúde (Formato dd/MM/yyyy)

cep
string

Campo para informar o cep do profissional

city
string

Campo para informar a cidade do profissional

uf
string
Enum: "RO" "AC" "AM" "RR" "PA" "AP" "TO" "MA" "PI" "CE" "RN" "PB" "PE" "AL" "SE" "BA" "MG" "ES" "RJ" "SP" "PR" "SC" "RS" "MS" "MT" "GO" "DF"

UF do endereço do profissional

neighborhood
string

Campo para informar o bairro do profissional

address
string

Campo para informar o endereço do profissional

complement
string

Campo para informar o complemento do endereço do profissional (caso tenha)

socialName
string

Campo para informar o nome social do profissional (O campo deve conter no máximo 80 caracteres)

motherName
string

Campo para informar o nome da mãe do profissional (O campo deve conter no máximo 80 caracteres)

unknowMother
boolean

Campo para sinalizar que a mãe do profissional é desconhecida.

idGender
long

Campo para indicar o gênero do profissional (código recuperado no endpoint da aba Dominio -> Listar as informações de Gênero)

idRaceColor
integer

ID da cor da raça do profissional (código recuperado no endpoint da aba Dominio -> Listar as informações de Raça/cor)

idNationality
integer

ID da nacionalidade do profissional (código recuperado no endpoint da aba Dominio -> Listar as informações de Nacionalidades)

birthCounty
string

Campo para informar o município de nascimento do profissional

idBirthUF
long

Campo para indicar a UF de nascimento do profissional (código recuperado no endpoint da aba Dominio -> Listar as informações de UF)

naturalizationDate
string

Data de naturalização

idBirthCountry
long

Campo para indicar o país de nascimento do profissional (código recuperado no endpoint da aba Dominio -> Listar as informações de País)

passport
String

Campo para informar o número do passaporte do profissional

idPassportIssuingCountry
long

Campo para indicar o país de nascimento do paciente (código recuperado no endpoint da aba Dominio -> Listar as informações de País)

passportIssuingDate
string

Campo para informar a data de emissão do passaporte do profissional

passportExpiryDate
string

Campo para informar a data de expiração do passaporte do profissional

residencialPhone
string

Campo para informar a telefone residencial do profissional

idAddressCountry
integer

Campo para indicar o pais do endereço do profissional

cns
string

Número da cns do profissional (O campo deve conter no máximo 15 caracteres)

identity
string

Número da identidade do profissional (O campo deve conter no máximo 20 caracteres)

idIdentityUF
long

Campo para indicar a UF da identidade do profissional (código recuperado no endpoint da aba Dominio -> Listar as informações de UF)

identityIssuingDate
string

Campo para informar a data de emissão da identidade do profissional

identityIssuingBody
string

Campo para informar o orgão emissor da identidade do profissional (O campo deve conter no máximo 50 caracteres)

nisNumber
string

Campo para informar o número de NIS (Número de Identificação Social) do profissional (O campo deve conter no máximo 11 caracteres)

idCbo
long

ID do CBO do profissional

blockAppointmentQueue
boolean
Default: false

Flag para que o profissional não realize atendimentos imediados. (PA)

Responses

Request samples

Content type
application/json
{
  • "id": 2343,
  • "name": "John",
  • "lastname": "Doe",
  • "mail": "john.doe@gmail.com",
  • "cellphone": "21999888777",
  • "sex": "MALE",
  • "isBrazilian": true,
  • "cpf": "11122277788",
  • "professionalType": "NURSE",
  • "councilNumber": "776622",
  • "councilUf": "RO",
  • "dateBirth": "10/01/1980",
  • "cep": 21341225,
  • "city": "Rio de Janeiro",
  • "uf": "RO",
  • "neighborhood": "Copacabana",
  • "address": "Rua Teste, n 123",
  • "complement": "Casa",
  • "socialName": "Steve",
  • "motherName": "Maria Silva",
  • "unknowMother": false,
  • "idGender": 1,
  • "idRaceColor": 1,
  • "idNationality": 1,
  • "birthCounty": "Rio de Janeiro",
  • "idBirthUF": 1,
  • "naturalizationDate": "26/09/2005",
  • "idBirthCountry": 1,
  • "passport": 1278172831,
  • "idPassportIssuingCountry": 1,
  • "passportIssuingDate": "17/10/2015",
  • "passportExpiryDate": "17/10/2020",
  • "residencialPhone": "(21) 3873-8437",
  • "idAddressCountry": "(21) 3873-8437",
  • "cns": 123456789101213,
  • "identity": 123456789,
  • "idIdentityUF": 1,
  • "identityIssuingDate": "17/10/2002",
  • "identityIssuingBody": "Detran",
  • "nisNumber": 72673612,
  • "idCbo": 2,
  • "blockAppointmentQueue": false
}

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": {
    },
  • "timestamp": 1591458128186
}

Ativar profissional de saúde por ID

Ativa um profissional de saúde da plataforma por ID

path Parameters
id
required
integer

ID do profissional de saúde

header Parameters
token
required
string

token API

Responses

Request samples 

curl -X POST "https://api.conexasaude.com.br/integration/enterprise/v2/healthcare-professionals/2343/activate" \
-H "token: SEU_API_TOKEN"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": true,
  • "timestamp": 1591458128186
}

Inativar profissional de saúde por ID

Inativa um profissional de saúde da plataforma por ID

path Parameters
id
required
integer

ID do profissional de saúde

header Parameters
token
required
string

token API

Responses

Request samples 

curl -X POST "https://api.conexasaude.com.br/integration/enterprise/v2/healthcare-professionals/2343/inactivate" \
-H "token: SEU_API_TOKEN"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": true,
  • "timestamp": 1591458128186
}

Obter profissional de saúde por ID

Obtém profissional de saúde da plataforma por ID

path Parameters
id
required
integer

ID do profissional de saúde

query Parameters
patientId
integer

ID do Paciente de saúde (Obrigatório apenas quando o professionalType for PSYCHOLOGIST)

professionalType
required
string
Enum: "NURSE" "PSYCHOLOGIST" "PHYSIOTHERAPIST" "PHONOAUDIOLOGIST" "NUTRITIONIST" "SOCIAL_ASSISTANT" "DOCTOR"

Tipo de profissional

appointmentId
integer

Id do atendimento em que o profissional foi responsável (Casos de profissional responsável com visualização privada)

header Parameters
token
required
string

token API

Responses

Request samples 

curl "https://api.conexasaude.com.br/integration/enterprise/v2/healthcare-professionals/2343?professionalType=DOCTOR&appointmentId=1234567" \
-H "token: SEU_API_TOKEN"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": {
    },
  • "timestamp": 1591458128186
}

Obter profissional de saúde sem calendario por ID

Obtém profissional de saúde da plataforma por ID

path Parameters
id
required
integer

ID do profissional de saúde

query Parameters
professionalType
required
string
Enum: "NURSE" "PSYCHOLOGIST" "PHYSIOTHERAPIST" "PHONOAUDIOLOGIST" "NUTRITIONIST" "SOCIAL_ASSISTANT" "DOCTOR"

Tipo de profissional

header Parameters
token
required
string

token API

Responses

Request samples 

curl "https://api.conexasaude.com.br/integration/enterprise/v2/healthcare-professionals/without-calendar/2343?professionalType=DOCTOR" \
-H "token: SEU_API_TOKEN"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": {
    },
  • "timestamp": 1591458128186
}

Listar horários disponíveis do profissional de saúde

Lista os horários disponíveis da agenda do profissional de saúde da plataforma

query Parameters
id
required
integer
Example: id=65492

ID do profissional de saúde

date
required
string
Example: date=10/10/2020

Data base para horários disponíveis. Formato dd/MM/yyyy

header Parameters
token
required
string

token API

Responses

Request samples 

curl -X GET "https://api.conexasaude.com.br/integration/enterprise/v2/healthcare-professionals/availabletimes?id=65492&date=10/10/2020" \
-H "token: SEU_API_TOKEN" \
-H "Content-Type: application/json"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": [
    ],
  • "timestamp": 1591458128186
}

Obter profissional de saúde por CPF

Obtém um profissional de saúde da plataforma por CPF

path Parameters
cpf
required
integer

CPF do profissional de saúde

query Parameters
onlyActive
integer

Campo para sinalizar a busca apenas de profissionais de saúde ativos na plataforma.

header Parameters
token
required
string

token API

Responses

Request samples 

curl "https://api.conexasaude.com.br/integration/enterprise/healthcare-professionals/cpf/11122277788?onlyActive=1" \
-H "token: SEU_API_TOKEN"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": {
    },
  • "timestamp": 1591458128186
}

Listar tipos de profissionais de saúde

Lista todos os tipos de profissionais de saúde disponíveis na plataforma

header Parameters
token
required
string

token API

Responses

Request samples 

curl "https://api.conexasaude.com.br/integration/enterprise/healthcare-professionals/types" \
-H "token: SEU_API_TOKEN"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": [
    ],
  • "timestamp": 1591458128186
}

Listar profissionais da saúde pelo nome

Lista os profissionais da saúde de determinado tipo disponíveis para agendamento para o paciente

path Parameters
page
required
integer

Página requerida

query Parameters
professionalType
required
string
Enum: "NURSE" "PSYCHOLOGIST" "PHYSIOTHERAPIST" "PHONOAUDIOLOGIST" "NUTRITIONIST" "SOCIAL_ASSISTANT" "DOCTOR"

Tipo de profissional

patientId
required
integer

ID do paciente

name
string

Nome do profissional para filtrar a busca

theme
string

Tema que o profissional atende para filtrar a busca (Obs. funciona apenas quando o professionalType for PSYCHOLOGIST)

occupationArea
string

Área de ocupação do profissional para filtrar a busca (Obs. funciona apenas quando o professionalType for PSYCHOLOGIST)

specialty
string

Especialidade do profissional para filtrar a busca (Obs. funciona apenas quando o professionalType for PSYCHOLOGIST)

approach
string

Abordagem do profissional para filtrar a busca (Obs. funciona apenas quando o professionalType for PSYCHOLOGIST)

ageRange
string

Faixa etária atendida pelo profissional para filtrar a busca (Obs. funciona apenas quando o professionalType for PSYCHOLOGIST)

searchByTriage
string

true caso queira filtrar apenas profissionais de triagem (Obs. funciona apenas quando o professionalType for PSYCHOLOGIST)

executeCount
string

true caso queira o retorno do total de profissionais na busca paginada (Obs. funciona apenas quando o professionalType for PSYCHOLOGIST)

sortType
string
Enum: "NAME" "NEAREST_DATE"

Tipo de ordenação da listagem

header Parameters
token
required
string

token API

Responses

Request samples 

curl "https://hml-api.conexasaude.com.br/integration/enterprise/v2/healthcare-professionals/name/1?professionalType=DOCTOR" \
-H "token: SEU_API_TOKEN"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": [
    ],
  • "timestamp": 1591458128186
}

Listar os horários disponíveis para agendamento com um profissional de saúde

Lista os horários disponíveis para agendamento com um profissional de saúde. Limitado a um retorno de 4 dias. Seguido a isso pode ser chamado novamente o serviço a partir da última data no retorno para obter mais 4 dias.

path Parameters
id
required
integer

ID do profissional de saúde

query Parameters
startDate
required
integer

Data base para horários disponíveis. Formato dd/MM/yyyy

professionalType
string
Enum: "NURSE" "PSYCHOLOGIST" "PHYSIOTHERAPIST" "PHONOAUDIOLOGIST" "NUTRITIONIST" "SOCIAL_ASSISTANT" "DOCTOR"

Tipo de profissional

patientId
integer

Id do paciente. Obrigatório quando parâmetro professionalType for PSYCHOLOGIST.

header Parameters
token
required
string

token API

Responses

Request samples 

curl -X GET "https://hml-api.conexasaude.com.br/integration/enterprise/v2/healthcare-professionals/1513/schedule/available?startDate=30%2F09%2F2020?professionalType=NURSE" \
-H "token: SEU_API_TOKEN"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": [
    ],
  • "timestamp": 1591458128186
}

Listar relatório de profissionais de saúde

Lista informações de relatórios relacionadas a aos profissionais de saúde da clínica baseado em filtro de busca

query Parameters
active
required
boolean

true para listar relatório de médicos ativos

inactive
required
boolean

true para listar relatóro de médicos inativos

blocked
required
boolean

true para listar relatóro de médicos bloqueados

page
integer

Número da página da listagem de relatório de médicos

header Parameters
token
required
string

token API

Responses

Request samples 

curl "https://api.conexasaude.com.br/integration/enterprise/healthcare-professionals/report?active=false&inactive=false&blocked=false&page=1" \
-H "token: SEU_API_TOKEN"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": [
    ],
  • "timestamp": 1591458128186
}

Gerar link mágico de uso único para profissional

Gera um link mágico de uso único acesso no navegador web para o profissional pelo seu ID

path Parameters
professionalId
required
integer

Identificador do profissional

query Parameters
professionalType
string
Enum: "DOCTOR" "PSYCHOLOGIST" "NUTRITIONIST" "NURSE" "PHYSIOTHERAPIST" "PHONOAUDIOLOGIST" "SOCIAL_ASSISTANT"

Tipo do profissional

route
string

Rota para utilizar na geração da URL

appointmentId
integer

Identificador do atendimento

header Parameters
token
required
string

token API

Responses

Request samples 

curl "https://api.conexasaude.com.br/integration/enterprise/professional/magic-link" \
-H "token: SEU_API_TOKEN"
-d  '{
  "professionalId": 123456
}'

Response samples

Content type
application/json
{}

Buscar profissionais de saúde (v3)

Lista profissionais de saúde disponíveis para agendamento, com filtros por especialidade, data, gênero do paciente e data de nascimento do paciente.

path Parameters
page
required
integer

Número da página solicitada

query Parameters
specialtyId
required
integer
Example: specialtyId=123

ID da especialidade do profissional de saúde

dateTimeSearch
required
string
Example: dateTimeSearch=01/06/2023

Data/hora para busca de disponibilidade (formato dd/MM/yyyy)

genderPatient
required
string
Enum: "MALE" "FEMALE" "OTHERS" "UNINFORMED"
Example: genderPatient=MALE

Gênero do paciente (ID ou valor conforme cadastro)

dateBirth
required
string
Example: dateBirth=15/01/1990

Data de nascimento do paciente (formato dd/MM/yyyy)

patientId
long
Example: patientId=456

ID do paciente

idProfessional
long
Example: idProfessional=789

ID do profissional de saúde

nameProfessional
string
Example: nameProfessional=Dr. Silva

Nome do profissional de saúde

genderProfessional
integer
Example: genderProfessional=2

Gênero do profissional de saúde

executeCount
boolean
Example: executeCount=true

Retornar o total de profissionais encontrados

searchByTriage
boolean

Filtrar apenas profissionais de triagem

sortType
string
Enum: "NAME" "NEAREST_DATE"
Example: sortType=NEAREST_DATE

Tipo de ordenação da listagem

total
integer
Example: total=10

Quantidade total de profissionais a retornar

header Parameters
token
required
string

Token de autenticação da API

Responses

Request samples 

curl --request GET \
  --url 'https://api.conexasaude.com.br/integration/enterprise/v3/healthcare-professionals/1?specialtyId=90&dateTimeSearch=01%2F01%2F2025&genderPatient=MALE&dateBirth=01%2F01%2F1990' \
  --header 'Authorization: Bearer seu_token_aqui' \
  --header 'Content-Type: application/json' \
  --header 'token: SEU_API_TOKEN'

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": [
    ],
  • "timestamp": 1591458128186
}

Listar faixas etárias atendidas por psicólogos

Lista todas as faixas etárias que serão usadas como filtro para buscar psicólogos que atendam determinada faixa etária.

header Parameters
token
required
string

token API

Responses

Request samples 

curl "https://api.conexasaude.com.br/integration/enterprise/healthcare-professionals/psychologists/age-ranges" \
-H "token: SEU_API_TOKEN"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": [
    ],
  • "timestamp": 1591458128186
}

Listar especialidades de psicólogos

Lista todas as especialidades que serão usadas como filtro para buscar psicólogos que tenham determinada especialidade.

header Parameters
token
required
string

token API

Responses

Request samples 

curl "https://api.conexasaude.com.br/integration/enterprise/healthcare-professionals/psychologists/specialties" \
-H "token: SEU_API_TOKEN"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": [
    ],
  • "timestamp": 1591458128186
}

Listar temas atendidos por psicólogos

Lista todos os temas que serão usados como filtro para buscar psicólogos que atendam direcionados a determinado tema.

header Parameters
token
required
string

token API

Responses

Request samples 

curl "https://api.conexasaude.com.br/integration/enterprise/healthcare-professionals/psychologists/themes" \
-H "token: SEU_API_TOKEN"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": [
    ],
  • "timestamp": 1591458128186
}

Listar abordagens atendidas por psicólogos

Lista todas as abordagens que serão usadas como filtro para buscar psicólogos que atendam direcionados a determinada abordagem.

header Parameters
token
required
string

token API

Responses

Request samples 

curl "https://api.conexasaude.com.br/integration/enterprise/healthcare-professionals/psychologists/approaches" \
-H "token: SEU_API_TOKEN"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": [
    ],
  • "timestamp": 1591458128186
}

Listar áreas de atuação atendidas por psicólogos

Lista todas as áreas de atuação que serão usadas como filtro para buscar psicólogos com determinada área de atuação.

header Parameters
token
required
string

token API

Responses

Request samples 

curl "https://api.conexasaude.com.br/integration/enterprise/healthcare-professionals/psychologists/occupation-areas" \
-H "token: SEU_API_TOKEN"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": [
    ],
  • "timestamp": 1591458128186
}

Paciente

Representa os endpoints de pacientes na plataforma Conexa

Inserir ou atualizar pacientes com dependentes

Cria ou altera dados de um paciente com dependentes na plataforma para posterior utilização. Se o parâmetro id for enviado na requisição, serão atualizados os dados daquele paciente com dependentes, se não, então um novo paciente com dependentes será criado.

header Parameters
token
required
string

token API

Request Body schema: application/json

Objeto com informações de paciente e/ou dependente a ser inserido

object (PatientRequest)
Array of objects (PatientFamilyGroupRequest)

Lista de dependentes

Responses

Request samples

Content type
application/json
{
  • "holder": {
    },
  • "dependents": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": {
    },
  • "timestamp": 1591458128186
}

Inserir ou atualizar pacientes

Cria ou altera dados de um paciente na plataforma para posterior utilização. Se o parâmetro id for enviado na requisição, serão atualizados os dados daquele paciente, se não, então um novo paciente será criado.

header Parameters
token
required
string

token API

Request Body schema: application/json

Objeto com informações de paciente e/ou dependente a ser inserido

id
integer

ID do paciente

name
required
string

Nome do Paciente

mail
required
string
Default: "Campo é obrigatorio somente quando a chave da clinica é 'EMAIL'"

E-mail do paciente (deve ser no formato padrão de email xxxxx@xxxx.com)

dateBirth
string

Data de nascimento do paciente (Formato dd/MM/yyyy)

sex
string
Enum: "MALE" "FEMALE"

Sexo do paciente

cpf
required
string
Default: "Campo é obrigatorio somente quando a chave da clinica é 'CPF'"

CPF do paciente

cellphone
string

Celular do paciente (deve sempre ser enviado com 2 digitos para ddd e 9 digitos do celular)

patientHolderId
integer

ID do titular do paciente

patientHolderCpf
string

CPF do titular do paciente

kinshipOfTheHolder
string
Enum: "PAI" "MAE" "CONJUGE" "FILHO" "ENTEADO" "COMPANHEIRO" "AVOS" "BISAVOS" "IRMAOS" "TIOS" "OUTROS"

Grau de Parentesco do Titular

healthCardNumber
required
string
Default: "Campo é obrigatorio somente quando a chave da clinica é 'CARTEIRA_CONVENIO'"

Número do cartão do plano de saúde

additionalInformation
string

Informações adicionais do paciente

passport
string

Número do passaporte do paciente

specialist
integer

TODO

nationalId
string

Número da identidade

object (PatientAddressRequest)

Objeto com informações de endereço de paciente

motherName
string

Campo para informar o nome da mãe do paciente (O campo deve conter no máximo 80 caracteres)

socialName
string

Campo para informar o nome social do paciente (O campo deve conter no máximo 80 caracteres)

idRaceColor
integer

ID da cor da raça do paciente (código recuperado no endpoint da aba Dominio -> Listar as informações e Raça/cor)

idNationality
integer

ID da nacionalidade do paciente (código recuperado no endpoint da aba Dominio -> Listar as informações de nacionalidades)

naturalizationDate
string

Data de naturalização

cns
string

Número da cns do paciente (O campo deve conter no máximo 15 caracteres)

idCbo
long

ID do CBO do paciente

religion
integer

ID da religião do paciente (código recuperado no endpoint da aba Dominio -> Listar as informações de Religiões)

otherReligions
string

Campo destinado para caso o paciente seja de alguma outra religião

workplace
string

Campo para informar o local de trabalho

freeObservations
string

Campo livre destinado para colocar qualquer informação (observação)

unknowMother
boolean

Campo para sinalizar que a mãe do paciente é desconhecida.

idHomeArea
integer

Campo para indicar o código da area de moradia (código recuperado no endpoint da aba Dominio -> Listar as informações de área de moradia)

homeSituation
boolean

Campo que indica a situação da moradia do paciente

idSchooling
integer

Campo para indicar a escolaridade do paciente (código recuperado no endpoint da aba Dominio -> Listar as informações de Escolaridades)

socialVulnerability
boolean

Campo que sinaliza a vulnerabilidade social do paciente

ethnicity
string

Campo para informar a etnia do paciente

idGender
long

Campo para indicar o gênero do paciente (código recuperado no endpoint da aba Dominio -> Listar as informações de Gênero)

birthCounty
string

Campo para informar o município de nascimento do paciente

idBirthUF
long

Campo para indicar a UF de nascimento do paciente (código recuperado no endpoint da aba Dominio -> Listar as informações de UF)

idPassportIssuingCountry
long

Campo para indicar o país de nascimento do paciente (código recuperado no endpoint da aba Dominio -> Listar as informações de País)

passportIssuingDate
string

Campo para informar a data de emissão do passaporte do paciente

passportExpiryDate
string

Campo para informar a data de expiração do passaporte do paciente

idBirthCountry
long

Campo para indicar o país de nascimento do paciente (código recuperado no endpoint da aba Dominio -> Listar as informações de País)

kinshipProcurator
string
Enum: "PAI" "MAE" "CONJUGE" "FILHO" "ENTEADO" "COMPANHEIRO" "AVOS" "BISAVOS" "IRMAOS" "TIOS" "OUTROS"

Grau de Parentesco do representante legal do paciente

cpfProcurator
string

Campo para informar o cpf do representante legal do paciente

nameProcurator
string

Campo para informar o nome do representante legal do paciente (O campo deve conter no máximo 80 caracteres)

identityIssuingDate
string

Campo para informar a data de emissão da identidade do paciente

idIdentityUF
long

Campo para indicar a UF da identidade do paciente (código recuperado no endpoint da aba Dominio -> Listar as informações de UF)

identityIssuingBody
string

Campo para informar o orgão emissor da identidade do paciente (O campo deve conter no máximo 50 caracteres)

nisNumber
string

Campo para informar o número de NIS (Número de Identificação Social) do paciente (O campo deve conter no máximo 11 caracteres)

flagAps
boolean

Campo para sinalizar que paciente participa do programa atenção primária à saúde (APS)

idPlanType
long

Campo para informar o identificador do tipo de plano.

registration
required
string
Default: "Campo é obrigatorio somente quando a chave da clinica é 'MATRICULA'"

Campo para informar a Matrícula do paciente.

healthPlan
string

Campo para informar o Plano de saúde do paciente.

enterprise
string

Campo para informar a Empresa do paciente.

department
string

Campo para informar o Departamento do paciente.

patientRole
string

Campo para informar o Cargo do paciente.

clinicPlan
string

Campo para informar o nome do Plano do paciente (que deve estar configurado na Clínica).

Responses

Request samples

Content type
application/json
{
  • "id": 401,
  • "name": "Steve Hopkins",
  • "mail": "steve.hopkins@gmail.com",
  • "dateBirth": "26/04/1985",
  • "sex": "MALE",
  • "cpf": "33311155511",
  • "cellphone": "21988776554",
  • "patientHolderId": 24521,
  • "patientHolderCpf": "98354881008",
  • "kinshipOfTheHolder": "PAI",
  • "healthCardNumber": "1113335556667",
  • "additionalInformation": "Matrícula 663399-6",
  • "passport": "BR123456",
  • "specialist": 199,
  • "nationalId": "20112527-9",
  • "address": {
    },
  • "motherName": "Maria Silva",
  • "socialName": "Steve H.",
  • "idRaceColor": 1,
  • "idNationality": 1,
  • "naturalizationDate": "26/09/2005",
  • "cns": 123456789101213,
  • "idCbo": 2,
  • "religion": 1,
  • "otherReligions": "string",
  • "workplace": "Coworking",
  • "freeObservations": "Exemplo de texto/observação do paciente",
  • "unknowMother": false,
  • "idHomeArea": 1,
  • "homeSituation": true,
  • "idSchooling": 1,
  • "socialVulnerability": false,
  • "ethnicity": "Indígena",
  • "idGender": 1,
  • "birthCounty": "Rio de Janeiro",
  • "idBirthUF": 1,
  • "idPassportIssuingCountry": 1,
  • "passportIssuingDate": "17/10/2015",
  • "passportExpiryDate": "17/10/2020",
  • "idBirthCountry": 1,
  • "kinshipProcurator": "PAI",
  • "cpfProcurator": "042.858.780-11",
  • "nameProcurator": "Luiz da Silva",
  • "identityIssuingDate": "17/10/2002",
  • "idIdentityUF": 1,
  • "identityIssuingBody": "Detran",
  • "nisNumber": 72673612,
  • "flagAps": false,
  • "idPlanType": 1,
  • "registration": "MATRICULATESTE",
  • "healthPlan": "PLANOTESTE",
  • "enterprise": "EMPRESATESTE",
  • "department": "DEPARTAMENTOTESTE",
  • "patientRole": "CARGOTESTE",
  • "clinicPlan": "PLANOSILVER"
}

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": {
    },
  • "timestamp": 1591458128186
}

Inserir ou atualizar pacientes por CPF ou Número do cartão de convênio

Cria ou altera dados de um paciente na plataforma para posterior utilização. Se o parâmetro id, cpf ou healthCardNumber for enviado na requisição para um paciente existente, serão atualizados os dados daquele paciente, se não, então um novo paciente será criado.

header Parameters
token
required
string

token API

Request Body schema: application/json

Objeto com informações de paciente e/ou dependente a ser inserido

id
integer

ID do paciente

name
required
string

Nome do Paciente

mail
required
string
Default: "Campo é obrigatorio somente quando a chave da clinica é 'EMAIL'"

E-mail do paciente (deve ser no formato padrão de email xxxxx@xxxx.com)

dateBirth
string

Data de nascimento do paciente (Formato dd/MM/yyyy)

sex
string
Enum: "MALE" "FEMALE"

Sexo do paciente

cpf
required
string
Default: "Campo é obrigatorio somente quando a chave da clinica é 'CPF'"

CPF do paciente

cellphone
string

Celular do paciente (deve sempre ser enviado com 2 digitos para ddd e 9 digitos do celular)

patientHolderId
integer

ID do titular do paciente

patientHolderCpf
string

CPF do titular do paciente

kinshipOfTheHolder
string
Enum: "PAI" "MAE" "CONJUGE" "FILHO" "ENTEADO" "COMPANHEIRO" "AVOS" "BISAVOS" "IRMAOS" "TIOS" "OUTROS"

Grau de Parentesco do Titular

healthCardNumber
required
string
Default: "Campo é obrigatorio somente quando a chave da clinica é 'CARTEIRA_CONVENIO'"

Número do cartão do plano de saúde

additionalInformation
string

Informações adicionais do paciente

passport
string

Número do passaporte do paciente

specialist
integer

TODO

nationalId
string

Número da identidade

object (PatientAddressRequest)

Objeto com informações de endereço de paciente

motherName
string

Campo para informar o nome da mãe do paciente (O campo deve conter no máximo 80 caracteres)

socialName
string

Campo para informar o nome social do paciente (O campo deve conter no máximo 80 caracteres)

idRaceColor
integer

ID da cor da raça do paciente (código recuperado no endpoint da aba Dominio -> Listar as informações e Raça/cor)

idNationality
integer

ID da nacionalidade do paciente (código recuperado no endpoint da aba Dominio -> Listar as informações de nacionalidades)

naturalizationDate
string

Data de naturalização

cns
string

Número da cns do paciente (O campo deve conter no máximo 15 caracteres)

idCbo
long

ID do CBO do paciente

religion
integer

ID da religião do paciente (código recuperado no endpoint da aba Dominio -> Listar as informações de Religiões)

otherReligions
string

Campo destinado para caso o paciente seja de alguma outra religião

workplace
string

Campo para informar o local de trabalho

freeObservations
string

Campo livre destinado para colocar qualquer informação (observação)

unknowMother
boolean

Campo para sinalizar que a mãe do paciente é desconhecida.

idHomeArea
integer

Campo para indicar o código da area de moradia (código recuperado no endpoint da aba Dominio -> Listar as informações de área de moradia)

homeSituation
boolean

Campo que indica a situação da moradia do paciente

idSchooling
integer

Campo para indicar a escolaridade do paciente (código recuperado no endpoint da aba Dominio -> Listar as informações de Escolaridades)

socialVulnerability
boolean

Campo que sinaliza a vulnerabilidade social do paciente

ethnicity
string

Campo para informar a etnia do paciente

idGender
long

Campo para indicar o gênero do paciente (código recuperado no endpoint da aba Dominio -> Listar as informações de Gênero)

birthCounty
string

Campo para informar o município de nascimento do paciente

idBirthUF
long

Campo para indicar a UF de nascimento do paciente (código recuperado no endpoint da aba Dominio -> Listar as informações de UF)

idPassportIssuingCountry
long

Campo para indicar o país de nascimento do paciente (código recuperado no endpoint da aba Dominio -> Listar as informações de País)

passportIssuingDate
string

Campo para informar a data de emissão do passaporte do paciente

passportExpiryDate
string

Campo para informar a data de expiração do passaporte do paciente

idBirthCountry
long

Campo para indicar o país de nascimento do paciente (código recuperado no endpoint da aba Dominio -> Listar as informações de País)

kinshipProcurator
string
Enum: "PAI" "MAE" "CONJUGE" "FILHO" "ENTEADO" "COMPANHEIRO" "AVOS" "BISAVOS" "IRMAOS" "TIOS" "OUTROS"

Grau de Parentesco do representante legal do paciente

cpfProcurator
string

Campo para informar o cpf do representante legal do paciente

nameProcurator
string

Campo para informar o nome do representante legal do paciente (O campo deve conter no máximo 80 caracteres)

identityIssuingDate
string

Campo para informar a data de emissão da identidade do paciente

idIdentityUF
long

Campo para indicar a UF da identidade do paciente (código recuperado no endpoint da aba Dominio -> Listar as informações de UF)

identityIssuingBody
string

Campo para informar o orgão emissor da identidade do paciente (O campo deve conter no máximo 50 caracteres)

nisNumber
string

Campo para informar o número de NIS (Número de Identificação Social) do paciente (O campo deve conter no máximo 11 caracteres)

flagAps
boolean

Campo para sinalizar que paciente participa do programa atenção primária à saúde (APS)

idPlanType
long

Campo para informar o identificador do tipo de plano.

registration
required
string
Default: "Campo é obrigatorio somente quando a chave da clinica é 'MATRICULA'"

Campo para informar a Matrícula do paciente.

healthPlan
string

Campo para informar o Plano de saúde do paciente.

enterprise
string

Campo para informar a Empresa do paciente.

department
string

Campo para informar o Departamento do paciente.

patientRole
string

Campo para informar o Cargo do paciente.

clinicPlan
string

Campo para informar o nome do Plano do paciente (que deve estar configurado na Clínica).

Responses

Request samples

Content type
application/json
{
  • "id": 401,
  • "name": "Steve Hopkins",
  • "mail": "steve.hopkins@gmail.com",
  • "dateBirth": "26/04/1985",
  • "sex": "MALE",
  • "cpf": "33311155511",
  • "cellphone": "21988776554",
  • "patientHolderId": 24521,
  • "patientHolderCpf": "98354881008",
  • "kinshipOfTheHolder": "PAI",
  • "healthCardNumber": "1113335556667",
  • "additionalInformation": "Matrícula 663399-6",
  • "passport": "BR123456",
  • "specialist": 199,
  • "nationalId": "20112527-9",
  • "address": {
    },
  • "motherName": "Maria Silva",
  • "socialName": "Steve H.",
  • "idRaceColor": 1,
  • "idNationality": 1,
  • "naturalizationDate": "26/09/2005",
  • "cns": 123456789101213,
  • "idCbo": 2,
  • "religion": 1,
  • "otherReligions": "string",
  • "workplace": "Coworking",
  • "freeObservations": "Exemplo de texto/observação do paciente",
  • "unknowMother": false,
  • "idHomeArea": 1,
  • "homeSituation": true,
  • "idSchooling": 1,
  • "socialVulnerability": false,
  • "ethnicity": "Indígena",
  • "idGender": 1,
  • "birthCounty": "Rio de Janeiro",
  • "idBirthUF": 1,
  • "idPassportIssuingCountry": 1,
  • "passportIssuingDate": "17/10/2015",
  • "passportExpiryDate": "17/10/2020",
  • "idBirthCountry": 1,
  • "kinshipProcurator": "PAI",
  • "cpfProcurator": "042.858.780-11",
  • "nameProcurator": "Luiz da Silva",
  • "identityIssuingDate": "17/10/2002",
  • "idIdentityUF": 1,
  • "identityIssuingBody": "Detran",
  • "nisNumber": 72673612,
  • "flagAps": false,
  • "idPlanType": 1,
  • "registration": "MATRICULATESTE",
  • "healthPlan": "PLANOTESTE",
  • "enterprise": "EMPRESATESTE",
  • "department": "DEPARTAMENTOTESTE",
  • "patientRole": "CARGOTESTE",
  • "clinicPlan": "PLANOSILVER"
}

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": {
    },
  • "timestamp": 1591458128186
}

Obter paciente por ID

Obtém dados cadastrais de um paciente por ID

path Parameters
id
required
integer

ID do paciente

header Parameters
token
required
string

token API

Responses

Request samples 

curl "https://api.conexasaude.com.br/integration/enterprise/patients/401" \
-H "token: SEU_API_TOKEN"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": {
    },
  • "timestamp": 1591458128186
}

Obter paciente por CPF

Obtém dados cadastrais de paciente por CPF

path Parameters
cpf
required
integer

CPF do paciente

header Parameters
token
required
string

token API

Responses

Request samples 

curl "https://api.conexasaude.com.br/integration/enterprise/patients/cpf/33311155511" \
-H "token: SEU_API_TOKEN"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": {
    },
  • "timestamp": 1591458128186
}

Obter qualquer paciente bloqueado e ou ativo por CPF

Obtém dados cadastrais de paciente por CPF

path Parameters
cpf
required
integer

CPF do paciente

header Parameters
token
required
string

token API

Responses

Request samples 

curl "https://api.conexasaude.com.br/integration/enterprise/any/patients/cpf/33311155511" \
-H "token: SEU_API_TOKEN"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": {
    },
  • "timestamp": 1591458128186
}

Obter paciente número do cartão de convênio

Obtém dados cadastrais de paciente pelo número do cartão de convênio (carteirinha)

path Parameters
healthCardNumber
required
integer

Número do cartão de convênio do paciente

header Parameters
token
required
string

token API

Responses

Request samples 

curl "https://api.conexasaude.com.br/integration/enterprise/patients/healthCardNumber/1113335556667" \
-H "token: SEU_API_TOKEN"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": {
    },
  • "timestamp": 1591458128186
}

Ativar paciente por ID

Altera o status do paciente na plataforma para `ativo´ pelo seu ID

path Parameters
id
required
integer

ID do paciente

header Parameters
token
required
string

token API

Responses

Request samples 

curl -X POST "https://api.conexasaude.com.br/integration/enterprise/v2/patients/401/activate" \
-H "token: SEU_API_TOKEN"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": true,
  • "timestamp": 1591458128186
}

Inativar paciente por ID

Altera o status do paciente na plataforma para inativo pelo seu ID

path Parameters
id
required
integer

ID do paciente

header Parameters
token
required
string

token API

Responses

Request samples 

curl -X POST "https://api.conexasaude.com.br/integration/enterprise/v2/patients/401/inactivate" \
-H "token: SEU_API_TOKEN"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": true,
  • "timestamp": 1591458128186
}

Bloquear paciente por ID

Bloqueia o acesso do paciente à plataforma pelo seu ID

path Parameters
id
required
integer

ID do paciente

header Parameters
token
required
string

token API

Responses

Request samples 

curl -X POST "https://api.conexasaude.com.br/integration/enterprise/v2/patients/401/block" \
-H "token: SEU_API_TOKEN"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": true,
  • "timestamp": 1591458128186
}

Desbloquear paciente por ID

Desbloqueia o paciente pelo seu ID para poder acessar à plataforma

path Parameters
id
required
integer

ID do paciente

header Parameters
token
required
string

token API

Responses

Request samples 

curl -X POST "https://api.conexasaude.com.br/integration/enterprise/v2/patients/401/unblock" \
-H "token: SEU_API_TOKEN" \
-H "Content-Type: application/json"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": true,
  • "timestamp": 1591458128186
}

Bloquear paciente por número do cartão de convênio

Bloqueia paciente de acessar a plataforma pelo número do seu cartão de convênio (carteirinha)

path Parameters
healthCardNumber
required
integer

Número do cartão de convênio do paciente

header Parameters
token
required
string

token API

Responses

Request samples 

curl -X POST "https://api.conexasaude.com.br/integration/enterprise/v2/patients/healthCard/1113335556667/block" \
-H "token: SEU_API_TOKEN" \
-H "Content-Type: application/json"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": true,
  • "timestamp": 1591458128186
}

Desbloquear paciente por número do cartão de convênio

Desbloqueia paciente de acessar a plataforma pelo número do seu cartão de convênio (carteirinha)

path Parameters
healthCardNumber
required
integer

Número do cartão de convênio do paciente

header Parameters
token
required
string

token API

Responses

Request samples 

curl -X POST "https://api.conexasaude.com.br/integration/enterprise/v2/patients/healthCard/1113335556667/unblock" \
-H "token: SEU_API_TOKEN" \
-H "Content-Type: application/json"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": true,
  • "timestamp": 1591458128186
}

Obter status de paciente por CPF

Obtém o status do paciente, indicando se o mesmo está ativo e/ou bloqueado a partir do seu CPF

path Parameters
cpf
required
integer

CPF do paciente

header Parameters
token
required
string

token API

Responses

Request samples 

curl "https://api.conexasaude.com.br/integration/enterprise/patients/status/cpf/33311155511" \
-H "token: SEU_API_TOKEN"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": {
    },
  • "timestamp": 1591458128186
}

Obter status de paciente por número do cartão de convênio

Obtém o status do paciente, indicando se o mesmo está ativo e/ou bloqueado a partir do número do seu cartão de convênio (carteirinha)

path Parameters
healthCardNumber
required
integer

Número do cartão de convênio do paciente

header Parameters
token
required
string

token API

Responses

Request samples 

curl "https://api.conexasaude.com.br/integration/enterprise/patients/status/healthCardNumber/1113335556667" \
-H "token: SEU_API_TOKEN"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": {
    },
  • "timestamp": 1591458128186
}

Obter status de paciente por ID

Obtém o status do paciente, indicando se o mesmo está ativo e/ou bloqueado a partir do seu ID

path Parameters
id
required
integer

ID do paciente

header Parameters
token
required
string

token API

Responses

Request samples 

curl "https://api.conexasaude.com.br/integration/enterprise/patients/status/id/401" \
-H "token: SEU_API_TOKEN"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": {
    },
  • "timestamp": 1591458128186
}

Resetar senha de paciente por ID

Reseta a senha do paciente na plataforma pelo seu ID. O paciente receberá um E-mail com uma nova senha para acessar a plataforma.

path Parameters
id
required
integer

ID do paciente

header Parameters
token
required
string

token API

Responses

Request samples 

curl -X POST "https://api.conexasaude.com.br/integration/enterprise/v2/patients/401/reset-password" \
-H "token: SEU_API_TOKEN" \
-H "Content-Type: application/json"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": true,
  • "timestamp": 1591458128186
}

Enviar E-mail de boas vindas ao paciente por ID

Envia o E-mail de boas vindas ao paciente com informações de acesso e utilização da plataforma

path Parameters
id
required
integer

ID do paciente

header Parameters
token
required
string

token API

Responses

Request samples 

curl -X POST "https://api.conexasaude.com.br/integration/enterprise/v2/patients/401/send-welcome-mail" \
-H "token: SEU_API_TOKEN" \
-H "Content-Type: application/json"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": true,
  • "timestamp": 1591458128186
}

Alterar celular de paciente por ID

Altera número do telefone celular de um paciente na plataforma pelo seu ID

path Parameters
id
required
string

ID do paciente

header Parameters
token
required
string

token API

Request Body schema: application/json

Objeto com informações de paciente a serem alteradas

newCellphoneNumber
required
string

Novo número do telefone celular do paciente (deve sempre ser enviado com 2 digitos para ddd e 9 digitos do celular)

Responses

Request samples

Content type
application/json
{
  • "newCellphoneNumber": "21999777555"
}

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": true,
  • "timestamp": 1591458128186
}

Alterar E-mail de paciente por ID

Altera E-mail de um paciente na plataforma pelo seu ID

path Parameters
id
required
string

ID do paciente

header Parameters
token
required
string

token API

Request Body schema: application/json

Objeto com informações de paciente a serem alteradas

newMail
required
string

Novo E-mail do paciente (deve ser no formato padrão de email xxxxx@xxxx.com)

Responses

Request samples

Content type
application/json
{
  • "newMail": "myNewEmail@gmail.com"
}

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": true,
  • "timestamp": 1591458128186
}

Inserir endereço de paciente por ID

Insere informações completas de endereço de um paciente na plataforma pelo seu ID

path Parameters
id
required
string

ID do paciente

header Parameters
token
required
string

token API

Request Body schema: application/json

Objeto com informações de endereço de paciente a serem inseridas

additionalAddressDetails
string

Informações adicionais do endereço

city
string

Cidade

country
string

País

region
string

Bairro

state
string
Enum: "RJ" "AC" "AM" "RR" "PA" "AP" "TO" "MA" "PI" "CE" "RN" "PB" "PE" "AL" "SE" "BA" "MG" "ES" "RO" "SP" "PR" "SC" "RS" "MS" "MT" "GO" "DF"

Estado (deverá ser uma UF válida)

streetAddress
string

Logradouro

numberAddress
string

Número do logradouro

zipCode
string

Número do CEP (deverá ser um cep válido)

Responses

Request samples

Content type
application/json
{
  • "additionalAddressDetails": "Em frente à clínica Rede Conexa",
  • "city": "Rio de Janeiro",
  • "country": "Brasil",
  • "region": "Ipanema",
  • "state": "RJ",
  • "streetAddress": "Rua da Passagem",
  • "numberAddress": 410,
  • "zipCode": 22780070
}

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": true,
  • "timestamp": 1591458128186
}

Alterar Senha do paciente

Altera senha de um paciente na plataforma pelo seu ID, lembrando que a senha deve ter ao menos 8 caracteres

path Parameters
id
required
string

ID do paciente

header Parameters
token
required
string

token API

Request Body schema: application/json

Objeto com a senha e a confirmação de senha para a atualização.

password
required
string

Senha desejada para a alteração

passwordConfirmation
required
string

Confirmação da senha desejada

Responses

Request samples

Content type
application/json
{
  • "password": 11111111,
  • "passwordConfirmation": 11111111
}

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": true,
  • "timestamp": 1591458128186
}

Aceitar de termos por paciente

Aceita o termo de uso da plataforma para um paciente

header Parameters
token
required
string

token API

Request Body schema: application/json

Objeto com informações para aceite de termos

idPatient
required
integer

ID do paciente

ip
required
string

IP do paciente para ser salvo no log de aceite do termo

Responses

Request samples

Content type
application/json
{
  • "idPatient": 401,
  • "ip": "191.163.30.215"
}

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": true,
  • "timestamp": 1591458128186
}

Obter aceite de termos do paciente por ID

Retorna o status do aceite do termo do paciente, caso ele já tenha aceitado o termo, virá true caso não tenha false

path Parameters
id
required
integer

ID do paciente

header Parameters
token
required
string

token API

Responses

Request samples 

curl "https://api.conexasaude.com.br/integration/enterprise/patients/401/term/accept" \
-H "token: SEU_API_TOKEN"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": true,
  • "timestamp": 1591458128186
}

Listar pacientes por nome e data de nascimento

Lista pacientes com os filtros de nome e data de nascimento (nome deverá ser exatamente como foi cadastrado, nome completo)

query Parameters
dateBirth
required
string
Example: dateBirth=26/04/1985

Data de nascimento. Formato dd/MM/yyy

name
required
string
Example: name=Steve

Nome do paciente

header Parameters
token
required
string

token API

Responses

Request samples 

curl -X GET "https://api.conexasaude.com.br/integration/enterprise/v2/patients/filter?dateBirth=26/04/1985&name=Steve" \
-H "token: SEU_API_TOKEN" \
-H "Content-Type: application/json"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": [
    ],
  • "timestamp": 1591458128186
}

Gerar link mágico para paciente

Gera um link mágico para aplicativo móvel e um para acesso no navegador web para o paciente pelo seu ID

path Parameters
id
required
integer

ID do paciente

query Parameters
route
string
Enum: "immediate-appointment" "scheduled-appointment" "scheduled-appointment-by-specialty" "scheduled-appointment-by-name" "scheduled-appointment-by-professional-id" "waiting-room" "my-appointments"

Indica para qual rota o link mágico vai direcionar o paciente. As opções são "immediate-appointment" (atendimentos imediato), "scheduled-appointment" (atendimentos agendados), "scheduled-appointment-by-specialty" (atendimentos agendados com busca de especialidades), "scheduled-appointment-by-name" (atendimentos agendados com busca por nome), "scheduled-appointment-by-professional-id" (atendimentos agendados acessando os horários do profissional), "waiting-room" (sala de espera) e "my-appointments" (meus atendimentos)

appointmentId
integer

Id do atendimento (Obrigatório se route for ´waiting-room´)

professionalId
integer

Id do profissional (Obrigatório se route for ´scheduled-appointment-by-professional-id´)

council
string
Enum: "CRM" "CRN" "CRO" "COREN" "CRP" "CREFITO" "CREFONO" "CFESS" "CONTER" "CFBM" "ACADEMICO"

Indica se já quer entrar logado com um tipo de conselho específico na busca (Obrigatório se route tiver prefixo ´scheduled-appointment´)

embed
boolean

Indica se irá desabilitar ou não o header(cabeçalho) da aplicação do paciente.

embedFull
boolean

Indica se irá desabilitar ou não o header(cabeçalho) completo da aplicação do paciente.

navbarEmbed
boolean

Indica se irá desabilitar as opções sair e suporte. (Deve ser enviado junto do parâmetro embed=true)

header Parameters
token
required
string

token API

Responses

Request samples 

curl "https://api.conexasaude.com.br/integration/enterprise/patients/generate-magiclink-access-app/401" \
-H "token: SEU_API_TOKEN"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": {},
  • "timestamp": 1591458128186
}

Listar pacientes da clínica

Lista todos os pacientes da clínica na ordem definida baseado na paginação. São listados 100 registros por chamada

path Parameters
page
required
integer

Número da página da listagem de pacientes

query Parameters
orderBy
string
Enum: "NAME" "ID"

Forma de ordenação da lista, podendo ser ordenado por nome dos pacientes ou ordernado pelo ID

header Parameters
token
required
string

token API

Responses

Request samples 

curl "https://api.conexasaude.com.br/integration/enterprise/patients/list/1" \
-H "token: SEU_API_TOKEN"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": [
    ],
  • "timestamp": 1591458128186
}

Listar relatório de pacientes

Lista informações de relatórios relacionadas aos pacientes da clínica baseado em filtro de busca (com informações de paginação)

query Parameters
active
boolean
Default: false

true para listar relatório de pacientes ativos

inactive
boolean
Default: false

true para listar relatóro de pacientes inativos

pendent
boolean
Default: false

true para listar relatóro de pacientes pendentes de ativação

blocked
boolean
Default: false

true para listar relatóro de pacientes bloqueados

unlocked
boolean
Default: false

true para listar relatóro de pacientes desbloqueados

page
integer
Default: 1

Número da página da listagem de relatório de pacientes

header Parameters
token
required
string

token API

Responses

Request samples 

curl "https://api.conexasaude.com.br/integration/enterprise/patients-report?active=true&inactive=true&pendent=true&blocked=true&unlocked=true&page=1" \
-H "token: SEU_API_TOKEN"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": [
    ],
  • "timestamp": 1591458128186
}

Listar pagamentos realizado pelo paciente

Lista informações de pagamentos dos atendimentos relacionadas ao paciente da clínica dentro de um período informado

path Parameters
id
required
integer

ID do paciente

query Parameters
startDate
required
string

Data inicial (Formato yyyy-MM-dd)

endDate
required
string

Data final (Formato yyyy-MM-dd)

header Parameters
token
required
string

token API

Responses

Request samples 

curl "https://api.conexasaude.com.br/integration/enterprise/patients/1/payments?startDate=2020-04-14&endDate=2020-04-15" \
-H "token: SEU_API_TOKEN"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": [
    ],
  • "timestamp": 1591458128186
}

Listar todas as medições realizadas na cabine

Retorna as informações das medições realizadas pelo paciente em uma cabine da Teleworld

path Parameters
patientId
required
integer

ID do paciente

header Parameters
token
required
string

token API

Responses

Request samples 

curl "https://api.conexasaude.com.br/integration/enterprise/patients/3961767/mensurations" \
-H "token: SEU_API_TOKEN"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": [
    ],
  • "timestamp": 1655776875581
}

Listar todas as medições realizadas na cabine por data

Retorna as informações das medições realizadas nas cabine da Teleworld, por período de datas ou id de paciente

header Parameters
token
required
string

token API

Request Body schema: application/json

Objeto com informações da pesquisa, deve-se informar a data inicial ou o id de paciente. (Priorizamos o ID do paciente na pesquisa)

initialDate
required
string

Data de inicial (Formato yyyy-MM-dd)

finalDate
string

Data de final (Formato yyyy-MM-dd)

patientId
integer

ID do paciente

Responses

Request samples

Content type
application/json
{
  • "initialDate": "2022-06-29",
  • "finalDate": "2022-06-30",
  • "patientId": null
}

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": [
    ],
  • "timestamp": 1655776875581
}

Login do paciente (link mágico)

Gera um link mágico para aplicativo móvel e um para acesso no navegador web para o paciente pelo seu login (email/cpf e senha)

header Parameters
token
required
string

token API

Request Body schema: application/json

Objeto com informações do login do paciente

email
required
string

Email ou cpf do paciente

senha
string

Senha do paciente

Responses

Request samples

Content type
application/json
{
  • "email": "teste@teste.com.br ou 527.319.660-41",
  • "senha": "paciente123"
}

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": {},
  • "timestamp": 1591458128186
}

Cartão

Representa os endpoints para gerenciamento de cartões de crédito na plataforma Conexa

Salvar cartão de crédito

Salva o cartão de crédito do paciente

path Parameters
patientId
required
integer

ID do paciente

header Parameters
token
required
string

token API

Request Body schema: application/json

Objeto com informações do cartão do paciente

holderName
required
string

Nome do titular do cartão

cardNumber
required
string

Número do cartão

cardExpiration
required
string

Validade do cartão. Formato MM/YYYY

cardSecurityNumber
required
string

Código de segurança do cartão

Responses

Request samples

Content type
application/json
{
  • "holderName": "IGOR P SILVA",
  • "cardNumber": 5148311470887020,
  • "cardExpiration": "10/2022",
  • "cardSecurityNumber": 123
}

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": {
    },
  • "timestamp": 1591458128186
}

Listar cartões de crédito salvos

Lista cartões de crédito do paciente

path Parameters
patientId
required
integer

ID do paciente

header Parameters
token
required
string

token API

Responses

Request samples 

curl --location --request GET 'https://api.conexasaude.com.br/integration/enterprise/patients/{patientId}/credit-cards' \
-H "token: SEU_API_TOKEN" \
-H "Content-Type: application/json"

Response samples

Content type
application/json
{}

Marcar cartão como default

Marca o cartão para ser usado como cartão padrão (default)

path Parameters
cardId
required
integer

ID do cartão a ser marcado como default

patientId
required
integer

ID do paciente

header Parameters
token
required
string

token API

Responses

Request samples 

curl --location --request PATCH 'https://api.conexasaude.com.br/integration/enterprise/patients/{patientId}/credit-cards/{creditCardId}/default' \
-H "token: SEU_API_TOKEN" \
-H "Content-Type: application/json"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "timestamp": 1591458128186
}

Deletar cartão

Deleta o cartão passado no path

path Parameters
cardId
required
integer

ID do cartão a ser deletado

patientId
required
integer

ID do paciente

header Parameters
token
required
string

token API

Responses

Request samples 

curl --location --request DELETE 'https://api.conexasaude.com.br/integration/enterprise/patients/{patientId}/credit-cards/{creditCardId}' \
-H "token: SEU_API_TOKEN" \
-H "Content-Type: application/json"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "timestamp": 1591458128186
}

Preços

Representa os endpoints para verificação de valores de consulta na plataforma Conexa

Listar preços de profissionais por ID

Lista preços de profissionais por ID

path Parameters
professionalId
required
integer

ID do profissional

header Parameters
token
required
string

token API

Responses

Request samples 

curl --location --request GET 'https://api.conexasaude.com.br/integration/enterprise/professionals/id/{professionalId}/prices' \
-H "token: SEU_API_TOKEN" \
-H "Content-Type: application/json"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": [
    ],
  • "timestamp": 1591458128186
}

Listar preços de profissionais por tipo

Lista preços de profissionais por tipo

query Parameters
professionalType
required
string
Default: ["DOCTOR"]
Enum: "DOCTOR" "NURSE" "PSYCHOLOGIST" "NUTRITIONIST" "DENTIST" "PHYSIOTHERAPIST" "PHONOAUDIOLOGIST" "SOCIAL_ASSISTANT" "HEALTH_COACH" "PHYSICAL_EDUCATOR"

Tipo profissional

header Parameters
token
required
string

token API

Responses

Request samples 

curl --location --request GET 'https://api.conexasaude.com.br/integration/enterprise/professionals/prices?professionalType=DOCTOR' \
-H "token: SEU_API_TOKEN" \
-H "Content-Type: application/json"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": [
    ],
  • "timestamp": 1591458128186
}

NPS

Representa os endpoints de NPS na plataforma Conexa

Salvar avaliação de um atendimento.

Salva uma avaliação do Profissional / Plataforma de um atendimento.

header Parameters
token
required
string

token API

Request Body schema: application/json

Objeto com informações da avaliação do atendimento

appointmentId
required
integer

ID do atendimento referente à avaliação

required
object (Evaluation)

Objeto com informações do conteudo de uma avaliação realizada

required
object (Evaluation)

Objeto com informações do conteudo de uma avaliação realizada

Responses

Request samples

Content type
application/json
{
  • "appointmentId": 999,
  • "professional": {
    },
  • "plataform": {
    }
}

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": true,
  • "timestamp": 1591458128186
}

Reenvia NPS para atendimento já concluído.

Reenvia NPS para atendimento já concluído.

path Parameters
appointmentId
required
integer

ID do atendimento

header Parameters
token
required
string

token API

Responses

Request samples 

 Response samples 
Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": [
    ],
  • "timestamp": 1591458128186
}
Lista de NPS por período 
Retorna uma lista de NPS dentro do período informado.


query Parameters
startDate
 required 
string
 
Data inicial (Formato yyyy-MM-dd)


endDate
 required 
string
 
Data final (Formato yyyy-MM-dd)


header Parameters
token
 required 
string
 
token API


Responses
 Request samples 
curl "https://api.conexasaude.com.br/integration/enterprise/nps/filter?startDate=2020-04-01&endDate=2020-04-10" \
-H "token: SEU_API_TOKEN"

 Response samples 
Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": [
    ],
  • "timestamp": 1591458128186
}
Lista de NPS de um atendimento especifico 
Retorna uma lista de NPS de um atendimento específico


path Parameters
appointmentId
 required 
integer
 
ID do atendimento


header Parameters
token
 required 
string
 
token API


Responses
 Request samples 
curl "https://api.conexasaude.com.br/integration/enterprise/nps/12345/appointment" \
-H "token: SEU_API_TOKEN"

 Response samples 
Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": [
    ],
  • "timestamp": 1591458128186
}
Clínica
Representa os endpoints de clínica na plataforma Conexa


Obter configuração da clínica 
Obtém informações das configurações da clínica


header Parameters
token
 required 
string
 
token API


Responses
 Request samples 
curl "https://api.conexasaude.com.br/integration/enterprise/clinic/config" \
-H "token: SEU_API_TOKEN"

 Response samples 
Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": {
    },
  • "timestamp": 1591458128186
}
Agenda Profissional
Representa os endpoints de inclusão, consulta e remoção de período na agenda de um profissional.


Obter todo o calendário de um profissional de saúde 
Retorna todos os dias com os horários salvos para um profissional de saúde


path Parameters
professionalID
 required 
long
 
ID do profissional que será consultado os horários


header Parameters
token
 required 
string
 
token API


Responses
 Request samples 
curl "https://api.conexasaude.com.br/integration/enterprise/professional/calendar/1" \
-H "token: SEU_API_TOKEN"

 Response samples 
Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": [
    ],
  • "timestamp": 1591458128186
}
Adicionar período no calendário do profissional de saúde 
Adiciona um período de algum dia da semana (Segunda, terca ...) para o profissional de saúde.


header Parameters
token
 required 
string
 
token API


Request Body schema: application/json
Objeto com informações do calendário do profissional a ser inserido


professionalID
 required 
long
 
ID do profissional que será adicionado o período do calendário


dayWeek
 required 
string
 Enum: "SEGUNDA" "TERCA" "QUARTA" "QUINTA" "SEXTA" "SABADO" "DOMINGO" 
 
Dia da semana


initialHour
 required 
string
 
Horário inicial do período


finalHour
 required 
string
 
Horário final do período


Responses
 Request samples 
Content type
application/json
{
  • "professionalID": 1,
  • "dayWeek": "SEGUNDA",
  • "initialHour": "08:00",
  • "finalHour": "18:00"
}
 Response samples 
Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": {
    },
  • "timestamp": 1591458128186
}
Remover período no calendário do profissional de saúde 
Remove um período de algum dia da semana (Segunda, terca ...) do profissional de saúde.


path Parameters
calendarID
 required 
long
 
ID do período do calendário que será removido


professionalID
 required 
long
 
ID do profissional que será removido o período do calendário


header Parameters
token
 required 
string
 
token API


Responses
 Request samples 
curl "https://api.conexasaude.com.br/integration/enterprise/professional/remove-calendar/123/1" \
-H "token: SEU_API_TOKEN"

 Response samples 
Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": true,
  • "timestamp": 1591458128186
}
Domínio
Representa os endpoints de domínio, endpoints genérico para popular algum campo de algum outro endpoint, exemplo Genero, Raca/cor, Pais entre outros.


Listar as informações de Raça/Cor 
Retorna todos os tipos de Raça/cor disponíveis no sistema


header Parameters
token
 required 
string
 
token API


Responses
 Request samples 
curl "https://api.conexasaude.com.br/integration/enterprise/domain/race-color" \
-H "token: SEU_API_TOKEN"

 Response samples 
Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": [
    ],
  • "timestamp": 1591458128186
}
Listar as informações de Nacionalidades 
Retorna todas as Nacionalidades disponíveis no sistema


header Parameters
token
 required 
string
 
token API


Responses
 Request samples 
curl "https://api.conexasaude.com.br/integration/enterprise/domain/nationality" \
-H "token: SEU_API_TOKEN"

 Response samples 
Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": [
    ],
  • "timestamp": 1591458128186
}
Listar as informações de Escolaridades 
Retorna todos os tipos de escolaridades disponíveis no sistema


header Parameters
token
 required 
string
 
token API


Responses
 Request samples 
curl "https://api.conexasaude.com.br/integration/enterprise/domain/education" \
-H "token: SEU_API_TOKEN"

 Response samples 
Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": [
    ],
  • "timestamp": 1591458128186
}
Listar as informações de Área de moradia 
Retorna todos os tipos de área de moradia disponíveis no sistema


header Parameters
token
 required 
string
 
token API


Responses
 Request samples 
curl "https://api.conexasaude.com.br/integration/enterprise/domain/living-area" \
-H "token: SEU_API_TOKEN"

 Response samples 
Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": [
    ],
  • "timestamp": 1591458128186
}
Listar as informações de Gênero 
Retorna todos os tipos de gênero disponíveis no sistema


header Parameters
token
 required 
string
 
token API


Responses
 Request samples 
curl "https://api.conexasaude.com.br/integration/enterprise/domain/gender" \
-H "token: SEU_API_TOKEN"

 Response samples 
Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": [
    ],
  • "timestamp": 1591458128186
}
Listar as informações de País 
Retorna todos os países disponíveis no sistema


header Parameters
token
 required 
string
 
token API


Responses
 Request samples 
curl "https://api.conexasaude.com.br/integration/enterprise/domain/country" \
-H "token: SEU_API_TOKEN"

 Response samples 
Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": [
    ],
  • "timestamp": 1591458128186
}
Listar as informações de UF 
Retorna todas as UF disponíveis no sistema


header Parameters
token
 required 
string
 
token API


Responses
 Request samples 
curl "https://api.conexasaude.com.br/integration/enterprise/domain/uf" \
-H "token: SEU_API_TOKEN"

 Response samples 
Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": [
    ],
  • "timestamp": 1591458128186
}
Listar as informações de CBO 
Retorna todos os tipos de CBO disponíveis no sistema


query Parameters
filter
string
 
Campo para busca pelo nome ou código do CBO


header Parameters
token
 required 
string
 
token API


Responses
 Request samples 
curl "https://api.conexasaude.com.br/integration/enterprise/domain/cbos" \
-H "token: SEU_API_TOKEN"

 Response samples 
Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": [
    ],
  • "timestamp": 1591458128186
}
Listar as informações de Religiões 
Retorna todos os tipos de religiões disponíveis no sistema


header Parameters
token
 required 
string
 
token API


Responses
 Request samples 
curl "https://api.conexasaude.com.br/integration/enterprise/domain/religion" \
-H "token: SEU_API_TOKEN"

 Response samples 
Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": [
    ],
  • "timestamp": 1591458128186
}
Nota Fiscal
Representa os endpoints de nota fiscal na plataforma Conexa


Emitir nota fiscal do atendimento 
Emite nota fiscal do atendimento para o paciente


path Parameters
attendanceId
 required 
integer
 
ID do atendimento


header Parameters
token
 required 
string
 
token API


Request Body schema: application/json
Objeto com informações da avaliação do atendimento


id
string
 
ID utilizado para identificar produto da venda


amountPaid
 required 
double
 
Valor a ser cobrado na nota fiscal


discrimination
string
 
Discriminação a ser informada na nota fiscal


Responses
 Request samples 
Content type
application/json
{
  • "id": "nf-0001-2022",
  • "amountPaid": 100.5,
  • "discrimination": "Consulta Especialiadade Cardiologia - João da Silva - CRM 123456RJ"
}
 Response samples 
Content type
application/json
{
  • "status": "201",
  • "msg": "Sucesso",
  • "object": "string",
  • "timestamp": 1591458128186
}
Emitir nota fiscal para o paciente 
Emite nota fiscal do do serviço prestado para o paciente


path Parameters
patientId
 required 
integer
 
ID do paciente


header Parameters
token
 required 
string
 
token API


Request Body schema: application/json
Objeto com informações da avaliação do atendimento


id
 required 
string
 
ID utilizado para identificar produto da venda


amountPaid
 required 
double
 
Valor a ser cobrado na nota fiscal


discrimination
 required 
string
 
Discriminação a ser informada na nota fiscal


Responses
 Request samples 
Content type
application/json
{
  • "id": "nf-0001-2022",
  • "amountPaid": 100.5,
  • "discrimination": "Consulta Especialiadade Cardiologia - João da Silva - CRM 123456RJ"
}
 Response samples 
Content type
application/json
{
  • "status": "201",
  • "msg": "Sucesso",
  • "object": "string",
  • "timestamp": 1591458128186
}
Cancelar nota fiscal 
Cancela nota fiscal informada


path Parameters
idEnota
 required 
string
 
ID da nota fiscal


header Parameters
token
 required 
string
 
token API


Responses
 Request samples 
curl --location --request POST 'https://api.conexasaude.com.br/integration/enterprise/invoice/{idEnota}/cancel/' \
-H "token: SEU_API_TOKEN" \
-H "Content-Type: application/json" \

 Response samples 
Content type
application/json
{
  • "status": "202",
  • "msg": "Sucesso",
  • "object": "string",
  • "timestamp": 1591458128186
}
Atenção primária à saúde
Obter time de atenção primária (APS) do paciente 
Retorna todos os profissionais do time de atenção primária (APS) de um paciente


path Parameters
patientId
 required 
long
 
ID do paciente que será retornado o time de atenção primária à saúde


header Parameters
token
 required 
string
 
token API


Responses
 Request samples 
curl "https://api.conexasaude.com.br/integration/enterprise/primary-health-care/list-patient-team/1" \
-H "token: SEU_API_TOKEN"

 Response samples 
Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": [
    ],
  • "timestamp": 1591458128186
}
Obter informações de saúde física 
Retorna todos as opções de saúde física para ser preenchida no formulário APS


header Parameters
token
 required 
string
 
token API


Responses
 Request samples 
curl "https://api.conexasaude.com.br/integration/enterprise/primary-health-care/list-health-physical" \
-H "token: SEU_API_TOKEN"

 Response samples 
Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": {
    },
  • "timestamp": 1591458128186
}
Salvar questionário de atenção primária à saúde 
Salva um questionário com algumas informações dada pelo paciente


header Parameters
token
 required 
string
 
token API


Request Body schema: application/json
Objeto com informações do questionário


object
 
physicalActivity
string
 Enum: "SIM_EU_FACO" "AS_VEZES" "NAO_NAO_FACO" 
 
Informação se faz atividade física


smoke
boolean
 
Flag que sinaliza se o paciente fuma


wantStopSmoking
boolean
 
Flag que sinaliza se o paciente pretende parar de fumar


ratingMentalHealth
string
 Enum: "SAUDE_MENTAL_MUITO_ABALADA" "SAUDE_MENTAL_POUCO_ABALADA" "BOA_SAUDE_MENTAL" 
 
Informação sobre a saúde mental do paciente


object
 
Array of objects
 
Lista com os tipos de resultados de consulta


Responses
 Request samples 
Content type
application/json
{
  • "profession": {
    },
  • "physicalActivity": "SIM_EU_FACO",
  • "smoke": true,
  • "wantStopSmoking": true,
  • "ratingMentalHealth": "BOA_SAUDE_MENTAL",
  • "physicalHealth": {
    },
  • "disease": [
    ]
}
 Response samples 
Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": true,
  • "timestamp": 1591458128186
}
Obter informações do questionário de atenção primária 
Retorna as informações do questionário preenchido pelo paciente


path Parameters
patientId
 required 
long
 
ID do paciente


header Parameters
token
 required 
string
 
token API


Responses
 Request samples 
curl "https://api.conexasaude.com.br/integration/enterprise/primary-health-care/obtain-patient-form/{patientId}" \
-H "token: SEU_API_TOKEN"

 Response samples 
Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": {
    },
  • "timestamp": 1591458128186
}
Obter celular do concierge da equipe de atenção primária 
Retorna o telefone do concierge (enfermeira(o)) da equipe de atenção primária à saúde (APS)


path Parameters
patientId
 required 
long
 
ID do paciente


header Parameters
token
 required 
string
 
token API


Responses
 Request samples 
curl "https://api.conexasaude.com.br/integration/enterprise/primary-health-care/obtain-patient-form/1" \
-H "token: SEU_API_TOKEN"

 Response samples 
Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": "(21) 99999-9999",
  • "timestamp": 1591458128186
}
Verifica preenchimento do questionário de atenção primária 
Verifica se o paciente já preencheu o questionário de atenção primária à saúde


path Parameters
patientId
 required 
long
 
ID do paciente


header Parameters
token
 required 
string
 
token API


Responses
 Request samples 
curl "https://api.conexasaude.com.br/integration/enterprise/primary-health-care/patient-form-answered/1" \
-H "token: SEU_API_TOKEN"

 Response samples 
Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": true,
  • "timestamp": 1591458128186
}
Verifica se um profissional está dentro da equipe de atenção primária do paciente 
Verifica se um profissional está dentro da equipe de atenção primária que o paciente participa


path Parameters
patientId
 required 
long
 
ID do paciente


professionalId
 required 
long
 
ID do profissional


header Parameters
token
 required 
string
 
token API


Responses
 Request samples 
curl "https://api.conexasaude.com.br/integration/enterprise/primary-health-care/has-professional-in-patient-team/1/1" \
-H "token: SEU_API_TOKEN"

 Response samples 
Content type
application/json
{
  • "status": "200",
  • "msg": "Sucesso",
  • "object": true,
  • "timestamp": 1591458128186
}