1 Purpose
2 Specification
3 Logic
4 Input parameters
5 Filters
6 Dictionaries
7 Request structure
8 Authorize
9 Headers
10 Request data validation
11 Processing
- 11.1 Service logic
12 Response structure
13 Post-processing processes
14 HTTP status codes

Purpose

This WS must be used to discover Care plans by requisition number. If nothing found by requisition number - it will return empty list

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

Specification

Link	https://medicaleventsmisapi.docs.apiary.io/#reference/care-plan/get-care-plans-by-requisition/get-care-plans-by-requisition
Resource	/api/patients/care_plans
Scope	care_plan:read
Components	Care plan
Microservices	me/api-medical-events me/event-consumer me/kafka-consumer il/api(rpc)
Protocol type	REST
Request type	GET
Sync/Async	Sync
Public/Private/Internal	Public

Logic

This service must be used to discover Care plans by requisition number. If nothing found by requisition number - it will return empty list

Input parameters

Input parameter	Values	Type	Description	Example

Input parameter	Values	Type	Description	Example
requisition		String	requisition number	`0123-4567-89AB-CEIK`

Filters

Filter	Values	Type	Description	Example

Filter	Type	Description	Example
status	String	Care plan's status	`active`
page	Number	Page number	`2`
page_size	Number	A limit on the number of objects to be returned, between 1 and 100. Default: 50	`50`

Dictionaries

PROVIDING_CONDITION

Request structure

Authorize

Verify the validity of access token
1. Return (401, 'unauthorized') in case of validation fails
Verify that token is not expired
1. in case of error - return (401, 'unauthorized')
Check user scopes in order to perform this action (scope = 'care_plan:read')
1. Return (403, 'invalid scopes') in case of invalid scope(s)

Headers

Наприклад:

Content-Type:application/json
Authorization:Bearer {{access_token}}
API-key:{{mis_client_secret}}

Request data validation

No

Processing

Service logic

Service returns all Care plans with specified requisition number filtered by status if submitted:

Get all care plan by requisition from care_plans collection (MongoDB)
If submitted, filter list above by status
Render a response according to specification with found Care plan entities. Care plans should be rendered without their activities.

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",
      "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"
          }
        ]
      },
      "identity": {
        "last_name": "Іванов",
        "first_name": "І.",
        "second_name": "І.",
        "gender": "MALE",
        "age": 35
      }
    }
  ]
}

Post-processing processes

No

HTTP status codes

HTTP status code	Message	What caused the error

HTTP status code	Message	What caused the error
200	Response
401	unauthorized	Invalid access token
403	invalid scopes	Invalid scope(s)

E-Health

Get Care Plans by requisition