Purpose

Use this method to obtain a list of Declaration Requests for an employee_id

Key features

Only authenticated and authorized user can use declaration requests.

Specification

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

Logic

If you want to reduce amount of data that is going trough your application, use status filter and show only requests that Doctor or Admin is interested in current UI section.

Also we suggest use employee_id and legal_entity_id to make sure that end-user understands context of actions that he or she will perform.

Method returns shortened details, to obtain full information - get Declaration Request it by it's ID.

Important

This endpoint shows the declaration requests which are created by V2 and V3. Due to the fact that structure of declaration request V3 is different from the structure of declaration request V2 , so not all fields of declaration request v2 can be displayed. If declaration request is created by v2, the field person_id will be empty.

Filters

Filter	Values	Type	Description	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`
status	NEW APPROVED SIGNED REJECTED CANCELLED	Enum		`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

Authorize

Verify the validity of access token
1. Return 401 in case validation fails
Check scopes in order to perform this action (scope = 'declaration_request:read')
1. Return 403 in case invalid scope(s)

Request to process the request using a token in the headers.

Headers

Content-Type:application/json
Authorization:Bearer c2778f3064753ea70de870a53795f5c9

Response structure

See on Apiary

Request 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",
      "start_date": "2017-03-02",
      "end_date": "2025-03-02",
      "status": "NEW",
      "person_id": "4fa9cac7-8950-44db-9294-0daba56eed58",
      "employee_id": "60a797bb-43c5-463d-86ee-68e354cb626b",
      "division_id": "4c9c9c6e-5230-444d-8b65-7678da1c1ab3",
      "legal_entity_id": "56b8bcd7-78b8-4ff7-8a60-a48e54a6ef57",
      "authorize_with": "cc949559-5dfe-420f-ac05-065e443b2cc6",
      "parent_declaration_id": "8c7753fc-a647-435f-8e43-4ff4546431f6"
    }
  ],
  "paging": {
    "page_number": 2,
    "page_size": 50,
    "total_entries": 1000,
    "total_pages": 23
  }
}

HTTP status codes

HTTP status code	Message	What caused the error
200	Response
401		Access token validation failed
403		Invalid scope

Backward compatibility

This endpoint returns declaration requests that were created through V2 and V3. Field person_id will be empty for declaration request V2.

Get declaration requests list V3