Purpose

Method to resend sms on service request.

Specification

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

Logic

Погашення направлення

Input parameters

Input parameter	Values	Type	Description	Example
service_request_id		String	Unique service request identifier	`aff00bf6-68bf-4b49-b66d-f031d48922b3`

Request structure

See on Apiary

Example:

Request example

{
  "completed_with": {
    "identifier": {
      "type": {
        "coding": [
          {
            "system": "eHealth/resources",
            "code": "diagnostic_report"
          }
        ]
      },
      "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
    }
  },
  "program_service": {
    "identifier": {
      "type": {
        "coding": [
          {
            "system": "eHealth/resources",
            "code": "program_service"
          }
        ]
      },
      "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
    }
  }
}

Authorize

Verify the validity of access token
- Return (401, 'unauthorized') in case of validation fails
Verify that token is not expired
- in case of error - return (401, 'unauthorized')
Check user scopes in order to perform this action (scope = 'service_request:complete')
1. Return (403, 'invalid scopes') in case of invalid scope(s)

Request to process the request using a token in the headers

Headers

Content-Type:application/json
Authorization:Bearer {token}
api-key:{secret}

Request data validation

Validate legal entity

Check legal entity type: it has to be in me_allowed_transactions_le_types config parameter, has status = active
- in case of error return 409 "Action is not allowed for the legal entity"

Validate request using JSON Schema

Return 422 with the list of validation errors in case validation fails

Validations

If service request has a program:
- Validate used_by_legal_entity
  1. ME.service_request.used_by_legal_enity.identifier.value=token.client_id
    1. in case of error return 409 "Service request is used by another legal entity"
- Validate program_processing_status
  1. ME.service_request.program_processing_status == "in_progress"
    1. in case of error return 409 "Invalid program processing status status"
- Validate completed_with
  1. $.completed_with as a Reference(encounter| diagnostic_report| procedure)
  2. if ME.service_request.category and resource according to config file
  3. $.completed_with.managing_organization== token.client_id
    1. Could not complete service request with an entity, created by another legal entity
  4. SR could be completed only with resource that referenced this SR
    1. in case error return 422, msg "$completed_with.code is not connected with this SR"
  5. If SR.category in ('hospitalization', 'transfer_of_care') validate resource is encounter.type = discharge
    1. in case error, return 422, "Service request with category $category could not be completed with current resource"
- Validate program_service exists
  1. $.program_service is an existing record from PRM.program_services where is_active=true
    1. in case of error return 422 "Program service does not exist"
- Validate that service code from completed with and from program service matches (except service requests where category in ('hospitalization', 'transfer_of_care')):
  1. if completed_with.identifier.type.coding[].code="diagnostic_report" or "procedure" than
    1. completed_with.code.identifier.value==program_service.service_id (enrich from ME and PRM)
  2. else if completed_with.identifier.type.coding[].code="encounter"
    1. if ME.service_request.code.identifier.type.coding[].code="service"
      1. ME.service_request.code.identifier.value==program_service.service_id (enrich from ME and PRM)
    2. if service_request.code.identifier.type.coding[].code="service_group"
      1. there is a record in status active in PRM.service_inclusions where PRM.service_inclusions.service_group_id=ME.service_request.code.identifier.value and PRM.service_inclusions.service_id=program_service.service_id
  3. in case of error return 409 "Services from program service and completed with does not match"
Else, if service request has no program:
1. Validate the service request has been referenced by at least one not entered_in_error procedure/encounter/diagnostic_report.
  1. in case of error - return 409 error ('Service request must be referenced by at least one procedure, encounter or diagnostic_report that is not entered_in_error ')
Validate status_reason filled according to eHealth/service_request_complete_reasons dictionary
1. in case system is another dictionary - return 422 error ('not allowed in enum')
2. in case code value is not active in corresponding dictionary - return 422 error ("Value is not active")

Validate transition

Check status is active and program_processing_status is new, in_queue, in_progress or absent.
1. in case of error - return 409 error ('Service request in status <status value> and program_processing_status <program_processing_status value> cannot be completed')

Processing

Service logic

Update program_processing_status to "completed" if it was not null
Update status to "completed"
Depending on changes update a status history and program_processing_status history
Save status_reason to service_request, including status_history
Save completed_with, program_service to service_request
If the service request is based on activity with quantity:
1. Recalculate and set remaining_quantity for the activity as described at PreQualify Service Request | Validate service request

Response structure