Required parameters are marked with "*"

...

Purpose

...

API paragraph not found

Specification

...

Page Properties
Link https://ehealthmedicaleventsapimedicaleventsmisapi.docs.apiary.io/#reference/service-requests/manage-service-requests/use-service-request Resource /api/service_requests/{{service_request_id}}/actions/use Scope service_request:use Components Service request Microservices API paragraph not found Protocol type REST Request type PATCH Sync/Async Async Public/Private/Internal Public

Logic

...

...

Input parameters

Request structure

...

See on Apiary

Example:

Expand
title Request example
Code Block { "used_by_employee": { "identifier": { "type": { "coding": [ { "system": "eHealth/resources", "code": "employee" } ] }, "value": "d5a5d991-0bf7-476f-b3cf-bec73f044b2e" } }, "used_by_legal_entity": { "identifier": { "type": { "coding": [ { "system": "eHealth/resources", "code": "legal_entity" } ] }, "value": "c5a6d991-0bf7-476f-b3cf-bec83f044b2a" } }, "used_by_division": { "identifier": { "type": { "coding": [ { "system": "eHealth/resources", "code": "division" } ] }, "value": "c5a6d991-0bf7-476f-b3cf-bec83f044b2a" } }, "program": { "identifier": { "type": { "coding": [ { "system": "eHealth/resources", "code": "medical_program" } ] }, "value": "9183a36b-4d45-4244-9339-63d81cd08d9c" } } }

Authorize

...

• Verify the validity of access token

  • Return return 401 (401, 'unauthorizedUnauthorized') in case of validation fails

• Verify that token is not expired

  • in case of error - return 401 (401, 'unauthorizedUnauthorized')

• Check user scopes in order to perform this action (scope = 'service_request:use')

  • Return 403 (

  403,

  • '

  invalid

  • Invalid scopes') in case of invalid scope(s)

• If BLOCK_UNVERIFIED_PARTY_USERS is true, then check party's data match following condition: verification_status != NOT_VERIFIED or (verification_status = NOT_VERIFIED and updated_at <= current_date - UNVERIFIED_PARTY_PERIOD_DAYS_ALLOWED)

Request to process the request using a token in the headers

...

• :

  •  in case not match - return 403 ("Access denied. Party is not verified")

Headers

Наприклад:

• Content-Type:application/json

• Authorization:Bearer mF_9.B5f-4.1JqM

• api-key:aFBLVTZ6Z2dON1V

Request data validation

...

Validate request using JSON Schema

...

Validate transition

Only active and unused (released) service request with a specified medical program can be used

1. Get service request by ID

2. Service request contains medical program

   1. $.program is NOT NULL

      1. in case of error return 409 "Service request without a program can not be used"

3. Service request must be valid by the expiration date

   1. $.expiration_date should be greater than or equal to current date

      1. in case of error return 409 "Service request is expired"

4. Service request must be active

   1. $.status  == "active"

      1. in case of error return 409 "

...

1. 1. 1. Can't use inactive service request

...

1. 1. 1. "

2. Service request must be unused

   1. $.used_by_legal_enity is empty object

      1. in case of error return 409 "Service request is already used"

3. Service request is not completed according to program_processing_status

   1. in case of error return 409 "Service request is already completed"

Validate program

1. Validate program is an existing service program (type=service)

   1. in case not found or is_active==false return 422  "Program not found"

   2. in case type!= service return 409 "Invalid program type"

2.  Service(or service_group) is an active member of the program

   1. Select request_allowed, is_active from PRM.program_services where service_id(or group_id) == $.signed_content.code.identifier.value and program_id=$.program.identifier.value

      1. if not found or is_active==false return 409 "Service is not included in the program"

3. Qualify service request

   1. if medical program exists in request 

      1.  invoke qualify for medical program in in use request

   2. if not exists

      1. invoke qualify in SR, if it is in SR

Validate request

1. Get token metadata

   1. Extract user_id, client_id, client_type

2. Ensure that employee belongs to client

   1. $.used_by_employee.identifier.type.coding[*].system == "eHealth/resources"

   2. $.used_by_employee.identifier.type.coding[*].code == "employee"

   3. $.used_by_employee.identifier.value must belong to client_id (prm.employees.legal_entity_id == :client_id)

      1. in case of error return 422 "You can assign service request only to employee within your legal entity"

3. Check employee_type

...

1. :

   1. in $.used_by_employee field validate employee_type:

      1. if service_request.category="laboratory_procedure",

...

1. 1. 1. "diagnostic_procedure" OR "procedure" check employee_type == DOCTOR, SPECIALIST, ASSISTANT OR LABORANT

      2. else  employee_type == DOCTOR OR SPECIALIST

         1. in case of error, return 422 "Invalid employee type"

2. Validate used_by_legal_entity is a current legal_entity

   1. $.used_by_legal_entity.identifier.value==token.client_id

      1. in case of error return 409 "You can assign service request only to your legal entity"

3. Validate used_by_division

   1. if SR.category = hospitalization

      1. validate used_by_division is sent, in case error return 422, "Division is mandatory for $category category"

      2. validate used_by_division.legal_entity_id = used_by_legal_entity_id

   2.  Is SR.category = transfer_of_care

      1. validate used_by_division is sent, in case error return 422, "Division is mandatory for $category category"

      2. Validate $division.legal_entity_id = SR.Performer, in case error return 422, "Patient is transferred to another legal entity"

Validate reuse allowed

If service request has already been used by legal entity and another legal entity wants to reuse it, then check the period for the prohibition of reuse has passed:

1. If used_by_legal_entity is different from current legal_entity:

...

1. 1. Get the latest entity from used_by_legal_entity_history.

   2. Compare that the difference (in minutes) between the current datetime and inserted_at of the latest entity is greater than the SERVICE_REQUEST_REUSE_AFTER_MINUTES chart param. Сonsider that the SERVICE_REQUEST_REUSE_AFTER_MINUTES is equal to zero minutes if it is empty or absent.

      1. in case it less - return 409 error “Reuse is temporarily blocked. It will be allowed after <SERVICE_REQUEST_REUSE_AFTER_MINUTES - difference> minutes“

Processing

Service logic

1. Update service request attributes

   1. Set Medical Events DB: 

      1. If used_by_employee exists in requests set service_requests[<id>].used_by_employee = Request: $.used_by_employee

      2. set service_requests[<id>].used_by_legal_entity = Request: $.used_by_legal_entity

   2. if medical program exists in request

      1. Set Medical Events DB: service_requests[<id>].medical_program = Request: $.medical_program.identifier.value

2. Fill program_processing_status_history

3. Change program_processing_status to `in_queue`

4. Change program_processing_status to `in_progress`

5. Fill used_by_legal_entity_history

6. Fill used_by_employee_history

Response structure

...

See on Apiary

Example:

Expand
title Response example
Code Block { "data": { "status": "pending", "eta": "2018-08-02T10:45:16.000Z", "links": [ { "entity": "job", "href": "/Jobs/NBXk9EyErUZv1RhXgyvgg" } ] }, "meta": { "code": 202, "url": "http://example.com/resource", "type": "object", "request_id": "req-adasdoijasdojsda" } }

Post-processing processes

...

API paragraph not found

HTTP status codes

...

Page Properties
HTTP status code Message What caused the error  202  Response    401 Unauthorized 403 Invalid scope 409 Validation error 422 Validation error