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 in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

SD.1 StructureDefinition-argo-endpoint

Scope and Usage

This profile sets minimum expectations for the Endpoint resource to record, search and fetch an Endpoint associated with a Provider or Organization. It identifies the mandatory core elements, extensions, vocabularies and value sets which SHALL be present in the Endpoint resource when using this profile. The requirements for the Argonaut Provider Directory data model were drawn from IHE Healthcare Provider Directory and the ONC Provider Directory Workshop.

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 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

Profile specific implementation guidance:

  • None
Examples

SD.1.1 Formal Views of Profile Content

The official URL for this profile is:

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

This profile builds on Endpoint.

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.

Summary of the Mandatory Requirements

  1. One status code in Endpoint.status which has a required binding to:
  2. One name in Endpoint.name
  3. One reference to a managing organization in Endpoint.managingOrganization
  4. One channel type code in Endpoint.connectionType which has an required binding to:
  5. One address in Endpoint.address
  6. One payload type code in Endpoint.payloadType which has an extensible binding to:

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

 

SD.1.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]/Endpoint?identifier=[system]|[code]

Example: GET [base]/Endpoint?identifier=http://hospital.smarthealthit.org/Endpoints|103270514

Support: Mandatory to search by identifier.

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


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

Example: GET [base]/Endpoint?organization=2354

Support: Mandatory to support search by organization.

Implementation Notes: Search based on organization (how to search by reference).


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

Example: GET [base]/Endpoint?name=good health hospital

Support: Mandatory to support search by Endpoint name.

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