Saltar para o conteúdo principal
POST
Cria um novo perfil de paciente e atribui-o a um grupo de perfis. O perfil guarda dados demográficos usados em marcações e pedidos laboratoriais. Requer o scope create_user. Envia um cabeçalho opcional Idempotency-Key para tornar esta criação segura para repetir — repetir a mesma chave devolve a resposta original em vez de criar outra. Vê Idempotência.

Pedido

Parâmetros do corpo

string
obrigatório
Nome próprio do paciente. Tem de usar caracteres latinos, entre 1 e 100 caracteres.
string
obrigatório
Apelido do paciente. Tem de usar caracteres latinos, entre 1 e 100 caracteres. Os laboratórios rejeitam pedidos para um paciente sem apelido, pelo que não é possível criar um perfil sem um.Três valores estão reservados para gerar dados de teste — consulta Dados de teste da sandbox.
integer
obrigatório
Sexo biológico segundo a norma ISO/IEC 5218. Usa 1 para masculino, 2 para feminino. O laboratório precisa dele para os intervalos de referência, pelo que 0 (desconhecido) devolve 400. Obrigatório, exceto se o teu grupo de perfis permitir que o paciente o introduza na página de ativação do kit. Nesse caso, omite-o. Consulta Deixar o paciente introduzir a data de nascimento e o sexo.
string
obrigatório
Data de nascimento no formato YYYY-MM-DD. Tem de ser no passado e não anterior a 1900. A idade implícita tem de estar entre 16 e 100 anos. Outros valores devolvem 400. Obrigatório, exceto se o teu grupo de perfis permitir que o paciente a introduza na página de ativação do kit. Nesse caso, omite-a.
string
obrigatório
Referência polimórfica (UUID ou slug) para o grupo de perfis ao qual atribuir este perfil. O UUID é o identificador imutável e mantém-se se o slug mudar de nome; o slug continua a ser aceite para integrações de marketing e de parceiros baseadas em identificadores legíveis. O UUID é preferível. O grupo de perfis tem de estar dentro do contexto de acesso da tua chave API. Obrigatório, exceto se enviares o campo obsoleto profile_group_slug.
string
obsoleto
Obsoleto: usa profile_group. Slug do grupo de perfis. Apenas letras minúsculas, dígitos, hífenes e underscores.
string
Endereço de email do perfil. Se for omitido, a Aniva gera automaticamente um endereço de email.Fornecer email também torna a criação segura para novas tentativas: um endereço só pode ter um perfil, pelo que um pedido repetido devolve 409 em vez de um segundo perfil. Os endereços gerados automaticamente são únicos por pedido. Envia email ou uma Idempotency-Key se a tua integração fizer novas tentativas.
string
Número de telefone no formato E.164 (por exemplo, +14155552671).
number
Altura em centímetros.
number
Peso em quilogramas.
string
padrão:"en"
Idioma preferido do perfil: en, bg, ca, cs, da, de, el, es, et, fi, fr, ga, hr, hu, is, it, lb, lt, lv, mt, nl, no, pl, pt, ro, ru, sk, sl, sr, sv, tr ou uk. O valor predefinido é en.
boolean
Indica se este perfil deve receber emails transacionais (programáticos) — confirmações de marcações, avisos de resultados prontos, etc. Substitui a predefinição do grupo de perfis. Distinto da autorização de marketing. Omite para usar a predefinição.
boolean
Indica se este perfil aceita receber emails de marketing (newsletters, novidades de produto). Substitui a predefinição do grupo de perfis. Distinto dos emails transacionais. Omite para usar a predefinição do grupo de perfis. Apenas de escrita: não é devolvido na resposta do perfil.

Dados de teste da sandbox

Todos os caminhos de leitura que vale a pena testar — Listar marcações, Obter resultados, Transferir documento — estão vazios até acontecer uma colheita de sangue real dias depois. Isso torna difícil escrever um teste de integração automatizado. Três valores de last_name estão reservados para resolver isso. Cria um perfil com um deles e a Aniva preenche previamente o estado descrito abaixo antes de responder, para que a tua chamada seguinte já o veja: A correspondência não distingue maiúsculas de minúsculas. Todos os outros campos — incluindo date_of_birth e sex — são guardados e usados normalmente, pelo que os intervalos de referência que recebes são os reais, específicos para a idade e o sexo do perfil que criaste. A marcação fica agendada no local Aniva Test, num horário real disponível daqui a pelo menos cinco dias (ou há cinco dias, para os estados passados). Gerá-la não cria nenhum pedido laboratorial nem marca estafeta.
Dá aos perfis de teste um endereço que controles. Os lembretes de marcação da Aniva são acionados por scheduled_at, por isso o cenário futuro vai enviá-los, a menos que o perfil tenha o envio desativado via transactional_emails_enabled: false.
O painel é escolhido aleatoriamente entre os que a tua chave de API consegue ver, pelo que o seu panel_id é sempre resolvido no teu próprio Listar painéis. Os biomarcadores clínicos recebem um valor dentro do intervalo de referência do biomarcador; os genes recebem um genótipo aleatório dos dados de referência da Aniva, com as variantes, o significado clínico e os rs ids correspondentes a derivarem daí.
O painel e os valores são gerados novamente em cada criação, por isso valida a estrutura em vez de um painel específico ou números exatos.

Resposta

Em caso de sucesso, a API devolve 201 Created com o perfil recém-criado.
string
obrigatório
Identificador único do perfil (UUID).
string
Handle ou nome de utilizador do perfil. Pode ser null.
string
Nome próprio. Pode ser null.
string
Apelido. Pode ser null.
string
Endereço de email. Pode ser null.
string
Número de telefone no formato E.164. Pode ser null.
integer
Sexo biológico segundo a norma ISO/IEC 5218 (0 = desconhecido, 1 = masculino, 2 = feminino). Pode ser null.
string
Data de nascimento no formato YYYY-MM-DD. Pode ser null.
number
Altura em centímetros. Pode ser null.
number
Peso em quilogramas. Pode ser null.
string
Idioma preferido, um dos 32 códigos acima.
boolean
Indica se este perfil recebe emails transacionais (programáticos). null quando nunca foi definido.
string
Carimbo de data/hora ISO 8601 da criação do perfil.
string
Carimbo de data/hora ISO 8601 da última atualização. null para perfis recém-criados.

Respostas de erro

Um 409 tem este aspeto — trata-o como “este perfil já existe” e procura-o com Listar perfis (?email=) em vez de voltares a tentar a criação:
Uma pessoa com o mesmo nome próprio, apelido, sexo e data de nascimento de um perfil que a tua chave consegue ver recebe um 409 com error_name: "duplicate_profile_error". Usa o profile_id devolvido em vez de criares um segundo perfil:
Os apelidos de sandbox que geram dados de teste estão isentos.