Purpose
The method is designed for getting an HTML template of informational reference for print.
The template can be getted only by a user who has access to the MC.
The template can be getted by MC in any status (PRELIMINARY, FINAL, AMENDED, ENTERED-IN-ERROR).
Generation works by the MAN component.
Saving the generated content at the component level is not expected. If it is necessary to get the information reference again, then a new request is made and it is generated anew.
Used in processes:
Create/Sign composition (general process)
Refinement (preperson -> person) for MVTN
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
Configurable parameters
Link to configurable parameters
VAR_NAME: EMAL_PRINT_FORM_ALLOWED_TEMPLATE_IDS_BY_CATEGORY
“21” for information reference by CATEGORIES of TYPE=TEMP_DISABILITY
“20“ 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 | 20, 21 | String(query) | ID of the template (man service) used to render the form | 20 |
Request structure
Example:
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 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
Example:
HTTP status codes
HTTP status code | Message | What caused the error |
---|---|---|
200 |
| Form exists |
404 |
| Form not found |