R6 Ballot (1st Draft)

This page is part of the FHIR Specification v6.0.0-ballot1: Release 6 Ballot (1st Draft) (see Ballot Notes). The current version is 5.0.0. For a full list of available versions, see the Directory of published versions

Example OperationDefinition/Resource-filter (JSON)

FHIR Infrastructure Work GroupMaturity Level: N/AStandards Status: Informative

Raw JSON (canonical form + also see JSON Format Specification)

Operation Definition

{
  "resourceType" : "OperationDefinition",
  "id" : "Resource-filter",
  "text" : {
    "status" : "extensions",
    "div" : "<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>Scope</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/><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>\n</div></td></tr><tr><td>OUT</td><td>return</td><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>\n</div></td></tr></table></div>"
  },
  "extension" : [{
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
    "valueInteger" : 0
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
    "valueCode" : "trial-use"
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
    "valueCode" : "fhir"
  }],
  "url" : "http://hl7.org/fhir/OperationDefinition/Resource-filter",
  "version" : "6.0.0-ballot1",
  "name" : "Filter",
  "title" : "Filter an array in a large resource",
  "status" : "draft",
  "kind" : "operation",
  "experimental" : false,
  "date" : "2023-12-18T15:12:07+11:00",
  "publisher" : "HL7 International / FHIR Infrastructure",
  "contact" : [{
    "telecom" : [{
      "system" : "url",
      "value" : "http://hl7.org/fhir"
    },
    {
      "system" : "email",
      "value" : "fhir@lists.hl7.org"
    }]
  },
  {
    "telecom" : [{
      "system" : "url",
      "value" : "http://www.hl7.org/Special/committees/fiwg"
    }]
  }],
  "description" : "Filter content from an array in a large resource such as List or Group. See [Operations for Large Resources](operations-for-large-resources.html).",
  "jurisdiction" : [{
    "coding" : [{
      "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
      "code" : "001",
      "display" : "World"
    }]
  }],
  "affectsState" : true,
  "code" : "filter",
  "resource" : ["Resource"],
  "system" : false,
  "type" : false,
  "instance" : true,
  "parameter" : [{
    "name" : "probes",
    "use" : "in",
    "min" : 1,
    "max" : "1",
    "documentation" : "Resource containing content that acts as a filter. See [Operations for Large Resources](operations-for-large-resources.html).",
    "type" : "Resource"
  },
  {
    "name" : "return",
    "use" : "out",
    "min" : 0,
    "max" : "1",
    "documentation" : "Resource containing content matching the filter. See [Operations for Large Resources](operations-for-large-resources.html).",
    "type" : "Resource"
  }]
}

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.