...

...

...

/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)

• Properties of a REST API method document

• Purpose

• Logic

• Configuration parameters

• Dictionaries

• Input parameters

• Request structure

• Headers

• Request data validation

• Processing

• Response structure examples

• HTTP status codes

• Post-processing processes

• Technical modules where the method is used

Properties of a REST API method document

Purpose

This WS is designed to return records about Care plans filtered by submitted parameters withtin specified patient. List should be returned without activities.

Процеси роботи з планом лікування (care plan) | Отримання інформації плану лікування

Logic

Returns care plan list filtered by submitted parameters within specified patient.

Service logic

Service returns all Care plans related to the patient filtered by submitted parameters:

1. Get all care plans by patient_id from care_plans collection (MongoDB)

2. Filter list above by submitted search parameters

3. Render a response according to specification with found Care plan entities. Care plans should be rendered without their activities.

Configuration parameters

Description of the configuration parameters that are used when processing a request in the systemN/A

Dictionaries

PROVIDING_CONDITION

Input parameters

Request structure

See on API-specification

Headers

...

Key

...

Value

...

Mandatory

...

Description

...

Example

...

Content-Type

...

application/json

...

M

...

Тип контенту

...

Content-Type:application/json

...

 Authorization

...

 Bearer {{access_token}}

...

...

...

 Authorization:Bearer {{access_token}}

...

API-key

...

{{mis_client_secret}}

...

API-key:{{mis_client_secret}}

Headers

Request data validation

Authorize

1. Verify the validity of access token

   1. Return (401, 'unauthorized') in case of validation fails

2. Verify that token is not expired

   1. in case of error - return (401, 'unauthorized')

3. Check user scopes in order to perform this action (scope = 'care_plan:read')

   1. Return (403, 'invalid scopes') in case of invalid scope(s)

Request to process the request using a token in the headers

Access to the resource is also managed by ABAC rules (EN)

Validate Patient

1. Get Patient identifier from the URL

2. Check it exists in DB

   1. Return 404 ('not found') in case of error

Processing

A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST APIN/A

Response structure examples

See on API-specification

{
  "meta": {
    "code": 200,
    "url": "http://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "data": [
    {
      "id": "90a9e15b-b71b-4caf-8f2e-ff247e8a5600",
      "based_on": {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "care_plan"
              }
            ]
          },
          "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
        }
      },
      "requisition": "0123-4567-89AB-CEIK",
      "part_of": {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "care_plan"
              }
            ]
          },
          "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
        }
      },
      "period": {
        "start": "2018-08-02T10:45:16.000Z",
        "end": "2018-08-02T11:00:00.000Z"
      },
      "intent": "order",
      "encounter": {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "encounter"
              }
            ]
          },
          "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
        }
      },
      "author": {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "employee"
              }
            ]
          },
          "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
        }
      },
      "subject": {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "patient"
              }
            ]
          },
          "value": "7c3da506-804d-4550-8993-bf17f9ee0403"
        }
      },
      "status": "active",
      "terms_of_service": {
        "coding": [
          {
            "system": "PROVIDING_CONDITION",
            "code": "INPATIENT"
          }
        ]
      }
    }
  ]
}

HTTP status codes

Post-processing processes

Description of actions performed on data after processing

Technical modules where the method is used

List of pages describing technical N/A

Technical modules where the method is used