Location

From HL7 Argonaut Project Wiki
Jump to: navigation, search

Back to Argonaut Implementation Guide

Approved Argonaut design has been formalized and moved

Official Argonaut IG

Introduction

The Argonaut Location provides the API documentation for searching for and fetching a Location. 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

  • A server is capable of returning a location by name using GET [base]/Location?name=[string]
  • A server is capable of returning a location by address using GET [base]/Location?address=[string]
  • A server has ensured that every API request includes a valid Authorization token, supplied via:Authorization: Bearer {server-specific-token-here}
  • A server has rejected any unauthorized requests by returning an HTTP 401 Unauthorized response code.

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 Location must have:

  1. A status of the Location
  2. A name
  3. A list of contact information
  4. A managing Organization

Formal Summary of the Mandatory Requirements

  1. A Location.active
  2. A Location.name
  3. A Location.telecom
  4. A Location.address
  5. A managingOrganization

Additional Requirements

  1. A server SHALL support the_include parameter when retrieving a Location resource.

Future recommended elements:

  1. A Location.type
    • The Location.type must come from value set?
  2. At least one identifier in Location.identifier (NPI, taxID, etc)
    • NPI preferred
    • Tax id is allowed
    • Local id is allowed in addition to 'authoritative' identifier
Location Resource Example

Quick Start

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

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

Support: Mandatory

Implementation Notes: Search based on Location 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]/Location?name=[string]

Support: Mandatory

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

  • address-city
  • address-state
  • address-postalcode

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]/Location?address=[string]

Support: Mandatory

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

SHOULD support:

  • address-city
  • address-state
  • address-postalcode

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?address=Arbor]
[GET https://fhir-open-api-dstu2.smarthealthit.org/Location?address-postalcode=48104]

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.