Table of Contents

minLevel	1
maxLevel	3

Purpose

...

Method to resend sms on service request.

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

Logic

...

Method to resend sms on service request. It can be processed in both sync and async methods depends on Server decision.
...
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:

Expand

title	Request 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 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')
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 mF_9.B5f-4.1JqM
api-key:aFBLVTZ6Z2dON1V

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

Processing

...

Service logic

Update program_processing_status to "completed"
Update status history
Save completed_with to service_request

Response structure

...

See on Apiary

Example:

Expand

title	Response example

Code Block

{
  "data": {
    "id": "90a9e15b-b71b-4caf-8f2e-ff247e8a5600",
    "requisition": "AX654654T",
    "status": "active",
    "program": {
      "identifier": {
        "type": {
          "coding": [
            {
              "system": "eHealth/resources",
              "code": "medical_program"
            }
          ]
        },
        "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
      },
      "display_value": "null"
    },
    "program_processing_status": "new",
    "status_history": [
      {
        "status": "closed",
        "status_reason": {
          "coding": [
            {
              "system": "eHealth/service_request_recall_reasons",
              "code": "cured"
            }
          ]
        },
        "inserted_at": "2018-08-02T10:45:16.000Z"
      }
    ],
    "program_processing_status_history": [
      {
        "program_processing_status": "new",
        "inserted_at": "2018-08-02T10:45:16.000Z",
        "inserted_by": "f7bdce4c-9d6e-4b08-913c-97c4b972f9be"
      }
    ],
    "program_service": {
      "identifier": {
        "type": {
          "coding": [
            {
              "system": "eHealth/resources",
              "code": "program_service"
            }
          ]
        },
        "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
      },
      "display_value": "null"
    },
    "intent": "order",
    "priority": "routine",
    "based_on": [
      {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "care_plan"
              }
            ]
          },
          "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
        }
      },
      {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "activity"
              }
            ]
          },
          "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
        }
      }
    ],
    "category": {
      "coding": [
        {
          "system": "eHealth/SNOMED/service_request_categories",
          "code": "409063005"
        }
      ]
    },
    "code": {
      "identifier": {
        "type": {
          "coding": [
            {
              "system": "eHealth/resources",
              "code": "service"
            }
          ]
        },
        "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
      },
      "display_value": "null"
    },
    "subject": {
      "identifier": {
        "type": {
          "coding": [
            {
              "system": "eHealth/resources",
              "code": "patient"
            }
          ]
        },
        "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
      },
      "display_value": "null"
    },
    "context": {
      "identifier": {
        "type": {
          "coding": [
            {
              "system": "eHealth/resources",
              "code": "encounter"
            }
          ]
        },
        "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
      },
      "display_value": "null"
    },
    "occurrence_period": {
      "start": "2018-08-02T10:45:16.000Z",
      "end": "2018-08-02T11:00:00.000Z"
    },
    "requester_employee": {
      "identifier": {
        "type": {
          "coding": [
            {
              "system": "eHealth/resources",
              "code": "employee"
            }
          ]
        },
        "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
      },
      "display_value": "null"
    },
    "requester_legal_entity": {
      "identifier": {
        "type": {
          "coding": [
            {
              "system": "eHealth/resources",
              "code": "legal_entity"
            }
          ]
        },
        "value": "75a6d991-0bf7-476f-b3cf-bec83f044b2a"
      },
      "display_value": "null"
    },
    "reason_references": [
      {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "condition"
              }
            ]
          },
          "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
        },
        "display_value": "null"
      }
    ],
    "supporting_info": [
      {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "episode_of_care"
              }
            ]
          },
          "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
        },
        "display_value": "null"
      }
    ],
    "note": "Some notes",
    "patient_instruction": "Some patient instructions",
    "expiration_date": "2018-08-02T10:45:16.000Z",
    "permitted_resources": [
      {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "episode_of_care"
              }
            ]
          },
          "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
        },
        "display_value": "null"
      }
    ],
    "used_by_employee": {
      "identifier": {
        "type": {
          "coding": [
            {
              "system": "eHealth/resources",
              "code": "legal_entity"
            }
          ]
        },
        "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
      },
      "display_value": "null"
    },
    "inserted_at": "2018-08-02T10:45:16.000Z",
    "updated_at": "2018-08-02T10:45:16.000Z",
    "completed_with": {
      "identifier": {
        "type": {
          "coding": [
            {
              "system": "eHealth/resources",
              "code": "diagnostic_report"
            }
          ]
        },
        "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
      },
      "display_value": "null"
    },
    "used_by_legal_entity": {
      "identifier": {
        "type": {
          "coding": [
            {
              "system": "eHealth/resources",
              "code": "legal_entity"
            }
          ]
        },
        "value": "c5a6d991-0bf7-476f-b3cf-bec83f044b2a"
      },
      "display_value": "null"
    },
    "performer": {
      "identifier": {
        "type": {
          "coding": [
            {
              "system": "eHealth/resources",
              "code": "legal_entity"
            }
          ]
        },
        "value": "c5a6d991-0bf7-476f-b3cf-bec83f044b2a"
      },
      "display_value": "Опанасенко Олексій Володимирович"
    },
    "location_reference": {
      "identifier": {
        "type": {
          "coding": [
            {
              "system": "eHealth/resources",
              "code": "division"
            }
          ]
        },
        "value": "c5a6d991-0bf7-476f-b3cf-bec83f044b2a"
      },
      "display_value": "null"
    },
    "performer_type": {
      "coding": [
        {
          "system": "SPECIALITY_TYPE",
          "code": "DIETETICS"
        }
      ]
    }
  },
  "meta": {
    "code": 201,
    "url": "http://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  }
}

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
201
use payload from response
sync
202
use Get job details to get processing result. Response payload will be returned in the job details
async: default method
...

Versions Compared

Old Version 25

New Version 26

Key

Purpose

Method to resend sms on service request.

Specification

Logic

Method to resend sms on service request. It can be processed in both sync and async methods depends on Server decision.
...
Input parameter
Values
Type
Description
Example
service_request_id
String
Unique service request identifier
`aff00bf6-68bf-4b49-b66d-f031d48922b3`

Request structure

Authorize

Headers

Наприклад:
Content-Type:application/json
Authorization:Bearer mF_9.B5f-4.1JqM
api-key:aFBLVTZ6Z2dON1V

Request data validation

Validate legal entity

Processing

Service logic

Response structure

Post-processing processes

API paragraph not found

HTTP status codes

Page Properties
HTTP status code
Message
What caused the error
201
use payload from response
sync
202
use Get job details to get processing result. Response payload will be returned in the job details
async: default method
...

Page Comparison

Versions Compared

Old Version 25

New Version 26

Key

Purpose

Method to resend sms on service request.

Specification

Logic

Method to resend sms on service request. It can be processed in both sync and async methods depends on Server decision. ...Input parameterValuesTypeDescriptionExampleservice_request_idStringUnique service request identifieraff00bf6-68bf-4b49-b66d-f031d48922b3

Request structure

Authorize

Headers

Наприклад:Content-Type:application/jsonAuthorization:Bearer mF_9.B5f-4.1JqMapi-key:aFBLVTZ6Z2dON1V

Request data validation

Validate legal entity

Processing

Service logic

Response structure

Post-processing processes

API paragraph not found

HTTP status codes

Page PropertiesHTTP status codeMessageWhat caused the error 201use payload from responsesync 202use Get job details to get processing result. Response payload will be returned in the job detailsasync: default method...

Method to resend sms on service request. It can be processed in both sync and async methods depends on Server decision.
...
Input parameter
Values
Type
Description
Example
service_request_id
String
Unique service request identifier
`aff00bf6-68bf-4b49-b66d-f031d48922b3`

Наприклад:
Content-Type:application/json
Authorization:Bearer mF_9.B5f-4.1JqM
api-key:aFBLVTZ6Z2dON1V

Page Properties
HTTP status code
Message
What caused the error
201
use payload from response
sync
202
use Get job details to get processing result. Response payload will be returned in the job details
async: default method
...