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

https://e-health-ua.atlassian.net/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)

1 Properties of a REST API method document
2 Purpose
3 Logic
4 Configuration parameters
5 Dictionaries
6 Input parameters
7 Request structure
8 Headers
9 Request data validation
- 9.1 Authorize
- 9.2 Validate Person
  - 9.2.1 Validate Encounter
  - 9.2.2 Validate Device
10 Processing
11 Response structure examples
12 HTTP status codes
13 Post-processing processes
14 Technical modules where the method is used

Properties of a REST API method document

Document type	Метод REST API
Document title	[DRAFT] REST API Get Device context [API-007-002-001-0232]
Guideline ID	GUI-0011
Author	@
Document version	1
Document status	DRAFT
Date of creation	ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD)
Date of update	ХХ.ХХ.ХХХХ (дата зміни версії)
Method API ID	API-007-002-001-0232
Microservices (namespace)	ME
Component	Devices and equipment
Component ID	COM-007-002
Link на API-специфікацію	https://medicaleventsmisapi.docs.apiary.io/#reference/medical-events/medication-statement/get-device-context
Resource	{{host}}/api/patients/{{patient_id}}/devices/{{device_id}}/context
Scope	medical_event_context:read
Protocol type	REST
Request type	GET
Sync/Async	Async
Public/Private	Public

Purpose

This method allows to get an ID of the episode that is a context of the Device, in order to create an approval on the episode, and receive access to the medical events related to that episode, including the Device.

This method allows to get the context of Device in order to create approval on episode and receive access to other medical events.

Logic

Service returns context_episode_id of the device:

Get device.context_episode_id from Device object
Enrich response with context_episode_id and render the response according to JSON Schema

Service returns context (episode), device based on:

Get Device object by device_id from devices (MongoDB)
Get device.context.identifier from Device object
Call Get Encounter context :
- Get Encounter object by device.context.identifier (device.context.identifier = encounter._id)
  AFTER
- Get encounter.episode from Encounter object
Render a response according to specification

Configuration parameters

N/A

Dictionaries

N/A

Input parameters

	Input parameter	Mandatory	Type	Description	Example

	Input parameter	Mandatory	Type	Description	Example
1	patient_id		String	Patient identifier	`70a9e15b-b71b-4caf-8f2e-ff247e8a5677`
2	device_id		String	Device identifier	`a10aeafb-0df2-4091-bc83-f07e92a100ae`

Request structure

See on API-specification

Headers

Request data validation

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

Validate Person

Get Person identifier from the URL
Check it exists in DB
- Return 404 ('not_found') in case of error

Validate Encounter

Get Device identifier from the URL
- Check it exists in DB
  - Return 404 ('not_found') in case of error
- Check Device belongs to patient
  - Return 404 ('not_found') in case of error

Validate Device

Get Device identifier from the URL
- Check it exists in DB
  - Return 404 ('not_found') in case of error
- Check Device belongs to the patient
  - Return 404 ('not_found') in case of error

Processing

N/A

Response structure examples