Quick intro
The developer guide is intended to get you up-and-running with using the PCA™ API. It covers everything you need to know from registration, authorisation, participation to publication and subscription.
High level architecture
Firstly some context, the diagram below outlines the high level architecture and the key components.
It is important to highlight that the PCA is composed of separate FHIR servers each with its own specific capability statement
The table below outlines the PCA components and access URLs:
| Component | Details | Access URL |
|---|---|---|
| Portal | Web channel for manual administration of the PCA | ${env}/PcaPortal |
| Identity and Access Manager | Components and interfaces that manage client registration, access tokens and authorisation. | ${env}/PcaAuthApi/v2 |
| Participation Manager | Components and interfaces that manage the participation of organisations with the PCA. Creates the base URL for each participating organisation’s FHIR server when the organisation is registered as a PCA participant | ${env}/PcaParticipationApi/v2 |
Publisher Agent* (see note below) | Components and interfaces that manage the publication of information to the PCA. One FHIR server per participating publisher organisation | ${env}/PcaFhirApi/v2/publisher/${org_id}/fhir |
Subscriber Agent* (see note below) | Components and interfaces that manage the subscription of information from the PCA. One FHIR server per participating subscriber organisation | ${env}/PcaFhirApi/v2/subscriber/${org_id}/fhir |
| System of Record Agent | Components and interfaces that manage validation of information with sources of record / data | ${env}/SystemOfRecordApi/v2 |
Note
The Publisher and Subscriber Agent have an added ${org} variable which will be specific to the organisation.
Environment
The ${env} URL for each environment is as following:
| Environment | ${env} URL |
|---|---|
| Software Vendor Testing | https://pca-svt.digitalhealth.gov.au |
| Production | https://pca.digitalhealth.gov.au |
NOTE
The PCA FHIR servers may be co-located within the same operating environment. That is, since the base URL of a FHIR server can comprise both host and path URL components, all PCA FHIR servers could be located at that the same domain/IP address with different path components for each of their base URLs.
The {base} variable as defined by FHIR is the following for the FHIR servers
| FHIR server | ${base} URL |
|---|---|
| Publisher Agent | ${env}/PcaFhirApi/v2/publisher/${org_id}/fhir |
| Subscriber Agent | ${env}/PcaFhirApi/v2/subscriber/${org_id}/fhir |
Portal
Whilst most of the high volume operations can be performed using the APIs there are some low volume operations and are currently not supported through the API.
The portal can be accessed using the following url:
${env}/PcaPortal
PRODA
In order to access the PCA Portal a user requires to authenticate using PRODA:
The URL for PRODA environment is as following:
| Environment | URL |
|---|---|
| Software Vendor Testing | https://vnd.proda.humanservices.gov.au |
| Production | https://proda.humanservices.gov.au |
Users need to create a PRODA account if they don't already have one.
The presentation below outlines how to create PRODA accounts.
Note: Valid identity documents are not required for creating test accounts
Presentation
PRODA - Register Accounts (PowerPoint)
Tools
Most applications and systems will use an existing wrapper library in the language of your choice, but it's important to familiarise yourself with the underlying API HTTP methods first.
There's no easier way to kick the tires than through clients like Postman. Collections and environment imports to expedite this can be found under testing utilities.
FHIR Implementation Guide
The HL7TM FHIR® specification for the APIs offered by the Provider Connect Australia service can be found here: https://pca.digitalhealth.gov.au/fhir/4.0/
Configuration considerations
Below we have outlined some possible profiles that would have different configurations based on how organisations wish to present the addressing information to the PCA:
- Tertiary hospital with many specialties and addressable healthcare services at one location
- Large service provider that provides a single speciality with many addressable healthcare services at many different locations (e.g. pathology, diagnostic imaging)
- Small clinic with one speciality and one addressable healthcare service at a location (e.g. GP, Specialist, AHP, etc.)
- Provider directory containing provider information for the purposes of secure messaging
Home | Next: Client registration
