O recurso de Integração do Prontuário Verde foi projetado para ser o elo central de toda a sua gestão de informações de saúde e registros de pacientes, promovendo a unificação automática de dados em uma base de dados centralizada. Essa funcionalidade é ideal para criar conexões fluídas e diretas entre o Prontuário Verde e uma ampla gama de fontes de dados clínicos e administrativos.
Endpoint para autenticação. Utilize Basic Auth com usuário e senha fornecidos. Retorna um token Bearer válido por 1 hora.
| grant_type | string Default: "client_credentials" |
{- "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI...",
- "token_type": "bearer",
- "expires_in": 3600
}Esta requisição tem por objetivo retornar os horários disponíveis para agendamento, permitindo a filtragem parametrizada por unidade, especialidade, convênio, profissional, e intervalo de datas (data de início e data de fim).
| data_inicio | string Example: data_inicio=2025-09-01 08:00 Data de início do agendamento. |
| data_termino | string Example: data_termino=2025-09-02 18:00 Data de término do agendamento. |
| id_convenio | number Example: id_convenio=98761 Número de identificação do convênio. |
| id_especialidade | number Example: id_especialidade=59734 Número de identificação da especialidade. |
| id_profissional | number Example: id_profissional=24671 Número de identificação do profissional. |
| id_unidade | number Example: id_unidade=47280 Número de identificação da unidade. |
{- "items": [
- {
- "id_unidade": 0,
- "nome_unidade": "string",
- "profissionais": [
- {
- "items": [
- {
- "id_unidade": 1982,
- "nome_unidade": "Prontuário Verde - Canoas",
- "profissionais": {
- "id_profissional": 19284,
- "nome": "Ana Júia Ramos",
- "id_convenios": [
- 1981,
- 3873
], - "id_especialidades": [
- 193,
- 92
], - "agenda": [
- {
- "data": "2025-09-01",
- "horario_atendimento": [
- {
- "inicio": "08:00",
- "fim": "12:00"
}, - {
- "inicio": "13:00",
- "fim": "18:00"
}
], - "horário_ocupado": [
- {
- "inicio": "09:30",
- "fim": "10:00"
}
]
}, - {
- "data": "2025-09-02",
- "horario_atendimento": [
- {
- "inicio": "08:00",
- "fim": "12:00"
}, - {
- "inicio": "13:00",
- "fim": "18:00"
}
], - "horário_ocupado": [ ]
}
]
}
}
]
}
]
}
]
}Permite alterar a situação de um agendamento. Existem as seguintes situações: Agendado(AGE), Confirmado(CON), Presente(PRE), Falta(FAL), Atendido(ATE), Cancelado pela clinica(CAN) e Cancelado pelo paciente (CPA).
| id_agendamento required | number^[^/]+$ Example: 74832 Número de identificação do agendamento. |
| situacao required | string Situação do agendamento. |
{- "situacao": "FAL"
}{- "sucesso": true,
- "id_agendamento": 74832
}Esta requisição tem por objetivo recuperar a listagem integral de todos os agendamentos registrados para a totalidade dos pacientes cadastrados na clínica.
| data_inicio | string Example: data_inicio=2025-10-09 09:30 Data de início das agendas. |
| telefone required | string Example: telefone=555136897321 Telefones dos pacientes. |
{- "items": [
- {
- "data_inicio": "2025-10-09 09:30",
- "data_termino": "2025-10-09 10:30",
- "id_agendamento": 10001,
- "id_paciente": 10395,
- "id_profissional": 13042,
- "id_unidade": 1984,
- "nome_paciente": "Betina Rafaela Novaes",
- "situacao": "Agendado",
- "telefone_celular_paciente": "5551992421485",
- "telefone_comercial_paciente": null,
- "telefone_residencial_paciente": "555137749341"
}, - {
- "data_inicio": "2025-10-10 11:30",
- "data_termino": "2025-10-10 12:00",
- "id_agendamento": 10089,
- "id_paciente": 10246,
- "id_profissional": 14930,
- "id_unidade": 1984,
- "nome_paciente": "Olivia Andrea Barros",
- "situacao": "Confirmado",
- "telefone_celular_paciente": "5551991846327",
- "telefone_comercial_paciente": "555139600619",
- "telefone_residencial_paciente": "555136897321"
}
]
}Este endpoint é utilizado para inserir um novo bloqueio de horário (indisponibilidade) na agenda do profissional especificado pelo {id_profissional}.
| id_profissional required | number^[^/]+$ Example: 12456 Número de identificação do profissional. |
| data_inicio required | string Data de início do bloqueio. |
| horario_inicio required | string Horário de início do bloqueio. |
| data_termino required | string Data de término do bloqueio. |
| horario_termino required | string Horário de término do bloqueio. |
| motivo required | string Motivo do bloqueio. |
{- "data_inicio": "2025-10-10",
- "horario_inicio": "08:00:00",
- "data_termino": "2025-10-11",
- "horario_termino": "09:00:00",
- "motivo": "Viagem bate e volta."
}{- "sucesso": true
}Este endpoint tem por objetivo inserir um novo compromisso na agenda do profissional especificado pelo identificador {id_profissional}.
| id_profissional required | number^[^/]+$ Example: 19372 Número de identificação do profissional |
| data_inicio required | string Data de início do compromisso. |
| horario_inicio required | string Horário de início do compromisso. |
| data_termino required | string Data de término do compromisso. |
| horario_termino required | string Horário de término do compromisso. |
| descricao required | string Descrição do compromisso. |
{- "data_inicio": "2025-09-26",
- "horario_inicio": "07:00:00",
- "data_termino": "2025-09-26",
- "horario_termino": "08:00:00",
- "descricao": "Consulta Oftalmo"
}{- "sucesso": true
}Esta requisição tem por objetivo recuperar e listar a programação integral de todas as agendas e horários vinculados ao profissional em questão.
| id_profissional required | number^[^/]+$ Example: 12847 Número de identificação do profissional. |
| data_inicio | string Example: data_inicio=2025-10-15 Data limite inferior (início) utilizada para filtrar os agendamentos por intervalo de tempo. |
| data_termino | string Example: data_termino=2025-10-16 Data limite superior (fim) utilizada para filtrar os agendamentos por intervalo de tempo. |
{- "items": [
- {
- "inicio": "2025-10-15 08:00",
- "termino": "2025-10-15 09:00",
- "tipo_agendamento": "Consulta",
- "situacao": "AGENDADO",
- "id_paciente": 1422800,
- "nome_paciente": "Antonia Aparecida Nicole",
- "procedimento_a_realizar": null,
- "observacoes": null,
- "id_agendamento": 5028284,
- "id_unidade": 10923,
- "nome_unidade": "Clinica Matriz"
}, - {
- "inicio": "2025-10-15 12:00",
- "termino": "2025-10-15 16:00",
- "tipo_agendamento": "Agenda Bloqueada",
- "situacao": "AGENDADO",
- "id_paciente": null,
- "nome_paciente": null,
- "procedimento_a_realizar": null,
- "observacoes": "Compromisso",
- "id_agendamento": 5028286,
- "id_unidade": 10923,
- "nome_unidade": "Clinica Matriz"
}
]
}Este endpoint é utilizado para inserir um novo registro de agendamento diretamente na agenda do profissional especificado pelo identificador {id_profissional}.
| id_profissional required | number^[^/]+$ Example: 32731 Número de identificação do profissional. |
| id_unidade required | number Número de identificação da unidade. |
| id_paciente required | number Número de identificação do paciente. |
| nome_paciente required | string Nome do paciente. |
| data_inicio required | string Data de início do agendamento. |
| horario_inicio required | string Horário de início do agendamento. |
| horario_termino required | string Horário de término do agendamento. |
| observacoes | string Observações do agendamento. |
{- "id_unidade": 10923,
- "id_paciente": 1422800,
- "nome_paciente": null,
- "data_inicio": "2025-10-15",
- "horario_inicio": "10:00",
- "horario_termino": "11:00",
- "observacoes": "Encaixe"
}{- "sucesso": true,
- "id_agendamento": 5028400
}Este endpoint (PUT) é utilizado para atualizar o status de um agendamento específico, referenciado pelo {id_agenda}, definindo-o como 'Cancelado' na agenda do profissional {id_profissional}.
| id_agenda required | number^[^/]+$ Example: 15555 Número de identificação da agenda. |
| id_profissional required | number^[^/]+$ Example: 13726 Número de identificação do profissional. |
| nome_paciente required | string Nome do paciente. |
| notificar_paciente required | string Indicador se é necessário ou não notificar o paciente. |
{- "nome_paciente": "Mariana da Silva Silveira",
- "notificar_paciente": "Não"
}{- "sucesso": true,
- "id_agendamento": 52536
}O endpoint confere acesso à base de dados para listar o inventário completo dos convênios vigentes, entregando todos os registros pertinentes ao sistema.
{- "items": [
- {
- "id_convenio": 20841,
- "nome": "Unimed"
}, - {
- "id_convenio": 67893,
- "nome": "MetLife"
}
]
}Esta operação é designada para coletar e retornar o inventário completo de todas as categorias de despesa utilizadas para a classificação dos registros financeiros da clínica.
{- "items": [
- {
- "id": 1461,
- "nome": "DESPESAS COM MATERIAIS/INSUMOS"
}, - {
- "id": 14184,
- "nome": "SANGRIA DE CAIXA"
}, - {
- "id": 19472,
- "nome": "TARIFAS DE CARTÕES"
}
]
}Esta requisição tem por objetivo recuperar a listagem de todas as despesas registradas que se enquadram no intervalo temporal definido pelos parâmetros de data.
| data_inicio | string Example: data_inicio=2025-10-01 Data de início do intervalo de listagem das despesas. |
| data_termino | string Example: data_termino=2025-10-26 Data de término do intervalo de listagem das despesas. |
{- "items": [
- {
- "id_nota": 76246,
- "numero": 1,
- "data": "13/10/2025",
- "id_unidade": 10923,
- "id_fornecedor": 28465,
- "id_recebedor": 10936,
- "total_itens": 110,
- "total_despesa": 110,
- "total_pago": 0,
- "itens": [
- {
- "id_item": 97190,
- "descricao": "LUVA CIRURGICA ESTERIL [1376663] - UN",
- "quantidade": 10,
- "id_embalagem": 1,
- "valor_unitario": 1,
- "valor_total": 10
}, - {
- "id_item": 97189,
- "descricao": "LUVA CIRURGICA ESTERIL [1376663] - CX (COM 10 UN)",
- "quantidade": 10,
- "id_embalagem": 2,
- "valor_unitario": 10,
- "valor_total": 100
}
], - "pagamentos": [
- {
- "parcela": 1,
- "vencimento": "13/10/2025",
- "valor": 55,
- "valor_pago": 0,
- "situacao": "VENCIDO"
}, - {
- "parcela": 2,
- "vencimento": "13/10/2025",
- "valor": 55,
- "valor_pago": 0,
- "situacao": "VENCIDO"
}
]
}, - {
- "id_nota": 76098,
- "numero": 111,
- "data": "11/07/2025",
- "id_unidade": "10923,",
- "id_fornecedor": "28422,",
- "id_recebedor": "10936,",
- "total_itens": "100,",
- "total_despesa": "100,",
- "total_pago": "100,",
- "itens": [
- {
- "id_item": 96428,
- "descricao": "54234",
- "quantidade": 1,
- "id_embalagem": null,
- "valor_unitario": 100,
- "valor_total": 100
}
], - "pagamentos": [
- {
- "parcela": "1,",
- "vencimento": "11/07/2025",
- "valor": 100,
- "valor_pago": 100,
- "situacao": "PAGA"
}
]
}
]
}A operação efetua a apresentação integral do catálogo de especialidades oferecidas pela clínica, fornecendo a lista completa dos serviços disponíveis.
{- "items": [
- {
- "items": [
- {
- "nome": "Endodontia",
- "id_especialidade": 8754
}, - {
- "nome": "Ortodontia",
- "id especialidade": 9091
}, - {
- "nome": "Protese",
- "id especialidade": 93729
}
]
}
]
}A requisição realiza a listagem integral dos itens de despesa que compõem o registro financeiro em questão.
{- "items": [
- {
- "id_item": 1376497,
- "nome_item": "LAMINA DE BISTURI N.15",
- "embalagens": [
- {
- "id_embalagem": 49372,
- "id_unidade_medida": 75180,
- "sigla_unidade_medida": "EMB",
- "nome_unidade_medida": "EMBALAGEM"
}
]
}, - {
- "id_item": 13764274,
- "nome_item": "KIT CIRURGICO DESCARTAVEL EM SMS",
- "embalagens": [
- {
- "id_embalagem": 53782,
- "id_unidade_medida": 75112,
- "sigla_unidade_medida": "UN",
- "nome_unidade_medida": "UNIDADE"
}
]
}
]
}O endpoint permite acessar e coletar o registro integral de todos os fornecedores cadastrados à clínica, fornecendo a base necessária para a correta classificação das despesas.
{- "items": [
- {
- "cnpj": "35110461000100",
- "id": 1422,
- "nome": "OVYVA SOFTWARE LTDA"
}, - {
- "cnpj": "89157731000159",
- "id": 12863,
- "nome": "Gabriela e Caleb Consultoria Financeira Ltda"
}
]
}Esta requisição tem por objetivo recuperar e listar todos os orçamentos que atendam simultaneamente aos critérios de situação definida e ao intervalo temporal (datas de início e término) especificados nos parâmetros de consulta.
| data_final required | string Example: data_final=2025-10-13 Parâmetro de data que define o limite final do período de busca para os orçamentos. |
| data_inicial required | string Example: data_inicial=2025-10-01 Parâmetro de data que define o limite inicial do período de busca para os orçamentos. |
| situacao | string Example: situacao=QUITADO Parâmetro utilizado para filtrar os orçamentos com base em seu status ou situação atual. |
{- "items": [
- {
- "id_orcamento": 825255,
- "id_paciente": 1412981,
- "numero": 2,
- "descricao": "Paciente em tratamento de tártaro",
- "data_orcamento": "13/10/2025",
- "situacao_geral": "QUITADO",
- "situacao_tratamento": "NÃO INICIADO",
- "id_unidade": 10923,
- "valor_orcado": 150,
- "valor_aprovado": 150,
- "valor_pago": 150,
- "saldo": 0,
- "procedimentos": [
- {
- "id_procedimento": 1708566,
- "id_unidade": 10923,
- "regiao": null,
- "face": null,
- "valor": 50,
- "valor_pago": 50,
- "situacao": "APROVADO",
- "data_aprovacao": "13/10/2025",
- "id_profissional_executor": null,
- "data_execucao": null,
- "id_vendedor": null
}, - {
- "id_procedimento": 1708557,
- "id_unidade": 10923,
- "regiao": "AI",
- "face": null,
- "valor": 100,
- "valor_pago": 100,
- "situacao": "APROVADO",
- "data_aprovacao": "13/10/2025",
- "id_profissional_executor": null,
- "data_execucao": null,
- "id_vendedor": null
}
]
}
]
}Essa operação realiza a listagem completa do catálogo de procedimentos disponíveis na clínica.
{- "items": [
- {
- "id": 1708616,
- "nome": "ABANDONO DO TRATAMENTO",
- "codigo": "91000087",
- "tempo_duracao": 0,
- "id_especialidade": 190050,
- "valores": [
- {
- "id_unidade": 10923,
- "valor_bruto": 370,
- "custo_material": 0,
- "custo_laboratorial": 0,
- "custo_servico": 0,
- "outros_custos": 0
}
]
}, - {
- "id": 1708622,
- "nome": "ARCO LINGUAL MANTEDOR DE ESPACO",
- "codigo": "91000013",
- "tempo_duracao": 60,
- "id_especialidade": 190050,
- "valores": [
- {
- "id_unidade": 10923,
- "valor_bruto": 450,
- "custo_material": 0.79,
- "custo_laboratorial": 55,
- "custo_servico": 0,
- "outros_custos": 0
}
]
}, - {
- "id": 1708532,
- "nome": "ATIVIDADE EDUCATIVA EM SAUDE BUCAL",
- "codigo": "84000139",
- "tempo_duracao": 1,
- "id_especialidade": 190047,
- "valores": [
- {
- "id_unidade": 10923,
- "valor_bruto": 60,
- "custo_material": 0,
- "custo_laboratorial": 0,
- "custo_servico": 0,
- "outros_custos": 0
}
]
}
]
}Este endpoint é responsável por coletar e disponibilizar o catálogo completo de todos os programas de fidelidade que estão atualmente cadastrados no sistema.
{- "items": [
- {
- "ativo": false,
- "id": 12309,
- "nome": "Paciente Feliz",
- "permite_adesao": false
}
]
}Este endpoint tem por objetivo recuperar a listagem completa de todos os profissionais de saúde cadastrados na clínica.
{- "items": [
- {
- "id_profissional": 15159,
- "login": "profissional@email.com",
- "nome_completo": "Luiza Vargas",
- "conselho": "CRO",
- "registro": "4232323",
- "uf_registro": "PR",
- "categoria_registro": "CD",
- "cpf": null,
- "telefone_celular": "5551515155151",
- "id_unidades": [
- 10923,
- 19312
]
}, - {
- "id_profissional": 15158,
- "login": "lorenzo-mendes87@bsd.com.br",
- "nome_completo": "Lorenzo Theo Mendes",
- "conselho": "CRO",
- "registro": "4232157",
- "uf_registro": "RS",
- "categoria_registro": "CD",
- "cpf": "61893655580",
- "telefone_celular": "5586996423542",
- "id_unidades": [
- 10921
]
}
]
}Este endpoint tem por objetivo recuperar a listagem completa de todos os pacientes que se encontram vinculados ao profissional especificado pelo identificador {id_profissional}.
| id_profissional required | number^[^/]+$ Example: 18472 Número de identificação do profissional. |
| nome_paciente | string Example: nome_paciente=GUILHERME SANTANA Nome do paciente. |
{- "items": [
- {
- "id_paciente": 1412979,
- "nome": "GABRIEL SILVA",
- "sexo": "Masculino",
- "data_nascimento": "11/07/1982",
- "numero_prontuario": 1,
- "convenios_paciente": null
}, - {
- "id_paciente": "1422224,",
- "nome": "ROGÉRIO ALVES",
- "sexo": "Masculino",
- "data_nascimento": "11/02/1981",
- "numero_prontuario": 5,
- "convenios_paciente": null
}, - {
- "id_paciente": 1422800,
- "nome": "GUILHERME SANTANA",
- "sexo": "Masculino",
- "data_nascimento": "11/02/1981",
- "numero_prontuario": 42016,
- "convenios_paciente": [
- {
- "id_convenio": 62028,
- "nome_convenio": "CAIXA SEGURADORA",
- "numero": "1234",
- "plano": "FLEX",
- "data_inicio": null,
- "data_termino": null,
- "empresa": "OVYVA",
- "titular": "JOANA"
}
]
}
]
}Esta requisição tem por objetivo recuperar a listagem de todas as unidades de atendimento que estão vinculadas ao profissional especificado pelo identificador {id_profissional}.
| id_profissional required | number^[^/]+$ Example: 15159 Número de identificação do profissional |
{- "items": [
- {
- "id_unidade": 29582,
- "nome_unidade": "Prontuário Verde - São Leopoldo"
}, - {
- "id_unidade": 7329,
- "nome_unidade": "Prontuário Verde - Porto Alegre"
}
]
}Esta requisição é designada para coletar e disponibilizar o conjunto de todas as fontes de captação (origens) utilizadas para classificar a procedência dos pacientes da clínica.
{- "items": [
- {
- "id": 94892,
- "nome": "Instagram",
- "ativo": true
}, - {
- "id": 19472,
- "nome": "Doctoralia",
- "ativo": true
}
]
}Esta operação é designada para coletar e apresentar o inventário completo de todos os pacientes registrados na base de dados da organização. Ao ser acionada, a requisição garante o retorno da lista integral de clientes. Deve receber pelo menos um parâmetro, sendo ele nome, CPF ou telefone.
| telefone | string Example: telefone=5551999954897 Telefone do paciente. |
| nome | string Example: nome=Fabiana Hadassa Ferreira Nome do paciente. |
| cpf | string Example: cpf=95074719011 CPF do paciente. |
{- "items": [
- {
- "cpf": "27021131097",
- "data_nascimento": "07/11/2000",
- "id_paciente": 35732,
- "nome": "João da Silva",
- "numero_prontuario": 10,
- "observacoes": "Paciente alérgico à dipirona.",
- "sexo": "Masculino",
- "telefone_celular": "5551999954897",
- "telefone_comercial": "5551997378043",
- "telefone_residencial": "5551997378043",
- "convenios_paciente": [
- {
- "id_convenio": 62028,
- "nome_convenio": "CAIXA SEGURADORA",
- "numero": "1234",
- "plano": "FLEX",
- "data_inicio": null,
- "data_termino": null,
- "empresa": "OVYVA",
- "titular": "JOANA"
}
], - "{}etiquetas": [
- "Paciente Convênio Unimed",
- "Alergia à dipirona"
]
}, - {
- "cpf": "07564188014",
- "data_nascimento": "15/10/1998",
- "id_paciente": 35992,
- "nome": "Maria Eduarda Silveira",
- "numero_prontuario": 200,
- "observacoes": "Paciente alérgico à amoxilina.",
- "sexo": "Feminino",
- "telefone_celular": "5551992421485",
- "telefone_comercial": "5551997378043",
- "telefone_residencial": "555137749341",
- "convenios_paciente": null,
- "{}etiquetas": [
- "Paciente Particular",
- "Alergia à amoxilina"
]
}
]
}O endpoint possibilita a criação de uma nova entidade de paciente, estabelecendo um registro inicial na base da organização.
| nome_registro required | string Nome completo oficial da pessoa (registro civil). |
| nome_social | string Nome social da pessoa, se houver. |
| dt_nascimento | string Data de nascimento da pessoa. |
| sexo | string Sexo biológico ou gênero da pessoa. |
| rg | string Número do Registro Geral (RG). |
| cpf | string Número do Cadastro de Pessoas Físicas (CPF). |
| uf | string Unidade Federativa (Estado) de residência. |
| cidade | string Nome da cidade de residência. |
| bairro | string Nome do bairro de residência. |
| logradouro | string Nome da rua, avenida, praça, etc. |
| numero_logradouro | number Número do endereço residencial. |
| complemento_logradouro | string Complemento do endereço. |
| cep | string Código de Endereçamento Postal (CEP). |
| telefone_residencial | string Número de telefone fixo residencial. |
| telefone_comercial | string Número de telefone comercial. |
| telefone_celular | string Número de telefone celular. |
string Endereço de e-mail. | |
| cns | string Número do Cartão Nacional de Saúde (CNS). |
| responsavel | string Nome completo do responsável legal (se aplicável). |
| responsavel_cpf | string CPF do responsável legal. |
| observacoes | string Campo para observações e informações adicionais. |
| id_origem | number Identificador da origem do cadastro/registro. |
| id_fidelidade | number Identificador ou número do programa de fidelidade. |
| vigencia_fim_fidelidade | string Data de término da vigência do programa de fidelidade. |
| nacionalidade | string Nacionalidade da pessoa. |
| estado_civil | string Estado civil da pessoa. |
| profissao | string Profissão ou ocupação principal. |
| nome_pai | string Nome completo do pai. |
| nome_mae | string Nome completo da mãe. |
| responsavel_nacionalidade | string Nacionalidade do responsável legal. |
| responsavel_estado_civil | string Estado civil do responsável legal. |
| responsavel_profissao | string Profissão ou ocupação do responsável legal. |
| responsavel_rg | string RG do responsável legal. |
| id_unidade | number Identificador da unidade de atendimento ou registro. |
| cpf_menor_estrangeiro | string CPF ou número de documento alternativo para menor estrangeiro. |
{- "items": [
- {
- "nome_registro": "Lúcia Rita Benedita Melo",
- "nome_social": null,
- "dt_nascimento": "27/07/2000",
- "sexo": "Feminino",
- "rg": "287878119",
- "cpf": "75822774067",
- "uf": "RS",
- "cidade": "Canoas",
- "bairro": "Nossa Senhora das Graças",
- "logradouro": "Rua Monte Castelo",
- "numero_logradouro": "625",
- "complemento_logradouro": "CASA",
- "cep": null,
- "telefone_residencial": "555135105529",
- "telefone_comercial": null,
- "telefone_celular": "5551993092796",
- "email": "lucia_rita_melo@construtoraplaneta.com.br",
- "cns": null,
- "responsavel": null,
- "responsavel_cpf": null,
- "observacoes": null,
- "id_origem": null,
- "id_fidelidade": null,
- "vigencia_fim_fidelidade": null,
- "nacionalidade": "BRASILEIRO(A)",
- "estado_civil": null,
- "profissao": "Professora",
- "nome_pai": null,
- "nome_mae": null,
- "responsavel_nacionalidade": null,
- "responsavel_estado_civil": null,
- "responsavel_profissao": null,
- "responsavel_rg": null,
- "id_unidade": 1,
- "cpf_menor_estrangeiro": null
}
]
}{- "sucesso": true,
- "id_paciente": 42726
}Esta requisição tem por objetivo recuperar e retornar os dados do paciente específico, com base no ID ({id_paciente}) fornecido no caminho do endpoint.
| id_paciente required | number Example: 12983 Número de identificação do paciente |
{- "items": [
- {
- "cpf": "27021131097",
- "data_nascimento": "07/11/2000",
- "id_paciente": 35732,
- "nome": "João da Silva",
- "numero_prontuario": 10,
- "observacoes": "Paciente alérgico à dipirona.",
- "sexo": "Masculino",
- "telefone_celular": "5551999954897",
- "telefone_comercial": "5551997378043",
- "telefone_residencial": "5551997378043",
- "convenios_paciente": [
- {
- "id_convenio": 62028,
- "nome_convenio": "CAIXA SEGURADORA",
- "numero": "1234",
- "plano": "FLEX",
- "data_inicio": null,
- "data_termino": null,
- "empresa": "OVYVA",
- "titular": "JOANA"
}
], - "{}etiquetas": [
- "Paciente Convênio Unimed",
- "Alergia à dipirona"
]
}
]
}Este endpoint permite atualizar os dados de um paciente específico. A operação aceita atualização parcial: apenas os campos fornecidos no corpo da requisição (JSON) serão alterados, mantendo-se inalterados os demais dados do registro.
| id_paciente required | number^[^/]+$ Example: 12001 Número de identificação do paciente |
| nome_registro | string Nome do paciente. |
| nome_social | string Nome social do paciente. |
| dt_nascimento | string Data de nascimento do paciente. |
| sexo | string Sexo biológico do paciente. |
| rg | string RG do paciente. |
| cpf | string CPF do paciente. |
| uf | string Unidade Federativa de residência. |
| cidade | string Cidade de residência. |
| bairro | string Bairro de residência. |
| logradouro | string Nome da rua, avenida ou logradouro. |
| numero_logradouro | string Número do logradouro. |
| complemento_logradouro | string Complemento do endereço. |
| cep | string Código de Endereçamento Postal (CEP). |
| telefone_residencial | string Telefone residencial do paciente. |
| telefone_comercial | string Telefone comercial do paciente. |
| telefone_celular | string Telefone celular do paciente. |
string Endereço de e-mail. | |
| cns | string Cartão Nacional de Saúde. |
| responsavel | string Nome do responsável legal, se aplicável. |
| responsavel_cpf | string CPF do responsável legal. |
| observacoes | string Campo para observações adicionais. |
| id_origem | number Número de identificação da origem do registro. |
| id_fidelidade | number Número de identificação de fidelidade/programa de benefícios. |
| vigencia_fim_fidelidade | string Data de fim da vigência do programa de fidelidade. |
| nacionalidade | string Nacionalidade do paciente. |
| estado_civil | string Estado civil do paciente. |
| profissao | string Profissão do paciente. |
| nome_pai | string Nome completo do pai. |
| nome_mae | string Nome completo da mãe. |
| responsavel_nacionalidade | string Nacionalidade do responsável legal. |
| responsavel_estado_civil | string Estado civil do responsável legal. |
| responsavel_profissao | string Profissão do responsável legal. |
| responsavel_rg | string RG do responsável legal. |
| id_unidade | number Número de identificador da unidade de atendimento/registro. |
| cpf_menor_estrangeiro | string Indica se o CPF pertence a um menor estrangeiro. |
{- "nome_registro": "Ryan Anderson da Silva",
- "nome_social": null,
- "dt_nascimento": "23/01/1980",
- "sexo": "Masculino",
- "rg": "329491878",
- "cpf": "50779257120",
- "uf": "PB",
- "cidade": "João Pessoa",
- "bairro": "Mangabeira",
- "logradouro": "Rua Josina Lessa Feitosa",
- "numero_logradouro": "789",
- "complemento_logradouro": null,
- "cep": "58055260",
- "telefone_residencial": "8338774043",
- "telefone_comercial": null,
- "telefone_celular": "83988485004",
- "email": "ryan.anderson.dasilva@negleribeiro.com",
- "cns": null,
- "responsavel": "string",
- "responsavel_cpf": "string",
- "observacoes": "Paciente diabético",
- "id_origem": 0,
- "id_fidelidade": 0,
- "vigencia_fim_fidelidade": "string",
- "nacionalidade": "Brasileiro",
- "estado_civil": "Casado",
- "profissao": "Empresário",
- "nome_pai": "Mateus Luís Tomás da Silva",
- "nome_mae": "Antônia Aparecida Nicole",
- "responsavel_nacionalidade": null,
- "responsavel_estado_civil": null,
- "responsavel_profissao": "string",
- "responsavel_rg": null,
- "id_unidade": 1,
- "cpf_menor_estrangeiro": "S"
}{- "sucesso": true,
- "id_paciente": 12001
}A operação retorna um inventário detalhado de todos os convênios ativos no cadastro do paciente cujo ID foi informado.
| id_paciente required | number^[^/]+$ Example: 18723 Número de identificação do paciente |
{- "items": [
- {
- "data_inicio": "2025-10-10",
- "data_termino": "2026-10-10",
- "empresa": "Unimed",
- "id_convenio": 5839,
- "nome_convenio": "Unimed",
- "numero": 6842,
- "plano": "+Longevidade",
- "titular": "Theodoro Alvin"
}
]
}A requisição realiza o cadastro (ou inclusão) de um novo convênio, vinculando-o diretamente ao registro do paciente especificado.
| id_paciente required | number^[^/]+$ Example: 12663 Número de identificação do paciente |
| id_convenio required | number Número de identificação do convênio. |
| numero_convenio required | number Número de registro, matrícula ou código do plano/carteirinha do beneficiário. |
| plano | string Nome do plano. |
| empresa | string Nome da empresa ou instituição responsável pela contratação/fornecimento do convênio. |
| titular | string Nome ou identificador do titular principal do convênio/plano (a pessoa responsável pelo contrato). |
{- "id_convenio": 62028,
- "numero_convenio": 1234,
- "plano": "FLEX",
- "empresa": "OVYVA",
- "titular": "JOANA"
}{- "sucesso": true,
- "id_paciente": 12001
}Esta requisição tem por objetivo recuperar a listagem integral de todas as etiquetas (tags) disponíveis para classificação e atribuição aos pacientes.
{- "items": [
- {
- "id_etiqueta": 59332,
- "nome": "Convênio Mais Saúde"
}, - {
- "id_etiqueta": 60613,
- "nome": "Menor de idade"
}, - {
- "id_etiqueta": 60614,
- "nome": "Paciente Diabético"
}
]
}Esta requisição tem por objetivo recuperar a listagem completa de todas as etiquetas (tags de classificação) que se encontram vinculadas ao paciente especificado pelo identificador {id_paciente}.
| id_paciente required | number^[^/]+$ Example: 12231 Número de identificação do paciente. |
{- "items": [
- {
- "id_etiqueta": 1256,
- "nome": "Paciente Menor de Idade"
}, - {
- "id_etiqueta": 2984,
- "nome": "Convênio"
}, - {
- "id_etiqueta": 3224,
- "nome": "Diabético"
}
]
}A operação realiza a exclusão de uma etiqueta do perfil do paciente, desassociando a classificação.
| id_paciente required | number^[^/]+$ Example: 1422800 Número de identificação do paciente. |
| etiqueta required | string Etiqueta do paciente. |
{- "etiqueta": [
- "Paciente Menor de Idade",
- "Pele sensível"
]
}{- "sucesso": true,
- "id_paciente": 1422800
}Esta requisição tem por objetivo atribuir ou vincular uma nova etiqueta de classificação ao registro do paciente.
| id_paciente required | number^[^/]+$ Example: 1422800 Número de identificação do paciente. |
| etiqueta required | string Etiqueta do paciente. |
{- "etiqueta": [
- "Paciente doador de sangue",
- "Tipo sanguíneo: O+"
]
}{- "sucesso": true,
- "id_paciente": 1422800
}Esta requisição tem por objetivo recuperar a listagem de todos os agendamentos registrados para o paciente cujo identificador ({id_paciente}) foi fornecido.
| id_paciente required | number^[^/]+$ Example: 13811 Número de identificação do paciente. |
| data_inicio | string Example: data_inicio=2025-10-10 09:30 Data de início do agendamento. |
{- "items": [
- {
- "data_inicio": "2025-10-10 09:30",
- "data_termino": "2025-10-10 10:30",
- "id_agendamento": 24627,
- "id_paciente": 13811,
- "id_profissional": 5893,
- "id_unidade": 1257,
- "nome_paciente": "Benedita Tânia Laís Gonçalves",
- "situacao": "Confirmado",
- "telefone_celular_paciente": "5586994700549",
- "telefone_comercial_paciente": "558635183187",
- "telefone_residencial_paciente": "558635183187"
}
]
}Esta requisição tem por objetivo recuperar a listagem integral de todos os registros de recebimentos provenientes de convênios.
| data_final | string Example: data_final=2025-10-17 Parâmetro de data que define o limite final do período de busca para os recebimentos de convênio. |
| data_inicial | string Example: data_inicial=2025-10-18 Parâmetro de data que define o limite inicial do período de busca para os recebimentos de convênio. |
{- "items": [
- {
- "id_unidade": 10923,
- "id_convenio": 62028,
- "id_conta": 855267,
- "data": "17/10/2025",
- "valor": 15.69,
- "id_recebedor": 10936
}, - {
- "id_unidade": 11274,
- "id_convenio": 12032,
- "id_conta": 855267,
- "data": "18/10/2025",
- "valor": 18.95,
- "id_recebedor": 10938
}
]
}Esta requisição tem por objetivo recuperar a listagem integral de todos os registros de recebimentos particulares.
| data_final required | string Example: data_final=2025-10-17 Parâmetro de data que define o limite final do período de busca para os recebimentos de natureza particular. |
| data_inicial required | string Example: data_inicial=2025-10-15 Parâmetro de data que define o limite inicial do período de busca para os recebimentos de natureza particular. |
{- "items": [
- {
- "id": 754193,
- "id_unidade": 10923,
- "recebedor": "Clinica Canoas",
- "conta": "CAIXA DE JOÃO DA SILVA",
- "nome_tipo": "Dinheiro",
- "meio_pagamento": "DINHEIRO",
- "id_paciente": 1412981,
- "pac_nome": "JOSÉ ROBERTO DOS SANTOS",
- "documento_pagador": "04747923071",
- "nome_pagador": null,
- "parcela": null,
- "data": "15/10/2025",
- "valor_bruto": 150,
- "valor_liquido": 150,
- "itens": "[{\\\"tipo_item\\\":\\\"Procedimento\\\",\\\"nome_item\\\":\\\"APLICACAO TOPICA DE FLUOR - PACOTE\\\",\\\"executor\\\":null,\\\"valor_cobrado\\\":\\\"50.00\\\"},{\\\"tipo_item\\\":\\\"Procedimento\\\",\\\"nome_item\\\":\\\"AJUSTE OCLUSAL POR DESGASTE SELETIVO - AI\\\",\\\"executor\\\":null,\\\"valor_cobrado\\\":\\\"100.00\\\"}]"
}
]
}Esta requisição tem por objetivo recuperar a listagem integral de todas as unidades de atendimento (ou filiais) cadastradas na conta da organização.
{- "items": [
- {
- "id_unidade": 18373,
- "nome": "Prontuário Verde - Florianópolis"
}, - {
- "id_unidade": 12546,
- "nome": "Prontuário Verde - Fortaleza"
}, - {
- "id_unidade": 13764,
- "nome": "Prontuário Verde - São Paulo"
}
]
}