R6 Ballot (2nd Draft)

Publish-box (todo)

Example OperationDefinition/ChargeItemDefinition-apply (JSON)

Patient Administration Work GroupMaturity Level: N/AStandards Status: Informative

Raw JSON (canonical form + also see JSON Format Specification)

Operation Definition

{
  "resourceType" : "OperationDefinition",
  "id" : "ChargeItemDefinition-apply",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition ChargeItemDefinition-apply</b></p><a name=\"ChargeItemDefinition-apply\"> </a><a name=\"hcChargeItemDefinition-apply\"> </a><a name=\"ChargeItemDefinition-apply-en-AU\"> </a><p>URL: [base]/ChargeItemDefinition/[id]/$apply</p><p>Parameters</p><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>chargeItem</td><td/><td>1..1</td><td><a href=\"references.html#Reference\">Reference</a> (<a href=\"chargeitem.html\" title=\"http://hl7.org/fhir/StructureDefinition/ChargeItem\">ChargeItem</a>)</td><td/><td><div><p>The ChargeItem on which the definition is to ba applies</p>\n</div></td></tr><tr><td>IN</td><td>account</td><td/><td>0..1</td><td><a href=\"references.html#Reference\">Reference</a> (<a href=\"account.html\" title=\"http://hl7.org/fhir/StructureDefinition/Account\">Account</a>)</td><td/><td><div><p>The account in context, if any</p>\n</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>1..1</td><td><a href=\"resource.html\">Resource</a></td><td/><td><div><p>The resource that is the result of applying the definition</p>\n</div></td></tr></table><div><p>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 ChargetItemDefinition 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. For a more detailed description, refer to the ChargetItemDefinition resource</p>\n</div></div>"
  },
  "extension" : [{
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
    "valueInteger" : 0
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
    "valueCode" : "trial-use"
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
    "valueCode" : "pa"
  }],
  "url" : "http://hl7.org/fhir/OperationDefinition/ChargeItemDefinition-apply",
  "version" : "6.0.0-ballot2",
  "name" : "Apply",
  "title" : "Apply",
  "status" : "draft",
  "kind" : "operation",
  "experimental" : false,
  "date" : "2024-08-12T16:52:12+08:00",
  "publisher" : "HL7 International / Patient Administration",
  "contact" : [{
    "telecom" : [{
      "system" : "url",
      "value" : "http://hl7.org/fhir"
    },
    {
      "system" : "email",
      "value" : "fhir@lists.hl7.org"
    }]
  },
  {
    "telecom" : [{
      "system" : "url",
      "value" : "http://www.hl7.org/Special/committees/pafm"
    }]
  }],
  "description" : "The apply operation applies a definition in a specific context",
  "jurisdiction" : [{
    "coding" : [{
      "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
      "code" : "001",
      "display" : "World"
    }]
  }],
  "affectsState" : true,
  "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 ChargetItemDefinition 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. For a more detailed description, refer to the ChargetItemDefinition resource",
  "resource" : ["ChargeItemDefinition"],
  "system" : false,
  "type" : false,
  "instance" : true,
  "parameter" : [{
    "name" : "chargeItem",
    "use" : "in",
    "min" : 1,
    "max" : "1",
    "documentation" : "The ChargeItem on which the definition is to ba applies",
    "type" : "Reference",
    "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ChargeItem"]
  },
  {
    "name" : "account",
    "use" : "in",
    "min" : 0,
    "max" : "1",
    "documentation" : "The account in context, if any",
    "type" : "Reference",
    "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Account"]
  },
  {
    "name" : "return",
    "use" : "out",
    "min" : 1,
    "max" : "1",
    "documentation" : "The resource that is the result of applying the definition",
    "type" : "Resource"
  }]
}

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.