System Parameters - Web Services

Use the Web Services tab to configure the addresses of the web services used in Communicare.

Security certificates for the web services are maintained on Organisation Parameters - Certificates.

Table 1. Web Services parameters
Pane Parameters & Description
ADHA Provider Directory Service (PDS) If required, specify information for the ADHA PDS:
  • Set Enable PDS address book synchronisation
  • In the URL field, enter the web address of the ADHA PDS.
  • From the Certificate list, select a certificate. Only those organisations in Communicare with a NASH org certificate are listed. For more information, see Certificates Maintenance.
Tip: On the System tab, also enable the Address Book Integration - ADHA PDS module.
Healthcare Identifiers (HI) Service Set Enable HI Service and enter the web service address of the HI Service, either:
  • Production URL: https://www3.medicareaustralia.gov.au/pcert/soap/services/
  • Test URL (for use in the Demo only): https://www5.medicareaustralia.gov.au/cert/soap/services/
Electronic Transfer of Prescriptions (ETP) The path to the eRx Adapter software that enables ETP, entered by Communicare when this module is enabled.
Enterprise Provider Directory (EPD) Service If required, specify the web service address of the EPD:
  • For the Demo only:
    • URL - https://securemessaging.dev.telstrahealth.com/epd/stu3/fhir
    • API Key - Y29tbXVuaWNhcmUtZGV2Ok1rakdUNEFyVXhSc2RvSExJbFIw
  • For production:
    • URL - https://securemessaging.telstrahealth.com/epd/stu3/fhir
  • API Key - contact Communicare Support
Communicare Web Service Specify the address of the Communicare web service. For example, https://webservices.communicaresystems.com.au:9000
My Health Record Service Specify the web service address of the My Health Record Service, either:
  • Production URL: https://services.ehealth.gov.au:443
  • Test URL (for use in the Demo only): https://services.svt.gw.myhealthrecord.gov.au
Real-Time Prescription Monitoring (RTPM) Service Specify the address of the Safescript web service:
  • Production URL: https://api.safescript.vic.gov.au/api/precheck
EMPI Search Specify the web service address of the EMPI search service.
Clinical Decision Support (CDS) To use the CDS service to link to the online MIMS database for condition and pregnancy interaction checking when prescribing instead of the locally installed MIMS database, set Enable Decision Support and add information to the following fields:
  • URL - the URL of the Telstra Health API, for example, https://api.sit.telstrahealth.com
  • Context - the subdirectory for the CDS API, for example, /meds/cds
  • Client Id - the ID assigned to your health service by Telstra Health, provided by Communicare Support
  • Client Secret - an authorisation key from Telstra Health, provided by Communicare Support
Note: If the CDS service is enabled and you are working offline, condition and pregnancy interaction checking won't be available.
The default timeout for calls to the CDS server is 2000 milliseconds. If you would like this extended, contact Communicare Support.
Tip: If you don't want pregnancy or condition interaction warnings displayed when prescribing, ask Communicare Support to disable them.
Services Australia
In V21.3 and later, settings required to connect to Service Australia's web services. Set Enable Services Australia to use these settings.
  • General settings:
    • System Identifier - the name of the OPV API, for example, communicare.resourcemanagement
    • Device Identifier - the foreign key for the system identifier. This is the global PRODA device ID setting for your organisation.
    • Identifier - the name of the Communicare server instance, for example, CCAREQA05
  • Medicare Endpoint - for integration with Medicare Online:
    • URL - the URL of the Telstra Health Services Australia API, for example, https://ap-dev-servicesaustralia-api-th.azurewebsites.net
    • Namespace - the namespace for Services Australia objects, for example, sp-dev-servicesaustralia-sb-th.servicebus.windows.net
  • Immunisation Endpoint - for integration with the AIR:
    • URL - the URL of the Telstra Health AIR API, for example, https://ap-dev-servicesaustralia-immunisation-th.azurewebsites.net/
  • API Credentials :
    • Client ID - the ID assigned to your health service by Telstra Health, provided by Communicare Support
    • Client Secret - an authorisation key from Telstra Health, provided by Communicare Support
    • Authentication URL - the URL used to authenticate access to Services Australia.
    • Scope - the API endpoint scope which defaults to api://{clientId}/.default
  • Message Bus Credentials:
    • Client ID - the ID assigned to your health service by Telstra Health, provided by Communicare Support
    • Client Secret - an authorisation key from Telstra Health, provided by Communicare Support
    • Authentication URL - the URL used to authenticate access to Services Australia.
    • Scope - the message bus scope which defaults to https://servicebus.azure.net/.default
Tip: The default timeout for calls to Services Australia is 5000 milliseconds. If you would like this changed, contact Communicare Support.
SNOMED Terminology Specify the settings of the SNOMED terminology server, used to validate SNOMED codes assigned to clinical items.
  • Browser Location - the web application to browse SNOMED terminology. Default: https://ontoserver.csiro.au/shrimp
  • FHIR Validation Service - the URL used to access a FHIR terminology server. Default: https://api.healthterminologies.gov.au/integration/R4/fhir
  • Authentication URL - the URL used to authenticate access to the FHIR terminology server. Leave this field blank if your terminology server does not require authentication. Default: https://api.healthterminologies.gov.au/oauth2/token
  • Client ID - the ID assigned by the FHIR terminology server.
  • Client Secret - an authorisation assigned by the FHIR terminology server.
Your health service can use one of the following terminology servers:
  • National Clinical Terminology Server (NCTS) provided by Australian Digital Health Agency (ADHA). Register at https://www.healthterminologies.gov.au/
  • A terminology server provided by Telstra Health
  • A terminology server hosted by your organisation or a third party
National Cancer Screening Register (NCSR) Specify your organisation's National Cancer Screening Register (NCSR) registration details:
  • URL - the URL of the NCSR API
  • Certificate - your organisation's NASH certificate
    Tip: First upload the certificate to File > Reference Tables > Certificates.
Tip: Before you can specify NCSR settings, on the System tab, first enable the NCSR Integration module.
Script Exchange
In V22.1 and later, settings required to enable Electronic Transfer of Prescriptions (ETP) and connect to an ETP service, such as eRx, using Telstra Health Script Exchange. Contact Communicare Support to register for ePrescribing.
  • General settings:
    • System Identifier - the customer code emailed to you when you registered for ePrescribing with Telstra Health, for example, CCARE05
    • Identifier - the authoring system foreign key emailed to you when you registered, for example, CPHS-123
    • Queue Name - the queue used to communicate with Script Exchange emailed to you when you registered, for example, CCareQueue_ScriptExchange/Classic-<CustomerCode>-<Environment>-01
    • Namespace - the namespace for Script Exchange objects, for example, sb-aue-classic-scriptexchange-th.servicebus.windows.net
    • Client ID - the ID emailed to you when you registered.
    • Client Secret - an authorisation key emailed to you when you registered.
    • Authentication URL - the URL used to authenticate access to eRx script exchange, for example, https://login.microsoftonline.com/....