eHealthExchange Healthcare Directory Implementation Guide
1.8.1 - Release 1

Artifacts Summary

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Behavior: Operation Definitions

These are custom operations that can be supported by and/or invoked by systems conforming to this implementation guide.

AggregateIdentifiers

Aggregates OIDs for one hierarchy or for all hierarchies.

AggregateStates

Aggregates state-of-operation (SOO) extensions for one hierarchy or for all hierarchies.

All

Returns all organizations from an in-memory cache as a single bundle.

GeoExport

Returns a "reduced" representation of organizations that is suitable for mapping.

HubAware

Converts endpoint addresses to Hub URLs.

OrgHierarchy

Returns the hierarchy rooted at the requested instance.

SearchNear

Returns organizations containing locations that are within a specified radius of one or more specified addresses.

StatusChanges

Returns the most recent change to logical deletion status for all organizations, optionally filtered to a specified date range and current deletion status.

StatusSnapshot

Returns the current logical deletion status for all organizations, optionally filtered to a specified deletion status.

Behavior: Search Parameters

These define the properties by which a RESTful server can be searched. They can also be used for sorting and including related resources.

NameOrID

The organization's name or ID or alias, ignoring the resource type (Organization/) and version (/_history/...)

Structures: Abstract Profiles

These are profiles on resources or data types that describe patterns used by other profiles, but cannot be instantiated directly. I.e. instances can conform to profiles based on these abstract profiles but do not declare conformance to the abstract profiles themselves.

eHx Organization

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide.

eHx Endpoint
eHx Participant
eHx SubParticipant
eHx Subparticipant Location

Structures: Extension Definitions

These define constraints on FHIR data types for systems conforming to this implementation guide.

EHx Subparticipant Org Location

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.

Participant Hospital

Participant Organization example

ParticipantEndpointExample

Participant Endpoint example

Subparticipant Hospital

Subparticipant Organization example

Subparticipant Location example

Subparticipant Location example