28/07/2026
Support at Home B2G API Readiness Checklist
Review Client APIs, vendor versions, portal roles, testing, sensitive-data handling, and fallback workflows for Support at Home B2G software.
Guide record
How this guide is reviewed
CaresLink reviews guides for plain language, practical operational use, and consistency with official sources linked on the page.
- Published
- 28/07/2026
- Reviewed
- 28 July 2026
Free Support at Home pack
Download the Portal-Ready Admin Pack.
Use the editable workbook and B2G review prompts to record vendor versions, Client API questions, portal owners, test results, fallbacks, and source dates.
Support at Home B2G API readiness starts with a clear question: what does the provider's current software actually support? The answer must come from current official sources, the software vendor, and the provider's own tested workflow.
The Department describes B2G as a secure connection between aged care software and government systems. Providers usually do not build this connection themselves. They need to understand the software product, version, supported APIs, user access, conformance status, and fallback process.
What the official B2G service currently covers
The Department's B2G page lists 8 available APIs. Four are aged care provider-focused Client APIs: Client Management, Referral Management, Support Plans, and Assessment.
These four APIs help authorised providers access information after referral acceptance. Their published descriptions do not say that progress notes, incident reports, handover notes, or service agreements must be exported through these Client APIs.
| API | Official purpose | Provider readiness question |
|---|---|---|
| Client Management API v1.1 | Access core client identity, demographic, and support-network information after referral acceptance | Which product version displays this information, and who controls access? |
| Referral Management API v1.1 | Access referral information after referral acceptance | Who owns referral acceptance, exception handling, and manual follow-up? |
| Support Plans API v1.0 | Access support plan information, approved services, and funding approval | How are versions, review dates, and local workflow owners recorded? |
| Assessment API v1.0 | Access assessment information to support service planning | Where are assessment dates, outlet details, and unresolved handoffs recorded? |
Client APIs and claiming are different workflow questions
The current Client APIs focus on accessing referral, support plan, assessment, and client-management information. Support at Home claiming can use the Aged Care Provider Portal or an organisation's B2G software.
Do not assume that one API description defines every claiming, invoice, progress-note, incident, or service-agreement field. Ask the vendor which official specification applies to each workflow.
What provider teams should record
Software vendor, product name, product version, and support contact.
API name and version discussed with the vendor.
Conformance register or vendor evidence source and the date checked.
Internal owner for referral, support plan, assessment, portal, finance, and operations questions.
Test date, test scope, result, unresolved issue, and next review date.
Manual fallback, workaround, rollback owner, and staff briefing record.
Storage location for reviewed evidence without copying sensitive data into CaresLink.
Questions to ask the software vendor
Which current B2G APIs does this exact product version support?
Is the product listed on the current conformance register for the relevant capability?
Which fields are read from government systems, entered locally, or sent through a separate workflow?
What happens when referral, support plan, assessment, or client information cannot be matched?
Which user roles can see, change, export, or submit information?
How are validation errors, amendments, retries, and duplicate records handled?
What is the tested fallback when the API, portal, or vendor service is unavailable?
Where will release notes, vendor answers, test evidence, and next review dates be recorded?
Sensitive data and human review
Client API information can include identity, demographics, language, cultural background, care needs, health conditions, goals, concerns, services, funding, and support-network information. Handle that information only in reviewed provider and government systems.
Do not paste participant details, clinical information, portal data, claims, invoices, or vendor credentials into CaresLink or general-purpose AI prompts. Keep human review and provider access controls in place.
How CaresLink can help
CaresLink can help a team structure vendor questions, owner registers, test logs, source dates, and fallback prompts. The Portal-Ready Admin Pack includes a B2G software workflow review file and an evidence-owner workbook.
CaresLink does not connect to B2G, test software conformance, submit claims, access participant data, or decide whether a product is suitable. Use current official guidance and vendor instructions for technical and operational decisions.
Frequently asked questions
Does the B2G project replace every manual provider workflow?
No. Available capabilities depend on the API, software product, product version, conformance status, and provider workflow. Confirm the current process with official sources and the vendor.
Must progress notes and incident reports be exported through the current Client APIs?
The current official Client API descriptions do not list progress notes or incident reports as their purpose. Do not treat them as mandatory Client API exports without a current official specification or vendor instruction.
Who is responsible for software conformance?
Software products must complete the relevant B2G conformance process before connecting through the gateway. Providers should check the current register and ask the vendor which product and capability were assessed.
What is the provider's immediate readiness task?
Record the vendor, product version, supported capability, internal owner, test result, fallback process, source checked date, and next review date.
Can CaresLink inspect API or participant data?
No. CaresLink is an operational resource and drafting layer. It does not connect to B2G, access provider systems, or accept participant and client records for this checklist.
Disclaimer
These resources are provided for general operational documentation and educational purposes only. They do not constitute legal, clinical, medical, compliance, or professional advice. Organisations should review and adapt all documents according to their own policies, procedures, registration requirements, funding arrangements, and regulatory obligations.
Free Word/Excel pack
Get the Portal-Ready Admin Pack
Enter your work email and the ZIP link will appear. Use the pack for vendor, portal, testing, fallback, and evidence-owner review prompts.