eHealth Infrastructure
2022.2 - release

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

: Export a PlanDefinition - XML Representation

Active as of 2022-06-20

Raw xml | Download



<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="PlanDefinition-i-export"/>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><h2>export</h2><p>OPERATION: export</p><p>The official URL for this operation definition is: </p><pre>https://plan.devtest.systematic-ehealth.com/fhir/OperationDefinition/PlanDefinition-i-export</pre><div><p>Export a PlanDefinition.</p>
<h3>Export Contents</h3>
<p>The export contains the PlanDefinition including referenced resources:- PlanDefinitions</p>
<ul>
<li>ActivityDefinitions</li>
<li>Questionnaires</li>
<li>Libraries</li>
<li>Organizations</li>
</ul>
<p>Each resource is returned in a separate JSon file.</p>
<h3>Parameters</h3>
<ul>
<li>exclude: references to ActivityDefinitions or PlanDefinitions to exclude from the export.</li>
</ul>
<h3>Output</h3>
<p>Output can be found in Binary.content. This is a Base64 encoded .zip file containing JSon files.
All returned objects are Fhir resources. See the implementation guide for details</p>
</div><p>URL: [base]/PlanDefinition/[id]/$export</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>exclude</td><td>0..*</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td/></tr></table></div>
  </text>
  <url
       value="https://plan.devtest.systematic-ehealth.com/fhir/OperationDefinition/PlanDefinition-i-export"/>
  <version value="2022.2"/>
  <name value="export"/>
  <title value="Export a PlanDefinition"/>
  <status value="active"/>
  <kind value="operation"/>
  <date value="2022-06-20T13:22: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="Export a PlanDefinition.
### Export Contents
The export contains the PlanDefinition including referenced resources:- PlanDefinitions
- ActivityDefinitions
- Questionnaires
- Libraries
- Organizations

Each resource is returned in a separate JSon file.
### Parameters
- exclude: references to ActivityDefinitions or PlanDefinitions to exclude from the export.
### Output
Output can be found in Binary.content. This is a Base64 encoded .zip file containing JSon files.
All returned objects are Fhir resources. See the implementation guide for details
"/>
  <affectsState value="false"/>
  <code value="export"/>
  <resource value="PlanDefinition"/>
  <system value="false"/>
  <type value="false"/>
  <instance value="true"/>
  <parameter>
    <name value="exclude"/>
    <use value="in"/>
    <min value="0"/>
    <max value="*"/>
    <type value="string"/>
  </parameter>
</OperationDefinition>