Skip to content
APIsAPI ReferenceContext callScan & Go

Introduction

This API allows you to retrieve a URL to a complete prescription import and validation interface. Two routes are available:

  • classic path: the contextual call returns the URL of an interface enabling a prescription to be sent and validated
  • pathway with pre-imported files: the context call is made by attaching files to be transcribed, and returns the url of a prescription validation interface.

Entry point

Contextual call URLs

⚠️

The base url is https://partner-connect.{env}.posos.co where {env} is the following environment: preprod for validation, production for live.


post/api/partners/patient/scan-token

HTTP headers

NameValue
Content-Typeapplication/json
AuthorizationBearer <token>

Request body

| Name | type | Description | | :------------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | | first_name | string | User first name

Required
| | last_name | string | User name
Required
| | rpps | string | RPPS of the user, or a technical identifier of the user within the establishment
Required
| | facilitySlug | string | Establishment identifier sent to you at the start of integration.
Required
| | patientId | string | The key allowing, when retrieving the prescription, to join with your software and assign the prescription to the correct file. This can be an IPP, a stay identifier, a unique identifier for a transcription session or other
Required
| | images | array | Array of objects containing images. See section Image | |

Good to know: the images field is only present for the route with pre-imported files.

Good to know: The “RPPS” is not necessarily the RPPS but can be a technical identifier of the user within the establishment. On the preprod environment you can test with the abcde1234 user which is configured.

Image

AttributTypeDescription
imagestringBase64-encoded image or PDF
Requis
isPdfbooleanIndicates whether the image is a PDF. Defaults to false
{
  "first_name": "John",
  "last_name": "Carter",
  "rpps": "abcde1234",
  "facilitySlug": "hospital-demo",
  "patientId": "123456"
}

Example

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": "hospital-demo",
   "patientId": "123456"
}'

Output

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

Response format

The result obtained is JSON of the following form:

Output

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

The url field is the one containing the URL to redirect the user to.

Response codes

CodeDescription
200
400One of the parameters passed in the request is invalid