Argonaut Provider Directory Implementation Guide Version 1.0.0

This page is part of the Argonaut Provider Directory Guide (v1.0.0: Release) based on FHIR R3. This is the current published version. For a full list of available versions, see the Directory of published versions

SD.2 StructureDefinition-argo-location

This profile sets minimum expectations for the Location resource for recording, searching for and fetching a Location associated with a provider or organization. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the resource when using this profile.

Mandatory Data Elements and Terminology

The following data-elements are mandatory (i.e data MUST be present). These are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements.

Each Location must have:

Each Location must have:

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

Each Location SHOULD have:

  1. A Location type
  2. A Location identifier
  3. A Location endpoint

Profile specific implementation guidance:

  • A server SHALL support the _include parameter when retrieving a Location resource.
Examples

SD.2.1 Formal Views of Profile Content

The official URL for this profile is:

http://fhir.org/guides/argonaut-pd/StructureDefinition/argo-location

This profile builds on Location.

This profile was published on Wed Nov 09 00:00:00 AEDT 2016 as a draft by Argonaut Project.

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

Complete Summary of the Mandatory Requirements

  1. A Location.status which has an required binding to:
  2. A Location.name
  3. A Location.telecom
  4. A Location.address
  5. A Location.managingOrganization

Each Location SHOULD have:

  1. A Location.type
    • The Location.type must come from value set?
  2. At least one identifier in Location.identifier
    • NPI preferred
    • Tax id is allowed
    • Local id is allowed in addition to ‘authoritative’ identifier
  3. A Location.endpoint

Downloads: StructureDefinition: (XML, JSON, CSV), Schema: XML Schematron

 

SD.2.2 - Quick Start

Below is an overview of the required search and read operations for this profile. See the Conformance requirements for a complete list of supported RESTful operations and search parameters for this IG.


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

Example: GET [base]/Location?identifier=http://hospital.smarthealthit.org/Location|123571

Support: Mandatory to search by identifier.

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


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

Example: GET [base]/Location?name=Health

Support: Mandatory to support search by Location name.

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


GET [base]/Location?address=[string]

Example: GET [base]/Location?address=Arbor

Example: GET [base]/Location?address-postalcode=48104

Support: Mandatory to support search by address.

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

SHOULD support the following search parameters:

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