| 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
This method is designed to return a procedure record by id.
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
Input parameter | Mandatory | Type | Description | Example | |
|---|---|---|---|---|---|
| 1 | id |
| String | Unique procedure identifier |
|
Request structure
See on Apiary
See on API-specification
| Expand | ||
|---|---|---|
| ||
|
Headers
Key | Value | Mandatory | Description | Example | |
|---|---|---|---|---|---|
| 1 | Content-Type | application/json | M | Тип контенту | Content-Type:application/json |
| 2 | Authorization | Bearer {{access_token}} | Authorization:Bearer {{access_token}} | ||
| 3 | API-key | {{secret}} | API-key:{{secret}} |
Request data validation
Authorize
Request to process the request using a token in the headers
...
Access to the resource is also managed by ABAC module.
Validation
validate person_id
validate $person_id is existing ID in mpi.persons.id And person is_active=true and status='active
in case error return 404, "Person not found"
Processing
A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST API
Response structure examples
See on Apiary
See on API-specification
...
Return response according to json schema
Return procedures where
managing_organization.identifier.value=$Client_id
consumer_id is a doctor with active declaration for current patient ($.person_id)
HTTP status codes
Response code | HTTP Status code | Message | Internal name | Description | |
|---|---|---|---|---|---|
| 1 | Базові | ||||
| 2 | 200 |
|
| ||
| 3 | 401 | Access denied |
| ||
| 4 | 403 | Invalid scopes |
| ||
| 5 | 404 | Patient not found |
| ||
| 6 | Специфічні | ||||
| 7 | |||||
Post-processing processes
Description of actions performed on data after processing
Technical modules where the method is used
List of pages describing technical modules where the method is used
| Page Properties Report | ||||
|---|---|---|---|---|
|
...