This page is part of the FHIR Specification (v4.3.0: R4B - STU). 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
Patient Administration Work Group | Maturity Level: N/A | Standards Status: Informative |
Raw XML (canonical form + also see XML Format Specification)
Operation Definition
<?xml version="1.0" encoding="UTF-8"?> <OperationDefinition xmlns="http://hl7.org/fhir"> <id value="ChargeItemDefinition-apply"/> <text> <status value="extensions"/> <div xmlns="http://www.w3.org/1999/xhtml"> <h2> Apply</h2> <p> OPERATION: Apply</p> <p> The official URL for this operation definition is: </p> <pre> http://hl7.org/fhir/OperationDefinition/ChargeItemDefinition-apply</pre> <div> <p> The apply operation applies a definition in a specific context</p> </div> <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> 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> 1..1</td> <td> <a href="references.html#Reference">Reference</a> </td> <td/> <td> <div> <p> The ChargeItem on which the definition is to ba applies</p> </div> </td> </tr> <tr> <td> IN</td> <td> account</td> <td> 0..1</td> <td> <a href="references.html#Reference">Reference</a> </td> <td/> <td> <div> <p> The account in context, if any</p> </div> </td> </tr> <tr> <td> OUT</td> <td> return</td> <td> 1..1</td> <td> Any</td> <td/> <td> <div> <p> The resource that is the result of applying the definition</p> </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 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. For a more detailed description, refer to the ActivityDefinition resource</p> </div> </div> </text> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm"> <valueInteger value="0"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="trial-use"/> </extension> <url value="http://hl7.org/fhir/OperationDefinition/ChargeItemDefinition-apply"/> <version value="4.3.0"/> <name value="Apply"/> <title value="Apply"/> <status value="draft"/> <kind value="operation"/> <experimental value="false"/> <date value="2022-05-28T12:47:40+10:00"/> <publisher value="HL7 (FHIR Project)"/> <contact> <telecom> <system value="url"/> <value value="http://hl7.org/fhir"/> </telecom> <telecom> <system value="email"/> <value value="fhir@lists.hl7.org"/> </telecom> </contact> <description value="The apply operation applies a definition in a specific context"/> <affectsState value="true"/> <code value="apply"/> <comment value="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. For a more detailed description, refer to the ActivityDefinition resource"/> <resource value="ChargeItemDefinition"/> <system value="false"/> <type value="false"/> <instance value="true"/> <parameter> <name value="chargeItem"/> <use value="in"/> <min value="1"/> <max value="1"/> <documentation value="The ChargeItem on which the definition is to ba applies"/> <type value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/ChargeItem"/> </parameter> <parameter> <name value="account"/> <use value="in"/> <min value="0"/> <max value="1"/> <documentation value="The account in context, if any"/> <type value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Account"/> </parameter> <parameter> <name value="return"/> <use value="out"/> <min value="1"/> <max value="1"/> <documentation value="The resource that is the result of applying the definition"/> <type value="Any"/> </parameter> </OperationDefinition>
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.