ERA FHIR specification - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Narrative Content
• XML
• JSON

: Get KVP relay request - JSON Representation

Draft as of 2026-10-28

Raw json | Download

{
  "resourceType" : "OperationDefinition",
  "id" : "get-kvp-relay-request",
  "text" : {
    "status" : "generated",
    "div" : "<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>\n</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>\n</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>\n</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>\n</div></td></tr></table></div>"
  },
  "url" : "https://eradocumentation.atostek.com/OperationDefinition/CommunicationRequest-get-kvp-relay-request",
  "version" : "1.0.0",
  "name" : "get-kvp-relay-request",
  "title" : "Get 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" : "The operation can be used to fetch relay requests of a given document.",
  "code" : "get-kvp-relay-request",
  "resource" : [
    "CommunicationRequest"
  ],
  "system" : false,
  "type" : true,
  "instance" : false,
  "parameter" : [
    {
      "name" : "patient:identifier",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "PIC or temporary identifier of the patient who is the subject of the relayed document.",
      "type" : "Identifier"
    },
    {
      "name" : "recipient:identifier",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "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" : "Identifier"
    },
    {
      "name" : "payload:identifier",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "OID of the relayed document.",
      "type" : "Identifier"
    },
    {
      "name" : "return",
      "use" : "out",
      "min" : 1,
      "max" : "1",
      "documentation" : "Searchset bundle from KVP which contains all the matching CommunicationRequest-resources conforming the Valityspyynto profile.",
      "type" : "Bundle"
    }
  ]
}