Versions Compared

Old Version 3

changes.mady.by.user Vitalii Shydlovskyi (SoE eHealth)

Saved on

compared with

New Version 4

changes.mady.by.user Vitalii Shydlovskyi (SoE eHealth)

Saved on

Key

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

...

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

Specification

Link

 Apiary

Resource

 /api/specimens/accession_identifier

Scope

 specimen:read

Components

 Specimen

Microservices

 

Protocol type

 REST

Request type

 GET

Sync/Async

 Async

Public/Private/Internal

 Public

Key points

  1. Returns a single Specimen that has a specified accession_identifier

  2. ABAC isn’t used here

...

  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.

Filters

Filter

Values

Type

Description

Example

accession_identifier

 

String

human readable Specimen number

1234-3224-2342-1233

Request structure

See on Apiary

...

See on Apiary

 

HTTP status codes

HTTP status code

Message

What caused the error

200

 

 

401

Invalid access token

 

403

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