| 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
The method is designed for getting an HTML template of informational reference for print.
...
The template can be getted by MC in any status (PRELIMINARY, FINAL, AMENDED, ENTERED_IN_ERROR).
Generation works by the MAN component.
...
Creating "a replacement" composition
Logic
...
Configuration parameters
Link to configurable parameters
...
“1001” for information reference by CATEGORIES of TYPE=TEMP_DISABILITY
“1000“ for information reference by CATEGORIES of TYPE=NEWBORN
Dictionaries
Provides a list of links to dictionaries that are available in ConfluenceN/A
Input parameters
Input parameter | Mandatory | Type | Description | Example | |
|---|---|---|---|---|---|
| 1 | compositionId |
| String($uuid) (path) | Composition object ID | 89678f60-4cdc-4fe3-ae83-e8b3ebd35c59 |
| 2 | patientId |
| String($uuid) (path) | Patient object ID | 89678f60-4cdc-4fe3-ae83-e8b3ebd35c59 |
| 3 | episodeId |
| String($uuid) (path) | Episode of Care object ID | 89678f60-4cdc-4fe3-ae83-e8b3ebd35c59 |
| 4 | encounterId |
| String($uuid) (path) | Encounter object ID | 89678f60-4cdc-4fe3-ae83-e8b3ebd35c59 |
| 5 | templateId | 1000, 1001 | String(query) | ID of the template (man service) used to render the form | 1000 |
Request structure
See on SwaggerHub (2.39.2)See on API-specification
| Expand | |||||
|---|---|---|---|---|---|
| |||||
|
Headers
...
Key
...
Value
...
Mandatory
...
Description
...
Example
...
Content-Type
...
application/json
...
M
...
Тип контенту
...
Content-Type:application/json
...
Authorization
...
Bearer {token}
...
Authorization: Bearer {token}
...
api-key
...
{secret}
...
api-key: {secret}
Request data validation
Authorize
Check user scopes in order to perform this action (scope = 'composition:read')
...
IF it is valid
THEN the process continues
ELSE an error 404 is returned.
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 SwaggerHub (2.39.2)See on API-specification
| Expand | |||||
|---|---|---|---|---|---|
| |||||
|
HTTP status codes
Response code | HTTP Status code | Message | Internal name | Description | |
|---|---|---|---|---|---|
| 1 | Базові | ||||
| 2 | 200 |
| Form exists | ||
| 3 | 404 |
| Form not found | ||
| 4 | Специфічні | ||||
| 5 | |||||
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 | ||||
|---|---|---|---|---|
|
...