HAhalaxy
PractitionerRole

List Practitioner Roles

Changed on

Retrieves a collection of practitioner clinic IDs within a practice group

get/main/PractitionerRole

Request

  • Base URL
    https://au-api.halaxy.com
  • URL
    https://au-api.halaxy.com/main/PractitionerRole
  • 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

practitionerstring

Practitioner that is able to provide the defined services for the organization

organizationstring

The identity of the organization the practitioner represents / acts on behalf of

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

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

providerNumberstring

Reference to the coverage for the invoice

_include'PractitionerRole:practitioner' | 'PractitionerRole:organization'

The _include parameter can be used to include related search results to reduce overall network delay of repeated retrievals of related resources.

Modifiers

  • _include:iterate = can be used to include related resources based on already included resources.

Response

PractitionerRole collection

containedFhirResourceInterface[]

Contained, inline Resources

idstring nullable

The practitioner's clinic ID - i.e. their identifier for a specific clinic location, 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/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 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/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)

    • warning

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