Download OpenAPI specification:Download
Serviços para integração entre empresas e os sistemas da Conexa e PV.
Para saber mais sobre a Conexa: https://www.conexasaude.com.br/.
Conexa API - Conexa Dev Este guia tem por objetivo ajudar você desenvolvedor a preparar a plataforma para receber endpoints de dentro da aplicação da propria Conexa, ligados a serviços extrernos de empresas parceiras.
Esse tipo de integração de pacientes é necessária em qualquer tipo de integração listada abaixo.
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.
token required | string token API |
Objeto com informações de paciente e/ou dependente a ser inserido
object Paciente titular | |
Array of objects (schema2) Lista de dependentes |
{- "holder": {
- "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": {
- "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
}, - "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"
}, - "dependents": [
- {
- "id": 401,
- "name": "Steve Hopkins",
- "mail": "steve.hopkins@gmail.com",
- "dateBirth": "26/04/1985",
- "sex": "MALE",
- "cpf": "33311155511",
- "cellphone": "21988776554",
- "patientHolderId": null,
- "patientHolderCpf": "98354881008",
- "healthCardNumber": "1113335556667",
- "additionalInformation": "Matrícula 663399-6",
- "specialist": 199,
- "nationalId": "20112527-9",
- "kinshipOfTheHolder": "PAI",
- "address": {
- "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
}, - "clinicPlan": "PLANOSILVER"
}
]
}
{- "status": "200",
- "msg": "Sucesso",
- "object": {
- "holder": {
- "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": {
- "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
}, - "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,
- "registration": "MATRICULATESTE",
- "healthPlan": "PLANOTESTE",
- "enterprise": "EMPRESATESTE",
- "department": "DEPARTAMENTOTESTE",
- "patientRole": "CARGOTESTE",
- "clinicPlan": "PLANOSILVER"
}, - "dependents": [
- {
- "id": 401,
- "name": "Steve Hopkins",
- "mail": "steve.hopkins@gmail.com",
- "dateBirth": "26/04/1985",
- "sex": "MALE",
- "cpf": "33311155511",
- "cellphone": "21988776554",
- "patientHolderId": null,
- "patientHolderCpf": "98354881008",
- "healthCardNumber": "1113335556667",
- "additionalInformation": "Matrícula 663399-6",
- "specialist": 199,
- "nationalId": "20112527-9",
- "kinshipOfTheHolder": "PAI",
- "address": {
- "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
}, - "clinicPlan": "PLANOSILVER"
}
]
}, - "timestamp": 1591458128186
}
Bloqueia o acesso do paciente à plataforma pelo seu ID
id required | integer ID do paciente |
token required | string token API |
curl -X POST "https://api.conexasaude.com.br/integration/enterprise/v2/patients/401/block" \ -H "token: SEU_API_TOKEN"
{- "status": "200",
- "msg": "Sucesso",
- "object": true,
- "timestamp": 1591458128186
}
Desbloqueia o paciente pelo seu ID para poder acessar à plataforma
id required | integer ID do paciente |
token required | string token API |
curl -X POST "https://api.conexasaude.com.br/integration/enterprise/v2/patients/401/unblock" \ -H "token: SEU_API_TOKEN" \ -H "Content-Type: application/json"
{- "status": "200",
- "msg": "Sucesso",
- "object": true,
- "timestamp": 1591458128186
}
Aceita o termo de uso da plataforma para um paciente
token required | string token API |
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 |
{- "idPatient": 401,
- "ip": "191.163.30.215"
}
{- "status": "200",
- "msg": "Sucesso",
- "object": true,
- "timestamp": 1591458128186
}
Gera um link mágico para aplicativo móvel e um para acesso no navegador web para o paciente pelo seu ID
id required | integer ID do paciente |
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) |
token required | string token API |
curl "https://api.conexasaude.com.br/integration/enterprise/patients/generate-magiclink-access-app/401" \ -H "token: SEU_API_TOKEN"
{- "status": "200",
- "msg": "Sucesso",
- "object": {
- "linkMagicoApp": "app.magiklink.com.br",
}, - "timestamp": 1591458128186
}
Cria um atendimento imediato (fila de atendimentos) para o paciente
token required | string token API |
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 Enum: "Médico" "NURSE" "PSYCHOLOGIST" 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 |
{- "patientId": "47293",
- "specialtyId": "12",
- "payment": {
- "creditCardId": 123
}, - "professionalType": "Médico",
- "symptoms": [
- "Dor na garganta",
- "febre"
], - "medicines": [
- 1222,
- 32322
], - "screening": "Dor de cabeça"
}
{- "status": "200",
- "msg": "Sucesso",
- "object": "b3g0eecc02200012212010009750c5e5",
- "timestamp": 1591458128186
}
Envia um arquivo (base64) para ficar anexado ao atendimento imediato informado. (Arquivo não pode ser maior que 10MB)
idProtocol required | string Protocolo (id) da solicitação do atendimento imediato |
token required | string token API |
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 |
{- "base64Content": "conteudo do arquivo base64",
- "describe": "Exame de sangue",
- "extension": "pdf",
- "tipoAnexoSibs": "EXAME",
- "dataExame": "2021-01-01"
}
{- "status": "200",
- "msg": "Sucesso",
- "object": true,
- "timestamp": 1591458128186
}
Obtém informações do atendimento imediato (fila) por ID do paciente
patientId required | integer ID do paciente |
token required | string token API |
curl "https://api.conexasaude.com.br/integration/enterprise/appointment/immediate/active/{patientId}" \ -H "token: SEU_API_TOKEN"
{- "status": "200",
- "msg": "Sucesso",
- "object": {
- "tamanhoFila": 2,
- "idProtocolo": "2908b4dc046be",
- "horaPrevistaAtendimento": "12/04/2020 12:30",
- "tipoProfissional": "Médico(a)",
- "tempoEstimado": 10,
- "tempoInicial": 10,
- "dataEntrada": "12/04/2020 12:30",
- "posicaoFila": 2
}, - "timestamp": 1591458128186
}
Cancela o atendimento imediato (da fila de atendimentos) de um paciente pelo seu ID
patientId required | integer ID do paciente |
token required | string token API |
curl -X POST "https://api.conexasaude.com.br/integration/enterprise/appointment/immediate/cancel/{patientId}" \ -H "token: SEU_API_TOKEN"
{- "status": "200",
- "msg": "Sucesso",
- "object": true,
- "timestamp": 1591458128186
}
Obtém informações da última chamada ativa pelo paciente informado (ID)
patientId required | integer ID do paciente |
token required | string token API |
curl "https://api.conexasaude.com.br/integration/enterprise/v2/appointment/last/call/{patientId}" \ -H "token: SEU_API_TOKEN"
{- "status": "200",
- "msg": "Sucesso",
- "object": {
- "appointmentId": 86482,
- "doctorId": 2001,
- "zoomMeetingId": "2908b40f9dc046beu48a1hd",
- "zoomMeetingPasswd": "2908b40f9dc046beu48a1hd",
- "callId": 70854830,
}, - "timestamp": 1591458128186
}
Salva uma avaliação do Profissional / Plataforma de um atendimento.
token required | string token API |
Objeto com informações da avaliação do atendimento
appointmentId required | integer ID do atendimento referente à avaliação |
required | object (schema4) Objeto com informações do conteudo de uma avaliação realizada |
required | object (schema4) Objeto com informações do conteudo de uma avaliação realizada |
{- "appointmentId": 999,
- "professional": {
- "evaluationType": "MEDICO",
- "evaluation": 5,
- "details": [
- "PASSAR_CONFIANCA"
], - "nps": 8,
- "comment": "Muito bom!!"
}, - "plataform": {
- "evaluationType": "MEDICO",
- "evaluation": 5,
- "details": [
- "PASSAR_CONFIANCA"
], - "nps": 8,
- "comment": "Muito bom!!"
}
}
{- "status": "200",
- "msg": "Sucesso",
- "object": true,
- "timestamp": 1591458128186
}
Lista todas as especialidades médicas disponíveis para atendimento
token required | string token API |
curl "https://api.conexasaude.com.br/integration/enterprise/appointment/specialties" \ -H "token: SEU_API_TOKEN"
{- "status": "200",
- "msg": "Sucesso",
- "object": [
- {
- "id": 10,
- "name": "Cardiologia"
}
], - "timestamp": 1591458128186
}
Lista os médicos disponíveis de determinada especialidade pelo nome para agendamento para o paciente
specialtyId required | integer ID da especialidade médica |
page required | integer Página requerida |
name | string Nome do médico |
patientId | integer ID do paciente |
sortType | string Enum: "NAME" "NEAREST_DATE" Tipo de ordenação da listagem |
token required | string token API |
curl "https://api.conexasaude.com.br/integration/enterprise/doctors/specialty/2/1?name=JOAO&patientId=111" \ -H "token: SEU_API_TOKEN"
{- "status": "200",
- "msg": "Sucesso",
- "object": [
- {
- "id": 10,
- "name": "Dr. da Silva",
- "photo": "10/doctorx.jpg",
- "specialtyName": "Cardiologia",
- "sex": "MALE",
- "crm": 11111,
- "crmUf": "RJ"
}
], - "timestamp": 1591458128186
}
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.
doctorId required | integer ID do médico |
startDate required | integer Data base para horários disponíveis. Formato |
token required | string token API |
curl "https://api.conexasaude.com.br/integration/enterprise/doctors/1036/schedule/available?startDate=30%2F09%2F2020" \ -H "token: SEU_API_TOKEN"
{- "status": "200",
- "msg": "Sucesso",
- "object": [
- {
- "date": "10/10/2019",
- "availableTimes": [
- "10:00",
- "10:30",
- "11:00",
- "11:30"
]
}
], - "timestamp": 1591458128186
}
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.
professionalType required | string Enum: "NURSE" "PSYCHOLOGIST" "PHYSIOTHERAPIST" "PHONOAUDIOLOGIST" "NUTRITIONIST" "SOCIAL_ASSISTANT" "DOCTOR" Tipo de profissional |
token required | string token API |
Objeto com informações de atendimento agendado
appointmentDate required | string Data de agendamento do atendimento. Formato |
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 |
{- "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": {
- "creditCardId": 123
}
}
{- "status": "200",
- "msg": "Sucesso",
- "object": {
}, - "timestamp": 1591458128186
}
Agendado – Especialidades (Nutrição – Fonoaudiologia – Enfermagem)
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.
professionalType required | string Enum: "NURSE" "PSYCHOLOGIST" "PHYSIOTHERAPIST" "PHONOAUDIOLOGIST" "NUTRITIONIST" "SOCIAL_ASSISTANT" "DOCTOR" Tipo de profissional |
token required | string token API |
Objeto com informações de atendimento agendado
appointmentDate required | string Data de agendamento do atendimento. Formato |
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 |
{- "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": {
- "creditCardId": 123
}
}
{- "status": "200",
- "msg": "Sucesso",
- "object": {
}, - "timestamp": 1591458128186
}
Lista os profissionais da saúde de determinado tipo disponíveis para agendamento para o paciente
page required | integer Página requerida |
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 |
token required | string token API |
curl "https://hml-api.conexasaude.com.br/integration/enterprise/v2/healthcare-professionals/name/1?professionalType=DOCTOR" \ -H "token: SEU_API_TOKEN"
{- "status": "200",
- "msg": "Sucesso",
- "object": [
- {
- "id": 10,
- "name": "Juliana da Silva",
- "photo": "10/doctorx.jpg",
- "specialtyName": "Enfermeiro(a)",
- "sex": "FEMALE",
- "councilNumber": 11111,
- "councilUf": "RJ"
}
], - "timestamp": 1591458128186
}
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.
id required | integer ID do profissional de saúde |
startDate required | integer Data base para horários disponíveis. Formato |
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. |
token required | string token API |
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"
{- "status": "200",
- "msg": "Sucesso",
- "object": [
- {
- "date": "10/10/2019",
- "availableTimes": [
- "10:00",
- "10:30",
- "11:00",
- "11:30"
]
}
], - "timestamp": 1591458128186
}
Gera o link de acesso a plataforma do usuário informado
Authorization required | string Authorization Bearer com o token de acesso gerado no Oauth2 |
user required | string Login do usuário |
convenio required | string Convênio do usuário |
type required | string Enum: "CONSULTORIO" "CONEXA_SAUDE" Tipo da integração do login |
{- "user": "12345678900",
- "convenio": "CONVNEIOPV",
- "type": "CONSULTORIO"
}
[- {
- "user": "12345678900",
- "authorization": "xxxxxxxxxxxxxx.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx,xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
- "refreshToken": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
- "convenio": "Convenio PV"
}
]
Gera o token de acesso OAuth2 para consumir os serviços de integrações SSO
client_id required | string Identificador Client ID das credenciais |
client_secret required | string Identificador Client Secret das credenciais |
scope required | string Value: "Integration" Scope de autenticação |
grant_type required | string Value: "client_credentials" Tipo de autenticação |
client_id=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&client_secret=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&scope=Integration&grant_type=client_credentials
{- "access_token": "xxxxxxxxxxxxxx.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx,xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
- "refresh_token": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
- "token_type": "bearer",
- "expires_in": 604800
}
Cadastra ou Atualiza um paciente com os dados informados
Authorization required | string Authorization Bearer com o token de acesso gerado no Oauth2 |
nome required | string Nome do paciente |
cpf required | string CPF do paciente.
|
codigoConvenio required | string Código do convênio |
login required | string Login único de acordo com o tipo definido no contarto. |
senha required | string Senha inicial definidada para o paciente |
desativado required | string Enum: "S" "N" Status desativado |
emailNotificacao | string E-mail para recebimento de notificações |
dataNascimento | string <date> Data de nascimento do paciente.
|
codigoPaisTelefone | string Código do país de telefone do paciente.
|
telefone | string Telefone para recebimento de notificações.
|
numeroCarteirinha | string Número da carteirinha do paciente respectivo a sua operadora de saúde
|
loginTitular | string Login do paciente titular deste dependente.
|
idExternoConexa | integer ID de integração entre pacientes Psicologia Viva X Conexa Saúde |
cargo | string Cargo do paciente na empresa do convênio |
nomeEmpresa | string Nome da empresa do paciente na empresa do convênio |
nomeEmpresaInterna | string Nome da empresa interna do paciente na empresa do convênio |
departamentoClienteEmpresa | string Departamento do paciente na empresa do convênio |
planoSaude | string Descrição plano saúde do paciente na empresa do convênio |
idEmpresa | string ID empresa do paciente na empresa do convênio |
idEmpresaInterna | string ID Empresa Interna do paciente na empresa do convênio |
type required | string Enum: "CONSULTORIO" "CONEXA_SAUDE" Tipo da integração do login |
{- "nome": "Paciente Teste",
- "cpf": "123.456.789-00",
- "codigoConvenio": "CONVENIOPV",
- "login": "12345678900",
- "senha": "#@paciente123",
- "desativado": "N",
- "emailNotificacao": "pacienteteste@email.com.br",
- "dataNascimento": "2000-01-01",
- "codigoPaisTelefone": "+55",
- "telefone": "31912345678",
- "numeroCarteirinha": "",
- "loginTitular": "",
- "idExternoConexa": "",
- "cargo": "",
- "nomeEmpresa": "",
- "nomeEmpresaInterna": "",
- "departamentoClienteEmpresa": "",
- "planoSaude": "",
- "idEmpresa": "",
- "idEmpresaInterna": "",
- "type": "CONSULTORIO"
}
{- "id": 0,
- "nome": "Paciente Teste",
- "login": "12345678900",
- "cpf": "123.456.789-00",
- "dataNascimento": "2000-01-01",
- "desativado": "S",
- "idioma": "pt_br",
- "numeroCarteirinha": "",
- "idExternoConexa": "",
- "cargo": "",
- "planoSaude": "",
- "contato": {
- "codigoPaisCelular": "+55",
- "celular": "31912345678",
- "emailNotificacao": "pacienteteste@email.com.br"
}, - "convenio": {
- "id": 1,
- "nome": "Convenio PV",
- "chaveLogin": "CPF",
- "codigoConvenio": "CONVENIOPV",
- "regiaoConvenio": "BR"
}, - "dadosEmpresarial": {
- "nomeEmpresa": "",
- "nomeEmpresaInterna": "",
- "departamentoClienteEmpresa": ""
}, - "pacienteTitular": {
- "id": 123
}
}
Retorna as informações dos próximos atendimentos PENDENTES de um paciente(tanto atendimento agendado com um profissional ou atendimento agendado sem preferência)
patientId required | integer ID do paciente |
token required | string token API |
curl "https://api.conexasaude.com.br/integration/enterprise/v2/appointment/next/12" \ -H "token: SEU_API_TOKEN"
{- "status": "200",
- "msg": "Sucesso",
- "object": [
- {
- "appointmentId": 86482,
- "token": "as23gasg22323kasdkajdajs",
- "appointmentDate": "12/04/2020 11:30",
- "professionalName": "Dr. Jonh Doe",
- "specialty": "Cardiologia",
- "professionalType": "MEDICO",
- "servicePermission": {
- "id": "MEDICO/ENFERMEIRO/PSICOLOGO...",
- "habilitated": true,
- "immediateAppointment": true,
- "scheduledAppointment": true,
- "description": "Médico(a), Enfermeiro(a), Psicólogo(a)...",
- "manualScheduledService": true,
- "automaticScheduledService": true
}, - "payment": {
- "paymentValue": "89,90",
- "lastCreditCardNumbers": "4323",
- "inclusionDate": "12/04/2020 11:30",
- "creditCardFlag": "Visa"
}, - "professionalId": "98726",
- "appointmentObjective": "ORIENTACAO",
- "createdBy": "ADMIN"
}
], - "timestamp": 1591458128186
}
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)
patientId required | integer ID do paciente |
professionalType | string Enum: "NURSE" "PSYCHOLOGIST" "PHYSIOTHERAPIST" "PHONOAUDIOLOGIST" "NUTRITIONIST" "SOCIAL_ASSISTANT" "DOCTOR" Tipo de profissional |
token required | string token API |
curl "https://api.conexasaude.com.br/integration/enterprise/v2/appointment/realized/{patientId}?professionalType=PSYCHOLOGIST" \ -H "token: SEU_API_TOKEN"
{- "status": "200",
- "msg": "Sucesso",
- "object": [
- {
- "appointmentId": 86482,
- "token": "as23gasg22323kasdkajdajs",
- "appointmentDate": "12/04/2020 11:30",
- "professionalName": "Dr. Jonh Doe",
- "specialty": "Cardiologia",
- "professionalType": "MEDICO",
- "servicePermission": {
- "id": "MEDICO/ENFERMEIRO/PSICOLOGO...",
- "habilitated": true,
- "immediateAppointment": true,
- "scheduledAppointment": true,
- "description": "Médico(a), Enfermeiro(a), Psicólogo(a)...",
- "manualScheduledService": true,
- "automaticScheduledService": true
}, - "payment": {
- "paymentValue": "89,90",
- "lastCreditCardNumbers": "4323",
- "inclusionDate": "12/04/2020 11:30",
- "creditCardFlag": "Visa"
}, - "professionalId": "98726",
- "appointmentObjective": "ORIENTACAO",
- "createdBy": "ADMIN"
}
], - "timestamp": 1591458128186
}
Retorna as informações dos últimos 50 atendimentos (independente do status) de um paciente
patientId required | integer ID do paciente |
professionalType | string Enum: "NURSE" "PSYCHOLOGIST" "PHYSIOTHERAPIST" "PHONOAUDIOLOGIST" "NUTRITIONIST" "SOCIAL_ASSISTANT" "DOCTOR" Tipo de profissional |
token required | string token API |
curl "https://api.conexasaude.com.br/integration/enterprise/v2/appointment/all/12?professionalType=PSYCHOLOGIST" \ -H "token: SEU_API_TOKEN"
{- "status": "200",
- "msg": "Sucesso",
- "object": [
- {
- "appointment": {
- "id": 86482,
- "doctorId": 2001,
- "doctorName": "Dr. Jonh Doe",
- "doctorCPF": "11122233344",
- "doctorCRM": "204060",
- "doctorUF": "RJ",
- "doctorSpecialty": "Cardiologia",
- "patientId": 400837,
- "patientName": "Jane Doe",
- "appointmentDate": "12/04/2020 11:30",
- "historyPhysicalExamination": "consulta de rotina",
- "prescription": "consulta de rotina",
- "previousDiagnosis": "Paciente alega falta de ar, febre e tosse",
- "clinicDiagnosis": "paciente sedentário",
- "specialistDiagnosis": "paciente possui importante transgressão dietética",
- "status": "CONCLUIDO",
- "prescriptions": [
- {
- "id": 86482,
- "prescriptionDate": "12/04/2020 12:30:10",
- "urlDownload": "url do s3 para download (ex.: https://drvirtual.s3.sa-east-1.amazonaws.com/prescricoes.....)"
}
], - "appointmentOutcomeDate": "12/04/2020 12:30",
- "outcome": "Demonstração",
- "outcomeCode": "DEMONSTRACAO",
- "cid10": [
- "E660",
- "E782"
], - "patientOrientation": "Você possui sintomas de dengue. Deve tomar bastante liquido e os remedios prescritos.",
- "patientAttachments": [
- {
- "id": 8819,
- "fileName": "anexos/atendimento/111111/29f1d9efc52313949812d18f4a77454a.jpg",
- "subtitle": "foto do exame",
}
], - "professionalAttachments": [
- {
- "id": 8819,
- "fileName": "anexos/atendimento/111111/29f1d9efc52313949812d18f4a77454a.jpg",
- "subtitle": "foto do exame",
}
], - "professionalType": "NURSE",
- "createdBy": "ADMIN"
}
}
], - "timestamp": 1591458128186
}