DK.EHEALTH.SUNDHED.FHIR.IG.CORE\Fetch ssl orders - XML Representation

eHealth Infrastructure
2021.3.0 - build
eHealth Infrastructure - Local Development build (v2021.3.0). See the Directory of published versions
: Fetch ssl orders - XML Representation



<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="-s-fetch-ssl-orders"/>
  <text>
    <status value="extensions"/>
    <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>
<p>This report contains SSL Orders</p>
<ul>
<li>OrderDetails</li>
<li>OrderLines</li>
<li>TraceLines</li>
</ul>
<h3>Grouping</h3>
<p>Order. Each Order is returned in a single JSon file.</p>
<h3>Parameters</h3>
<ul>
<li>organization: Filter on Order.buyer</li>
<li>period: Filter on TraceLine.timestamp</li>
<li>seller: Filter on Order.seller</li>
</ul>
<h3>Output</h3>
<p>Output can be found in Binary.content. This is a Base64 encoded .zip file containing JSon files corresponding to the report groups.</p>
<h3>Example output</h3>
<p>All returned objects are SSL resources. See the SSL API description for details</p>
<pre><code>{
    '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
            }
        ]
    }
}
</code></pre>
</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>
  </text>
  <url
       value="https://reporting.devtest.systematic-ehealth.com/fhir/OperationDefinition/-s-fetch-ssl-orders"/>
  <version value="2021.3.0"/>
  <name value="fetch-ssl-orders"/>
  <title value="Fetch ssl orders"/>
  <status value="active"/>
  <kind value="operation"/>
  <date value="2021-11-25T09:32:14+00:00"/>
  <publisher value="Systematic | Trifork"/>
  <contact>
    <name value="Systematic | Trifork"/>
    <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

    {
        &#39;OrderDetails&#39;: {
            &#39;order&#39;: {
                &#39;id&#39;: &#39;https://ssl-order.local.ehealth.sundhed.dk/v1/order/ORDER&#39;,
                &#39;threadId&#39;: null,
                &#39;identifiers&#39;: null,
                &#39;status&#39;: null,
                &#39;priority&#39;: null,
                &#39;notes&#39;: null,
                &#39;buyer&#39;: &#39;https://ssl-order.local.ehealth.sundhed.dk/v1/party/BUYER&#39;,
                &#39;seller&#39;: &#39;https://ssl-order.local.ehealth.sundhed.dk/v1/party/SELLER&#39;,
                &#39;sellerDeliveryContactEmail&#39;: null,
                &#39;carePlanRef&#39;: null,
                &#39;carePlanTitle&#39;: null,
                &#39;earliestDeliveryDate&#39;: null,
                &#39;latestDeliveryDate&#39;: null,
                &#39;receiver&#39;: null
            },
            &#39;orderLines&#39;: [{
                    &#39;id&#39;: &#39;https://ssl-order.local.ehealth.sundhed.dk/v1/order-line/ORDERLINE&#39;,
                    &#39;order&#39;: &#39;https://ssl-order.local.ehealth.sundhed.dk/v1/order/ORDER&#39;,
                    &#39;status&#39;: null,
                    &#39;item&#39;: null,
                    &#39;agreedDate&#39;: null,
                    &#39;device&#39;: null
                }
            ],
            &#39;traceLines&#39;: [{
                    &#39;id&#39;: &#39;https://ssl-order.local.ehealth.sundhed.dk/v1/order/ORDER/1&#39;,
                    &#39;timestamp&#39;: &#39;2019-12-24T18:00:00Z&#39;,
                    &#39;createdByOrganization&#39;: null,
                    &#39;createdByUser&#39;: null,
                    &#39;text&#39;: null,
                    &#39;supplementaryText&#39;: null,
                    &#39;order&#39;: &#39;https://ssl-order.local.ehealth.sundhed.dk/v1/order/ORDER&#39;,
                    &#39;orderLine&#39;: null,
                    &#39;statusChange&#39;: null
                }
            ]
        }
    }
"/>
  <affectsState value="true"/>
  <code value="fetch-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>
Links: Table of Contents | QA Report | Change log