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

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
- 2.1 Key points
3 Logic
4 Configuration parameters
5 Dictionaries
6 Input parameters
7 Request structure
8 Headers
9 Request data validation
- 9.1 Authorization
- 9.2 Validate Patient
- 9.3 Validate Specimen
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 Specimen details [API-007-012-001-0495]
Guideline ID	GUI-0011
Author	@
Document version	1
Document status	DRAFT
Date of creation	ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD)
Date of update	ХХ.ХХ.ХХХХ (дата зміни версії)
Method API ID	API-007-012-001-0495
Microservices (namespace)	ME
Component	Specimen
Component ID	COM-007-012
Link на API-специфікацію	MEDICAL EVENTS MIS API · Apiary
Resource	{{host}}/api/patients/patient_id/specimens/{{id}}
Scope	specimen:read
Protocol type	REST
Request type	GET
Sync/Async	Sync
Public/Private	Public

Purpose

This WS allows to get a single Specimen by its identifier.

Key points

Only authenticated and authorized employee with appropriate scope can get a Specimen.
Method returns a single Specimen that belongs to the specified patient.
ABAC rules are used here.

Logic

[DRAFT] BP-ESOZ-028-0003 [MIS] Отримання інформації Зразка при взаємодії з пацієнтом

Service returns specified Specimen related to the patient:

Get Specimen by ID from specimens collection (MongoDB)
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
2

Request structure

See on API-specification

Headers

Request data validation

Authorization

Verify the validity of access token
- in case of error - 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 and client scopes in order to perform this action (scope = 'specimen:read')
- return 403 “Your scope does not allow to access this resource. Missing allowances: specimen:read” in case of invalid scope(s)
Access to the resource is also managed by ABAC module

Validate Patient

Get Patient identifier from the URL
Check it exists in DB
- Return 404 ('not found') in case of error

Validate Specimen

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

Processing

N/A

Response structure examples