eHealth Infrastructure
3.1.0 - release

This page is part of the FUT Infrastructure (v3.1.0: Release) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

: Schedule ssl orders - JSON Representation

Active as of 2024-07-01

Raw json | Download


{
  "resourceType" : "OperationDefinition",
  "id" : "-s-schedule-ssl-orders",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition -s-schedule-ssl-orders</b></p><a name=\"-s-schedule-ssl-orders\"> </a><a name=\"hc-s-schedule-ssl-orders\"> </a><a name=\"hc-s-schedule-ssl-orders-en-US\"> </a><p>URL: [base]/$schedule-ssl-orders</p><p>Parameters</p><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>anonymization</td><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/><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/><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/><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/><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-schedule-ssl-orders",
  "version" : "3.1.0",
  "name" : "schedule-ssl-orders",
  "title" : "Schedule ssl orders",
  "status" : "active",
  "kind" : "operation",
  "date" : "2024-07-01T11:04:33+00:00",
  "publisher" : "Den telemedicinske infrastruktur (eHealth Infrastructure)",
  "contact" : [
    {
      "name" : "Den telemedicinske infrastruktur (eHealth Infrastructure)",
      "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" : "schedule-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"
    }
  ]
}