HAhalaxy
Practitioner

List Practitioners

Changed on

Retrieves a collection of practitioner and administrator records within a practice group

get/main/Practitioner

Request

  • Base URL
    https://au-api.halaxy.com
  • URL
    https://au-api.halaxy.com/main/Practitioner
  • Auth
    OAuth 2
    Client credentials
    Token URL: /main/oauth/token

Query parameters

pageinteger

The collection page number

_countinteger

The number of items per page

paginationboolean

Enable or disable pagination

_summary[]string[]
_idstring

The logical id of the resource

namestring

The family, given or preferred name of the resource

familystring

The family portion of the name

givenstring

The given portion of the name

emailstring

A value in an email contact

activeboolean

Whether the practitioner is active

_profile'StructureDefinition/hx-practitioner' | 'StructureDefinition/hx-external-practitioner'

The _profile parameter can be used to select different types of a resources.

_lastUpdatedstring datetime

Practitioner _lastUpdated

_sort'name' | '-name'

Each item in the comma-separated list is a search parameter, optionally with a ' - ' prefix. The prefix indicates decreasing order; in its absence, the parameter is applied in increasing order.

Response

Practitioner collection

activeboolean nullable

Indicates if the user's record is in active use - changes to false if the user's profile is deactivated from the practice group

gender'male' | 'female' | 'other' | 'unknown' | 'null' nullable

male | female | other | unknown

birthDatestring nullable

The date on which the practitioner was born

containedFhirResourceInterface[]

Contained, inline Resources

idstring nullable

The practitioner identifier within the practice group, wherein the ID includes the appropriate prefix for internal practitioner (PR-) or professional contact (EP-)

resourceTypestring nullable

Resource Type

Changes

  • 1a14a579daecRevision changes
    • warning

      removed the optional property ////// from the response with the status (media type: application/fhir+json)

    • warning

      removed the optional property ////// from the response with the status (media type: application/fhir+json)

    • warning

      removed the optional property ////// from the response with the status (media type: application/fhir+json)

    • warning

      removed the optional property /// from the response with the status (media type: application/json)

    • warning

      removed the optional property /// from the response with the status (media type: application/json)

    • warning

      removed the optional property /// from the response with the status (media type: application/json)

    • warning

      added the new ValueSet enum value to the /////////// response property for the response status (media type: application/fhir+json)

    • warning

      added the new ValueSet enum value to the ///////////// response property for the response status (media type: application/fhir+json)

    • warning

      added the new ValueSet enum value to the /////////// response property for the response status (media type: application/fhir+json)

    • warning

      added the new ValueSet enum value to the //////// response property for the response status (media type: application/json)

    • warning

      added the new ValueSet enum value to the ////////// response property for the response status (media type: application/json)

    • warning

      added the new ValueSet enum value to the //////// response property for the response status (media type: application/json)

    • warning

      added the new ValueSetConcept enum value to the /////////// response property for the response status (media type: application/fhir+json)

    • warning

      added the new ValueSetConcept enum value to the ///////////// response property for the response status (media type: application/fhir+json)

    • warning

      added the new ValueSetConcept enum value to the /////////// response property for the response status (media type: application/fhir+json)

    • warning

      added the new ValueSetConcept enum value to the //////// response property for the response status (media type: application/json)

    • warning

      added the new ValueSetConcept enum value to the ////////// response property for the response status (media type: application/json)

    • warning

      added the new ValueSetConcept enum value to the //////// response property for the response status (media type: application/json)