eHealthExchange Healthcare Directory Implementation Guide
1.8.1 - Release 1

: AggregateStates - XML Representation

Active as of 2025-10-27

Raw xml | Download


<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="aggregate-states"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: OperationDefinition aggregate-states</b></p><a name="aggregate-states"> </a><a name="hcaggregate-states"> </a><p>URL: [base]/Organization/$aggregate-states</p><p>URL: [base]/Organization/[id]/$aggregate-states</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>_lastUpdated</td><td/><td>0..*</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#instant">instant</a></td><td/><td><div><p>Post-aggregation filter on Organization.meta.lastUpdated.</p>
</div></td></tr><tr><td>IN</td><td>active</td><td/><td>0..*</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a><br/>(<a href="https://hl7.org/fhir/R4/search.html#token">token</a>)</td><td/><td><div><p>Post-aggregation filter on Organization.active.</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#string">string</a><br/>(<a href="https://hl7.org/fhir/R4/search.html#token">token</a>)</td><td/><td><div><p>Post-aggregation filter on Organization.type.</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 with aggregated states.</p>
</div></td></tr></table></div>
  </text>
  <url
       value="https://sequoiaproject.org/fhir/ehx/OperationDefinition/aggregate-states"/>
  <version value="1.8.1"/>
  <name value="AggregateStates"/>
  <title value="Aggregate States"/>
  <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="Aggregates state-of-operation (SOO) extensions for one hierarchy (rooted at the requested instance, if called at the instance level) or for all hierarchies (if called at the type level). Each organization’s SOOs are duplicated to each of its ancestors (if not already present)."/>
  <code value="aggregate-states"/>
  <base
        value="https://sequoiaproject.org/fhir/ehx/OperationDefinition/aggregate-states"/>
  <resource value="Organization"/>
  <system value="false"/>
  <type value="true"/>
  <instance value="true"/>
  <parameter>
    <name value="_lastUpdated"/>
    <use value="in"/>
    <min value="0"/>
    <max value="*"/>
    <documentation
                   value="Post-aggregation filter on Organization.meta.lastUpdated."/>
    <type value="instant"/>
  </parameter>
  <parameter>
    <name value="active"/>
    <use value="in"/>
    <min value="0"/>
    <max value="*"/>
    <documentation value="Post-aggregation filter on Organization.active."/>
    <type value="string"/>
    <searchType value="token"/>
  </parameter>
  <parameter>
    <name value="type"/>
    <use value="in"/>
    <min value="0"/>
    <max value="*"/>
    <documentation value="Post-aggregation filter on Organization.type."/>
    <type value="string"/>
    <searchType value="token"/>
  </parameter>
  <parameter>
    <name value="return"/>
    <use value="out"/>
    <min value="1"/>
    <max value="1"/>
    <documentation value="Bundle of organizations with aggregated states."/>
    <type value="Bundle"/>
  </parameter>
</OperationDefinition>