Sequoia Project Healthcare Directory Implementation Guide
0.0.10 - CI Build
Sequoia Project Healthcare Directory Implementation Guide - Local Development build (v0.0.10). See the Directory of published versions
Contents:
This page provides a list of the FHIR artifacts defined as part of this implementation guide.
The following artifacts define the specific capabilities that different types of systems are expected to have in order to comply with this implementation guide. Systems conforming to this implementation guide are expected to declare conformance to one or more of the following capability statements.
Sequoia Project Healthcare Directory |
Sequoia Project FHIR Provider Directory |
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.
Sequoia Endpoint |
This profile on the FHIR Endpoint resource represents information about the endpoints provided by organizations participating in Sequoia project sponsored exchanges. The endpoints described can use any Sequoia supported protocol, such as IHE XCA, and need not be FHIR endpoints. |
Sequoia Organization |
This profile on the FHIR Organization resource is an abstract base profile that defines shared constraints for all other profiles on the Organization resource in the implementation guides that are based on it. It is not intended to be used directly, rather end users should create instances conforming to the non-abstract profiles defined in other IGs such as Carequality, eHealthExchange, and RCE. |
These define constraints on FHIR resources for systems conforming to this implementation guide.
Sequoia Location |
This profile on the FHIR Location resource is used to store geolocation data about an address, as well as the OrgRole extension. If not set by the QHIN when publishing an Organization address to the Directory, SequoiaLocation is created by the Directory with geolocation Position details determined from the provided physical address. |
These define constraints on FHIR data types for systems conforming to this implementation guide.
Hub Routing Status |
This extension is currently only used by eHealthExchange. This should be ignored in other directories. |
StateOfOperation |
This extension on the Organization resource contains States (or Provinces/Territories) in which Organization operates. |
Domains |
This extension is used on the Organization resource and indicates which Sequoia directory (or directories) the Organization participantes in. The current legal values are CQ, eHx, and RCE. Most Organizations would only have a single value in this extension. |
Hub Service Subscription |
This extension is currently only used by eHealthExchange. This should be ignored in other directories. |
Downtime |
This extension is used on the Endpoint resource and indicates expected future down-time of the endpoint for maintenance, etc. |
Org Role |
This extension is used on the Location resoruce to indicate the organization role at a given address. |
Company |
The company or organization affiliated with the contact. The contact’s company/organization may differ from the Organization.name as the company may be working as a technology partner or consultant in support of the entity defined by the Organization.name. This extension is only necessary when the contact person is employed by an organization different from the one specified in the Organization resource itself. |
OrgManagingOrg |
This extension is directly tied to the Directory server access API key allowing Organizations to be created, updated, and deleted only by their managing Organization. This is typically the top-level Organization in the hierarchical chain defined by partOf. |
Transaction |
This extension is used on the Endpoint resource and indicates the profile/standard supported for transactions sent to the Endpoint address (e.g., XCA ITI-38) |
Version |
When an implementation of the Sequoia Directory IG allows multiple published versions of a single transaction profile/standard, this extension indicates the specific Version supported for transactions sent to the Endpoint address. |
UseCases |
When an implementation of the Sequoia Directory IG has unique requirements tied to specific Use Case participation, this extension is used on the Organization resource to indicate which Use Case(s) the Organization participates in. |
Purposes Of Use |
This extension is used on both the Endpoint and Organization resources. For an Endpoint, this extension defines the Purpose(s) of Use for which the Endpoint will receive and respond to requests from others. An Organization may have multiple Endpoints for the same Transaction type that receive and process different Purposes of Use. For an Organization, this extension defines the Purpose(s) of Use for which the Organization will initiate requests to others. |
Roles |
This extension is used on the Endpoint resource and provides SNOMED CT codes to indicate the clinical role(s) of document authors for documents available from that Endpoint. |
Initiator Only |
When an Organization participates in a Use Case that includes a requirement to respond to requests from others, this extension may be used on that Organization resource to indicate that they meet an Initiator Only exception and do not have Endpoints for that Use Case, if allowed by the Use Case’s Initiator Only policies. |
Administrative Status |
This extension is currently only used by eHealthExchange. This should be ignored in other directories. |
Org Location |
This extension is used on the Organization resource to indicate the geolocation and organization role at a given address. |
These define sets of codes used by systems conforming to this implementation guide.
Hub Routing Status |
Codes used by the HubRoutingStatus extension |
Administrative Status |
Codes used by the AdministrativeStatus extension. |
Domains |
Codes used by the Domains extension. |
Hub Service Subscriptions |
This extension is currently only used by eHealthExchange. This should be ignored in other directories. |
Endpoint Use Case Codes |
Codes used by the UseCases extension |
NHIN User Role |
The value set is defined by the NHIN Specifications Factory to the restricted set of SNOMED CT codes listed in Table 2-155 Author Role Value Set Definition |
Organization Type |
Codes used in Organization.type |
Identifier Codes |
Codes used in Identifier.type |
Purpose Of Use |
Codes used by the PurposesOfUse extension |
Initiator Only |
Codes used by the InitiatorOnly extension |
Endpoint Payload Type Codes |
Codes used in Endpoint.payloadType |
Endpoint Connection Type |
Codes used in Endpoint.connectionType |
Transactions |
Codes used by the Transactions extension |
These define new code systems used by systems conforming to this implementation guide.
Hub Routing Status |
Codes used by the HubRoutingStatus extension |
Administrative Status |
This extension is currently only used by eHealthExchange. This should be ignored in other directories. |
Domains |
Codes used by the Domains extension |
HubServiceSubscriptionCodes |
Codes used by the HubServiceSubscriptions extension |
SequoiaIdentifierCodes |
Codes used in Identifier.type |
Endpoint Use Case Codes |
Codes used by the UseCases extension |
Organization Type |
Codes used in Organization.type |
Endpoint Role Codes |
Codes used by the Roles extension |
Purpose Of Use |
Codes used by the PurposesOfUse extension |
Transaction Codes |
Codes used by the Transaction extension |
Initator Only Codes |
When an Organization participates in a Use Case that includes a requirement to respond to requests from others, this extension may be used on that Organization resource to indicate that they meet an Initiator Only exception and do not have Endpoints for that Use Case, if allowed by the Use Case’s Initiator Only policies. |
Endpoint Connection Type |
Codes used in Endpoint.connectionType |
These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.