This page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
FHIR Infrastructure 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="Resource-filter"/> <text> <status value="extensions"/> <div xmlns="http://www.w3.org/1999/xhtml"> <p> URL: [base]/Resource/[id]/$filter</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> probes</td> <td> 1..1</td> <td> <a href="resource.html">Resource</a> </td> <td/> <td> <div> <p> Resource containing content that acts as a filter. See <a href="operations-for-large-resources.html">Operations for Large Resources</a> . </p> </div> </td> </tr> <tr> <td> OUT</td> <td> return</td> <td> 0..1</td> <td> <a href="resource.html">Resource</a> </td> <td/> <td> <div> <p> Resource containing content matching the filter. See <a href="operations-for-large-resources.html">Operations for Large Resources</a> . </p> </div> </td> </tr> </table> <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/Resource-filter"/> <version value="5.0.0-ballot"/> <name value="Filter"/> <title value="Filter an array in a large resource"/> <status value="draft"/> <kind value="operation"/> <experimental value="false"/> <date value="2022-09-07T10:58:29+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="Filter content from an array in a large resource such as List or Group. See [Operations for Large Resources](operations-for-large-resources.html)."/> <affectsState value="true"/> <code value="filter"/> <resource value="Resource"/> <system value="false"/> <type value="false"/> <instance value="true"/> <parameter> <name value="probes"/> <use value="in"/> <min value="1"/> <max value="1"/> <documentation value="Resource containing content that acts as a filter. See [Operations for Large Resources](operations-f or-large-resources.html)."/> <type value="Resource"/> </parameter> <parameter> <name value="return"/> <use value="out"/> <min value="0"/> <max value="1"/> <documentation value="Resource containing content matching the filter. See [Operations for Large Resources](operations-for -large-resources.html)."/> <type value="Resource"/> </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.