Halaxy Practitioner Role API

openapi: 3.2.0
info:
  title: Halaxy Practitioner Role API
  description: A FHIR API for Halaxy based on R4 of the FHIR specification
  termsOfService: https://www.halaxy.com/article/terms/practitioner
  contact:
    name: Halaxy Developers
    url: https://www.halaxy.com
    email: community@halaxy.com
  version: '1.104'
servers:
- url: https://au-api.halaxy.com
  description: Production AU
- url: https://eu-api.halaxy.com
  description: Production EU
security:
- oauth: []
tags:
- name: Practitioner Role
paths:
  /main/PractitionerRole:
    get:
      operationId: findPractitionerRole
      tags:
      - Practitioner Role
      responses:
        '200':
          description: PractitionerRole collection
          content:
            application/fhir+json:
              schema:
                type: object
                readOnly: true
                properties:
                  resourceType:
                    type: string
                    readOnly: true
                    enum:
                    - Bundle
                    default: Bundle
                  timestamp:
                    type: string
                    readOnly: true
                    format: date-time
                  type:
                    type: string
                    readOnly: true
                    enum:
                    - searchset
                    default: searchset
                  entry:
                    type: array
                    items:
                      type: object
                      properties:
                        fullUrl:
                          type: string
                          format: iri-reference
                        resource:
                          type: array
                          items:
                            $ref: '#/components/schemas/PractitionerRole.jsonfhir'
                        search:
                          type: object
                          properties:
                            mode:
                              type: string
                              enum:
                              - match
                              - include
                              - outcome
                  total:
                    type: integer
                    readOnly: true
                    minimum: 0
                  link:
                    type: array
                    readOnly: true
                    items:
                      type: object
                      properties:
                        relation:
                          type: string
                          readOnly: true
                          enum:
                          - self
                          - first
                          - last
                          - prev
                          - next
                        url:
                          type: string
                          readOnly: true
                          format: iri-reference
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PractitionerRole'
        '403':
          description: Forbidden
      summary: List Practitioner Roles
      description: Retrieves a collection of practitioner clinic IDs within a practice group
      parameters:
      - name: page
        in: query
        description: The collection page number
        required: false
        deprecated: false
        schema:
          type: integer
          default: 1
        style: form
        explode: false
      - name: _count
        in: query
        description: The number of items per page
        required: false
        deprecated: false
        schema:
          type: integer
          default: 30
          minimum: 0
        style: form
        explode: false
      - name: pagination
        in: query
        description: Enable or disable pagination
        required: false
        deprecated: false
        schema:
          type: boolean
        style: form
        explode: false
      - name: _summary[]
        in: query
        description: ''
        required: false
        deprecated: false
        schema:
          type: array
          items:
            type: string
            enum:
            - 'false'
            - data
            - count
            - Default
            - text
        style: form
        explode: true
      - name: _id
        in: query
        description: The logical id of the resource
        required: false
        deprecated: false
        schema:
          type: string
        style: form
        explode: false
      - name: practitioner
        in: query
        description: Practitioner that is able to provide the defined services for the organization
        required: false
        deprecated: false
        schema:
          type: string
        style: form
        explode: false
      - name: organization
        in: query
        description: The identity of the organization the practitioner represents / acts on behalf of
        required: false
        deprecated: false
        schema:
          type: string
        style: form
        explode: false
      - name: _profile
        in: query
        description: The `_profile` parameter can be used to select different types of a resources.
        required: false
        deprecated: false
        schema:
          type: string
          enum:
          - StructureDefinition/hx-practitioner-role
          - StructureDefinition/hx-external-practitioner-role
        style: form
        explode: false
      - name: providerNumber
        in: query
        description: Reference to the coverage for the invoice
        required: false
        deprecated: false
        schema:
          type: string
        style: form
        explode: false
      - name: _include
        in: query
        description: '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.'
        required: false
        deprecated: false
        schema:
          type: string
          enum:
          - PractitionerRole:practitioner
          - PractitionerRole:organization
        style: form
        explode: false
      deprecated: false
    post:
      operationId: createPractitionerRole
      tags:
      - Practitioner Role
      responses:
        '201':
          description: PractitionerRole resource created
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/PractitionerRole.jsonfhir'
            application/json:
              schema:
                $ref: '#/components/schemas/PractitionerRole'
          links: {}
        '400':
          description: Invalid input
        '403':
          description: Forbidden
        '422':
          description: Unprocessable entity
      summary: Create PractitionerRole (Professional Contact)
      description: Creates a new professional contact identifier linked to their practice
      parameters: []
      requestBody:
        description: The new PractitionerRole resource
        content:
          application/fhir+json:
            schema:
              $ref: '#/components/schemas/PractitionerRole.jsonfhir'
          application/json:
            schema:
              $ref: '#/components/schemas/PractitionerRole'
        required: true
      deprecated: false
  /main/PractitionerRole/{id}:
    get:
      operationId: getPractitionerRole
      tags:
      - Practitioner Role
      responses:
        '200':
          description: PractitionerRole resource
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/PractitionerRole.jsonfhir'
            application/json:
              schema:
                $ref: '#/components/schemas/PractitionerRole'
        '403':
          description: Forbidden
        '404':
          description: Resource not found
      summary: Get Practitioner Roles
      description: Retrieves an individual practitioner clinic ID
      parameters:
      - name: id
        in: path
        description: PractitionerRole identifier
        required: true
        deprecated: false
        schema:
          type: string
        style: simple
        explode: false
      deprecated: false
components:
  schemas:
    FhirNarrative:
      type: object
      description: ''
      deprecated: false
      properties:
        status:
          readOnly: true
          description: Describes how the narrative was generated
          type: string
          enum:
          - generated
          - extensions
          - additional
          - empty
        div:
          readOnly: true
          description: Limited xhtml content
          type: string
        id:
          readOnly: true
          description: ID of the FHIR element (optional)
          type:
          - string
          - 'null'
    PractitionerRole:
      type: object
      description: A PractitionerRole. See https://www.hl7.org/fhir/R4/practitionerrole.html
      deprecated: false
      properties:
        identifier:
          description: Business Identifiers that are specific to a role/location
          type: array
          items:
            $ref: '#/components/schemas/FhirIdentifier'
        practitioner:
          description: The URL reference to the practitioner's identifier within the practice group, wherein the ID includes the appropriate prefix for internal practitioner (PR-) or professional contact (EP-)
          anyOf:
          - $ref: '#/components/schemas/FhirReference'
          - type: 'null'
        organization:
          description: The URL reference to the clinic location or external practice, wherein the ID includes the appropriate prefix for internal clinic (CL-) or external practice (SP-)
          anyOf:
          - $ref: '#/components/schemas/FhirReference'
          - type: 'null'
        code:
          maxItems: 1
          description: Roles which this practitioner may perform
          type: array
          items:
            $ref: '#/components/schemas/FhirCodeableConcept'
        healthcareService:
          readOnly: true
          description: The list of healthcare services that this worker provides for this role's Organization/Location(s)
          type: array
          items:
            $ref: '#/components/schemas/FhirReference'
        telecom:
          description: The practitioner's contact number/s or email address/es at the specified location
          type: array
          items:
            $ref: '#/components/schemas/FhirContactPoint'
        text:
          readOnly: true
          description: Text summary of the resource, for human interpretation
          anyOf:
          - $ref: '#/components/schemas/FhirNarrative'
          - type: 'null'
        contained:
          readOnly: true
          description: Contained, inline Resources
          type: array
          items:
            $ref: '#/components/schemas/FhirResourceInterface'
        id:
          readOnly: true
          description: 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-)
          type:
          - string
          - 'null'
        meta:
          description: Metadata about the resource
          anyOf:
          - $ref: '#/components/schemas/FhirResourceMeta'
          - type: 'null'
        resourceType:
          description: Resource Type
          type:
          - string
          - 'null'
    FhirContactPoint.jsonfhir:
      type: object
      description: ''
      deprecated: false
      properties:
        system:
          description: Type of contact detail
          type:
          - string
          - 'null'
          enum:
          - phone
          - fax
          - email
          - sms
          - null
        value:
          description: The actual phone number or email address
          type:
          - string
          - 'null'
        use:
          description: Purpose of the contact detail
          type:
          - string
          - 'null'
          enum:
          - home
          - work
          - mobile
          - null
        id:
          readOnly: true
          description: ID of the FHIR element (optional)
          type:
          - string
          - 'null'
    PractitionerRole.jsonfhir:
      type: object
      description: A PractitionerRole. See https://www.hl7.org/fhir/R4/practitionerrole.html
      deprecated: false
      properties:
        identifier:
          description: Business Identifiers that are specific to a role/location
          type: array
          items:
            $ref: '#/components/schemas/FhirIdentifier.jsonfhir'
        practitioner:
          description: The URL reference to the practitioner's identifier within the practice group, wherein the ID includes the appropriate prefix for internal practitioner (PR-) or professional contact (EP-)
          anyOf:
          - $ref: '#/components/schemas/FhirReference.jsonfhir'
          - type: 'null'
        organization:
          description: The URL reference to the clinic location or external practice, wherein the ID includes the appropriate prefix for internal clinic (CL-) or external practice (SP-)
          anyOf:
          - $ref: '#/components/schemas/FhirReference.jsonfhir'
          - type: 'null'
        code:
          maxItems: 1
          description: Roles which this practitioner may perform
          type: array
          items:
            $ref: '#/components/schemas/FhirCodeableConcept.jsonfhir'
        healthcareService:
          readOnly: true
          description: The list of healthcare services that this worker provides for this role's Organization/Location(s)
          type: array
          items:
            $ref: '#/components/schemas/FhirReference.jsonfhir'
        telecom:
          description: The practitioner's contact number/s or email address/es at the specified location
          type: array
          items:
            $ref: '#/components/schemas/FhirContactPoint.jsonfhir'
        text:
          readOnly: true
          description: Text summary of the resource, for human interpretation
          anyOf:
          - $ref: '#/components/schemas/FhirNarrative.jsonfhir'
          - type: 'null'
        contained:
          readOnly: true
          description: Contained, inline Resources
          type: array
          items:
            $ref: '#/components/schemas/FhirResourceInterface.jsonfhir'
        id:
          readOnly: true
          description: 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-)
          type:
          - string
          - 'null'
        meta:
          description: Metadata about the resource
          anyOf:
          - $ref: '#/components/schemas/FhirResourceMeta.jsonfhir'
          - type: 'null'
        resourceType:
          description: Resource Type
          type:
          - string
          - 'null'
    FhirCoding.jsonfhir:
      type: object
      description: ''
      deprecated: false
      properties:
        system:
          format: uri
          description: Identity of the terminology system
          externalDocs:
            url: https://schema.org/url
          type:
          - string
          - 'null'
        code:
          description: Symbol in syntax defined by the system
          type:
          - string
          - 'null'
        display:
          description: Representation defined by the system
          type:
          - string
          - 'null'
        userSelected:
          readOnly: true
          description: If this coding was chosen directly by the user
          type:
          - boolean
          - 'null'
        id:
          readOnly: true
          description: ID of the FHIR element (optional)
          type:
          - string
          - 'null'
    FhirReference.jsonfhir:
      type: object
      description: ''
      deprecated: false
      required:
      - reference
      properties:
        reference:
          description: The URL (relative or absolute) to the resource being referenced
          type: string
        type:
          description: The type of resource being referenced
          type:
          - string
          - 'null'
          enum:
          - 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
          - ValueSet
          - ValueSetConcept
          - Observation
          - Binary
          - Bundle
          - OperationOutcome
          - Parameters
          - List
          - null
        id:
          readOnly: true
          description: ID of the FHIR element (optional)
          type:
          - string
          - 'null'
    FhirPeriodDateTime:
      type: object
      description: ''
      deprecated: false
      properties:
        start:
          externalDocs:
            url: https://schema.org/DateTime
          type:
          - string
          - 'null'
          format: date-time
        end:
          externalDocs:
            url: https://schema.org/DateTime
          type:
          - string
          - 'null'
          format: date-time
        id:
          readOnly: true
          description: ID of the FHIR element (optional)
          type:
          - string
          - 'null'
    FhirCodeableConcept:
      type: object
      description: ''
      deprecated: false
      properties:
        coding:
          description: defined by a terminology system
          type: array
          items:
            $ref: '#/components/schemas/FhirCoding'
        text:
          description: Plain text representation of the concept
          type:
          - string
          - 'null'
        id:
          readOnly: true
          description: ID of the FHIR element (optional)
          type:
          - string
          - 'null'
    FhirIdentifier:
      type: object
      description: ''
      deprecated: false
      properties:
        use:
          type:
          - string
          - 'null'
          enum:
          - usual
          - official
          - temp
          - secondary
          - old
          - null
        type:
          description: Description of identifier
          anyOf:
          - $ref: '#/components/schemas/FhirCodeableConcept'
          - type: 'null'
        system:
          description: The namespace for the identifier value
          type:
          - string
          - 'null'
        value:
          description: The unique identifier
          type:
          - string
          - 'null'
        period:
          description: The time period when identifier is/was valid for use
          anyOf:
          - $ref: '#/components/schemas/FhirPeriodDateTime'
          - type: 'null'
        assigner:
          description: Organization that issued id (may be just text)
          anyOf:
          - $ref: '#/components/schemas/FhirReference'
          - type: 'null'
        id:
          readOnly: true
          description: ID of the FHIR element (optional)
          type:
          - string
          - 'null'
    FhirResourceInterface:
      type: object
      description: ''
      deprecated: false
    FhirNarrative.jsonfhir:
      type: object
      description: ''
      deprecated: false
      properties:
        status:
          readOnly: true
          description: Describes how the narrative was generated
          type: string
          enum:
          - generated
          - extensions
          - additional
          - empty
        div:
          readOnly: true
          description: Limited xhtml content
          type: string
        id:
          readOnly: true
          description: ID of the FHIR element (optional)
          type:
          - string
          - 'null'
    FhirCoding:
      type: object
      description: ''
      deprecated: false
      properties:
        system:
          format: uri
          description: Identity of the terminology system
          externalDocs:
            url: https://schema.org/url
          type:
          - string
          - 'null'
        code:
          description: Symbol in syntax defined by the system
          type:
          - string
          - 'null'
        display:
          description: Representation defined by the system
          type:
          - string
          - 'null'
        userSelected:
          readOnly: true
          description: If this coding was chosen directly by the user
          type:
          - boolean
          - 'null'
        id:
          readOnly: true
          description: ID of the FHIR element (optional)
          type:
          - string
          - 'null'
    FhirIdentifier.jsonfhir:
      type: object
      description: ''
      deprecated: false
      properties:
        use:
          type:
          - string
          - 'null'
          enum:
          - usual
          - official
          - temp
          - secondary
          - old
          - null
        type:
          description: Description of identifier
          anyOf:
          - $ref: '#/components/schemas/FhirCodeableConcept.jsonfhir'
          - type: 'null'
        system:
          description: The namespace for the identifier value
          type:
          - string
          - 'null'
        value:
          description: The unique identifier
          type:
          - string
          - 'null'
        period:
          description: The time period when identifier is/was valid for use
          anyOf:
          - $ref: '#/components/schemas/FhirPeriodDateTime.jsonfhir'
          - type: 'null'
        assigner:
          description: Organization that issued id (may be just text)
          anyOf:
          - $ref: '#/components/schemas/FhirReference.jsonfhir'
          - type: 'null'
        id:
          readOnly: true
          description: ID of the FHIR element (optional)
          type:
          - string
          - 'null'
    FhirReference:
      type: object
      description: ''
      deprecated: false
      required:
      - reference
      properties:
        reference:
          description: The URL (relative or absolute) to the resource being referenced
          type: string
        type:
          description: The type of resource being referenced
          type:
          - string
          - 'null'
          enum:
          - 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
          - ValueSet
          - ValueSetConcept
          - Observation
          - Binary
          - Bundle
          - OperationOutcome
          - Parameters
          - List
          - null
        id:
          readOnly: true
          description: ID of the FHIR element (optional)
          type:
          - string
          - 'null'
    FhirContactPoint:
      type: object
      description: ''
      deprecated: false
      properties:
        system:
          description: Type of contact detail
          type:
          - string
          - 'null'
          enum:
          - phone
          - fax
          - email
          - sms
          - null
        value:
          description: The actual phone number or email address
          type:
          - string
          - 'null'
        use:
          description: Purpose of the contact detail
          type:
          - string
          - 'null'
          enum:
          - home
          - work
          - mobile
          - null
        id:
          readOnly: true
          description: ID of the FHIR element (optional)
          type:
          - string
          - 'null'
    FhirResourceMeta.jsonfhir:
      type: object
      description: ''
      deprecated: false
      properties:
        lastUpdated:
          readOnly: true
          description: When the resource version last changed
          type:
          - string
          - 'null'
          format: date-time
        profile:
          description: Profiles this resource claims to conform to
          type: array
          items:
            type: string
    FhirResourceInterface.jsonfhir:
      type: object
      description: ''
      deprecated: false
    FhirPeriodDateTime.jsonfhir:
      type: object
      description: ''
      deprecated: false
      properties:
        start:
          externalDocs:
            url: https://schema.org/DateTime
          type:
          - string
          - 'null'
          format: date-time
        end:
          externalDocs:
            url: https://schema.org/DateTime
          type:
          - string
          - 'null'
          format: date-time
        id:
          readOnly: true
          description: ID of the FHIR element (optional)
          type:
          - string
          - 'null'
    FhirResourceMeta:
      type: object
      description: ''
      deprecated: false
      properties:
        lastUpdated:
          readOnly: true
          description: When the resource version last changed
          type:
          - string
          - 'null'
          format: date-time
        profile:
          description: Profiles this resource claims to conform to
          type: array
          items:
            type: string
    FhirCodeableConcept.jsonfhir:
      type: object
      description: ''
      deprecated: false
      properties:
        coding:
          description: defined by a terminology system
          type: array
          items:
            $ref: '#/components/schemas/FhirCoding.jsonfhir'
        text:
          description: Plain text representation of the concept
          type:
          - string
          - 'null'
        id:
          readOnly: true
          description: ID of the FHIR element (optional)
          type:
          - string
          - 'null'
  securitySchemes:
    oauth:
      type: oauth2
      description: OAuth 2.0 client credentials Grant
      flows:
        clientCredentials:
          tokenUrl: /main/oauth/token
          scopes: {}
x-provenance:
  method: searched
  source: https://developers.halaxy.com/reference
  harvested: '2026-10-22'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://developers.halaxy.com/reference/api_metadata_get.md
  - https://developers.halaxy.com/reference/createappointment.md
  - https://developers.halaxy.com/reference/createcoverage.md
  - https://developers.halaxy.com/reference/createdocumentreference.md
  - https://developers.halaxy.com/reference/createorganisation.md
  - https://developers.halaxy.com/reference/createpatient.md
  - https://developers.halaxy.com/reference/createpractitioner.md
  - https://developers.halaxy.com/reference/createpractitionerrole.md
  - https://developers.halaxy.com/reference/createreferral.md
  - https://developers.halaxy.com/reference/createschedule.md
  - https://developers.halaxy.com/reference/findavailableappointments.md
  - https://developers.halaxy.com/reference/findchargeitemdefinitions.md
  - https://developers.halaxy.com/reference/findcoverage.md
  - https://developers.halaxy.com/reference/findinvoice.md
  - https://developers.halaxy.com/reference/findinvoiceline.md
  - https://developers.halaxy.com/reference/findorganization.md
  - https://developers.halaxy.com/reference/findpatient.md
  - https://developers.halaxy.com/reference/findpaymenttransaction.md
  - https://developers.halaxy.com/reference/findpractitioner.md
  - https://developers.halaxy.com/reference/findpractitionerrole.md
  - https://developers.halaxy.com/reference/findreferral.md
  - https://developers.halaxy.com/reference/findreferraldefinition.md
  - https://developers.halaxy.com/reference/findschedules.md
  - https://developers.halaxy.com/reference/findsearchparameters.md
  - https://developers.halaxy.com/reference/findslots.md
  - https://developers.halaxy.com/reference/generatescheduleslots.md
  - https://developers.halaxy.com/reference/getappointment.md
  - https://developers.halaxy.com/reference/getchargeitemdefinition.md
  - https://developers.halaxy.com/reference/getcoverage.md
  - https://developers.halaxy.com/reference/gethealthcareservice.md
  - https://developers.halaxy.com/reference/getinvoice.md
  - https://developers.halaxy.com/reference/getinvoiceline.md
  - https://developers.halaxy.com/reference/getorganization.md
  - https://developers.halaxy.com/reference/getpatient.md
  - https://developers.halaxy.com/reference/getpatientids.md
  - https://developers.halaxy.com/reference/getpaymenttransaction.md
  - https://developers.halaxy.com/reference/getpractitioner.md
  - https://developers.halaxy.com/reference/getpractitionerrole.md
  - https://developers.halaxy.com/reference/getreferral.md
  - https://developers.halaxy.com/reference/getreferraldefinition.md
  - https://developers.halaxy.com/reference/getschedule.md
  - https://developers.halaxy.com/reference/getslot.md
  - https://developers.halaxy.com/reference/listappointments.md
  - https://developers.halaxy.com/reference/listhealthcareservice.md
  - https://developers.halaxy.com/reference/patchappointment.md
  - https://developers.halaxy.com/reference/patchcoverage.md
  - https://developers.halaxy.com/reference/patchpatient.md
  - https://developers.halaxy.com/reference/patchreferral.md
  - https://developers.halaxy.com/reference/updatepatient.md
  merge:
    pages: 49
    deduped: 942
    conflicts_kept_first: 0