Release 4

This page is part of the FHIR Specification (v4.0.1: R4 - Mixed Normative and STU) in it's permanent home (it will always be available at this URL). 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: 0Trial Use Compartments: N/A

The apply operation applies a definition in a specific context.

The official URL for this operation definition is

 http://hl7.org/fhir/OperationDefinition/ChargeItemDefinition-apply

Formal Definition (as a OperationDefinition).

URL: [base]/ChargeItemDefinition/[id]/$apply

This is not an idempotent operation

In Parameters:
NameCardinalityTypeBindingProfileDocumentation
chargeItem1..1Reference(ChargeItem)

The ChargeItem on which the definition is to ba applies

account0..1Reference(Account)

The account in context, if any

Out Parameters:
NameCardinalityTypeBindingProfileDocumentation
return1..1Any

The resource that is the result of applying the definition

Note: as this is the only out parameter, it is a resource, and it has the name 'return', the result of this operation is returned directly as a resource

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

Request: Apply a ChargeItemDefinitionDefinition to an account

GET [base]/ChargeItemDefinition/ebm-1100/$apply?account=1234567

Response: Returned on successful application

HTTP/1.1 200 OK

<?xml version="1.0" encoding="UTF-8"?>
<OperationOutcome xmlns="http://hl7.org/fhir">
  <text> 
    <status value="generated"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">
      <p> Error applying ChargeItemDefinition: Billing Code SHALL NOT be charged for in-patient encounters</p> 
    </div> 
  </text> 
  <issue> 
    <severity value="error"/> 
    <code value="business-rule"/> 
    <details> 
      <text value="Billing Code SHALL NOT be charged for in-patient encounters"/> 
    </details>  
  </issue> 
</OperationOutcome>

 

For more information about operations, including how they are invoked, see Operations.