Déposer une pièce justificative

POST/v1/supporting-documents

Reçoit une ordonnance ou la feuille de soins papier d’une feuille dégradée, en PDF ou en images, et la convertit au format SCOR : PDF/A-1b en noir et blanc, 200 points par pouce, 250 Ko au plus. Une page blanche, trop sombre ou en double est refusée. Avec nature et claims, la pièce est jointe et partira avec le lot de pièces qui suit le lot de ses feuilles.

Droit de clé restreinte : claims:write.

Corps de la requête

contentstexte
Le fichier, encodé en base 64 : PDF (1.4 au plus, un seul calque), JPEG ou PNG. Ou pages.
pagestableau de texte
Une image par page, encodées en base 64, dans l'ordre : elles forment un seul PDF.
file_nametexte
Le nom du fichier déposé.
natureénumération
La nature de la pièce.
prescriptionexception_prescriptionbizone_prescriptionclaim_formnursing_care_planother
claimstableau de texte
Les feuilles qu'elle justifie, clm_…, la porteuse d'abord.
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.

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 POST https://api.ophelix.fr/v1/supporting-documents \
  -H "Authorization: Bearer sk_test_…" \
  -H "Content-Type: application/json" \
  -d '{
    "contents": "iVBORw0KGgo…",
    "file_name": "ordonnance.jpg",
    "nature": "prescription",
    "claims": [
      "clm_…"
    ],
    "prescriber": "751234561",
    "prescribed_on": "2026-10-28"
  }'

PHP


$client = new GuzzleHttp\Client(['base_uri' => 'https://api.ophelix.fr']);
 
$response = $client->post('/v1/supporting-documents', [
    'headers' => ['Authorization' => 'Bearer sk_test_…'],
    'json' => [
        'contents' => 'iVBORw0KGgo…',
        'file_name' => 'ordonnance.jpg',
        'nature' => 'prescription',
        'claims' => [
            'clm_…',
        ],
        'prescriber' => '751234561',
        'prescribed_on' => '2026-10-28',
    ],
]);
$object = json_decode((string) $response->getBody(), true);

TypeScript


const response = await fetch('https://api.ophelix.fr/v1/supporting-documents', {
  method: 'POST',
  headers: { Authorization: 'Bearer sk_test_…', 'Content-Type': 'application/json' },
  body: JSON.stringify({
    contents: 'iVBORw0KGgo…',
    file_name: 'ordonnance.jpg',
    nature: 'prescription',
    claims: [
      'clm_…'
    ],
    prescriber: '751234561',
    prescribed_on: '2026-10-28'
  }),
})
const object = await response.json()

Réponse 201


{
  "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
}