0.1.0 - ci-build
SENAITEFHIRImplementationGuide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://fhir.senaite.org/OperationDefinition/SenaiteServiceRequestRevoke | Version: 0.1.0 | |||
| Active as of 2026-11-05 | Computable Name: revoke | |||
Revokes a ServiceRequest in SENAITE, transitioning its status to revoked and triggering the corresponding revocation workflow. Only callable on ServiceRequests in active status. The request body is optional — if omitted or empty, the operation proceeds without a reason.
URL: [base]/ServiceRequest/[id]/$revoke
Output parameters Profile:Senaite ServiceRequest Revoked
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | reason | 0..1 | string | Optional plain-text reason for revoking the ServiceRequest. If supplied, the server persists this value into ServiceRequest.note[0].text on the updated resource. The request body may be omitted entirely, which is equivalent to calling the operation with no reason. | ||
| OUT | return | 1..1 | ServiceRequest (Senaite ServiceRequest Revoked) | The updated ServiceRequest with status set to revoked. If a reason was supplied, it will be present in note[0].text. |