Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

Purpose

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

...

Filter

Values

Type

Description

Example

status

 https://e-health-ua.atlassian.net/wiki/spaces/EH/pages/17629118869/RC.+Specimen+status+model#Statuses-of-Specimen

String

status of the Specimen

available

type

String

kind of material that forms the Specimen

ABP

registered_by

String

identifier of employee who registered the specimen

ef30f210-5328-4f48-bfe6-c7150d4737a6

collected_from

String

he date from which the Specimen was collected

2023-12-25

collected_to

String

the date to which the Specimen was collected

2023-12-28

container_identifier

String

identifier of the container in the Specimen

1-ABC-4311

container_type

String

type of the container in the Specimen

tube

parent

String

parent Specimen

9075e0e2-6b57-47fd-aff7-324806efa7e6

request

String

service request identifier linked to the Specimen

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

encounter

String

encounter/context identifier linked to the Specimen

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

Dictionaries

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

...

  • 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

  • encounter

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

Response structure

See on Apiary

...