Purpose 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.
Related information
(Deprected) IL.Sign declaration request
Specification
Link
https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/declaration-requests/sign-declaration-request-v3
Посилання на Apiary або Swagger
Resource
/api/v3/declaration_requests/{{id}}/actions/sign
Посилання на ресурс, наприклад: /api/persons/create
Scope
declaration_request:sign
Scope для доступу
Components
Declarations
Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription
Microservices
API paragraph not found
Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC
Protocol type
REST
Тип протоколу, який використовується запитом, наприклад: SOAP | REST
Request type
PATCH
Тип запиту API, наприклад: GET, POST, PATCH…
Sync/Async
Async
Метод є синхронним чи асинхронним?
Public/Private/Internal
Public
Потрібно зазначити тип методу за ступенем доступності
Logic Only authenticated and authorized user can use this service
Only APPROVED declaration request can be signed
The request can be signed only by the employee who works in the same legal entity in which the request was made.
Input parameters Request structure See on Apiary
Request example
{
"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 Verify the validity of access token
Return 401 in case validation fails
Check scopes in order to perform this action (scope = 'declaration_request:sign ')
Return 403 in case invalid scope(s)
Headers
Request data validation Digital signature Decode content that is encrypted in an electronic digital signature. Use Digital signature WS. Method checks digital signature and returns result. See service specification
Validate DRFO Check that DRFO in Certificate details exists and not empty
Check that DRFO in Certificate details is equal to DRFO in Party
Get party.tax_id using employee_id in person payload
Compare DRFO in Certificate with party.tax_id
Convert DRFO and TAX_ID to uppercase
Compare DRFO and TAX_ID as Cyrillic letters
Convert DRFO to Cyrillic and compare as Cyrillic letters
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 Validate request using JSON schema (See specification )
In case validation fails - generate 422 error
Check declaration request status
If status is not APPROVED, - returned error 'Incorrect status'
Validate person verification status Validate Parent declaration Get parent_declaration_id from IL_DB.declaration_requests.parent_declaration_id.
Check signed content Check decoded signed content with previously created on IL.db.
SELECT data.data_to_be_signed
FROM declaration_requests
WHERE id = {:id}
In case if they are not equal - generate 422 error (message: "Signed content does not match the previously created content")
Check employee Declaration_request can be signed by any employee with necessery scopes in equal legal_entity_id.
Extract legal_entity_id (client_id) from token
Extract employee_id from request
Check if $.client_id=employees.legal_entity_id
in case error return 422
Check patient_signed flag If "patient_signed" is not present in request, return 422 ("required property patient_signed was not present")
If "patient_signed"=false in request, return 422 ("Patient must sign declaration form")
If “patient_signed”=null, check that parent_declaration_id is not null,
Validate human readable declaration number Search declaration_number in declarations.declaration_number.
Processing Save signed declaration to media storage Get url for declaration upload. Use Request a Secret WS
Parameter
Source
action'GET'bucket'DECLARATIONS'resource_id: DECLARATION_IDresource_name: DECLARATION_NAME
Upload signed declaration to media storage
Update declaration request: Change entity status in IL_DB.declaration_request to SIGNED
Set updated_at - now() (Get current date-time)
Set updated_by - user_id (Extract user from token)
Get active declarations Search for active declarations using MPI ID
If found, - terminate them and create new declaration.
Terminate declaration In case active declarations found - terminate all by changing status to INACTIVE.
In case parent_declaration_id of declaration request is not null - terminate parent_declaration with reason reason = 'auto_reorganization'.
Create declaration Check authentication_method_current
If "type" = "OFFLINE"
set declaration status to "PENDING_VERIFICATION"
set reason to 'offline'
if "type" = "OTP" - set declaration status to "ACTIVE"
if "type" = "NA" - check parent_declaration_id, if not null than set declaration status to "ACTIVE"
Check persons 'no_tax_id' flag
if 'no_tax_id'=true and parent_declaration_id is null
set declaration status to "PENDING_VERIFICATION"
set reason to 'no_tax_id'
if ‘no_tax_id’=true and parent_declaration_id is not null - set declaration status to "ACTIVE"
Create a new declaration by adding a new entity to the declarations table ops_db without declaration_id.
if there is existing record in the declarations table with the same id and declaration_request_id, return ok to IL
Response structure See on Apiary
Post-processing processes API paragraph not found
HTTP status codes