Operation-plandefinition-apply.json

Operation Definition

{
  "resourceType": "OperationDefinition",
  "id": "PlanDefinition-apply",
  "text": {
    "status": "generated",
    "div": "<div>!-- Snipped for Brevity --></div>"
  },
  "url": "http://hl7.org/fhir/OperationDefinition/PlanDefinition-apply",
  "name": "Place",
  "status": "draft",
  "kind": "operation",
  "date": "2016-12-06T12:22:34+11:00",
  "publisher": "HL7 (FHIR Project)",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://hl7.org/fhir"
        },
        {
          "system": "email",
          "value": "fhir@lists.hl7.org"
        }
      ]
    }
  ],
  "description": "The apply operation applies a PlanDefinition to a given context",
  "code": "apply",
  "resource": [
    "PlanDefinition"
  ],
  "system": false,
  "type": false,
  "instance": true,
  "parameter": [
    {
      "name": "patient",
      "use": "in",
      "min": 1,
      "max": "1",
      "documentation": "The patient that is the target of the plan to be applied",
      "type": "Reference",
      "profile": {
        "reference": "http://hl7.org/fhir/StructureDefinition/Patient"
      }
    },
    {
      "name": "encounter",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "The encounter in context, if any",
      "type": "Reference",
      "profile": {
        "reference": "http://hl7.org/fhir/StructureDefinition/Encounter"
      }
    },
    {
      "name": "practitioner",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "The practitioner applying the plan definition",
      "type": "Reference",
      "profile": {
        "reference": "http://hl7.org/fhir/StructureDefinition/Practitioner"
      }
    },
    {
      "name": "organization",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "The organization applying the plan definition",
      "type": "Reference",
      "profile": {
        "reference": "http://hl7.org/fhir/StructureDefinition/Organization"
      }
    },
    {
      "name": "userType",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "The type of user initiating the request, e.g. patient, healthcare provider, or specific type of healthcare provider (physician, nurse, etc.)",
      "type": "CodeableConcept"
    },
    {
      "name": "userLanguage",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "Preferred language of the person using the system",
      "type": "CodeableConcept"
    },
    {
      "name": "userTaskContext",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "The task the system user is performing, e.g. laboratory results review, medication list review, etc. This information can be used to tailor decision support outputs, such as recommended information resources",
      "type": "CodeableConcept"
    },
    {
      "name": "setting",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "The current setting of the request (inpatient, outpatient, etc)",
      "type": "CodeableConcept"
    },
    {
      "name": "settingContext",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "Additional detail about the setting of the request, if any",
      "type": "CodeableConcept"
    },
    {
      "name": "return",
      "use": "out",
      "min": 1,
      "max": "1",
      "documentation": "The CarePlan that is the result of applying the plan definition",
      "type": "CarePlan"
    }
  ]
}