eHealthExchange Healthcare Directory Implementation Guide
1.8.1 - Release 1
eHealthExchange Healthcare Directory Implementation Guide
1.8.1 - Release 1
| Active as of 2025-10-27 |
{
"resourceType" : "OperationDefinition",
"id" : "aggregate-identifiers",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition aggregate-identifiers</b></p><a name=\"aggregate-identifiers\"> </a><a name=\"hcaggregate-identifiers\"> </a><p>URL: [base]/Organization/$aggregate-identifiers</p><p>URL: [base]/Organization/[id]/$aggregate-identifiers</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>\n</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>\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#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>\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 with aggregated OIDs.</p>\n</div></td></tr></table></div>"
},
"url" : "https://sequoiaproject.org/fhir/ehx/OperationDefinition/aggregate-identifiers",
"version" : "1.8.1",
"name" : "AggregateIdentifiers",
"title" : "Aggregate Identifiers",
"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" : "Aggregates OIDs for one hierarchy (rooted at the requested instance, if called at the instance level) or for all hierarchies (if called at the type level). Here, OID refers to an HCID or AAID that appears either in an organization’s identifiers or in its contained endpoints’ identifiers. Organizations containing no endpoints are ignored except for the purpose of defining hierarchies. Aggregation is applied both “vertically” and “horizontally.” I.e., OIDs are deduplicated to the highest level both within and across hierarchies. Horizontal deduplication (between organizations not related as ancestor/descendant) is considered exceptional and produces a log warning.",
"code" : "aggregate-identifiers",
"base" : "https://sequoiaproject.org/fhir/ehx/OperationDefinition/aggregate-identifiers",
"resource" : [
"Organization"
],
"system" : false,
"type" : true,
"instance" : true,
"parameter" : [
{
"name" : "_lastUpdated",
"use" : "in",
"min" : 0,
"max" : "*",
"documentation" : "Post-aggregation filter on Organization.meta.lastUpdated.",
"type" : "instant"
},
{
"name" : "active",
"use" : "in",
"min" : 0,
"max" : "*",
"documentation" : "Post-aggregation filter on Organization.active.",
"type" : "string",
"searchType" : "token"
},
{
"name" : "type",
"use" : "in",
"min" : 0,
"max" : "*",
"documentation" : "Post-aggregation filter on Organization.type.",
"type" : "string",
"searchType" : "token"
},
{
"name" : "return",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "Bundle of organizations with aggregated OIDs.",
"type" : "Bundle"
}
]
}