/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)
...
Properties of a REST API method document
Document type | Метод REST API |
|---|---|
Document title | [Document statusDRAFT] REST API [Назва методу] [ID методуNEW] Get Composition by search params [API-007-011-001-0476] |
Guideline ID | GUI-0011 |
Author | @ |
Document version | 1 |
Document status | DRAFT |
Date of creation | ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD) |
Date of update | ХХ.ХХ.ХХХХ (дата зміни версії) |
Method API ID | API-007-011-001-0476 |
Microservices (namespace) | MPIME |
Component | AuthCompositions_ME |
Component ID | COM-007-011 |
Link на API-специфікацію | |
Resource | {{host}}//api.ehealth.gov.ua/api/patients/id/encounter_package |
Scope | |
Protocol type | REST |
Request type | |
Sync/Async | |
Public/Private |
...
Get all Composition by subject from
compositionscollection (MongoDB)Filter list above by submitted search parameters
Render a response according to specification with a list of found Composition entities.
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
Description of input N/A
Dictionaries
N/A
Input parameters
Input parameter | Mandatory | Type | Description | Example | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| 1 | composition_id | M | String ($uuid) (path)Composition object ID | 89678f60-4cdc-4fe3-ae83-e8b3ebd35c59 | ||||||
| 2 |
|
|
|
|
|
Request structure
See on API-specification (посилання на сторінку з API-специфікацією)
Description of the REST API request structure, example
| Expand | ||
|---|---|---|
| ||
|
Headers
...
...
Request data validation
...
Mandatory
...
Description
...
Example
...
Content-Type
...
application/json
...
M
...
Тип контенту
...
Content-Type:application/json
...
Authorization
...
Bearer c2778f3064753ea70de870a53795f5c9
...
M
...
Перевірка користувача
...
Authorization:Bearer c2778f3064753ea70de870a53795f5c9
...
...
...
...
...
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 = 'composition:read')
return 403 “Your scope does not allow to access this resource. Missing allowances: composition:read” in case of invalid scope(s)
Access to the resource is also managed by /wiki/spaces/emal/pages/18119196701
Validate Patient
Get Patient identifier from the URL
Check it exists in Mongo DB
Return 404 ('not found') in case of error
...
encounter_id
filter list by composition.encounter.identifier.value
context_episode_id
filter list by episode of care - composition.context_episode_id
type
filter list by composition.type.coding[*].code
category
filter list by composition.category.coding[*].code
title
filter list by composition.title
status
filter list by composition.status
author
filter list by composition.author.identifier.value
attester
filter list by composition.attester.party.value
custodian
filter list by composition.custodian.identifier.value
date_from
filter list by $.date_from <= composition.date
date_to
filter list by $.date_to >= composition.date
page
filter list by page number
page_size
a limit on the number of objects to be returned, between 1 and 100. Default: 50
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 (посилання на сторінку з API-специфікацією)Description of the REST API response structure, example
| Expand | ||
|---|---|---|
| ||
|
...
Response code | HTTP Status code | Message | Internal name | Description | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | Базові | ||||||||||
| 2 | 401 | Invalid access token | |||||||||
| 3 |
| 401Unauthorized |
| Помилка підтвердження | 4 | 403 | Your scope does not allow to access this resource. Missing allowances: composition:read | ||||
| 54 | 1000 | 404 | Composition not found | COMPOSITION_NOT_FOUND_404 | Не знайдено медичний висновок | 6 | 404 | not found | |||
| 7 | Специфічні | ||||||||||
| 8 |
| 422 | Only for active MPI record can be created medication request! | 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
Название | ID ТМ | Статус |
|---|---|---|
TM0112 | ||
...