• Narrative Content
• XML
• JSON
• TTL

: SearchNear - XML Representation

Active as of 2025-10-27

Raw xml | Download

<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="search-near"/>
  <text>
    <status value="generated"/>
    <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>
</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>
</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>
</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>
</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>
</div></td></tr></table></div>
  </text>
  <url
       value="https://sequoiaproject.org/fhir/ehx/OperationDefinition/search-near"/>
  <version value="1.8.1"/>
  <name value="SearchNear"/>
  <title value="Search Near"/>
  <status value="active"/>
  <kind value="operation"/>
  <date value="2025-10-27T13:14:09-04:00"/>
  <publisher value="eHealthExchange"/>
  <contact>
    <name value="eHealthExchange"/>
    <telecom>
      <system value="url"/>
      <value value="https://ehealthexchange.org/"/>
    </telecom>
  </contact>
  <description
               value="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:
```json
    {
      &quot;resourceType&quot;: &quot;Parameters&quot;,
      &quot;parameter&quot;: [
        {
          &quot;name&quot;: &quot;address&quot;,
          &quot;valueAddress&quot;: {
            &quot;line&quot;: [
              &quot;1600 Pennsylvania Avenue NW&quot;
            ],
            &quot;city&quot;: &quot;Washington&quot;,
            &quot;state&quot;: &quot;DC&quot;,
            &quot;postalCode&quot;: &quot;20500&quot;
          }
        },
        {
          &quot;name&quot;: &quot;radius&quot;,
          &quot;valueDistance&quot;: {
            &quot;value&quot;: 10,
            &quot;system&quot;: &quot;http://unitsofmeasure.org&quot;,
            &quot;code&quot;: &quot;[mi_i]&quot;
          }
        },
        {
          &quot;name&quot;: &quot;type&quot;,
          &quot;valueCoding&quot;: {
            &quot;system&quot;: &quot;https://sequoiaproject.org/fhir/sphd/CodeSystem/OrganizationType&quot;,
            &quot;code&quot;: &quot;Participant&quot;
          }
        },
        {
          &quot;name&quot;: &quot;endpoint:missing&quot;,
          &quot;valueBoolean&quot;: false
        }
      ]
    }
```"/>
  <code value="search-near"/>
  <base
        value="https://sequoiaproject.org/fhir/ehx/OperationDefinition/search-near"/>
  <resource value="Organization"/>
  <system value="false"/>
  <type value="true"/>
  <instance value="false"/>
  <parameter>
    <name value="address"/>
    <use value="in"/>
    <min value="1"/>
    <max value="*"/>
    <documentation value="Addresses around which to search."/>
    <type value="Address"/>
  </parameter>
  <parameter>
    <name value="radius"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation value="Threshold radius."/>
    <type value="Distance"/>
  </parameter>
  <parameter>
    <name value="type"/>
    <use value="in"/>
    <min value="0"/>
    <max value="*"/>
    <documentation value="Filter on Organization.type."/>
    <type value="Coding"/>
  </parameter>
  <parameter>
    <name value="endpoint:missing"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="Filter on absence of Organization.endpoint."/>
    <type value="boolean"/>
  </parameter>
  <parameter>
    <name value="return"/>
    <use value="out"/>
    <min value="1"/>
    <max value="1"/>
    <documentation
                   value="Bundle of organizations within the threshold of one or more addresses."/>
    <type value="Bundle"/>
  </parameter>
</OperationDefinition>