APIs
Référence API
Appel contextuel
Scan & Go

Introduction

Cette API permet de récupérer un URL vers une interface complète d’import et de validation de la prescription. Deux parcours existent :

  • parcours classique : l'appel contextuel renvoie l'url d'une interface permettant l'envoi d'une prescription et sa validation
  • parcours avec fichiers pré-importés : l'appel contextuel est réalisé en joignant d'emblée des fichiers à retranscrire et renvoie l'url d'une interface de validation de la prescription

Point d'entrée

URL des appels contextuels

⚠️

L'url de base est https://partner-connect.{env}.posos.co{env} est l'environnement suivant : preprod pour la validation, production pour le live.


post/api/partners/patient/scan-token

En-têtes HTTP

NomValeur
Content-Typeapplication/json
AuthorizationBearer <token>

Corps de la requête

NomtypeDescription
first_namestringPrénom de l'utilisateur requis
last_namestringNom de l'utilisateur requis
rppsstringRPPS de l'utilisateur, ou un identifiant technique de l’utilisateur au sein de l’établissement requis
facilitySlugstringIdentifiant d’établissement qui vous a été transmis en début d’intégration. requis
patientIdstringLa clé permettant, lors de la récupération de la prescription, de faire la jointure avec votre logiciel et attribuer la prescription au bon dossier. Ce peut être un IPP, un identifiant de séjour, un identifiant unique pour une session de retranscription ou autre requis
imagesarrayTableau d'objets contenant les images. Voir la section Image

Bon à savoir : le champ images n'est présent que pour le parcours avec fichiers pré-importés.

Bon à savoir : Le “RPPS” n’est pas nécessairement le RPPS mais peut être un identifiant technique de l’utilisateur au sein de l’établissement. Sur l’environnement preprod vous pouvez tester avec l’utilisateur abcde1234 qui est configuré.

Image

AttributTypeDescription
imagestringImage ou PDF encodé en base64 requis
isPdfbooleanIndique si l’image est un PDF. Par défaut à false.
{
  "first_name": "John",
  "last_name": "Carter",
  "rpps": "abcde1234",
  "facilitySlug": "hopital-demo",
  "patientId": "123456"
}

Exemple

Request

POST
/api/partners/patient/scan-token
curl --request POST \
  --url https://partner-connect.preprod.posos.co/api/partners/patient/scan-token \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "first_name": "John",
  "last_name": "Carter",
  "rpps": "abcde1234",
  "facilitySlug": "hopital-demo",
  "patientId": "123456"
}'

Response

{
  "token": "5358af7fc61098c6535b2f23f8b0bb2a%7C92b3fee3955e7e72cdcd8b7d3a29b0a43c0bd49eb4ea8160ebcd0a88297789217fcfa4584ab5d759",
  "url": "https://scan-complete.preprod.posos.co?token=5358af7fc61098c6535b2f23f8b0bb2a%7C92b3fee3955e7e72cdcd8b7d3a29b0a43c0bd49eb4ea8160ebcd0a88297789217fcfa4584ab5d759"
}

Format de la réponse

Le résultat obtenu est du JSON de la forme suivante:

Response

{
  "token": "5358af7fc61098c6535b2f23f8b0bb2a%7C92b3fee3955e7e72cdcd8b7d3a29b0a43c0bd49eb4ea8160ebcd0a88297789217fcfa4584ab5d759",
  "url": "https://scan-complete.preprod.posos.co?token=5358af7fc61098c6535b2f23f8b0bb2a%7C92b3fee3955e7e72cdcd8b7d3a29b0a43c0bd49eb4ea8160ebcd0a88297789217fcfa4584ab5d759"
}

Le champ url est celui contenant l’URL vers laquelle rediriger l’utilisateur.

Codes de réponse

CodeDescription
200
400Un des paramètres passés dans la requête est invalide