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
| Active as of 2026-11-05 |
{
"resourceType" : "OperationDefinition",
"id" : "SenaiteServiceRequestRevoke",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition SenaiteServiceRequestRevoke</b></p><a name=\"SenaiteServiceRequestRevoke\"> </a><a name=\"hcSenaiteServiceRequestRevoke\"> </a><p>URL: [base]/ServiceRequest/[id]/$revoke</p><p>Output parameters Profile:<a href=\"StructureDefinition-SenaiteServiceRequestRevocation.html\">Senaite ServiceRequest Revoked</a></p><h3>Parameters</h3><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>reason</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R5/datatypes.html#string\">string</a></td><td/><td><div><p>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.</p>\n</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R5/servicerequest.html\">ServiceRequest</a> (<a href=\"StructureDefinition-SenaiteServiceRequestRevocation.html\" title=\"https://fhir.senaite.org/StructureDefinition/SenaiteServiceRequestRevocation\">Senaite ServiceRequest Revoked</a>)</td><td/><td><div><p>The updated ServiceRequest with status set to revoked. If a reason was supplied, it will be present in note[0].text.</p>\n</div></td></tr></table></div>"
},
"url" : "https://fhir.senaite.org/OperationDefinition/SenaiteServiceRequestRevoke",
"version" : "0.1.0",
"name" : "revoke",
"title" : "Revoke a ServiceRequest",
"status" : "active",
"kind" : "operation",
"date" : "2026-11-05T16:10:27+01:00",
"publisher" : "Naralabs",
"contact" : [
{
"name" : "Naralabs",
"telecom" : [
{
"system" : "url",
"value" : "https://naralabs.com"
},
{
"system" : "email",
"value" : "info@naralabs.com"
}
]
},
{
"name" : "Senaite FHIR",
"telecom" : [
{
"system" : "email",
"value" : "info@naralabs.com",
"use" : "work"
}
]
}
],
"description" : "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.",
"code" : "revoke",
"resource" : [
"ServiceRequest"
],
"system" : false,
"type" : false,
"instance" : true,
"outputProfile" : "https://fhir.senaite.org/StructureDefinition/SenaiteServiceRequestRevocation",
"parameter" : [
{
"name" : "reason",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "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.",
"type" : "string"
},
{
"name" : "return",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "The updated ServiceRequest with status set to revoked. If a reason was supplied, it will be present in note[0].text.",
"type" : "ServiceRequest",
"targetProfile" : [
🔗 "https://fhir.senaite.org/StructureDefinition/SenaiteServiceRequestRevocation"
]
}
]
}