Purpose

This web service returns brief information in order not to disclose confidential and sensitive data. Access to full episode data is restricted by patient's approval. If you have an approval - you can obtain episode details and nested entities through /episode/:id/* web services.

Specification

Logic

API paragraph not found

Filters

Request structure

API paragraph not found

Authorize

API paragraph not found

Headers

• Content-Type:application/json

• Authorization:Bearer mF_9.B5f-4.1JqM

• api-key:aFBLVTZ6Z2dON1V

• X-Custom-PSK:a2aa05c76f3f2d91870f923a53cc8aa8f23bbc01a8238d1c2c26d4299715a7e4

Request data validation

Validate token

• Verify the validity of access token

  • Return 401 in case validation fails

• Verify token is not expired

  • in case error return 401

Validate scopes

• Check user scopes in order to perform this action (scope = 'patient_summary:read')

  1. Return 403 in case invalid scope(s)

Validate patient

• Validate patient exists in MongoDB

  • In case of error return 404 not found

Processing

1. Get all patient's episodes

2. Filter using Forbidden Groups

3. Apply filters provided by user

4. Render reduced episode data

Response structure

See on Apiary

Example:

{
  "meta": {
    "code": 200,
    "url": "http://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "data": [
    {
      "id": "90a9e15b-b71b-4caf-8f2e-ff247e8a5600",
      "name": "Діабет 2018",
      "status": "active",
      "period": {
        "start": "2018-08-02T10:45:16.000Z",
        "end": "2018-08-03T10:45:16.000Z"
      },
      "inserted_at": "2018-08-02T10:45:16.000Z",
      "updated_at": "2018-08-02T10:45:16.000Z"
    }
  ],
  "paging": {
    "page": 2,
    "page_size": 50,
    "total_entries": 1000,
    "total_pages": 20
  }
}

Post-processing processes

API paragraph not found

HTTP status codes