Practitioner read

get/Practitioner/{id}

Page View

This resource includes details about an individual at a healthcare organization. The individual may range from those indirectly responsible for patient treatment or services (e.g., receptionists, IT personnel) to those directly responsible for patient treatment or services (e.g., physicians, pharmacists, therapists). However, this resource doesn’t include people related to the patient like a caregiver.

You can review or retrieve practitioner records.

Supported fields and schema examples

We support any valid FHIR® field. However, we only display fields we’ve defined in our schema, which are usually based on what’s included in the U.S. Core profile. We recommend relying on U.S. Core requirements.

Our schema examples show the shape and possibility of each FHIR® resource; they aren’t code for real-time API calls. We don’t currently recommend copying and pasting these schema examples for your API calls. Consider reviewing FHIR® API actions for realistic examples for particular use cases.

read

Review a specific Practitioner resource with details about a practitioner assigned to a patient you're treating or interacting with.

FHIR read

To use a read interaction, you must know the related resource ID, which you may not have in your real workflows. A read is likely only a follow-up option after receiving the specific resource in a recent FHIR® passthrough or data on demand exchange.

Typically, you should use the more flexible _search with query parameters, unless you're guaranteed to request data directly from a FHIR® server using the resource ID. Learn more about using FHIR® identifiers.

Request parameters

cURL request example

bash

1
curl 'https://api.redoxengine.com/fhir/R4/{destinationSlug}/{environmentFlag}/Practitioner/{id}' \
2
--request GET \
3
--header 'Authorization: Bearer $API_TOKEN'

Request Parameters

id
required, string
Practitioner identifier

Response fields and example

json

1
{}

A profile on the practitioner resource that conforms to Redox requirements.

resourceType
required, string
Identifies the type of the resource
Value: Practitioner
identifier
required, Array of NPI or Other
An identifier that applies to this person in this role.
name
required, Array of object
The name(s) associated with the practitioner.
- family
  required, string
  The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.
- use
  string
  Identifies the purpose for this name.
  Possible Values: usual, official, temp, nickname, anonymous, old, maiden
- given
  Array of string
  Given name.
id
string
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
active
boolean
Whether this practitioner's record is in active use.
telecom
Array of object
A contact detail for the practitioner, e.g. a telephone number or an email address.
- system
  string
  Telecommunications form for contact point - what communications system is required to make use of the contact.
  Possible Values: phone, fax, email, pager, url, sms, other
- value
  string
  The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).
- use
  string
  Identifies the purpose for the contact point.
  Possible Values: home, work, temp, old, mobile
address
Array of object
Address(es) of the practitioner that are not role specific (typically home address). Work addresses are not typically entered in this property as they are usually role dependent.
- line
  Array of string
  This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.
- city
  string
  The name of the city, town, suburb, village or other community or delivery center.
- state
  string
  Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).
- postalCode
  string
  A postal code designating a region defined by the postal service.
- country
  string
  Country - a nation as commonly understood or generally accepted.
- use
  string
  The purpose of this address.
  Possible Values: home, work, temp, old, billing
- district
  string
  The name of the administrative area (county).
gender
string
Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
Possible Values: male, female, other, unknown
qualification
Array of object
The official certifications, training, and licenses that authorize or otherwise pertain to the provision of care by the practitioner. For example, a medical license issued by a medical board authorizing the practitioner to practice medicine within a certian locality.
- code
  required, object
  Coded representation of the qualification.
  coding
  Array of object
  A reference to a code defined by a terminology system.
  system
  string
  The identification of the code system that defines the meaning of the symbol in the code.
  code
  string
  A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
  text
  string
  A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

FHIR® is a registered trademark of Health Level Seven International (HL7) and is used with the permission of HL7. Use of this trademark does not constitute an endorsement of products/services by HL7®.