---
title: "List Practitioners"
method: GET
path: "/main/Practitioner"
tags: ["Practitioner"]
---

# List Practitioners

`GET /main/Practitioner`

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

## Query parameters

- `page` integer
- `_count` integer
- `pagination` boolean
- `_summary[]` string[]
- `_id` string
- `name` string
- `family` string
- `given` string
- `email` string
- `active` boolean
- `_profile` 'StructureDefinition/hx-practitioner' | 'StructureDefinition/hx-external-practitioner'
- `_lastUpdated` string, datetime
- `_sort` 'name' | '-name'

## Response `200`

Practitioner collection

- Practitioner[]
  - `identifier` FhirIdentifier[] — Identifies this practitioner across multiple systems
    - `use` 'usual' | 'official' | 'temp' | 'secondary' | 'old' | 'null', nullable
    - `type` FhirCodeableConcept
      - `coding` FhirCoding[] — defined by a terminology system
        - `system` string, uri, nullable — Identity of the terminology system
        - `code` string, nullable — Symbol in syntax defined by the system
        - `display` string, nullable — Representation defined by the system
        - `userSelected` boolean, nullable — If this coding was chosen directly by the user
        - `id` string, nullable — ID of the FHIR element (optional)
      - `text` string, nullable — Plain text representation of the concept
      - `id` string, nullable — ID of the FHIR element (optional)
    - `system` string, nullable — The namespace for the identifier value
    - `value` string, nullable — The unique identifier
    - `period` FhirPeriodDateTime
      - `start` string, date-time, nullable
      - `end` string, date-time, nullable
      - `id` string, nullable — ID of the FHIR element (optional)
    - `assigner` FhirReference
      - `reference` string, required — The URL (relative or absolute) to the resource being referenced
      - `type` 'Organization' | 'Patient' | 'Practitioner' | 'PractitionerRole' | 'Appointment' | 'Coverage' | 'Invoice' | 'Communication' | 'Group' | 'DocumentReference' | 'InvoiceLine' | 'PaymentTransaction' | 'Referral' | 'ReferralDefinition' | 'Schedule' | 'Slot' | 'HealthcareService' | 'AllergyIntolerance' | 'Condition' | 'Immunization' | 'Subscription' | 'SubscriptionTopic' | 'ChargeItemDefinition' | 'ServiceRequest' | 'Medication' | 'MedicationRequest' | 'Questionnaire' | 'QuestionnaireResponse' | 'Observation' | 'Binary' | 'Bundle' | 'OperationOutcome' | 'Parameters' | 'List' | 'null', nullable — The type of resource being referenced
      - `id` string, nullable — ID of the FHIR element (optional)
    - `id` string, nullable — ID of the FHIR element (optional)
  - `active` boolean, 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
  - `name` FhirHumanName[] — The name/s associated with the practitioner
    - `use` 'usual' | 'official' | 'null', nullable — The type of name - 'official' for legal names, 'usual' for single name
    - `text` string, nullable — The full name in text format
    - `family` string, nullable — Family name (often called 'surname')
    - `given` string[] — Given names - includes middle name/s
    - `prefix` string[] — Title before the patient's name
    - `id` string, nullable — ID of the FHIR element (optional)
  - `telecom` FhirContactPoint[] — A unique email address linked to the practitioner
    - `system` 'phone' | 'fax' | 'email' | 'sms' | 'null', nullable — Type of contact detail
    - `value` string, nullable — The actual phone number or email address
    - `use` 'home' | 'work' | 'mobile' | 'null', nullable — Purpose of the contact detail
    - `id` string, nullable — ID of the FHIR element (optional)
  - `address` FhirAddress[] — Address(es) of the practitioner that are not role specific
    - `use` 'home' | 'work' | 'billing' | 'mailing' | 'null', nullable — The purpose of this address
    - `type` 'both' | 'null', nullable — Distinguishes between a physical address and mailing address
    - `text` string, nullable — The full address in text format
    - `line` string[] — Contains the street name, number, direction and P.O. Box in the order in which lines should appear on an address label
    - `city` string, nullable — Name of city or town
    - `state` string, nullable — State, province, or regions in ISO 3166-2 code (e.g., VIC, AUK, ON)
    - `postalCode` string, nullable — Postal or zip code of address
    - `country` string, nullable — Country of the address in ISO 3166-1 alpha-2 code (e.g., AU, NZ, CA)
    - `id` string, nullable — ID of the FHIR element (optional)
  - `gender` 'male' | 'female' | 'other' | 'unknown' | 'null', nullable — male | female | other | unknown
  - `birthDate` string, nullable — The date on which the practitioner was born
  - `qualification` FhirQualification[] — The practitioner's profession in their profile
    - `identifier` FhirIdentifier[], nullable — An identifier for this qualification
      - `use` 'usual' | 'official' | 'temp' | 'secondary' | 'old' | 'null', nullable
      - `type` FhirCodeableConcept
        - `coding` FhirCoding[] — defined by a terminology system
          - `system` string, uri, nullable — Identity of the terminology system
          - `code` string, nullable — Symbol in syntax defined by the system
          - `display` string, nullable — Representation defined by the system
          - `userSelected` boolean, nullable — If this coding was chosen directly by the user
          - `id` string, nullable — ID of the FHIR element (optional)
        - `text` string, nullable — Plain text representation of the concept
        - `id` string, nullable — ID of the FHIR element (optional)
      - `system` string, nullable — The namespace for the identifier value
      - `value` string, nullable — The unique identifier
      - `period` FhirPeriodDateTime
        - `start` string, date-time, nullable
        - `end` string, date-time, nullable
        - `id` string, nullable — ID of the FHIR element (optional)
      - `assigner` FhirReference
        - `reference` string, required — The URL (relative or absolute) to the resource being referenced
        - `type` 'Organization' | 'Patient' | 'Practitioner' | 'PractitionerRole' | 'Appointment' | 'Coverage' | 'Invoice' | 'Communication' | 'Group' | 'DocumentReference' | 'InvoiceLine' | 'PaymentTransaction' | 'Referral' | 'ReferralDefinition' | 'Schedule' | 'Slot' | 'HealthcareService' | 'AllergyIntolerance' | 'Condition' | 'Immunization' | 'Subscription' | 'SubscriptionTopic' | 'ChargeItemDefinition' | 'ServiceRequest' | 'Medication' | 'MedicationRequest' | 'Questionnaire' | 'QuestionnaireResponse' | 'Observation' | 'Binary' | 'Bundle' | 'OperationOutcome' | 'Parameters' | 'List' | 'null', nullable — The type of resource being referenced
        - `id` string, nullable — ID of the FHIR element (optional)
      - `id` string, nullable — ID of the FHIR element (optional)
    - `code` FhirCodeableConcept
      - `coding` FhirCoding[] — defined by a terminology system
        - `system` string, uri, nullable — Identity of the terminology system
        - `code` string, nullable — Symbol in syntax defined by the system
        - `display` string, nullable — Representation defined by the system
        - `userSelected` boolean, nullable — If this coding was chosen directly by the user
        - `id` string, nullable — ID of the FHIR element (optional)
      - `text` string, nullable — Plain text representation of the concept
      - `id` string, nullable — ID of the FHIR element (optional)
    - `period` FhirPeriodDateTime
      - `start` string, date-time, nullable
      - `end` string, date-time, nullable
      - `id` string, nullable — ID of the FHIR element (optional)
    - `issuer` FhirReference
      - `reference` string, required — The URL (relative or absolute) to the resource being referenced
      - `type` 'Organization' | 'Patient' | 'Practitioner' | 'PractitionerRole' | 'Appointment' | 'Coverage' | 'Invoice' | 'Communication' | 'Group' | 'DocumentReference' | 'InvoiceLine' | 'PaymentTransaction' | 'Referral' | 'ReferralDefinition' | 'Schedule' | 'Slot' | 'HealthcareService' | 'AllergyIntolerance' | 'Condition' | 'Immunization' | 'Subscription' | 'SubscriptionTopic' | 'ChargeItemDefinition' | 'ServiceRequest' | 'Medication' | 'MedicationRequest' | 'Questionnaire' | 'QuestionnaireResponse' | 'Observation' | 'Binary' | 'Bundle' | 'OperationOutcome' | 'Parameters' | 'List' | 'null', nullable — The type of resource being referenced
      - `id` string, nullable — ID of the FHIR element (optional)
    - `id` string, nullable — ID of the FHIR element (optional)
  - `text` FhirNarrative
    - `status` 'generated' | 'extensions' | 'additional' | 'empty' — Describes how the narrative was generated
    - `div` string — Limited xhtml content
    - `id` string, nullable — ID of the FHIR element (optional)
  - `contained` AbstractFhirResource[] — Contained, inline Resources
    - `id` string, nullable — Logical id of this artifact
    - `meta` FhirResourceMeta
      - `lastUpdated` string, date-time, nullable — When the resource version last changed
      - `profile` string[] — Profiles this resource claims to conform to
    - `resourceType` string, nullable — Resource Type
  - `id` string, nullable — The practitioner identifier within the practice group, wherein the ID includes the appropriate prefix for internal practitioner (PR-) or professional contact (EP-)
  - `meta` FhirResourceMeta
    - `lastUpdated` string, date-time, nullable — When the resource version last changed
    - `profile` string[] — Profiles this resource claims to conform to
  - `resourceType` string, nullable — Resource Type

## Other responses

- `403` — Forbidden

---

[API](https://skmtc.dev/halaxy/apis/halaxy-api.md) · [All operations](https://skmtc.dev/halaxy/apis/halaxy-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/halaxy/halaxy-api/revisions/d72139daaa89/schema)