PCA™ - Search for partner services

Quick intro

After creating a healthcare service(s) at a location, you can search for available partner services. 

RESTful search interaction

This operation is a RESTful search interaction (type level Interaction) as described in https://www.hl7.org/fhir/http.html#search of the HealthcareService as profiled for Australian use and described at https://pca.digitalhealth.gov.au/fhir/4.0/currentdraft/StructureDefinition-pca-partner-service.html.

GET /PcaFhirApi/v2/publisher/org-6ac00cb80e4b4dbbabb489ee8a9c942b/fhir/HealthcareService?active=true&service-category=http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-partner-service-category|SecureMessagingServices&_profile=http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-partner-service HTTP/1.1
Content-Type: application/fhir+json; charset=utf-8
Accept: application/fhir+json; charset=utf-8
Authorization: Bearer 19.1649241842.2b4d433fcd3e44b5ab7fe5e11f1d88e5
User-Agent: PostmanRuntime/7.29.0
Cache-Control: no-cache
Postman-Token: 03c0c134-11ad-4661-b127-8cfb5f68f246
Host: pca-vendor-test.digitalhealth.gov.au
Accept-Encoding: gzip, deflate, br
Connection: keep-alive
Cookie: __cf_bm=8IXPeSXKanH.hVqS_3kosQvV5RgbQXsw.VIli2BqwOU-1649241542-0-AdnmvGbrZDFTxp1uirEtWTfQmbttWlZ8r+uIfht6oprEbo7YMDCjzJHVq1GmHd28HIs+wVm3bX1GJWu8EprsiM0=
  
HTTP/1.1 200 OK
Date: Wed, 06 Apr 2022 10:39:12 GMT
Content-Type: application/fhir+json; charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive
Last-Modified: Wed, 06 Apr 2022 10:39:11 GMT
Location: Bundle/3d1d5fe1-d584-4ba4-826f-f069cc57318f
X-XSS-Protection: 1; mode=block
X-Frame-Options: DENY
X-Content-Type-Options: nosniff
CF-Cache-Status: DYNAMIC
Expect-CT: max-age=604800, report-uri="https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct"
Strict-Transport-Security: max-age=15552000; includeSubDomains; preload
Server: cloudflare
CF-RAY: 6f79e5d0aa9b5a55-MEL  
{
    "resourceType": "Bundle",
    "id": "3d1d5fe1-d584-4ba4-826f-f069cc57318f",
    "type": "searchset",
    "total": 2,
    "link": [
        {
            "relation": "self",
            "url": "https://pca-vendor-test.digitalhealth.gov.au/PcaFhirApi/v2/subscriber/org-6ac00cb80e4b4dbbabb489ee8a9c942b/fhir?active=true&service-category=http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-partner-service-category|SecureMessagingServices&_profile=http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-partner-service&_type=HealthcareService&_page=1"
        }
    ],
    "entry": [
        {
            "fullUrl": "https://pca-vendor-test.digitalhealth.gov.au/PcaFhirApi/v2/subscriber/org-6ac00cb80e4b4dbbabb489ee8a9c942b/fhir/HealthcareService/prs-843a6c2a8b2d46799edf27bb8903d3dc",
            "resource": {
                "resourceType": "HealthcareService",
                "id": "prs-843a6c2a8b2d46799edf27bb8903d3dc",
                "meta": {
                    "versionId": "2",
                    "lastUpdated": "2022-03-29T06:51:54.9935724+10:00"
                },
                "extension": [
                    {
                        "url": "http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-current-information-use-statement",
                        "valueReference": {
                            "reference": "Contract/ius-287047a7bde744448d93525de5285c94"
                        }
                    }
                ],
                "identifier": [
                    {
                        "system": "http://pca.digitalhealth.gov.au/id/partner-service",
                        "value": "prs-843a6c2a8b2d46799edf27bb8903d3dc"
                    }
                ],
                "active": true,
                "providedBy": {
                    "reference": "Organization/org-96bea0f61e9c4e98b6803017f300d2a1"
                },
                "category": [
                    {
                        "coding": [
                            {
                                "system": "http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-partner-service-category",
                                "code": "SecureMessagingServices"
                            }
                        ]
                    }
                ],
                "name": "OB Secure messaging services",
                "comment": "Provide secure messaging services and directory",
                "coverageArea": [
                    {
                        "display": "All Postcodes"
                    }
                ]
            },
            "search": {
                "mode": "match"
            }
        },
        {
            "fullUrl": "https://pca-vendor-test.digitalhealth.gov.au/PcaFhirApi/v2/subscriber/org-6ac00cb80e4b4dbbabb489ee8a9c942b/fhir/HealthcareService/prs-df0ecab9f03e43cab623e4f63cc0fa5a",
            "resource": {
                "resourceType": "HealthcareService",
                "id": "prs-df0ecab9f03e43cab623e4f63cc0fa5a",
                "meta": {
                    "versionId": "1",
                    "lastUpdated": "2022-04-05T10:01:50.3646738+10:00"
                },
                "extension": [
                    {
                        "url": "http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-current-information-use-statement",
                        "valueReference": {
                            "reference": "Contract/ius-81b4ed8551ec4006a7fdadf7b86598a9"
                        }
                    }
                ],
                "identifier": [
                    {
                        "system": "http://pca.digitalhealth.gov.au/id/partner-service",
                        "value": "prs-df0ecab9f03e43cab623e4f63cc0fa5a"
                    }
                ],
                "active": true,
                "providedBy": {
                    "reference": "Organization/org-e09ccfda7bb347b29ae1305f9dc53a46"
                },
                "category": [
                    {
                        "coding": [
                            {
                                "system": "http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-partner-service-category",
                                "code": "SecureMessagingServices"
                            }
                        ]
                    }
                ],
                "name": "TH Secure Messaging",
                "comment": "Secure messaging service",
                "coverageArea": [
                    {
                        "display": "All Postcodes"
                    }
                ]
            },
            "search": {
                "mode": "match"
            }
        }
    ]
}

What is interesting to note here is the following:

• Request for _profile=http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-partner-service
• Request for filter of service-category=http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-partner-service-category|SecureMessagingServices
• A requesting system may use other filter expressions
• The response is a Bundle containing all new relevant partner services of type HealthcareService.
• This operation uses the FHIR paging pattern and which is denoted with the reference to page in the link url.
• extension – provides details on how to obtain the business partner service information use statement

 Home | Back: Create healthcare service | Next: Get information use statement