eHealth Infrastructure
latest - ci-build

eHealth Infrastructure - Local Development build (vlatest) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

: Schedule ssl orders - XML Representation

Active as of 2024-06-07

Raw xml | Download



<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="-s-schedule-ssl-orders"/>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><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>
  </text>
  <url
       value="https://reporting.devtest.systematic-ehealth.com/fhir/OperationDefinition/-s-schedule-ssl-orders"/>
  <version value="latest"/>
  <name value="schedule-ssl-orders"/>
  <title value="Schedule ssl orders"/>
  <status value="active"/>
  <kind value="operation"/>
  <date value="2024-06-07T07:57:53+00:00"/>
  <publisher
             value="Den telemedicinske infrastruktur (eHealth Infrastructure)"/>
  <contact>
    <name value="Den telemedicinske infrastruktur (eHealth Infrastructure)"/>
    <telecom>
      <system value="url"/>
      <value value="http://ehealth.sundhed.dk"/>
    </telecom>
  </contact>
  <description
               value="### Report Contents
This report contains SSL Orders
- OrderDetails
- OrderLines
- TraceLines
### Grouping 
Order. Each Order is returned in a single JSon file.
### Parameters
- organization: Filter on Order.buyer
- period: Filter on TraceLine.timestamp
- seller: Filter on Order.seller
### Output
Output can be found in Binary.content. This is a Base64 encoded .zip file containing JSon files corresponding to the report groups.
### Example output
All returned objects are SSL resources. See the SSL API description for details

    {
        'OrderDetails': {
            'order': {
                'id': 'https://ssl-order.local.ehealth.sundhed.dk/v1/order/ORDER',
                'threadId': null,
                'identifiers': null,
                'status': null,
                'priority': null,
                'notes': null,
                'buyer': 'https://ssl-order.local.ehealth.sundhed.dk/v1/party/BUYER',
                'seller': 'https://ssl-order.local.ehealth.sundhed.dk/v1/party/SELLER',
                'sellerDeliveryContactEmail': null,
                'carePlanRef': null,
                'carePlanTitle': null,
                'earliestDeliveryDate': null,
                'latestDeliveryDate': null,
                'receiver': null
            },
            'orderLines': [{
                    'id': 'https://ssl-order.local.ehealth.sundhed.dk/v1/order-line/ORDERLINE',
                    'order': 'https://ssl-order.local.ehealth.sundhed.dk/v1/order/ORDER',
                    'status': null,
                    'item': null,
                    'agreedDate': null,
                    'device': null
                }
            ],
            'traceLines': [{
                    'id': 'https://ssl-order.local.ehealth.sundhed.dk/v1/order/ORDER/1',
                    'timestamp': '2019-12-24T18:00:00Z',
                    'createdByOrganization': null,
                    'createdByUser': null,
                    'text': null,
                    'supplementaryText': null,
                    'order': 'https://ssl-order.local.ehealth.sundhed.dk/v1/order/ORDER',
                    'orderLine': null,
                    'statusChange': null
                }
            ]
        }
    }
"/>
  <affectsState value="true"/>
  <code value="schedule-ssl-orders"/>
  <system value="true"/>
  <type value="false"/>
  <instance value="false"/>
  <parameter>
    <name value="anonymization"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <type value="string"/>
  </parameter>
  <parameter>
    <name value="organization"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <type value="Reference"/>
  </parameter>
  <parameter>
    <name value="seller"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <type value="Reference"/>
  </parameter>
  <parameter>
    <name value="period"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <type value="Period"/>
  </parameter>
  <parameter>
    <name value="return"/>
    <use value="out"/>
    <min value="0"/>
    <max value="1"/>
    <type value="Binary"/>
  </parameter>
</OperationDefinition>