PractitionerRole

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 PractitionerRole provides the API documentation for searching for and fetching a Provider (Practitioner) role. 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.

The PractitionerRole Resource in the Provider Directory IG is based upon the candidate STU 3.0 version.

Minimum Requirements

Clients

Servers

By default, servers will only return active records.

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

  1. An associated practitioner
  2. An associated organization
  3. A list of specialities
  4. Contact information

Formal Summary of the Mandatory Requirements

  1. PractitionerRole.practitioner
  2. PractitionerRole.organization
  3. PractitionerRole.code (NUCC - Classification) binding extensible
  4. PractitionerRole.speciality (NUCC - Specialization) binding extensible
  5. PractitionerRole.location
  6. PractitionerRole.telecom OR PractitionerRole.Endpoint.Reference


Additional Requirements

  1. The Practitioner resource SHALL be included when returning the PractitionerRole resource.
  2. The Endpoint resource SHALL be included when returning the PractitionerRole resource.
  3. The PractitionerRole.endpoint is where the Direct address is included.


PractitionerRole Resource Example
PractitionerRole Resource Example with contained Endpoint and Practitioner
PractitionerRole_Resource_Example_with_referenced_Practitioner
PractitionerRole_Resource_Example_with_referenced_Practitioner_Endpoint
Practitioner Resource Example
Location Resource Example

Quick Start

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

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

Support: Mandatory

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

Response Class:

  • (Status 200): successful operation
  • (Status 400): invalid parameter
  • (Status 401): unauthorized request

Example:

[GET  http://fhir3.healthintersections.com.au/open/PractitionerRole?identifier=http://www.acme.org/practitioners%7C23]


GET [base]/PractitionerRole?practitioner.identifier=[system]|[code]

Support: Mandatory

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

Response Class:

  • (Status 200): successful operation
  • (Status 400): invalid parameter
  • (Status 401): unauthorized request

Example:

[GET  http://fhir3.healthintersections.com.au/open/PractitionerRole?practitioner.identifier=http://hl7.org/fhir/sid/us-ssn%7C999999999]


GET [base]/PractitionerRole?practitioner.family=[string]&practitioner.given=[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): unauthorized request

Example:

[GET  http://fhir3.healthintersections.com.au/open/PractitionerRole?practitioner.family=verify&practitioner.given=v]
[GET http://fhir3.healthintersections.com.au/open/PractitionerRole?practitioner.family=verify&practitioner.given=v&_include=PractitionerRole:practitioner]

GET [base]/PractitionerRole?specialty=[system]|[code]

Support: Mandatory

Implementation Notes: name - Search based on specialty (how to search by token).

Response Class

  • (Status 200): successful operation
  • (Status 400): invalid parameter
  • (Status 401): unauthorized request

Example:

[GET  http://fhir3.healthintersections.com.au/open/PractitionerRole?specialty=http://hl7.org/fhir/practitioner-specialty%7Ccardio]
[Get http://fhir3.healthintersections.com.au/open/PractitionerRole?specialty:text=cardio&_include=PractitionerRole:practitioner]


Searches under development

GET [base]/Practitioner?location.address-city=[city]
GET [base]/Practitioner?location.address-city=[city]&specialty=[string]
GET [base]/Practitioner?location.near=-72.519854,42.373222&near-distance=2m

Support: Mandatory

Implementation Notes: name - Search based on city and speciality (how to search by token).

Response Class

  • (Status 200): successful operation
  • (Status 400): invalid parameter
  • (Status 401): unauthorized request

Example:

[GET XXX]

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.