| Info |
|---|
REST API method / Метод REST API (настанова) (remove the link block before publishing the document) |
| Table of Contents |
|---|
Properties of a REST API method document
...
| id | page_properties_method_REST API |
|---|
...
Document type
...
Метод REST API
...
Document title
...
[Document status] REST API [Назва методу] [ID методу]
...
Guideline ID
...
GUI-0011
...
Author
...
@
...
Document version
...
1
...
Document status
...
DRAFT
...
Date of creation
...
ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD)
...
Date of update
...
ХХ.ХХ.ХХХХ (дата зміни версії)
...
Method API ID
...
API-007-004-004-0254
...
Microservices (namespace)
...
ME
...
Component
...
EDP
...
Component ID
...
COM-007-004
...
Link на API-специфікацію
...
...
Resource
...
{{host}}/api/patients/{{patient_id}}/encounters/{{encounter_id}}
...
Scope
...
encounter:read
...
Protocol type
...
REST
...
Request type
...
GET
...
Sync/Async
...
Sync
...
Public/Private
...
Public
Purpose
This web service is designed to return encounters by id.
Logic
Description of the working algorithm of the API method and the interaction of services with each other add Service logic (if necessary)
Configuration parameters
Description of the configuration parameters that are used when processing a request in the system
Dictionaries
Provides a list of links to dictionaries that are available in Confluence
Input parameters
...
Input parameter
...
Mandatory
...
Type
...
Description
...
Example
...
patient_id
...
...
String
...
Patient identifier
...
70a9e15b-b71b-4caf-8f2e-ff247e8a5677
...
encounter_id
...
...
String
...
Encounter identifier
...
a10aeafb-0df2-4091-bc83-f07e92a100ae
Request structure
See on Apiary
...
| title | Example |
|---|
...
Headers
...
Key
...
Value
...
Mandatory
...
Description
...
Example
...
Content-Type
...
application/json
...
M
...
Тип контенту
...
Content-Type:application/json
...
Authorization
...
Bearer {{access_token}}
...
Authorization:Bearer {{access_token}}
...
API-key
...
{{secret}}
...
| Note |
|---|
Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою. |
| Info |
|---|
/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document) |
| Table of Contents |
|---|
Properties of a REST API method document
| Page Properties | ||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||
|
Purpose
This web service is designed to return encounters by id.
Logic
N/A
Configuration parameters
N/A
Dictionaries
N/A
Input parameters
Input parameter | Mandatory | Type | Description | Example | |
|---|---|---|---|---|---|
| 1 | patient_id |
| String | Patient identifier |
|
| 2 | encounter_id |
| String | Encounter identifier |
|
Request structure
See on API-specification
| Expand | ||
|---|---|---|
| ||
|
Headers
Request data validation
Authorize
Request to process the request using a token in the headers
...
Access to the resource is also managed by ABAC module.
Processing
A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST APIN/A
Response structure examples
See on API-specification
| Expand | ||
|---|---|---|
| ||
|
HTTP status codes
Response code | HTTP Status code | Message | Internal name | Description | |
|---|---|---|---|---|---|
| 1 | Базові | ||||
| 2 | 200 |
|
| ||
| 3 | 401 |
| Access token validation failed | ||
| 4 | 403 |
| Invalid scope | ||
| 5 | Специфічні | ||||
| 6 | |||||
Post-processing processes
Description of actions performed on data after processing
Technical modules where the method is used
List of pages describing technical N/A
Technical modules where the method is used
| Page Properties Report | ||||
|---|---|---|---|---|
|
...