Operation-activitydefinition-apply.json

Operation Definition

{
  "resourceType" : "OperationDefinition",
  "id" : "ActivityDefinition-apply",
  "text" : {
    "status" : "extensions",
    "div" : "<div>!-- Snipped for Brevity --></div>"
  },
  "extension" : [{
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
    "valueInteger" : 3
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
    "valueCode" : "trial-use"
  }],
  "url" : "http://hl7.org/fhir/OperationDefinition/ActivityDefinition-apply",
  "version" : "4.3.0-snapshot1",
  "name" : "apply",
  "title" : "Apply",
  "status" : "draft",
  "kind" : "operation",
  "date" : "2021-12-20T14:08:35+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 definition in a specific context",
  "affectsState" : false,
  "code" : "apply",
  "comment" : "The result of invoking this operation is a resource of the type specified by the activity definition, with all the definitions resolved as appropriate for the type of resource. Any dynamicValue elements will be evaluated (in the order in which they appear in the resource) and the results applied to the returned resource.  If the ActivityDefinition includes library references, those libraries will be available to the evaluated expressions. If those libraries have parameters, those parameters will be bound by name to the parameters given to the operation. In addition, parameters to the $apply operation are available within dynamicValue expressions as context variables, accessible by the name of the parameter, prefixed with a percent (%) symbol. For a more detailed description, refer to the ActivityDefinition resource",
  "resource" : ["ActivityDefinition"],
  "system" : false,
  "type" : true,
  "instance" : true,
  "parameter" : [{
    "name" : "activityDefinition",
    "use" : "in",
    "min" : 0,
    "max" : "1",
    "documentation" : "The activity definition to apply. If the operation is invoked on an instance, this parameter is not allowed. If the operation is invoked at the type level, this parameter is required",
    "type" : "ActivityDefinition"
  },
  {
    "name" : "subject",
    "use" : "in",
    "min" : 1,
    "max" : "*",
    "documentation" : "The subject(s) that is/are the target of the activity definition to be applied. The subject may be a Patient, Practitioner, Organization, Location, Device, or Group. Subjects provided in this parameter will be resolved as the subject of the PlanDefinition based on the type of the subject. If multiple subjects of the same type are provided, the behavior is implementation-defined",
    "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 in context",
    "type" : "string",
    "searchType" : "reference"
  },
  {
    "name" : "organization",
    "use" : "in",
    "min" : 0,
    "max" : "1",
    "documentation" : "The organization in context",
    "type" : "string",
    "searchType" : "reference"
  },
  {
    "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 resource that is the result of applying the definition",
    "type" : "Any"
  }]
}