Introduction

This API allows you to make a contextual call to the different Posos functionalities.

Entry point

Contextual call URLs

post/api/partners/proxy/prepare

HTTP headers

Query parameters

It is possible to pass the same parameters in a

Request body

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.

{
  "rpps": "<rpps_user>",
  "first_name": "<username>",
  "last_name": "<username",
  "guide": "<guide_name>"
}

Description of the guide parameter

Access to the home page

guide: home

This guide provides access to the POSOS home page, thus providing access to its search bar and other guides. This integration does not allow the pre-filling of a search field.

Good to know: No call parameters to include in the body of the call.

Example

{
  "rpps": "abcde1234",
  "first_name": "John",
  "last_name": "Doe",
  "guide": "home"
}

Side Effects Guide

guide: side_effects

This guide allows you to list the undesirable effects from a list of medications and to suggest which medication may be causing an observed effect. In this integration, it is proposed to pre-populate the search with a list of medications.

It is necessary to have at least one of the ucds or dcis or cis parameters. they’re cumulative.

Example

{
  "rpps": "abcde1234",
  "first_name": "John",
  "last_name": "Does",
  "guide": "side_effects",
  "ucds": ["3400894203018", "3400892335049"],
  "cis": ["67443191"],
  "dcis": ["paracetamol"]
}

Interactions and Contraindications Guide

guide: interactions

This guide lists known drug interactions between several medications.

It is necessary to have at least one of the ucds or dcis or cis parameters. they’re cumulative.

The age and birth_date fields can coexist but the value of birth_date is used in case of conflict.

Example

{
  "rpps": "abcde1234",
  "first_name": "John",
  "last_name": "Does",
  "guide": "interactions",
  "ucds": ["3400894203018", "3400891764857"],
  "cis": ["67443191"],
  "dcis": ["paracetamol"],
  "terrains": ["E11"], // diabetes
  "age": 70, // or "birth_date": "1952-01-04" ISO date format;
  // 0 if age < 1 year.
  "pregnancy": false // false by default (no known pregnancy),
  //or true (current pregnancy)
 
  // result, the combination of haloperidol and citalopram is contraindicated
}

Prescription Analysis Guide

guide: analysis

This guide centralizes the functionalities of the Interactions and Contraindications and Adverse Effects guides.

It is necessary to have at least one of the ucds or dcis or cis parameters. they’re cumulative.

The age and birth_date fields can coexist but the value of birth_date is used in case of conflict.

Example

{
  "rpps": "abcde1234",
  "first_name": "John",
  "last_name": "Does",
  "guide": "analysis",
  "ucds": ["3400894203018", "3400891764857"],
  "cis": ["67443191"],
  "dcis": ["paracetamol"],
  "terrains": ["E11"], // diabetes
  "age": 70, // or "birth_date": "1952-01-04" ISO date format;
  // 0 if age < 1 year.
  "pregnancy": false // false by default (no known pregnancy),
  //or true (current pregnancy)
 
  // result, the combination of haloperidol and citalopram is contraindicated
}

Alternative treatments

guide: alternatives

This guide allows you to find alternative treatments for a drug, given a patient profile and concomitant treatments.

it is necessary to have at least one of the ucd, cis, or cip parameters. The three cannot be sent together.

All of the fields are optional. age and birth_date can coexist but birth_date is used in case of conflict.

concomitantTreatments is optional. If passed, it is required to have at least one of the ucds, dcis, cis, or cips parameters, they’re cumulative.

Exemple

{
  "rpps": "abcde1234",
  "first_name": "John",
  "last_name": "Doe",
  "guide": "alternatives",
  "cis": "61467730", // or ucd or cip
  "concomitantTreatments": {
    "ucds": ["3400894203018", "3400891764857"],
    "cis": ["68416845"],
    "dcis": ["paracetamol"],
    "cips": ["3406955"]
  },
  "terrains": ["E11"], // diabete
  "age": 70, // or "birth_date": "1952-01-04" ISO date format;
  // 0 if age < 1 year.
  "pregnancy": false // false by default (no known pregnancy),
  //or true (current pregnancy)
}

Example

curl --request POST \
   --url https://partner-connect.preprod.posos.co/api/partners/proxy/prepare \
   --header 'Authorization: Bearer <token>' \
   --header 'Content-Type: application/json' \
   --data '{
     "rpps": "abcde1234",
     "first_name": "John",
     "last_name": "Does",
     "guide": "analysis",
     "ucds": "3400891764857",
     "dcis": ["ketamine"]
}'

{
  "location": "https://partner-connect.preprod.posos.co/api/partners/proxy/logout?payload=..."
}

Response format

If successful, an HTTP code 201 is returned with a JSON response body containing a single location field containing the URL to redirect the workstation to.

{
  "location": "https://partner-connect.preprod.posos.co/partners/proxy/logout?payload=...."
}

The payload parameter in the url contains an opaque token which will authenticate the user. This URL will be used in the next step.

Response codes

Example of error 400

{
  "error": "'/ucds' must be array; '/ucds' must match pattern \"^([0-9]{7}|[0-9]{13})$\"; '/ucds' must match exactly one schema in oneOf"
}