Resource-operation-filter

Release 5

This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version. For a full list of available versions, see the Directory of published versions

2.1.27.5.8.10 Operation $filter on Resource

FHIR Infrastructure icon

Work Group

Maturity Level: 0

Trial Use

Compartments: N/A

Filter content from an array in a large resource such as List or Group. See Operations for Large Resources.

The canonical URL for this operation definition is

 http://hl7.org/fhir/OperationDefinition/Resource-filter

Formal Definition (as a OperationDefinition).

URL: [base]/[Resource]/[id]/$filter

This is not an idempotent operation

In Parameters:

Name

Scope

Cardinality

Type

Binding

Profile

Documentation

probes

1..1

Resource

Resource containing content that acts as a filter. See Operations for Large Resources.

Out Parameters:

Name

Scope

Cardinality

Type

Binding

Profile

Documentation

return

0..1

Resource

Resource containing content matching the filter. See Operations for Large Resources.

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

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