eHealth Infrastructure
2021.3.0 - build

eHealth Infrastructure - Local Development build (v2021.3.0). See the Directory of published versions

: Fetch ssl orders - JSON Representation

Raw json | Download


{
  "resourceType" : "OperationDefinition",
  "id" : "-s-fetch-ssl-orders",
  "text" : {
    "status" : "extensions",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><h2>fetch-ssl-orders</h2><p>OPERATION: fetch-ssl-orders</p><p>The official URL for this operation definition is: </p><pre>https://reporting.devtest.systematic-ehealth.com/fhir/OperationDefinition/-s-fetch-ssl-orders</pre><div><h3>Report Contents</h3>\n<p>This report contains SSL Orders</p>\n<ul>\n<li>OrderDetails</li>\n<li>OrderLines</li>\n<li>TraceLines</li>\n</ul>\n<h3>Grouping</h3>\n<p>Order. Each Order is returned in a single JSon file.</p>\n<h3>Parameters</h3>\n<ul>\n<li>organization: Filter on Order.buyer</li>\n<li>period: Filter on TraceLine.timestamp</li>\n<li>seller: Filter on Order.seller</li>\n</ul>\n<h3>Output</h3>\n<p>Output can be found in Binary.content. This is a Base64 encoded .zip file containing JSon files corresponding to the report groups.</p>\n<h3>Example output</h3>\n<p>All returned objects are SSL resources. See the SSL API description for details</p>\n<pre><code>{\n    'OrderDetails': {\n        'order': {\n            'id': 'https://ssl-order.local.ehealth.sundhed.dk/v1/order/ORDER',\n            'threadId': null,\n            'identifiers': null,\n            'status': null,\n            'priority': null,\n            'notes': null,\n            'buyer': 'https://ssl-order.local.ehealth.sundhed.dk/v1/party/BUYER',\n            'seller': 'https://ssl-order.local.ehealth.sundhed.dk/v1/party/SELLER',\n            'sellerDeliveryContactEmail': null,\n            'carePlanRef': null,\n            'carePlanTitle': null,\n            'earliestDeliveryDate': null,\n            'latestDeliveryDate': null,\n            'receiver': null\n        },\n        'orderLines': [{\n                'id': 'https://ssl-order.local.ehealth.sundhed.dk/v1/order-line/ORDERLINE',\n                'order': 'https://ssl-order.local.ehealth.sundhed.dk/v1/order/ORDER',\n                'status': null,\n                'item': null,\n                'agreedDate': null,\n                'device': null\n            }\n        ],\n        'traceLines': [{\n                'id': 'https://ssl-order.local.ehealth.sundhed.dk/v1/order/ORDER/1',\n                'timestamp': '2019-12-24T18:00:00Z',\n                'createdByOrganization': null,\n                'createdByUser': null,\n                'text': null,\n                'supplementaryText': null,\n                'order': 'https://ssl-order.local.ehealth.sundhed.dk/v1/order/ORDER',\n                'orderLine': null,\n                'statusChange': null\n            }\n        ]\n    }\n}\n</code></pre>\n</div><p>URL: [base]/$fetch-ssl-orders</p><p>Parameters</p><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</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>anonymization</td><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td/></tr><tr><td>IN</td><td>organization</td><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/references.html#Reference\">Reference</a></td><td/><td/></tr><tr><td>IN</td><td>seller</td><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/references.html#Reference\">Reference</a></td><td/><td/></tr><tr><td>IN</td><td>period</td><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#Period\">Period</a></td><td/><td/></tr><tr><td>OUT</td><td>return</td><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/binary.html\">Binary</a></td><td/><td/></tr></table></div>"
  },
  "url" : "https://reporting.devtest.systematic-ehealth.com/fhir/OperationDefinition/-s-fetch-ssl-orders",
  "version" : "2021.3.0",
  "name" : "fetch-ssl-orders",
  "title" : "Fetch ssl orders",
  "status" : "active",
  "kind" : "operation",
  "date" : "2021-11-25T09:32:14+00:00",
  "publisher" : "Systematic | Trifork",
  "contact" : [
    {
      "name" : "Systematic | Trifork",
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://ehealth.sundhed.dk"
        }
      ]
    }
  ],
  "description" : "### Report Contents\nThis report contains SSL Orders\n- OrderDetails\n- OrderLines\n- TraceLines\n### Grouping \nOrder. Each Order is returned in a single JSon file.\n### Parameters\n- organization: Filter on Order.buyer\n- period: Filter on TraceLine.timestamp\n- seller: Filter on Order.seller\n### Output\nOutput can be found in Binary.content. This is a Base64 encoded .zip file containing JSon files corresponding to the report groups.\n### Example output\nAll returned objects are SSL resources. See the SSL API description for details\n\n    {\n        'OrderDetails': {\n            'order': {\n                'id': 'https://ssl-order.local.ehealth.sundhed.dk/v1/order/ORDER',\n                'threadId': null,\n                'identifiers': null,\n                'status': null,\n                'priority': null,\n                'notes': null,\n                'buyer': 'https://ssl-order.local.ehealth.sundhed.dk/v1/party/BUYER',\n                'seller': 'https://ssl-order.local.ehealth.sundhed.dk/v1/party/SELLER',\n                'sellerDeliveryContactEmail': null,\n                'carePlanRef': null,\n                'carePlanTitle': null,\n                'earliestDeliveryDate': null,\n                'latestDeliveryDate': null,\n                'receiver': null\n            },\n            'orderLines': [{\n                    'id': 'https://ssl-order.local.ehealth.sundhed.dk/v1/order-line/ORDERLINE',\n                    'order': 'https://ssl-order.local.ehealth.sundhed.dk/v1/order/ORDER',\n                    'status': null,\n                    'item': null,\n                    'agreedDate': null,\n                    'device': null\n                }\n            ],\n            'traceLines': [{\n                    'id': 'https://ssl-order.local.ehealth.sundhed.dk/v1/order/ORDER/1',\n                    'timestamp': '2019-12-24T18:00:00Z',\n                    'createdByOrganization': null,\n                    'createdByUser': null,\n                    'text': null,\n                    'supplementaryText': null,\n                    'order': 'https://ssl-order.local.ehealth.sundhed.dk/v1/order/ORDER',\n                    'orderLine': null,\n                    'statusChange': null\n                }\n            ]\n        }\n    }\n",
  "affectsState" : true,
  "code" : "fetch-ssl-orders",
  "system" : true,
  "type" : false,
  "instance" : false,
  "parameter" : [
    {
      "name" : "anonymization",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "type" : "string"
    },
    {
      "name" : "organization",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "type" : "Reference"
    },
    {
      "name" : "seller",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "type" : "Reference"
    },
    {
      "name" : "period",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "type" : "Period"
    },
    {
      "name" : "return",
      "use" : "out",
      "min" : 0,
      "max" : "1",
      "type" : "Binary"
    }
  ]
}