Halaxy Slot API

openapi: 3.2.0
info:
  title: Halaxy Slot 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: Slot
paths:
  /main/Slot:
    get:
      operationId: findSlots
      tags:
      - Slot
      responses:
        '200':
          description: Slot 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/Slot.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/Slot'
        '403':
          description: Forbidden
      summary: List Slots
      description: Retrieves a collection of time intervals that are available for booking appointments
      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: _id
        in: query
        description: The logical id of the resource
        required: false
        deprecated: false
        schema:
          type: string
        style: form
        explode: false
      - name: duration
        in: query
        description: The duration of the slot
        required: false
        deprecated: false
        schema:
          type: string
        style: form
        explode: false
      - name: status
        in: query
        description: The free/busy status of the appointment
        required: false
        deprecated: false
        schema:
          type: string
        style: form
        explode: false
      - name: practitioner
        in: query
        description: The practitioner available for the slot
        required: false
        deprecated: false
        schema:
          type: string
        style: form
        explode: false
      - name: organization
        in: query
        description: The Organization the slot if apart of the Slot
        required: false
        deprecated: false
        schema:
          type: string
        style: form
        explode: false
      - name: practitioner-role
        in: query
        description: The PractitionerRole that is apart of the Slot
        required: false
        deprecated: false
        schema:
          type: string
        style: form
        explode: false
      - name: start
        in: query
        description: The Appointment start date/time.
        required: false
        deprecated: false
        schema:
          type: string
          format: datetime
        style: form
        explode: false
      - name: end
        in: query
        description: The Appointment end date/time.
        required: false
        deprecated: false
        schema:
          type: string
          format: datetime
        style: form
        explode: false
      - name: schedule
        in: query
        description: The schedule the slot is a part of
        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:
          - Slot:practitioner
          - Slot:organization
          - Slot:practitioner-role
        style: form
        explode: false
      deprecated: false
  /main/Slot/{id}:
    get:
      operationId: getSlot
      tags:
      - Slot
      responses:
        '200':
          description: Slot resource
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/Slot.jsonfhir'
            application/json:
              schema:
                $ref: '#/components/schemas/Slot'
        '403':
          description: Forbidden
        '404':
          description: Resource not found
      summary: Get Slot
      description: Retrieves an individual time interval available for booking appointments
      parameters:
      - name: id
        in: path
        description: Slot identifier
        required: true
        deprecated: false
        schema:
          type: string
        style: simple
        explode: false
      deprecated: false
components:
  schemas:
    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
    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'
    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'
    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'
    Slot:
      type: object
      description: "Slot resources are used to provide time-slots that can be booked using an appointment. They do not provide any information about \n    appointments that are available, just the time, and optionally what the time can be used for. These are effectively spaces of free/busy time.\nSlots can also be marked as busy without having appointments associated."
      deprecated: false
      properties:
        schedule:
          description: The schedule resource that this slot defines an interval of status information
          $ref: '#/components/schemas/FhirReference'
        status:
          description: busy | free | busy-unavailable | busy-tentative | entered-in-error
          type: string
          enum:
          - busy
          - free
          - busy-unavailable
          - busy-tentative
          - entered-in-error
        start:
          description: Date/Time that the slot is to begin
          type: string
          format: date-time
        end:
          description: Date/Time that the slot is to conclude
          type: string
          format: date-time
        overbooked:
          description: This slot has already been overbooked, appointments are unlikely to be accepted for this time
          type:
          - boolean
          - 'null'
        actor:
          minItems: 1
          uniqueItems: true
          description: This slot has already been overbooked, appointments are unlikely to be accepted for this time
          type: array
          items:
            $ref: '#/components/schemas/FhirReference'
        comment:
          writeOnly: true
          description: Comments on the slot to describe any extended information. Such as custom constraints on the slot
          type:
          - string
          - 'null'
        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: Logical id of this artifact
          type:
          - string
          - 'null'
        meta:
          description: Metadata about the resource
          anyOf:
          - $ref: '#/components/schemas/FhirResourceMeta'
          - type: 'null'
        resourceType:
          description: Resource Type
          type:
          - string
          - 'null'
      required:
      - status
      - start
      - end
      - actor
    Slot.jsonfhir:
      type: object
      description: "Slot resources are used to provide time-slots that can be booked using an appointment. They do not provide any information about \n    appointments that are available, just the time, and optionally what the time can be used for. These are effectively spaces of free/busy time.\nSlots can also be marked as busy without having appointments associated."
      deprecated: false
      properties:
        schedule:
          description: The schedule resource that this slot defines an interval of status information
          $ref: '#/components/schemas/FhirReference.jsonfhir'
        status:
          description: busy | free | busy-unavailable | busy-tentative | entered-in-error
          type: string
          enum:
          - busy
          - free
          - busy-unavailable
          - busy-tentative
          - entered-in-error
        start:
          description: Date/Time that the slot is to begin
          type: string
          format: date-time
        end:
          description: Date/Time that the slot is to conclude
          type: string
          format: date-time
        overbooked:
          description: This slot has already been overbooked, appointments are unlikely to be accepted for this time
          type:
          - boolean
          - 'null'
        actor:
          minItems: 1
          uniqueItems: true
          description: This slot has already been overbooked, appointments are unlikely to be accepted for this time
          type: array
          items:
            $ref: '#/components/schemas/FhirReference.jsonfhir'
        comment:
          writeOnly: true
          description: Comments on the slot to describe any extended information. Such as custom constraints on the slot
          type:
          - string
          - 'null'
        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: Logical id of this artifact
          type:
          - string
          - 'null'
        meta:
          description: Metadata about the resource
          anyOf:
          - $ref: '#/components/schemas/FhirResourceMeta.jsonfhir'
          - type: 'null'
        resourceType:
          description: Resource Type
          type:
          - string
          - 'null'
      required:
      - status
      - start
      - end
      - actor
    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
    FhirResourceInterface:
      type: object
      description: ''
      deprecated: false
    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'
  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