/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)
...
Properties of a REST API method document
Document type | Метод REST API |
|---|---|
Document title | [DRAFT] Create Specimen [API-007-012-001-0493] |
Guideline ID | GUI-0011 |
Author | @ |
Document version | 1 |
Document status | DRAFT |
Date of creation | ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD) |
Date of update | ХХ.ХХ.ХХХХ (дата зміни версії) |
Method API ID | API-007-012-001-0493 |
Microservices (namespace) | ME |
Component | Specimen |
Component ID | COM-007-012 |
Link на API-специфікацію | https://ehealthmedicalevents975v12.docs.apiary.io/#reference/medical-events/specimen/create-specimen |
Resource | {{host}}/api/patients/patient_id/specimens |
Scope | specimen:write |
Protocol type | REST |
Request type | POST |
Sync/Async | Async |
Public/Private | Public |
Purpose
Describe the purpose of the API method, add Key points (if necessary)
Logic
Description of the working algorithm of the API method and the interaction of services with each other add Service logic (if necessary)
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
...
This WS allows to create Specimen entity by employees without submitting Encounter Data Package.
Key points
Only authenticated and authorized employee with appropriate scope can create a Specimen.
Request should be signed with DS.
The specimen is created asynchronously
The specimen can be created both for persons and for prepersons.
Logic
Configuration parameters
Dictionaries
Input parameters
Input parameter | Mandatory | Type | Description | Example | |
|---|---|---|---|---|---|
| 1 |
patient_id |
|
String |
Unique patient identifier |
| ||||
| 2 |
|
|
|
|
|
Request structure
See on API-specification
...
Request data validation
Describe the process of checking the input data transmitted in the request for compliance with the given rules and restrictions set in the API
Processing
A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST API
Response structure examples
...
Post-processing processes
Description of actions performed on data after processing
Technical modules where the method is used
Название |
|---|
Содержимое не найдено |