...

This WS allows to get a list of Specimens in patient context. Also, this list can be filtered using search parameters.

Specification

...

https://e-health-ua.atlassian.net/wiki/spaces/EH/pages/17629119370/RC.+Specimen+dictionaries+and+configurable+parameters#Dictionaries

Request structure

See on Apiary

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

...

• status

  • filter list by specimen.status

• type

  • filter list by specimen.type.coding[*].code

• registered_by.

  • filter list by specimen.registered_by.identifier.value

• collected_from

  • In depend on what is set - filter by specimen.collection.collected_date_time or specimen.collection.collected_period field. Do not take time into account.

    • filter list by $.collected_from <= collected_date_time

    • filter list by $.collected_from <= collected_period.end

• collected_to

  • In depend on what is set - filter by specimen.collection.collected_date_time or specimen.collection.collected_period field. Do not take time into account.

    • filter list by $.collected_to >= collected_date_time.

    • filter list by $.collected_to >= collected_period.start

• container_identifier

  • filter list by specimen.container[*].identifier

• container_type

  • filter list by specimen.container[*].type

• parent

  • filter list by specimen.parent.identifier.value

• request

  • filter list by specimen.request[*].identifier.value

Response structure

See on Apiary

HTTP status codes