...
This WS allows to get a list of Specimens in patient context. Also, this list can be filtered using search parameters.
Specification
Link | |
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
Only authenticated and authorized employee with appropriate scope can get a list of Specimen.
Method returns a list of Specimen that belongs to the specified patient.
List can be filtered by search params.
ABAC rules are used here
...
Get all Specimens by subject from specimens collection (MongoDB)
Filter list above by submitted search parameters
Render a response according to specification with a list of found Specimen entities.
Filters
Filter | Values | Type | Description | Example |
|---|---|---|---|---|
status | 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_date | String | date when Specimen was collected. Matches the date of collected_date_time field or date within collected_period field | 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 |
Dictionaries
...
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 |