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

: Send KVP Relay Request - XML Representation

Draft as of 2026-10-28

Raw xml | Download


<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="send-kvp-relay-request"/>
  <text>
    <status value="generated"/>
    <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>
</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>
</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>
</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>
</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>
</div></td></tr></table></div>
  </text>
  <url
       value="https://eradocumentation.atostek.com/OperationDefinition/CommunicationRequest-send-kvp-relay-request"/>
  <version value="1.0.0"/>
  <name value="send-kvp-relay-request"/>
  <title value="Send KVP Relay Request"/>
  <status value="draft"/>
  <kind value="operation"/>
  <date value="2026-10-28T11:52:12+00:00"/>
  <publisher value="Atostek"/>
  <contact>
    <name value="Atostek"/>
    <telecom>
      <system value="url"/>
      <value value="https://atostek.com/"/>
    </telecom>
  </contact>
  <description
               value="Send a relay request to Kysely- ja välityspalvelu (KVP)."/>
  <code value="send-kvp-relay-request"/>
  <resource value="CommunicationRequest"/>
  <system value="false"/>
  <type value="true"/>
  <instance value="false"/>
  <parameter>
    <name value="subject"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation
                   value="Patient whose document will be relayed. Must conform KVPPatient profile."/>
    <type value="Patient"/>
  </parameter>
  <parameter>
    <name value="documentOid"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation value="Document OID of the object of the relay request."/>
    <type value="string"/>
  </parameter>
  <parameter>
    <name value="recipient"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation
                   value="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 value="Coding"/>
  </parameter>
  <parameter>
    <name value="reasonCode"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation
                   value="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 value="Coding"/>
  </parameter>
  <parameter>
    <name value="return"/>
    <use value="out"/>
    <min value="1"/>
    <max value="1"/>
    <documentation
                   value="Information on whether the relay request succeeded or failed."/>
    <type value="OperationOutcome"/>
  </parameter>
</OperationDefinition>