Halaxy

Halaxy Payment Transaction API

The PaymentTransaction API from Halaxy — 2 operation(s) for paymenttransaction.

GitHub OpenAPI

Operations 2

GET /main/PaymentTransaction List Payment Transactions #
GET /main/PaymentTransaction/{id} Get Payment Transaction #

Documentation

📖
Documentation
https://developers.halaxy.com/docs/about-this-guide
📖
APIReference
https://developers.halaxy.com/reference/patient
📖
Authentication
https://developers.halaxy.com/docs/authentication

Specifications

⚙
OpenAPI
https://artifacts.apis.io/halaxy/openapi/halaxy-paymenttransaction-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/halaxy/json-schema/halaxy-search-parameter-jsonfhir-schema.json
📊
JSONSchema
https://artifacts.apis.io/halaxy/json-schema/halaxy-search-parameter-schema.json
📊
JSONSchema
https://artifacts.apis.io/halaxy/json-schema/halaxy-capability-statement-jsonfhir-schema.json
📊
JSONSchema
https://artifacts.apis.io/halaxy/json-schema/halaxy-capability-statement-schema.json
📊
JSONSchema
https://artifacts.apis.io/halaxy/json-schema/halaxy-referral-jsonfhir-schema.json
📊
JSONSchema
https://artifacts.apis.io/halaxy/json-schema/halaxy-referral-schema.json

Other Resources

🔗
Webhooks
https://developers.halaxy.com/docs/webhooks

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/halaxy:halaxy-paymenttransaction-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

halaxy-paymenttransaction-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Halaxy Payment Transaction 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: PaymentTransaction
paths:
  /main/PaymentTransaction:
    get:
      operationId: findPaymentTransaction
      tags:
      - PaymentTransaction
      responses:
        '200':
          description: PaymentTransaction 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/PaymentTransaction.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/PaymentTransaction'
        '403':
          description: Forbidden
      summary: List Payment Transactions
      description: Retrieves a collection of payment transaction records in invoices
      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: ID of the payment transaction
        required: false
        deprecated: false
        schema:
          type: string
        style: form
        explode: false
      - name: _lastUpdated
        in: query
        description: Date the payment transaction was last updated.
        required: false
        deprecated: false
        schema:
          type: string
          format: datetime
        style: form
        explode: false
      - name: created
        in: query
        description: Date the payment transaction was created.
        required: false
        deprecated: false
        schema:
          type: string
          format: datetime
        style: form
        explode: false
      deprecated: false
  /main/PaymentTransaction/{id}:
    get:
      operationId: getPaymentTransaction
      tags:
      - PaymentTransaction
      responses:
        '200':
          description: PaymentTransaction resource
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/PaymentTransaction.jsonfhir'
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentTransaction'
        '403':
          description: Forbidden
        '404':
          description: Resource not found
      summary: Get Payment Transaction
      description: Retrieves an individual payment transaction record
      parameters:
      - name: id
        in: path
        description: PaymentTransaction 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'
    FhirMoney:
      type: object
      description: ''
      deprecated: false
      properties:
        value:
          description: The numerical value of the amount
          type:
          - number
          - 'null'
        currency:
          description: The currency used in ISO 4217 currency code
          type:
          - string
          - 'null'
          enum:
          - AED
          - AFN
          - ALL
          - AMD
          - ANG
          - AOA
          - ARS
          - AUD
          - AWG
          - AZN
          - BAM
          - BBD
          - BDT
          - BGN
          - BHD
          - BIF
          - BMD
          - BND
          - BOB
          - BRL
          - BSD
          - BTN
          - BWP
          - BYN
          - BZD
          - CAD
          - CDF
          - CHF
          - CLP
          - CNY
          - COP
          - CRC
          - CUC
          - CUP
          - CVE
          - CZK
          - DJF
          - DKK
          - DOP
          - DZD
          - EGP
          - ERN
          - ETB
          - EUR
          - FJD
          - FKP
          - FOK
          - GBP
          - GEL
          - GGP
          - GHS
          - GIP
          - GMD
          - GNF
          - GTQ
          - GYD
          - HKD
          - HNL
          - HRK
          - HTG
          - HUF
          - IDR
          - ILS
          - IMP
          - INR
          - IQD
          - IRR
          - ISK
          - JEP
          - JMD
          - JOD
          - JPY
          - KES
          - KGS
          - KHR
          - KID
          - KMF
          - KRW
          - KWD
          - KYD
          - KZT
          - LAK
          - LBP
          - LKR
          - LRD
          - LSL
          - LYD
          - MAD
          - MDL
          - MGA
          - MKD
          - MMK
          - MNT
          - MOP
          - MRU
          - MUR
          - MVR
          - MWK
          - MXN
          - MYR
          - MZN
          - NAD
          - NGN
          - NIO
          - NOK
          - NPR
          - NZD
          - OMR
          - PAB
          - PEN
          - PGK
          - PHP
          - PKR
          - PLN
          - PYG
          - QAR
          - RON
          - RSD
          - RUB
          - RWF
          - SAR
          - SBD
          - SCR
          - SDG
          - SEK
          - SGD
          - SHP
          - SLL
          - SOS
          - SRD
          - SSP
          - STN
          - SVC
          - SYP
          - SZL
          - THB
          - TJS
          - TMT
          - TND
          - TOP
          - TRY
          - TTD
          - TVD
          - TWD
          - TZS
          - UAH
          - UGX
          - USD
          - USN
          - UYI
          - UYU
          - UZS
          - VEF
          - VND
          - VUV
          - WST
          - XAF
          - XAG
          - XAU
          - XBA
          - XBB
          - XBC
          - XBD
          - XCD
          - XDR
          - XOF
          - XPD
          - XPF
          - XPT
          - XSU
          - XTS
          - XUA
          - XXX
          - YER
          - ZAR
          - ZMW
          - ZWL
          - null
        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'
    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'
    PaymentTransaction:
      type: object
      description: A PaymentTransaction.
      deprecated: false
      properties:
        id:
          description: ID of the Payment Transaction
          type:
          - string
          - 'null'
        created:
          description: The date the payment transaction was created
          type:
          - string
          - 'null'
          format: date-time
        date:
          description: The date displayed on the payment transaction
          type:
          - string
          - 'null'
          format: date-time
        method:
          description: The method of the payment transaction - e.g. Braintree, Discount, BPAY, Cash
          anyOf:
          - $ref: '#/components/schemas/FhirCodeableConcept'
          - type: 'null'
        type:
          description: Type of payment transaction - e.g. Deposit, Failed, Payment
          anyOf:
          - $ref: '#/components/schemas/FhirCodeableConcept'
          - type: 'null'
        priceComponent:
          description: The amount breakdown of the payment transaction
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/FhirMonetaryComponent'
        status:
          description: Status of the payment transaction
          anyOf:
          - $ref: '#/components/schemas/FhirCodeableConcept'
          - type: 'null'
        partOf:
          description: The payment transaction is part of another payment transaction
          anyOf:
          - $ref: '#/components/schemas/FhirReference'
          - type: 'null'
        invoice:
          description: The URL reference to the invoice that contains this payment transaction
          anyOf:
          - $ref: '#/components/schemas/FhirReference'
          - type: 'null'
        subject:
          description: The URL reference to the patient whom the payment transaction was for
          anyOf:
          - $ref: '#/components/schemas/FhirReference'
          - type: 'null'
        comment:
          description: Additional notes on the payment transaction
          type:
          - string
          - 'null'
        assignedPractitioner:
          description: The URL reference to the practitioner that this payment transaction is assigned to (optional, for deposits only)
          anyOf:
          - $ref: '#/components/schemas/FhirReference'
          - type: 'null'
        assignedOrganization:
          description: The URL reference to the clinic location that this payment is assigned to (optional, for deposits only)
          anyOf:
          - $ref: '#/components/schemas/FhirReference'
          - type: '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'
        meta:
          description: Metadata about the resource
          anyOf:
          - $ref: '#/components/schemas/FhirResourceMeta'
          - type: 'null'
        resourceType:
          description: Resource Type
          type:
          - string
          - 'null'
    PaymentTransaction.jsonfhir:
      type: object
      description: A PaymentTransaction.
      deprecated: false
      properties:
        id:
          description: ID of the Payment Transaction
          type:
          - string
          - 'null'
        created:
          description: The date the payment transaction was created
          type:
          - string
          - 'null'
          format: date-time
        date:
          description: The date displayed on the payment transaction
          type:
          - string
          - 'null'
          format: date-time
        method:
          description: The method of the payment transaction - e.g. Braintree, Discount, BPAY, Cash
          anyOf:
          - $ref: '#/components/schemas/FhirCodeableConcept.jsonfhir'
          - type: 'null'
        type:
          description: Type of payment transaction - e.g. Deposit, Failed, Payment
          anyOf:
          - $ref: '#/components/schemas/FhirCodeableConcept.jsonfhir'
          - type: 'null'
        priceComponent:
          description: The amount breakdown of the payment transaction
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/FhirMonetaryComponent.jsonfhir'
        status:
          description: Status of the payment transaction
          anyOf:
          - $ref: '#/components/schemas/FhirCodeableConcept.jsonfhir'
          - type: 'null'
        partOf:
          description: The payment transaction is part of another payment transaction
          anyOf:
          - $ref: '#/components/schemas/FhirReference.jsonfhir'
          - type: 'null'
        invoice:
          description: The URL reference to the invoice that contains this payment transaction
          anyOf:
          - $ref: '#/components/schemas/FhirReference.jsonfhir'
          - type: 'null'
        subject:
          description: The URL reference to the patient whom the payment transaction was for
          anyOf:
          - $ref: '#/components/schemas/FhirReference.jsonfhir'
          - type: 'null'
        comment:
          description: Additional notes on the payment transaction
          type:
          - string
          - 'null'
        assignedPractitioner:
          description: The URL reference to the practitioner that this payment transaction is assigned to (optional, for deposits only)
          anyOf:
          - $ref: '#/components/schemas/FhirReference.jsonfhir'
          - type: 'null'
        assignedOrganization:
          description: The URL reference to the clinic location that this payment is assigned to (optional, for deposits only)
          anyOf:
          - $ref: '#/components/schemas/FhirReference.jsonfhir'
          - type: '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'
        meta:
          description: Metadata about the resource
          anyOf:
          - $ref: '#/components/schemas/FhirResourceMeta.jsonfhir'
          - type: 'null'
        resourceType:
          description: Resource Type
          type:
          - string
          - 'null'
    FhirMonetaryComponent.jsonfhir:
      type: object
      description: ''
      deprecated: false
      properties:
        type:
          description: Codes indicating the kind of the price component
          type: string
          enum:
          - base
          - surcharge
          - deduction
          - discount
          - tax
          - informational
        code:
          description: Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc
          anyOf:
          - $ref: '#/components/schemas/FhirCodeableConcept.jsonfhir'
          - type: 'null'
        factor:
          description: Factor used for calculating this component
          type:
          - number
          - 'null'
        amount:
          description: Explicit value amount to be used
          anyOf:
          - $ref: '#/components/schemas/FhirMoney.jsonfhir'
          - type: 'null'
        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'
    FhirMoney.jsonfhir:
      type: object
      description: ''
      deprecated: false
      properties:
        value:
          description: The numerical value of the amount
          type:
          - number
          - 'null'
        currency:
          description: The currency used in ISO 4217 currency code
          type:
          - string
          - 'null'
          enum:
          - AED
          - AFN
          - ALL
          - AMD
          - ANG
          - AOA
          - ARS
          - AUD
          - AWG
          - AZN
          - BAM
          - BBD
          - BDT
          - BGN
          - BHD
          - BIF
          - BMD
          - BND
          - BOB
          - BRL
          - BSD
          - BTN
          - BWP
          - BYN
          - BZD
          - CAD
          - CDF
          - CHF
          - CLP
          - CNY
          - COP
          - CRC
          - CUC
          - CUP
          - CVE
          - CZK
          - DJF
          - DKK
          - DOP
          - DZD
          - EGP
          - ERN
          - ETB
          - EUR
          - FJD
          - FKP
          - FOK
          - GBP
          - GEL
          - GGP
          - GHS
          - GIP
          - GMD
          - GNF
          - GTQ
          - GYD
          - HKD
          - HNL
          - HRK
          - HTG
          - HUF
          - IDR
          - ILS
          - IMP
          - INR
          - IQD
          - IRR
          - ISK
          - JEP
          - JMD
          - JOD
          - JPY
          - KES
          - KGS
          - KHR
          - KID
          - KMF
          - KRW
          - KWD
          - KYD
          - KZT
          - LAK
          - LBP
          - LKR
          - LRD
          - LSL
          - LYD
          - MAD
          - MDL
          - MGA
          - MKD
          - MMK
          - MNT
          - MOP
          - MRU
          - MUR
          - MVR
          - MWK
          - MXN
          - MYR
          - MZN
          - NAD
          - NGN
          - NIO
          - NOK
          - NPR
          - NZD
          - OMR
          - PAB
          - PEN
          - PGK
          - PHP
          - PKR
          - PLN
          - PYG
          - QAR
          - RON
          - RSD
          - RUB
          - RWF
          - SAR
          - SBD
          - SCR
          - SDG
          - SEK
          - SGD
          - SHP
          - SLL
          - SOS
          - SRD
          - SSP
          - STN
          - SVC
          - SYP
          - SZL
          - THB
          - TJS
          - TMT
          - TND
          - TOP
          - TRY
          - TTD
          - TVD
          - TWD
          - TZS
          - UAH
          - UGX
          - USD
          - USN
          - UYI
          - UYU
          - UZS
          - VEF
          - VND
          - VUV
          - WST
          - XAF
          - XAG
          - XAU
          - XBA
          - XBB
          - XBC
          - XBD
          - XCD
          - XDR
          - XOF
          - XPD
          - XPF
          - XPT
          - XSU
          - XTS
          - XUA
          - XXX
          - YER
          - ZAR
          - ZMW
          - ZWL
          - null
        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
    FhirResourceInterface:
      type: object
      description: ''
      deprecated: false
    FhirMonetaryComponent:
      type: object
      description: ''
      deprecated: false
      properties:
        type:
          description: Codes indicating the kind of the price component
          type: string
          enum:
          - base
          - surcharge
          - deduction
          - discount
          - tax
          - informational
        code:
          description: Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc
          anyOf:
          - $ref: '#/components/schemas/FhirCodeableConcept'
          - type: 'null'
        factor:
          description: Factor used for calculating this component
          type:
          - number
          - 'null'
        amount:
          description: Explicit value amount to be used
          anyOf:
          - $ref: '#/components/schemas/FhirMoney'
          - type: 'null'
        id:
          readOnly: true
          description: ID of the FHIR element (optional)
          type:
          - string
          - 'null'
    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'
    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'
    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'
  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


# --- truncated at 32 KB (32 KB total) ---
# Full source: https://artifacts.apis.io/halaxy/openapi/halaxy-paymenttransaction-api-openapi.yml