Guide
DG-3050
Status
Active
Version
1.0
Created
Updated
This is the current version.
Quick intro
The _count search parameter returns the number of requested resources per page (excluding the resources returned with _include search parameter) as requested by the client.
_count search parameter
The use of Paging to manage response times relating to the volume of data returned is done by the PCA server.
If the _count selected by the client is larger than the total per page size set by the PCA server, the PCA server setting will apply.
In the example below, the client has a set _count to 10. This represents the total number of matches, not how many resources are returned in a particular response.
The link attribute allows the subscriber system to traverse the bundle through the use of paging.
GET /PcaFhirApi/v2/subscriber/org-d754585791ce463a8d65f78d688918b8/fhir/?_type=HealthcareService,PractitionerRole,Organization,Location,Provenance,Contract,Practitioner&_lastUpdated=gt2019-11-18T15:56:48%2B11:00&_include=Location:organization&_include=HealthcareService:organization&_include=HealthcareService:location&_include=PractitionerRole:organization&_include=PractitionerRole:location&_include=PractitionerRole:service&_include=PractitionerRole:practitioner&_include=Provenance:target&_include=Contract:subject&_include:iterate=HealthcareService:organization&_include:iterate=HealthcareService:location&_include:iterate=PractitionerRole:organization&_include:iterate=PractitionerRole:location&_include:iterate=PractitionerRole:service&_include:iterate=PractitionerRole:practitioner&_count=10 HTTP/1.1
Authorization: Bearer 18.1654483847.123e2df9df8d4a6e9cc98c4c0ac27d22
User-Agent: PostmanRuntime/7.29.0
Accept: */*
Cache-Control: no-cache
Postman-Token: a82cdf79-60c6-4641-8fd9-fbf362def6a6
Host: pca-vendor-test.digitalhealth.gov.au
Accept-Encoding: gzip, deflate, br
Connection: keep-alive
Cookie: __cf_bm=KmSaxOlqke_4h_OJAyYC.PE7UymrHCRkdtb5l_j1ES4-1654483395-0-AVkihupq3QoIcSIaiFZI9+GeTikAZDj2dX8Tj9rByQUsWFX+TN4LHd6MJ3DHHvnhhyUa9Re9jqSFv38PSZL+3oo=
HTTP/1.1 200 OK
Date: Mon, 06 Jun 2022 02:47:16 GMT
Content-Type: application/fhir+json; charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive
Last-Modified: Mon, 06 Jun 2022 02:47:16 GMT
Location: Bundle/cb900176-e841-4b92-9553-992dc4c33706
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: 716dd2627de45515-SYD
{
"resourceType": "Bundle",
"id": "cb900176-e841-4b92-9553-992dc4c33706",
"type": "searchset",
"total": 93,
"link": [
{
"relation": "self",
"url": "https://pca-vendor-test.digitalhealth.gov.au/PcaFhirApi/v2/subscriber/org-d754585791ce463a8d65f78d688918b8/fhir?_type=HealthcareService,PractitionerRole,Organization,Location,Provenance,Contract,Practitioner&_lastUpdated=gt2019-11-18T15:56:48+11:00&_include=Location:organization&_include=HealthcareService:organization&_include=HealthcareService:location&_include=PractitionerRole:organization&_include=PractitionerRole:location&_include=PractitionerRole:service&_include=PractitionerRole:practitioner&_include=Provenance:target&_include=Contract:subject&_include:iterate=HealthcareService:organization&_include:iterate=HealthcareService:location&_include:iterate=PractitionerRole:organization&_include:iterate=PractitionerRole:location&_include:iterate=PractitionerRole:service&_include:iterate=PractitionerRole:practitioner&_count=10&_page=1&_resultId=b0eb555e-cc17-40e0-97d2-25bc6793305c"
},
{
"relation": "first",
"url": "https://pca-vendor-test.digitalhealth.gov.au/PcaFhirApi/v2/subscriber/org-d754585791ce463a8d65f78d688918b8/fhir?_type=HealthcareService,PractitionerRole,Organization,Location,Provenance,Contract,Practitioner&_lastUpdated=gt2019-11-18T15:56:48+11:00&_include=Location:organization&_include=HealthcareService:organization&_include=HealthcareService:location&_include=PractitionerRole:organization&_include=PractitionerRole:location&_include=PractitionerRole:service&_include=PractitionerRole:practitioner&_include=Provenance:target&_include=Contract:subject&_include:iterate=HealthcareService:organization&_include:iterate=HealthcareService:location&_include:iterate=PractitionerRole:organization&_include:iterate=PractitionerRole:location&_include:iterate=PractitionerRole:service&_include:iterate=PractitionerRole:practitioner&_count=10&_page=1&_resultId=b0eb555e-cc17-40e0-97d2-25bc6793305c"
},
{
"relation": "last",
"url": "https://pca-vendor-test.digitalhealth.gov.au/PcaFhirApi/v2/subscriber/org-d754585791ce463a8d65f78d688918b8/fhir?_type=HealthcareService,PractitionerRole,Organization,Location,Provenance,Contract,Practitioner&_lastUpdated=gt2019-11-18T15:56:48+11:00&_include=Location:organization&_include=HealthcareService:organization&_include=HealthcareService:location&_include=PractitionerRole:organization&_include=PractitionerRole:location&_include=PractitionerRole:service&_include=PractitionerRole:practitioner&_include=Provenance:target&_include=Contract:subject&_include:iterate=HealthcareService:organization&_include:iterate=HealthcareService:location&_include:iterate=PractitionerRole:organization&_include:iterate=PractitionerRole:location&_include:iterate=PractitionerRole:service&_include:iterate=PractitionerRole:practitioner&_count=10&_page=10&_resultId=b0eb555e-cc17-40e0-97d2-25bc6793305c"
},
{
"relation": "next",
"url": "https://pca-vendor-test.digitalhealth.gov.au/PcaFhirApi/v2/subscriber/org-d754585791ce463a8d65f78d688918b8/fhir?_type=HealthcareService,PractitionerRole,Organization,Location,Provenance,Contract,Practitioner&_lastUpdated=gt2019-11-18T15:56:48+11:00&_include=Location:organization&_include=HealthcareService:organization&_include=HealthcareService:location&_include=PractitionerRole:organization&_include=PractitionerRole:location&_include=PractitionerRole:service&_include=PractitionerRole:practitioner&_include=Provenance:target&_include=Contract:subject&_include:iterate=HealthcareService:organization&_include:iterate=HealthcareService:location&_include:iterate=PractitionerRole:organization&_include:iterate=PractitionerRole:location&_include:iterate=PractitionerRole:service&_include:iterate=PractitionerRole:practitioner&_count=10&_page=2&_resultId=b0eb555e-cc17-40e0-97d2-25bc6793305c"
}
],
"entry": [
{
"fullUrl": "https://pca-vendor-test.digitalhealth.gov.au/PcaFhirApi/v2/subscriber/org-d754585791ce463a8d65f78d688918b8/fhir/HealthcareService/hcs-1525d14d9c794d1ba5f17cdcf7f79d2e",
"resource": {
"resourceType": "HealthcareService",
"id": "hcs-1525d14d9c794d1ba5f17cdcf7f79d2e",
"meta": {
"versionId": "0",
"lastUpdated": "2022-05-11T05:45:03.184987+00:00"
},
"extension": [
{
"url": "http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-postal-address",
"valueAddress": {
"extension": [
{
"url": "http://hl7.org.au/fhir/StructureDefinition/address-identifier",
"valueIdentifier": {
"type": {
"coding": [
{
"system": "http://terminology.hl7.org.au/CodeSystem/v2-0203",
"code": "GNAF"
}
]
},
"system": "http://hl7.org.au/id/gnafidentifier",
"value": "GANSW718473771"
}
}
],
"use": "work",
"type": "postal",
"line": [
"",
"Shop 8",
"147-153 Castlereagh Street"
],
"city": "SYDNEY",
"state": "NSW",
"postalCode": "2000",
"country": "AU"
}
}
],
"identifier": [
.......trimmed for brevityHome | Back: Synchronisation | Next: Include and iterate