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.4 StructureDefinition-argo-practitioner

This profile sets minimum expectations for the Practitioner resource to record [content] associated with a patient. 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 Practitioner must have:

  1. An identifier (NPI preferred)
  2. A name

Profile specific implementation guidance:

  • none
Examples

SD.4.1 Formal Views of Profile Content

The official URL for this profile is:

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

This profile builds on Practitioner.

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. At least one (non-local) identifier in Practitioner.identifier
    • NPI preferred
    • Tax id is allowed
    • Local id is allowed in addition to authoritative identifier
  2. One name in Practitioner.name

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

 

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

Example: GET [base]/Practitioner?identifier=http://hl7.org/fhir/sid/us-npi|1497860456

Support: Mandatory to search by identifier.

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


GET [base]/Practitioner?family=[string]&given=[string]

Example: GET [base]/Practitioner?family=Smith&given=John

Support: Mandatory to support search by Practitioner name.

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