Table of Contents

minLevel	1
maxLevel	3

Required parameters are marked with "*"

...

Purpose*

This method must be used to cancel existing Service Request.

Specification*

...

Link

...

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

...

Resource

...

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

...

Scope

...

service_request:cancel

...

Components

...

Service request

...

Microservices

...

API paragraph not found

...

Protocol type

...

REST

...

Request type

...

PATCH

...

Sync/Async

...

Async

...

Public/Private/Internal

...

Public

Logic*

This method must be used to cancel existing Service Request. Method receives signed message (pkcs7) that consists of signed content, digital signature and signer public key. All signature fields will be validated (including signer certificate authority)

Important

Signed content of service request must be equal to service request stored in DB. See Get Service Request details
status_reason and explanatory_letter (optional) must be added to signed content

Please see Service request (Referral) state model and Dummy Cancel Service Request for more details

Scopes required: service_request:cancel

It can be processed in both sync and async methods depends on Server decision.

Request structure*

See on Apiary

Example:

Expand

title	Request example

Code Block
{ "signed_data": "ew0KICAicGVyaW9kIjogew0KIC..." }

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:cancel')

...

Table of Contents

minLevel	1
maxLevel	3

Purpose

This method must be used to cancel existing Service Request.

Specification

Page Properties

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

Logic

Відкликання направлення (entered in error)

This method must be used to cancel existing Service Request. Method receives signed message (pkcs7) that consists of signed content, digital signature and signer public key. All signature fields will be validated (including signer certificate authority)

Important

Signed content of service request must be equal to service request stored in DB. See Get Service Request details
status_reason and explanatory_letter (optional) must be added to signed content

Please see Service request (Referral) state model and Dummy Cancel Service Request for more details

Scopes required: service_request:cancel

It can be processed in both sync and async methods depends on Server decision.

Request structure

See on Apiary

Example:

Expand

title	Request example

Code Block
{ "signed_data": "ew0KICAicGVyaW9kIjogew0KIC..." }

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:cancel')
1. Return (403, '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):
- in case not match - return 403 ("Access denied. Party is not verified")
If BLOCK_DECEASED_PARTY_USERS is true, check that party is not deceased (party_verification record does not equal to: dracs_death_verification_status = VERIFIED and dracs_death_verification_reason = MANUAL_CONFIRMED):
- in case of error - return 403 ("Access denied. Party is deceased")

Request to process the request using a token in the headers

Headers

...

Наприклад:
Content-Type:application/json
Authorization:Bearer mF_9.B5f-4.1JqM: {{access_token}}
api-key: aFBLVTZ6Z2dON1V{{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 and nhs_verified = true
- in case of error return 409 "Action is not allowed for the legal entity"

...

Code Block
SELECT e.id FROM employees e WHERE e.party_id = :party_id AND e.legal_entity_id = :client_id;

~~2.4 Ensure that $.requester.identifier.value matches with user employees~~

Validate that DS belongs to the requester of encounter

...

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

Validate permission to cancel

Only doctor who signed this service request is able to cancel this service request

...

to cancel

Only doctor who signed this service request is able to cancel this service request

Implemented by DS validation (see Validate digital signature p.2)

Validate user

Canceling a Service Request is allowed for user if he has one of the following active and approved employee that:

is an Employee from legal entity where Service Request is created
- in case of error - return 409 ("Only an employee from legal entity where service request is created can cancel service request")

Validate transition

Only active service request can be canceled

Get current service request status
1. Check that status in ('active', 'completed')'completed')
  1. in case of error - return 409 error ('Service request in status %status% cannot be canceled')

Validate cancelation reason

Validate $.status_reason.code is a value from eHealth/service_request_cancel_reasons dictionary
1. in case of error - return
  409 error ('Service request in status %status% cannot be canceled')

...

1. 422 ("value is not allowed in enum")

Validate content

Signed content must match with service request in DB in order to be canceled

Render service request from DB
Exclude $.status_reason and $.explanatory_letter from signed content
Compare rendered service request and signed content
1. In case both object doesn't match - return 422 ('Signed content doesn't match with previously created service request')

Processing

...

Service logic

Save signed content to media storage
Update service request status to entered_in_error (update also updated_at, updated_by)
Write record to status history
Send SMS to patient (if authentication_method_current == SMS, do NOT send sms in case performer is present in SR)
1. Template - TBD
Async! Revoke all approvals made by this service request
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

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 23

New Version Current

Key

Required parameters are marked with "*"

Purpose*

Specification*

Logic*

Request structure*

Authorize*

Purpose

Specification

Logic

Request structure

Authorize

Headers

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

Request data validation

Validate legal entity

Validate permission to cancel

to cancel

Validate user

Validate transition

Validate cancelation reason

Validate content

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 23

New Version Current

Key

Required parameters are marked with "*"

Purpose*

Specification*

Logic*

Request structure*

Authorize*

Purpose

Specification

Logic

Request structure

Authorize

Headers

Наприклад:Content-Type:application/jsonAuthorization:Bearer mF_9.B5f-4.1JqM: {{access_token}}api-key: aFBLVTZ6Z2dON1V{{secret}}

Request data validation

Validate legal entity

Validate permission to cancel

to cancel

Validate user

Validate transition

Validate cancelation reason

Validate content

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

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

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