telemed-support

Especialidades

As especialidades são utilizadas para atribuir à uma fila, isso permite que o médico identifique que o paciente está retornando de uma outra consulta da mesma especialidade. É possível também aplicar regras de cobrança quando se quer atribuir funções de consulta particular.

Listar especialidades

A listagem poderá ser filtrada por meio de params/query:

Campo/Propriedade	Tipagem	Padrão/Formato	Descrição	Obrigatório
offset	Integer		offset/início de referência para a busca	❌
limit	Integer		limite de resultados, não é possível ser maior que 100	❌
title	String		Título da especialidade	❌
sorting	String	“asc” ou “desc”	Ordenar resultados por crescente ou decrescente, padrão: “title”	❌
orderBy	String		Ordenar por campo específico, padrão: “title”	❌

Exemplo:

GET /api/specialties HTTP/2
Host: telemedicina.example.com
Accept: application/json
accesskey: sua-chave-de-acesso

{
    "count": 1,
    "rows": [
        {
            "id": "ZIk0Pvk7UbkI2wopVUuc",
            "noChargesToReturnQuantity": 20,
            "title": "Cardiologia",
            "noChargesToReturnDays": 30
        },
    ]
}

Listar especialidade por id

A listagem poderá ser feita por meio de um id na params/query:

Exemplo:

GET /api/specialties/:id HTTP/2
Host: telemedicina.example.com
Accept: application/json
accesskey: sua-chave-de-acesso

{
    "id": "ZIk0Pvk7UbkI2wopVUuc",
    "noChargesToReturnDays": 30,
    "title": "Cardiologia",
    "noChargesToReturnQuantity": 20
}

Criação de Especialidade

Para cadastrar:

POST /api/specialties HTTP/2
Host: telemedicina.example.com
Content-Type: application/json
accesskey: sua-chave-de-acesso

Campo/Propriedade	Tipagem	Padrão/Formato	Descrição	Obrigatório	Customizável	Campo único
title	String		Título da especialidade	✅	❌	❌
noChargesToReturnDays	Integer		Período de dias que será considerado retorno a partir da última consulta do paciente, se for particular e estiver fora do período haverá cobrança	❌	❌	❌
noChargesToReturnQuantity	Integer		Quantidade de retornos sem cobrança dentro do período	❌	❌	❌

Exemplo de retorno:

{
    "id": "BR7iaTP9yx6jCIUGItI6",
    "createdAt": "2020-11-05T17:56:49.307Z",
    "noChargesToReturnDays": 32,
    "noChargesToReturnQuantity": 5,
    "title": "Ginecologia"
}

Atualização de especialiade

Para atualizar é só seguir as mesmas especificações da criação, porém informando o id na queryString no método PATCH.

PATCH /api/specialties/:id HTTP/2
Host: telemedicina.example.com
Content-Type: application/json
accesskey: sua-chave-de-acesso

Deletar de especialiade

Para deletar, basta informar o id na queryString no método DELETE:

DELETE /api/specialties/:id HTTP/2
Host: telemedicina.example.com
Content-Type: application/json
accesskey: sua-chave-de-acesso