Versions Compared

Key

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

...

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

Specification

Link

 Apiary

Resource

 api/patients/patient_id/specimens

Scope

 specimen:read

Components

 Specimen

Microservices

 ABAC

Protocol type

 REST

Request type

 GET

Sync/Async

 Async

Public/Private/Internal

 Public

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

...

  • Get Specimen by ID from specimens collection (MongoDB)

  • Render a response according to specification

Filters

Filter

Values

Type

Description

Example

patient_id

 

String

Unique patient identifier

7075e0e2-6b57-47fd-aff7-324806efa7e5

id

 

String

Unique specimen identifier

7075e0e2-6b57-47fd-aff7-324806efa7e5

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

 

404

not found