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

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.1.1 Validate token
  - 9.1.2 Validate scopes
10 Validate patient
11 Processing
12 Response structure examples
13 HTTP status codes
14 Post-processing processes
15 Technical modules where the method is used

Properties of a REST API method document

Document type	Метод REST API
Document title	[DRAFT] Get Short Encounter by id [API-007-008-007-0290]
Guideline ID	GUI-0011
Author	@
Document version	1
Document status	DRAFT
Date of creation	ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD)
Date of update	ХХ.ХХ.ХХХХ (дата зміни версії)
Method API ID	API-007-008-007-0290
Microservices (namespace)	ME
Component	Patient Summary
Component ID	COM-007-008
Link на API-специфікацію	https://medicaleventsmisapi.docs.apiary.io/#reference/medical-events/patient-summary/get-short-encounter-by-id
Resource	{{host}}/api/patients/{{patient_id}}/summary/encounters/{{encounter_id}}
Scope	patient_summary:read
Protocol type	REST
Request type	GET
Sync/Async	Sync
Public/Private	Public

Purpose

Return single short Encounter info

Logic

The endpoint returns single short Encounter info

Configuration parameters

N/A (Not applicable)

Dictionaries

eHealth/resources - encounter(parameter “encounter_id“ in request)
eHealth/encounter_statuses (parameter “status“ in response)
eHealth/resources - episode (parameter “episode “ in response)
eHealth/encounter_classes (parameter “class“ in response)
eHealth/encounter_types (parameter “type“ in response)
SPECIALITY_TYPE (parameter “performer_speciality“ in response)

Input parameters

	Input parameter	Mandatory	Type	Description	Example

	Input parameter	Mandatory	Type	Description	Example
1	patient_id	M	String	Unique patient identifier	`e549c257-232e-4dab-9f1e-b2322cac3968`
2	encounter_id	M	String	Unique encounter identifier	`340b86fd-23f3-4a33-94c5-8ec19d116c33`

Request structure

See on API-specification

Headers

See on Headers

Request data validation

Authorize

Request to process the request using a token in the headers

Validate token

Verify the validity of access token
- Return 401 in case validation fails
Verify token is not expired
- in case error return 401

Validate scopes

Check user scopes in order to perform this action (scope = 'patient_summary:read')
1. Return 403 in case invalid scope(s)

Validate patient

Validate patient exists in MongoDB
- In case of error return 404 not found

Processing

N/A

Response structure examples