Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
minLevel1
maxLevel3

Purpose

Method to resend sms on service requestThis WS is designed to use Service request after providing services.

Specification

Page Properties

Link

https://medicaleventsmisapi.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

...

Expand
titleRequest example
Code Block
{
  "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 error - return 401 (“Invalid access token”) in case of validation fails

  • Verify that token is not expired

    • in case of error - return (401, 'unauthorized'401 (“Invalid access token”)

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

    • return 403 (“Your scope does not allow to access this resource. Missing allowances: service_request:

    complete')Return (403, 'invalid scopes')
    • complete”) 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}

...

  • 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"

    2. $.program_service should be only as a service (check that PRM.program_service.service_id IS NOT NULL)

      1. in case of error return 422 "Program service with service group is not allowed for completing current resource"

  • 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"

...