...
| Page Properties |
|---|
| 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-001006-001-001-00010209 |
|---|
Microservices (namespace) | MC |
|---|
Component | Compositions |
|---|
Component ID | COM-006-001 |
|---|
Link на API-специфікацію | https://app.swaggerhub.com/apis/ehealthua/compositions/Prod#/async/getAsyncJobStatus |
|---|
Resource | {{host}}/patients/composition/job/{{asyncJobId}}
|
|---|
Scope | composition:read |
|---|
Protocol type | REST |
|---|
Request type | GET |
|---|
Sync/Async | Sync |
|---|
Public/Private | Public |
|---|
|
...
| Expand |
|---|
|
MIS/Medical employee->Compositions: Creating or updating compositions POST patients/composition/ Compositions->Compositions: AsyncJob planning Compositions->MIS/Medical employee: AsyncJob scheduled (eta) MIS/Medical employee->MIS/Medical employee: asynJob.data.eta timer on MIS/Medical employee-->Compositions: GET /patients/composition/job/{asyncJobId} Compositions-->MIS/Medical employee: AsincJob pending (eta) MIS/Medical employee-->MIS/Medical employee: asynJob.data.eta timer on Compositions->Compositions: AsyncJob completed MIS/Medical employee->Compositions: GET /patients/composition/job/{asyncJobId} Compositions->MIS/Medical employee: AsincJob completed (compositionAsyncJobStateData.links) MIS/Medical employee->Compositions: GET /patients/{patientId}/encounter/{encounterId}/composition/{compositionId} Compositions->MIS/Medical employee: The composition is received
|
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 parameters
| Input parameter | Mandatory | Type | Description | Example |
|---|
| 1 | asyncJobId | | String | Async Job Object ID | 89678f60-4cdc-4fe3-ae83-e8b3ebd35c59 |
Request structure
See on SwaggerHubDescription of the REST API request structure, example
| Expand |
|---|
|
| Code Block |
|---|
/patients/composition/job/{asyncJobId} |
|
...
asyncJobId (correct composition ID needed)
Processing
A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST API
Response structure examples
See on SwaggerHub
| Expand |
|---|
|
compositionAsyncJobStateResponse{ description: | Стан планування/виконання асинхронної задачі | data* | compositionAsyncJobStateData{ eta* string($datetime)
example: 2022-10-24T12:35:49.956Z id* string($uuid)
example: 89678f60-4cdc-4fe3-ae83-e8b3ebd35c59 links* [compositionAsyncJobListItem{ entity*string
example: eHealth/resources }] status* string Enum:
[ PENDING, FAILED, DONE ] } |
} |
...
| Response code | HTTP Status code | Message | Internal name | Description |
|---|
| 1 | Базові |
| 2 | | 200 | Task found | | Correct answer with one of the possible statuses: PENDING, FAILED, DONE |
| 3 | | 400 | Invalid request format | | Error in query syntax or other error |
| 4 | | 404 | Task not found | | The task with the specified ID does not exist or was not found |
| 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 modules where the method is used
| Page Properties Report |
|---|
| headings | ID ТМ, Статус |
|---|
| cql | label = "tr-mis" |
|---|
|
...