/
[DRAFT] Get Specimen details [API-007-012-001-0495]
  • In progress

    • ЕСОЗ - публічна документація

    [DRAFT] Get Specimen details [API-007-012-001-0495]

    Owned by Anzhela Kovalenko (SoE eHealth)
    yesterday at 8:02 PM
    2 min read

    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

    Document type

    Метод REST API

    Document title

    [DRAFT] Get Specimen details [API-007-012-001-0495]

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

    Microservices (namespace)

    ABAC

    Component

    Specimen

    Component ID

    COM-007-012

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

    https://ehealthmedicalevents975v12.docs.apiary.io/#reference/medical-events/specimen/get-specimen-details

    Resource

    {{host}}/api/patients/patient_id/specimens

    Scope

    specimen:read

    Protocol type

    REST

    Request type

    GET

    Sync/Async

    Async

    Public/Private

    Public

    Purpose

    This WS allows to get a single Specimen by its identifier.

    Key points

    1. Only authenticated and authorized employee with appropriate scope can get a Specimen.

    2. Method returns a single Specimen that belongs to the specified patient.

    3. ABAC rules are used here

    Logic

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

    Service returns specified Specimen related to the patient:

    • Get Specimen by ID from specimens collection (MongoDB)

    • Render a response according to specification

    Configuration parameters

    N/A

    Dictionaries

    N/A

    Input parameters

    Input parameter

    Mandatory

    Type

    Description

    Example

    Input parameter

    Mandatory

    Type

    Description

    Example

    1

     

     

     

     

     

    2

     

     

     

     

     

    Request structure

    See on API-specification

    Headers

    Headers

    Request data validation

    Authorization

    • 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 and client 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)

    • Access to the resource is also managed by ABAC module

    Validate Patient

    • Get Patient identifier from the URL

    • Check it exists in DB

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

    Validate Specimen

    • Get Specimen identifier from the URL

    • Check it exists in DB

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

    • Check Specimen belongs to patient

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

    Processing

    N/A

    Response structure examples

    See on API-specification

    HTTP status codes

    Response code

    HTTP Status code

    Message

    Internal name

    Description

    Response code

    HTTP Status code

    Message

    Internal name

    Description

    1

    Базові

    2

     

    200

     

     

     

    3

     

    401

    Invalid access token

     

     

    4

     

    403

    Your scope does not allow to access this resource. Missing allowances: specimen:read

     

     

    Post-processing processes

    N/A

    Technical modules where the method is used

    ЕСОЗ - публічна документація