Skip to main content
ID
DG-3042
Type
Guide
Version
1.0
Status
Active
Created date
Updated date

Quick intro

Client registration APIs

System-based

The following table outlines the client registration operations available through the API:

RefAPIURLHTTP ActionDetailed Action
SC1.1Register client${env}/PcaAuthApi/v2/auth/registerPOSTRegister client with PCA™
SC1.2Deregister client${env}/PcaAuthApi/v2/auth/register/[client_id]DELETEDeregister the client from the PCA™
SC2.1Get access token${env}/PcaAuthApi/v2/auth/tokenPOSTGet access token to be used for interaction with PCA™
SC2.2Introspect${env}/PcaAuthApi/v2/auth/introspectPOSTDetermine the set of metadata for a given token

Publisher operation APIs

The following table outlines the publisher operations available through the API on the PCA™ Publisher Agent:

RefAPIURLHTTP ActionDetailed Action
PO1.1Capability statement${base}/metadata?GETReturns the capability statement for the publisher agent
PO2.1Create location${base}/LocationPOSTRegister a location for organisation
PO2.2Get location${base}/Location/[loc_id]GETGet location details
PO2.3Update location${base}/Location/[loc_id]PUTUpdate location details
PO2.4Search locations${base}/Location?GETSearch for locations based on search parameters
PO3.1Create healthcare service${base}/HealthcareServicePOSTRegister a location for organisation
PO3.2Get healthcare service${base}/HealthcareService/[hcs_id]GETGet healthcare service details
PO3.3Update healthcare service${base}/HealthcareService/[hcs_id]PUTUpdate healthcare service details
PO4.1Search partner services${base}/HealthcareService?_profile=http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-partner-serviceGETSearch for partner services based on search parameters
PO4.2Get partner service${base}/HealthcareService/[prs_id]GETGet partner service details
PO4.3Get information use statement${base}/Contract/[ius_id]GETGet information use statement
PO5.1Get practitioner${base}/Practitioner?identifier=[ahpraRegistrationNumber]GETGet practitioner details using their AHPRA number
PO6.1Create practitioner role${base}/PractitionerRoleCREATERegister a practitioner role at a healthcare service
PO6.2Get practitioner role${base}/PractitionerRole/[prr_id]GETGet practitioner role details
PO6.3Update practitioner role${base}/PractitionerRole/[prr_id]PUTUpdate practitioner role details
PO7.1Get matched records${base}/?_type=TaskGETGet a status of matched records

Subscriber operation APIs

The following table outlines the subscriber operations through the API on the PCA™ Subscriber Agent:

The following table outlines the subscriber operations through the API on the PCA™ Subscriber Agent:

RefAPIURLHTTP ActionDetailed Action
SO1.1Capability statement${base}/metadataGETReturns the capability statement for the subscriber agent
SO2.1Register notification${base}/SubscriptionPOSTRegister notification channel
SO2.2Get registered notification channels${base}/SubscriptionGETGet registered notification channels
SO2.3Deregister notification${base}/Subscription/${subscription_id}DELETEDeregister notification channel
SO3.1Get service offerings based on date parameter

${base}?_type={resourceName}&_lastUpdated={timeStamp}

 

GET

Get resources based on date parameter

e.g. _lastUpdated=gt2019-11-18T15:56:48%2B11:00

SO3.2Get service offerings  based on date parameter - include and iterate over references${base}?_type={resourceName}&_lastUpdated={timeStamp}&_include={resourceName}:{searchParamater}&_include:iterate={resourceName}:{searchParamater}GET

Get resources based on date parameter and include and iterate on references:

e.g. _include=HealthcareService:organization

SO4.1Patch healthcare service${base}/HealthcareService/[hcs_id]PATCHPatch healthcare service details
SO5.1Submit match record${base}/TaskPOSTSubmit match records

System of record APIs

The following table outlines the system of record APIs:

RefAPIURLHTTP ActionDetailed Action
SR1.1ABR search${env}/PcaSystemOfRecordApi/v2/api/AbrSearch/search?abn={abn}GETSearch by ABN
SR1.2ABR ABN${env}/PcaSystemOfRecordApi/v2/api/AbrSearch/abn?abn={abn}GETLookup and validation of the ABN
SR2.1Address autocomplete${env}/PcaSystemOfRecordApi/v2/api/AddressSearch/addressautocomplete?address={address}GETSearch to return closely matching addresses which can then be selected from by the user
SR2.2Address metadata${env}/PcaSystemOfRecordApi/v2/api/AddressSearch/addressmetadata?id={address_id}GETReturn the full metadata associated with an address selected from address autocomplete API.
SR3.1Location autocomplete${env}/PcaSystemOfRecordApi/v2/api/AddressSearch/locationautocomplete?address={location}GETSearch to return matching suburb or post code which can then be selected from by the user
SR3.2Location metadata${env}/PcaSystemOfRecordApi/v2/api/AddressSearch/locationmetadata?id={location_id}GETReturn the full metadata associated with an location selected from location autocomplete API.
SR4.1AHPRA lookup${env}/PcaSystemOfRecordApi/v2/api/Ahpra/search?ahpraProfessionNumber={ahpra_profession_number}GETLookup and validation of the AHPRA number
SR5.1HI search HPIO${env}/PcaSystemOfRecordApi/v2/api/HiSearch/organisation/hpio?user={username}&hpioLinkedToCsp={hpioLinkedToCsp}&hpio={hpio}GETHealth identifier validation for organisation using HPIO
SR5.2HI search ABN${env}/PcaSystemOfRecordApi/v2/api/HiSearch/organisation/abn?user={username}&hpioLinkedToCsp={hpioLinkedToCsp}&abn={abn}GETHealth identifier validation for organisation using ABN
SR5.3HI search HPII${env}/PcaSystemOfRecordApi/v2/api/HiSearch/provider?user={username}&hpioLinkedToCsp={hpioLinkedToCsp}&familyName={familyname}&id={id}&idType=hpiiGETHealth identifier validation for individual using HPII
SR5.4HI search AHPRA${env}/PcaSystemOfRecordApi/v2/api/HiSearch/provider?user={username}&hpioLinkedToCsp={hpioLinkedToCsp}&familyName={familyname}&id={id}&idType=ahpraGETHealth identifier validation for individual using AHPRA registration id
SR6.1Medicare validate{{env}}/PcaSystemOfRecordApi/v2/api/Medicare/validate?providerNumber={providerNumber}&givenName={givenName}&familyName={familyName}&postcode={postcode}GET Validate Medicare Provider Number
SR7.1Terminology valueset${env}/PcaSystemOfRecordApi/v2/api/TerminologyManager/valueset?valueSet={valueset}GETReturns a valueset See below *
SR7.2Terminology allparents${env}/PcaSystemOfRecordApi/v2/api/TerminologyManager/allparents?valueSet={valueset}&code={code}GETReturns parents of code for a valueset
SR7.3Terminology children${env}/PcaSystemOfRecordApi/v2/api/TerminologyManager/children?valueSet={valueset}&code={code}GETReturns children of code for a valueset

Testing utilities (PCA™ API)

You can use a client such as Postman for testing.

The latest collections and environment imports are in the ZIP file linked below:

Quick start guide

Step  Details
1Install Postman and create a PCA™ workspace
2Unzip the latest postman collections archive above
3Import all extracted files into PCA™ workspace
4Create an Organisation (PCA™ portal) 
5Register client (CR1.1)
6Authorise client (PCA™ portal) for the Organisation
7Get access token (CR2.1)
8Source org_id by calling introspect token (CR2.2)
9Run any publisher, subscriber or system of record operations

 Home | Back: Implementation patterns | Next: Code samples

Trade marks of the Australian Digital Health Agency: 
Provider Connect Australia™, Helping healthcare providers stay connected™

PCA logo
PCA logo

On this page