|
More information: |
The purpose of this page is to provide guidance to developers who are implementing the new interoperability standards for secure messaging thus enabling clinical information systems (CISs) and secure messaging (SM) systems to find healthcare providers as well as accurately address and securely exchange standards-based messages.
Provider Directory Service & Message Payload Developer Guide
This document is intended to provide practical implementation guidance to developers who are enabling clinical information systems (CISs) and secure messaging (SM) systems to securely exchange standards-based messages. This document can be downloaded here:
https://developer.digitalhealth.gov.au/sites/default/files/
dh-3184-2020-pds-mp-developer-guide-v2.4.pdf [Updated 8 May 2020]
- Provider Directory Service – Sample Request and Response
This document is intended to provide technical details around sample requests, corresponding responses and error scenarios that can be used to inform design and development.
This document can be downloaded here: https://developer.digitalhealth.gov.au/sites/default/files/pds-api-samplerequestresponse-v.1.0.xlsx
How to test your implementation
- Provider Directory and Message Payload Tester Guide
This document is intended to provide practical testing guidance for developers how to validate and test their products so that they meet the key requirements of the developer guide.
https://developer.digitalhealth.gov.au/sites/default/files/dh-3185-2020-pds-mp-tester-guide-v2.4.pdf [Updated 8 May 2020] - Implementation Conformance Statements (ICS)
- CIS Implementation Conformance Statement
This document is intended to provide a step-by-step software validation process as it relates to CIS product developer and provides a template to be completed to demonstrate and state conformance to requirements of the Secure Messaging Industry Offer.
https://developer.digitalhealth.gov.au/sites/default/files/dh-3212-2020-smio-cis-ics-v1.5.docx [Updated 2 June 2020] - SM Implementation Conformance Statement
This document is intended to provide a step-by-step software validation process as it relates to SM product developer and provides a template to be completed to demonstrate and state conformance to requirements of the Secure Messaging Industry Offer.
https://developer.digitalhealth.gov.au/sites/default/files/dh-3213-2020-smio-sm-ics-v1.4.docx [Updated 2 June 2020]
- CIS Implementation Conformance Statement
- Test Data
- Provider Directory Service Test Data
This document is intended to provide a test data set that will be used in scenarios to validate the developed products.
https://developer.digitalhealth.gov.au/sites/default/files/dh-3317-2020-pds-testdata-v2.4.xlsx [Updated 17 September 2020] -
Additional files to be used in CIS vendor tests
Tests MP-5.1 to MP-5.4 require that the CIS vendor demonstrate that their CIS can successfully process MDM-T02 messages containing CDA Packages (.hl7 files).
The following MDM-T02 messages should be used for these tests: [.hl7 Updated 11 March 2020]
MP-5.1 SHA-1 – valid signature use: MDMT02-SHA1-Valid
MP-5.2 SHA-1 – invalid signature use: MDMT02-SHA1-Invalid
MP-5.3 SHA-2 – valid signature use: MDMT02-SHA2-Valid
MP-5.4 SHA-2 – invalid signature use: MP-5.4 SHA-2 – invalid signature
- Provider Directory Service Test Data
- Test Execution
- Provider Directory Service Test Scripts
This package contains postman collections that align with the tester guide and can be imported into the Postman tool to aid in testing:
https://developer.digitalhealth.gov.au/sites/default/files/dh-3318-2020-smio.r4.fhir_.pd_.postman-collections-v2.6.zip [.zip 10KB - Updated 17 September 2020]
- Secure Messaging Industry Offer - Clinical Package Validator (CPV) BETA* Release [Updated June 2020]
Used to validate messages and generate output to be used in the SMIO Implementation Conformance Statements.
Note: The Agency Collaborate download site has restricted access and is only available to persons registered by the Agency to use it. You will firstly need to be registered on digitalhealth.gov.au, then request access to the Secure Messaging Share Space via an email to [email protected], including the name and email address you used to register on digitalhealth.gov.au. Access to the Beta CPV is available at the following link:
https://collaborate.digitalhealth.gov.au/pages/viewpage.action?spaceKey=SMP&title=Secure+Messaging+Share+Space (see note above).
- Provider Directory Service Test Scripts
How to connect to the test environments and receive test certificates
- Requesting NASH test certificates
Please complete and return the 2 forms below and return to [email protected]. Note that a processing time of approximately 2 weeks is required.- Application to request a NASH Test Certificate kit
This form contains the terms and conditions to obtain a Test Certificate and Related Software and Materials.
https://developer.digitalhealth.gov.au/sites/default/files/application-request-nash-pki-test-certificate.pdf - Secure Messaging Industry Offer (SMIO) - NASH PKI Test Certificates Order Form
Application to request a National Authentication Service for Health Test Certificate kit for the purpose of the Secure Messaging Industry Offer (SMIO) [Form revised July 2019]
https://developer.digitalhealth.gov.au/sites/default/files/nash_test_certificates_ordering_form_rev_jul2019.pdf
- Application to request a NASH Test Certificate kit
Supporting Resources
- Australian Profile for Provider Directory Services
- This guide covers capability requirements of FHIR® services to implement a set of profiles and support interfaces in an Australian context for the purpose of implementation of provider directory services.
- http://hl7.org.au/fhir/pd/pd2/
Message Payload
NB: Clarifications and minor updates to the REF-I12 and RRI-I12 specifications have been made by the HL7 Australia Orders & Observations (O&A) Working Group. These will affect SMIO participants. The list of updates can be found in the following spreadsheet:
https://developer.digitalhealth.gov.au/sites/default/files/dh-3816-2020-hl7-oando-group-decisions-impacting-smio-v1.0.xlsx [Added 8 May 2020]
- Message Payload format Patient Referral Message (REF-I12)
The Australian Referral Message has both constrained and also extended the HL7 International version to allow transmission of a full patient history in one message including referral information, patient summary, allergies, medication history and patient care. For detailed information on the message structure please consult Australian Diagnostics and Referral Messaging – Localisation of HL7 Version 2.4:
https://confluence.hl7australia.com/display/OOADRM20181/7+Patient+Referral#id-7PatientReferral-7.2.1PatientReferralMessagestructure(REF_I12) - Patient Referral Response Message (RRI-I12)
On receiving a REF^I12 message a system must produce a RRI^I12 response with the following message structure. The purpose of this message is to inform the originating referrer of the RF1-11 External Referral Identifier allocated by the receiving system. Receivers must not return clinical information to the originating referrer such as reports or results in the Referral Response Information (RRI).
For detailed information on the message structure please consult Australian Diagnostics and Referral Messaging – Localisation of HL7 Version 2.4: https://confluence.hl7australia.com/display/OOADRM20181/7+Patient+Referral#id-7PatientReferral-7.2.2PatientReferralAcknowledgementMessagestructure(RRI_I12) - Medical Document Management Message (MDM-T02)
The HL7 v2 MDM^T02 v2 message shall only be used for transporting the CDA package using a single OBX segment, and SHALL NOT contain any other OBX segments that contain another format of the same data (e.g. RTF, PDF or text).
All relevant documents SHALL be contained inside the CDA package. For detailed information on the message structure please consult:
https://developer.digitalhealth.gov.au/sites/default/files/dh-3239-2020-hl7v2-message-envelope-cda-package-v2.3.pdf [PDF 400KB - Updated 25 June 2020] - Acknowledgement message (ACK-T02)
Two defined levels of acknowledgements are to be supported:- Transport – confirmation that the message has arrived at its destination.
- Application – confirmation that the message has been received within the intended recipient‘s clinical system.
For detailed information on the message structure please consult:
https://developer.digitalhealth.gov.au/sites/default/files/dh-3239-2020-hl7v2-message-envelope-cda-package-v2.3.pdf [PDF 400KB - Updated 25 June 2020]
Clinical Documents
- Common Conformance Profile v1.7
This document provides conformance requirements applicable to all types of clinical documents. This includes references to other documents containing additional normative content. - eReferral v1.4
An eReferral facilitates the seamless exchange of significant patient information from one treating healthcare provider to another. - Specialist Letter v1.3
Specialist Letter documents are used in replying to a referral or reporting on a health event and contain information related to the event or the requested diagnosis or treatment by a specialist. - eDischarge Summary v1.5
eDischarge Summary supports the transfer of a patient from the hospital to their primary physician
Development and Testing Support
- Please contact [email protected] if you require further assistance.
To find out more about Secure Messaging visit the Secure Messaging product guide.