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 |
<OperationDefinition xmlns="http://hl7.org/fhir">
<id value="get-kvp-relay-request"/>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: OperationDefinition get-kvp-relay-request</b></p><a name="get-kvp-relay-request"> </a><a name="hcget-kvp-relay-request"> </a><p>URL: [base]/CommunicationRequest/$get-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>patient:identifier</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#Identifier">Identifier</a></td><td/><td><div><p>PIC or temporary identifier of the patient who is the subject of the relayed document.</p>
</div></td></tr><tr><td>IN</td><td>recipient:identifier</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#Identifier">Identifier</a></td><td/><td><div><p>OID of the recipient who is the target of the relay request. The identifier must be from Viestinvälitys - Sanoman vastaanottaja (1.2.246.537.6.40191.201701). If omitted, no organization filter is applied.</p>
</div></td></tr><tr><td>IN</td><td>payload:identifier</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#Identifier">Identifier</a></td><td/><td><div><p>OID of the relayed document.</p>
</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/bundle.html">Bundle</a></td><td/><td><div><p>Searchset bundle from KVP which contains all the matching CommunicationRequest-resources conforming the Valityspyynto profile.</p>
</div></td></tr></table></div>
</text>
<url
value="https://eradocumentation.atostek.com/OperationDefinition/CommunicationRequest-get-kvp-relay-request"/>
<version value="1.0.0"/>
<name value="get-kvp-relay-request"/>
<title value="Get 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="The operation can be used to fetch relay requests of a given document."/>
<code value="get-kvp-relay-request"/>
<resource value="CommunicationRequest"/>
<system value="false"/>
<type value="true"/>
<instance value="false"/>
<parameter>
<name value="patient:identifier"/>
<use value="in"/>
<min value="1"/>
<max value="1"/>
<documentation
value="PIC or temporary identifier of the patient who is the subject of the relayed document."/>
<type value="Identifier"/>
</parameter>
<parameter>
<name value="recipient:identifier"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="OID of the recipient who is the target of the relay request. The identifier must be from Viestinvälitys - Sanoman vastaanottaja (1.2.246.537.6.40191.201701). If omitted, no organization filter is applied."/>
<type value="Identifier"/>
</parameter>
<parameter>
<name value="payload:identifier"/>
<use value="in"/>
<min value="1"/>
<max value="1"/>
<documentation value="OID of the relayed document."/>
<type value="Identifier"/>
</parameter>
<parameter>
<name value="return"/>
<use value="out"/>
<min value="1"/>
<max value="1"/>
<documentation
value="Searchset bundle from KVP which contains all the matching CommunicationRequest-resources conforming the Valityspyynto profile."/>
<type value="Bundle"/>
</parameter>
</OperationDefinition>