eHealth Infrastructure
2.5.0 - release

eHealth Infrastructure - Local Development build (v2.5.0). See the Directory of published versions

: Export a PlanDefinition - JSON Representation

Active as of 2023-02-09

Raw json | Download


{
  "resourceType" : "OperationDefinition",
  "id" : "PlanDefinition-i-export",
  "text" : {
    "status" : "extensions",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><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>"
  },
  "url" : "https://plan.devtest.systematic-ehealth.com/fhir/OperationDefinition/PlanDefinition-i-export",
  "version" : "2.5.0",
  "name" : "export",
  "title" : "Export a PlanDefinition",
  "status" : "active",
  "kind" : "operation",
  "date" : "2023-02-09T09:12:35+00:00",
  "publisher" : "Systematic | Trifork",
  "contact" : [
    {
      "name" : "Systematic | Trifork",
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://ehealth.sundhed.dk"
        }
      ]
    }
  ],
  "description" : "Export a PlanDefinition.\n### Export Contents\nThe export contains the PlanDefinition including referenced resources:- PlanDefinitions\n- ActivityDefinitions\n- Questionnaires\n- Libraries\n- Organizations\n\nEach resource is returned in a separate JSon file.\n### Parameters\n- exclude: references to ActivityDefinitions or PlanDefinitions to exclude from the export.\n### Output\nOutput can be found in Binary.content. This is a Base64 encoded .zip file containing JSon files.\nAll returned objects are Fhir resources. See the implementation guide for details\n",
  "affectsState" : false,
  "code" : "export",
  "resource" : [
    "PlanDefinition"
  ],
  "system" : false,
  "type" : false,
  "instance" : true,
  "parameter" : [
    {
      "name" : "exclude",
      "use" : "in",
      "min" : 0,
      "max" : "*",
      "type" : "string"
    }
  ]
}