Get a list of practitioners

get

/Practitioner/

Retrieves a list of practitioners that meet supplied query parameters.

Authorization Types

This operation supports the following authorization types:

Request

Query Parameters
  • Minimum Value: 1

    The maximum number of results to return.

    Example: _count=15

  • Minimum Number of Items: 1

    The logical resource ID. This parameter is required if the identifier, family, name, or active parameter is not used.

    Example: _id=12345

  • The indication of whether this practitioner's record is in active use. This parameter is required if _id, identifier, family, or name is not used.

  • The start of the family name of the practitioner. This parameter is required if _id, identifier, name, or active is not used.

    Example: family=Smith

  • The start of the given name of the practitioner.

    Searching by the given name requires the family parameter.

    Example: given=Sally

  • The practitioner identifier. This parameter is required if the _id, family, name, or active parameter is not used.

    The value of the identifier parameter must include both a system and a code.

    Example: identifier=http://hl7.org/fhir/sid/us-npi|4326587548

  • Minimum Length: 2

    The start of the given name or the family name of the practitioner. This parameter is required if _id, identifier, family,, or active is not used.

    Example: name=Riley

Header Parameters
Back to Top

Response

Supported Media Types

200 Response

OK

Headers
Body
Example Response (application/fhir+json)
{
    "resourceType":"Bundle",
    "id":"7ec264d2-c7c7-49b2-8478-22351c82db73",
    "type":"searchset",
    "link":[
        {
            "relation":"self",
            "url":"https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Practitioner?_id=109413936"
        }
    ],
    "entry":[
        {
            "fullUrl":"https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Practitioner/109413936",
            "resource":{
                "resourceType":"Practitioner",
                "id":"109413936",
                "meta":{
                    "versionId":"0",
                    "lastUpdated":"2019-03-07T20:40:34.000Z"
                },
                "text":{
                    "status":"generated",
                    "div":"<div xmlns='http://www.w3.org/1999/xhtml'><p><b>Practitioner</b></p><p><b>Name</b>: Lombardi, Falco Shine</p><p><b>Identifiers</b>: DOCUPIN: F88788, DOCDEA: 887887887, SPI: 16611661, NPI: 6656656, PRSNLPRIMID: 12332122</p><p><b>Gender</b>: Male</p><p><b>Status</b>: Active</p></div>"
                },
                "extension":[
                    {
                        "valueBoolean":true,
                        "url":"https://fhir-ehr.cerner.com/r4/StructureDefinition/is-physician"
                    }
                ],
                "identifier":[
                    {
                        "use":"usual",
                        "type":{
                            "coding":[
                                {
                                    "system":"http://terminology.hl7.org/CodeSystem/v2-0203",
                                    "code":"PRN",
                                    "display":"Provider number"
                                }
                            ],
                            "text":"DOCUPIN"
                        },
                        "_system":{
                            "extension":[
                                {
                                    "url":"http://hl7.org/fhir/StructureDefinition/data-absent-reason",
                                    "valueCode":"unknown"
                                }
                            ]
                        },
                        "value":"F88788",
                        "period":{
                            "start":"2019-03-07T20:40:35.000Z"
                        }
                    },
                    {
                        "use":"usual",
                        "type":{
                            "coding":[
                                {
                                    "system":"http://terminology.hl7.org/CodeSystem/v2-0203",
                                    "code":"DEA",
                                    "display":"Drug Enforcement Administration registration number"
                                }
                            ],
                            "text":"DOCDEA"
                        },
                        "system":"urn:oid:2.16.840.1.113883.4.814",
                        "value":"887887887",
                        "period":{
                            "start":"2019-03-07T20:40:35.000Z"
                        }
                    },
                    {
                        "use":"usual",
                        "type":{
                            "coding":[
                                {
                                    "system":"http://terminology.hl7.org/CodeSystem/v2-0203",
                                    "code":"PRN",
                                    "display":"Provider number"
                                }
                            ],
                            "text":"SureScripts Prescriber Index"
                        },
                        "system":"urn:oid:2.16.840.1.113883.3.2054",
                        "value":"16611661",
                        "period":{
                            "start":"2019-04-12T18:24:23.000Z"
                        }
                    },
                    {
                        "use":"usual",
                        "type":{
                            "coding":[
                                {
                                    "system":"http://terminology.hl7.org/CodeSystem/v2-0203",
                                    "code":"NPI",
                                    "display":"National provider identifier"
                                }
                            ],
                            "text":"National Provider Identifier"
                        },
                        "system":"http://hl7.org/fhir/sid/us-npi",
                        "value":"6656656",
                        "period":{
                            "start":"2019-03-07T20:40:35.000Z"
                        }
                    },
                    {
                        "use":"usual",
                        "type":{
                            "text":"Personnel Primary Identifier"
                        },
                        "system":"urn:oid:1.2.243.58",
                        "value":"12332122",
                        "period":{
                            "start":"2019-04-12T18:24:23.000Z"
                        }
                    }
                ],
                "active":true,
                "name":[
                    {
                        "use":"usual",
                        "text":"Lombardi, Falco Shine",
                        "family":"Lombardi",
                        "given":[
                            "Falco",
                            "Shine"
                        ],
                        "prefix":[
                            "Dr."
                        ],
                        "suffix":[
                            "M.D."
                        ],
                        "period":{
                            "start":"2019-03-07T20:40:35.000Z"
                        }
                    }
                ],
                "telecom":[
                    {
                        "system":"phone",
                        "value":"7861231234",
                        "use":"work"
                    },
                    {
                        "system":"email",
                        "value":"falco.lombardi@sfox.com",
                        "use":"work"
                    }
                ],
                "address":[
                    {
                        "use":"work",
                        "text":"111 Corneria Dr.\\nTallahassee, FL 32304\\nUSA",
                        "line":[
                            "111 Corneria Dr."
                        ],
                        "city":"Tallahassee",
                        "district":"Leon",
                        "state":"FL",
                        "postalCode":"32304",
                        "country":"USA"
                    }
                ],
                "gender":"male",
                "qualification":[
                    {
                        "code":{
                            "coding":[
                                {
                                    "system":"https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/29600",
                                    "code":"677091",
                                    "display":"MD",
                                    "userSelected":true
                                }
                            ],
                            "text":"MD"
                        },
                        "period":{
                            "start":"2014-07-09T06:00:00.000Z"
                        }
                    },
                    {
                        "code":{
                            "coding":[
                                {
                                    "system":"https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/29600",
                                    "code":"677079",
                                    "display":"PhD",
                                    "userSelected":true
                                }
                            ],
                            "text":"PhD"
                        },
                        "period":{
                            "start":"2014-07-09T06:00:00.000Z"
                        }
                    }
                ]
            }
        }
    ]
}

Default Response

An OperationOutcome describing any error that occurred.
Headers
  • For Update or Patch versioning controls. Related to If-Match. When a resource performs an operation that creates or updates a record, an Etag value is returned as a header. This same value should be included in request headers as an If-Match for any subsequent update to that record.
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the X-Request-Id, if present.
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the opc-Request-Id, if present.
Body ()
Root Schema : schema
Type: object
Show Source
Nested Schema : issue
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : details
Type: object
Show Source
Nested Schema : location
Type: array
Show Source
Nested Schema : coding
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top