Quick intro
In order for a subscriber to know that information has become available based on some defined criteria, the subscriber needs register a notification channel either via the Portal or using an API.
Portal
Using the portal the organisation manager can add an email configuration as per the tab below:
The partner service, email address, frequency and changes can be configured as per below:
API
This operation is a RESTful create interaction (type level Interaction) as described in https://www.hl7.org/fhir/http.html#create of a PCA™ Subscription resource as described in https://pca.digitalhealth.gov.au/fhir/4.0/currentdraft/StructureDefinition-pca-subscription.html.
POST /PcaFhirApi/v2/subscriber/org-bdde9e29c1044fecb281ea9411e7866a/fhir/Subscription HTTP/1.1
Content-Type: application/fhir+json; charset=utf-8
Accept: application/fhir+json; charset=utf-8
Authorization: Bearer 24.1643784525.8e7ceace124643c996556c19cff21922
User-Agent: PostmanRuntime/7.29.0
Cache-Control: no-cache
Postman-Token: a7e0021d-b641-4d66-8d59-c6a8613a021a
Host: bne-drp-trp.digitalhealth.gov.au
Accept-Encoding: gzip, deflate, br
Connection: keep-alive
Content-Length: 334
{
"resourceType": "Subscription",
"status": "requested",
"reason": "subscriber change notifications",
"criteria": "_type=Organization,HealthcareService,Location,Practitioner,PractitionerRole,Provenance",
"channel": {
"type": "rest-hook",
"endpoint": "https://sm-r-us.com.au/my-notification-channel2"
}
}
HTTP/1.1 200 OK
Transfer-Encoding: chunked
Content-Type: application/fhir+json; charset=utf-8
Last-Modified: Wed, 02 Feb 2022 06:45:45 GMT
Location: Subscription/sub-31779d1bd8894076979ba3f012164bb6
X-Frame-Options: DENY
Date: Wed, 02 Feb 2022 06:45:45 GMT
{
"resourceType":"Subscription",
"id":"sub-31779d1bd8894076979ba3f012164bb6",
"meta": {
"lastUpdated":"2022-02-02T16:45:45.4348652+10:00"
},
"status":"active",
"reason":"subscriber change notifications",
"criteria":"_type=Organization,HealthcareService,Location,Practitioner,PractitionerRole,Provenance",
"channel": {
"type":"rest-hook","endpoint":"https://sm-r-us.com.au/my-notification-channel2"
}
}Notes:
- When a resource is created or updated that meets the criteria, the PCA server sends a POST request with no body to the nominated URL.
- When the subscriber receives a POST to https://sm-r-us.com.au/my-notification-channel2, it re-issues the criteria as a query to the server, appending _lastUpdated=<lastUpdated> (where <lastUpdated> is replaced by the time at which the client last checked). In this way and example above it will fetch all new relevant Organization, HealthcareService, Location, Practitioner, PractitionerRole
- Since payload is missing, the data in the resources is only available via pull through the PCA server REST API, which helps consolidate authorisation and authentication logic. The subscriber must append the headers to the request that it makes to the PCA server.
For further details on managing and updating notification channels refer to subscription operations of the API reference.
Home | Back: Subscriber capability statement | Next: Get service offerings
