Purpose

This WS is designed to return records about Device requests in person context by search params.

This method returns all device requests related to specified patient.

Specification

Link	https://ehealthmedicaleventsapi.docs.apiary.io/#reference/device-requests/get-device-requests-by-search-params/get-device-requests-by-search-params	Посилання на Apiary або Swagger
Resource	/api/patients/{{patient_id}}/device_requests	Посилання на ресурс, наприклад: /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 all Device requests related to the person filtered by submitted parameters:

Get all Device requests by person_id from device_requests collection (Mongo database)
Validate data consistency:
- Ensure that requested Device requests have ABAC context
  - Return 403 ('Access denied') in case of error
Filter list above by submitted search parameters
Render a response according to specification with found Device requests entities.

Filters

Filter	Type	Description	Example
patient_id	String	Unique patient identifie	`7075e0e2-6b57-47fd-aff7-324806efa7e5`
status	String		`active`
code	String		`30222`
requester_legal_entity	String		`7075e0e2-6b57-47fd-aff7-324806efa7e5`
requester	String		`7075e0e2-6b57-47fd-aff7-324806efa7e5`
encounter	String		`7075e0e2-6b57-47fd-aff7-324806efa7e5`
program	String		`7075e0e2-6b57-47fd-aff7-324806efa7e5`
context_episode_id	String	Unique episode identifier	`ef30f210-5328-4f48-bfe6-c7150d4737a6`

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 = '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

Request data validation

API paragraph not found

Processing

API paragraph not found

Response structure

See on Apiary

Example:

Response example

{
  "meta": {
    "code": 200,
    "url": "http://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "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"
    }
  ],
  "paging": {
    "page": 2,
    "page_size": 50,
    "total_entries": 1000,
    "total_pages": 20
  }
}

Response example

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

HTTP status codes

HTTP status code	Message	What caused the error
200
404

Get Device requests by search params

Purpose

Specification

Logic

Filters

Request structure

Authorize

Headers

Request data validation

Processing

Response structure

HTTP status codes