Technical details and API
Hosting platform
The BadgerNet Spine is the principal interoperability component of the national BadgerNet platform which is hosted on Microsoft Azure infrastructure.
For the UK National BadgerNet platform, it is hosted in the Azure UK South region with a dedicated high-speed HSCN express route network link.
For the NZ National BadgerNet platform, it is hosted in the Azure Australia East region with a dedicated high-speed Connected Health network link. It is also internet-facing for Client Systems that are not part of the Connected Health network.
Client System authentication architecture
Dedicated BadgerNet OAuth 2.0-compatible Identity Provider (IdP).
Spine Client authentication IDs and secrets are created by the Clevermed Spine Admin team.
Each single Spine Client System instance is assigned its own Spine Client ID and Client Secret (the system equivalent of username and password) combination which must not be shared between systems.
Security
Every Spine API request must be authenticated with a valid access token issued by the BadgerNet IdP.
All traffic is encrypted with HTTPS TLS1.2.
Every Spine Client System is assigned a Spine Client Type which has specific roles and expectations associated with each role. These are enforced for every API request.
Every BadgerNet Spine request is fully logged, including all payload data sent and received.
Spine Client System requirements
Must be compliant with respective national requirements for care record security compliance.
Must be capable of securely storing its associated Client Credentials (i.e. it must be a Confidential Client).
Must be able to store its own detailed audit trail of all requests related to care record updates if it is sending patient data to the BadgerNet Spine.
Endpoints
The HTTP end-points for both TEST and LIVE in both UK and NZ can be obtained from Clevermed. Please email support@clevermed.com to request these as needed.
Accessing the BadgerNet Spine
If you would like to have your system access the national BadgerNet Spine, please email support@clevermed.com to start the process.
FHIR Models
For sending and reading data to/from the BadgerNet Spine, all patient data must be modelled using FHIR resources.
Each of the BadgerNet care record types defines its own set of FHIR resource profiles and associated usage guidance.
When sending FHIR Bundles to the BadgerNet Spine, only those FHIR resources defined in this section will be processed for saving in the associated raw BadgerNet Care Record. Additional FHIR resources can be sent without an error being returned, but will simply not be processed and saved within the underlying BadgerNet care record.
When reading from the BadgerNet Spine, it is important to note that only the FHIR resources permitted within the project’s Spine Record Filter will be included. This is usually a subset of all possible FHIR resources for any specific patient, as required to meet the governance rules for each Spine Project.