Conexa API - Webhook (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 prontuários de terceiros e a plataforma de telemedicina da Conexa Saúde.

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

Introdução

Conexa API - Webhook Este guia tem por objetivo ajudar você desenvolvedor a preparar sua plataforma para receber as notificações dos nossos webhook’s. Portanto, é de suma importância que seja implementado um endpoint para que possamos notificá-los quando isso acontecer e, depois de pronto, nos encaminhar.

Autenticação

A requisição realizada pelo webhook será POST e, caso preferir, poderá proteger seu endpoint nos fornecendo um token para que possamos enviá-lo através dos headers da requisição, juntamente com o nome do cabeçalho, por exemplo, token: 1qw64g8vqv31321a5sfa.

Webhook

Representa os endpoints de webhook na plataforma Conexa

Webhook chamada aceita

Esse webhook é enviado quando o médico chama o paciente e enviamos esse webhook com alguns dados da chamada e a URL da chamada.

Request Body schema: application/json

Objeto com informações da chamada de quando o médico chama o paciente

callId required	long ID da chamada do atendimento criada
callToken	string token da chamada do atendimento criada
callUrl required	string URL da chamada do atendimento
meetingID required	string ID da chamada do meeting (zoom, vonage)
meetingPasswd	string Senha do meeting criado
meetingType required	string Enum: "VONAGE" "VONAGE_EXPRESS" "VONAGE_V2" Tipo de meeting utilizado (Tratar retorno como texto, para evitar erros com novas opções)
appointmentId required	long ID do atendimento
healthcareProfessionalId required	long ID do profissional de saúde
healthcareProfessionalName required	string Nome do profissional de saúde
healthcareProfessionalPhoto	string URL da foto do profissional de saúde
patientId required	long ID do paciente
patientName required	string Nome do paciente
patientCpf	string CPF do paciente
protocolId	string Protocolo (id) da solicitação do atendimento imediato

Responses

Request samples

Payload

Content type

application/json

{"callId": 87876,
"callToken": "f81f4d7131f741fe89539cce11255321",
"callUrl": "url_video_chamada",
"meetingID": "12141213",
"meetingPasswd": "123adsas",
"meetingType": "VONAGE_EXPRESS",
"appointmentId": 123,
"healthcareProfessionalId": 999,
"healthcareProfessionalName": "Dr João",
"healthcareProfessionalPhoto": "url_foto_profissional",
"patientId": 871,
"patientName": "Maria Silva",
"patientCpf": "0123456789",
"protocolId": "000f8458c4b842fc8f5c603082c187b0"
}

Webhook atendimento concluído

Esse webhook é enviado quando o médico finaliza um atendimento e enviamos dados do atendimento.

Request Body schema: application/json

Objeto com informações da chamada de quando o médico chama o paciente

appointmentId required	long ID do atendimento
appointmentDate required	string Data do atendimento
appointmentOutcomeDate required	string Data da realização do desfecho do atendimento
appointmentObjective	string Enum: "ORIENTACAO" "ATESTADO" "AFASTADO" "CONSULTA_ROTINA" "RETORNO_CONSULTA" "ACOMPANHAMENTO_NUTRICIONAL_ONCOLOGICO" "ACOMPANHAMENTO_NUTRICIONAL_POS_OPERATORIO" "ACOMPANHAMENTO_NUTRICIONAL_PREVENTIVO" "ACOMPANHAMENTO_NUTRICIONAL_PATOLOGICO" "CONSULTA_URGENCIA_PADRAO" "CONSULTA_MONITORAMENTO_COVID_POS_PS" "CONSULTA_MONITORAMENTO_POS_INTERNACAO" "CONSULTA_REAVALIACAO_FOLLOW_UP" "CONSULTA_COVID_PRE_CIRURGICO" "AGENDAMENTO_POR_EXCECAO" Objetivo do atendimento
patientId required	long ID do paciente
patientName required	string Nome do paciente
patientHealthCardNumber	string Número da carteirinha do paciente
patientEmail	string Email do paciente
patientCellphone	string Número do celular do paciente
patientCpf	string CPF do paciente
healthcareProfessionalId required	long ID do profissional de saúde
healthcareProfessionalName required	string Nome do profissional de saúde
healthcareProfessionalPhoto	string URL da foto do profissional de saúde
healthcareProfessionalType	string Enum: "NURSE" "PSYCHOLOGIST" "PHYSIOTHERAPIST" "PHONOAUDIOLOGIST" "NUTRITIONIST" "SOCIAL_ASSISTANT" "HEALTH_COACH" "DOCTOR" "DENTIST" "PHYSICAL_EDUCATOR" Tipo de profissional de saúde
healthcareProfessionalSpecialtyId	long ID da especialidade do profissional de saúde na conexa
healthcareProfessionalSpecialty	string Nome da especialidade do profissional de sapude na conexa
healthcareCouncilRegistration required	string Número do conselho (CRM, CRN...) do profissional de saúde
healthcareCouncilRegistrationUF required	string Enum: "AC" "AL" "AM" "AP" "BA" "CE" "DF" "ES" "GO" "MA" "MG" "MS" "MT" "PA" "PB" "PE" "PI" "PR" "RJ" "RN" "RO" "RR" "RS" "SC" "SE" "SP" "TO" UF do conselho do profissional de saúde
healthcareCouncilRegistrationType	string Enum: "CRM" "CRO" "COREN" "CRN" "CRP" "CREFITO" "CREFONO" "CFESS" "CONTER" "CFBM" "CREF" "NAO_DEFINIDO" Tipo de conselho (CRM, CRN, CRO...)
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" "ENCAMINHADO_PARA_EXAMES" "ATENDIMENTO_RECORRENTE" "ENTREVISTA_DE_TRIAGEM" "ENCAMINHAMENTO_PSIQUIATRIA" "ULTIMO_ATENDIMENTO" "ATENDIMENTO_PONTUAL" "PERICIA_MEDICA" "ENCAMINHADO_PARA_PROCEDIMENTOS" Dia da semana
hasCall	boolean Flag que indica se teve chamada no atendimento
historyPhysicalExamination	string Campo com informações de exame físico, relato do paciente
historyOfPresentIllness	string Campo com informações da doença atual do paciente
previousDiagnosis	string Campo com informação de diagnóstico prévio
clinicDiagnosis	string Campo com informação do parecer do clínico
specialistDiagnosis	string Campo com informação do parecer do especialista
prescription	string Campo com informação da prescrição do médico
	Array of objects Prescrições geradas no atendimento
	Array of objects Dados da prescrição com origem no prestador utilizado
	Array of objects Anexos do paciente
	Array of objects Anexos do profissional
cid10	Array of strings Lista com a classificação Internacional de Doenças
epidemic	string Nome da epidemia que o atendimento se refere
epidemicMedicalReport	string Relato médico da epidemia do atendimento
screening	string Triagem do atendimento caso tenha
adviceToPatient	string Orientação ao paciente
kinshipOfTheHolder	string Enum: "PAI" "MAE" "CONJUGE" "FILHO" "ENTEADO" "COMPANHEIRO" "AVOS" "BISAVOS" "IRMAOS" "TIOS" "OUTROS" Grau de parentesco do titular
protocolId	string Protocolo (id) da solicitação do atendimento imediato

Responses

Request samples

Payload

Content type

application/json

{"appointmentId": 123,
"appointmentDate": "01/01/2021 12:00:00",
"appointmentOutcomeDate": "01/01/2021 15:00",
"appointmentObjective": "ORIENTACAO",
"patientId": 871,
"patientName": "Maria Silva",
"patientHealthCardNumber": "73762162171",
"patientEmail": "maria.silva@teste.com.br",
"patientCellphone": "21999999999",
"patientCpf": "0123456789",
"healthcareProfessionalId": 999,
"healthcareProfessionalName": "Dr João",
"healthcareProfessionalPhoto": "url_foto_profissional",
"healthcareProfessionalType": "NURSE",
"healthcareProfessionalSpecialtyId": 2,
"healthcareProfessionalSpecialty": "Clínico Geral",
"healthcareCouncilRegistration": "1234123",
"healthcareCouncilRegistrationUF": "RJ",
"healthcareCouncilRegistrationType": "CRM",
"outcome": "ALTA_CONSULTA",
"hasCall": true,
"historyPhysicalExamination": "Historico de exame fisico, relato do paciente",
"historyOfPresentIllness": "Historia da doença atual do paciente",
"previousDiagnosis": "relato do paciente",
"clinicDiagnosis": "Paciente estável",
"specialistDiagnosis": "Nao necessita.",
"prescription": "tomar dipirona 2x ao dia",
"prescriptions": [{"id": 8000,
"prescriptionDate": "01/01/2021 15:00",
"urlDownload": "url_download_prescricao",
"providerId": 123456,
"providerName": "MEVO"
}
],
"prescriptionProviderData": [{"providerId": 123456,
"providerName": "MEVO",
"providerDate": "21/03/2025 10:33",
"data": { }
}
],
"patientAttachments": [{"id": 123456,
"fileName": "anexos/123/123456.pdf",
"subtitle": "Exame de sangue",
"urlDownload": "https://HOST-Amazon/anexos/123/123456.pdf?X-Amz-Security-Token=TokenDeSeguranca&DemaisParametros=Necessarios"
}
],
"professionalAttachments": [{"id": 123456,
"fileName": "nexodata/atestado/123/123456.pdf",
"subtitle": "Atestado",
"urlDownload": "https://HOST-Amazon/nexodata/atestado/123/123456.pdf?X-Amz-Security-Token=TokenDeSeguranca&DemaisParametros=Necessarios"
}
],
"cid10": ["M797",
"Z720"
],
"epidemic": "Coronavírus",
"epidemicMedicalReport": "SUSPEITO",
"screening": "dor de cabeça, indisposição",
"adviceToPatient": "Repouso durante 3 dias",
"kinshipOfTheHolder": "PAI",
"protocolId": "6f4a0823600b4fcc8dbd8f5d0caa342c"
}

Webhook de prescrição médica

Esse webhook é disparado quando houver conclusão de atendimento com prescrição médica, onde a clínica permite envio de dados sigilosos

Request Body schema: application/json

Objeto com informações da precrição quando o atendimento é concluído

appointmentId required	long ID do atendimento
appointmentDate required	string Data do atendimento
protocolId	string Protocolo (id) da solicitação do atendimento imediato
patientId required	long ID do paciente
patientName required	string Nome do paciente
patientCpf	string CPF do paciente
patientHealthCardNumber	string Número da carteirinha do paciente
patientEmail	string Email do paciente
healthcareProfessionalName required	string Nome do profissional de saúde
healthcareCouncilRegistration required	string Número do conselho (CRM, CRN...) do profissional de saúde
healthcareCouncilRegistrationUF required	string Enum: "AC" "AL" "AM" "AP" "BA" "CE" "DF" "ES" "GO" "MA" "MG" "MS" "MT" "PA" "PB" "PE" "PI" "PR" "RJ" "RN" "RO" "RR" "RS" "SC" "SE" "SP" "TO" UF do conselho do profissional de saúde
healthcareCouncilRegistrationType required	string Enum: "CRM" "CRO" "COREN" "CRN" "CRP" "CREFITO" "CREFONO" "CFESS" "CONTER" "CFBM" "CREF" "NAO_DEFINIDO" Tipo de conselho (CRM, CRN, CRO...)
prescription	string Campo com informação da prescrição do médico
required	Array of objects Prescrições geradas no atendimento
required	Array of objects Dados da prescrição com origem no prestador utilizado

Responses

Request samples

Payload

Content type

application/json

{"appointmentId": 123,
"appointmentDate": "01/01/2021 12:00:00",
"protocolId": "6f4a0823600b4fcc8dbd8f5d0caa342c",
"patientId": 871,
"patientName": "Maria Silva",
"patientCpf": "0123456789",
"patientHealthCardNumber": "73762162171",
"patientEmail": "maria.silva@teste.com.br",
"healthcareProfessionalName": "Dr João",
"healthcareCouncilRegistration": "1234123",
"healthcareCouncilRegistrationUF": "RJ",
"healthcareCouncilRegistrationType": "CRM",
"prescription": "tomar dipirona 2x ao dia",
"prescriptions": [{"id": 8000,
"prescriptionDate": "01/01/2021 15:00",
"urlDownload": "url_download_prescricao",
"providerId": 123456,
"providerName": "MEVO"
}
],
"prescriptionProviderData": [{"providerId": 123456,
"providerName": "MEVO",
"providerDate": "21/03/2025 10:33",
"data": { }
}
]
}

Webhook proximidade de atendimento

Esse webhook é enviado quando um atendimento é agendado sem preferência de profissional e é disparado 5 minutos antes do horário agendado.

Request Body schema: application/json

Objeto com informações da chamada de quando um atendimento é agendado sem preferência de profissional

patientId required	long ID do paciente que agendou o atendimento
patientCpf	string CPF do paciente

Responses

Request samples

Payload

Content type

application/json

{"patientId": 87312,
"patientCpf": "0123456789"
}

Webhook atendimento cancelado

Esse webhook é enviado no momento que o atendimento é cancelado pelo profissional.

Request Body schema: application/json

Objeto com informações da chamada enviada no momento que o atendimento é cancelado pelo profissional

appointmentId required	long ID do atendimento
appointmentDate	string Data do atendimento
protocolId	string Protocolo (id) da solicitação do atendimento imediato
healthcareProfessionalId required	long ID do profissional de saúde
healthcareProfessionalName required	string Nome do profissional de saúde
healthcareProfessionalPhoto	string URL da foto do profissional de saúde
patientId required	long ID do paciente
patientName required	string Nome do paciente
patientBirthdate	string Data de nascimento do paciente
patientCpf	string CPF do paciente
patientEmail	string Email do paciente
patientCellphone	string Número do celular do paciente
outcome	string Enum: "NAO_INFORMADO" "ALTA_CONSULTA" "AMBULATORIAL" "ENCAMINHADO_PS" "ATENDIMENTO_INTERROMPIDO" "FOLLOW_UP_TELEMEDICINA" "PACIENTE_FALTOU" "DEMONSTRACAO" "INTERCONSULTA" "REGISTRO_ATESTADO" "ENCAMINHAMENTO_MEDICO_IMEDIATO" "ENCAMINHADO_PARA_EXAMES" "ATENDIMENTO_RECORRENTE" "ENTREVISTA_DE_TRIAGEM" "ENCAMINHAMENTO_PSIQUIATRIA" "ULTIMO_ATENDIMENTO" "ATENDIMENTO_PONTUAL" "PERICIA_MEDICA" "ENCAMINHADO_PARA_PROCEDIMENTOS" "ATENDIMENTO_INVALIDADO" Desfecho do atendimento
cancellationReason	string Motivo do cancelamento

Responses

Request samples

Payload

Content type

application/json

{"appointmentId": 123,
"appointmentDate": "01/01/2021 15:00",
"protocolId": "6f4a0823600b4fcc8dbd8f5d0caa342c",
"healthcareProfessionalId": 999,
"healthcareProfessionalName": "Dr João",
"healthcareProfessionalPhoto": "url_foto_profissional",
"patientId": 871,
"patientName": "Maria Silva",
"patientBirthdate": "28/02/1980",
"patientCpf": "0123456789",
"patientEmail": "maria.silva@teste.com.br",
"patientCellphone": "21999999999",
"outcome": "ALTA_CONSULTA",
"cancellationReason": "Estou me sentindo melhor."
}

Webhook criação de atendimento

Esse webhook é enviado no momento da criação de um atendimento.

Request Body schema: application/json

Objeto com informações enviado no momento da criação de um atendimento

appointmentId required	long ID do atendimento
appointmentDate required	string Data do atendimento
protocolId	string Protocolo (id) da solicitação do atendimento imediato
patientId required	long ID do paciente
patientName required	string Nome do paciente
patientBirthdate	string Data de nascimento do paciente
patientCpf	string CPF do paciente
patientEmail	string Email do paciente
patientCellphone	string Número do celular do paciente
	object
appointmentObjective required	string Enum: "ORIENTACAO" "ATESTADO" "AFASTADO" "CONSULTA_ROTINA" "RETORNO_CONSULTA" "ACOMPANHAMENTO_NUTRICIONAL_ONCOLOGICO" "ACOMPANHAMENTO_NUTRICIONAL_POS_OPERATORIO" "ACOMPANHAMENTO_NUTRICIONAL_PREVENTIVO" "ACOMPANHAMENTO_NUTRICIONAL_PATOLOGICO" "CONSULTA_URGENCIA_PADRAO" "CONSULTA_MONITORAMENTO_COVID_POS_PS" "CONSULTA_MONITORAMENTO_POS_INTERNACAO" "CONSULTA_REAVALIACAO_FOLLOW_UP" "CONSULTA_COVID_PRE_CIRURGICO" "AGENDAMENTO_POR_EXCECAO" Objetivo do atendimento
healthcareProfessionalId required	long ID do profissional de saúde
healthcareProfessionalName required	string Nome do profissional de saúde
healthcareProfessionalPhoto	string URL da foto do profissional de saúde
healthcareCouncilRegistration required	string Número do conselho (CRM, CRN...) do profissional de saúde
healthcareCouncilRegistrationUF required	string Enum: "AC" "AL" "AM" "AP" "BA" "CE" "DF" "ES" "GO" "MA" "MG" "MS" "MT" "PA" "PB" "PE" "PI" "PR" "RJ" "RN" "RO" "RR" "RS" "SC" "SE" "SP" "TO" UF do conselho do profissional de saúde
healthcareCouncilRegistrationType	string Enum: "CRM" "CRO" "COREN" "CRN" "CRP" "CREFITO" "CREFONO" "CFESS" "CONTER" "CFBM" "CREF" "NAO_DEFINIDO" Tipo de conselho (CRM, CRN, CRO...)
healthcareProfessionalSpecialtyId	long ID da especialidade do profissional de saúde na conexa
healthcareProfessionalSpecialty	string Nome da especialidade do profissional de sapude na conexa
kinshipOfTheHolder	string Enum: "PAI" "MAE" "CONJUGE" "FILHO" "ENTEADO" "COMPANHEIRO" "AVOS" "BISAVOS" "IRMAOS" "TIOS" "OUTROS" Grau de parentesco do titular

Responses

Request samples

Payload

Content type

application/json

{"appointmentId": 123,
"appointmentDate": "01/01/2021 15:00",
"protocolId": "6f4a0823600b4fcc8dbd8f5d0caa342c",
"patientId": 871,
"patientName": "Maria Silva",
"patientBirthdate": "28/02/1980",
"patientCpf": "0123456789",
"patientEmail": "maria.silva@teste.com.br",
"patientCellphone": "21999999999",
"patientAddress": {"address": "Rua de Teste",
"complement": "AP 303 BLOCO 09",
"district": "Copacabana",
"city": "Rio de Janeiro",
"stateDescription": "Rio de Janeiro",
"stateAbbreviation": "RJ",
"zipCode": "22060-040"
},
"appointmentObjective": "ORIENTACAO",
"healthcareProfessionalId": 999,
"healthcareProfessionalName": "Dr João",
"healthcareProfessionalPhoto": "url_foto_profissional",
"healthcareCouncilRegistration": "1234123",
"healthcareCouncilRegistrationUF": "RJ",
"healthcareCouncilRegistrationType": "CRM",
"healthcareProfessionalSpecialtyId": 2,
"healthcareProfessionalSpecialty": "Clínico Geral",
"kinshipOfTheHolder": "PAI"
}

Webhook PDF do atendimento concluído

Esse webhook envia o PDF do atendimento concluído.

header Parameters

patientId

required

string

ID do paciente que agendou o atendimento

Request Body schema: application/json

Objeto com informações do webhook que envia o PDF do atendimento concluído

cpf_Paciente required	string cpf do paciente
anamnese_Paciente required	string informação a respeito do PDF

Responses

Request samples

Payload

Content type

application/json

{"cpf_Paciente": "405.752.860-16",
"anamnese_Paciente": "string base64 do pdf"
}

Webhook NPS do atendimento

Esse webhook envia a lista de avaliações do atendimento ao ser realizada uma avaliação.

Request Body schema: application/json

Objeto com informações da lista de avaliações do atendimento ao ser realizada uma avaliação

required

Array of objects (nps)

Responses

Request samples

Payload

Content type

application/json

{"appointmentNPS": [{"nps": {"appointmentId": 1,
"score": 4,
"npsScale": 7,
"comment": "comentario",
"evaluationType": "MEDICO",
"appointmentShape": "AGENDADO",
"protocolId": "6f4a0823600b4fcc8dbd8f5d0caa342c"
}
}
]
}

Webhook NPS não respondido

Envia o webhook de NPS não respondido, envia o cpf do paciente que não respondeu à avaliação.

Request Body schema: application/json

Objeto com informações do cpf do paciente que não respondeu à avaliação

patientCpf

required

string

CPF do paciente que não respondeu à avaliação do atendimento

Responses

Request samples

Payload

Content type

application/json

{"patientCpf": "20151319065"
}

Webhook paciente removido da fila

Envia o webhook quando um paciente que é removido da fila de atendimento imediato.

Request Body schema: application/json

Objeto com informações do paciente que é removido da fila de atendimento imediato

protocolId required	string Protocolo (id) da solicitação do atendimento imediato
patientId required	long ID do paciente removido da fila de atendimento imediato
patientName required	string Nome do paciente removido da fila de atendimento imediato
patientCpf	string CPF do paciente
removalReason	string Motivo da remoção do paciente da fila

Responses

Request samples

Payload

Content type

application/json

{"protocolId": "6f4a0823600b4fcc8dbd8f5d0caa342c",
"patientId": 871,
"patientName": "Maria Silva",
"patientCpf": "0123456789",
"removalReason": "Estou me sentindo melhor"
}

Webhook status da videochamada

Envia o webhook de status da videochamada das teleconsultas realizadas através da plataforma conexa.

Request Body schema: application/json

Objeto com informações de status da videochamada das teleconsultas realizadas através da plataforma conexa

event required	string ready - será notificado quando o médico iniciar a chamada; ongoing - será notificado quando a chamada estiver em andamento, ou seja, quando o médico e o paciente estiverem na chamada; done - será notificado quando a chamada for finalizada; error - será notificado quando houver um erro fatal na chamada.
success required	boolean define se a notificação é de sucesso, quando o fluxo estiver correto; ou não, quando aconteceu um erro
	object
timestamp required	long timestamp do evento
	object

Responses

Request samples

Payload

Content type

application/json

{"event": "ready",
"success": true,
"data": {"appointmentId": 28747,
"callId": 11238,
"patientId": 653974,
"protocolId": "6f4a0823600b4fcc8dbd8f5d0caa342c",
"patientCpf": "0123456789"
},
"timestamp": 1607635632569,
"error": null
}

Webhook ativação de paciente

Envia o webhook quando acontece a ativação do paciente. Esse Webhook está no padrão hl7 fhir.

Request Body schema: application/json

Objeto com informações da ativação do paciente

resourceType required	string Enum: "Resource" "Patient" "OperationOutcome" Tipo do recurso
active required	boolean Flag que indica se paciente está ativo
gender required	string Enum: "male" "female" "other" "unknown" Gênero do paciente
birthDate required	object Data de nascimento do paciente no formato YYYY-MM-DD
required	object
required	Array of objects (HumanName)
	Array of objects (ConcactPoint)
required	Array of objects (PatientIdentifier)

Responses

Request samples

Payload

Content type

application/json

{"resourceType": "Patient",
"active": true,
"gender": "male",
"birthDate": "1980-02-28",
"managingOrganization": {"identifier": {"system": "https://paciente.conexasaude.com.br/",
"use": "usual",
"value": 11628298
}
},
"name": [{"text": "MARIA DA SILVA",
"use": "official"
}
],
"telecom": [{"value": "+5549990296877",
"system": "phone",
"use": "old"
}
],
"identifier": [{"system": "https://clinica.conexasaude.com.br/",
"use": "official",
"value": 7811
}
]
}

Webhook de reagendamento do atendimento

Envia o webhook quando acontece o reagendamento do atendimento.

Request Body schema: application/json

Objeto com informações do reagendamento

appointmentId required	long ID do atendimento
appointmentDate required	string Data do atendimento no formato 'dd/MM/yyyy HH:mm'
appointmentObjective	string Enum: "ORIENTACAO" "ATESTADO" "AFASTADO" "CONSULTA_ROTINA" "RETORNO_CONSULTA" "ACOMPANHAMENTO_NUTRICIONAL_ONCOLOGICO" "ACOMPANHAMENTO_NUTRICIONAL_POS_OPERATORIO" "ACOMPANHAMENTO_NUTRICIONAL_PREVENTIVO" "ACOMPANHAMENTO_NUTRICIONAL_PATOLOGICO" "CONSULTA_URGENCIA_PADRAO" "CONSULTA_MONITORAMENTO_COVID_POS_PS" "CONSULTA_MONITORAMENTO_POS_INTERNACAO" "CONSULTA_REAVALIACAO_FOLLOW_UP" "CONSULTA_COVID_PRE_CIRURGICO" "AGENDAMENTO_POR_EXCECAO" Objetivo do atendimento
patientId required	long ID do paciente
patientName required	string Nome do paciente
patientEmail	string Email do paciente
patientCellphone	string Celular do paciente
patientCpf	string CPF do paciente
healthcareProfessionalId required	long ID do profissional de saúde
healthcareProfessionalName required	string Nome do profissional de saúde
healthcareProfessionalPhoto	string URL da foto do profissional de saúde
healthcareProfessionalSpecialtyId	long ID da especialidade do profissional de saúde na conexa
healthcareProfessionalSpecialty	string Nome da especialidade do profissional de sapude na conexa
healthcareCouncilRegistration required	string Número do conselho (CRM, CRN...) do profissional de saúde
healthcareCouncilRegistrationUF required	string Enum: "AC" "AL" "AM" "AP" "BA" "CE" "DF" "ES" "GO" "MA" "MG" "MS" "MT" "PA" "PB" "PE" "PI" "PR" "RJ" "RN" "RO" "RR" "RS" "SC" "SE" "SP" "TO" UF do conselho do profissional de saúde
healthcareCouncilRegistrationType required	string Enum: "CRM" "CRO" "COREN" "CRN" "CRP" "CREFITO" "CREFONO" "CFESS" "CONTER" "CFBM" "CREF" "NAO_DEFINIDO" Tipo de conselho (CRM, CRN, CRO...)

Responses

Request samples

Payload

Content type

application/json

{"appointmentId": 123,
"appointmentDate": "19/03/2024 15:00",
"appointmentObjective": "ORIENTACAO",
"patientId": 871,
"patientName": "Maria Silva",
"patientEmail": "maria.silva@email.com.br",
"patientCellphone": "21999999999",
"patientCpf": "0123456789",
"healthcareProfessionalId": 999,
"healthcareProfessionalName": "Dr João",
"healthcareProfessionalPhoto": "url_foto_profissional",
"healthcareProfessionalSpecialtyId": 2,
"healthcareProfessionalSpecialty": "Clínico Geral",
"healthcareCouncilRegistration": "1234123",
"healthcareCouncilRegistrationUF": "RJ",
"healthcareCouncilRegistrationType": "CRM"
}