FHIRsmith: CapabilityStatement/CapabilityStatement-health-connect-provider-directory-requester.json

FHIR IG analytics

Package	au.digitalhealth.r4.healthconnect
Resource Type	CapabilityStatement
Id	CapabilityStatement-health-connect-provider-directory-requester.json
FHIR Version	R4
Source	https://build.fhir.org/ig/AuDigitalHealth/HealthConnect/CapabilityStatement-health-connect-provider-directory-requester.html
URL	http://ns.electronichealth.net.au/hc/CapabilityStatement/health-connect-provider-directory-requester
Version	0.2.0-preview
Status	draft
Date	2025-11-27
Name	HealthConnectProviderDirectoryRequester
Title	Health Connect Provider Directory Requester
Realm	au
Authority	national
Description	This [CapabilityStatement](https://hl7.org/fhir/R4/capabilitystatement.html) resource defines the expected capabilities of the [Health Connect Provider Directory Requester Actor](ActorDefinition-requester-actor-health-connect.html) when conforming to this implementation guide. The complete list of FHIR profiles, RESTful operations, and search parameters supported by Health Connect Provider Directory Requester Actor are defined in this CapabilityStatement. The requirements of the Health Connect Provider Directory Requester actor may also be impacted by the rules of local jurisdictions or other contextual requirements.
Copyright	Copyright © 2025 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See [https://creativecommons.org/licenses/by/4.0/](https://creativecommons.org/licenses/by/4.0/)
Kind	requirements

Resources that use this resource

No resources found

Resources that this resource uses

SearchParameter
gender-identity	GenderIdentity
allday	SearchParameterAllDay
daysofweek	SearchParameterDaysOfWeek
endpoint-hcepi	SearchParameterEndpointIdentifierHC
endpoint-payloadmimetype	SearchParameterEndpointPayloadMimeType
endpoint-url	SearchParameterEndpointUrl
endtime	SearchParameterEndTime
healthcareservice-billing	SearchParameterHealthcareServiceBilling
languages	SearchParameterLanguages
location-amenities	SearchParameterLocationAmenities
location-locmailaddress	SearchParameterLocationPostalAddress
location-physicaltype	SearchParameterLocationPhysicalType
practitioner-identifier-r5	SearchParameterPractitionerIdentifierR5
practitioner-regprof	SearchParameterPractitionerRegProf
practitioner-rsg	SearchParameterPractitionerRSG
starttime	SearchParameterStartTime

StructureDefinition
hc-endpoint	HC Endpoint
hc-healthcareservice	HC HealthcareService
hc-location	HC Location
hc-organization	HC Organization
hc-practitioner	HC Practitioner
hc-practitionerrole	HC PractitionerRole
hc-provenance	HC Provenance

Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: CapabilityStatement health-connect-provider-directory-requester

Health Connect Provider Directory Requester

Implementation Guide Version: 0.2.0-preview
FHIR Version: 4.0.1
Supported Formats: SHALL support json, SHOULD support xml
Published on: 2025-11-27
Published by: Australian Digital Health Agency

Note to Implementers: FHIR Capabilities
Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

FHIR RESTful Capabilities

Mode: `client`

Security

Enable CORS: no

Security services supported: OAuth

All interactions SHOULD be secured using OAuth protocols. It SHOULD support authentication, authorisation, and audit logging in accordance with local policy and regulatory requirements.

Summary of System-wide Interactions

Supports the search-systeminteraction described as follows:
Definition:

This operation is a RESTful search interaction (whole system interaction), across multiple resource types (as described in the FHIR specification).

Behaviour:

This operation is used by a client system operated by a Health Connect Provider Directory Requester to get resources that match the specified search parameters. .

The following search parameters are supported:
- _lastUpdated is used to get the resources that have been added or changed since the requesting system last synchronised their local data store with Health Connect Provider Directory Requester. This search parameter supports the gt and lt comparison prefixes.
- _type is used to filter the resources returned by their resource type. The available types are:
  - HealthcareService (returns resources conforming to the HC Healthcare Service profile)
  - PractitionerRole (returns resources conforming to the HC Practitioner Role profile)
  - Organization (returns resources conforming to the HC Organization profile)
  - Location (returns resources conforming to the HC Location profile)
  - Practitioner (returns resources conforming to the HC Practitioner profile)
  - Provenance (returns resources conforming to the HC Provenance profile)
All of the following query parameters are required in order to receive the complete set of resources that have been created, changed or published since [last_synchronized]:

_lastUpdated=[last_synchronized]

_type=HealthcareService,PractitionerRole,Practitioner,Organization,Location,Provenance

_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:iterate=HealthcareService:organization

_include:iterate=HealthcareService:location

_include:iterate=PractitionerRole:organization

_include:iterate=PractitionerRole:location

_include:iterate=PractitionerRole:service

_include:iterate=PractitionerRole:practitioner

As described above the resources returned in the Bundle exclude any Identifiers (e.g. HPI-Is) that cannot be disclosed to the subscriber.

This operation supports 'paging' (see FHIR specification). If there are too many resources to return in one Bundle, the FHIR server adds a next link to the response Bundle. The contents of the result Bundle therefore comprise all instances of the requested resource types whose lastUpdated timestamp is greater than the <lastSync> in the request query expression and less than or equal to <lastInBundle> where <lastInBundle> is the greatest lastUpdated value of all resources included in the result Bundle. The Subscriber Agent FHIR server sets the next link to the filter expression that was used in the original request except that <lastSync> is replaced with <lastInBundle>. If the next link is not present in the Bundle, then there are no more service offerings available.

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

The relevant profiles (if any)
The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
The required, recommended, and some optional search parameters (if any).
The linked resources enabled for _include
The other resources enabled for _revinclude
The operations on the resource (if any)

Resource Type	Profile	R	S	Searches	`_include`	`_revinclude`
Provenance	http://ns.electronichealth.net.au/hc/StructureDefinition/hc-provenance\|0.2.0-preview	y	y	target	`Provenance:target`
Organization	http://ns.electronichealth.net.au/hc/StructureDefinition/hc-organization\|0.2.0-preview	y	y	identifier, name, type	`Organization:partOf`	`Location:organization`, `Provenance:target`
Location	http://ns.electronichealth.net.au/hc/StructureDefinition/hc-location\|0.2.0-preview	y	y	locmailaddress, locationamenities, name, address, type, locationphysicaltype, near	`Location:organization`, `Location:endpoint`	`HealthcareService:location`, `Provenance:target`
HealthcareService	http://ns.electronichealth.net.au/hc/StructureDefinition/hc-healthcareservice\|0.2.0-preview	y	y	languages, hsbilling, allday, daysofweek, starttime, endtime, service-type	`HealthcareService:location`, `HealthcareService:organization`, `HealthcareService:endpoint`	`PractitionerRole:service`, `Provenance:target`
PractitionerRole	http://ns.electronichealth.net.au/hc/StructureDefinition/hc-practitionerrole\|0.2.0-preview	y	y	languages, allday, daysofweek, starttime, endtime, identifier, role	`PractitionerRole:practitioner`, `PractitionerRole:service`, `PractitionerRole:organization`, `PractitionerRole:location`, `PractitionerRole:endpoint`	`Provenance:target`
Practitioner	http://ns.electronichealth.net.au/hc/StructureDefinition/hc-practitioner\|0.2.0-preview	y	y	identifier, regprof, rsg, genderIdentity, name, identifier-r5		`PractitionerRole:practitioner`, `Provenance:target`
Endpoint	http://ns.electronichealth.net.au/hc/StructureDefinition/hc-endpoint\|0.2.0-preview	y	y	epurl, payloadmimetype, hcepi, name, connection-type, payload-type		`HealthcareService:endpoint`, `Location:endpoint`, `PractitionerRole:endpoint`, `Provenance:target`

Resource Conformance: SHOULD Provenance

Base System Profile
HC Provenanceversion: 0.2.0-preview)

Profile Conformance
SHOULD

Reference Policy

Interaction summary

Supports
read
Read HC Provenance records to understand data lineage

search-type
Search for HC Provenance records by target resource

Documentation

This resource is used to track the provenance of data retrieved, updated, or verified from external systems of record for HC resources.

Search Parameters

Conformance	Parameter	Type	Documentation
SHOULD	target	`reference`

Resource Conformance: SHOULD Organization

Base System Profile
HC Organizationversion: 0.2.0-preview)

Profile Conformance
SHALL

Reference Policy

Interaction summary

Supports read, search-type.

Documentation

This section defines the supported interactions by a Requester Actor for the HC Organization profile of the Organization resource type.

Search Parameters

Conformance	Parameter	Type
SHOULD	identifier	`token`
SHOULD	name	`string`
SHOULD	type	`token`

Resource Conformance: SHOULD Location

Base System Profile
HC Locationversion: 0.2.0-preview)

Profile Conformance
SHOULD

Reference Policy

Interaction summary

Supports read, search-type.

Documentation

This section introduces the supported interactions by a Requester Actor for the HC Location profile.

Search Parameters

Conformance	Parameter	Type
SHOULD	locmailaddress	`string`
SHOULD	locationamenities	`token`
SHOULD	name	`string`
SHOULD	address	`string`
SHOULD	type	`token`
SHOULD	locationphysicaltype	`token`
SHOULD	near	`special`

Resource Conformance: SHOULD HealthcareService

Base System Profile
HC HealthcareServiceversion: 0.2.0-preview)

Profile Conformance
SHOULD

Reference Policy

Interaction summary

Supports read, search-type.

Documentation

This section introduces the supported interactions by a Requester Actor for the HC Healthcare Service profile.

Search Parameters

Conformance	Parameter	Type
SHOULD	languages	`token`
SHOULD	hsbilling	`token`
SHOULD	allday	`token`
SHOULD	daysofweek	`token`
SHOULD	starttime	`number`
SHOULD	endtime	`number`
SHOULD	service-type	`token`

Resource Conformance: SHOULD PractitionerRole

Base System Profile
HC PractitionerRoleversion: 0.2.0-preview)

Profile Conformance
SHOULD

Reference Policy

Interaction summary

Supports read, search-type.

Documentation

This section defines the supported interactions for the HC Practitioner Role profile of the PractitionerRole resource type. Each PractitionerRole resource conforming to the HC Practitioner Role profile describes a practitioner in a role at a healthcare service.

Search Parameters

Conformance	Parameter	Type
SHOULD	languages	`token`
SHOULD	allday	`token`
SHOULD	daysofweek	`token`
SHOULD	starttime	`number`
SHOULD	endtime	`number`
SHOULD	identifier	`token`
SHOULD	role	`token`

Resource Conformance: SHOULD Practitioner

Base System Profile
HC Practitionerversion: 0.2.0-preview)

Profile Conformance
SHALL

Reference Policy

Interaction summary

Supports read, search-type.

Documentation

This section defines the supported interactions for the HC Practitioner profile of the Practitioner resource type.

Search Parameters

Conformance	Parameter	Type
SHOULD	identifier	`token`
SHOULD	regprof	`string`
SHOULD	rsg	`token`
SHOULD	genderIdentity	`token`
SHOULD	name	`string`
SHOULD	identifier-r5	`token`

Resource Conformance: SHOULD Endpoint

Base System Profile
HC Endpointversion: 0.2.0-preview)

Profile Conformance
SHOULD

Reference Policy

Interaction summary

Supports read, search-type.

Documentation

This section defines the supported interactions for the HC Endpoint profile of the Endpoint resource type. Each Endpoint resource conforming to the HC Endpoint profile is a read-only proxy for a corresponding Endpoint resource published by the HC portal.

Search Parameters

Conformance	Parameter	Type
SHOULD	epurl	`uri`
SHOULD	payloadmimetype	`token`
SHOULD	hcepi	`token`
SHOULD	name	`string`
SHOULD	connection-type	`token`
SHOULD	payload-type	`token`

Source1

{
  "resourceType": "CapabilityStatement",
  "id": "health-connect-provider-directory-requester",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode": "draft",
      "_valueCode": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical": "http://ns.electronichealth.net.au/hc/ImplementationGuide/au.digitalhealth.r4.healthconnect"
          }
        ]
      }
    }
  ],
  "url": "http://ns.electronichealth.net.au/hc/CapabilityStatement/health-connect-provider-directory-requester",
  "version": "0.2.0-preview",
  "name": "HealthConnectProviderDirectoryRequester",
  "title": "Health Connect Provider Directory Requester",
  "status": "draft",
  "date": "2025-11-27",
  "publisher": "Australian Digital Health Agency",
  "contact": [
    {
      "name": "Australian Digital Health Agency",
      "telecom": [
        {
          "system": "url",
          "value": "https://www.digitalhealth.gov.au/"
        },
        {
          "system": "email",
          "value": "help@digitalhealth.gov.au"
        }
      ]
    },
    {
      "name": "Australian Digital Health Agency",
      "telecom": [
        {
          "system": "email",
          "value": "mailto:help@digitalhealth.gov.au",
          "use": "work"
        }
      ]
    }
  ],
  "description": "This [CapabilityStatement](https://hl7.org/fhir/R4/capabilitystatement.html) resource defines the expected capabilities \nof the [Health Connect Provider Directory Requester Actor](ActorDefinition-requester-actor-health-connect.html) when conforming to this implementation guide. The complete \nlist of FHIR profiles, RESTful operations, and search parameters supported by Health Connect Provider Directory Requester Actor are defined in this CapabilityStatement. \nThe requirements of the Health Connect Provider Directory Requester actor may also be impacted by the rules of local jurisdictions or other contextual requirements.",
  "useContext": [
    {
      "code": {
        "system": "http://terminology.hl7.org/CodeSystem/usage-context-type",
        "code": "jurisdiction"
      },
      "valueCodeableConcept": {
        "coding": [
          {
            "system": "urn:iso:std:iso:3166",
            "code": "AU",
            "display": "Australia"
          }
        ]
      }
    }
  ],
  "copyright": "Copyright © 2025 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See [https://creativecommons.org/licenses/by/4.0/](https://creativecommons.org/licenses/by/4.0/)",
  "kind": "requirements",
  "fhirVersion": "4.0.1",
  "format": [
    "json",
    "xml"
  ],
  "_format": [
    {
      "extension": [
        {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        }
      ]
    },
    {
      "extension": [
        {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        }
      ]
    }
  ],
  "rest": [
    {
      "mode": "client",
      "security": {
        "service": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/restful-security-service",
                "code": "OAuth",
                "display": "OAuth"
              }
            ]
          }
        ],
        "description": "All interactions SHOULD be secured using OAuth protocols. It SHOULD support authentication, authorisation, and audit logging in accordance with local policy and regulatory requirements."
      },
      "resource": [
        {
          "type": "Provenance",
          "profile": "http://ns.electronichealth.net.au/hc/StructureDefinition/hc-provenance|0.2.0-preview",
          "_profile": {
            "extension": [
              {
                "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                "valueCode": "SHOULD"
              }
            ]
          },
          "documentation": "This resource is used to track the provenance of data retrieved, updated, or verified from external systems of record for HC resources.",
          "interaction": [
            {
              "code": "read",
              "documentation": "Read HC Provenance records to understand data lineage"
            },
            {
              "code": "search-type",
              "documentation": "Search for HC Provenance records by target resource"
            }
          ],
          "versioning": "versioned",
          "readHistory": false,
          "searchInclude": [
            "Provenance:target"
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "target",
              "definition": "http://hl7.org/fhir/SearchParameter/Provenance-target|4.0.1",
              "type": "reference"
            }
          ]
        },
        {
          "type": "Organization",
          "profile": "http://ns.electronichealth.net.au/hc/StructureDefinition/hc-organization|0.2.0-preview",
          "_profile": {
            "extension": [
              {
                "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                "valueCode": "SHALL"
              }
            ]
          },
          "documentation": "This section defines the supported interactions by a Requester Actor for the HC Organization profile of the Organization resource type.",
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "search-type"
            }
          ],
          "versioning": "versioned",
          "searchInclude": [
            "Organization:partOf"
          ],
          "searchRevInclude": [
            "Location:organization",
            "Provenance:target"
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "identifier",
              "definition": "http://hl7.org/fhir/SearchParameter/Organization-identifier|4.0.1",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "name",
              "definition": "http://hl7.org/fhir/SearchParameter/Organization-name|4.0.1",
              "type": "string"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "type",
              "definition": "http://hl7.org/fhir/SearchParameter/Organization-type|4.0.1",
              "type": "token"
            }
          ]
        },
        {
          "type": "Location",
          "profile": "http://ns.electronichealth.net.au/hc/StructureDefinition/hc-location|0.2.0-preview",
          "_profile": {
            "extension": [
              {
                "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                "valueCode": "SHOULD"
              }
            ]
          },
          "documentation": "This section introduces the supported interactions by a Requester Actor for the HC Location profile.",
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "search-type"
            }
          ],
          "versioning": "versioned",
          "searchInclude": [
            "Location:organization",
            "Location:endpoint"
          ],
          "searchRevInclude": [
            "HealthcareService:location",
            "Provenance:target"
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "locmailaddress",
              "definition": "http://ns.electronichealth.net.au/hc/SearchParameter/location-locmailaddress|0.2.0-preview",
              "type": "string"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "locationamenities",
              "definition": "http://ns.electronichealth.net.au/hc/SearchParameter/location-amenities|0.2.0-preview",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "name",
              "definition": "http://hl7.org/fhir/SearchParameter/Location-name|4.0.1",
              "type": "string"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "address",
              "definition": "http://hl7.org/fhir/SearchParameter/Location-address|4.0.1",
              "type": "string"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "type",
              "definition": "http://hl7.org/fhir/SearchParameter/Location-type|4.0.1",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "locationphysicaltype",
              "definition": "http://ns.electronichealth.net.au/hc/SearchParameter/location-physicaltype|0.2.0-preview",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "near",
              "definition": "http://hl7.org/fhir/SearchParameter/Location-near|4.0.1",
              "type": "special"
            }
          ]
        },
        {
          "type": "HealthcareService",
          "profile": "http://ns.electronichealth.net.au/hc/StructureDefinition/hc-healthcareservice|0.2.0-preview",
          "_profile": {
            "extension": [
              {
                "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                "valueCode": "SHOULD"
              }
            ]
          },
          "documentation": "This section introduces the supported interactions by a Requester Actor for the [HC Healthcare Service](StructureDefinition-hc-healthcareservice.html) profile.",
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "search-type"
            }
          ],
          "searchInclude": [
            "HealthcareService:location",
            "HealthcareService:organization",
            "HealthcareService:endpoint"
          ],
          "searchRevInclude": [
            "PractitionerRole:service",
            "Provenance:target"
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "languages",
              "definition": "http://ns.electronichealth.net.au/hc/SearchParameter/languages|0.2.0-preview",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "hsbilling",
              "definition": "http://ns.electronichealth.net.au/hc/SearchParameter/healthcareservice-billing|0.2.0-preview",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "allday",
              "definition": "http://ns.electronichealth.net.au/hc/SearchParameter/allday|0.2.0-preview",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "daysofweek",
              "definition": "http://ns.electronichealth.net.au/hc/SearchParameter/daysofweek|0.2.0-preview",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "starttime",
              "definition": "http://ns.electronichealth.net.au/hc/SearchParameter/starttime|0.2.0-preview",
              "type": "number"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "endtime",
              "definition": "http://ns.electronichealth.net.au/hc/SearchParameter/endtime|0.2.0-preview",
              "type": "number"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "service-type",
              "definition": "http://hl7.org/fhir/SearchParameter/HealthcareService-service-type|4.0.1",
              "type": "token"
            }
          ]
        },
        {
          "type": "PractitionerRole",
          "profile": "http://ns.electronichealth.net.au/hc/StructureDefinition/hc-practitionerrole|0.2.0-preview",
          "_profile": {
            "extension": [
              {
                "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                "valueCode": "SHOULD"
              }
            ]
          },
          "documentation": "This section defines the supported interactions for the [HC Practitioner Role](StructureDefinition-hc-practitionerrole.html) profile of the PractitionerRole resource type. Each PractitionerRole resource conforming to the [HC Practitioner Role](StructureDefinition-hc-practitionerrole.html) profile describes a practitioner in a role at a healthcare service.",
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "search-type"
            }
          ],
          "searchInclude": [
            "PractitionerRole:practitioner",
            "PractitionerRole:service",
            "PractitionerRole:organization",
            "PractitionerRole:location",
            "PractitionerRole:endpoint"
          ],
          "searchRevInclude": [
            "Provenance:target"
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "languages",
              "definition": "http://ns.electronichealth.net.au/hc/SearchParameter/languages|0.2.0-preview",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "allday",
              "definition": "http://ns.electronichealth.net.au/hc/SearchParameter/allday|0.2.0-preview",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "daysofweek",
              "definition": "http://ns.electronichealth.net.au/hc/SearchParameter/daysofweek|0.2.0-preview",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "starttime",
              "definition": "http://ns.electronichealth.net.au/hc/SearchParameter/starttime|0.2.0-preview",
              "type": "number"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "endtime",
              "definition": "http://ns.electronichealth.net.au/hc/SearchParameter/endtime|0.2.0-preview",
              "type": "number"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "identifier",
              "definition": "http://hl7.org/fhir/SearchParameter/PractitionerRole-identifier|4.0.1",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "role",
              "definition": "http://hl7.org/fhir/SearchParameter/PractitionerRole-role|4.0.1",
              "type": "token"
            }
          ]
        },
        {
          "type": "Practitioner",
          "profile": "http://ns.electronichealth.net.au/hc/StructureDefinition/hc-practitioner|0.2.0-preview",
          "_profile": {
            "extension": [
              {
                "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                "valueCode": "SHALL"
              }
            ]
          },
          "documentation": "This section defines the supported interactions for the [HC Practitioner](StructureDefinition-hc-practitioner.html) profile of the Practitioner resource type.",
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "search-type"
            }
          ],
          "searchRevInclude": [
            "PractitionerRole:practitioner",
            "Provenance:target"
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "identifier",
              "definition": "http://hl7.org/fhir/SearchParameter/Practitioner-identifier|4.0.1",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "regprof",
              "definition": "http://ns.electronichealth.net.au/hc/SearchParameter/practitioner-regprof|0.2.0-preview",
              "type": "string"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "rsg",
              "definition": "http://ns.electronichealth.net.au/hc/SearchParameter/practitioner-rsg|0.2.0-preview",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "genderIdentity",
              "definition": "http://hl7.org.au/fhir/SearchParameter/gender-identity|6.0.0-ballot",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "name",
              "definition": "http://hl7.org/fhir/SearchParameter/Practitioner-name|4.0.1",
              "type": "string"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "identifier-r5",
              "definition": "http://ns.electronichealth.net.au/hc/SearchParameter/practitioner-identifier-r5|0.2.0-preview",
              "type": "token"
            }
          ]
        },
        {
          "type": "Endpoint",
          "profile": "http://ns.electronichealth.net.au/hc/StructureDefinition/hc-endpoint|0.2.0-preview",
          "_profile": {
            "extension": [
              {
                "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                "valueCode": "SHOULD"
              }
            ]
          },
          "documentation": "This section defines the supported interactions for the [HC Endpoint](StructureDefinition-hc-endpoint.html) profile of the Endpoint resource type. Each Endpoint resource conforming to the [HC Endpoint](StructureDefinition-hc-endpoint.html) profile is a read-only proxy for a corresponding Endpoint resource published by the HC portal.",
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "search-type"
            }
          ],
          "versioning": "versioned",
          "searchRevInclude": [
            "HealthcareService:endpoint",
            "Location:endpoint",
            "PractitionerRole:endpoint",
            "Provenance:target"
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "epurl",
              "definition": "http://ns.electronichealth.net.au/hc/SearchParameter/endpoint-url|0.2.0-preview",
              "type": "uri"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "payloadmimetype",
              "definition": "http://ns.electronichealth.net.au/hc/SearchParameter/endpoint-payloadmimetype|0.2.0-preview",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "hcepi",
              "definition": "http://ns.electronichealth.net.au/hc/SearchParameter/endpoint-hcepi|0.2.0-preview",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "name",
              "definition": "http://hl7.org/fhir/SearchParameter/Endpoint-name|4.0.1",
              "type": "string"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "connection-type",
              "definition": "http://hl7.org/fhir/SearchParameter/Endpoint-connection-type|4.0.1",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "payload-type",
              "definition": "http://hl7.org/fhir/SearchParameter/Endpoint-payload-type|4.0.1",
              "type": "token"
            }
          ]
        }
      ],
      "interaction": [
        {
          "code": "search-system",
          "documentation": "**Definition**:\r\n    \n This operation is a RESTful *search* interaction (whole system interaction), across multiple resource types (as described in the [FHIR specification](https://www.hl7.org/fhir/http.html#search)). \r\n    \n\r\n    \n **Behaviour**:\r\n    \n This operation is used by a client system operated by a Health Connect Provider Directory Requester to get resources that match the specified search parameters. .\r\n    \n\r\n    \n The following  search parameters are supported:\r\n    \n\r\n    \n * *_lastUpdated* is used to get the resources that have been added or changed since the requesting system last synchronised their local data store with Health Connect Provider Directory Requester.  This search parameter supports the ```gt``` and ```lt``` comparison prefixes.\r\n    \n * *_type* is used to filter the resources returned by their resource type. The available types are: \r\n    \n\r\n    \n   * ```HealthcareService``` (returns resources conforming to the [HC Healthcare Service](StructureDefinition-hc-healthcareservice.html) profile)\r\n    \n   * ```PractitionerRole``` (returns resources conforming to the [HC Practitioner Role](StructureDefinition-hc-practitionerrole.html) profile)\r\n    \n   * ```Organization``` (returns resources conforming to the [HC Organization](StructureDefinition-hc-organization.html) profile)\r\n    \n   * ```Location``` (returns resources conforming to the [HC Location](StructureDefinition-hc-location.html) profile)\r\n    \n   * ```Practitioner``` (returns resources conforming to the [HC Practitioner](StructureDefinition-hc-practitioner.html) profile)\r\n    \n   * ```Provenance``` (returns resources conforming to the [HC Provenance](StructureDefinition-hc-provenance.html) profile)\r\n    \n   \r\n    \n \r\n    \n All of the following query parameters are required in order to receive the complete set of resources that have been created, changed or published since *[last_synchronized]*:\r\n    \n\r\n    \n ``` _lastUpdated=[last_synchronized] ```\r\n    \n ```_type=HealthcareService,PractitionerRole,Practitioner,Organization,Location,Provenance ```\r\n    \n ```_include=Location:organization ```\r\n    \n ```_include=HealthcareService:organization ```\r\n    \n ```_include=HealthcareService:location ```\r\n    \n ```_include=PractitionerRole:organization ```\r\n    \n ```_include=PractitionerRole:location ```  \r\n    \n ```_include=PractitionerRole:service ```\r\n    \n ```_include=PractitionerRole:practitioner ``` \r\n    \n ```_include=Provenance:target ```   \r\n    \n ```_include:iterate=HealthcareService:organization  ```  \r\n    \n ```_include:iterate=HealthcareService:location ```\r\n    \n ```_include:iterate=PractitionerRole:organization ```\r\n    \n ```_include:iterate=PractitionerRole:location ```\r\n    \n ```_include:iterate=PractitionerRole:service ```\r\n    \n ```_include:iterate=PractitionerRole:practitioner ```\r\n    \n \r\n    \n As described above the resources returned in the Bundle exclude any *Identifiers* (e.g. HPI-Is) that cannot be disclosed to the subscriber.\r\n    \n \r\n    \n This operation supports 'paging' ([see FHIR specification](https://www.hl7.org/fhir/search.html#Paging)).  If there are too many resources to return in one ```Bundle```, the FHIR server adds a *next* link to the response ```Bundle```. The contents of the result ```Bundle``` therefore comprise all instances of the requested resource types whose *lastUpdated* timestamp is greater than the \\<lastSync\\> in the request query expression and less than or equal to \\<lastInBundle\\> where \\<lastInBundle\\> is the greatest *lastUpdated* value of all resources included in the result ```Bundle```. The Subscriber Agent FHIR server sets the *next* link to the filter expression that was used in the original request except that \\<lastSync\\> is replaced with \\<lastInBundle\\>. If the *next* link is not present in the Bundle, then there are no more service offerings available.    "
        }
      ],
      "searchParam": [
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHOULD"
            }
          ],
          "name": "_lastUpdated",
          "definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated|4.0.1",
          "type": "date"
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHOULD"
            }
          ],
          "name": "_type",
          "type": "token"
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHOULD"
            }
          ],
          "name": "_include",
          "type": "special"
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHOULD"
            }
          ],
          "name": "_resultId",
          "type": "special"
        }
      ]
    }
  ]
}

FHIR IG analytics

Resources that use this resource

Resources that this resource uses

Narrative

Health Connect Provider Directory Requester

FHIR RESTful Capabilities

Mode: client

Capabilities by Resource/Profile

Summary

Resource Conformance: SHOULD Provenance

Resource Conformance: SHOULD Organization

Resource Conformance: SHOULD Location

Resource Conformance: SHOULD HealthcareService

Resource Conformance: SHOULD PractitionerRole

Resource Conformance: SHOULD Practitioner

Resource Conformance: SHOULD Endpoint

Source1

Mode: `client`