Magentus Practice Management FHIR Implementation Guide - Local Development build (v1.2.35) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Narrative Content
• JSON

: Diagnostic Request Claim Operation - JSON Representation

Active as of 2024-06-20

Raw json | Download

{
  "resourceType" : "OperationDefinition",
  "id" : "EOrderClaimOperation",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition EOrderClaimOperation</b></p><a name=\"EOrderClaimOperation\"> </a><a name=\"hcEOrderClaimOperation\"> </a><a name=\"EOrderClaimOperation-en-US\"> </a><p>URL: [base]/ServiceRequest/$claim</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>requisition</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#Identifier\">Identifier</a></td><td/><td><div><p>The group identifier for the request, typically the barcode.</p>\n</div></td></tr><tr><td>IN</td><td>organization</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/references.html#Reference\">Reference</a> (<a href=\"StructureDefinition-gs-organization.html\" title=\"http://fhir.geniesolutions.io/StructureDefinition/gs-organization\">Genie Organization</a>)</td><td/><td><div><p>Reference to the branded organization claiming the request.</p>\n</div></td></tr><tr><td>OUT</td><td>groupTask</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/references.html#Reference\">Reference</a> (<a href=\"StructureDefinition-eorders-task-fulfillment-group.html\" title=\"http://fhir.geniesolutions.io/StructureDefinition/eorders-task-fulfillment-group\">EOrders Task Fulfillment Request Group</a>)</td><td/><td><div><p>Returns a reference to the group <code>Task</code> assigned to the requesting organisation or nothing if an error occurred.</p>\n</div></td></tr><tr><td>OUT</td><td>result</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#Coding\">Coding</a></td><td><a href=\"ValueSet-eorder-claim-result-type-valueset.html\">Request Claim Result Type ValueSet</a> (Required)</td><td><div><p>The result of the attempting request claim.</p>\n</div></td></tr></table><div><ul>\n<li>It is assumed that the claiming provider is sufficiently authorised to claim a request.</li>\n</ul>\n</div></div>"
  },
  "url" : "http://fhir.geniesolutions.io/OperationDefinition/EOrderClaimOperation",
  "version" : "1.2.35",
  "name" : "EOrderClaimOperation",
  "title" : "Diagnostic Request Claim Operation",
  "status" : "active",
  "kind" : "operation",
  "date" : "2024-06-20",
  "publisher" : "Magentus Practice Management",
  "contact" : [
    {
      "name" : "Magentus Practice Management",
      "telecom" : [
        {
          "system" : "url",
          "value" : "https://www.magentus.com/practice-management"
        },
        {
          "system" : "email",
          "value" : "andy.bond@magentus.com"
        }
      ]
    },
    {
      "name" : "Magentus Practice Management",
      "telecom" : [
        {
          "system" : "url",
          "value" : "https://www.magentus.com/practice-management",
          "use" : "work"
        }
      ]
    }
  ],
  "description" : "This operation is used to claim a request based on a scanned barcode and return a group `Task` reference.  The transferred request will result in the creation of a new set of `Task`s, including a group `Task`, each of which will be placed in a `requested` status.  To distinguish a request that has been claimed, the `businessStatus` of the request will be set to `claimed-request`.",
  "code" : "claim",
  "comment" : " - It is assumed that the claiming provider is sufficiently authorised to claim a request.",
  "resource" : [
    "ServiceRequest"
  ],
  "system" : false,
  "type" : true,
  "instance" : false,
  "parameter" : [
    {
      "name" : "requisition",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "The group identifier for the request, typically the barcode.",
      "type" : "Identifier"
    },
    {
      "name" : "organization",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "Reference to the branded organization claiming the request.",
      "type" : "Reference",
      "targetProfile" : [
        🔗 "http://fhir.geniesolutions.io/StructureDefinition/gs-organization"
      ]
    },
    {
      "name" : "groupTask",
      "use" : "out",
      "min" : 0,
      "max" : "1",
      "documentation" : "Returns a reference to the group `Task` assigned to the requesting organisation or nothing if an error occurred.",
      "type" : "Reference",
      "targetProfile" : [
        🔗 "http://fhir.geniesolutions.io/StructureDefinition/eorders-task-fulfillment-group"
      ]
    },
    {
      "name" : "result",
      "use" : "out",
      "min" : 1,
      "max" : "1",
      "documentation" : "The result of the attempting request claim.",
      "type" : "Coding",
      "binding" : {
        "strength" : "required",
        "valueSet" : "http://fhir.geniesolutions.io/ValueSet/eorder-claim-result-type-valueset"
      }
    }
  ]
}