Saltar para o conteúdo principal
Usa este guia para criar um perfil de paciente e atribuí-lo ao teu grupo de perfis. Os perfis são o ponto de partida para agendar marcações e iniciar pedidos laboratoriais.
1

Obter a referência do teu grupo de perfis

Cada perfil tem de ser atribuído a um grupo de perfis que pertença à tua conta de parceiro. O campo profile_group aceita o UUID imutável do grupo ou o seu slug legível — o UUID é preferível porque nunca muda e mantém-se válido se o slug for renomeado.Se não souberes a referência do teu grupo de perfis, contacta a Aniva para a obter. Não podes criar perfis sem uma referência válida.
2

Criar o perfil

Envia um pedido POST para /api/v1/profiles com os dados demográficos do paciente.
first_name e last_name são ambos obrigatórios. Aceitam apenas letras do alfabeto latino (incluindo letras acentuadas como ü), espaços, hífenes e apóstrofos. Translitera nomes noutros alfabetos antes de os submeteres.
Se omitires email, a Aniva gera automaticamente um endereço de email provisório para o perfil. Podes atualizá-lo mais tarde com um pedido PATCH.
O campo language controla o idioma que a Aniva usa ao comunicar com o paciente — por exemplo, lembretes de marcação e notificações de resultados. Define-o de acordo com o idioma preferido do paciente. Criar perfil lista os valores suportados. O valor predefinido é en.
Um pedido bem-sucedido devolve 201 Created com o novo objeto de perfil:
Guarda o id — vais precisar dele para agendar marcações e atualizar o perfil.
3

Atualizar o perfil (opcional)

Usa PATCH /api/v1/profiles/{id} para atualizar quaisquer campos do perfil após a criação. Todos os campos são opcionais — inclui apenas os campos que queres alterar.O exemplo seguinte adiciona um número de telefone e a altura:
Um pedido bem-sucedido devolve 200 OK com o objeto de perfil atualizado completo.

Tratamento de erros