https://e-health-ua.atlassian.net/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)

• Properties of a REST API method document

• Purpose

• Logic

• Configuration parameters

• Dictionaries

• Input parameters

• Request structure

• Headers

• Request data validation

• Processing

• Response structure examples

• HTTP status codes

• Post-processing processes

• Technical modules where the method is used

Properties of a REST API method document

Purpose

This WS allows to get Specimen without patient context by its accession identifier.

Key points

1. Returns a single Specimen that has a specified accession_identifier

2. ABAC isn’t used here

Logic

RC._Процеси роботи зі зразком біоматеріалу | Отримання інформації Зразка без взаємодії з пацієнтом

Service returns a single Specimen that has a specified accession_identifier:

1. Get Specimen by ID from specimens collection (MongoDB)

2. Enrich identity object in the response with person’s age and gender, but w/o patient’s name

3. Render a response according to specification.

Configuration parameters

N/A

Dictionaries

N/A

Input parameters

Request structure

See on API-specification

Headers

Headers

Request data validation

Authorization

• Verify the validity of access token

  • 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 = 'specimen:read')

  • Return (403, 'Your scope does not allow to access this resource. Missing allowances: specimen:read') in case of invalid scope(s)

Validate Specimen

• Get Specimen identifier from the URL

• Check it exists in DB

  • Return 404 ('Specimen is not found.') in case of error

Processing

N/A

Response structure examples

See on API-specification

HTTP status codes

Post-processing processes

N/A

Technical modules where the method is used