Effacer un patient

POST/v1/patients/{patient}/erase

Efface ce qui n’est sous aucune obligation de conservation, l’identité comprise quand rien ne reste. Une facture signée reste, avec ce qu’elle cite : retained dit pourquoi et jusqu’à quand. Rejouable : un nouvel appel, une fois la conservation finie, efface le reste.

Droit de clé restreinte : patients:write.

Paramètres de chemin

patienttexteobligatoire
L'identifiant, pat_….

En-têtes

Idempotency-Keytexte
Rend le rejeu de cette écriture sûr pendant 24 heures. Idempotence.

Réponse

Rend le corps ci-contre.

Une erreur suit le format commun.

Requête

curl


curl -X POST https://api.ophelix.fr/v1/patients/pat_…/erase \
  -H "Authorization: Bearer sk_test_…"

PHP


$client = new GuzzleHttp\Client(['base_uri' => 'https://api.ophelix.fr']);
 
$response = $client->post('/v1/patients/pat_…/erase', [
    'headers' => ['Authorization' => 'Bearer sk_test_…'],
]);
$object = json_decode((string) $response->getBody(), true);

TypeScript


const response = await fetch('https://api.ophelix.fr/v1/patients/pat_…/erase', {
  method: 'POST',
  headers: { Authorization: 'Bearer sk_test_…' },
})
const object = await response.json()

Réponse 201


{
  "id": "obj_…",
  "object": "patient_erasure",
  "patient": "…",
  "reason": "request",
  "status": "completed",
  "patient_erased": true,
  "erased": {
    "claims": 0,
    "coverages": 0,
    "quotes": 0,
    "prior_agreements": 0
  },
  "retained": [
    {
      "object": "claim",
      "id": "obj_…",
      "reason": "billing_retention",
      "retained_until": null
    }
  ],
  "livemode": false,
  "created": 1793970000
}