ЕСОЗ - публічна документація
Sign person request
- 1 Purpose
- 1.1 Key features
- 2 Specification
- 3 Preconditions
- 4 Input parameters
- 5 Request structure
- 6 Authorize
- 7 Headers
- 8 Request data validation
- 9 Processing
- 10 Response structure
- 11 HTTP status codes
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 synchronous. If all validations are successfully completed, the synchronous process of creating a person starts by processing the message.
Key features
Only authenticated and authorized user can use this service
Only APPROVED patient 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.
Specification
Link | Посилання на Apiary або Swagger | |
Resource | /api/person_requests/{{id}}/actions/sign | Посилання на ресурс, наприклад: /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 |
|
Preconditions
Person request must be approved.
Input parameters
Input parameter | Values | Type | Description | Example |
---|---|---|---|---|
id |
| String | Required | eeebb86d-5cba-43c9-885b-6482ecaf826b |
Request structure
Example:
Authorize
Verify the validity of access token
Return (401, 'Invalid access token') in case of validation fails
Verify that token is not expired
in case of error - return (401, 'Invalid access token')
Check user scopes in order to perform this action (scope = 'person_request:write')
Return (403, 'Your scope does not allow to access this resource. Missing allowances: person_request:write') in case of invalid scope(s)
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.
Headers
Content-Type:application/json
Authorization:Bearer {{access_token}}
api-key:{{secret}}
mds_drfo:{{secret}}
Request data validation
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 patient request status
If status is not APPROVED, - returned error 'Incorrect status'.
Check signed content
Check decoded signed content with previously created on IL.db.
SELECT data
FROM patient_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 legal entity id
Patient request can be signed by any employee with necessary scopes in equal legal_entity_id.
Check that ID in URL exists in the system
Return 401 in case validation fails
Check that patient request belongs to the same legal entity as the user
In case of error - return 403
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 ("value is not allowed in enum")
Processing
Update patient request
Update patient request:
Change entity status in IL_DB.patient_request to SIGNED
Set updated_at - now() (Get current date-time)
Set updated_by - user_id (Extract user from token)
Create person
After singed patient request create new person on DB.mpi.
Calculate the end date of the person_aus_method and set as default
These params set only if person is creating (so after Create person request)
If person has auth_method = third_person
, add in table person_auth_methods
row with type = THIRD_PERSON
, value = id (third_person_id), alias
Calculate term of person_authentication_method:
Start date: start_date = Current_date()
End date:
if (person.age < prm.global_parameters.no_self_auth_age) { end_date = end_date =birth_date + prm.global_parameters.no_self_auth_age - 1d; } else { end_date = start_date + third_person_term; } |
Also to table person_auth_methods add this method as default(field `default` = TRUE) - it's for all auth_method.type
Check if Person should be sent for verification
Please note, (GraphQL) Update person refers to this validation.
if person’s data match any of the following rules:
validate all Rules 01-05
Person has OFFLINE auth method
if create Person process, check Request
if update Person process, check within MPI.person_athentication_methods tablePerson's age >= no_self_auth_age and no_tax_id = true (check in Request)
Person's age >= no_self_auth_age and Person’s tax_id is invalid (i.e. not match with birth date or gender or invalid checksum) (check in Request)
Person’s age < no_self_auth_age and has document with type BIRTH_CERTIFICATE_FOREIGN (check in Request)
Person’s age >= no_self_auth_age and has document with type PERMANENT_RESIDENCE_PERMIT (check in Request)
then
manual verification is needed
Set
MPI.persons.verification_status
=VERIFICATION_NEEDED
andSet
MPI.persons.verification_reason
=RULES_TRIGGERED
andCreate StateChangeEvent in event manager with new verification status
else
person will be verified with Registers
Set
MPI.persons.verification_status
=VERIFICATION_NEEDED
andSet
MPI.persons.verification_reason
=RULES_PASSED
andSet
MPI.persons.verification_comment
=NULL
andCreate StateChangeEvent in event manager with new verification status
Submit person on verification
Please note, (GraphQL) Update person refers to this section.
Create or update existing record in person_verifications table for a person according to logic in sections below. Also, set:
updated_at = now()
updated_by = user uuid
inserted_at = now() (for new records)
inserted_by = user uuid (for new records)
Manual NHS verification
If person’s data match any of the following rules:
Person has OFFLINE auth method
if create Person process, check Request
if update Person process, check within MPI.person_athentication_methods tablePerson's age >= no_self_auth_age and no_tax_id = true (check in Request)
Person's age >= no_self_auth_age and Person’s tax_id is invalid (i.e. not match with birth date or gender or invalid checksum) (check in Request)
Person’s age < no_self_auth_age and has document with type BIRTH_CERTIFICATE_FOREIGN (check in Request, within $.person.documents and $.person.confidant_person[:].documents_relationship[:])
Person’s age >= no_self_auth_age and has document with type PERMANENT_RESIDENCE_PERMIT (check in Request)
then manual verification is needed. Set to person verification record:
nhs_verification_status = VERIFICATION_NEEDED
nhs_verification_reason = RULES_TRIGGERED
else manual verification is not needed. Set to person verification record:
nhs_verification_status = VERIFIED
nhs_verification_reason = RULES_PASSED
nhs_verification_comment = NULL
DRFO registry verification
Set to person verification record:
drfo_data_id = NULL
drfo_data_result = NULL
drfo_synced_at = NULL
drfo_verification_status = VERIFICATION_NEEDED
drfo_verification_reason = ONLINE_TRIGGERED
Then person will be verified online with DRFO registry via separate process: DRFO data synchronization for Persons
DRACS death acts registry verification
Set to person verification record as ready for online verification with DRACS death acts registry:
dracs_death_verification_status = VERIFICATION_NEEDED
dracs_death_verification_reason = ONLINE_TRIGGERED
dracs_death_online_status = READY
Then person will be verified online with DRACS death acts registry via separate process: Online verification of Persons with DRACS death acts registry_EN
Calculate cumulative verification status
Calculate persons cumulative verification status based on persons verification status in each stream: Manual NHS verification, DRFO registry verification, DRACS death acts registry verification according to logic described at Person verification status model_EN :
Set calculated status to persons.verification_status field
Create StatusChangeEvent in event manager with new verification status
Response structure
Example:
HTTP status codes
HTTP status code | Message | What caused the error |
---|---|---|
200 | Response |
|
401 | Error | Access token validation failed Check that ID in URL exists in the system failed |
403 | Invalid scope Error | Check that patient request belongs to the same legal entity as the user failed |
422 | Value is not allowed in enum Required property patient_signed was not present Signed content does not match the previously created content Error | Validation of the request using JSON schema failed |
ЕСОЗ - публічна документація