Endpoint

From HL7 Argonaut Project Wiki
Jump to: navigation, search

Back to Argonaut Implementation Guide

Introduction

The Argonaut Endpoint provides the API documentation for searching for and fetching an Endpoint. This content profile is the minimum bar, local implementations may add requirements.

The requirements for the Argonaut Provider Directory data model were drawn from IHE Healthcare Provider Directory and the ONC Provider Directory Workshop.

Minimum Requirements

Clients

Servers

Mandatory Data Elements

The following data-elements are mandatory (i.e data MUST be present). These are presented below in simple human-readable explanations along with sample data to demonstrate the requirements.

Each Endpoint must have:

  1. A status
  2. A name
  3. A managing organization
  4. The channel type to send notifications on (connectionType)
  5. The address

Formal Summary of the Mandatory Requirements

  1. A Endpoint.status from EndpointStatus
  2. A Endpoint.name
  3. A Endpoint.managingOrganization
  4. A Endpoint.connectionType from SubscriptionChannelType
  5. A Endpoint.address
  6. A Endpoint.payloadFormat <-- not discussed in Argonaut, but required in current build.
  7. A Endpoint.payloadType <-- not discussed in Argonaut, but required in current build.


***Baltimore Connectathon Design Discussion on Endpoint - We expect this to be present in the FHIR build by mid-October.***

Endpoint Resource Example

Quick Start

Below is a quick overview of the required search and read operations.

GET [base]/Endpoint?identifier=[system]|[code]

Support: Mandatory

Implementation Notes: Search based on EndPoint identifier (how to search by token).

Response Class:

  • (Status 200): successful operation
  • (Status 400): invalid parameter
  • (Status 401/4xx): unauthorized request
  • (Status 403): insufficient scope

Example:

[GET http://fhir2.healthintersections.com.au/open/Location?identifier=urn:ietf:rfc:3986%7C2.16.840.1.113883.19.5]


GET [base]/Endpoint?name=[string]

Support: Mandatory

Implementation Notes: name - Search based on text name (how to search by string).

Response Class

  • (Status 200): successful operation
  • (Status 400): invalid parameter
  • (Status 401/4xx): unauthorized request
  • (Status 403): insufficient scope

Example:

[GET https://fhir-open-api-dstu2.smarthealthit.org/Location?name=Health]


GET [base]/Endpoint?organization=[id]

Support: Mandatory

Implementation Notes: Search for all Endpoints for an organization. Fetches a bundle of all Endpoint resources for the specified Organization (how to search by reference).

Response Class

  • (Status 200): successful operation
  • (Status 400): invalid parameter
  • (Status 401/4xx): unauthorized request
  • (Status 403): insufficient scope

Example:

[GET https://fhir-open-api-dstu2.smarthealthit.org/Location?name=Health]

Open Issues

The following issues have been identified:

Resources

Formalized testing with test scripts and objective results reporting is available through the participation of AEGIS and MITRE (Crucible). The testscript provided can be used to test servers: [todo]

References


Back to Argonaut Implementation Guide

Copyright © Health Level Seven International ® ALL RIGHTS RESERVED. The reproduction of this material in any form is strictly forbidden without the written permission of the publisher.