ERA FHIR specification
1.0.0 - draft
ERA FHIR specification - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Draft as of 2026-10-28 |
{
"resourceType" : "OperationDefinition",
"id" : "send-kvp-relay-request",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition send-kvp-relay-request</b></p><a name=\"send-kvp-relay-request\"> </a><a name=\"hcsend-kvp-relay-request\"> </a><p>URL: [base]/CommunicationRequest/$send-kvp-relay-request</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/patient.html\">Patient</a></td><td/><td><div><p>Patient whose document will be relayed. Must conform KVPPatient profile.</p>\n</div></td></tr><tr><td>IN</td><td>documentOid</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>Document OID of the object of the relay request.</p>\n</div></td></tr><tr><td>IN</td><td>recipient</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#Coding\">Coding</a></td><td/><td><div><p>OID of the recipient who is the target of the relay request. The identifier must be from the code system 1.2.246.537.6.40191.201701 Viestinvälitys - Sanoman vastaanottaja.</p>\n</div></td></tr><tr><td>IN</td><td>reasonCode</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#Coding\">Coding</a></td><td/><td><div><p>Reason for sending the relay request. The Value must be from the code system 1.2.246.537.6.40192 - Viestinvälitys välitysperuste.</p>\n</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/operationoutcome.html\">OperationOutcome</a></td><td/><td><div><p>Information on whether the relay request succeeded or failed.</p>\n</div></td></tr></table></div>"
},
"url" : "https://eradocumentation.atostek.com/OperationDefinition/CommunicationRequest-send-kvp-relay-request",
"version" : "1.0.0",
"name" : "send-kvp-relay-request",
"title" : "Send KVP Relay Request",
"status" : "draft",
"kind" : "operation",
"date" : "2026-10-28T11:52:12+00:00",
"publisher" : "Atostek",
"contact" : [
{
"name" : "Atostek",
"telecom" : [
{
"system" : "url",
"value" : "https://atostek.com/"
}
]
}
],
"description" : "Send a relay request to Kysely- ja välityspalvelu (KVP).",
"code" : "send-kvp-relay-request",
"resource" : [
"CommunicationRequest"
],
"system" : false,
"type" : true,
"instance" : false,
"parameter" : [
{
"name" : "subject",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "Patient whose document will be relayed. Must conform KVPPatient profile.",
"type" : "Patient"
},
{
"name" : "documentOid",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "Document OID of the object of the relay request.",
"type" : "string"
},
{
"name" : "recipient",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "OID of the recipient who is the target of the relay request. The identifier must be from the code system 1.2.246.537.6.40191.201701 Viestinvälitys - Sanoman vastaanottaja.",
"type" : "Coding"
},
{
"name" : "reasonCode",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "Reason for sending the relay request. The Value must be from the code system 1.2.246.537.6.40192 - Viestinvälitys välitysperuste.",
"type" : "Coding"
},
{
"name" : "return",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "Information on whether the relay request succeeded or failed.",
"type" : "OperationOutcome"
}
]
}