> ## Documentation Index
> Fetch the complete documentation index at: https://docs.anivahealth.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Profiel aanmaken

> Een nieuw patiëntprofiel aanmaken en toewijzen aan een profielgroep

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](https://docs.anivahealth.com/nl/concepts/idempotency.md).

## Verzoek

### Bodyparameters

**first\_name** `string` *required*

Voornaam van de patiënt. Moet Latijnse tekens gebruiken, tussen 1 en 100 tekens.

**last\_name** `string` *required*

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](#sandbox-testfixtures).

**sex** `integer` *required*

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](https://docs.anivahealth.com/nl/concepts/profiles.md#de-patient-zelf-geboortedatum-en-geslacht-laten-invullen).

**date\_of\_birth** `string` *required*

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.

**profile\_group** `string` *required*

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.

**profile\_group\_slug** `string` *deprecated*

Verouderd: gebruik `profile_group`. Slug van de profielgroep. Alleen kleine letters, cijfers,
koppeltekens en underscores.

**email** `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.

**phone** `string`

Telefoonnummer in E.164-formaat (bijv. `+14155552671`).

**height** `number`

Lengte in centimeters.

**weight** `number`

Gewicht in kilogram.

**language** `string` (default: 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`.

**transactional\_emails\_enabled** `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.

**marketing\_emails\_enabled** `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](https://docs.anivahealth.com/nl/api/appointments/list-appointments.md),
[Resultaten ophalen](https://docs.anivahealth.com/nl/api/appointments/get-results.md),
[Document downloaden](https://docs.anivahealth.com/nl/api/documents/download-document.md) — 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:

| `last_name` | Wat het profiel krijgt |
| - | - |
| `Upcomingtestmann` | Eén aankomende `confirmed`-afspraak met een gekoppeld panel. Nog geen resultaten. |
| `Partialtestmann` | Eén afgelopen `blood_drawn`-afspraak. Ongeveer de **helft** van het panel is gerapporteerd; [Resultaten ophalen](https://docs.anivahealth.com/nl/api/appointments/get-results.md) is `in_progress`. |
| `Fulltestmann` | Eén afgelopen `blood_drawn`-afspraak. **Elke** biomarker in het panel is gerapporteerd, `status: "completed"`, en een pdf van het labrapport in `documents[]`. |

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.

> [!NOTE]
>
> 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](https://docs.anivahealth.com/nl/api/panels/list-panels.md). 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.

> [!NOTE]
>
> 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.

**id** `string` *required*

Unieke identifier van het profiel (UUID).

**handle** `string`

Profielhandle of gebruikersnaam. Kan `null` zijn.

**first\_name** `string`

Voornaam. Kan `null` zijn.

**last\_name** `string`

Achternaam. Kan `null` zijn.

**email** `string`

E-mailadres. Kan `null` zijn.

**phone** `string`

Telefoonnummer in E.164-formaat. Kan `null` zijn.

**sex** `integer`

Biologisch geslacht volgens ISO/IEC 5218 (`0` = onbekend, `1` = man, `2` = vrouw). Kan `null` zijn.

**date\_of\_birth** `string`

Geboortedatum in `YYYY-MM-DD`-formaat. Kan `null` zijn.

**height** `number`

Lengte in centimeter. Kan `null` zijn.

**weight** `number`

Gewicht in kilogram. Kan `null` zijn.

**language** `string`

Voorkeurstaal, een van de 32 codes hierboven.

**transactional\_emails\_enabled** `boolean`

Of dit profiel transactionele (programmatische) e-mails ontvangt. `null` als dit nooit is ingesteld.

**created\_at** `string`

ISO 8601-tijdstempel van het moment waarop het profiel is aangemaakt.

**updated\_at** `string`

ISO 8601-tijdstempel van de laatste update. `null` voor nieuw aangemaakte profielen.

## Foutresponsen

| Status | Beschrijving |
| - | - |
| `400` | Validatiefout — een of meer velden voldoen niet aan de validatie. |
| `403` | Geen toegang — je API-sleutel heeft geen toegang tot deze bewerking of de profielgroep valt buiten je toegangscontext. |
| `404` | Profielgroep niet gevonden. |
| `409` | Er bestaat al een profiel voor het opgegeven `email` (de response bevat het adres), of voor dezelfde persoon (zie hieronder), of de `Idempotency-Key` is opnieuw gebruikt met een andere body, of het oorspronkelijke verzoek is nog niet afgerond. |
| `500` | Interne serverfout. |

Een `409` ziet er zo uit — behandel dit als "dit profiel bestaat al" en zoek het profiel op met
[Profielen weergeven](https://docs.anivahealth.com/nl/api/profiles/list-profiles.md) (`?email=`) in plaats van het aanmaken opnieuw te proberen:

```json theme={null}
{
  "error": "An account with the email \"maria.schmidt@example.com\" already exists.",
  "error_name": "email_exists_error",
  "email": "maria.schmidt@example.com"
}
```

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:

```json theme={null}
{
  "error": "A patient named \"Maria Schmidt\", born 02-04-1990, with the same biological sex already exists as m***@example.com. Search for that patient and select them instead of creating a duplicate.",
  "error_name": "duplicate_profile_error",
  "profile_id": "3f1c2a8e-5b7d-4c9e-8a21-6d4f0b9e7c35",
  "full_name": "Maria Schmidt",
  "date_of_birth": "1990-04-02",
  "masked_email": "m***@example.com"
}
```

De sandbox-achternamen waarmee testdata wordt aangemaakt, zijn uitgezonderd.

```bash cURL theme={null}
curl --request POST \
  --url https://anivahealth.com/api/v1/profiles \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "first_name": "Maria",
    "last_name": "Schmidt",
    "sex": 2,
    "date_of_birth": "1985-03-22",
    "profile_group": "acme-clinic-berlin",
    "email": "maria.schmidt@example.com",
    "phone": "+4930123456789",
    "height": 168,
    "weight": 65,
    "language": "de",
    "transactional_emails_enabled": true,
    "marketing_emails_enabled": false
  }'
```

```json 201 theme={null}
{
  "id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
  "handle": null,
  "first_name": "Maria",
  "last_name": "Schmidt",
  "email": "maria.schmidt@example.com",
  "phone": "+4930123456789",
  "sex": 2,
  "date_of_birth": "1985-03-22",
  "height": 168,
  "weight": 65,
  "language": "de",
  "transactional_emails_enabled": true,
  "created_at": "2026-04-01T09:14:32Z",
  "updated_at": null
}
```

```json 400 theme={null}
{
  "error": "date_of_birth: Birthdate cannot be in the future."
}
```

```json 404 theme={null}
{
  "error": "Profile group 'acme-clinic-berlin' not found"
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.