Qualifier une pièce justificative

PATCH/v1/supporting-documents/{supportingDocument}

Sa nature, son prescripteur, la date de la prescription. Une pièce partie ne se modifie plus.

Droit de clé restreinte : claims:write.

Paramètres de chemin

supportingDocumenttexteobligatoire
L'identifiant, sdoc_….

Corps de la requête

natureénumération
prescriptionexception_prescriptionbizone_prescriptionclaim_formnursing_care_planother
prescribertexteou null
Le numéro de facturation du prescripteur d'une ordonnance, neuf caractères.
prescribed_ondateou null
La date de la prescription, AAAA-MM-JJ.
file_nametexteou null

En-têtes

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

Réponse

Rend l’objet pièces justificatives.

Une erreur suit le format commun.

Requête

curl


curl -X PATCH https://api.ophelix.fr/v1/supporting-documents/sdoc_… \
  -H "Authorization: Bearer sk_test_…" \
  -H "Content-Type: application/json" \
  -d '{"nature":"prescription","prescriber":"751234561"}'

PHP


$client = new GuzzleHttp\Client(['base_uri' => 'https://api.ophelix.fr']);
 
$response = $client->patch('/v1/supporting-documents/sdoc_…', [
    'headers' => ['Authorization' => 'Bearer sk_test_…'],
    'json' => [
        'nature' => 'prescription',
        'prescriber' => '751234561',
    ],
]);
$object = json_decode((string) $response->getBody(), true);

TypeScript


const response = await fetch('https://api.ophelix.fr/v1/supporting-documents/sdoc_…', {
  method: 'PATCH',
  headers: { Authorization: 'Bearer sk_test_…', 'Content-Type': 'application/json' },
  body: JSON.stringify({
    nature: 'prescription',
    prescriber: '751234561'
  }),
})
const object = await response.json()

Réponse 200


{
  "id": "obj_…",
  "object": "supporting_document",
  "status": "draft",
  "nature": "prescription",
  "claims": [
    "…"
  ],
  "practitioner": null,
  "identifier": null,
  "file_name": null,
  "source_type": "…",
  "size_bytes": 0,
  "page_count": 0,
  "prescriber": null,
  "prescribed_on": null,
  "batch": null,
  "rejection_code": null,
  "rejection_label": null,
  "digitized_at": null,
  "attached_at": null,
  "sent_at": null,
  "acknowledged_at": null,
  "livemode": false,
  "created": 1793970000
}