Page Comparison

Table of Contents

minLevel	1

...

Required parameters are marked with "*"

...


maxLevel	3

Purpose

Use this method to reject previously created Declaration Request.

Specification

...

Link
Apiary https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/declaration-requests/reject-declaration-request-v3
Resource
/api/v3/declaration_requests/{{id}}/actions/reject
Scope
declaration_request:reject
Components
Необхідно зазначити перелік компонентів, які використовують цей метод, наприклад: ePrescription
Using Dictionaries
Потрібно вказати словники, які використовує метод APIDeclarations
Using Dictionaries
API paragraph not found
Using Microservices
Вкажіть перелік мікросервісів, які використовує метод API. Наприклад: Auth, ABACAPI paragraph not found
Protocol type
Вкажіть тип протоколу, який використовується запитом, наприклад: SOAP | REST | JSON
Request type
PATCH
Sync/Async
Метод є синхронним чи асинхронним?
...
Sync
Public/Private/Internal
Public

Logic

Only authenticated and authorized user can use this service
New and Approved declaration request can be rejected
The request can be rejected only by the employee who works in the same legal entity in which the request was made.

Input parameters

Filter	Values	Type	Description	Example
id		String	`b075f148`	7f93-4fc2-b2ec-2d81b19a9b7b

Request structure

...

API paragraph not found

Authorize

...

Verify the validity of access token
Return 401 in case validation fails
Check scopes in order to perform this action (scope = 'declaration_request:write')
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
...

Validation data request

Check that declaration request with such ID exists in the system (is_active = true)
1. In case of error - return 404
Check that declaration request belongs to the same legal entity as the user
1. In case of error - return 403

Validation data request*

...

Processing

API paragraph not found

Response structure

...

Expand

title	Request example

Code Block

{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "data": {
    "id": "b075f148-7f93-4fc2-b2ec-2d81b19a9b7b",
    "start_date": "2017-03-02",
    "end_date": "2017-03-02",
    "person_id": "4d0d790c-cbf1-44f5-ab21-ba8db67da161",
    "employee_id": "1a8b10ea-ba09-40f2-8f9e-55608e9208c6",
    "division_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "declaration_number": "0000-12H4-245D",
    "declaration_id": "8311ab82-e341-4da0-8a95-235ec9885e23",
    "parent_declaration_id": "8c7753fc-a647-435f-8e43-4ff4546431f6",
    "status": "NEW",
    "channel": "MIS",
    "authorize_with": "cc949559-5dfe-420f-ac05-065e443b2cc6",
    "data_to_be_signed": {
      "id": "b099f148-7f93-4fc2-b2ec-2d81b19a9b7b",
      "declaration_number": "0000-12H4-245D",
      "declaration_id": "8311ab82-e341-4da0-8a95-235ec9885e23",
      "start_date": "2017-03-02",
      "end_date": "2017-03-02",
      "content": "Declaration content",
      "channel": "MIS",
      "person": {
        "id": "5fb57a5d-1457-430e-9678-c81cec72779f",
        "first_name": "Петро",
        "last_name": "Іванов",
        "second_name": "Миколайович",
        "birth_date": "2009-07-05",
        "birth_country": "Україна",
        "birth_settlement": "Вінниця",
        "gender": "MALE",
        "email": "email@example.com",
        "no_tax_id": false,
        "tax_id": "3999869394",
        "secret": "secret",
        "documents": [
          {
            "type": "BIRTH_CERTIFICATE",
            "number": "АА120518",
            "issued_by": "Рокитнянським РВ ГУ МВС Київської області",
            "issued_at": "2017-02-28",
            "expiration_date": "2027-02-28"
          }
        ],
        "addresses": [
          {
            "type": "RESIDENCE",
            "country": "UA",
            "area": "Житомирська",
            "region": "Бердичівський",
            "settlement": "Київ",
            "settlement_type": "CITY",
            "settlement_id": "b075f148",
            "street_type": "STREET",
            "street": "вул. Ніжинська",
            "building": "15",
            "apartment": "23",
            "zip": "02090"
          }
        ],
        "phones": [
          {
            "type": "MOBILE",
            "number": "+380503410870"
          }
        ],
        "authentication_methods": [
          {
            "type": "OTP",
            "phone_number": "+38093*****85"
          }
        ],
        "unzr": "20090705-00011",
        "emergency_contact": {
          "first_name": "Петро",
          "last_name": "Іванов",
          "second_name": "Миколайович",
          "phones": [
            {
              "type": "MOBILE",
              "number": "+380503410870"
            }
          ]
        },
        "confidant_person": [
          {
            "relation_type": "PRIMARY",
            "first_name": "Петро",
            "last_name": "Іванов",
            "second_name": "Миколайович",
            "birth_date": "1972-10-26",
            "birth_country": "Україна",
            "birth_settlement": "Вінниця",
            "gender": "MALE",
            "tax_id": "2659719350",
            "secret": "secret",
            "unzr": "19900101-00099",
            "preferred_way_communication": "email",
            "documents_person": [
              {
                "type": "PASSPORT",
                "number": "АА120518",
                "expiration_date": "2021-02-28",
                "issued_by": "Рокитнянським РВ ГУ МВС Київської області",
                "issued_at": "2017-02-28"
              }
            ],
            "documents_relationship": [
              {
                "type": "BIRTH_CERTIFICATE",
                "number": "АА120518",
                "issued_by": "Рокитнянським РВ ГУ МВС Київської області",
                "issued_at": "2017-02-28"
              }
            ],
            "phones": [
              {
                "type": "MOBILE",
                "number": "+380503410870"
              }
            ],
            "email": "emaill@example.com"
          }
        ],
        "preferred_way_communication": "email",
        "patient_signed": false,
        "process_disclosure_data_consent": true
      },
      "employee": {
        "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
        "position": "P6",
        "party": {
          "id": "b075f148-7f93-4fc2-b2ec-2d81b19a9b7b",
          "no_tax_id": true,
          "first_name": "Петро",
          "last_name": "Іванов",
          "second_name": "Миколайович",
          "email": "email@example.com",
          "phones": [
            {
              "type": "MOBILE",
              "number": "+380503410870"
            }
          ]
        }
      },
      "legal_entity": {
        "name": "Клініка Ноунейм",
        "short_name": "Ноунейм",
        "legal_form": "140",
        "public_name": "ЦПМСД №1",
        "edrpou": "5432345432",
        "licenses": [
          {
            "license_number": "fd123443",
            "issued_by": "Кваліфікацйна комісія",
            "issued_date": "2017-02-28",
            "expiry_date": "2017-02-28",
            "active_from_date": "2017-02-28",
            "what_licensed": "реалізація наркотичних засобів",
            "order_no": "ВА43234"
          }
        ],
        "accreditation": {
          "category": "SECOND",
          "issued_date": "2017-02-28",
          "expiry_date": "2017-02-28",
          "order_no": "fd123443",
          "order_date": "2017-02-28"
        },
        "addresses": [
          {
            "type": "RESIDENCE",
            "country": "UA",
            "area": "Житомирська",
            "region": "Бердичівський",
            "settlement": "Київ",
            "settlement_type": "CITY",
            "settlement_id": "b075f148",
            "street_type": "STREET",
            "street": "вул. Ніжинська",
            "building": "15",
            "apartment": "23",
            "zip": "02090"
          }
        ],
        "phones": [
          {
            "type": "MOBILE",
            "number": "+380503410870"
          }
        ],
        "email": "email@example.com",
        "id": "b075f148-7f93-4fc2-b2ec-2d81b19a9b7b"
      },
      "division": {
        "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
        "legal_entity_id": "c8aadb87-ecb9-41ca-9ad4-ffdfe1dd89c9",
        "name": "Бориспільське відділення Клініки Ноунейм",
        "addresses": [
          {
            "type": "RESIDENCE",
            "country": "UA",
            "area": "Житомирська",
            "region": "Бердичівський",
            "settlement": "Київ",
            "settlement_type": "CITY",
            "settlement_id": "b075f148",
            "street_type": "STREET",
            "street": "вул. Ніжинська",
            "building": "15",
            "apartment": "23",
            "zip": "02090"
          }
        ],
        "phones": [
          {
            "type": "MOBILE",
            "number": "+380503410870"
          }
        ],
        "email": "email@example.com",
        "type": "clinic",
        "external_id": "3213213",
        "dls_id": "2872985",
        "dls_verified": true
      },
      "seed": "hash",
      "authorize_with": "cc949559-5dfe-420f-ac05-065e443b2cc6"
    }
  }
}

Post-processing processes

...

Change declaration request
Change entity status in IL_DB.declaration_request to REJECTED
Set updated_at - now() (Get current date-time)
Set updated_by - user_id (Extract user from token)

HTTP status codes

HTTP status code	What caused the error
201	201	Response
401	Access token validation failed
403	Invalid scopes Check that declaration request belongs to the same legal entity as the user failed
404	Check that declaration request with such ID exists in the system (is_active = true) failed

Link	Apiary https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/declaration-requests/reject-declaration-request-v3
Resource	/api/v3/declaration_requests/{{id}}/actions/reject
Scope	declaration_request:reject
Components	Необхідно зазначити перелік компонентів, які використовують цей метод, наприклад: ePrescription	Using Dictionaries	Потрібно вказати словники, які використовує метод APIDeclarations
Using Dictionaries	API paragraph not found
Using Microservices	Вкажіть перелік мікросервісів, які використовує метод API. Наприклад: Auth, ABACAPI paragraph not found
Protocol type	Вкажіть тип протоколу, який використовується запитом, наприклад: SOAP \| REST \| JSON
Request type	PATCH
Sync/Async	Метод є синхронним чи асинхронним?

Versions Compared

Old Version 3

New Version 4

Key

Required parameters are marked with "*"

Purpose

Specification

Logic

Input parameters

Request structure

API paragraph not found

Authorize

Verify the validity of access token
Return 401 in case validation fails
Check scopes in order to perform this action (scope = 'declaration_request:write')
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
...

Validation data request

Validation data request*

Processing

Response structure

Post-processing processes

Change declaration request
Change entity status in IL_DB.declaration_request to REJECTED
Set updated_at - now() (Get current date-time)
Set updated_by - user_id (Extract user from token)

HTTP status codes

Page Comparison

Versions Compared

Old Version 3

New Version 4

Key

Required parameters are marked with "*"

Purpose

Specification

Logic

Input parameters

Request structure

API paragraph not found

Authorize

Verify the validity of access tokenReturn 401 in case validation failsCheck scopes in order to perform this action (scope = 'declaration_request:write')Return 403 in case invalid scope(s)Request to process the request using a token in the headers.

Headers

Content-Type:application/jsonAuthorization:Bearer c2778f3064753ea70de870a53795f5c9...

Validation data request

Validation data request*

Processing

Response structure

Post-processing processes

Change declaration requestChange entity status in IL_DB.declaration_request to REJECTEDSet updated_at - now() (Get current date-time)Set updated_by - user_id (Extract user from token)

HTTP status codes

Verify the validity of access token
Return 401 in case validation fails
Check scopes in order to perform this action (scope = 'declaration_request:write')
Return 403 in case invalid scope(s)
Request to process the request using a token in the headers.

Content-Type:application/json
Authorization:Bearer c2778f3064753ea70de870a53795f5c9
...

Change declaration request
Change entity status in IL_DB.declaration_request to REJECTED
Set updated_at - now() (Get current date-time)
Set updated_by - user_id (Extract user from token)