API docs by Redocly

API Clinicarx (1.4.1)

Download OpenAPI specification:Download

Suporte Técnico Clinicarx: api@clinicarx.com.br URL: https://clinicas.clinicarx.com.br/

Introdução

A API Clinicarx possibilita a conexão entre nosso software de saúde e nossos parceiros, viabilizando o acesso rápido aos dados em seus sistemas. Com ela, a experiência dos usuários é potencializada ao integrar funcionalidades do nosso software de maneira automatizada.

Através da API Clinicarx, é possível aprimorar a experiência dos pacientes ao fornecer informações atualizadas sobre agendamentos, atendimentos e serviços. Além disso, a integração direta com a Plataforma Clinicarx elimina tarefas manuais e aprimora a eficiência operacional.

Se surgirem dúvidas durante a integração, consulte a documentação completa e contate nossa equipe de Suporte Técnico para assistência especializada.

Contato

Recomendamos que você consulte a documentação da API Clinicarx em primeiro lugar, pois muitas perguntas podem ter respostas detalhadas e soluções já documentadas.

No entanto, se surgirem dúvidas ou se você precisar de assistência adicional durante o processo de integração ou ao utilizar a API Clinicarx,, não hesite em entrar em contato conosco pelo e-mail api@clinicarx.com.br. Nossa equipe terá prazer em ajudá-lo e garantir que sua experiência com a API Clinicarx seja bem-sucedida.

Requisitos de acesso à API Clinicarx

Para acessar a API Clinicarx, é necessário seguir os seguintes requisitos:

  • Solicitar credenciais: Entre em contato com o nosso time de desenvolvimento (api@clinicarx.com.br) para solicitar as credenciais de acesso. Você receberá um app_id (username) e um app_key (password), que deverão ser utilizados para autenticar as requisições.
  • Autenticação: A autenticação para todas as requisições à API Clinicarx é feita utilizando o método Basic Auth. Você deve incluir as credenciais (app_id e app_key) no cabeçalho das requisições.

Regras e Premissas

  • Modelo de Comunicação: O formato de requisição da sua API Clinicarx é baseado em REST (Representational State Transfer). Isso significa que as solicitações são feitas por meio dos métodos HTTP, como GET, POST, PUT e DELETE, para interagir com os recursos da API.

  • Codificação de caracteres: O conteúdo retornado pela API Clinicarx segue a codificação UTF-8. Certifique-se de configurar corretamente a codificação UTF-8 ao manipular as respostas da API para evitar problemas de caracteres especiais.

  • Comunicação segura: Toda comunicação com a API Clinicarx deve ser feita por meio de conexões seguras utilizando HTTPS.

  • Stateless: A API Clinicarx é projetada como stateless, o que significa que cada requisição é independente e não mantém estado entre as solicitações.

  • Formato de dados (content-type): A API Clinicarx utiliza o formato JSON (JavaScript Object Notation) para as requisições e respostas. Certifique-se de enviar e receber os dados no formato adequado.

  • Formato de datas e horários: Utilize o formato YYYY-MM-DD hh:mm:ss para datas e horários na API Clinicarx. O fuso-horário padrão é sempre UTC (Tempo Universal Coordenado). Ex: O 2018-05-25 21:33:21 (UTC) equivale à 2018-05-25 18:33:21 (GMT-3)

  • Separador decimal: A API Clinicarx utiliza o separador decimal americano, sem o separador de milhares. Por exemplo, o número 1989.01 representa 1.989,01.

  • Campos numéricos: Campos como CPF, CNPJ e CEP devem ser fornecidos como valores numéricos, sem formatações especiais.

  • Códigos HTTP: A API Clinicarx retorna códigos HTTP para indicar o status da requisição. Alguns dos principais códigos são:

    • 200: Esta requisição foi bem sucedida
    • 400: Dados fornecidos na requisição são inválidos
    • 401: Credenciais utilizadas são inválidas
    • 403: Credenciais utilizadas não têm permissão de acesso ao conteúdo
    • 404: Não encontrado
    • 500: Ocorreu um problema interno no servidor. Tente novamente em breve. Se o erro persistir, entre em contato com o suporte para obter assistência.

Agendamentos

Tudo sobre seus Agendamentos

Listar os Agendamentos de um Paciente

Este endpoint retorna a lista de agendamentos de um paciente específico com base em seu ID (UUID) ou CPF (ID) Se os parâmetros start e end não forem definidos, serão listados agendamentos entre a data corrente e o dia seguinte.

Authorizations:
basicAuth
path Parameters
patient_id
required
string
Example: 17052897890 ou 498124ed-53d5-46eb-89c9-2b1e6a6191a5

Id (CPF) ou UUID do Paciente

query Parameters
start
string <date-time>

Data de início do filtro

end
string <date-time>

Data de fim do filtro

sort
string

Ordena conforme o valor passado, para ordernar de forma decrescente passar o sinal negativo (-) antes do nome do parâmeto. Se for passado o parametro filter esse será desconsiderado

limit
integer

Limita a quantidade de resultados por requisição. O limite não pode ser maior que 100.

page
integer

Determina a conjunto de resultados

clinic
string
Example: clinic=09390160000169

filtra os eventos pelo CNPJ da farmácia

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "api_version": "1.0.0",
  • "pagination": {
    }
}

Agendar um horário para um Paciente

Este endpoint permite criar um novo evento (agendamento) associado a um paciente com base no seu ID (UUID) ou CPF (ID). Os agendamentos realizados através da API Clinicarx permitem a sobreposição com bloqueios de agenda que possam existir na clínica/filial.

Authorizations:
basicAuth
path Parameters
patient_id
required
string
Example: 17052897890 ou 498124ed-53d5-46eb-89c9-2b1e6a6191a5

Id (CPF) ou UUID do Paciente

query Parameters
allow_overlap
boolean
Example: allow_overlap=false

Permite sobreposição de agenda

Request Body schema: application/json
clinic_id
required
string (CNPJ da farmácia do agendamento)

Identificador único da farmácia, o id é composto pelo CNPJ, apenas números, sem formatação.

clinic_uuid
string <uuid> (UUID da farmácia do agendamento)
patient_cpf
string (CPF do paciente que agendou a consulta)

Identificador único do paciente, o id é composto pelo CPF, apenas números, sem formatação.

status
string (Status do evento)
Enum: "open" "done" "cancelled" "processing" "patient_missing"

em qual estado o evento está, ou seja, se ele ainda não foi realizado, se foi cancelado, se está sendo realizado, se já foi realizado ou se o paciente faltou

scheduled_start_at
required
string <date-time> (data e hora que o evento tem previsão de começar com o Fuso-Horário UTC)
scheduled_end_at
required
string <date-time> (data e hora que o evento tem previsão de acabar com o Fuso-Horário UTC)
scheduled_duration
integer (Duração prevista do evento)
annotations
string (Observações do agendamento)
allow_overlap
boolean (Quando permite que há mais de um agendamento do mesmo horário)
timezone
string (Fuso-horário do local do agendamento)

Responses

Request samples

Content type
application/json
{
  • "clinic_id": "09390160000169",
  • "clinic_uuid": "498124ed-53d5-46eb-89c9-2b1e6a6191a5",
  • "patient_cpf": 17052897890,
  • "status": "done",
  • "scheduled_start_at": "2017-05-31 09:17:03",
  • "scheduled_end_at": "2017-05-31 10:47:03",
  • "scheduled_duration": 30,
  • "annotations": "Retorno marcado para verificar melhora do paciente",
  • "allow_overlap": false,
  • "timezone": "America/Sao_Paulo"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "api_version": "1.0.0"
}

Consultar um agendamento específico de um Paciente

Este endpoint retorna as informações de um evento agendado com base no ID fornecido. As informações do paciente associado ao evento serão retornadas somente se o paciente pertencer à mesma rede do usuário autenticado.

Authorizations:
basicAuth
path Parameters
patient_id
required
string
Example: 17052897890 ou 498124ed-53d5-46eb-89c9-2b1e6a6191a5

Id (CPF) ou UUID do Paciente

id
required
string <uuid>
Example: 8a492139-c5be-4cf8-bfc0-7ab12f8460b5

Id do Agendamento

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "api_version": "1.0.0"
}

Atualizar dados do agendamento de um paciente

Este endpoint permite atualizar os dados de um agendamento existente ou remarcar um agendamento para um paciente.

Authorizations:
basicAuth
path Parameters
patient_id
required
string
Example: 17052897890 ou 498124ed-53d5-46eb-89c9-2b1e6a6191a5

Id (CPF) ou UUID do Paciente

id
required
string <uuid>
Example: 8a492139-c5be-4cf8-bfc0-7ab12f8460b5

Id do Agendamento

Request Body schema: application/json
clinic_id
required
string (CNPJ da farmácia do agendamento)

Identificador único da farmácia, o id é composto pelo CNPJ, apenas números, sem formatação.

clinic_uuid
string <uuid> (UUID da farmácia do agendamento)
patient_cpf
string (CPF do paciente que agendou a consulta)

Identificador único do paciente, o id é composto pelo CPF, apenas números, sem formatação.

patient_uuid
string <uuid> (UUID do paciente que agendou a consulta)
status
string (Status do evento)
Enum: "open" "done" "cancelled" "processing" "patient_missing"

em qual estado o evento está, ou seja, se ele ainda não foi realizado, se foi cancelado, se está sendo realizado, se já foi realizado ou se o paciente faltou

scheduled_start_at
required
string <date-time> (data e hora que o evento tem previsão de começar com o Fuso-Horário UTC)
scheduled_end_at
required
string <date-time> (data e hora que o evento tem previsão de acabar com o Fuso-Horário UTC)
scheduled_duration
integer (Duração prevista do evento)
annotations
string (Observações do agendamento)
allow_overlap
boolean (Quando permite que há mais de um agendamento do mesmo horário)

Responses

Request samples

Content type
application/json
{
  • "clinic_id": "09390160000169",
  • "clinic_uuid": "498124ed-53d5-46eb-89c9-2b1e6a6191a5",
  • "patient_cpf": 17052897890,
  • "patient_uuid": "498124ed-53d5-46eb-89c9-2b1e6a6191a5",
  • "status": "done",
  • "scheduled_start_at": "2017-05-31 09:17:03",
  • "scheduled_end_at": "2017-05-31 10:47:03",
  • "scheduled_duration": 30,
  • "annotations": "Retorno marcado para verificar melhora do paciente",
  • "allow_overlap": false
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "api_version": "1.0.0"
}

Cancelar/Excluir um agendamento

Este endpoint permite cancelar um agendamento realizado para um paciente com base no ID do evento fornecido. Ao cancelar o agendamento, ele é removido da agenda da clínica/filial. Para agendamentos cancelados pela API, não são enviados e-mails aos pacientes.

Authorizations:
basicAuth
path Parameters
patient_id
required
string
Example: 17052897890 ou 498124ed-53d5-46eb-89c9-2b1e6a6191a5

Id (CPF) ou UUID do Paciente

id
required
string <uuid>
Example: 8a492139-c5be-4cf8-bfc0-7ab12f8460b5

Id do Agendamento

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [ ],
  • "api_version": "1.3.3"
}

Listar os agendamentos de uma Clínica ou Filial

Este endpoint retorna a lista de agendamentos associados a uma clínica/filial específica com base no ID fornecido.

Authorizations:
basicAuth
path Parameters
clinic_id
required
string
Example: 09390160000169 ou 498124ed-53d5-46eb-89c9-2b1e6a6191a5

Id (CNPJ) ou UUID da Farmácia

query Parameters
start
string <date-time>

Data de início do filtro

end
string <date-time>

Data de fim do filtro

sort
string

Ordena conforme o valor passado, para ordernar de forma decrescente passar o sinal negativo (-) antes do nome do parâmeto. Se for passado o parametro filter esse será desconsiderado

limit
integer

Limita a quantidade de resultados por requisição. O limite não pode ser maior que 100.

page
integer

Determina a conjunto de resultados

patient
string
Example: patient=17052897890

filtra os eventos pelo CNPJ da farmácia

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "pagination": {
    }
}

Fazer o agendamento de um horário em uma Clínica ou Filial

Este endpoint permite criar um novo evento (agendamento) na agenda de uma clínica/filial específica. Os agendamentos realizados através da API Clinicarx permitem a sobreposição com bloqueios de agenda que possam existir na clínica/filial.

Authorizations:
basicAuth
path Parameters
clinic_id
required
string
Example: 09390160000169 ou 498124ed-53d5-46eb-89c9-2b1e6a6191a5

Id (CNPJ) ou UUID da Farmácia

Request Body schema: application/json
patient_id
required
string (CPF do paciente que agendou a consulta)

Identificador único do paciente, o id é composto pelo CPF, apenas números, sem formatação.

status
required
string (Status do evento)
Enum: "open" "done" "cancelled" "processing" "patient_missing"

em qual estado o evento está, ou seja, se ele ainda não foi realizado, se foi cancelado, se está sendo realizado, se já foi realizado ou se o paciente faltou

scheduled_start_at
required
string <date-time> (data e hora que o evento tem previsão de começar com o Fuso-Horário UTC)
scheduled_end_at
required
string <date-time> (data e hora que o evento tem previsão de acabar com o Fuso-Horário UTC)
scheduled_duration
integer (Duração prevista do evento)
annotations
string (Observações do agendamento)
patient_uuid
string <uuid> (UUID do paciente que agendou a consulta)
allow_overlap
boolean (Permite o agendamento de mais de um serviço ao mesmo tempo)
timezone
string (Fuso-horário do local do agendamento)

Responses

Request samples

Content type
application/json
{
  • "patient_id": 17052897890,
  • "status": "done",
  • "scheduled_start_at": "2017-05-31 09:17:03",
  • "scheduled_end_at": "2017-05-31 10:47:03",
  • "scheduled_duration": 30,
  • "annotations": "Retorno marcado para verificar melhora do paciente",
  • "patient_uuid": "498124ed-53d5-46eb-89c9-2b1e6a6191a5",
  • "allow_overlap": false,
  • "timezone": "America/Sao_Paulo"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "api_version": "1.0.0"
}

Consultar um agendamento específico de uma Clínica ou Filial

Este endpoint retorna as informações de um evento agendado com base no ID fornecido. As informações do paciente associado ao evento serão retornadas somente se o paciente pertencer à mesma rede do usuário autenticado.

Authorizations:
basicAuth
path Parameters
clinic_id
required
string
Example: 09390160000169 ou 498124ed-53d5-46eb-89c9-2b1e6a6191a5

Id (CNPJ) ou UUID da Farmácia

id
required
string <uuid>
Example: 8a492139-c5be-4cf8-bfc0-7ab12f8460b5

Id do Agendamento

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "api_version": "1.0.0"
}

Atualizar dados de um agendamento em uma Clínica ou Filial

Este endpoint permite atualizar os dados de um agendamento existente ou remarcar um agendamento em uma clínica/filial específica.

Authorizations:
basicAuth
path Parameters
clinic_id
required
string
Example: 09390160000169 ou 498124ed-53d5-46eb-89c9-2b1e6a6191a5

Id (CNPJ) ou UUID da Farmácia

id
required
string <uuid>
Example: 8a492139-c5be-4cf8-bfc0-7ab12f8460b5

Id do Agendamento

Request Body schema: application/json
patient_id
required
string (CPF do paciente que agendou a consulta)

Identificador único do paciente, o id é composto pelo CPF, apenas números, sem formatação.

status
required
string (Status do evento)
Enum: "open" "done" "cancelled" "processing" "patient_missing"

em qual estado o evento está, ou seja, se ele ainda não foi realizado, se foi cancelado, se está sendo realizado, se já foi realizado ou se o paciente faltou

scheduled_start_at
required
string <date-time> (data e hora que o evento tem previsão de começar com o Fuso-Horário UTC)
scheduled_end_at
required
string <date-time> (data e hora que o evento tem previsão de acabar com o Fuso-Horário UTC)
scheduled_duration
integer (Duração prevista do evento)
annotations
string (Observações do agendamento)
patient_uuid
string <uuid> (UUID do paciente que agendou a consulta)
allow_overlap
boolean (Permite o agendamento de mais de um serviço ao mesmo tempo)
timezone
string (Fuso-horário do local do agendamento)

Responses

Request samples

Content type
application/json
{
  • "patient_id": 17052897890,
  • "status": "done",
  • "scheduled_start_at": "2017-05-31 09:17:03",
  • "scheduled_end_at": "2017-05-31 10:47:03",
  • "scheduled_duration": 30,
  • "annotations": "Retorno marcado para verificar melhora do paciente",
  • "patient_uuid": "498124ed-53d5-46eb-89c9-2b1e6a6191a5",
  • "allow_overlap": false,
  • "timezone": "America/Sao_Paulo"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "api_version": "1.0.0"
}

Atendimentos

Tudo sobre seus Atendimentos

Listar os atendimentos da rede de Clínicas/Filiais

Este endpoint retorna uma lista de atendimentos realizados na rede ou na clínica/filial. É importante destacar que a consulta por período está limitada a 31 dias, e o número máximo de resultados por página é de 100 registros. Além disso, esse endpoint não retorna atendimentos que foram cancelados.

Authorizations:
basicAuth
query Parameters
start
string <date-time>

Filtra os atendimentos a partir da data e hora específicadas. O filtro é feito com base no horário local da clínica onde ocorreu o atendimento. O intervalo de busca não pode ser maior que 31 dias.

end
string <date-time>

Filtra os atendimentos até data e hora específicadas. O filtro é feito com base no horário local da clínica onde ocorreu o atendimento. O intervalo de busca não pode ser maior que 31 dias.

patient_id
string
Example: patient_id=12345678910 ou 6b1b7d5e-22c9-435c-b43b-422acf5387db

Filtra os atendimentos de um paciente, por meio de CPF ou UUID

pharmacist_id
string
Example: pharmacist_id=12345678910 ou 6b1b7d5e-22c9-435c-b43b-422acf5387db

Filtra os atendimentos de um farmacêutico, por meio de CPF ou UUID

clinic_id
string
Example: clinic_id=12345678000123 ou 6b1b7d5e-22c9-435c-b43b-422acf5387db

Filtra os atendimentos de uma clínica, por meio de CNPJ ou UUID

limit
integer

Limita a quantidade de resultados por requisição. O limite não pode ser maior que 100.

page
integer

Determina a conjunto de resultados

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "pagination": {
    },
  • "api_version": "1.0.0"
}

Consultar um atendimento específico

Este endpoint retorna as informações de um atendimento realizado com base no ID fornecido. As informações do paciente associado ao evento serão retornadas somente se o paciente pertencer à mesma rede do usuário autenticado. Além disso, esse endpoint não retorna atendimentos que foram cancelados.

Authorizations:
basicAuth
path Parameters
id
required
string <UUID>
Example: 6b1b7d5e-22c9-435c-b43b-422acf5387db

Id do Atendimento

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "api_version": "1.0.0"
}

Pacientes

Tudo sobre seus Pacientes

Listar os Pacientes cadastrados na rede

Este endpoint retorna uma lista contendo os dados dos pacientes cadastrados na rede de farmácias. As informações detalhadas de cada paciente, como nome, CPF, data de nascimento e outros dados relevantes, são incluídas na lista. Importante ressaltar que, de acordo com o artigo 15 da LGPD (Lei Geral de Proteção de Dados), pacientes que foram inativados terão seus dados exibidos de forma anonimizada.

Authorizations:
basicAuth
query Parameters
filter
string

Filtro geral, pode ser pelo nome da entidade ou outros atributos

sort
string

Ordena conforme o valor passado, para ordernar de forma decrescente passar o sinal negativo (-) antes do nome do parâmeto. Se for passado o parametro filter esse será desconsiderado

limit
integer

Limita a quantidade de resultados por requisição. O limite não pode ser maior que 100.

page
integer

Determina a conjunto de resultados

responsible_id
string
Example: responsible_id=12345678910 ou 498124ed-53d5-46eb-89c9-2b1e6a6191a5

Busca pacientes pelo ID ou CPF do seu responsável

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "pagination": {
    },
  • "api_version": "1.0.0"
}

Cadastrar um novo Paciente na rede

Cadastra um novo paciente no sistema. Este endpoint permite cadastrar um novo paciente na rede de farmácias. Os dados obrigatórios para o cadastro são Nome (name), Sexo (sex) e Data de Nascimento (birthday). No entanto, para facilitar o início do atendimento imediato dentro do software, é recomendado incluir também os seguintes dados mínimos para pacientes adultos brasileiros: CPF (id), telefone (phone1) e/ou e-mail (email).

Authorizations:
basicAuth
Request Body schema: application/json
id
string (CPF do Paciente.)

Identificador único do paciente, o id é composto pelo CPF, apenas números, sem formatação.

name
required
string (Nome do paciente)

Como o paciente gostaria de ser chamado

has_social_name
boolean

Indica se o paciente opta por usar o nome do registro civil

civil_name
string (Nome do registro civil do paciente)

Nome registrado em documento.

email
string (Email do paciente)

Identificador único que permite localizar um determinado paciente através de um determinado email.

birthday
required
string <date> (Data de aniversário do paciente.)

Usar formato de data internacional - YYYY-MM-DD.

sex
required
string (O sexo do paciente.)
Enum: "male" "female"
health_plan_id
string (Identificador do plano de saúde do paciente)
health_plan_name
string (Nome do plano de saúde do paciente)
health_plan_document
string (CNPJ do plano de saúde do paciente)
has_national_health
boolean (Se o paciente tem SUS)
has_particular
boolean (Se o paciente faz por atendimento particular)
phone1
string (Número do telefone principal do contato ou responsável)
phone2
string (Número do telefone secundário do contato ou responsável)
mother_name
string (Nome da Mãe)
skin_color
string (Raça/Cor da Pele)
Enum: "white" "black" "brown" "indigenous" "asian" "other" "undeclared"
Array of objects (Phone)
Array of objects (TagsCreation)
Array of objects (PatientContactCreation)
Array of objects (AddressCreation)

Responses

Request samples

Content type
application/json
{
  • "id": 17052897890,
  • "name": "Johnny",
  • "has_social_name": true,
  • "civil_name": "John Doe",
  • "email": "john_doe@example.com",
  • "birthday": "1999-12-31",
  • "sex": "male",
  • "health_plan_id": "string",
  • "health_plan_name": "string",
  • "health_plan_document": "string",
  • "has_national_health": true,
  • "has_particular": true,
  • "phone1": "string",
  • "phone2": "string",
  • "mother_name": "string",
  • "skin_color": "white",
  • "phones": [
    ],
  • "tags": [
    ],
  • "contacts": [
    ],
  • "addresses": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "api_version": "1.0.0"
}

Consultar um Paciente específico cadastrado

Este endpoint permite obter informações detalhadas de um paciente específico da rede de farmácias, utilizando o ID (CPF) ou UUID como parâmetro. Importante ressaltar que, de acordo com o artigo 15 da LGPD (Lei Geral de Proteção de Dados), pacientes inativados terão seus dados exibidos de forma anonimizada.

Authorizations:
basicAuth
path Parameters
id
required
string
Example: 17052897890 ou 498124ed-53d5-46eb-89c9-2b1e6a6191a5

Id (CPF) ou UUID do Paciente

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "api_version": "1.0.0"
}

Atualizar dados de um Paciente ativo cadastrado

Este endpoint permite atualizar as informações de um paciente existente na rede de farmácias, utilizando o ID (CPF) ou UUID como parâmetro. Importante ressaltar que, de acordo com o artigo 15 da LGPD (Lei Geral de Proteção de Dados), pacientes inativados terão seus dados exibidos de forma anonimizada e, por consequência, não podem ser editados através desse endpoint.

Authorizations:
basicAuth
path Parameters
id
required
string
Example: 17052897890 ou 498124ed-53d5-46eb-89c9-2b1e6a6191a5

Id (CPF) ou UUID do Paciente

Request Body schema: application/json
name
string (Nome do paciente)

Como o paciente gostaria de ser chamado.

has_social_name
boolean

Indica se o paciente opta por usar o nome do registro civil

civil_name
string (Nome do registro civil do paciente)

Nome registrado em documento.

email
string (Email do paciente)

Identificador único que permite localizar um determinado paciente através de um determinado email.

birthday
string <date> (Data de aniversário do paciente.)

Usar formato de data internacional - YYYY-MM-DD.

sex
string (O sexo do paciente.)
Enum: "male" "female"
health_plan_id
string (Identificador do plano de saúde do paciente)
health_plan_name
string (Nome do plano de saúde do paciente)
health_plan_document
string (CNPJ do plano de saúde do paciente)
has_national_health
boolean (Se o paciente tem SUS)
has_particular
boolean (Se o paciente faz por atendimento particular)
phone1
string (Número do telefone principal do contato ou responsável)
phone2
string (Número do telefone secundário do contato ou responsável)
mother_name
string (Nome da Mãe)
skin_color
string (Raça/Cor da Pele)
Enum: "white" "black" "brown" "indigenous" "asian" "other" "undeclared"
Array of objects (Phone)
Array of objects (TagsCreation)
Array of objects (PatientContactCreation)
Array of objects (AddressCreation)

Responses

Request samples

Content type
application/json
{
  • "name": "Johnny",
  • "has_social_name": true,
  • "civil_name": "John Doe",
  • "email": "john_doe@example.com",
  • "birthday": "1999-12-31",
  • "sex": "male",
  • "health_plan_id": "string",
  • "health_plan_name": "string",
  • "health_plan_document": "string",
  • "has_national_health": true,
  • "has_particular": true,
  • "phone1": "string",
  • "phone2": "string",
  • "mother_name": "string",
  • "skin_color": "white",
  • "phones": [
    ],
  • "tags": [
    ],
  • "contacts": [
    ],
  • "addresses": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "api_version": "1.0.0"
}

Consultar um Paciente inativo específico cadastrado

Este endpoint permite obter informações detalhadas de um paciente inativo específico da rede de farmácias e que possua um ou mais cadastros, utilizando o ID (CPF) ou UUID como parâmetro. Importante ressaltar que, de acordo com o artigo 15 da LGPD (Lei Geral de Proteção de Dados), pacientes inativados terão seus dados exibidos de forma anonimizada.

Authorizations:
basicAuth
path Parameters
id
required
string
Example: 17052897890 ou 498124ed-53d5-46eb-89c9-2b1e6a6191a5

Id (CPF) ou UUID do Paciente

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "api_version": "1.0.0"
}

Inativa um Paciente

Este endpoint permite inativar um paciente na rede, seguindo as diretrizes estabelecidas pelo artigo 15 da LGPD (Lei Geral de Proteção de Dados). A inativação de um paciente envolve a suspensão do acesso às suas informações pessoais. Essa ação não pode ser desfeita.

Authorizations:
basicAuth
path Parameters
id
required
string
Example: 17052897890 ou 498124ed-53d5-46eb-89c9-2b1e6a6191a5

Id (CPF) ou UUID do Paciente

Request Body schema: application/json
reason
string

Motivo da inativação, caso haja

Responses

Request samples

Content type
application/json
{
  • "reason": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "api_version": "1.0.0"
}

Listar os Agendamentos de um Paciente

Este endpoint retorna a lista de agendamentos de um paciente específico com base em seu ID (UUID) ou CPF (ID) Se os parâmetros start e end não forem definidos, serão listados agendamentos entre a data corrente e o dia seguinte.

Authorizations:
basicAuth
path Parameters
patient_id
required
string
Example: 17052897890 ou 498124ed-53d5-46eb-89c9-2b1e6a6191a5

Id (CPF) ou UUID do Paciente

query Parameters
start
string <date-time>

Data de início do filtro

end
string <date-time>

Data de fim do filtro

sort
string

Ordena conforme o valor passado, para ordernar de forma decrescente passar o sinal negativo (-) antes do nome do parâmeto. Se for passado o parametro filter esse será desconsiderado

limit
integer

Limita a quantidade de resultados por requisição. O limite não pode ser maior que 100.

page
integer

Determina a conjunto de resultados

clinic
string
Example: clinic=09390160000169

filtra os eventos pelo CNPJ da farmácia

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "api_version": "1.0.0",
  • "pagination": {
    }
}

Agendar um horário para um Paciente

Este endpoint permite criar um novo evento (agendamento) associado a um paciente com base no seu ID (UUID) ou CPF (ID). Os agendamentos realizados através da API Clinicarx permitem a sobreposição com bloqueios de agenda que possam existir na clínica/filial.

Authorizations:
basicAuth
path Parameters
patient_id
required
string
Example: 17052897890 ou 498124ed-53d5-46eb-89c9-2b1e6a6191a5

Id (CPF) ou UUID do Paciente

query Parameters
allow_overlap
boolean
Example: allow_overlap=false

Permite sobreposição de agenda

Request Body schema: application/json
clinic_id
required
string (CNPJ da farmácia do agendamento)

Identificador único da farmácia, o id é composto pelo CNPJ, apenas números, sem formatação.

clinic_uuid
string <uuid> (UUID da farmácia do agendamento)
patient_cpf
string (CPF do paciente que agendou a consulta)

Identificador único do paciente, o id é composto pelo CPF, apenas números, sem formatação.

status
string (Status do evento)
Enum: "open" "done" "cancelled" "processing" "patient_missing"

em qual estado o evento está, ou seja, se ele ainda não foi realizado, se foi cancelado, se está sendo realizado, se já foi realizado ou se o paciente faltou

scheduled_start_at
required
string <date-time> (data e hora que o evento tem previsão de começar com o Fuso-Horário UTC)
scheduled_end_at
required
string <date-time> (data e hora que o evento tem previsão de acabar com o Fuso-Horário UTC)
scheduled_duration
integer (Duração prevista do evento)
annotations
string (Observações do agendamento)
allow_overlap
boolean (Quando permite que há mais de um agendamento do mesmo horário)
timezone
string (Fuso-horário do local do agendamento)

Responses

Request samples

Content type
application/json
{
  • "clinic_id": "09390160000169",
  • "clinic_uuid": "498124ed-53d5-46eb-89c9-2b1e6a6191a5",
  • "patient_cpf": 17052897890,
  • "status": "done",
  • "scheduled_start_at": "2017-05-31 09:17:03",
  • "scheduled_end_at": "2017-05-31 10:47:03",
  • "scheduled_duration": 30,
  • "annotations": "Retorno marcado para verificar melhora do paciente",
  • "allow_overlap": false,
  • "timezone": "America/Sao_Paulo"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "api_version": "1.0.0"
}

Consultar um agendamento específico de um Paciente

Este endpoint retorna as informações de um evento agendado com base no ID fornecido. As informações do paciente associado ao evento serão retornadas somente se o paciente pertencer à mesma rede do usuário autenticado.

Authorizations:
basicAuth
path Parameters
patient_id
required
string
Example: 17052897890 ou 498124ed-53d5-46eb-89c9-2b1e6a6191a5

Id (CPF) ou UUID do Paciente

id
required
string <uuid>
Example: 8a492139-c5be-4cf8-bfc0-7ab12f8460b5

Id do Agendamento

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "api_version": "1.0.0"
}

Atualizar dados do agendamento de um paciente

Este endpoint permite atualizar os dados de um agendamento existente ou remarcar um agendamento para um paciente.

Authorizations:
basicAuth
path Parameters
patient_id
required
string
Example: 17052897890 ou 498124ed-53d5-46eb-89c9-2b1e6a6191a5

Id (CPF) ou UUID do Paciente

id
required
string <uuid>
Example: 8a492139-c5be-4cf8-bfc0-7ab12f8460b5

Id do Agendamento

Request Body schema: application/json
clinic_id
required
string (CNPJ da farmácia do agendamento)

Identificador único da farmácia, o id é composto pelo CNPJ, apenas números, sem formatação.

clinic_uuid
string <uuid> (UUID da farmácia do agendamento)
patient_cpf
string (CPF do paciente que agendou a consulta)

Identificador único do paciente, o id é composto pelo CPF, apenas números, sem formatação.

patient_uuid
string <uuid> (UUID do paciente que agendou a consulta)
status
string (Status do evento)
Enum: "open" "done" "cancelled" "processing" "patient_missing"

em qual estado o evento está, ou seja, se ele ainda não foi realizado, se foi cancelado, se está sendo realizado, se já foi realizado ou se o paciente faltou

scheduled_start_at
required
string <date-time> (data e hora que o evento tem previsão de começar com o Fuso-Horário UTC)
scheduled_end_at
required
string <date-time> (data e hora que o evento tem previsão de acabar com o Fuso-Horário UTC)
scheduled_duration
integer (Duração prevista do evento)
annotations
string (Observações do agendamento)
allow_overlap
boolean (Quando permite que há mais de um agendamento do mesmo horário)

Responses

Request samples

Content type
application/json
{
  • "clinic_id": "09390160000169",
  • "clinic_uuid": "498124ed-53d5-46eb-89c9-2b1e6a6191a5",
  • "patient_cpf": 17052897890,
  • "patient_uuid": "498124ed-53d5-46eb-89c9-2b1e6a6191a5",
  • "status": "done",
  • "scheduled_start_at": "2017-05-31 09:17:03",
  • "scheduled_end_at": "2017-05-31 10:47:03",
  • "scheduled_duration": 30,
  • "annotations": "Retorno marcado para verificar melhora do paciente",
  • "allow_overlap": false
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "api_version": "1.0.0"
}

Cancelar/Excluir um agendamento

Este endpoint permite cancelar um agendamento realizado para um paciente com base no ID do evento fornecido. Ao cancelar o agendamento, ele é removido da agenda da clínica/filial. Para agendamentos cancelados pela API, não são enviados e-mails aos pacientes.

Authorizations:
basicAuth
path Parameters
patient_id
required
string
Example: 17052897890 ou 498124ed-53d5-46eb-89c9-2b1e6a6191a5

Id (CPF) ou UUID do Paciente

id
required
string <uuid>
Example: 8a492139-c5be-4cf8-bfc0-7ab12f8460b5

Id do Agendamento

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [ ],
  • "api_version": "1.3.3"
}

Clínicas

Tudo sobre suas Clínicas

Listar as Clínicas/Filiais da rede

Este endpoint retorna uma lista com informações detalhadas das clínicas/filiais da rede, abrangendo tanto as clínicas/filiais ativas quanto as clínicas/filiais inativas.

Authorizations:
basicAuth
query Parameters
allow_online_appointment
boolean
Example: allow_online_appointment=true

Se a clínica habilitou ou não agendamento web

filter
string

Filtro geral, pode ser pelo nome da entidade ou outros atributos

sort
string

Ordena conforme o valor passado, para ordernar de forma decrescente passar o sinal negativo (-) antes do nome do parâmeto. Se for passado o parametro filter esse será desconsiderado

limit
integer

Limita a quantidade de resultados por requisição. O limite não pode ser maior que 100.

page
integer

Determina a conjunto de resultados

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "pagination": {
    }
}

Cadastrar uma nova Clínica/Filial na rede

Este endpoint permite cadastrar uma nova clínica/filial na rede. Para garantir o sucesso no cadastro, é essencial observar os campos obrigatórios necessários para o preenchimento. O formato correto de envio de dados também é fundamental para que o cadastro seja realizado com sucesso.

Authorizations:
basicAuth
Request Body schema: application/json
id
string (CNPJ da farmácia)

Identificador único da farmácia, o id é composto do CNPJ, apenas números, sem formatação

name
string (Nome da Empresa)

Nome comercial da farmácia

identification
string (Identificação da Farmácia)

Identificação interna da loja

active
boolean (Status da Farmácia)

Indica se a farmácia está ativa ou não

cnes
string (Código CNES da farmácia)

Registro no Cadastro Nacional de Estabelecimentos de Saúde da farmácia

total_area
number (Área Total da Farmácia)

Área total da farmácia em m²

service_room_area
number (Área da Sala de Serviços)

Área usada como sala de serviços farmacêuticos, ou consultório, da farmácia em m²

timezone
string (Fuso-Horário da Farmácia)

Fuso-Horário que a farmácia usa cadastrado no Clinicarx. Os valores desse campo obedecem os valores de timezone do PHP https://secure.php.net/manual/pt_BR/timezones.america.php, a lista de fuso-horários do Brasil pode ser obtida no exemplo https://secure.php.net/manual/pt_BR/timezones.america.php#118862

allow_online_appointment
boolean (Define se a clínica ativou ou não o Agendamento Web)
object (Dias e horários de expediente)

JSON com os dias da semana e horários de início e fim de expediente. A estrutura consistem eum array de objetos (ou null), onde o índice 0 é domingo e o índice 6, sábado. Índices com valor null representam dia sem expediente. O objeto com os horários possui os índices start e end, com horário no formato `hh:mm``, no horário local da clínica

room_number
integer (Número de salas de atendimento)
service_time_limit
integer (Duração padrão do atendimento, em minutos)
break_time_start
string (Horário de início do intervalo, no horário local da clínica, caso a clínica faça pausa para almoço, por exemplo)
break_time_end
string (Horário de fim do intervalo, no horário local da clínica, caso a clínica faça pausa para almoço, por exemplo)
online_appointment_antecedence_time
number (Tempo de antecedência, em horas, configurado para a clínica receber agendamentos)
Array of objects (ClinicPhoneCreation)
Array of objects (ClinicAddressCreation)

Responses

Request samples

Content type
application/json
{
  • "id": "09390160000169",
  • "name": "Drogaria Exemplo",
  • "identification": "Loja 01",
  • "active": true,
  • "cnes": "9999999",
  • "total_area": 250,
  • "service_room_area": 7.5,
  • "timezone": "America/Sao_Paulo",
  • "allow_online_appointment": true,
  • "service_hours": [
    ],
  • "room_number": 0,
  • "service_time_limit": 0,
  • "break_time_start": "12:00",
  • "break_time_end": "13:00",
  • "online_appointment_antecedence_time": 48,
  • "phones": [
    ],
  • "addresses": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "api_version": "1.0.0"
}

Consultar uma Clínica/Filial específica

Este endpoint retorna as informações detalhadas de uma clínica/filial com base no ID fornecido. As informações da clínica/filial serão retornadas somente se ela pertencer à mesma rede do usuário autenticado.

Authorizations:
basicAuth
path Parameters
id
required
string
Example: 09390160000169 ou 498124ed-53d5-46eb-89c9-2b1e6a6191a5

Id (CNPJ) ou UUID da Farmácia

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Atualizar os dados de uma Clínica/Filial

Este endpoint permite atualizar uma clínica ou filial existente na rede de farmácias por meio do ID ou CNPJ fornecido. Além disso, este endpoint oferece a possibilidade de ativar ou inativar a clínica/filial e habilitar/desabilitar serviços online, bem como outras alterações importantes.

Authorizations:
basicAuth
path Parameters
id
required
string
Example: 09390160000169 ou 498124ed-53d5-46eb-89c9-2b1e6a6191a5

Id (CNPJ) ou UUID da Farmácia

Request Body schema: application/json
name
string (Nome da Empresa)

Nome comercial da farmácia

identification
string (Identificação da Farmácia)

Identificação interna da loja

active
boolean (Status da Farmácia)

Indica se a farmácia está ativa ou não

cnes
string (Código CNES da farmácia)

Registro no Cadastro Nacional de Estabelecimentos de Saúde da farmácia

total_area
number (Área Total da Farmácia)

Área total da farmácia em m²

service_room_area
number (Área da Sala de Serviços)

Área usada como sala de serviços farmacêuticos, ou consultório, da farmácia em m²

timezone
string (Fuso-Horário da Farmácia)

Fuso-Horário que a farmácia usa cadastrado no Clinicarx. Os valores desse campo obedecem os valores de timezone do PHP https://secure.php.net/manual/pt_BR/timezones.america.php, a lista de fuso-horários do Brasil pode ser obtida no exemplo https://secure.php.net/manual/pt_BR/timezones.america.php#118862

allow_online_appointment
boolean (Define se a clínica ativou ou não o Agendamento Web)
object (Dias e horários de expediente)

JSON com os dias da semana e horários de início e fim de expediente. A estrutura consistem eum array de objetos (ou null), onde o índice 0 é domingo e o índice 6, sábado. Índices com valor null representam dia sem expediente. O objeto com os horários possui os índices start e end, com horário no formato `hh:mm``, no horário local da clínica

room_number
integer (Número de salas de atendimento)
service_time_limit
integer (Duração padrão do atendimento, em minutos)
break_time_start
string (Horário de início do intervalo, no horário local da clínica, caso a clínica faça pausa para almoço, por exemplo)
break_time_end
string (Horário de fim do intervalo, no horário local da clínica, caso a clínica faça pausa para almoço, por exemplo)
online_appointment_antecedence_time
number (Tempo de antecedência, em horas, configurado para a clínica receber agendamentos)
Array of objects (ClinicPhoneCreation)
Array of objects (ClinicAddressCreation)

Responses

Request samples

Content type
application/json
{
  • "name": "Drogaria Exemplo",
  • "identification": "Loja 01",
  • "active": true,
  • "cnes": "9999999",
  • "total_area": 250,
  • "service_room_area": 7.5,
  • "timezone": "America/Sao_Paulo",
  • "allow_online_appointment": true,
  • "service_hours": [
    ],
  • "room_number": 0,
  • "service_time_limit": 0,
  • "break_time_start": "12:00",
  • "break_time_end": "13:00",
  • "online_appointment_antecedence_time": 48,
  • "phones": [
    ],
  • "addresses": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [ ],
  • "api_version": "1.0.0"
}

Listar os agendamentos de uma Clínica ou Filial

Este endpoint retorna a lista de agendamentos associados a uma clínica/filial específica com base no ID fornecido.

Authorizations:
basicAuth
path Parameters
clinic_id
required
string
Example: 09390160000169 ou 498124ed-53d5-46eb-89c9-2b1e6a6191a5

Id (CNPJ) ou UUID da Farmácia

query Parameters
start
string <date-time>

Data de início do filtro

end
string <date-time>

Data de fim do filtro

sort
string

Ordena conforme o valor passado, para ordernar de forma decrescente passar o sinal negativo (-) antes do nome do parâmeto. Se for passado o parametro filter esse será desconsiderado

limit
integer

Limita a quantidade de resultados por requisição. O limite não pode ser maior que 100.

page
integer

Determina a conjunto de resultados

patient
string
Example: patient=17052897890

filtra os eventos pelo CNPJ da farmácia

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "pagination": {
    }
}

Fazer o agendamento de um horário em uma Clínica ou Filial

Este endpoint permite criar um novo evento (agendamento) na agenda de uma clínica/filial específica. Os agendamentos realizados através da API Clinicarx permitem a sobreposição com bloqueios de agenda que possam existir na clínica/filial.

Authorizations:
basicAuth
path Parameters
clinic_id
required
string
Example: 09390160000169 ou 498124ed-53d5-46eb-89c9-2b1e6a6191a5

Id (CNPJ) ou UUID da Farmácia

Request Body schema: application/json
patient_id
required
string (CPF do paciente que agendou a consulta)

Identificador único do paciente, o id é composto pelo CPF, apenas números, sem formatação.

status
required
string (Status do evento)
Enum: "open" "done" "cancelled" "processing" "patient_missing"

em qual estado o evento está, ou seja, se ele ainda não foi realizado, se foi cancelado, se está sendo realizado, se já foi realizado ou se o paciente faltou

scheduled_start_at
required
string <date-time> (data e hora que o evento tem previsão de começar com o Fuso-Horário UTC)
scheduled_end_at
required
string <date-time> (data e hora que o evento tem previsão de acabar com o Fuso-Horário UTC)
scheduled_duration
integer (Duração prevista do evento)
annotations
string (Observações do agendamento)
patient_uuid
string <uuid> (UUID do paciente que agendou a consulta)
allow_overlap
boolean (Permite o agendamento de mais de um serviço ao mesmo tempo)
timezone
string (Fuso-horário do local do agendamento)

Responses

Request samples

Content type
application/json
{
  • "patient_id": 17052897890,
  • "status": "done",
  • "scheduled_start_at": "2017-05-31 09:17:03",
  • "scheduled_end_at": "2017-05-31 10:47:03",
  • "scheduled_duration": 30,
  • "annotations": "Retorno marcado para verificar melhora do paciente",
  • "patient_uuid": "498124ed-53d5-46eb-89c9-2b1e6a6191a5",
  • "allow_overlap": false,
  • "timezone": "America/Sao_Paulo"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "api_version": "1.0.0"
}

Consultar um agendamento específico de uma Clínica ou Filial

Este endpoint retorna as informações de um evento agendado com base no ID fornecido. As informações do paciente associado ao evento serão retornadas somente se o paciente pertencer à mesma rede do usuário autenticado.

Authorizations:
basicAuth
path Parameters
clinic_id
required
string
Example: 09390160000169 ou 498124ed-53d5-46eb-89c9-2b1e6a6191a5

Id (CNPJ) ou UUID da Farmácia

id
required
string <uuid>
Example: 8a492139-c5be-4cf8-bfc0-7ab12f8460b5

Id do Agendamento

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "api_version": "1.0.0"
}

Atualizar dados de um agendamento em uma Clínica ou Filial

Este endpoint permite atualizar os dados de um agendamento existente ou remarcar um agendamento em uma clínica/filial específica.

Authorizations:
basicAuth
path Parameters
clinic_id
required
string
Example: 09390160000169 ou 498124ed-53d5-46eb-89c9-2b1e6a6191a5

Id (CNPJ) ou UUID da Farmácia

id
required
string <uuid>
Example: 8a492139-c5be-4cf8-bfc0-7ab12f8460b5

Id do Agendamento

Request Body schema: application/json
patient_id
required
string (CPF do paciente que agendou a consulta)

Identificador único do paciente, o id é composto pelo CPF, apenas números, sem formatação.

status
required
string (Status do evento)
Enum: "open" "done" "cancelled" "processing" "patient_missing"

em qual estado o evento está, ou seja, se ele ainda não foi realizado, se foi cancelado, se está sendo realizado, se já foi realizado ou se o paciente faltou

scheduled_start_at
required
string <date-time> (data e hora que o evento tem previsão de começar com o Fuso-Horário UTC)
scheduled_end_at
required
string <date-time> (data e hora que o evento tem previsão de acabar com o Fuso-Horário UTC)
scheduled_duration
integer (Duração prevista do evento)
annotations
string (Observações do agendamento)
patient_uuid
string <uuid> (UUID do paciente que agendou a consulta)
allow_overlap
boolean (Permite o agendamento de mais de um serviço ao mesmo tempo)
timezone
string (Fuso-horário do local do agendamento)

Responses

Request samples

Content type
application/json
{
  • "patient_id": 17052897890,
  • "status": "done",
  • "scheduled_start_at": "2017-05-31 09:17:03",
  • "scheduled_end_at": "2017-05-31 10:47:03",
  • "scheduled_duration": 30,
  • "annotations": "Retorno marcado para verificar melhora do paciente",
  • "patient_uuid": "498124ed-53d5-46eb-89c9-2b1e6a6191a5",
  • "allow_overlap": false,
  • "timezone": "America/Sao_Paulo"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "api_version": "1.0.0"
}

Fazer a criação de um bloqueio na agenda de uma Clínica ou Filial

Este endpoint permite criar um novo bloqueio na agenda de uma clínica/filial específica. Os bloqueios realizados através da API Clinicarx permitem a sobreposição na agenda que possam existir na clínica/filial.

Authorizations:
basicAuth
path Parameters
clinic_id
required
string
Example: 09390160000169 ou 498124ed-53d5-46eb-89c9-2b1e6a6191a5

Id (CNPJ) ou UUID da Farmácia

Request Body schema: application/json
title
required
string (Título do bloqueio na agenda.)
repeat_frequency
string (Frequência de repetição do bloqueio)
Enum: "daily" "weekly" "monthly" "yearly"
start_at
required
string <date-time> (data e hora que o bloqueio começa com o Fuso-Horário UTC)
end_at
required
string <date-time> (data e hora que o bloqueio acaba com o Fuso-Horário UTC)

Responses

Request samples

Content type
application/json
{
  • "title": "Bloqueio Semanal",
  • "repeat_frequency": "weekly",
  • "start_at": "2017-05-31 09:17:03",
  • "end_at": "2017-05-31 10:47:03"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "api_version": "1.0.0"
}

Atualizar dados de um bloqueio existente na agenda de uma Clínica ou Filial

Este endpoint permite atualizar os dados de um bloqueio existente de uma clínica/filial específica.

Authorizations:
basicAuth
path Parameters
clinic_id
required
string
Example: 09390160000169 ou 498124ed-53d5-46eb-89c9-2b1e6a6191a5

Id (CNPJ) ou UUID da Farmácia

id
required
string <uuid>
Example: 8a492139-c5be-4cf8-bfc0-7ab12f8460b5

Id do Bloqueio

Request Body schema: application/json
title
string (Título do bloqueio na agenda.)
repeat_frequency
string (Frequência de repetição do bloqueio)
Enum: "daily" "weekly" "monthly" "yearly"
start_at
required
string <date-time> (data e hora que o bloqueio começa com o Fuso-Horário UTC)
end_at
required
string <date-time> (data e hora que o bloqueio acaba com o Fuso-Horário UTC)

Responses

Request samples

Content type
application/json
{
  • "title": "Bloqueio Semanal",
  • "repeat_frequency": "weekly",
  • "start_at": "2017-05-31 09:17:03",
  • "end_at": "2017-05-31 10:47:03"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "api_version": "1.0.0"
}

Excluir um bloqueio de agenda

Este endpoint permite remover um bloqueio de agenda de uma clínica com base no ID do bloqueio fornecido.

Authorizations:
basicAuth
path Parameters
clinic_id
required
string
Example: 09390160000169 ou 498124ed-53d5-46eb-89c9-2b1e6a6191a5

Id (CNPJ) ou UUID da Farmácia

id
required
string <uuid>
Example: 8a492139-c5be-4cf8-bfc0-7ab12f8460b5

Id do Bloqueio

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "api_version": "1.0.0"
}

Usuários

Tudo sobre seus Usuários

Listar usuários da rede

Este endpoint retorna uma lista contendo os usuários da rede de farmácias, abrangendo tanto os usuários ativos quanto os inativos. A lista apresenta informações detalhadas sobre cada usuário.

Authorizations:
basicAuth
query Parameters
email
string
Example: email=email@example.org

Email do farmacêutico

document
string
Example: document=55160198857

CPF do farmacêutico (sem formatação)

active
boolean
Example: active=true

Status do farmacêutico

limit
integer

Limita a quantidade de resultados por requisição. O limite não pode ser maior que 100.

page
integer

Determina a conjunto de resultados

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "api_version": "1.0.0",
  • "pagination": {
    }
}

Alterar status de um usuário da rede

Este endpoint permite alterar o status de um usuário na rede entre ativo e inativo.

Authorizations:
basicAuth
path Parameters
id
required
string
Example: 9390160097

CPF do usuário

Request Body schema: application/json
active
boolean

Status do usuário

Responses

Request samples

Content type
application/json
{
  • "active": true
}

Response samples

Content type
application/json
{
  • "success": true,
  • "api_version": "1.0.0",
  • "data": {
    }
}

Serviços

Tudo sobre seus Serviços

Listar Serviços cadastrados na rede

Este endpoint retorna uma lista contendo os serviços da rede de farmácias, abrangendo tanto os serviços ativos quanto os inativos. A lista apresenta informações detalhadas sobre cada serviço oferecido.

Authorizations:
basicAuth
query Parameters
clinic_id
string
Example: clinic_id=09390160000169 ou 9cfbd61f-0601-45b0-8d2b-22692a84eb1a

Id da Farmácia (UUID ou CNPJ)

filter
string

Filtro geral, pode ser pelo nome da entidade ou outros atributos

sort
string

Ordena conforme o valor passado, para ordernar de forma decrescente passar o sinal negativo (-) antes do nome do parâmeto. Se for passado o parametro filter esse será desconsiderado

limit
integer

Limita a quantidade de resultados por requisição. O limite não pode ser maior que 100.

page
integer

Determina a conjunto de resultados

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "pagination": {
    },
  • "api_version": "1.0.0"
}

Cadastrar um novo Serviço na rede

Este endpoint permite cadastrar um novo serviço na rede de farmácias.

Authorizations:
basicAuth
Request Body schema: application/json
code
string (Código do serviço.)
name
required
string (Nome do serviço.)
description
required
string (Descrição do serviço.)
active
boolean (Define se o serviço está ativo ou inativo)
price
required
number (Preço do serviço.)
cost_percent
number (Percentual de custo do serviço.)
commission_percent
number (Percentual de comissão do serviço.)

Responses

Request samples

Content type
application/json
{
  • "code": "845",
  • "name": "CHECKUP GLICEMIA CAPILAR",
  • "description": "<p>Teste casual de glicemia capilar com glicosímetro comum, tanto para diabéticos como pacientes sem diagnóstico prévio. Acompanha resultado impressos com régua da glicemia</p>",
  • "active": true,
  • "price": 6.51,
  • "cost_percent": 1.23,
  • "commission_percent": 0
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "api_version": "1.3.3"
}

Consultar um Serviço específico

Este endpoint retorna as informações detalhadas de um específico com base no ID fornecido.

Authorizations:
basicAuth
path Parameters
id
required
string <UUID>
Example: 6b1b7d5e-22c9-435c-b43b-422acf5387db

Id do serviço

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Atualizar os dados de um Serviço cadastrado

Este endpoint permite atualizar um serviço existente na rede. Além disso, este endpoint oferece a possibilidade de ativar ou inativar p serviço, bem como outras alterações importantes.

Authorizations:
basicAuth
path Parameters
id
required
string <UUID>
Example: 6b1b7d5e-22c9-435c-b43b-422acf5387db

Id do serviço

Request Body schema: application/json
code
string (Código do serviço.)
name
required
string (Nome do serviço.)
description
required
string (Descrição do serviço.)
service_group
string (Descrição sobre a qual grupo pertence o serviço.)
active
boolean (Define se o serviço está ativo ou inativo)
price
required
number (Preço do serviço.)
cost_percent
number (Percentual de custo do serviço.)
commission_percent
number (Percentual de comissão do serviço.)

Responses

Request samples

Content type
application/json
{
  • "code": "845",
  • "name": "CHECKUP GLICEMIA CAPILAR",
  • "description": "<p>Teste casual de glicemia capilar com glicosímetro comum, tanto para diabéticos como pacientes sem diagnóstico prévio. Acompanha resultado impressos com régua da glicemia</p>",
  • "service_group": "Aplicação de injeção",
  • "active": true,
  • "price": 6.51,
  • "cost_percent": 1.23,
  • "commission_percent": 0
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "api_version": "1.0.0"
}