Versions Compared

Version Old Version 8 New Version 9
Changes made by

Anzhela Kovalenko (SoE eHealth)

Anzhela Kovalenko (SoE eHealth)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Note

Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою.

...

Page Properties
idpage_properties_method_REST API

Document type

Метод REST API

Document title

[DRAFT] Cancel Service request [API-007-010-001-0312]

Guideline ID

GUI-0011

Author

@

Document version

1

Document status

DRAFT

Date of creation

ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD)

Date of update

ХХ.ХХ.ХХХХ (дата зміни версії)

Method API ID

API-007-010-001-0312

Microservices (namespace)

ME

Component

Service request

Component ID

COM-007-010

Link на API-специфікацію

https://medicaleventsmisapi.docs.apiary.io/#reference/service-requests/manage-service-requests-in-patient-context/cancel-service-request

Resource

{{host}}/api/patients/{{id}}/service_requests/{{id}}/actions/cancel

Scope

service_request:cancel

Protocol type

REST

Request type

PATCH

Sync/Async

Async(def)/Sync

Public/Private

Public

...

  1. Save signed content to media storage

  2. Update service request status to entered_in_error (update also updated_at, updated_by)

  3. Write record to status history

  4. Send SMS to patient (if authentication_method_current == SMS, do NOT send sms in case performer is present in SR)

    1. Template - TBD

  5. Async! Revoke all approvals made by this service request

  6. if the service request is based on the activity with quantity:

    1. Recalculate and set remaining_quantity for the activity as described at PreQualify Service Request | Validate service request

...

Dictionaries

N/A

Input parameters

Input parameter

Mandatory

Type

Description

Example

1

2

Request structure

See on API-specification

...

Expand
titleResponse Example
Code Block
languagejson
{
  "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"
  }
}

HTTP status codes

Response code

HTTP Status code

Message

Internal name

Description

1

Базові

2

201

Use payload from response

sync

3

202

Use Get job details to get processing result. Response payload will be returned in the job details

async: default method

4

403

Access denied. Party is not verified

5

403

Access denied. Party is deceased

6

403

Invalid scopes

7

409

Action is not allowed for the legal entity

8

409

Only an employee from legal entity where service request is created can cancel service request

9

409

Service request in status %status% cannot be canceled

10

422

Signed content doesn't match with previously created service request

11

422

Value is not allowed in enum

12

Специфічні

13

Post-processing processes

N/A

Technical modules where the method is used

...

modules where the method is used

Page Properties Report
headingsID ТМ, Статус
cqllabel = "tr-mis"

...