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 |
<OperationDefinition xmlns="http://hl7.org/fhir">
<id value="SenaiteServiceRequestRevoke"/>
<text>
<status value="generated"/>
<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>
</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>
</div></td></tr></table></div>
</text>
<url
value="https://fhir.senaite.org/OperationDefinition/SenaiteServiceRequestRevoke"/>
<version value="0.1.0"/>
<name value="revoke"/>
<title value="Revoke a ServiceRequest"/>
<status value="active"/>
<kind value="operation"/>
<date value="2026-11-05T16:10:27+01:00"/>
<publisher value="Naralabs"/>
<contact>
<name value="Naralabs"/>
<telecom>
<system value="url"/>
<value value="https://naralabs.com"/>
</telecom>
<telecom>
<system value="email"/>
<value value="info@naralabs.com"/>
</telecom>
</contact>
<contact>
<name value="Senaite FHIR"/>
<telecom>
<system value="email"/>
<value value="info@naralabs.com"/>
<use value="work"/>
</telecom>
</contact>
<description
value="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 value="revoke"/>
<resource value="ServiceRequest"/>
<system value="false"/>
<type value="false"/>
<instance value="true"/>
<outputProfile
value="https://fhir.senaite.org/StructureDefinition/SenaiteServiceRequestRevocation"/>
<parameter>
<name value="reason"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="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 value="string"/>
</parameter>
<parameter>
<name value="return"/>
<use value="out"/>
<min value="1"/>
<max value="1"/>
<documentation
value="The updated ServiceRequest with status set to revoked. If a reason was supplied, it will be present in note[0].text."/>
<type value="ServiceRequest"/>
<targetProfile
value="https://fhir.senaite.org/StructureDefinition/SenaiteServiceRequestRevocation"/>
</parameter>
</OperationDefinition>