eHealthExchange Healthcare Directory Implementation Guide
1.8.1 - Release 1

: HubAware - XML Representation

Active as of 2025-10-27

Raw xml | Download


<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="hub-aware"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: OperationDefinition hub-aware</b></p><a name="hub-aware"> </a><a name="hchub-aware"> </a><p>URL: [base]/Organization/$hub-aware</p><p>URL: [base]/Organization/[id]/$hub-aware</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>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 with Hub URLs.</p>
</div></td></tr></table></div>
  </text>
  <url
       value="https://sequoiaproject.org/fhir/ehx/OperationDefinition/hub-aware"/>
  <version value="1.8.1"/>
  <name value="HubAware"/>
  <title value="Hub Aware"/>
  <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="Responds with updated contained Endpoint resources that have addresses based on hub-aware formats (key-version, transaction). This operation supports all search parameters for the Organization resource type."/>
  <code value="hub-aware"/>
  <base
        value="https://sequoiaproject.org/fhir/ehx/OperationDefinition/hub-aware"/>
  <resource value="Organization"/>
  <system value="false"/>
  <type value="true"/>
  <instance value="true"/>
  <parameter>
    <name value="return"/>
    <use value="out"/>
    <min value="1"/>
    <max value="1"/>
    <documentation value="Bundle of organizations with Hub URLs."/>
    <type value="Bundle"/>
  </parameter>
</OperationDefinition>