Practitioner search-type

Request Fields and Example
identifier
[string]

One or more external identifiers for the practitioner

given
[string]

A portion of the given name of the practitioner

family
[string]

A portion of the family name of the practitioner

name
[string]

A portion of the name of the practitioner

post/Practitioner/_search
Response Fields and Example

Response to a Practitioner search operation containing only practitioner resources

resourceType
required, string

Identifies the type of the resource

Value: Bundle
type
required, string

Identifies this bundle as a response to a search

Value: searchset
total
required, number

The total number of matches

entry
[Practitioner, Other]

A resource matching the search criteria or related to a matching resource

Any of:
resource
required, object

Information about a healthcare practitioner

resourceType
required, string

Identifies the type of the resource

Value: Practitioner
identifier
required, [NPI, Other]

An identifier that applies to this person in this role.

Any of:
system
required, string

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Value: http://hl7.org/fhir/sid/us-npi
extension
[Boolean, String, CodeableConcept, Coding, HumanName, Reference]

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

One of:
url
required, string

Source of the definition for the extension code - a logical name or a URL.

valueBoolean
boolean

A single value for the extension.

use
string

The purpose of this identifier.

Possible Values: usual, official, temp, secondary, old (If known)
value
string

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

name
required, [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
[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
[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
[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
[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
[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
[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.

search
required, object

Information about the search process that lead to the creation of this entry.

mode
required, string

Identifies the Practitioner as matching the search parameters

Value: match