| Table of Contents | ||||
|---|---|---|---|---|
|
...
Link | |
Resource | /patients/{patientId}/composition/{compositionId}/episode/{episodeId}/encounter/{encounterId}/integrationData |
Scope | composition:read |
Components | CompositionCompositions |
Microservices | API paragraph not found |
Protocol type | REST |
Request type | GET |
Sync/Async | Async |
Public/Private/Internal | Public |
...
The method can only be executed by a user with access to composition.
The method can only be executed for a composition with the status:
FINAL
AMENDED
ENTERED-IN-ERROR
Logic*
Потрібно по пунктах описати логіку методу API або додати діаграму
Global and configurable parameters
Потрібно вказати посилання на сторінки з описом глобальних та конфігураційних параметрів
Input parameters
Input parameter | Values | Type | Description | Example |
|---|---|---|---|---|
compositionId |
| String($uuid) (path) | Composition object ID | 89678f60-4cdc-4fe3-ae83-e8b3ebd35c59 |
patientId |
| String($uuid) (path) | Patient object ID | 89678f60-4cdc-4fe3-ae83-e8b3ebd35c59 |
episodeId |
| String($uuid) (path) | Episode of Care object ID | 89678f60-4cdc-4fe3-ae83-e8b3ebd35c59 |
encounterId |
| String($uuid) (path) | Encounter object ID | 89678f60-4cdc-4fe3-ae83-e8b3ebd35c59 |
...
Content-Type: application/json
Authorization: Bearer {token}
api-key: {secret}
Request data validation*
Валідація даних
Наприклад:
Validate request using JSON schema
In case validation failed - generate 422 error
Processing*
Потрібно описати процеси, які відбуваються з даними
1. Using global parameters
Потрібно викликати глобальні параметри (Global parameters), щоб отримати наведені нижче параметри
Response structure*
...
Post-processing processes*
Що має відбутися в ЦБД після опрацювання та відправлення відповіді, тощо
HTTP status codes*
HTTP status code | Message | What caused the error |
|---|---|---|
200 |
|
|
404 |
|
|
...