Table of Contents

This WS allows to mark Specimen as entered-in-error.

Specification

Link	Apiary
Resource	/api/patients/patient_id/specimens/id/actions/
Scope	specimen:cancel
Components	Specimen
Microservices
Protocol type	REST
Request type	PATCH
Sync/Async	Async
Public/Private/Internal	Public

Key points

Only an employee who registered a Specimen, has an approval or a med_admin from the same legal entity, if they have an appropriate scope, are able to cancel the Specimen.
Request should be signed with DS.
The specimen is cancelled asynchronously
Signed content of a Specimen must be equal to the Specimen stored in DB. See Get Specimen details
status_reason must be added to signed content
status must be changed to entered_in_error for the purpose of displaying in the signed content

Input parameter	Values	Type	Description	Example
patient_id		String	Unique patient identifier	`7075e0e2-6b57-47fd-aff7-324806efa7e5`
id		String	Unique specimen identifier	aff00bf6-68bf-4b49-b66d-f031d48922b3

specimen_cancel_reasons

See on Apiary

...

See on Apiary

HTTP status code	Message	What caused the error
200
401	Invalid access token
403	Access denied. Party is deceased Your scope does not allow to access this resource. Missing allowances: specimen:cancel
409	Does not match the signer drfo client_id refers to legal entity that is not active User is not allowed to perform actions with an enity that belongs to another legal entity Employee is not the one who registered the specimen, doesn't have an approval or required employee type Specimen in status <status> cannot be cancelled'
422	Invalid signed content value is not allowed in enum Signed content doesn't match with previously created specimen