Release 5 Ballot

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

Example OperationDefinition/example-query-high-risk (JSON)

FHIR Infrastructure Work GroupMaturity Level: N/AStandards Status: InformativeCompartments: Not linked to any defined compartments

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

Example Named Query of Patients based on risk assessments

{
  "resourceType": "OperationDefinition",
  "id": "example-query-high-risk",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative: OperationDefinition</b><a name=\"example-query-high-risk\"> </a></p><div style=\"display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%\"><p style=\"margin-bottom: 0px\">Resource OperationDefinition &quot;example-query-high-risk&quot; </p></div><p><b>url</b>: <code>http://hl7.org/fhir/OperationDefinition/example-query-high-risk</code></p><p><b>version</b>: 0.0.1</p><p><b>name</b>: Example of High-Risk Patient Query</p><p><b>status</b>: draft</p><p><b>kind</b>: query</p><p><b>description</b>: Example Named Query of Patients based on risk assessments</p><p><b>code</b>: example-query-high-risk</p><p><b>resource</b>: Patient</p><p><b>system</b>: false</p><p><b>type</b>: true</p><p><b>instance</b>: false</p><blockquote><p><b>parameter</b></p><p><b>name</b>: ward</p><p><b>use</b>: in</p><p><b>min</b>: 0</p><p><b>max</b>: *</p><p><b>documentation</b>: Ward filters to apply to patient locations</p><p><b>type</b>: string</p><p><b>searchType</b>: reference</p></blockquote><blockquote><p><b>parameter</b></p><p><b>name</b>: return</p><p><b>use</b>: out</p><p><b>min</b>: 1</p><p><b>max</b>: 1</p><p><b>documentation</b>: Searchset bundle</p><p><b>type</b>: Bundle</p></blockquote></div>"
  },
  "url": "http://hl7.org/fhir/OperationDefinition/example-query-high-risk",
  "version": "0.0.1",
  "name": "Example of High-Risk Patient Query",
  "status": "draft",
  "kind": "query",
  "description": "Example Named Query of Patients based on risk assessments",
  "code": "example-query-high-risk",
  "resource": [
    "Patient"
  ],
  "system": false,
  "type": true,
  "instance": false,
  "parameter": [
    {
      "name": "ward",
      "use": "in",
      "min": 0,
      "max": "*",
      "documentation": "Ward filters to apply to patient locations",
      "type": "string",
      "searchType": "reference"
    },
    {
      "name": "return",
      "use": "out",
      "min": 1,
      "max": "1",
      "documentation": "Searchset bundle",
      "type": "Bundle"
    }
  ]
}

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.