Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.5 - release

Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.5) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## : Care In The Community PlanDefinition Apply Operation - JSON Representation

Draft as of 2022-09-20

Raw json | Download

    {
      "resourceType" : "OperationDefinition",
      "id" : "PlanDefinition-apply",
      "text" : {
        "status" : "generated",
        "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition PlanDefinition-apply</b></p><a name=\"PlanDefinition-apply\"> </a><a name=\"hcPlanDefinition-apply\"> </a><p>URL: [base]/PlanDefinition/[id]?_query=apply&amp;...</p><h3>Parameters</h3><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</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>planDefinition</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/plandefinition.html\">PlanDefinition</a></td><td/><td><div><p>The plan definition to be applied (required).</p>\n</div></td></tr><tr><td>IN</td><td>subject</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a><br/>(<a href=\"https://hl7.org/fhir/R4/search.html#reference\">reference</a>)</td><td/><td><div><p>The subject Patient that is the target of the plan to be applied.</p>\n</div></td></tr><tr><td>IN</td><td>encounter</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a><br/>(<a href=\"https://hl7.org/fhir/R4/search.html#reference\">reference</a>)</td><td/><td><div><p>The encounter in context, if any</p>\n</div></td></tr><tr><td>IN</td><td>practitioner</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a><br/>(<a href=\"https://hl7.org/fhir/R4/search.html#reference\">reference</a>)</td><td/><td><div><p>The practitioner applying the plan definition</p>\n</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/careplan.html\">CarePlan</a></td><td/><td><div><p>The CarePlan that is the result of applying the plan definition</p>\n</div></td></tr></table><div><p>The result of this operation is a CarePlan resource</p>\n</div></div>"
      },
      "url" : "https://fhir-ig.digital.health.nz/shared-care/OperationDefinition/PlanDefinition-apply",
      "version" : "0.4.5",
      "name" : "CareInTheCommunityPlanDefinitionApplyOperation",
      "title" : "Care In The Community PlanDefinition Apply Operation",
      "status" : "draft",
      "kind" : "query",
      "date" : "2022-09-20",
      "publisher" : "Te Whatu Ora",
      "contact" : [
        {
          "name" : "Te Whatu Ora",
          "telecom" : [
            {
              "system" : "url",
              "value" : "https://www.tewhatuora.govt.nz/"
            }
          ]
        },
        {
          "name" : "Te Whatu Ora Integration Team",
          "telecom" : [
            {
              "system" : "email",
              "value" : "integration@tewhatuora.govt.nz",
              "use" : "work"
            }
          ]
        }
      ],
      "description" : "The apply operation applies a PlanDefinition to a given context",
      "jurisdiction" : [
        {
          "coding" : [
            {
              "system" : "urn:iso:std:iso:3166",
              "code" : "NZ",
              "display" : "New Zealand"
            }
          ]
        }
      ],
      "code" : "apply",
      "comment" : "The result of this operation is a CarePlan resource",
      "base" : "http://hl7.org/fhir/OperationDefinition/PlanDefinition-apply",
      "resource" : [
        "PlanDefinition"
      ],
      "system" : false,
      "type" : false,
      "instance" : true,
      "parameter" : [
        {
          "name" : "planDefinition",
          "use" : "in",
          "min" : 1,
          "max" : "1",
          "documentation" : "The plan definition to be applied (required).",
          "type" : "PlanDefinition"
        },
        {
          "name" : "subject",
          "use" : "in",
          "min" : 1,
          "max" : "1",
          "documentation" : "The subject Patient that is the target of the plan to be applied.",
          "type" : "string",
          "searchType" : "reference"
        },
        {
          "name" : "encounter",
          "use" : "in",
          "min" : 0,
          "max" : "1",
          "documentation" : "The encounter in context, if any",
          "type" : "string",
          "searchType" : "reference"
        },
        {
          "name" : "practitioner",
          "use" : "in",
          "min" : 0,
          "max" : "1",
          "documentation" : "The practitioner applying the plan definition",
          "type" : "string",
          "searchType" : "reference"
        },
        {
          "name" : "return",
          "use" : "out",
          "min" : 1,
          "max" : "1",
          "documentation" : "The CarePlan that is the result of applying the plan definition",
          "type" : "CarePlan"
        }
      ]
    }