eHealth Infrastructure
2022.1 - release

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

: Fetch careteam stats - XML Representation

Raw xml | Download



<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="-s-fetch-careteam-stats"/>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><h2>fetch-careteam-stats</h2><p>OPERATION: fetch-careteam-stats</p><p>The official URL for this operation definition is: </p><pre>https://reporting.devtest.systematic-ehealth.com/fhir/OperationDefinition/-s-fetch-careteam-stats</pre><div><h3>Report Contents</h3>
<p>This report contains counts of resources associated with CareTeams:</p>
<ul>
<li>EpisodeOfCare</li>
<li>CarePlan</li>
<li>Task: Count for each task category</li>
</ul>
<h3>Grouping</h3>
<p>This report is grouped by CareTeam. Each group is returned in a separate JSon file.</p>
<h3>Parameters</h3>
<ul>
<li>organization: Filter on CareTeam.managingOrganization match</li>
<li>period: Filter on:
<ul>
<li>CarePlan.period overlap for CarePlans</li>
<li>EpisodeOfCare.period overlap for EpisodeOfCare</li>
<li>Task.authoredOn inside period for Tasks</li>
</ul>
</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>EHealthCareTeam is a Fhir resource. See the implementation guide for details</p>
<pre><code>{
    'EHealthCareTeam': {
        'resourceType': 'CareTeam',
        'id': '12958',
        'meta': {
            'versionId': '1',
            'profile': ['http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-careteam']
        },
        'identifier': [{
                'id': '59f70e4e-1c31-4647-8c91-404939b6b14e',
                'system': 'urn:ietf:rfc:3986'
            }
        ],
        'status': 'active',
        'name': '0cea5c11-af39-4e5c-8733-9f532ea9961a',
        'reasonCode': [{
                'coding': [{
                        'system': 'http://ehealth.sundhed.dk/cs/conditions',
                        'code': 'TBD'
                    }
                ]
            }
        ],
        'managingOrganization': [{
                'reference': 'https://organization.local.ehealth.sundhed.dk/fhir/Organization/66642'
            }
        ]
    },
    'CareTeamSummary': {
        'episodeOfCareCount': 2,
        'carePlanCount': 6,
        'taskCountByCategory': {
            'MissingMeasurementResolving': 2
        }
    }
}
</code></pre>
</div><p>URL: [base]/$fetch-careteam-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/></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-careteam-stats"/>
  <version value="2022.1"/>
  <name value="fetch-careteam-stats"/>
  <title value="Fetch careteam 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 counts of resources associated with CareTeams:
- EpisodeOfCare
- CarePlan
- Task: Count for each task category
### Grouping 
This report is grouped by CareTeam. Each group is returned in a separate JSon file.
### Parameters
- organization: Filter on CareTeam.managingOrganization match
- period: Filter on:
    - CarePlan.period overlap for CarePlans
    - EpisodeOfCare.period overlap for EpisodeOfCare
    - Task.authoredOn inside period for Tasks
### 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
EHealthCareTeam is a Fhir resource. See the implementation guide for details

    {
        &#39;EHealthCareTeam&#39;: {
            &#39;resourceType&#39;: &#39;CareTeam&#39;,
            &#39;id&#39;: &#39;12958&#39;,
            &#39;meta&#39;: {
                &#39;versionId&#39;: &#39;1&#39;,
                &#39;profile&#39;: [&#39;http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-careteam&#39;]
            },
            &#39;identifier&#39;: [{
                    &#39;id&#39;: &#39;59f70e4e-1c31-4647-8c91-404939b6b14e&#39;,
                    &#39;system&#39;: &#39;urn:ietf:rfc:3986&#39;
                }
            ],
            &#39;status&#39;: &#39;active&#39;,
            &#39;name&#39;: &#39;0cea5c11-af39-4e5c-8733-9f532ea9961a&#39;,
            &#39;reasonCode&#39;: [{
                    &#39;coding&#39;: [{
                            &#39;system&#39;: &#39;http://ehealth.sundhed.dk/cs/conditions&#39;,
                            &#39;code&#39;: &#39;TBD&#39;
                        }
                    ]
                }
            ],
            &#39;managingOrganization&#39;: [{
                    &#39;reference&#39;: &#39;https://organization.local.ehealth.sundhed.dk/fhir/Organization/66642&#39;
                }
            ]
        },
        &#39;CareTeamSummary&#39;: {
            &#39;episodeOfCareCount&#39;: 2,
            &#39;carePlanCount&#39;: 6,
            &#39;taskCountByCategory&#39;: {
                &#39;MissingMeasurementResolving&#39;: 2
            }
        }
    }"/>
  <affectsState value="true"/>
  <code value="fetch-careteam-stats"/>
  <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="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>