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

FHIR IG analytics

Package	au.gov.digitalhealth.hcpd
Resource Type	CapabilityStatement
Id	CapabilityStatement-health-connect-provider-directory-requester.json
FHIR Version	R4
Source	https://build.fhir.org/ig/AuDigitalHealth/HCPD-Snapshot-26.0.0-SPARKED-Testing-20260708/CapabilityStatement-health-connect-provider-directory-requester.html
URL	http://digitalhealth.gov.au/fhir/hcpd/CapabilityStatement/health-connect-provider-directory-requester
Version	26.0.0
Status	active
Date	2026-03-31
Name	HealthConnectProviderDirectoryRequester
Title	Health Connect Provider Directory Requester
Realm	au
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	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
au.gov.digitalhealth.hcpd#current	allday	SearchParameterAllDay
au.gov.digitalhealth.hcpd#current	daysofweek	SearchParameterDaysOfWeek
au.gov.digitalhealth.hcpd#current	endpoint-hcepi	SearchParameterEndpointIdentifierHC
au.gov.digitalhealth.hcpd#current	endpoint-payloadmimetype	SearchParameterEndpointPayloadMimeType
au.gov.digitalhealth.hcpd#current	endpoint-url	SearchParameterEndpointUrl
au.gov.digitalhealth.hcpd#current	endtime	SearchParameterEndTime
au.gov.digitalhealth.hcpd#current	healthcareservice-billing	SearchParameterHealthcareServiceBilling
au.gov.digitalhealth.hcpd#current	languages	SearchParameterLanguages
au.gov.digitalhealth.hcpd#current	location-amenities	SearchParameterLocationAmenities
au.gov.digitalhealth.hcpd#current	location-locmailaddress	SearchParameterAlternatePostalAddress
au.gov.digitalhealth.hcpd#current	location-physicaltype	SearchParameterLocationPhysicalType
au.gov.digitalhealth.hcpd#current	practitioner-identifier-r5	SearchParameterPractitionerIdentifierR5
au.gov.digitalhealth.hcpd#current	practitioner-regprof	SearchParameterPractitionerRegProf
au.gov.digitalhealth.hcpd#current	practitioner-rsg	SearchParameterPractitionerRSG
au.gov.digitalhealth.hcpd#current	starttime	SearchParameterStartTime
au.gov.digitalhealth.hcpd#current	suppressed	SearchParameterSuppressedBy

StructureDefinition
au.gov.digitalhealth.hcpd#current	hcpd-endpoint	HCPD Endpoint
au.gov.digitalhealth.hcpd#current	hcpd-healthcareservice	HCPD HealthcareService
au.gov.digitalhealth.hcpd#current	hcpd-location	HCPD Location
au.gov.digitalhealth.hcpd#current	hcpd-organization	HCPD Organization
au.gov.digitalhealth.hcpd#current	hcpd-practitioner	HCPD Practitioner
au.gov.digitalhealth.hcpd#current	hcpd-practitionerrole	HCPD PractitionerRole
au.gov.digitalhealth.hcpd#current	hcpd-provenance	HCPD 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: 26.0.0
FHIR Version: 4.0.1
Supported Formats: SHALL support json, SHOULD support xml
Published on: 2026-03-31
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.

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://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-provenance\|26.0.0	y	y	target	`Provenance:target`
Organization	http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-organization\|26.0.0	y	y	identifier, name, type, active, suppressed	`Organization:partOf`	`Location:organization`, `Provenance:target`
Location	http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-location\|26.0.0	y	y	locmailaddress, locationamenities, name, address, type, locationphysicaltype, near, status, suppressed	`Location:organization`, `Location:endpoint`	`HealthcareService:location`, `Provenance:target`
HealthcareService	http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-healthcareservice\|26.0.0	y	y	languages, hsbilling, allday, daysofweek, starttime, endtime, service-type, active, suppressed	`HealthcareService:location`, `HealthcareService:organization`, `HealthcareService:endpoint`	`PractitionerRole:service`, `Provenance:target`
PractitionerRole	http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-practitionerrole\|26.0.0	y	y	languages, allday, daysofweek, starttime, endtime, identifier, role, active, suppressed	`PractitionerRole:practitioner`, `PractitionerRole:service`, `PractitionerRole:organization`, `PractitionerRole:location`, `PractitionerRole:endpoint`	`Provenance:target`
Practitioner	http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-practitioner\|26.0.0	y	y	identifier, regprof, rsg, name, identifier-r5, active, suppressed		`PractitionerRole:practitioner`, `Provenance:target`
Endpoint	http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-endpoint\|26.0.0	y	y	epurl, payloadmimetype, hcepi, name, connection-type, payload-type, status, suppressed		`HealthcareService:endpoint`, `Location:endpoint`, `PractitionerRole:endpoint`, `Provenance:target`

Resource Conformance: SHOULD Provenance

Base System Profile
HCPD Provenanceversion: 26.0.0)

Profile Conformance
SHALL

Reference Policy

Interaction summary

Supports
read
Read HCPD Provenance records to understand data lineage

search-type
Search for HCPD 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: SHALL Organization

Base System Profile
HCPD Organizationversion: 26.0.0)

Profile Conformance
SHALL

Reference Policy

Interaction summary

Supports read, search-type.

Documentation

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

Search Parameters

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

Resource Conformance: SHOULD Location

Base System Profile
HCPD Locationversion: 26.0.0)

Profile Conformance
SHALL

Reference Policy

Interaction summary

Supports read, search-type.

Documentation

This section introduces the supported interactions by a Requester Actor for the HCPD 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`
SHOULD	status	`token`
SHOULD	suppressed	`token`

Resource Conformance: SHOULD HealthcareService

Base System Profile
HCPD HealthcareServiceversion: 26.0.0)

Profile Conformance
SHALL

Reference Policy

Interaction summary

Supports read, search-type.

Documentation

This section introduces the supported interactions by a Requester Actor for the HCPD 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`
SHOULD	active	`token`
SHOULD	suppressed	`token`

Resource Conformance: SHOULD PractitionerRole

Base System Profile
HCPD PractitionerRoleversion: 26.0.0)

Profile Conformance
SHALL

Reference Policy

Interaction summary

Supports read, search-type.

Documentation

This section defines the supported interactions for the HCPD Practitioner Role profile of the PractitionerRole resource type. Each PractitionerRole resource conforming to the HCPD 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`
SHOULD	active	`token`
SHOULD	suppressed	`token`

Resource Conformance: SHALL Practitioner

Base System Profile
HCPD Practitionerversion: 26.0.0)

Profile Conformance
SHALL

Reference Policy

Interaction summary

Supports read, search-type.

Documentation

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

Search Parameters

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

Resource Conformance: SHOULD Endpoint

Base System Profile
HCPD Endpointversion: 26.0.0)

Profile Conformance
SHALL

Reference Policy

Interaction summary

Supports read, search-type.

Documentation

This section defines the supported interactions for the HCPD Endpoint profile of the Endpoint resource type. Each Endpoint resource conforming to the HCPD Endpoint profile is a read-only proxy for a corresponding Endpoint resource published by the HCPD 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`
SHOULD	status	`token`
SHOULD	suppressed	`token`

Source1

{
  "resourceType": "CapabilityStatement",
  "id": "health-connect-provider-directory-requester",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "url": "http://digitalhealth.gov.au/fhir/hcpd/CapabilityStatement/health-connect-provider-directory-requester",
  "version": "26.0.0",
  "name": "HealthConnectProviderDirectoryRequester",
  "title": "Health Connect Provider Directory Requester",
  "status": "active",
  "experimental": false,
  "date": "2026-03-31",
  "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": "url",
          "value": "https://www.digitalhealth.gov.au",
          "use": "work"
        },
        {
          "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.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "urn:iso:std:iso:3166",
          "code": "AU",
          "display": "Australia"
        }
      ]
    }
  ],
  "copyright": "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": [
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHOULD"
            }
          ],
          "type": "Provenance",
          "profile": "http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-provenance|26.0.0",
          "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 HCPD Provenance records to understand data lineage"
            },
            {
              "code": "search-type",
              "documentation": "Search for HCPD 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"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "type": "Organization",
          "profile": "http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-organization|26.0.0",
          "documentation": "This section defines the supported interactions by a Requester Actor for the HCPD 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"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "active",
              "definition": "http://hl7.org/fhir/SearchParameter/Organization-active|4.0.1",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "suppressed",
              "definition": "http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/suppressed|26.0.0",
              "type": "token"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHOULD"
            }
          ],
          "type": "Location",
          "profile": "http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-location|26.0.0",
          "documentation": "This section introduces the supported interactions by a Requester Actor for the HCPD 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://digitalhealth.gov.au/fhir/hcpd/SearchParameter/location-locmailaddress|26.0.0",
              "type": "string"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "locationamenities",
              "definition": "http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/location-amenities|26.0.0",
              "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://digitalhealth.gov.au/fhir/hcpd/SearchParameter/location-physicaltype|26.0.0",
              "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"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "status",
              "definition": "http://hl7.org/fhir/SearchParameter/Location-status|4.0.1",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "suppressed",
              "definition": "http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/suppressed|26.0.0",
              "type": "token"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHOULD"
            }
          ],
          "type": "HealthcareService",
          "profile": "http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-healthcareservice|26.0.0",
          "documentation": "This section introduces the supported interactions by a Requester Actor for the [HCPD Healthcare Service](StructureDefinition-hcpd-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://digitalhealth.gov.au/fhir/hcpd/SearchParameter/languages|26.0.0",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "hsbilling",
              "definition": "http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/healthcareservice-billing|26.0.0",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "allday",
              "definition": "http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/allday|26.0.0",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "daysofweek",
              "definition": "http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/daysofweek|26.0.0",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "starttime",
              "definition": "http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/starttime|26.0.0",
              "type": "number"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "endtime",
              "definition": "http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/endtime|26.0.0",
              "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"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "active",
              "definition": "http://hl7.org/fhir/SearchParameter/HealthcareService-active|4.0.1",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "suppressed",
              "definition": "http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/suppressed|26.0.0",
              "type": "token"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHOULD"
            }
          ],
          "type": "PractitionerRole",
          "profile": "http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-practitionerrole|26.0.0",
          "documentation": "This section defines the supported interactions for the [HCPD Practitioner Role](StructureDefinition-hcpd-practitionerrole.html) profile of the PractitionerRole resource type. Each PractitionerRole resource conforming to the [HCPD Practitioner Role](StructureDefinition-hcpd-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://digitalhealth.gov.au/fhir/hcpd/SearchParameter/languages|26.0.0",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "allday",
              "definition": "http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/allday|26.0.0",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "daysofweek",
              "definition": "http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/daysofweek|26.0.0",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "starttime",
              "definition": "http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/starttime|26.0.0",
              "type": "number"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "endtime",
              "definition": "http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/endtime|26.0.0",
              "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"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "active",
              "definition": "http://hl7.org/fhir/SearchParameter/PractitionerRole-active|4.0.1",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "suppressed",
              "definition": "http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/suppressed|26.0.0",
              "type": "token"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "type": "Practitioner",
          "profile": "http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-practitioner|26.0.0",
          "documentation": "This section defines the supported interactions for the [HCPD Practitioner](StructureDefinition-hcpd-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://digitalhealth.gov.au/fhir/hcpd/SearchParameter/practitioner-regprof|26.0.0",
              "type": "string"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "rsg",
              "definition": "http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/practitioner-rsg|26.0.0",
              "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://digitalhealth.gov.au/fhir/hcpd/SearchParameter/practitioner-identifier-r5|26.0.0",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "active",
              "definition": "http://hl7.org/fhir/SearchParameter/Practitioner-active|4.0.1",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "suppressed",
              "definition": "http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/suppressed|26.0.0",
              "type": "token"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHOULD"
            }
          ],
          "type": "Endpoint",
          "profile": "http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-endpoint|26.0.0",
          "documentation": "This section defines the supported interactions for the [HCPD Endpoint](StructureDefinition-hcpd-endpoint.html) profile of the Endpoint resource type. Each Endpoint resource conforming to the [HCPD Endpoint](StructureDefinition-hcpd-endpoint.html) profile is a read-only proxy for a corresponding Endpoint resource published by the HCPD 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://digitalhealth.gov.au/fhir/hcpd/SearchParameter/endpoint-url|26.0.0",
              "type": "uri"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "payloadmimetype",
              "definition": "http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/endpoint-payloadmimetype|26.0.0",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "hcepi",
              "definition": "http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/endpoint-hcepi|26.0.0",
              "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"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "status",
              "definition": "http://hl7.org/fhir/SearchParameter/Endpoint-status|4.0.1",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "suppressed",
              "definition": "http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/suppressed|26.0.0",
              "type": "token"
            }
          ]
        }
      ]
    }
  ]
}

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: SHALL Organization

Resource Conformance: SHOULD Location

Resource Conformance: SHOULD HealthcareService

Resource Conformance: SHOULD PractitionerRole

Resource Conformance: SHALL Practitioner

Resource Conformance: SHOULD Endpoint

Source1

Mode: `client`