Naar hoofdinhoud gaan
POST
Maak een nieuw patiëntprofiel aan en wijs het toe aan een profielgroep. Het profiel bevat demografische gegevens die worden gebruikt voor afspraken en labaanvragen. Vereist de scope create_user. Stuur een optionele Idempotency-Key-header mee om het aanmaken veilig opnieuw te kunnen proberen — bij herhaling van dezelfde sleutel krijg je de oorspronkelijke respons terug in plaats van een tweede aan te maken. Zie Idempotentie.

Verzoek

Bodyparameters

string
vereist
Voornaam van de patiënt. Moet Latijnse tekens gebruiken, tussen 1 en 100 tekens.
string
vereist
Achternaam van de patiënt. Moet Latijnse tekens gebruiken, tussen 1 en 100 tekens. Laboratoria weigeren aanvragen voor een patiënt zonder achternaam, dus een profiel kan niet zonder worden aangemaakt.Drie waarden zijn gereserveerd om testfixtures aan te maken — zie Sandbox-testfixtures.
integer
vereist
Biologisch geslacht volgens ISO/IEC 5218. Gebruik 1 voor man, 2 voor vrouw. Het laboratorium heeft dit nodig voor de referentiebereiken, dus 0 (onbekend) geeft 400 terug. Vereist, tenzij je profielgroep de patiënt dit laat invullen op de activatiepagina van de kit. Laat het dan weg. Zie De patiënt geboortedatum en geslacht laten invullen.
string
vereist
Geboortedatum in YYYY-MM-DD-formaat. Moet in het verleden liggen en niet vóór 1900. De leeftijd moet tussen 16 en 100 jaar liggen. Andere waarden geven 400 terug. Vereist, tenzij je profielgroep de patiënt dit laat invullen op de activatiepagina van de kit. Laat dit dan weg.
string
vereist
Polymorfe verwijzing (UUID of slug) naar de profielgroep waaraan je dit profiel toewijst. De UUID is de onveranderlijke identifier en blijft geldig als een slug wordt gewijzigd; de slug blijft geaccepteerd voor marketing- en partnerintegraties die op leesbare identifiers zijn gebouwd. UUID heeft de voorkeur. De profielgroep moet binnen de toegangscontext van je API-sleutel vallen. Vereist, tenzij je de verouderde profile_group_slug meestuurt.
string
verouderd
Verouderd: gebruik profile_group. Slug van de profielgroep. Alleen kleine letters, cijfers, koppeltekens en underscores.
string
E-mailadres voor het profiel. Als je dit weglaat, genereert Aniva automatisch een e-mailadres.Door email mee te sturen wordt het aanmaken ook veilig bij herhalen: een adres kan maar één profiel hebben, dus een herhaald verzoek geeft 409 terug in plaats van een tweede profiel. Automatisch gegenereerde adressen zijn uniek per verzoek. Stuur email of een Idempotency-Key mee als je integratie verzoeken opnieuw probeert.
string
Telefoonnummer in E.164-formaat (bijv. +14155552671).
number
Lengte in centimeters.
number
Gewicht in kilogram.
string
standaard:"en"
Voorkeurstaal voor het profiel: 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 of uk. De standaardwaarde is en.
boolean
Of dit profiel transactionele (automatische) e-mails moet ontvangen — afspraakbevestigingen, meldingen wanneer resultaten klaarstaan, enz. Overschrijft de standaard van de profielgroep. Staat los van de marketing-opt-in. Laat weg om de standaard te gebruiken.
boolean
Of dit profiel zich aanmeldt voor marketing-e-mails (nieuwsbrieven, productupdates). Overschrijft de standaard van de profielgroep. Staat los van transactionele e-mails. Laat weg om de standaard van de profielgroep te gebruiken. Alleen-schrijven: wordt niet teruggegeven in de profielrespons.

Sandbox-testfixtures

Elk leespad dat de moeite waard is om te testen — Afspraken ophalen, Resultaten ophalen, Document downloaden — is leeg totdat er dagen later een echte bloedafname plaatsvindt. Dat maakt een geautomatiseerde integratietest lastig om te schrijven. Om dat op te lossen zijn drie waarden voor last_name gereserveerd. Maak een profiel aan met een van deze waarden en Aniva vult de onderstaande status al in vóór het antwoord, zodat je volgende verzoek dit direct ziet: De vergelijking is niet hoofdlettergevoelig. Elk ander veld — inclusief date_of_birth en sex — wordt normaal opgeslagen en gebruikt, zodat de referentiebereiken die je terugkrijgt de echte leeftijds- en geslachtsspecifieke waarden zijn voor het profiel dat je hebt aangemaakt. De afspraak wordt geboekt op de locatie Aniva Test, op een echt boekbaar tijdslot minstens vijf dagen vanaf nu (of vijf dagen geleden, voor de statussen in het verleden). Het aanmaken plaatst geen laborder en boekt geen koerier.
Geef testprofielen een adres dat je zelf beheert. De afspraakherinneringen van Aniva worden aangestuurd door scheduled_at, dus de aankomende fixture verstuurt ze tenzij het profiel is afgemeld via transactional_emails_enabled: false.
Het panel wordt willekeurig gekozen uit de panels die je API-sleutel kan zien, zodat het panel_id altijd te vinden is via je eigen Panels weergeven. Klinische biomarkers krijgen een waarde binnen het referentiebereik van de biomarker; genen krijgen een willekeurig genotype uit de referentiedata van Aniva, waaruit de bijbehorende varianten, klinische significantie en rs-ID’s volgen.
Het panel en de waarden worden elke keer bij het aanmaken opnieuw gegenereerd, dus test op de structuur in plaats van op een specifiek panel of exacte getallen.

Respons

Bij succes geeft de API 201 Created terug met het nieuw aangemaakte profiel.
string
vereist
Unieke identifier van het profiel (UUID).
string
Profielhandle of gebruikersnaam. Kan null zijn.
string
Voornaam. Kan null zijn.
string
Achternaam. Kan null zijn.
string
E-mailadres. Kan null zijn.
string
Telefoonnummer in E.164-formaat. Kan null zijn.
integer
Biologisch geslacht volgens ISO/IEC 5218 (0 = onbekend, 1 = man, 2 = vrouw). Kan null zijn.
string
Geboortedatum in YYYY-MM-DD-formaat. Kan null zijn.
number
Lengte in centimeter. Kan null zijn.
number
Gewicht in kilogram. Kan null zijn.
string
Voorkeurstaal, een van de 32 codes hierboven.
boolean
Of dit profiel transactionele (programmatische) e-mails ontvangt. null als dit nooit is ingesteld.
string
ISO 8601-tijdstempel van het moment waarop het profiel is aangemaakt.
string
ISO 8601-tijdstempel van de laatste update. null voor nieuw aangemaakte profielen.

Foutresponsen

Een 409 ziet er zo uit — behandel dit als “dit profiel bestaat al” en zoek het profiel op met Profielen weergeven (?email=) in plaats van het aanmaken opnieuw te proberen:
Een persoon met dezelfde voornaam en achternaam, hetzelfde geslacht en dezelfde geboortedatum als een profiel dat je sleutel kan zien, krijgt een 409 met error_name: "duplicate_profile_error". Gebruik het teruggegeven profile_id in plaats van een tweede profiel aan te maken:
De sandbox-achternamen waarmee testdata wordt aangemaakt, zijn uitgezonderd.