Specification of the Remove Flag operation, which streamlines removal of an entire Reasonable Adjustments record within the FHIR® Reasonable Adjustments API.
Important: This site is under active development by NHS Digital and is intended to provide all the technical resources you need to successfully develop applications using the FHIR® Reasonable Adjustments API. This project is being developed using an agile methodology so iterative updates to content will be added on a regular basis.
Warning: This site is provided for information only and is intended for those engaged with NHS Digital. It is advised not to develop against these specifications until a formal announcement has been made.
removerarecord operation
The OperationDefinition of removerarecord defines the in parameters for this operation and their structure and content.
RARecord-RemoveRARecord-Operation-1 XML Example
<!-- RARecord-RemoveRARecord-Operation-1 -->
<OperationDefinition xmlns="http://hl7.org/fhir">
<id value="RARecord-RemoveRARecord-Operation-1"/>
<meta>
</meta>
<url value="https://fhir.nhs.uk/STU3/OperationDefinition/RARecord-RemoveRARecord-Operation-1"/>
<version value="1.4.0"/>
<name value="RARecord-RemoveRARecord-Operation"/>
<status value="draft"/>
<kind value="operation"/>
<date value="2018-10-01"/>
<publisher value="NHS Digital"/>
<contact>
<name value="Interoperability Team"/>
<telecom>
<system value="email"/>
<value value="interoperabilityteam@nhs.net"/>
</telecom>
</contact>
<description value="Removes (inactivates) all Reasonable Adjustment Record resources for a given Person (by NHS Number)"/>
<code value="removererecord"/>
<resource value="Consent"/>
<resource value="Flag"/>
<resource value="List"/>
<resource value="Condition"/>
<system value="true"/>
<type value="false"/>
<instance value="false"/>
<parameter>
<name value="removeRARecord"/>
<use value="in"/>
<min value="1"/>
<max value="1"/>
<documentation value="Passes parameters required to Remove all Reasonable Adjustment Record resources."/>
<part>
<name value="nhsNumber"/>
<use value="in"/>
<min value="1"/>
<max value="1"/>
<documentation value="Identifies Person (Patient) whose RA Record is to be removed (inactivated)"/>
<type value="string"/>
</part>
<part>
<name value="removalReason"/>
<use value="in"/>
<min value="1"/>
<max value="1"/>
<documentation value="Code recording Removal Reason"/>
<type value="CodeableConcept"/>
</part>
</parameter>
</OperationDefinition>