Generated Narrative: OperationDefinition get-kvp-relay-request

URL: [base]/CommunicationRequest/$get-kvp-relay-request

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INpatient:identifier1..1Identifier

PIC or temporary identifier of the patient who is the subject of the relayed document.

INrecipient:identifier0..1Identifier

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.

INpayload:identifier1..1Identifier

OID of the relayed document.

OUTreturn1..1Bundle

Searchset bundle from KVP which contains all the matching CommunicationRequest-resources conforming the Valityspyynto profile.

 <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>