Practitioner – FHIR API

GET /Practitioner

This endpoint returns a response of Bundle of the Practitioner entity.

Request

Query Parameters
  • _id (optional) – string
  • active (optional) – string
  • name-use (optional) – string
  • name-text (optional) – string
  • resourceType (optional) – string
  • communication-text (optional) – string

Response

200 Response

Success

Array of objects – Practitioner

GET /Practitioner/{id}

This endpoint returns a response of a single entity of the Practitioner when supplied an ID.

Request

Query Parameters
  • _id (optional) – string
  • active (optional) – string
  • name-use (optional) – string
  • name-text (optional) – string
  • resourceType (optional) – string
  • communication-text (optional) – string

200 Response

Success

Type: object – Practitioner
  • active – string
  • communication – object
  • id – string
  • meta – object
  • name – object
  • qualification – object
  • resource – object
  • resourceType – string

GET /Practitioner/_history

This endpoint returns a response of Bundle a history of updates for the Practitioner entity.

Request

Query Parameters
  • _id (optional) – string
  • _count (optional) – string
  • _since (optional) – string
  • active (optional) – string
  • communication-text (optional) – string
  • name-text (optional) – string
  • name-use (optional) – string

Response

200 Response

Success

Array of objects – Practitioner History
  • active – string
  • communication – object
  • entry- object
  • id – string
  • link – object
  • meta – object
  • name – object
  • qualification – object
  • resource – object
  • resourceType – string

GET /Practitioner/{id}/_history

This endpoint returns a response of a history of updates for the Practitioner entity when supplied an ID.

Request

Query Parameters
  • _id (optional) – string
  • _count (optional) – string
  • _since (optional) – string
  • active (optional) – string
  • communication-text (optional) – string
  • name-text (optional) – string
  • name-use (optional) – string

Response

200 Response

Success

object – Practitioner History
  • communication – object
  • fullUrl – string
  • id – string
  • meta – object
  • name – string
  • qualification – object
  • resource – object
  • resourceType – string
  • type – string