| Info |
|---|
/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document) |
Properties of a REST API method document
| Page Properties |
|---|
| id | page_properties_method_REST API |
|---|
|
Document type | Метод REST API |
|---|
Document title | [Document statusDRAFT] REST API [Назва методу] [ID методу]searchCompositions [API-006-001-001-0215] |
|---|
Guideline ID | GUI-0011 |
|---|
Author | @ |
|---|
Document version | 1 |
|---|
Document status | DRAFT |
|---|
Date of creation | ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD) |
|---|
Date of update | ХХ.ХХ.ХХХХ (дата зміни версії) |
|---|
Method API ID | API-006-001-001-0215 |
|---|
Microservices (namespace) | MC |
|---|
Component | Compositions |
|---|
Component ID | COM-006-001 |
|---|
Link на API-специфікацію | https://app.swaggerhub.com/apis/ehealthua/compositions/Prod#/main/searchCompositions |
|---|
Resource | {{host}}/patients/{{patientId}}/composition |
|---|
Scope | composition:search |
|---|
Protocol type | REST |
|---|
Request type | GET |
|---|
Sync/Async | Sync |
|---|
Public/Private | Public |
|---|
|
Purpose
This method is designed to search for a composition by the specified parameters and get a list of results that match these parameters.
Logic
...
Configuration parameters
Description of the configuration parameters that are used when processing a request in the systemN/A
Dictionaries
| Input parameter | Mandatory | Type | Description | Example |
|---|
| 1 | subject | | string($uuid) | subject's MPI ID (patientID - incompatible with focus) | 89678f60-4cdc-4fe3-ae83-e8b3ebd35c59 |
| 2 | focus | | string($uuid) | subject's MPI ID (patientID - incompatible with subject) | 89678f60-4cdc-4fe3-ae83-e8b3ebd35c59 |
Request structure
See on API-specification
| Expand |
|---|
|
| Code Block |
|---|
| '/patients/searchComposition':
get:
description: Пошук мед висновків
operationId: searchCompositions
tags: ['main']
parameters:
- $ref: '#/components/parameters/offsetParam'
- $ref: '#/components/parameters/limitParam'
- name: subject
in: query
required: false
description: subject's MPI ID (пацієнт) (несумісний з focus)
schema:
type: string
format: uuid
- name: focus
in: query
required: false
description: focus MPI ID (фокус) (несумісний з subject)
schema:
type: string
format: uuid
- in: query
name: type
required: false
schema:
$ref: '#/components/schemas/compositionTypeEnum'
- in: query
name: episodeOfCare
required: false
schema:
type: string
format: uuid
- in: query
name: encounter
description: id ME-об'єкту Encounter
required: false
schema:
type: string
format: uuid
- in: query
name: status
description: статус медвисновку
required: false
schema:
$ref: '#/components/schemas/compositionStatusEnum' |
|
...
Key
...
Value
...
Mandatory
...
Description
...
Example
...
Content-Type
...
application/json
...
M
...
Тип контенту
...
Content-Type:application/json
...
Authorization
...
Bearer {token}
...
Authorization: Bearer {token}
...
api-key
...
{secret}
...
Headers
Request data validation
Authorize
Check user scopes in order to perform this action (scope = 'composition:search')
return 401 (Unauthorized) in case of invalid scope(s)
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 |
|---|
|
| Code Block |
|---|
| [
{
"identifier": {
"type": {
"coding": [
{
"system": "eHealth/resources",
"code": "person"
}
],
"text": "string"
},
"value": "52b504c7-0177-4078-834b-52d89154081c"
},
"status": "PRELIMINARY",
"title": "string",
"type": {
"coding": [
{
"system": "COMPOSITION_TYPES",
"code": "TEMP_DISABILITY"
}
]
},
"date": "string",
"encounter": {
"type": {
"coding": [
{
"system": "eHealth/resources",
"code": "person"
}
],
"text": "string"
},
"value": "52b504c7-0177-4078-834b-52d89154081c"
},
"episodeOfCare": {
"type": {
"coding": [
{
"system": "eHealth/resources",
"code": "person"
}
],
"text": "string"
},
"value": "52b504c7-0177-4078-834b-52d89154081c"
}
}
] |
|
HTTP status codes
| Response code | HTTP Status code | Message | Internal name | Description |
|---|
| 1 | Базові |
| 2 | | 200 | Search results | | |
| 3 | Специфічні |
| 4 | | | | | |
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 |
|---|
| headings | ID ТМ, Статус |
|---|
| cql | label = "tr-mis" |
|---|
|
...