...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
Table of Contents | ||||
---|---|---|---|---|
|
Purpose
This WS is designed to return Medical Program detail.
Specification
Page Properties | |||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Logic
Get Medical Program by id.
Render a response according to specification.
Preconditions
API paragraph not found
...
No
Input parameters
Input parameter | Values | Type | Description | Example |
---|---|---|---|---|
id | UUID string | Internal medical program ID. Required. | c7d52544-0bd4-4129-97b0-2d72633e0490 |
Filters
No
Dictionaries
API paragraph not found
Request structure
...
Dictionaries
LICENSE_TYPE
clinical_impression_patient_categories
MEDICAL_PROGRAM_TYPE
PROVIDING_CONDITION
FUNDING_SOURCE
MR_BLANK_TYPES
Authorize
Verify the validity of access token
in case of error - return 401 (“Invalid access token”) in case of validation fails.
Verify that token is not expired
in case of error - return 401 (“Invalid access token”).
Check user scopes in order to perform this action (scope = 'medical_program:read')
return 403 (“Your scope does not allow to access this resource. Missing allowances: medical_program:read”) in case of invalid scope(s).
...
Get Medical Program identifier from the URL.
Check it exists in DB
in case of error - return 404 error (message: "Medical program does not exist ").
...
API paragraph not found
Response structure
See on Apiary
Example:
Expand | ||
---|---|---|
| ||
|
Post-processing processes
...
HTTP status codes
Page Properties | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Backward compatibility
...