eHealth Infrastructure (v2019.5.3)

{
  "resourceType" : "OperationDefinition",
  "id" : "PlanDefinition-i-apply",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><h2>apply</h2><p>OPERATION: apply</p><p>The official URL for this operation definition is: </p><pre>http://ehealth.sundhed.dk/fhir/OperationDefinition/PlanDefinition-i-apply</pre><div><p>This operation creates a CarePlan for a specific EpisodeOfCare using this PlanDefinition as a template.</p>\n<h3>Parameter description</h3>\n<ul>\n<li>1..1 EpisodeOfCare: Reference to the EpisodeOfCare in context of which a new CarePlan should be created.</li>\n</ul>\n<p>Example:</p>\n<pre><code class=\"language-json\">{\n  'resourceType': 'Parameters',\n  'parameter': [\n    {\n      'name': 'episodeOfCare',\n      'valueReference': {\n        'reference': 'http://local.ehealth.sundhed.dk:31380/hapi-fhir-server/fhir/EpisodeOfCare/38'\n      }\n    }\n  ]\n}\n</code></pre>\n<h3>Output description</h3>\n<p>Upon success this operation returns an CarePlan resource.</p>\n<p>Example output:</p>\n<pre><code class=\"language-json\">{\n  'resourceType': 'Parameters',\n  'parameter': [\n    {\n      'name': 'return',\n      'resource': {\n      {\n        'resourceType': 'CarePlan',\n        'id': '30',\n        'meta': {\n          'versionId': '1',\n          'lastUpdated': '2019-04-11T10:55:30.374+00:00',\n          'profile': [\n            'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-careplan'\n          ]\n        },\n        'contained': [\n          {\n            'resourceType': 'Condition',\n            'id': '1',\n            'clinicalStatus': 'active',\n            'subject': {\n              'reference': 'http://ehealth.sundhed.dk/patient/fhir/Patient/46216'\n            },\n            'assertedDate': '2019-04-11T12:55:30+02:00'\n          }\n        ],\n        'definition': [\n          {\n            'reference': 'http://ehealth.sundhed.dk/hapi-fhir-server/fhir/PlanDefinition/23'\n          }\n        ],\n        'status': 'active',\n        'intent': 'order',\n        'category': [\n          {\n            'coding': [\n              {\n                'system': 'http://snomed.info/sct',\n                'code': '412776001',\n                'display': 'Chronic obstructive pulmonary disease clinical management plan'\n              }\n            ]\n          }\n        ],\n        'subject': {\n          'reference': 'http://ehealth.sundhed.dk/patient/fhir/Patient/10016'\n        },\n        'context': {\n          'reference': 'http://ehealth.sundhed.dk/episodeofcare/fhir/EpisodeOfCare/24'\n        },\n        'period': {\n          'start': '2019-04-11T10:55:30+00:00'\n        },\n        'addresses': [\n          {\n            'reference': '#1'\n          }\n        ],\n        'activity': [\n          {\n            'reference': {\n              'reference': 'http://ehealth.sundhed.dk/procedurerequest/fhir/ProcedureRequest/28'\n            }\n          },\n          {\n            'reference': {\n              'reference': 'http://ehealth.sundhed.dk/procedurerequest/fhir/ProcedureRequest/29'\n            }\n          }\n        ]\n      }\n    }\n  ]\n}\n</code></pre>\n</div><p>URL: [base]/PlanDefinition/[id]/$apply</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>episodeOfCare</td><td>1..1</td><td><a href=\"http://hl7.org/fhir/STU3/datatypes.html#Reference\">Reference</a></td><td/><td/></tr><tr><td>OUT</td><td>return</td><td>0..1</td><td><a href=\"http://hl7.org/fhir/STU3/parameters.html\">Parameters</a></td><td/><td/></tr></table></div>"
  },
  "url" : "http://ehealth.sundhed.dk/fhir/OperationDefinition/PlanDefinition-i-apply",
  "version" : "2019.5.3",
  "name" : "apply",
  "status" : "active",
  "kind" : "operation",
  "date" : "2019-06-07T11:10:06+00:00",
  "description" : "This operation creates a CarePlan for a specific EpisodeOfCare using this PlanDefinition as a template.\n\n### Parameter description\n- 1..1 EpisodeOfCare: Reference to the EpisodeOfCare in context of which a new CarePlan should be created.\n\nExample:\n\n```json\n{\n  'resourceType': 'Parameters',\n  'parameter': [\n    {\n      'name': 'episodeOfCare',\n      'valueReference': {\n        'reference': 'http://local.ehealth.sundhed.dk:31380/hapi-fhir-server/fhir/EpisodeOfCare/38'\n      }\n    }\n  ]\n}\n```\n\n### Output description\nUpon success this operation returns an CarePlan resource.\n\nExample output:\n\n```json\n{\n  'resourceType': 'Parameters',\n  'parameter': [\n    {\n      'name': 'return',\n      'resource': {\n      {\n        'resourceType': 'CarePlan',\n        'id': '30',\n        'meta': {\n          'versionId': '1',\n          'lastUpdated': '2019-04-11T10:55:30.374+00:00',\n          'profile': [\n            'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-careplan'\n          ]\n        },\n        'contained': [\n          {\n            'resourceType': 'Condition',\n            'id': '1',\n            'clinicalStatus': 'active',\n            'subject': {\n              'reference': 'http://ehealth.sundhed.dk/patient/fhir/Patient/46216'\n            },\n            'assertedDate': '2019-04-11T12:55:30+02:00'\n          }\n        ],\n        'definition': [\n          {\n            'reference': 'http://ehealth.sundhed.dk/hapi-fhir-server/fhir/PlanDefinition/23'\n          }\n        ],\n        'status': 'active',\n        'intent': 'order',\n        'category': [\n          {\n            'coding': [\n              {\n                'system': 'http://snomed.info/sct',\n                'code': '412776001',\n                'display': 'Chronic obstructive pulmonary disease clinical management plan'\n              }\n            ]\n          }\n        ],\n        'subject': {\n          'reference': 'http://ehealth.sundhed.dk/patient/fhir/Patient/10016'\n        },\n        'context': {\n          'reference': 'http://ehealth.sundhed.dk/episodeofcare/fhir/EpisodeOfCare/24'\n        },\n        'period': {\n          'start': '2019-04-11T10:55:30+00:00'\n        },\n        'addresses': [\n          {\n            'reference': '#1'\n          }\n        ],\n        'activity': [\n          {\n            'reference': {\n              'reference': 'http://ehealth.sundhed.dk/procedurerequest/fhir/ProcedureRequest/28'\n            }\n          },\n          {\n            'reference': {\n              'reference': 'http://ehealth.sundhed.dk/procedurerequest/fhir/ProcedureRequest/29'\n            }\n          }\n        ]\n      }\n    }\n  ]\n}\n```\n\n",
  "idempotent" : false,
  "code" : "apply",
  "resource" : [
    "PlanDefinition"
  ],
  "system" : false,
  "type" : false,
  "instance" : true,
  "parameter" : [
    {
      "name" : "episodeOfCare",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "type" : "Reference"
    },
    {
      "name" : "return",
      "use" : "out",
      "min" : 0,
      "max" : "1",
      "type" : "Parameters"
    }
  ]
}