1 Purpose
2 Specification
3 Logic
4 Input parameters
5 Dictionaries
6 Request structure
7 Authorize
8 Headers
9 Request data validation
- 9.1 Validate person request
10 Processing
- 10.1 Change person request
11 Response structure
12 HTTP status codes

Purpose

Use this method to reject previously created Person Request.

Specification

Link	https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/person-requests/reject-person-request	Посилання на Apiary або Swagger
Resource	/api/person_requests/{{id}}/actions/reject	Посилання на ресурс, наприклад: /api/persons/create
Scope	person_request:write	Scope для доступу
Components	Patient registry	Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription
Microservices	il/api fe/admin-web	Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC
Protocol type	REST	Тип протоколу, який використовується запитом, наприклад: SOAP \| REST
Request type	PATCH	Тип запиту API, наприклад: GET, POST, PATCH…
Sync/Async	Sync	Метод є синхронним чи асинхронним?
Public/Private/Internal	Public

Logic

Key features:

Only authenticated and authorized user can use this service;
New and Approved person 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

Input parameter	Values	Type	Description	Example

Input parameter	Values	Type	Description	Example
id		String	Required	eeebb86d-5cba-43c9-885b-6482ecaf826b

Dictionaries

GENDER
DOCUMENT_TYPE
ADDRESS_TYPE
COUNTRY
SETTLEMENT_TYPE
STREET_TYPE
PHONE_TYPE
CONFIDANT_PERSON_TYPE
PREFERRED_WAY_COMMUNICATION
DOCUMENT_TYPE
DOCUMENT_RELATIONSHIP_TYPE
AUTHENTICATION_METHOD

Request structure

See on Apiary

Authorize

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

Headers

Content-Type:application/json

Authorization:Bearer {{access_token}}

api-key:{{secret}}

Request data validation

Validate person request

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

Processing

Change person request

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

Response structure

Example:

{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "data": {
    "status": "SIGNED",
    "id": "eeebb86d-5cba-43c9-885b-6482ecaf826b",
    "person": {
      "id": "13001c60-45a0-4b5a-b425-9505e1de18bd",
      "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": "THIRD_PERSON",
          "phone_number": "+380508887700",
          "value": "c282f8a9-e709-40aa-94b4-dde1402bf4b6",
          "alias": "husband"
        }
      ],
      "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,
    "content": "Person content",
    "channel": "MIS",
    "authorize_with": "cc949559-5dfe-420f-ac05-065e443b2cc6"
  }
}

HTTP status codes

HTTP status code	Message	What caused the error

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

E-Health

Reject person request

Purpose

Specification

Logic

Input parameters

Dictionaries

Request structure

Authorize

Headers

Request data validation

Validate person request

Processing

Change person request

Response structure

HTTP status codes