Sequoia Project Healthcare Directory Implementation Guide
1.0.3 - Release 1 United States of America flag

Artifacts Summary

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

Behavior: Capability Statements

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

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.

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.

SequoiaOrganization

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.

Structures: Resource Profiles

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.

Structures: Extension Definitions

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

Administrative Status

This extension is currently only used by eHealthExchange. This should be ignored in other directories.

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.

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.

Downtime

This extension is used on the Endpoint resource and indicates expected future down-time of the endpoint for maintenance, etc.

Hub Routing Status

This extension is currently only used by eHealthExchange. This should be ignored in other directories.

Hub Service Subscription

This extension is currently only used by eHealthExchange. This should be ignored in other directories.

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.

Org Location

This extension is used on the Organization resource to indicate the geolocation and organization role at a given address.

Org Managing Org

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.

Org Role

This extension is used on the Location resoruce to indicate the organization role at a given address.

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.

StateOfOperation

This extension is used on the Organization resource. It is repeatable, and each instances contains a state or province in which the organization operates.

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)

Use Cases

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.

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.

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide.

Administrative Status

Codes used by the AdministrativeStatus extension.

Domains

Codes used by the Domains extension.

Endpoint Connection Type

Codes used in Endpoint.connectionType

Endpoint Payload Type Codes

Codes used in Endpoint.payloadType

Endpoint Use Case Codes

Codes used by the UseCases extension

Hub Routing Status

Codes used by the HubRoutingStatus extension

Hub Service Subscriptions

This extension is currently only used by eHealthExchange. This should be ignored in other directories.

Identifier Codes

Codes used in Identifier.type

Initiator Only

Codes used by the InitiatorOnly 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

Purpose Of Use

Codes used by the PurposesOfUse extension

RCE Purpose ValueSet

Codes used for the RCE implementation of the PurposesOfUse extension. Each code is used as defined in the Common Agreement, QHIN Technical Framework, Exchange Purposes SOP, and any other applicable Exchange Purpose Implementation SOP.

SequoiaServiceDeliveryLocationRoleTypeValueSet

Adds additional codes required by Sequoia directories that are not present in the HL7 Service Delivery Location Role Type value set.

Transactions

Codes used by the Transactions extension

Terminology: Code Systems

These define new code systems used by systems conforming to this implementation guide.

Administrative Status

This extension is currently only used by eHealthExchange. This should be ignored in other directories.

Domains

Codes used by the Domains extension

Endpoint Connection Type

Codes used in Endpoint.connectionType

Endpoint Role Codes

Codes used by the Roles extension

Endpoint Use Case Codes

Codes used by the UseCases extension

Hub Routing Status

Codes used by the HubRoutingStatus extension

Hub Service Subscription Codes

Codes used by the HubServiceSubscriptions 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.

Organization Type

Codes used in Organization.type

Purpose Of Use

Codes used by the PurposesOfUse extension

RCE Purpose

Codes used for the RCE implementation of the PurposesOfUse extension. Each code is used as defined in the Common Agreement, QHIN Technical Framework, Exchange Purposes SOP, and any other applicable Exchange Purpose Implementation SOP.

Sequoia Identifier Codes

Codes used in Identifier.type

SequoiaServiceDeliveryLocationRoleTypeCodingSystem

Adds additional codes required by Sequoia directories that are not present in the HL7 Service Delivery Location Role Type code system.

Transaction Codes

Codes used by the Transaction extension

Example: Example Instances

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

Create Error Example

Create Error Example

Create Full Example 2

Create Full Example 2

Create Success Example

Create Success Example

Create Success Example 2

Create Success Example 2

Delete Error Example

Delete Error Example

Delete Success Example

Delete Success Example

Delete Success Example 2

Delete Success Example 2

Delete Success Example 3

Delete Success Example 3

Delete Success Example 4

Delete Success Example 4

Eric Hospital

Example SequoiaOrganization

Eric Hospital

Update Success Example 2

Eric Hospital

Update Success Example 4

Kyras Clinic

Create Full Example

Read Error Example

Read Error Example

Read Success Example

Read Success Example

Read Success Example

Read Success Example

Read Success Example

Read Success Example

Read Success Example 4

Read Success Example 4

Read Success Example 5

Read Success Example 5

Read Success Example 6

Read Success Example 6

Read Success Example 7

Read Success Example 7

Update Success Example

Update Success Example

Update Success Example 3

Update Success Example 3

Update Success Example 5

Update Success Example 5

Validate Error Example

Validate Error Example

Validate Success Example

Validate Success Example