eHealth Infrastructure
3.0.0 - release

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

: Get Report Job Status - XML Representation

Active as of 2024-05-16

Raw xml | Download



<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="-s-get-report-job-status"/>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p>URL: [base]/$get-report-job-status</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>OUT</td><td>return</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/bundle.html">Bundle</a></td><td/><td/></tr></table></div>
  </text>
  <url
       value="https://reporting.devtest.systematic-ehealth.com/fhir/OperationDefinition/-s-get-report-job-status"/>
  <version value="3.0.0"/>
  <name value="get-report-job-status"/>
  <title value="Get Report Job Status"/>
  <status value="active"/>
  <kind value="operation"/>
  <date value="2024-05-16T07:12:56+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="### Status Contents 
This operation returns status for reports scheduled by the user (by schedule or execute)
### Output
The output is a Bundle containing Parameters resources for each scheduled report.
The parts of the Parameters describe the class of report, the parameters that the report
was scheduled with, the user ID, the status of the report, a reference to the report Binary
and time of creation, start, and end of execution.
### Example output
{
  'resourceType': 'Bundle',
  'type': 'collection',
  'entry': [
    {
      'fullUrl': 'ce35bcd5-4bb2-4c6e-b230-5347df1fe9bc',
      'resource': {
        'resourceType': 'Parameters',
        'id': 'ce35bcd5-4bb2-4c6e-b230-5347df1fe9bc',
        'parameter': [
          {
            'name': 'reportJob',
            'part': [
              {
                'name': 'reportClass',
                'valueString': 'com.systematic.ehealth.reporting.reports.PatientsUsageReport'
              },
              {
                'name': 'userId',
                'valueString': '0aaca7cd-67c3-48dd-a8c4-0cceecb5d276'
              },
              {
                'name': 'status',
                'valueString': 'DONE'
              },
              {
                'name': 'binary',
                'valueReference': {
                  'reference': 'https://reporting.local.ehealth.sundhed.dk/fhir/Binary/7'
                }
              },
              {
                'name': 'parameters',
                'resource': {
                  'resourceType': 'Parameters',
                  'parameter': [
                    {
                      'name': 'anonymization',
                      'valueString': 'None'
                    }
                  ]
                }
              },
              {
                'name': 'created',
                'valueDateTime': '2023-10-12T09:51:50+00:00'
              },
              {
                'name': 'started',
                'valueDateTime': '2023-10-12T09:51:50+00:00'
              },
              {
                'name': 'ended',
                'valueDateTime': '2023-10-12T09:51:51+00:00'
              }
            ]
          }
        ]
      }
    }
  ]
}
"/>
  <affectsState value="false"/>
  <code value="get-report-job-status"/>
  <system value="true"/>
  <type value="false"/>
  <instance value="false"/>
  <parameter>
    <name value="return"/>
    <use value="out"/>
    <min value="0"/>
    <max value="1"/>
    <type value="Bundle"/>
  </parameter>
</OperationDefinition>