Patients

Contains the information about a Patient in the mediQuo ecosystem.

Patient object

Attributes

Name	Type	Allowed values	Description
code	string		The value that identifies your patient in your system
first_name	string		Patient first name or full name
last_name	string (optional)		Patient last name
gender	string (optional)	male,female	Patient gender
birth_date	string (optional)		Patient birth date (Y-m-d)
tax_id	string (optional)		Patient tax id number
email	string (optional)		Patient email
plan	string (optional)		Patient plan name
phone	string (optional)		Patient phone number with prefix code
locale	string (optional)	de, en, es, pt	Patient locale. es by default
meta	array (optional)		Metadata to add some information

Create or update Patients

PUT /v1/patients

Use this endpoint to integrate your patients into our platform. You can bulk many patients at once but keep in mind that we limit up to 100 patients per request.

You must provide a unique code for each patient that we will use to identify you patients. This way if you want to update the information of a given user, you can request it again with it's code and the new data. The operation will either create or update a patient by the code you provide us.

In case many patients are provided, the operation will either success or fail as a whole, meaning that in case of an error, no patients will be created or updated.

If attribute plan is provided, the patient will be treated as a subscribed user fully capable to access all features. In case no plan is provided, the patient will be treated as an unsubscribed user and won't be able to use any paid feature. Omit attribute plan in order to unsubscribe a patient.

Since the endpoint handles the data asyncronally, it is possible that there is a small delay between the request and the data being available.

Endpoint URL

https://sdk.mediquo.com/v1/patients

Authentication and rate limits

Authentication	Rate limits
HTTP Headers	600 requests per minute

Learn more about rate limits.

Request parameters

Name	Type	Description
patients	array[Patient]	List of patients

Example request

{
  "patients": [
    {
      "code": "dcb70f10-bafe-4a43-af99-8c86c61aa68d",
      "first_name": "John",
      "last_name": "Doe",
      "gender": "male",
      "plan": "premium",
      "birth_date": "1980-01-01",
      "tax_id": "123456789",
      "email": "john@doe.com",
      "phone": "+1 123345678",
      "meta": {
        "card_id": "1234"
      }
    },
    {
      "code": "jane-unique-id",
      "first_name": "Jane",
      "gender": "female",
      "birth_date": "1980-01-01"
    }
  ]
}

Response fields

Name	Type	Description
message	string	Response message

Default response

Status: 200 OK

{
  "message": "Success"
}

Get Patient

GET /v1/patients/{code}

Use this endpoint to retrieve the patient information by its code.

Endpoint URL

https://sdk.mediquo.com/v1/patients/{code}

Authentication and rate limits

Authentication	Rate limits
HTTP Headers	600 requests per minute

Learn more about rate limits.

Request parameters

No parameters

Response fields

Name	Type	Description
code	string	The value that identifies your patient in your system
first_name	string	Patient first name or full name
last_name	string	Patient last name
gender	string	Patient gender (male or female)
birth_date	string	Patient birth date (Y-m-d)
tax_id	string	Patient tax id number
email	string	Patient email
plan	string	Patient plan
phone	string	Patient phone number
locale	string	Patient locale (de,en,es,pt)
created_at	string	Patient created at date
updated_at	string	Last updated date
unsubscribed_at	string	Date when the patient was unsubscribed
meta	array	Metadata to add some information

Default response

Status: 200 OK

{
  "code": "biOo3TPo",
  "first_name": "Jane",
  "last_name": "Doe",
  "gender": "female",
  "birth_date": "2000-01-01",
  "tax_id": null,
  "email": null,
  "plan": null,
  "phone": null,
  "locale": "es",
  "created_at": "2000-01-01 10:00:00+0000",
  "updated_at": "2000-01-01 10:00:00+0000",
  "unsubscribed_at": "2000-01-01 10:00:00+0000",
  "meta": {
    "card_id": "1234"
  }
}

Authenticate

POST /v1/patients/authenticate

Use this endpoint to authenticate your patients (only applies to mediQuo Widget).

Endpoint URL

https://sdk.mediquo.com/v1/patients/authenticate

Authentication and rate limits

Authentication	Rate limits
HTTP Headers	600 requests per minute

Learn more about rate limits.

Request parameters

Name	Type	Description
code	string	The code of patient

Response fields

Name	Type	Description
access_token	string	The user authentication token
token_type	string	Authentication scheme that involves the access_token

Default response

Status: 200 OK

{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
  "token_type": "Bearer"
}