Purpose

...

This WS intended to get a list of patient approvals filtered by search params.

Specification

...

Page Properties
Link https://medicaleventsmisapi.docs.apiary.io/#reference/approvals/get-approvals/get-approvals Resource /api/patients/{{patient_id}}/approvals Scope approval:read Components Approvals Microservices API paragraph not found Protocol type REST Request type GET Sync/Async Async Public/Private/Internal Public

Logic

...

Method for receiving a list of patient approvals. It is allowed only for the doctor who has an active declaration with a patient from url (can get all approvals) or approval is granted to user (can get own approval).

...

Filter	Values	Type	Description	Example
patient_id		String	identifier of the patient	7c3da506-804d-4550-8993-bf17f9ee0402
granted_to		String	identifier of the employee or legal entity to whom access has been granted	7c3da506-804d-4550-8993-bf17f9ee0402
granted_resources		String	identifier of the entity for which the approval was created	7c3da506-804d-4550-8993-bf17f9ee0400
granted_resource_type		String	entity type for which the approval was created	diagnostic_report
status		String	status of approval	active
reason		String	type and identifier of entity based on which approval has been created	7c3da506-804d-4550-8993-bf17f9ee0401
access_level		String	access level to data	read
page		Number	Page number	2
page_size		Number	A limit on the number of objects to be returned, between 1 and 100. Default: 50	50

Request structure

...

API paragraph not found

Authorize

...

• Verify the validity of access token

  • Return (401, 'Invalid access token') in case of validation fails

• Verify that token is not expired

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

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

  • Return (403, 'Your scope does not allow to access this resource. Missing allowances: approval:read') in case of invalid scope(s)

Request to process the request using a token in the headers

Headers

...

Наприклад:

• Content-Type:application/json

• Authorization:Bearer c2778f3064753ea70de870a53795f5c9

• api-key:uXhEczJ56adsfh3Ri9SUkc4en

Request data validation

...

Validate Patient

• Get Patient identifier from the URL

• Check it exists in DB

  • Return 404 ('Person is not found') in case of error

...

• Extract user_id from token.

• Check user has an active declaration with a patient from URL (can get all approvals) or approval is granted to user (can get own approval):

  • Return 200 with empty array in case the employee doesn't have an active declaration with the patient or approval is granted to user

Processing

...

Service logic

Service returns all approvals related to the patient filtered by submitted parameters:

• Get all approvals by patient_id from approvals collection (MongoDB)

• Filter list above by submitted search parameters

• Render a response according to specification.

Response structure

...

See on Apiary

Example:

Expand
title Response example
Code Block { "meta": { "code": 200, "url": "http://example.com/resource", "type": "object", "request_id": "req-adasdoijasdojsda" }, "data": { "id": "d5a5d991-0bf7-476f-b3cf-bec73f044b2e", "granted_resources": [ { "identifier": { "type": { "coding": [ { "system": "eHealth/resources", "code": "episode_of_care" } ] }, "value": "d5a5d991-0bf7-476f-b3cf-bec73f044b2e" }, "display_value": "null" } ], "granted_to": { "identifier": { "type": { "coding": [ { "system": "eHealth/resources", "code": "employee" } ] }, "value": "9183a36b-4d45-4244-9339-63d81cd08d9c" }, "display_value": "null" }, "reason": { "identifier": { "type": { "coding": [ { "system": "eHealth/resources", "code": "service_request" } ] }, "value": "9183a36b-4d45-4244-9339-63d81cd08d9c" }, "display_value": "null" }, "status": "new", "access_level": "read" }, "paging": { "page": 2, "page_size": 50, "total_entries": 1000, "total_pages": 20 } }

Post-processing processes

...

API paragraph not found

HTTP status codes

...

Page Properties
HTTP status code Message What caused the error  200

...