{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-docs/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["tabs","tab"]},"type":"markdown"},"seo":{"title":"Getting started","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"getting-started","__idx":0},"children":["Getting started"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Tyro HealthPoint lets a practice management system (PMS) process private health fund claims through"," ","a Tyro terminal. The PMS builds and validates the claim, including provider details, patient"," ","identifiers and the claimable service items. The terminal is used to capture the patient's health"," ","fund details and send the claim to the fund for approval."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Before you begin, review the certification criteria, which set out the minimum requirements for"," ","certifying an integrated private health fund solution with Tyro:"," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/assets/certification_criteria_iclient_health.de1992aad6cd97914bb43e39084a8a4b289408d46faa21d159ccd3f2dd420298.d564e73d.pdf"},"children":["Certification Criteria for iClient Health"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Two claiming functions are available on both libraries:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Claim"]}," — submit a claim to the patient's health fund."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Cancel claim"]}," — cancel an approved claim on the day it was processed."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The JS library also supports a ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/in-person-payments/pay-in-person/features/private-health-fund/rebate-estimate"},"children":["rebate estimate"]}," and"," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/in-person-payments/pay-in-person/features/private-health-fund/preferred-providers"},"children":["preferred provider claims"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"how-a-claim-works","__idx":1},"children":["How a claim works"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["In the PMS, the staff select a provider and a patient and build up the list of services provided."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Once the list is final, the PMS invokes the library, passing in the claim items and some other"," ","details."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The library's window appears and the claim is passed to the terminal for processing."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The patient presents their health fund card on the terminal when prompted, and the claim is sent"," ","to the health fund for approval."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Once approved, the terminal prints the claim receipt and shows the gap amount to the patient."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["In the PMS, the library shows the gap amount and asks the operator to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Accept"]}," or ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Reject"]}," ","the claim.",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Accept"]}," prompts the terminal to print the patient copy and finalise the claim."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Reject"]}," prompts the terminal to void the claim and print receipts showing it has been"," ","voided."]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["In either case, the result of the original claim is returned to the PMS."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/in-person-payments/pay-in-person/features/private-health-fund/operational-workflow"},"children":["operational workflow"]}," page covers claim approval, declines, voids and"," ","cancellations in more detail."]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"div","attributes":{"label":"JS library","disable":false},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Refer to the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/assets/iclient-api.57e262928075df78cfa8a01bd63db2f4b79b8d58736bbb024a56daa62cd686fe.fbf1555a.zip"},"children":["JS library API"]}," for sample HealthPoint claiming code. After"," ","downloading and extracting the zip folder, open ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["iclient-api/index.html"]},", click Classes, then"," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TYRO.IClientWithUI"]},", scroll down to the index and method tabs, and click index."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"claim-request","__idx":2},"children":["Claim request"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["initiateHealthPointClaim(requestParams, transactionCallbacks)"]}," tells the terminal to start a"," ","HealthPoint claim."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Request parameter"},"children":["Request parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["claimItems"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["JSON array of claim items (maximum 16). See the claim items table below."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["claimItemsCount"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["int"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Total number of claim items."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["mid"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional. Required for headless pairing, multi-merchant, or if your browser doesn't support local storage."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tid"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional. Required for headless pairing, multi-merchant, or if your browser doesn't support local storage."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["integrationKey"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Use if your browser doesn't support local storage, or for headless pairing or multi-merchant."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["providerId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The 8-character provider number (usually Medicare issued)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["serviceType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The 1-character category of service. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/in-person-payments/pay-in-person/features/private-health-fund/modalities-and-settlement"},"children":["Modalities and settlement"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["totalClaimAmount"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["int"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The total amount of all claim items, in cents."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transactionid"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional. Supply a custom transaction ID."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transactionCompleteCallback"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Function"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Invoked when the transaction has completed on the terminal."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["statusMessageCallback"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Function"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Invoked to advertise what is happening on the terminal, which typically faces the customer rather than the provider."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["questionCallback"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Function"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Invoked when the terminal requires the merchant to answer a question to proceed with the transaction."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["statusMessageCallback"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["questionCallback"]}," are only required when using ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TYRO.IClient"]},". With"," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TYRO.IClientWithUI"]},", the UI provided handles status messages and questions."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"claim-items","__idx":3},"children":["Claim items"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Claim item field"},"children":["Claim item field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["serviceReference"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional clinical reference or tooth number suffix (maximum 3 characters). See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#service-reference"},"children":["Service reference"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["claimAmount"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["int"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Claim amount in cents (maximum 10 digits)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["serviceDate"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Claim date, in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["YYYYMMDD"]}," format."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["description"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Item description for the receipt (maximum 32 characters)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["serviceCode"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Item number or service code (maximum 5 characters)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["patientId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Patient identifier (exactly 2 digits)."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"example-request","__idx":4},"children":["Example request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"iclient.initiateHealthPointClaim({\n    providerId: \"1455813F\",\n    serviceType: \"P\",\n    claimItemsCount: \"2\",\n    totalClaimAmount: \"20100\",\n    claimItems: [\n        {\n            \"claimAmount\": \"10000\",\n            \"serviceCode\": \"500\",\n            \"description\": \"Assessment Consult\",\n            \"serviceReference\": \"01\",\n            \"patientId\": \"02\",\n            \"serviceDate\": \"20240921\"\n        },\n        {\n            \"claimAmount\": \"10100\",\n            \"serviceCode\": \"505\",\n            \"description\": \"Subsequent Consult\",\n            \"serviceReference\": \"01\",\n            \"patientId\": \"02\",\n            \"serviceDate\": \"20240921\"\n        }\n    ]}, {\n    transactionCompleteCallback: yourPosCode.handleComplete,\n    statusMessageCallback: yourPosCode.handleStatusMessage,\n    questionCallback: yourPosCode.questionAsked\n});\n","lang":"javascript"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"callbacks","__idx":5},"children":["Callbacks"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To handle the response:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Code callback functions to handle the responses returned by the library through"," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["statusMessageCallback"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["questionCallback"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transactionCompleteCallback"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Associate the callback functions with the callbacks in the function invocation."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Use the response fields returned by the callback to control any subsequent workflow in the PMS,"," ","for example using the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["result"]}," field to decide when the PMS closes the transaction, displays the"," ","result, and marks the transaction with the correct status, such as \"Approved\"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Conduct all follow-up actions and workflows in the callback function."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["statusMessageCallback"]}," is called with a single string argument, for example \"Patient Approval\"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["questionCallback"]}," may not apply to every transaction. For a claim, it can include a prompt for the"," ","patient to approve or decline the claim. It is called with:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["text"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The question to present to the merchant."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["options"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array[String]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The button labels to present. Show one button for each element."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["answerCallback"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Function"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Call this with the label of the clicked button, from the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["options"]}," array, to answer the question."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"claim-response","__idx":6},"children":["Claim response"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Claim responses typically return within 5 seconds but can take up to 55 seconds with some funds. If"," ","no response arrives within 55 seconds, the terminal sends an auto void and the claim must be"," ","reattempted."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["result"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The overall transaction result: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["APPROVED"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CANCELLED"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["REVERSED"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DECLINED"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SYSTEM ERROR"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["NOT STARTED"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["UNKNOWN"]},". The provider only receives settlement if this is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["APPROVED"]},". ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["UNKNOWN"]}," means the provider should look at the terminal to determine what happened, and typically indicates a network error."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transactionId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The 36-character ID for the integrated transaction."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["healthpointFreeText"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional text from the health fund. Can include the patient name, policy details or loyalty information."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["healthpointGapAmount"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The aggregate gap amount."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["healthpointHealthFundName"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The health fund name."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["healthpointPhfResponseCode"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://help.tyro.com/s/article/HealthPoint-claim-response-codes#four"},"children":["claim level response code"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["healthpointRefTag"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A unique claim identifier, printed on the receipt."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["healthpointSettlementDateTime"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The settlement timestamp from HealthPoint."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["healthpointTerminalDateTime"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The terminal's local timestamp."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["healthpointTotalBenefitAmount"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The aggregate benefit amount."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["healthpointClaimItems.rebateAmount"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The benefit amount for the service item."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["healthpointClaimItems.responseCode"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://help.tyro.com/s/article/HealthPoint-claim-response-codes#five"},"children":["service item response code"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["healthpointClaimItems.responseCodeDescription"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The service item response short description."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Other elements echo the request. Every response other than ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["00 - APPROVED"]}," means the fund declined"," ","the item, although an item with another response code can still pay a limited benefit. See the"," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://help.tyro.com/s/article/HealthPoint-claim-response-codes"},"children":["response codes"]}," for each type of"," ","response."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"loyalty-and-bonus-codes","__idx":7},"children":["Loyalty and bonus codes"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For some funds, such as HCF, the response can include a benefit-only item code that the PMS didn't"," ","submit, as part of the fund's loyalty or bonus program. It reduces the gap the patient owes. The"," ","code appears on the patient and provider receipts with:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["a $0 charge amount"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["a benefit-only amount"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["the item ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["serviceCode"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["00992"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["possibly more detail in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["healthpointFreeText"]},", such as \"Limit Boost\""]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"example-response","__idx":8},"children":["Example response"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n    \"result\": \"APPROVED\",\n    \"transactionId\": \"6dbdaffd58adac4e89387f2c9d2c0cdd7c1e\",\n    \"healthpointRefTag\": \"2120599\",\n    \"healthpointTotalBenefitAmount\": \"6600\",\n    \"healthpointSettlementDateTime\": \"20240921093316\",\n    \"healthpointTerminalDateTime\": \"20240921093316\",\n    \"healthpointMemberNumber\": \"12345678\",\n    \"healthpointProviderId\": \"2147661H\",\n    \"healthpointServiceType\": \"P\",\n    \"healthpointClaimItems\": [\n        {\n            \"claimAmount\": \"1000\",\n            \"rebateAmount\": \"600\",\n            \"serviceCode\": \"00500\",\n            \"description\": \"Assessment Consult\",\n            \"serviceReference\": \"01\",\n            \"patientId\": \"02\",\n            \"serviceDate\": \"20240921\",\n            \"responseCode\": \"0000\"\n        },\n        {\n            \"claimAmount\": \"10000\",\n            \"rebateAmount\": \"6000\",\n            \"serviceCode\": \"00520\",\n            \"description\": \"Extended Consult\",\n            \"serviceReference\": \"01\",\n            \"patientId\": \"02\",\n            \"serviceDate\": \"20240921\",\n            \"responseCode\": \"0000\"\n        }\n    ],\n    \"healthpointGapAmount\": \"4400\",\n    \"healthpointPhfResponseCode\": \"00\",\n    \"healthpointPhfResponseCodeDescription\": \"APPROVED\",\n    \"healthpointHealthFundName\": \"ISOFT FUND\",\n    \"healthpointHealthFundIdentifyingDigits\": \"0099\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"gap-payments","__idx":9},"children":["Gap payments"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Once a claim is approved, there's typically a gap between the benefit the health fund pays and the"," ","amount the practitioner charged. If the patient wants to pay the gap by card, use the standard"," ","purchase method and pass ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["healthpointTransactionId"]},", which is the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transactionId"]}," returned in the"," ","response to the original HealthPoint claim. See"," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/in-person-payments/pay-in-person/features/payment-cashout-refund"},"children":["Payments, cashout and refunds"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"cancel-a-claim","__idx":10},"children":["Cancel a claim"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["An approved claim can be cancelled on the day it was processed, before settlement (23:59:59"," ","Australian Eastern time, adjusted for daylight saving)."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cancelHealthPointClaim(requestParams, transactionCallbacks)"]}," tells the terminal to cancel a"," ","HealthPoint claim. The request parameters are those of the claim, plus ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["refTag"]},". The claim values"," ","must match the original claim."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Request parameter"},"children":["Request parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["claimItems"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["JSON array of claim items (maximum 16). Must be the same as the original claim."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["claimItemsCount"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["int"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Total number of claim items. Must be the same as the original claim."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["mid"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional. Must be the same as the original claim if set."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tid"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional. Must be the same as the original claim if set."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["integrationKey"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Must be the same as the original claim if set."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["providerId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The 8-character provider number. Must be the same as the original claim."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["serviceType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The 1-character category of service. Must be the same as the original claim."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["totalClaimAmount"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["int"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The total amount of all claim items, in cents. Must be the same as the original claim."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["refTag"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required. The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["healthpointRefTag"]}," returned in the original claim's final transaction status response."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transactionid"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional. Supply a custom transaction ID. Must be different from the original claim."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transactionCompleteCallback"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Function"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Invoked when the transaction has completed on the terminal."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["statusMessageCallback"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Function"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Invoked to advertise what is happening on the terminal."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["questionCallback"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Function"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Invoked when the terminal requires the merchant to answer a question."]}]}]}]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"// Cancel a completed HealthPoint claim with two claim items totalling $250\niclient.cancelHealthPointClaim({\n    providerId: \"2147661H\",\n    serviceType: \"D\",\n    claimItemsCount: \"2\",\n    totalClaimAmount: \"25000\",\n    refTag: \"0960001\",\n    claimItems: [\n        {\n            \"claimAmount\": \"10000\",\n            \"serviceCode\": \"00001\",\n            \"description\": \"SKULL XRAY\",\n            \"serviceReference\": \"01\",\n            \"patientId\": \"02\",\n            \"serviceDate\": \"20131010\"\n        },\n        {\n            \"claimAmount\": \"15000\",\n            \"serviceCode\": \"00001\",\n            \"description\": \"SKULL XRAY\",\n            \"serviceReference\": \"01\",\n            \"patientId\": \"02\",\n            \"serviceDate\": \"20140508\"\n        }\n    ]}, {\n    transactionCompleteCallback: yourPosCode.handleComplete,\n    statusMessageCallback: yourPosCode.handleComplete,\n    questionCallback: yourPosCode.questionAsked\n});\n","lang":"javascript"},"children":[]}]},{"$$mdtype":"Tag","name":"div","attributes":{"label":".NET library","disable":false},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"claim-payload","__idx":11},"children":["Claim payload"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The .NET library's claim methods take a number of parameters, including a valid XML claim payload."," ","The maximum number of claim items is 16."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Request:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"xml","header":{"controls":{"copy":{}}},"source":"<?xml version='1.0' encoding='utf-8'?>\n<healthpoint-claim-items>\n  <claim-item>\n    <claim-amount>[claim amount in cents - max 10 digits]</claim-amount>\n    <service-code>[item number service code - exactly 5 characters long]</service-code>\n    <service-reference>[body part or tooth number suffix - max 3 characters]</service-reference>\n    <patient-id>[patient ID on card - exactly 2 digits]</patient-id>\n    <service-date>[claim date in YYYYMMDD format]</service-date>\n    <description>[description of item to appear on receipt - max 32 characters]</description>\n  </claim-item>\n</healthpoint-claim-items>\n","lang":"xml"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The payload returned by ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GetHealthpointClaimItems()"]}," adds the benefit and the item's response code:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"xml","header":{"controls":{"copy":{}}},"source":"<healthpoint-claim-items>\n  <claim-item>\n    <claim-amount>[claim amount in cents]</claim-amount>\n    <rebate-amount>[rebate amount in cents]</rebate-amount>\n    <service-code>[item number service code]</service-code>\n    <description>[description of item that appears on receipt]</description>\n    <service-reference>[body part or tooth number suffix]</service-reference>\n    <patient-id>[patient ID on card]</patient-id>\n    <service-date>[claim date in YYYYMMDD format]</service-date>\n    <response-code>[4 digit response code]</response-code>\n  </claim-item>\n</healthpoint-claim-items>\n","lang":"xml"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"methods","__idx":12},"children":["Methods"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Integrated receipts are not supported for health fund claiming."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Tyro.Integ.Domain.ITransactionResult Claim(string providerID, string serviceType, int claimItemsCount, long totalClaimAmount, string payload)"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Tyro.Integ.Domain.ITransactionResult ClaimMidTid(string merchantID, string terminalID, string providerID, string serviceType, int claimItemsCount, long totalClaimAmount, string payload)"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Tyro.Integ.Domain.ITransactionResult Cancel(string providerID, string serviceType, int claimItemsCount, long totalClaimAmount, string refTag, string payload)"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Tyro.Integ.Domain.ITransactionResult CancelMidTid(string merchantID, string terminalID, string providerID, string serviceType, int claimItemsCount, long totalClaimAmount, string refTag, string payload)"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["MidTid"]}," methods let you pass a specific merchant ID and terminal ID, for multi-merchant"," ","capable terminals."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Valid values"},"children":["Valid values"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["providerId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The ID of the provider attending the patient."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["8 alphanumeric characters."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["serviceType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The category of service. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/in-person-payments/pay-in-person/features/private-health-fund/modalities-and-settlement"},"children":["Modalities and settlement"]},"."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["1 alphabetic character."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["claimItemsCount"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Total number of claim items."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Positive integer, from 1 to 16."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["totalClaimAmount"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The total amount of all claim items, in cents."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Positive integer. Maximum length 15."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payload"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The list of claim items in XML. When cancelling, the payload must be the same as the original claim's."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#claim-payload"},"children":["Claim payload"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["refTag"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The reference tag returned in the original claim's final transaction status response. Cancel only."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["refTag"]}," returned for a transaction from the same day."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A claim can only be cancelled on the same day as the original claim."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"response","__idx":13},"children":["Response"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following methods are added to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ITransaction"]},", available from"," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ITransactionResult.getTransaction()"]},":"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Method"},"children":["Method"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string GetHealthpointClaimItems()"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The XML payload response, as described in ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#claim-payload"},"children":["Claim payload"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string GetHealthpointFreeText()"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional free text with extra information on error codes or other information from the private health fund. May be empty."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string GetHealthpointGapAmount()"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The gap amount in cents. Only present on successful claims and voids."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string GetHealthpointMemberNumber()"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The private health fund member number of the cardholder."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string[] GetHealthpointMessages()"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional list of current system notifications. The .NET library shows the messages to the operator, but the PMS may want to store them or pass them to a different audience."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string GetHealthpointPhfResponseCode()"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The overall response code for the claim from the private health fund."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string GetHealthpointPhfResponseCodeDescription()"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The description of the response code from the private health fund."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string GetHealthpointHealthFundIdentifyingDigits()"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The ID of the private health fund."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string GetHealthpointHealthFundName()"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The name of the private health fund."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string GetHealthpointProviderID()"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The provider ID matching the original request."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string GetHealthpointServiceType()"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The service type matching the original request."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string GetHealthpointSettlementDateTime()"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The settlement date and time, as decided by the CSS system or health fund."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string GetHealthpointTotalAmount()"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The total benefit amount for all claim items, in cents."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string GetHealthpointTransactionDateTime()"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The transaction date and time of the claim."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string GetHealthpointTransactionID()"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The transaction ID, or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["refTag"]},", for the claim. Required for cancels."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string GetHealthpointVoidResponseCode()"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The void response code if the claim was rejected or voided."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string GetHealthpointErrorCode()"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The error code for HealthPoint claims. Requires .NET library version 1.2.34 or higher."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string GetHealthpointErrorDescription()"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The error code description for HealthPoint claims. Requires .NET library version 1.2.34 or higher."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"gap-payments-1","__idx":14},"children":["Gap payments"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If the patient wants to pay the gap by card, the PMS must use one of these methods to process the"," ","gap payment:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["bool PurchaseAdditionalData(int amountInCents, int cashOutInCents, string additionalData)"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["bool PurchaseMidTidAdditionalData(string merchantID, string terminalID, int amountInCents, int cashOutInCents, string additionalData)"]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Valid values"},"children":["Valid values"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["amountInCents"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The gap amount to pay, in cents."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Positive integer. Maximum length 7."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cashOutInCents"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["An optional cash out amount. Specify 0 if not required."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Positive integer. Maximum length 7."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["additionalData"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A JSON block containing the transaction ID (or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["refTag"]},") from the claim response."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["For example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{\"healthpointTransactionId\": \"3oijiofw8uf\"}"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["merchantId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The merchant ID to use for the gap payment (part of multi-merchant support)."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The Tyro merchant ID."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["terminalId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The terminal ID to use for the gap payment (part of multi-merchant support)."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The Tyro terminal ID."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The .NET library comes with a sample application that shows how to process integrated health fund"," ","claims."]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"item-numbers","__idx":15},"children":["Item numbers"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Item numbers for claims must be known to and provided by the PMS. They change from time to time,"," ","typically on 1 April, and vary between health funds, so the PMS is responsible for providing the"," ","authoritative list to practice installations. The HealthPoint reference data lists the currently"," ","approved item numbers by modality, plus error codes and the items configured for testing:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/assets/healthpoint-reference-data.23d8f65d56dabc357bed339d8e4377698bf539bf5744acd0715f57c26269bcb2.69da7bba.xlsx"},"children":["HealthPoint reference data (spreadsheet)"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/assets/item-numbers.8f09e8196f074b9882507b60b941c350cc88aafef1af7696dc50fc76ebe9719c.d564e73d.pdf"},"children":["Item numbers (PDF)"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A category code is included in the reference data, but the PMS doesn't need to set it."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"service-reference","__idx":16},"children":["Service reference"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Each claimable item has an optional 3-character service reference. Professions use it to list the"," ","elements certain funds need for a claim. The HealthPoint reference data has the specific codes. In"," ","summary:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Psychology: the primary condition, as 2 numeric characters."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Occupational therapy: the primary condition as 1 numeric character and the diagnostic"," ","intervention as 1 numeric character."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Physiotherapy and chiropractic: the body part or clinical code, as 2 alphanumeric characters."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Dentistry: the FDI tooth number, as 2 numeric characters."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Other professions: up to 3 alphanumeric characters."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"next-steps","__idx":17},"children":["Next steps"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/in-person-payments/pay-in-person/features/private-health-fund/operational-workflow"},"children":["Operational workflow"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/in-person-payments/pay-in-person/features/private-health-fund/modalities-and-settlement"},"children":["Modalities and settlement"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/in-person-payments/pay-in-person/features/private-health-fund/supported-funds"},"children":["Supported health funds"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/in-person-payments/pay-in-person/features/private-health-fund/reports-and-reconciliation"},"children":["Reports and reconciliation"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/in-person-payments/pay-in-person/features/private-health-fund/testing"},"children":["Testing"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/in-person-payments/pay-in-person/features/multi-merchant"},"children":["Multi-merchant"]},", for practices where several providers share a terminal"]}]}]},"headings":[{"value":"Getting started","id":"getting-started","depth":1},{"value":"How a claim works","id":"how-a-claim-works","depth":2},{"value":"Claim request","id":"claim-request","depth":3},{"value":"Claim items","id":"claim-items","depth":4},{"value":"Example request","id":"example-request","depth":4},{"value":"Callbacks","id":"callbacks","depth":3},{"value":"Claim response","id":"claim-response","depth":3},{"value":"Loyalty and bonus codes","id":"loyalty-and-bonus-codes","depth":4},{"value":"Example response","id":"example-response","depth":4},{"value":"Gap payments","id":"gap-payments","depth":3},{"value":"Cancel a claim","id":"cancel-a-claim","depth":3},{"value":"Claim payload","id":"claim-payload","depth":3},{"value":"Methods","id":"methods","depth":3},{"value":"Response","id":"response","depth":3},{"value":"Gap payments","id":"gap-payments-1","depth":3},{"value":"Item numbers","id":"item-numbers","depth":2},{"value":"Service reference","id":"service-reference","depth":2},{"value":"Next steps","id":"next-steps","depth":2}],"frontmatter":{"title":"Getting started","seo":{"title":"Getting started"}},"lastModified":"2026-10-11T02:45:50.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/in-person-payments/pay-in-person/features/private-health-fund/getting-started","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}