Practitioner

Top Previous Next

A person who is directly or indirectly involved in the provisioning of healthcare.

Response Description

Sample Response

{

"resourceType": "Practitioner",

"id": "GVTADAWS",

"meta": {

"lastUpdated": "2019-04-02T12:00:00-04:00",

"profile": [

"http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner"

]

"text": {

"status": "generated",

"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><table><tbody><tr><td>Code:</td><td>GVTADAWS</td></tr><tr><td>Name:</td><td>Aaron Dawson</td></tr></tbody></table></div>"

"identifier": [

{

"system": "https://pai.healthcare",

"value": "GVTADAWS"

}

"name": [

{

"text": "Aaron Dawson",

"family": "Dawson",

"given": [

"Aaron"

]

}

"telecom": [

{

"system": "email",

"value": "adawson@practice-alt.com"

}

]

}

Practitioner.id

The logical ID of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Cardinality	0..1
Type	string
Comment	The only time that a resource does not have an ID is when it is being submitted to the server using a create operation.

Practitioner.meta

Metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Cardinality	0..1
Type	Meta

Practitioner.text

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative.

Cardinality	0..1
Type	Narrative
Comment	Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Practitioner.identifier

An identifier that applies to this person in this role. This will be an NPI number when possible.

Cardinality	0..*
Type	Identifier
Comment	This is a business identifier, not a resource identifier

Practitioner.identifier.system

The namespace for the identifier value.

Cardinality	1..1
Type	uri

Practitioner.identifier.value

The value that is unique.

Cardinality	1..1
Type	string

Practitioner.identifier:NPI

A NPI identifier that applies to this person in this role.

Cardinality

0..1

Type

Identifier

Comment

</valueIdentifier>

Practitioner.name

The name(s) associated with the practitioner.

Cardinality	0..*
Type	HumanName
Requirements	The name(s) that a Practitioner is known by. Where there are multiple, the name that the practitioner is usually known as should be used in the display.

Practitioner.name.family

The practitioner's surname.

Cardinality	0..*
Type	string
Requirements	Family name (often called 'Surname')

Practitioner.telecom

A contact detail for the practitioner, e.g. a telephone number or an email address.

Cardinality	0..*
Type	ContactPoint
Comment	May need to have options for contacting the person urgently and to help with identification. These typically will have home numbers, or mobile numbers that are not role specific.

URL Syntax

Two HTTP methods are supported for searching: GET and POST. It is recommended to use HTTP POST.

Visit the FHIR Sandbox to try requests.

HTTP GET - searching

https://sandbox.pai.healthcare/preview/fhir/Practitioner?{query string}

HTTP GET - return single record

https://sandbox.pai.healthcare/preview/fhir/Practitioner/{resource id}

HTTP POST - searching

https://sandbox.pai.healthcare/preview/fhir/Practitioner/_search

•Set the Content-Type header to application/x-www-urlencoded

•The body of the request is a similar query string used in the GET type of request detailed above.

Error Handling

If no records are returned or invalid search parameters are provided, then an HTTP 400 Bad Request is returned.

The body of the response will be an OperationOutcome.

Supported Search Parameters

_id

Corresponds to

Practitioner.id

exact

Example

https://sandbox.pai.healthcare/preview/fhir/Practitioner/117

https://sandbox.pai.healthcare/preview/fhir/Practitioner?_id=117

Returns the information on Practitioner 117.

patient

exact

Example

https://sandbox.pai.healthcare/preview/fhir/Practitioner?patient=Patient/DEV-DEV-11913

Returns all practitioners for patient 11913.