Social Care Interoperability Platform FHIR Implementation Guide
Version: 0.1.0, Status: draft
Social Care Interoperability Platform FHIR Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Draft as of 2026-03-24 |
<OperationDefinition xmlns="http://hl7.org/fhir">
<id value="Operation-MODSDSCRPatientTransfer"/>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: OperationDefinition Operation-MODSDSCRPatientTransfer</b></p><a name="Operation-MODSDSCRPatientTransfer"> </a><a name="hcOperation-MODSDSCRPatientTransfer"> </a><p>URL: [base]/Patient/$transfer</p><p>Input parameters Profile:<a href="StructureDefinition-MODS-DSCRTransferParametersIn-1.html">MODS DSCR $transfer — Input Parameters</a></p><p>Output parameters Profile:<a href="StructureDefinition-MODS-DSCRTransferParametersOutput-1.html">MODS DSCR $transfer — Output Parameters</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>subject</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/references.html#Reference">Reference</a> (<a href="StructureDefinition-MODS-Patient.html" title="https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/MODS-Patient">MODS Patient</a>)</td><td/><td><div><p>Logical-only reference to Patient (identifier+display; no literal reference). Who the request is about (the subject of care or patient).</p>
</div></td></tr><tr><td>IN</td><td>fulfiller</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/references.html#Reference">Reference</a> (<a href="StructureDefinition-MODS-Organization.html" title="https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/MODS-Organization">MODS Organization</a>)</td><td/><td><div><p>Logical-only reference to Organization (identifier+display; no literal reference). The organisation who 'owns' or oversees the request to fulfillment (the organisation providing the data).</p>
</div></td></tr><tr><td>IN</td><td>requestor</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/references.html#Reference">Reference</a> (<a href="StructureDefinition-MODS-Organization.html" title="https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/MODS-Organization">MODS Organization</a>)</td><td/><td><div><p>Logical-only reference to Organization (identifier+display; no literal reference). The organisation who initiated or placed the request.</p>
</div></td></tr><tr><td>IN</td><td>requestedBy</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/references.html#Reference">Reference</a> (<a href="StructureDefinition-MODS-Practitioner.html" title="https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/MODS-Practitioner">MODS Practitioner</a>)</td><td/><td><div><p>Logical-only reference to Practitioner (identifier+display; no literal reference). The person who initiated or placed the request.</p>
</div></td></tr><tr><td>IN</td><td>fulfilledBy</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/references.html#Reference">Reference</a> (<a href="StructureDefinition-MODS-Practitioner.html" title="https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/MODS-Practitioner">MODS Practitioner</a>)</td><td/><td><div><p>Logical-only reference to Practitioner (identifier+display; no literal reference). The person who 'owns' or oversees the request to fulfillment.</p>
</div></td></tr><tr><td>IN</td><td>targetCompletion</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#date">date</a></td><td/><td><div><p>Requested completion date (YYYY, YYYY-MM, or YYYY-MM-DD).</p>
</div></td></tr><tr><td>IN</td><td>status</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#code">code</a></td><td><a href="ValueSet-MODS-DSCRTransferStatus-1.html">MODS DSCR Transfer Status</a> (Required)</td><td><div><p>Required transfer status; initial/default is 'requested'.</p>
</div></td></tr><tr><td>IN</td><td>statusLastUpdated</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#dateTime">dateTime</a></td><td/><td><div><p>Last date/time the status changed in ISO datetime format.</p>
</div></td></tr><tr><td>IN</td><td>note</td><td/><td>0..*</td><td/><td/><td><div><p>Optional note with date and text; text limited to 250 chars.</p>
</div></td></tr><tr><td>IN</td><td>note.date</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#dateTime">dateTime</a></td><td/><td/></tr><tr><td>IN</td><td>note.text</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>Free text, max 250 characters.</p>
</div></td></tr><tr><td>IN</td><td>requestorTrackingId</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>Stable, unique ID from the requestor (enforced by implementors).</p>
</div></td></tr><tr><td>IN</td><td>fulfillerTrackingId</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>Stable, unique ID from the fulfiller when present (enforced by implementors).</p>
</div></td></tr><tr><td>OUT</td><td>operationOutcome</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/operationoutcome.html">OperationOutcome</a></td><td/><td><div><p>OperationOutcome resource with status information</p>
</div></td></tr><tr><td>OUT</td><td>requestorTrackingId</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>Stable, unique ID from the requestor</p>
</div></td></tr><tr><td>OUT</td><td>fulfillerTrackingId</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>Stable, unique ID from the fulfiller when present</p>
</div></td></tr><tr><td>OUT</td><td>targetCompletion</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#date">date</a></td><td/><td><div><p>Requested completion date (YYYY, YYYY-MM, or YYYY-MM-DD).</p>
</div></td></tr><tr><td>OUT</td><td>status</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#code">code</a></td><td><a href="ValueSet-MODS-DSCRTransferStatus-1.html">MODS DSCR Transfer Status</a> (Required)</td><td><div><p>Required transfer status; if this is a response to a new request, the status will be 'received'</p>
</div></td></tr><tr><td>OUT</td><td>statusLastUpdated</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#dateTime">dateTime</a></td><td/><td><div><p>Last date/time the status changed in ISO datetime format.</p>
</div></td></tr><tr><td>OUT</td><td>subject</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/references.html#Reference">Reference</a> (<a href="StructureDefinition-MODS-Patient.html" title="https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/MODS-Patient">MODS Patient</a>)</td><td/><td><div><p>Logical-only reference to Patient (identifier+display; no literal reference). Who the request is about (the subject of care or patient).</p>
</div></td></tr><tr><td>OUT</td><td>fulfiller</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/references.html#Reference">Reference</a> (<a href="StructureDefinition-MODS-Organization.html" title="https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/MODS-Organization">MODS Organization</a>)</td><td/><td><div><p>Logical-only reference to Organization (identifier+display; no literal reference). The organisation who 'owns' or oversees the request to fulfillment (the organisation providing the data).</p>
</div></td></tr><tr><td>OUT</td><td>requestor</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/references.html#Reference">Reference</a> (<a href="StructureDefinition-MODS-Organization.html" title="https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/MODS-Organization">MODS Organization</a>)</td><td/><td><div><p>Logical-only reference to Organization (identifier+display; no literal reference). The organisation who initiated or placed the request.</p>
</div></td></tr><tr><td>OUT</td><td>requestedBy</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/references.html#Reference">Reference</a> (<a href="StructureDefinition-MODS-Practitioner.html" title="https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/MODS-Practitioner">MODS Practitioner</a>)</td><td/><td><div><p>Logical-only reference to Practitioner (identifier+display; no literal reference). The person who initiated or placed the request.</p>
</div></td></tr><tr><td>OUT</td><td>fulfilledBy</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/references.html#Reference">Reference</a> (<a href="StructureDefinition-MODS-Practitioner.html" title="https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/MODS-Practitioner">MODS Practitioner</a>)</td><td/><td><div><p>Logical-only reference to Practitioner (identifier+display; no literal reference). The person who 'owns' or oversees the request to fulfillment.</p>
</div></td></tr><tr><td>OUT</td><td>note</td><td/><td>0..*</td><td/><td/><td><div><p>Optional note with date and text; text limited to 250 chars.</p>
</div></td></tr><tr><td>OUT</td><td>note.date</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#dateTime">dateTime</a></td><td/><td/></tr><tr><td>OUT</td><td>note.text</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>Free text, max 250 characters.</p>
</div></td></tr></table></div>
</text>
<url
value="https://metadata.phase2.scip.synanetics.cloud/fhir/r4/OperationDefinition/Operation-MODS-DSCRPatientTransfer-1"/>
<version value="0.1.0"/>
<name value="MODS DSCR Transfer"/>
<title value="MODS DSCR to DSCR transfer"/>
<status value="draft"/>
<kind value="operation"/>
<date value="2026-03-24T16:18:08+00:00"/>
<publisher
value="Synanetics Ltd on behalf of DHSC/Social Care Interoperability Platform"/>
<contact>
<name
value="Synanetics Ltd on behalf of DHSC/Social Care Interoperability Platform"/>
<telecom>
<system value="url"/>
<value value="https://synanetics.com"/>
</telecom>
<telecom>
<system value="email"/>
<value value="info@synanetics.com"/>
</telecom>
</contact>
<description
value="Transfers a patient from one organisation/service/care context to another.
Invoked at the Patient type level because the fulfiller does not know the server-assigned Patient id."/>
<jurisdiction>
<coding>
<system value="urn:iso:std:iso:3166"/>
<code value="GB"/>
<display value="United Kingdom of Great Britain and Northern Ireland"/>
</coding>
</jurisdiction>
<affectsState value="true"/>
<code value="transfer"/>
<resource value="Patient"/>
<system value="false"/>
<type value="true"/>
<instance value="false"/>
<inputProfile
value="https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/MODS-DSCRTransferParametersIn-1"/>
<outputProfile
value="https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/MODS-DSCRTransferParametersOutput-1"/>
<parameter>
<name value="subject"/>
<use value="in"/>
<min value="1"/>
<max value="1"/>
<documentation
value="Logical-only reference to Patient (identifier+display; no literal reference). Who the request is about (the subject of care or patient)."/>
<type value="Reference"/>
<targetProfile
value="https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/MODS-Patient"/>
</parameter>
<parameter>
<name value="fulfiller"/>
<use value="in"/>
<min value="1"/>
<max value="1"/>
<documentation
value="Logical-only reference to Organization (identifier+display; no literal reference). The organisation who 'owns' or oversees the request to fulfillment (the organisation providing the data)."/>
<type value="Reference"/>
<targetProfile
value="https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/MODS-Organization"/>
</parameter>
<parameter>
<name value="requestor"/>
<use value="in"/>
<min value="1"/>
<max value="1"/>
<documentation
value="Logical-only reference to Organization (identifier+display; no literal reference). The organisation who initiated or placed the request."/>
<type value="Reference"/>
<targetProfile
value="https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/MODS-Organization"/>
</parameter>
<parameter>
<name value="requestedBy"/>
<use value="in"/>
<min value="1"/>
<max value="1"/>
<documentation
value="Logical-only reference to Practitioner (identifier+display; no literal reference). The person who initiated or placed the request."/>
<type value="Reference"/>
<targetProfile
value="https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/MODS-Practitioner"/>
</parameter>
<parameter>
<name value="fulfilledBy"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="Logical-only reference to Practitioner (identifier+display; no literal reference). The person who 'owns' or oversees the request to fulfillment."/>
<type value="Reference"/>
<targetProfile
value="https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/MODS-Practitioner"/>
</parameter>
<parameter>
<name value="targetCompletion"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="Requested completion date (YYYY, YYYY-MM, or YYYY-MM-DD)."/>
<type value="date"/>
</parameter>
<parameter>
<name value="status"/>
<use value="in"/>
<min value="1"/>
<max value="1"/>
<documentation
value="Required transfer status; initial/default is 'requested'."/>
<type value="code"/>
<binding>
<strength value="required"/>
<valueSet
value="https://metadata.phase2.scip.synanetics.cloud/fhir/r4/ValueSet/MODS-DSCRTransferStatus-1"/>
</binding>
</parameter>
<parameter>
<name value="statusLastUpdated"/>
<use value="in"/>
<min value="1"/>
<max value="1"/>
<documentation
value="Last date/time the status changed in ISO datetime format."/>
<type value="dateTime"/>
</parameter>
<parameter>
<name value="note"/>
<use value="in"/>
<min value="0"/>
<max value="*"/>
<documentation
value="Optional note with date and text; text limited to 250 chars."/>
<part>
<name value="date"/>
<use value="in"/>
<min value="1"/>
<max value="1"/>
<type value="dateTime"/>
</part>
<part>
<name value="text"/>
<use value="in"/>
<min value="1"/>
<max value="1"/>
<documentation value="Free text, max 250 characters."/>
<type value="string"/>
</part>
</parameter>
<parameter>
<name value="requestorTrackingId"/>
<use value="in"/>
<min value="1"/>
<max value="1"/>
<documentation
value="Stable, unique ID from the requestor (enforced by implementors)."/>
<type value="string"/>
</parameter>
<parameter>
<name value="fulfillerTrackingId"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="Stable, unique ID from the fulfiller when present (enforced by implementors)."/>
<type value="string"/>
</parameter>
<parameter>
<name value="operationOutcome"/>
<use value="out"/>
<min value="1"/>
<max value="1"/>
<documentation value="OperationOutcome resource with status information"/>
<type value="OperationOutcome"/>
</parameter>
<parameter>
<name value="requestorTrackingId"/>
<use value="out"/>
<min value="1"/>
<max value="1"/>
<documentation value="Stable, unique ID from the requestor"/>
<type value="string"/>
</parameter>
<parameter>
<name value="fulfillerTrackingId"/>
<use value="out"/>
<min value="0"/>
<max value="1"/>
<documentation value="Stable, unique ID from the fulfiller when present"/>
<type value="string"/>
</parameter>
<parameter>
<name value="targetCompletion"/>
<use value="out"/>
<min value="0"/>
<max value="1"/>
<documentation
value="Requested completion date (YYYY, YYYY-MM, or YYYY-MM-DD)."/>
<type value="date"/>
</parameter>
<parameter>
<name value="status"/>
<use value="out"/>
<min value="1"/>
<max value="1"/>
<documentation
value="Required transfer status; if this is a response to a new request, the status will be 'received'"/>
<type value="code"/>
<binding>
<strength value="required"/>
<valueSet
value="https://metadata.phase2.scip.synanetics.cloud/fhir/r4/ValueSet/MODS-DSCRTransferStatus-1"/>
</binding>
</parameter>
<parameter>
<name value="statusLastUpdated"/>
<use value="out"/>
<min value="1"/>
<max value="1"/>
<documentation
value="Last date/time the status changed in ISO datetime format."/>
<type value="dateTime"/>
</parameter>
<parameter>
<name value="subject"/>
<use value="out"/>
<min value="1"/>
<max value="1"/>
<documentation
value="Logical-only reference to Patient (identifier+display; no literal reference). Who the request is about (the subject of care or patient)."/>
<type value="Reference"/>
<targetProfile
value="https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/MODS-Patient"/>
</parameter>
<parameter>
<name value="fulfiller"/>
<use value="out"/>
<min value="1"/>
<max value="1"/>
<documentation
value="Logical-only reference to Organization (identifier+display; no literal reference). The organisation who 'owns' or oversees the request to fulfillment (the organisation providing the data)."/>
<type value="Reference"/>
<targetProfile
value="https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/MODS-Organization"/>
</parameter>
<parameter>
<name value="requestor"/>
<use value="out"/>
<min value="1"/>
<max value="1"/>
<documentation
value="Logical-only reference to Organization (identifier+display; no literal reference). The organisation who initiated or placed the request."/>
<type value="Reference"/>
<targetProfile
value="https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/MODS-Organization"/>
</parameter>
<parameter>
<name value="requestedBy"/>
<use value="out"/>
<min value="1"/>
<max value="1"/>
<documentation
value="Logical-only reference to Practitioner (identifier+display; no literal reference). The person who initiated or placed the request."/>
<type value="Reference"/>
<targetProfile
value="https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/MODS-Practitioner"/>
</parameter>
<parameter>
<name value="fulfilledBy"/>
<use value="out"/>
<min value="0"/>
<max value="1"/>
<documentation
value="Logical-only reference to Practitioner (identifier+display; no literal reference). The person who 'owns' or oversees the request to fulfillment."/>
<type value="Reference"/>
<targetProfile
value="https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/MODS-Practitioner"/>
</parameter>
<parameter>
<name value="note"/>
<use value="out"/>
<min value="0"/>
<max value="*"/>
<documentation
value="Optional note with date and text; text limited to 250 chars."/>
<part>
<name value="date"/>
<use value="out"/>
<min value="1"/>
<max value="1"/>
<type value="dateTime"/>
</part>
<part>
<name value="text"/>
<use value="out"/>
<min value="1"/>
<max value="1"/>
<documentation value="Free text, max 250 characters."/>
<type value="string"/>
</part>
</parameter>
</OperationDefinition>