eHealth Infrastructure
2022.1 - release

eHealth Infrastructure - Local Development build (v2022.1). See the Directory of published versions

: Fetch careplan and episode of care stats - XML Representation

Raw xml | Download



<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="-s-fetch-careplan-and-episode-of-care-stats"/>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><h2>fetch-careplan-and-episode-of-care-stats</h2><p>OPERATION: fetch-careplan-and-episode-of-care-stats</p><p>The official URL for this operation definition is: </p><pre>https://reporting.devtest.systematic-ehealth.com/fhir/OperationDefinition/-s-fetch-careplan-and-episode-of-care-stats</pre><div><h3>Report Contents</h3>
<p>This report contains a count of active EpisodeOfCare and CarePlans.</p>
<h3>Grouping</h3>
<p>This report is grouped by ConditionCode. Each group is returned in a separate JSon file.</p>
<h3>Parameters</h3>
<ul>
<li>organization: Filter on EpisodeOfCare.managingOrganization match</li>
<li>period: Filter on CarePlan.period overlap</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>The ConditionCode is a Fhir CodeableConcept. See the implementation guide for details</p>
<pre><code>{
    'ConditionCode': {
        'valueCodeableConcept': {
            'coding': [{
                    'system': 'urn:oid:1.2.208.176.2.4',
                    'code': 'DJ44'
                }
            ]
        }
    },
    'ConditionSummary': {
        'activeEpisodeOfCareCount': 1,
        'activeCarePlanCount': 1
    }
}
</code></pre>
</div><p>URL: [base]/$fetch-careplan-and-episode-of-care-stats</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><div><p>anonymization</p>
</div></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>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-careplan-and-episode-of-care-stats"/>
  <version value="2022.1"/>
  <name value="fetch-careplan-and-episode-of-care-stats"/>
  <title value="Fetch careplan and episode of care stats"/>
  <status value="active"/>
  <kind value="operation"/>
  <date value="2022-01-18T09:57:29+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 a count of active EpisodeOfCare and CarePlans.
### Grouping 
This report is grouped by ConditionCode. Each group is returned in a separate JSon file.
### Parameters
- organization: Filter on EpisodeOfCare.managingOrganization match
- period: Filter on CarePlan.period overlap

### 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
The ConditionCode is a Fhir CodeableConcept. See the implementation guide for details

    {
        &#39;ConditionCode&#39;: {
            &#39;valueCodeableConcept&#39;: {
                &#39;coding&#39;: [{
                        &#39;system&#39;: &#39;urn:oid:1.2.208.176.2.4&#39;,
                        &#39;code&#39;: &#39;DJ44&#39;
                    }
                ]
            }
        },
        &#39;ConditionSummary&#39;: {
            &#39;activeEpisodeOfCareCount&#39;: 1,
            &#39;activeCarePlanCount&#39;: 1
        }
    }"/>
  <affectsState value="true"/>
  <code value="fetch-careplan-and-episode-of-care-stats"/>
  <system value="true"/>
  <type value="false"/>
  <instance value="false"/>
  <parameter>
    <name value="anonymization"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation value="anonymization"/>
    <type value="string"/>
  </parameter>
  <parameter>
    <name value="organization"/>
    <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>