Référence de l’API partenaires
Ordonnances
Lire les ordonnances signées par les vétérinaires des sites ouverts à l'application, leurs lignes et leur PDF officiel. Seules les ordonnances signées sont exposées, y compris celles annulées après signature ; un brouillon n'est pas une ordonnance tant que le vétérinaire ne l'a pas signée (article R.5141-111 du code de la santé publique), même s'il a été préparé ou validé par l'équipe. Lecture seule : l'API ne crée, ne modifie, ne signe ni n'annule aucune ordonnance. Droit exigé : prescriptions:read. Notification associée : prescription.signed.
Lister les ordonnances signées
GET/api/partner/v1/prescriptions#
Rend une page des ordonnances signées (ou annulées après signature) établies sur les sites ouverts à l'application, sans leurs lignes (lineCount donne leur nombre). Les brouillons ne sont jamais rendus. Tri par date de synchronisation (updatedAt) puis identifiant : une ordonnance annulée revient dans updated_since.
Les modifications des 60 dernières secondes n'apparaissent qu'aux appels suivants ; la lecture par identifiant est immédiate. Un patient_id inconnu rend une liste vide, pas une erreur.
Paramètres
| patient_idrequête · uuid | Restreint aux ordonnances de cet animal. |
| statusrequête · enum | Restreint à ce statut. Insensible à la casse. |
| site_idrequête · uuid | Restreint à un site ouvert à l'application (ou passer l'en-tête |
| updated_sincerequête · date-time | Ne rend que les ordonnances dont |
| cursorrequête · string | Curseur |
| limitrequête · integer | Nombre d'ordonnances par page, de 1 à 200 (au-delà de 200, ramené à 200). Défaut :50 |
| Treats-Site-Iden-tête · uuid | Site visé, à la place du paramètre |
Réponse
200Une page d'ordonnances, sans lignes.
Champs de la réponse (2)
| itemsPrescription[] | |
| iduuid | Identifiant de l'ordonnance. |
| numberstring | Numéro de l'ordonnance, attribué à la signature. peut être null |
| siteIduuid | Site où l'ordonnance a été établie. |
| patientIduuid | Animal concerné. peut être null |
| consultationIduuid | Consultation d'où vient l'ordonnance. peut être null |
| typeenum |
SIMPLESECURED |
| statusenum |
SIGNEDCANCELLED |
| issuedAtdate-time | Date d'établissement. |
| expiresAtdate-time | Date de fin de validité. |
| signedAtdate-time | Date de signature par le vétérinaire. Peut manquer sur une ordonnance reprise d'un ancien logiciel. peut être null |
| validboolean | Au détail : |
| prescriberNamestring | Au détail : nom du vétérinaire prescripteur. |
| recommendationsstring | Au détail : recommandations imprimées sur l'ordonnance. |
| renewalPolicyenum | Au détail : renouvellement non autorisé, autorisé pendant un an, ou sous conditions. NOT_ALLOWEDALLOWED_1_YEARWITH_CONDITIONSpeut être null |
| renewedFromIduuid | Au détail : ordonnance dont celle-ci est le renouvellement. |
| cancelledAtdate-time | Au détail : date d'annulation d'une ordonnance annulée. |
| cancellationReasonstring | Au détail : motif d'annulation. |
| lineCountinteger | Nombre de lignes de l'ordonnance. |
| linesPrescriptionLine[] | Au détail : les lignes, telles qu'imprimées. |
| iduuid | Identifiant de la ligne. |
| catalogItemIduuid | Article du catalogue prescrit (voir |
| namestring | Nom du médicament ou du produit prescrit. peut être null |
| substancestring | Substance active. peut être null |
| dosagestring | Posologie, telle qu'imprimée (« 1 comprimé matin et soir »). peut être null |
| durationstring | Durée du traitement, telle qu'imprimée. peut être null |
| quantityinteger | Quantité délivrée. peut être null |
| conditioningstring | Conditionnement. peut être null |
| routestring | Voie d'administration. peut être null |
| instructionsstring | Instructions complémentaires. peut être null |
| computedDoseValuenumber | Dose calculée pour le poids de l'animal, quand le vétérinaire l'a calculée. peut être null |
| computedDoseUnitstring | Unité de cette dose ( |
| offLabelUseboolean |
|
| freeTextboolean |
|
| updatedAtdate-time | Date de synchronisation : dernière modification de l'ordonnance (signature, annulation…), à défaut sa création. Sert de clé à |
| nextCursorstring | Curseur opaque de la page suivante, à repasser tel quel dans |
Erreurs propres à cette opération
| 400 INVALID_FIELD |
|
| 400 INVALID_SITE_ID |
|
| 404 SITE_NOT_FOUND | Le site demandé n'est pas ouvert à l'application. |
Et les erreurs communes à toutes les opérations : erreurs et limites.
Lire une ordonnance signée
GET/api/partner/v1/prescriptions/{id}#
Rend le détail d'une ordonnance signée (ou annulée après signature) d'un site ouvert à l'application : prescripteur, recommandations, renouvellement, annulation et lignes avec leur posologie. Un brouillon, ou une ordonnance d'un site non ouvert, répond 404.
Paramètres
| idchemin · uuidrequis | Identifiant de l'ordonnance. |
Réponse
200L'ordonnance, avec ses lignes.
Champs de la réponse (20)
| iduuid | Identifiant de l'ordonnance. |
| numberstring | Numéro de l'ordonnance, attribué à la signature. peut être null |
| siteIduuid | Site où l'ordonnance a été établie. |
| patientIduuid | Animal concerné. peut être null |
| consultationIduuid | Consultation d'où vient l'ordonnance. peut être null |
| typeenum |
SIMPLESECURED |
| statusenum |
SIGNEDCANCELLED |
| issuedAtdate-time | Date d'établissement. |
| expiresAtdate-time | Date de fin de validité. |
| signedAtdate-time | Date de signature par le vétérinaire. Peut manquer sur une ordonnance reprise d'un ancien logiciel. peut être null |
| validboolean | Au détail : |
| prescriberNamestring | Au détail : nom du vétérinaire prescripteur. |
| recommendationsstring | Au détail : recommandations imprimées sur l'ordonnance. |
| renewalPolicyenum | Au détail : renouvellement non autorisé, autorisé pendant un an, ou sous conditions. NOT_ALLOWEDALLOWED_1_YEARWITH_CONDITIONSpeut être null |
| renewedFromIduuid | Au détail : ordonnance dont celle-ci est le renouvellement. |
| cancelledAtdate-time | Au détail : date d'annulation d'une ordonnance annulée. |
| cancellationReasonstring | Au détail : motif d'annulation. |
| lineCountinteger | Nombre de lignes de l'ordonnance. |
| linesPrescriptionLine[] | Au détail : les lignes, telles qu'imprimées. |
| iduuid | Identifiant de la ligne. |
| catalogItemIduuid | Article du catalogue prescrit (voir |
| namestring | Nom du médicament ou du produit prescrit. peut être null |
| substancestring | Substance active. peut être null |
| dosagestring | Posologie, telle qu'imprimée (« 1 comprimé matin et soir »). peut être null |
| durationstring | Durée du traitement, telle qu'imprimée. peut être null |
| quantityinteger | Quantité délivrée. peut être null |
| conditioningstring | Conditionnement. peut être null |
| routestring | Voie d'administration. peut être null |
| instructionsstring | Instructions complémentaires. peut être null |
| computedDoseValuenumber | Dose calculée pour le poids de l'animal, quand le vétérinaire l'a calculée. peut être null |
| computedDoseUnitstring | Unité de cette dose ( |
| offLabelUseboolean |
|
| freeTextboolean |
|
| updatedAtdate-time | Date de synchronisation : dernière modification de l'ordonnance (signature, annulation…), à défaut sa création. Sert de clé à |
Erreurs propres à cette opération
| 404 PRESCRIPTION_NOT_FOUND | Aucune ordonnance signée de ce périmètre ne porte cet identifiant (brouillon, autre organisation, site non ouvert). |
Et les erreurs communes à toutes les opérations : erreurs et limites.
Télécharger le PDF d'une ordonnance signée
GET/api/partner/v1/prescriptions/{id}/pdf#
Rend le PDF officiel de l'ordonnance, celui remis au client, avec l'en-tête du site où elle a été établie. Même périmètre que GET /prescriptions/{id} : un brouillon répond 404. Le fichier est servi avec Content-Disposition: inline; filename="ordonnance-<id>.pdf".
Paramètres
| idchemin · uuidrequis | Identifiant de l'ordonnance. |
Réponse
200Le PDF de l'ordonnance. · fichier application/pdf
Erreurs propres à cette opération
| 404 PRESCRIPTION_NOT_FOUND | Aucune ordonnance signée de ce périmètre ne porte cet identifiant. |
Et les erreurs communes à toutes les opérations : erreurs et limites.