Versions Compared

Version Old Version 1 New Version Current
Changes made by

Anzhela Kovalenko (SoE eHealth)

Anzhela Kovalenko (SoE eHealth)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Note

Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою.

Info

/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

...

Table of Contents
stylenone

Properties of a REST API method document

Document type

Метод REST API

Document title

[DRAFT] REST API Get Specimen by accession identifier [API-007-012-001-0496]

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-0496

Microservices (namespace)

ME

Component

Specimen

Component ID

COM-007-012

Link на API-специфікацію

https://ehealthmedicalevents975v12.docs.apiary.io/#reference/medical-events/specimen/get-specimen-by-accession-identifier

Resource

{{host}}/api/specimens/accession_identifier

Scope

specimen:read

Protocol type

REST

Request type

GET

Sync/Async

AsyncSync

Public/Private

Public

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

https://e-health-ua.atlassian.net/wiki/spaces/EH/pages/17629118915/RC.#%D0%9E%D1%82%D1%80%D0%B8%D0%BC%D0%B0%D0%BD%D0%BD%D1%8F-%D1%96%D0%BD%D1%84%D0%BE%D1%80%D0%BC%D0%B0%D1%86%D1%96%D1%97-%D0%97%D1%80%D0%B0%D0%B7%D0%BA%D0%B0-%D0%B1%D0%B5%D0%B7-%D0%B2%D0%B7%D0%B0%D1%94%D0%BC%D0%BE%D0%B4%D1%96%D1%97-%D0%B7-%D0%BF%D0%B0%D1%86%D1%96%D1%94%D0%BD%D1%82%D0%BE%D0%BC[DRAFT] BP-ESOZ-028-0004 [MIS] Отримання інформації Зразка без взаємодії з пацієнтом

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

Input parameter

Mandatory

Type

Description

Example

1

2

 

 

 

 

 

Request structure

See on API-specification

Expand
titleExample
Code Block
languagejson
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
 Expand
titleExample
 Code Block
languagejson
HTTP status codes
Response code
HTTP Status code
Message
Internal name
Description
1
Базові
2
200
 
 
 
3
401
Invalid access token
  
Недійсний токен доступу
43
403
Your scope does not allow to access this resource. Missing allowances: specimen:read
 
Відсутня можливість доступу до цього ресурсу через брак наявності скоупу: specimen:read
4
404
Specimen is not found
Зразок не знайдено
Post-processing processes
N/A
Technical modules where the method is used
N/A