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

• Content
• Examples
• Detailed Descriptions
• Mappings
• Profiles & Extensions
• Operations

14.1.10 Resource ActivityDefinition - Operations

This resource has 2 operations associated with it:

$apply	Apply
$data-requirements	Data Requirements

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

14.1.10.1 Apply

The apply operation realizes a definition in a specific context

Formal Definition (as a OperationDefinition ).

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

In Parameters:
Name	Cardinality	Type	Binding	Profile	Documentation
patient	1..1	Reference ( Patient )			The patient that is the target of the activity to be applied
encounter	0..1	Reference ( Encounter )			The encounter in context, if any
practitioner	0..1	Reference ( Practitioner )			The practitioner in context
organization	0..1	Reference ( Organization )			The organization in context
userType	0..1	CodeableConcept			The type of user initiating the request, e.g. patient, healthcare provider, or specific type of healthcare provider (physician, nurse, etc.)
userLanguage	0..1	CodeableConcept			Preferred language of the person using the system
userTaskContext	0..1	CodeableConcept			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
setting	0..1	CodeableConcept			The current setting of the request (inpatient, outpatient, etc)
settingContext	0..1	CodeableConcept			Additional detail about the setting of the request, if any
Out Parameters:
Name	Cardinality	Type	Binding	Profile	Documentation
return	1..1	Any			The resource that is the result of applying the definition

 

14.1.10.2 Data Requirements

The data-requirements operation aggregates and returns the parameters and data requirements for the activity definition and all its dependencies as a single module definition library

Formal Definition (as a OperationDefinition ).

URL: [base]/ActivityDefinition/[id]/$data-requirements

Out Parameters:
Name	Cardinality	Type	Binding	Profile	Documentation
return	1..1	Library			The result of the requirements gathering Note: as this 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 effect of invoking this operation is to determine the aggregate set of data requirements and dependencies for the activity definition. The result is a Library resource with a type of module-definition that contains all the parameter definitions and data requirements of the activity definition and any libraries referenced by it. Implementations SHOULD aggregate data requirements intelligently (i.e. by collapsing overlapping data requirements)