eHealthExchange Healthcare Directory Implementation Guide
1.8.1 - Release 1

: SearchNear - JSON Representation

Active as of 2025-10-27

Raw json | Download

{
  "resourceType" : "OperationDefinition",
  "id" : "search-near",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition search-near</b></p><a name=\"search-near\"> </a><a name=\"hcsearch-near\"> </a><p>URL: [base]/Organization/$search-near</p><h3>Parameters</h3><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>address</td><td/><td>1..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#Address\">Address</a></td><td/><td><div><p>Addresses around which to search.</p>\n</div></td></tr><tr><td>IN</td><td>radius</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#Distance\">Distance</a></td><td/><td><div><p>Threshold radius.</p>\n</div></td></tr><tr><td>IN</td><td>type</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#Coding\">Coding</a></td><td/><td><div><p>Filter on Organization.type.</p>\n</div></td></tr><tr><td>IN</td><td>endpoint:missing</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#boolean\">boolean</a></td><td/><td><div><p>Filter on absence of Organization.endpoint.</p>\n</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/bundle.html\">Bundle</a></td><td/><td><div><p>Bundle of organizations within the threshold of one or more addresses.</p>\n</div></td></tr></table></div>"
  },
  "url" : "https://sequoiaproject.org/fhir/ehx/OperationDefinition/search-near",
  "version" : "1.8.1",
  "name" : "SearchNear",
  "title" : "Search Near",
  "status" : "active",
  "kind" : "operation",
  "date" : "2025-10-27T13:14:09-04:00",
  "publisher" : "eHealthExchange",
  "contact" : [
    {
      "name" : "eHealthExchange",
      "telecom" : [
        {
          "system" : "url",
          "value" : "https://ehealthexchange.org/"
        }
      ]
    }
  ],
  "description" : "Returns organizations containing locations that are within a specified radius of one or more specified addresses. See the following example, which searches for participants with endpoints that are within ten miles of the White House:\n```json\n    {\n      \"resourceType\": \"Parameters\",\n      \"parameter\": [\n        {\n          \"name\": \"address\",\n          \"valueAddress\": {\n            \"line\": [\n              \"1600 Pennsylvania Avenue NW\"\n            ],\n            \"city\": \"Washington\",\n            \"state\": \"DC\",\n            \"postalCode\": \"20500\"\n          }\n        },\n        {\n          \"name\": \"radius\",\n          \"valueDistance\": {\n            \"value\": 10,\n            \"system\": \"http://unitsofmeasure.org\",\n            \"code\": \"[mi_i]\"\n          }\n        },\n        {\n          \"name\": \"type\",\n          \"valueCoding\": {\n            \"system\": \"https://sequoiaproject.org/fhir/sphd/CodeSystem/OrganizationType\",\n            \"code\": \"Participant\"\n          }\n        },\n        {\n          \"name\": \"endpoint:missing\",\n          \"valueBoolean\": false\n        }\n      ]\n    }\n```",
  "code" : "search-near",
  "base" : "https://sequoiaproject.org/fhir/ehx/OperationDefinition/search-near",
  "resource" : [
    "Organization"
  ],
  "system" : false,
  "type" : true,
  "instance" : false,
  "parameter" : [
    {
      "name" : "address",
      "use" : "in",
      "min" : 1,
      "max" : "*",
      "documentation" : "Addresses around which to search.",
      "type" : "Address"
    },
    {
      "name" : "radius",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "Threshold radius.",
      "type" : "Distance"
    },
    {
      "name" : "type",
      "use" : "in",
      "min" : 0,
      "max" : "*",
      "documentation" : "Filter on Organization.type.",
      "type" : "Coding"
    },
    {
      "name" : "endpoint:missing",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Filter on absence of Organization.endpoint.",
      "type" : "boolean"
    },
    {
      "name" : "return",
      "use" : "out",
      "min" : 1,
      "max" : "1",
      "documentation" : "Bundle of organizations within the threshold of one or more addresses.",
      "type" : "Bundle"
    }
  ]
}