Related information

IL.Sign declaration request

Required parameters are marked with "*"

...

Purpose

...

This method is used to sign Declaration Request

Key features

1. Only authenticated and authorized user can use this service

2. Only APPROVED declaration request can be signed

3. The request can be signed only by the employee who works in the same legal entity in which the request was made.

Specification

...

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

...

	Async
Public/Private/Internal	Public

Logic

The process is initiated by any employee with necessary scopes in this legal entity and involves the transfer of a signed person with electronic digital signature. 

Process is asynchronous. If all validations are successfully completed, the asynchronous process of creating a person starts by processing the message.

1. Only authenticated and authorized user can use this service

2. Only APPROVED declaration request can be signed

3. The request can be signed only by the employee who works in the same legal entity in which the request was made.

Method receives signed message (pkcs7) including signed content, digital signature and signer public key in signed_content property. All signature fields will be validated (including signer certificate authority).

...

Declaration request can be signed either by doctor or admin (user with scope declaration_request:sign) from legal entity as in declaration request.

❗ Important

Invoke Get Declaration Request by ID to obtain seed - Hash of previous block in declarations chain or other random component that should be signed with declaration.

There is a dummy method that describes the signed date example.

Preconditions

Digital signature

...

Request structure

...

See on Apiary

This request contains base64 coded content which was signed by digital sign. There is a dummy method that describes the signed date example.

Code Block

{ "signed_declaration_request": "{
  "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": "THIRD_PERSON",
        "value": "+380508887700",
        "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": true,
    "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

...

1. Verify the validity of access token

   1. Return 401 in case validation fails

2. Check scopes in order to perform this action (scope = 'declaration_request:sign')

   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

Processing

...

Validate DRFO

1. Check that DRFO in Certificate details exists and not empty

2. Check that DRFO in Certificate details is equal to DRFO in Party

   1. Get party.tax_id using employee_id in person payload

   2. Compare DRFO in Certificate with party.tax_id

      1. Convert DRFO and TAX_ID to uppercase

      2. Compare DRFO and TAX_ID as Cyrillic letters

      3. Convert DRFO to Cyrillic and compare as Cyrillic letters

   3. In case validation fails - generate 422 error

Latin to Cyrillic mapping

%{"A" => "А", "B" => "В", "C" => "С", "E" => "Е", "H" => "Н", "I" => "І", "K" => "К", "M" => "М", "O" => "О", "P" => "Р", "T" => "Т", "X" => "Х"}

Validate request

1. Validate request using JSON schema

...

1. 1. In case validation fails - generate 422 error

2. Check declaration request status

   1. If status is not APPROVED, - returned error 'Incorrect status'

Validate person verification status

• validate patient's verification_status is not equal to NOT_VERIFIED.

  • in case of error return 409, "Patient is not verified"

Check signed content

Check decoded signed content with previously created on IL.db.

...

Declaration_request can be signed by any employee with necessery scopes in equal legal_entity_id.

1. Extract legal_entity_id (client_id) from token

2. Extract employee_id from request

3. Check if $.client_id=employees.legal_entity_id 

   1. in case error return 422 

Check patient_signed flag

...

Save signed declaration to media storage

1. Get url for declaration upload.
   Use Request a Secret WS

   Parameter

   Source

   action'GET'bucket'DECLARATIONS'resource_id: DECLARATION_IDresource_name: DECLARATION_NAME

2. Upload signed declaration to media storage

Update declaration request:

1. Change entity status in IL_DB.declaration_request to SIGNED

2. Set updated_at - now() (Get current date-time)

3. Set updated_by - user_id (Extract user from token)

Get active declarations

Search for active declarations using MPI ID

1. If found, - terminate them and create new declaration.

   • If not found - create new declaration.

Terminate declaration

In case active declarations found - terminate all by changing status to INACTIVE.

Create declaration

1. Check authentication_method_current

   Code Block
   SELECT authentication_method_current FROM declaration_requests WHERE id = {:id}

   1. If "type" = "OFFLINE"

      1.  set declaration status to "PENDING_VERIFICATION"

      2. set reason to 'offline'

   2. if "type" = "OTP" - set declaration status to "ACTIVE" 

2. Check persons 'no_tax_id' flag

   1. if 'no_tax_id'=true 

      1. set declaration status to "PENDING_VERIFICATION"

      2. set reason to 'no_tax_id'

3. Create a new declaration by adding a new entity to the declarations table ops_db without declaration_id.

   1. if there is existing record in the declarations table with the same id and declaration_request_id, return ok to IL

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", "signed_at": "2017-03-02T00:00:00.000Z", "status": "active", "declaration_request_id": "74a6fae6-4207-4e03-a136-f2e70c6b0c02", "person_id": "5fb57a5d-1457-430e-9678-c81cec72779f", "legal_entity_id": "b075f148-7f93-4fc2-b2ec-2d81b19a9b7b", "employee_id": "d290f1ee-6c54-4b01-90e6-d701748f0851", "division_id": "d290f1ee-6c54-4b01-90e6-d701748f0851", "inserted_at": "2017-07-06T16:54:05.161571Z", "is_active": true, "reason": "manual_employee", "reason_description": "Згідно постанови 1 від 10.01.2017" } }

Post-processing processes

...

API paragraph not found

HTTP status codes

...