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 |
{
"resourceType" : "OperationDefinition",
"id" : "Operation-MODSDSCRPatientTransfer",
"text" : {
"status" : "generated",
"div" : "<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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</div></td></tr></table></div>"
},
"url" : "https://metadata.phase2.scip.synanetics.cloud/fhir/r4/OperationDefinition/Operation-MODS-DSCRPatientTransfer-1",
"version" : "0.1.0",
"name" : "MODS DSCR Transfer",
"title" : "MODS DSCR to DSCR transfer",
"status" : "draft",
"kind" : "operation",
"date" : "2026-03-24T16:18:08+00:00",
"publisher" : "Synanetics Ltd on behalf of DHSC/Social Care Interoperability Platform",
"contact" : [
{
"name" : "Synanetics Ltd on behalf of DHSC/Social Care Interoperability Platform",
"telecom" : [
{
"system" : "url",
"value" : "https://synanetics.com"
},
{
"system" : "email",
"value" : "info@synanetics.com"
}
]
}
],
"description" : "Transfers a patient from one organisation/service/care context to another.\nInvoked at the Patient type level because the fulfiller does not know the server-assigned Patient id.",
"jurisdiction" : [
{
"coding" : [
{
"system" : "urn:iso:std:iso:3166",
"code" : "GB",
"display" : "United Kingdom of Great Britain and Northern Ireland"
}
]
}
],
"affectsState" : true,
"code" : "transfer",
"resource" : [
"Patient"
],
"system" : false,
"type" : true,
"instance" : false,
"inputProfile" : "https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/MODS-DSCRTransferParametersIn-1",
"outputProfile" : "https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/MODS-DSCRTransferParametersOutput-1",
"parameter" : [
{
"name" : "subject",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "Logical-only reference to Patient (identifier+display; no literal reference). Who the request is about (the subject of care or patient).",
"type" : "Reference",
"targetProfile" : [
🔗 "https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/MODS-Patient"
]
},
{
"name" : "fulfiller",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "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" : "Reference",
"targetProfile" : [
🔗 "https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/MODS-Organization"
]
},
{
"name" : "requestor",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "Logical-only reference to Organization (identifier+display; no literal reference). The organisation who initiated or placed the request.",
"type" : "Reference",
"targetProfile" : [
🔗 "https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/MODS-Organization"
]
},
{
"name" : "requestedBy",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "Logical-only reference to Practitioner (identifier+display; no literal reference). The person who initiated or placed the request.",
"type" : "Reference",
"targetProfile" : [
🔗 "https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/MODS-Practitioner"
]
},
{
"name" : "fulfilledBy",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Logical-only reference to Practitioner (identifier+display; no literal reference). The person who 'owns' or oversees the request to fulfillment.",
"type" : "Reference",
"targetProfile" : [
🔗 "https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/MODS-Practitioner"
]
},
{
"name" : "targetCompletion",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Requested completion date (YYYY, YYYY-MM, or YYYY-MM-DD).",
"type" : "date"
},
{
"name" : "status",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "Required transfer status; initial/default is 'requested'.",
"type" : "code",
"binding" : {
"strength" : "required",
"valueSet" : "https://metadata.phase2.scip.synanetics.cloud/fhir/r4/ValueSet/MODS-DSCRTransferStatus-1"
}
},
{
"name" : "statusLastUpdated",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "Last date/time the status changed in ISO datetime format.",
"type" : "dateTime"
},
{
"name" : "note",
"use" : "in",
"min" : 0,
"max" : "*",
"documentation" : "Optional note with date and text; text limited to 250 chars.",
"part" : [
{
"name" : "date",
"use" : "in",
"min" : 1,
"max" : "1",
"type" : "dateTime"
},
{
"name" : "text",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "Free text, max 250 characters.",
"type" : "string"
}
]
},
{
"name" : "requestorTrackingId",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "Stable, unique ID from the requestor (enforced by implementors).",
"type" : "string"
},
{
"name" : "fulfillerTrackingId",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Stable, unique ID from the fulfiller when present (enforced by implementors).",
"type" : "string"
},
{
"name" : "operationOutcome",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "OperationOutcome resource with status information",
"type" : "OperationOutcome"
},
{
"name" : "requestorTrackingId",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "Stable, unique ID from the requestor",
"type" : "string"
},
{
"name" : "fulfillerTrackingId",
"use" : "out",
"min" : 0,
"max" : "1",
"documentation" : "Stable, unique ID from the fulfiller when present",
"type" : "string"
},
{
"name" : "targetCompletion",
"use" : "out",
"min" : 0,
"max" : "1",
"documentation" : "Requested completion date (YYYY, YYYY-MM, or YYYY-MM-DD).",
"type" : "date"
},
{
"name" : "status",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "Required transfer status; if this is a response to a new request, the status will be 'received'",
"type" : "code",
"binding" : {
"strength" : "required",
"valueSet" : "https://metadata.phase2.scip.synanetics.cloud/fhir/r4/ValueSet/MODS-DSCRTransferStatus-1"
}
},
{
"name" : "statusLastUpdated",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "Last date/time the status changed in ISO datetime format.",
"type" : "dateTime"
},
{
"name" : "subject",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "Logical-only reference to Patient (identifier+display; no literal reference). Who the request is about (the subject of care or patient).",
"type" : "Reference",
"targetProfile" : [
🔗 "https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/MODS-Patient"
]
},
{
"name" : "fulfiller",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "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" : "Reference",
"targetProfile" : [
🔗 "https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/MODS-Organization"
]
},
{
"name" : "requestor",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "Logical-only reference to Organization (identifier+display; no literal reference). The organisation who initiated or placed the request.",
"type" : "Reference",
"targetProfile" : [
🔗 "https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/MODS-Organization"
]
},
{
"name" : "requestedBy",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "Logical-only reference to Practitioner (identifier+display; no literal reference). The person who initiated or placed the request.",
"type" : "Reference",
"targetProfile" : [
🔗 "https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/MODS-Practitioner"
]
},
{
"name" : "fulfilledBy",
"use" : "out",
"min" : 0,
"max" : "1",
"documentation" : "Logical-only reference to Practitioner (identifier+display; no literal reference). The person who 'owns' or oversees the request to fulfillment.",
"type" : "Reference",
"targetProfile" : [
🔗 "https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/MODS-Practitioner"
]
},
{
"name" : "note",
"use" : "out",
"min" : 0,
"max" : "*",
"documentation" : "Optional note with date and text; text limited to 250 chars.",
"part" : [
{
"name" : "date",
"use" : "out",
"min" : 1,
"max" : "1",
"type" : "dateTime"
},
{
"name" : "text",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "Free text, max 250 characters.",
"type" : "string"
}
]
}
]
}