Practitioner

Overview

Practitioner Information addresses:

• Practitioner HL7® FHIR® resource with US Core Profile 6.1.0

Practitioner is a person who is directly or indirectly involved in the provisioning of healthcare. This profile meets the U.S. Core Data for Interoperability (USCDI) v3 requirements for Care Team Member and Practitioner Information.

Practitioner covers all individuals who are engaged in the healthcare process and healthcare-related services as part of their formal responsibilities and this Resource is used for attribution of activities and responsibilities to these individuals.

Example Usage Scenarios:

The following are example usage scenarios for the this profile:

• Query for an practitioner by name or NPI
• Reference from other Resources

Each Practitioner has next elements:

• an identifier which must support an NPI if available.
• a name

Each Practitioner supports next elements:

• Contact information
• An address

Practitioner response will be provided in JSON (refers to Capability Statement) format as per FHIR standard R4 version.

This resource refers to US Core Practitioner Profile 6.1.0.

Must support elements, mandatory and optional search parameters

Practitionermust support these elements:

• Slices for identifier
  • identifier: all slices
    • system
    • value
  • identifier: NPI
• active
• name
  • family
• telecom
  • system
  • value
• address
  • line
  • city
  • state
  • postalCode
  • country

Each Practitioner Must Have (Mandatory):

• identifier
  • system
  • value
• name
  • family

Practitioner response will be provided in JSON (refers to Capability Statement) format as per FHIR standard R4 version.

The following search parameters and search parameter combinations SHALL be supported:

The syntax used to describe the interactions is described here.

SHALL support searching for a practitioner by a string match of any part of name using the name search parameter: GET [base url]/Practitioner?name=[string]

SHALL support searching a practitioner by an identifier such as an NPI using the identifier search parameter: GET [base url]/Practitioner?identifier={system|}[code]

The following search parameters and search parameter combinations SHOULD be supported:

SHOULD support searching using the _id search parameter: GET [base url]/Practitioner?_id=[id]

The response to any search operation is always a list of resources in a Bundle or an Operation Outcome.

Practitioner By Name

Search for Practitioner by name using string match.

METHOD GET

GET [base url]/Practitioner?name=[string]

PARAMS [base url] - FHIR base url [string] - Practitioner's name (any portion - given, family, prefix, suffix)

HEADERS

The Authorization token SHALL be obtained during Authentication and Authorization process. Goto Authentication and Authorization for further details.

Header	Type	Required/Optional	Value
Authorization	string	required	Bearer <token>

RESPONSES

Code	Description	Comment
200	OK	The request was processed successfully
400	Bad request	Invalid request parameters or FHIR operation outcome resource returned
401	Unauthorized	This code indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource
404	no Route matched with those values	The request was able to communicate with a given server, but the server could not find what was requested
500	Internal Server Error	The server has encountered a situation it doesn't know how to handle

The response to any search operation is always a list of resources in a Bundle or an Operation Outcome.

EXAMPLE:

curl --location --request GET 'https://sandbox.fhir.elationemr.com/fhir/Practitioner?name=Smith' \
--header 'Authorization: Bearer fe1cd986-1ac7-4c26-b8b3-d632a48408fd'

Practitioner By Identifier

Search for Practitioner by identifier (such as NPI).

METHOD GET

GET [base url]/Practitioner?identifier={system|}[code]

PARAMS

[base url] - FHIR base url {system|} - The system for the identifier. FHIR search token parameter. See Search specification for more information. Example: http://hl7.org/fhir/sid/us-npi| [code] - Identifier code. Example: NPI number 1234567890

HEADERS

The Authorization token SHALL be obtained during Authentication and Authorization process. Goto Authentication and Authorization for further details.

Header	Type	Required/Optional	Value
Authorization	string	required	Bearer <token>

RESPONSES

Code	Description	Comment
200	OK	The request was processed successfully
400	Bad request	Invalid request parameters or FHIR operation outcome resource returned
401	Unauthorized	This code indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource
404	no Route matched with those values	The request was able to communicate with a given server, but the server could not find what was requested
500	Internal Server Error	The server has encountered a situation it doesn't know how to handle

The response to any search operation is always a list of resources in a Bundle or an Operation Outcome.

EXAMPLE:

curl --location --request GET 'https://sandbox.fhir.elationemr.com/fhir/Practitioner?identifier=http://hl7.org/fhir/sid/us-npi|1234567890' \
--header 'Authorization: Bearer fe1cd986-1ac7-4c26-b8b3-d632a48408fd'

Practitioner By Id

Fetch a single Practitioner by internal resource id.

METHOD GET

GET [base url]/Practitioner/{id}

or

GET [base url]/Practitioner?_id={id}

PARAMS

[base url] - FHIR base url {id} - Practitioner's internal resource id

HEADERS

The Authorization token SHALL be obtained during Authentication and Authorization process. Goto Authentication and Authorization for further details.

Header	Type	Required/Optional	Value
Authorization	string	required	Bearer <token>

RESPONSES

Code	Description	Comment
200	OK	The request was processed successfully
400	Bad request	Invalid request parameters or FHIR operation outcome resource returned
401	Unauthorized	This code indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource
404	no Route matched with those values	The request was able to communicate with a given server, but the server could not find what was requested
500	Internal Server Error	The server has encountered a situation it doesn't know how to handle

The response to any search operation is always a list of resources in a Bundle or an Operation Outcome.

EXAMPLE:

curl --location --request GET 'https://sandbox.fhir.elationemr.com/fhir/Practitioner/97860456' \
--header 'Authorization: Bearer fe1cd986-1ac7-4c26-b8b3-d632a48408fd'