STU3 Candidate

This page is part of the FHIR Specification (v1.8.0: STU 3 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3

Operation-activitydefinition-apply.json

Raw JSON (canonical form)

Operation Definition

{
  "resourceType": "OperationDefinition",
  "id": "ActivityDefinition-apply",
  "text": {
    "status": "generated",
    "div": "<div>!-- Snipped for Brevity --></div>"
  },
  "url": "http://hl7.org/fhir/OperationDefinition/ActivityDefinition-apply",
  "name": "Apply",
  "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 realizes a definition in a specific context",
  "code": "apply",
  "resource": [
    "ActivityDefinition"
  ],
  "system": false,
  "type": false,
  "instance": true,
  "parameter": [
    {
      "name": "patient",
      "use": "in",
      "min": 1,
      "max": "1",
      "documentation": "The patient that is the target of the activity 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 in context",
      "type": "Reference",
      "profile": {
        "reference": "http://hl7.org/fhir/StructureDefinition/Practitioner"
      }
    },
    {
      "name": "organization",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "The organization in context",
      "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 resource that is the result of applying the definition",
      "type": "Any"
    }
  ]
}

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.