Purpose

This WS is designed to return Device request details by identifier.

Specification

Link	https://ehealthmedicaleventsapi.docs.apiary.io/#reference/device-requests/get-device-request-details/get-device-request-details	Посилання на Apiary або Swagger
Resource	/api/patients/{{patient_id}}/device_requests/{{device_request_id}}	Посилання на ресурс, наприклад: /api/persons/create
Scope	`device_request:read`	Scope для доступу
Components	Devices	Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription
Microservices		Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC
Protocol type	REST	Тип протоколу, який використовується запитом, наприклад: SOAP \| REST
Request type	GET	Тип запиту API, наприклад: GET, POST, PATCH…
Sync/Async	Sync	Метод є синхронним чи асинхронним?
Public/Private/Internal	Public	Потрібно зазначити тип методу за ступенем доступності

Logic

Service returns specified Device requests related to the patient:

Get Device requests from device_request collection (MongoDB)
Validate data consistency:
1. Ensure that requested Device requests relates to requested Patient (from URL)
  1. Return 403 ('Access denied') in case of error
Fill in urgent block with current authentication method and verification_code field:
1. Get program from request and (if provided) get program setting request_notification_disabled
2. If person has OTP or THIRD_PERSON (with OTP) authentication method and request_notification_disabled = false/null (or absent), then set phone_number and verification_code=null
3. if person has OTP or THIRD_PERSON (with OTP) authentication method and request_notification_disabled = true, then set verification_code and phone_number
Render a response according to the specification
1. Calculate remaining quantity:
  1. Select all Device dispenses in status completed related to the Device request
  2. Sum quantity in the filtered Device dispenses as dispensed_qty
  3. Calculate remaining_quantity = requested_quantity- dispensed_quantity
2. Return remaining_quantity in the response
Fill in urgent block with current authentication method and verification_code field:
1. Get program from request and (if provided) get program setting request_notification_disabled
2. Get person authentication method according to logic:
  1. If inform_with exists in device request and is not empty, check:
    1. Authentication method exists in person_authentication_methods table in MPI DB (with is_active=true), is active (ended_at > now() or null)
    2. Get value of THIRD_PERSON_CONFIDANT_PERSON_RELATIONSHIP_CHECK config parameter, if it is set to true - for authentication method with type = THIRD_PERSON check that person from value is an approved confidant for a person from device request – exists active and approved confidant person relationship between person from request and confidant_person_id from authentication method value (using following logic: Check confidant person relationship with person_id = person from request and confidant_person_id = value from auth method - expected :ok, :approved response)
      1. in case any validation failed - set verification_code and phone_number=null
      2. else - get persons authentication method from inform_with
  2. if inform_with does not exist in device request or is empty - get default authentication method of person from MPI using Determination of a default authentication method and return person's active auth_methods
3. If person has OTP or THIRD_PERSON (with OTP) authentication method and request_notification_disabled = false/null (or absent), then set phone_number and verification_code=null
4. if person has OTP or THIRD_PERSON (with OTP) authentication method and request_notification_disabled = true, then set verification_code and phone_number
5. If person has OFFLINE authentication method (or doesn't have any active authentication method), then set verification_code and phone_number=null
Render a response according to the specification
1. Calculate remaining quantity:
  1. Select all Device dispenses with following parameters:
    - based_on is current Device request
    - status = completed, preparation
  2. Sum quantity in the filtered Device dispenses as dispensed_qty
  3. Calculate remaining_quantity = requested_quantity- dispensed_quantity
2. Return remaining_quantity in the response

Input parameters

Input parameter	Values	Type	Description	Example

Input parameter	Values	Type	Description	Example
patient_id		String	Unique patient identifier	`7075e0e2-6b57-47fd-aff7-324806efa7e5`
device_request_id		String	Unique device request identifier	`aff00bf6-68bf-4b49-b66d-f031d48922b3`

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 = 'device_request:read')
- Return (403, 'Your scope does not allow to access this resource. Missing allowances: device_request:read') in case of invalid scope(s)

Access to the resource is also managed by ABAC rules.

Headers

Content-Type:application/json
Authorization:Bearer mF_9.B5f-4.1JqM
api-key:aFBLVTZ6Z2dON1V

Response structure

See on Apiary

Example:

{
  "data": {
    "id": "90a9e15b-b71b-4caf-8f2e-ff247e8a5600",
    "intent": "order",
    "code": {
      "coding": [
        {
          "system": "device_definition_classification_type",
          "code": "30221"
        }
      ]
    },
    "quantity": {
      "value": 10,
      "system": "device_unit",
      "code": "piece",
      "unit": "шт"
    },
    "encounter": {
      "identifier": {
        "type": {
          "coding": [
            {
              "system": "eHealth/resources",
              "code": "encounter"
            }
          ]
        },
        "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
      },
      "display_value": "null"
    },
    "reason": [
      {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "condition"
              }
            ]
          },
          "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
        },
        "display_value": "null"
      }
    ],
    "requester": {
      "identifier": {
        "type": {
          "coding": [
            {
              "system": "eHealth/resources",
              "code": "employee"
            }
          ]
        },
        "value": "b4a6d991-0bf7-476f-b3cf-bec83f044b1b"
      },
      "display_value": "Мельник Микола Микитович"
    },
    "authored_on": "2000-01-01T00:00:00.000Z",
    "occurrence_period": {
      "start": "2000-01-01T00:00:00.000Z",
      "end": "2018-08-02T11:00:00.000Z"
    },
    "status": "active",
    "status_reason": {
      "coding": [
        {
          "system": "device_request_revoke_reasons",
          "code": "incorrect_patient"
        }
      ]
    },
    "subject": {
      "identifier": {
        "type": {
          "coding": [
            {
              "system": "eHealth/resources",
              "code": "patient"
            }
          ]
        },
        "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
      },
      "display_value": "null"
    },
    "requester_legal_entity": {
      "identifier": {
        "type": {
          "coding": [
            {
              "system": "eHealth/resources",
              "code": "legal_entity"
            }
          ]
        },
        "value": "c5a6d991-0bf7-476f-b3cf-bec83f044b2a"
      },
      "display_value": "Комунальне підприємство Медлаб"
    },
    "program": {
      "identifier": {
        "type": {
          "coding": [
            {
              "system": "eHealth/resources",
              "code": "medical_program"
            }
          ]
        },
        "value": "c5a6d991-0bf7-476f-b3cf-bec83f044b2a"
      },
      "display_value": "Доступні медичні вироби"
    },
    "requisition": "AX65-4654-TІВ1-ТВТ1",
    "dispense_valid_to": "2018-08-02T10:45:16.000Z",
    "note": "Some notes",
    "inserted_at": "2018-08-02T10:45:16.000Z",
    "updated_at": "2018-08-02T10:45:16.000Z"
  },
  "meta": {
    "code": 200,
    "url": "http://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "urgent": {
    "authentication_method_current": {
      "type": "OTP",
      "number": "+38093*****85"
    },
    "verification_code": null
  }
}

{
  "meta": {
    "code": 404,
    "url": "http://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "error": {
    "type": "NOT_FOUND",
    "message": "Device request not found"
  }
}

HTTP status codes

HTTP status code	Message	What caused the error

HTTP status code	Message	What caused the error
200
404

E-Health

RC_[UPD] Get Device request details