Purpose

This WS is designed to obtain a declaration list.

Specification

Link	https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/declarations/get-declarations-list
Resource	/api/declarations
Scope	declaration:read
Components	Declarations
Microservices	il/api ops/api
Protocol type	REST
Request type	GET
Sync/Async	Sync
Public/Private/Internal	Public

Key points

This is a REST method used by MIS.
Only authenticated and authorized employee with appropriate scope can get declarations list.
Method returns shortened declaration details, to obtain full information - use Get Declaration by ID method.

Logic

Filter declarations by search params.
Render found declarations with shortened details according to specification.

Use this method to obtain a list of Declarations for an employee_id and legal_entity_id. If you want to reduce the amount of data that is going trough your application, use status filter and show only requests that Doctor is interested in the current UI section.

Filters

Name	Type	Value	Example
employee_id	String	`user_id` of a Doctor	`d290f1ee-6c54-4b01-90e6-d701748f0851`
legal_entity_id	String	MSP ID	`d290f1ee-6c54-4b01-90e6-d701748f0851`
declaration_number	String	Unique human redable number of declaration	`0000-12H4-245D`
status	String	Default: `active`	`active`
reason	String	Filter declaration by reason	`offline`
page	Number	Page number	2
page_size	Number	A limit on the number of objects to be returned, between 1 and 300. Default: 50	50

Authorize

Verify the validity of access token
- in case of error - return 401 (“Invalid access token”) in case of validation fails
Verify that token is not expired
- in case of error - return 401 (“Invalid access token”)
Check user scopes in order to perform this action (scope = 'declaration:read')
- return 403 (“Your scope does not allow to access this resource. Missing allowances: declaration:read”) in case of invalid scope(s)

Request data validation

API paragraph not found

Processing

API paragraph not found

Response structure

See on Apiary

Example:

Response example

{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810"
  },
  "data": [
    {
      "id": "b075f148-7f93-4fc2-b2ec-2d81b19a9b7b",
      "declaration_number": "0000-12H4-245D",
      "employee": {
        "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
        "position": "P6",
        "employee_type": "doctor"
      },
      "division": {
        "id": "asSbcy12sYs8c",
        "name": "Пединовка"
      },
      "start_date": "2017-03-02",
      "end_date": "2017-03-02",
      "reason": "manual_employee",
      "reason_description": "Згідно постанови 1 від 10.01.20171111",
      "person": {
        "id": "b075f148-7f93-4fc2-b2ec-2d81b19a9b7b",
        "first_name": "Петро",
        "last_name": "Іванов",
        "second_name": "Миколайович",
        "birth_date": "1991"
      },
      "legal_entity": {
        "short_name": "Ноунейм",
        "name": "Клініка Ноунейм",
        "id": "b075f148-7f93-4fc2-b2ec-2d81b19a9b7b",
        "edrpou": "5432345432"
      },
      "declaration_request_id": "74a6fae6-4207-4e03-a136-f2e70c6b0c02",
      "inserted_at": "2017-04-20T19:14:13Z",
      "updated_at": "2017-04-20T19:14:13Z"
    }
  ],
  "paging": {
    "page_number": 2,
    "page_size": 50,
    "total_entries": 1000,
    "total_pages": 23
  }
}

Post-processing processes

API paragraph not found

HTTP status codes

HTTP status code	Message	What caused the error
200	Response
401		Invalid access token
403		Your scope does not allow to access this resource. Missing allowances: declaration:read

Get Declarations List

Purpose

Specification

Key points

Logic

Filters

Authorize

Request data validation

Processing

Response structure

Post-processing processes

HTTP status codes