Table of Contents | ||||
---|---|---|---|---|
|
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
Specification
Link | |
Resource | |
Scope | composition:read |
Components | |
Microservices | API paragraph not found |
Protocol type | REST |
Request type | GET |
Sync/Async | Async |
Public/Private/Internal | Public |
Logic
...
View file | ||
---|---|---|
|
Configurable parameters
Link to configurable parameters
...
“1001” for information reference by CATEGORIES of TYPE=TEMP_DISABILITY
“1000“ for information reference by CATEGORIES of TYPE=NEWBORN
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 | |
templateId | 1000, 1001 | String(query) | ID of the template (man service) used to render the form | 1000 |
Request structure
...
Expand | ||
---|---|---|
| ||
|
Authorize
Check user scopes in order to perform this action (scope = 'composition:read')
return 401 (Unauthorized) in case of invalid scope(s)
Headers
Content-Type: application/json
Authorization: Bearer {token}
api-key: {secret}
Request data validation
The compositionId in the request is checked:
IF it is valid
THEN the process continues
ELSE an error 404 is returned.
Processing
Before collecting data from the composition, access to the composition according to the data from the request is checked:
IF access allowed
THEN data collect
ELSE access error message
After requesting a template from the MAN component, the response is checked:
IF template received in response
THEN print form generated in response to MIS
ELSE template error message
Response structure
...
Expand | ||
---|---|---|
| ||
|
HTTP status codes
HTTP status code | Message | What caused the error |
---|---|---|
200 |
| Form exists |
404 |
| Form not found |