DFT - The specification is currently in ballot review and subject to change. It is not ready for limited roll-out or production level use. For a full list of available versions, see the Directory of published versions

Queries

Note: More information on query searches can be found at https://hl7.org/fhir/R4/search.html

Search Parameter Expectations Across All Resource Types

• Both the Consumer and the supplier the SHALL support the :contains and :exact modifiers in all of the string query parameters it supports.
• All resource types SHALL support the following search parameters as defined at http://hl7.org/fhir/R4/search.html#all:
  • _id
  • _lastUpdated

EndPoint

Resource Interaction Summary:

• SHALL support search-type

Supported Parameters

Parameter	Capability Statement - Consumer	Capability Statement - Supplier	Type
_id	SHALL	SHALL
_lastUpdated	SHALL	SHALL	date
identifier	SHALL	SHALL	token
organization	SHOULD	SHOULD	reference
status	SHOULD	SHOULD	token

_include

      N/A

_revinclude

      N/A

HealthcareService

Supported Parameters

Parameter	Capability Statement - Consumer	Capability Statement - Supplier	Type
_id	SHALL	SHALL
_lastUpdated	SHALL	SHALL	date
active	SHOULD	SHOULD	token
identifier	SHALL	SHALL	token
name	SHALL	SHALL	string
name:contains	SHOULD	SHOULD	string
name:exact	SHOULD	SHOULD	string
organization	SHOULD	SHOULD	reference
service-type	SHALL	SHALL	token

_include

      N/A

_revinclude

      N/A

Location

Supported Parameters

Parameter	Capability Statement - Consumer	Capability Statement - Supplier	Type
_id	SHALL	SHALL
_lastUpdated	SHALL	SHALL	date
identifier	SHALL	SHALL	token
name	SHOULD	SHOULD	string
name:contains	SHOULD	SHOULD	string
name:exact	SHOULD	SHOULD	string
organization	SHOULD	SHOULD	reference
partof	SHOULD	SHOULD	reference
type	SHALL	SHOULD	token
status	SHOULD	SHOULD	token

_include

Parameter	Capability Statement - Consumer	Capability Statement - Supplier
Location:organization	SHOULD

_revinclude

      N/A

Location With Distance

Resource Interaction Summary:

• SHALL support search-type

Supported Parameters

Parameter	Capability Statement Location Distance - Consumer	Capability Statement Location Distance - Supplier	Type
_id	SHALL	SHALL
_lastUpdated	SHALL	SHALL	date
near	SHOULD	SHOULD	token
near-distance	SHOULD	SHOULD	quantity

_include

      N/A

_revinclude

      N/A

Organization

Supported Parameters

Parameter	Capability Statement - Consumer	Capability Statement - Supplier	Type
_id	SHALL	SHALL
_lastUpdated	SHALL	SHOULD	date
active	SHOULD	SHOULD	token
identifier	SHALL	SHALL	token
name	SHALL	SHOULD	string
name:contains	SHOULD	SHOULD	string
name:exact	SHOULD	SHOULD	string
partof	SHOULD	SHOULD	reference
type	SHALL	SHOULD	token

_include

Parameter	Capability Statement - Consumer	Capability Statement - Supplier
Organization.endpoint	SHOULD	SHOULD

_revinclude

Parameter	Capability Statement - Consumer	Capability Statement - Supplier
Location:organization	SHOULD	SHOULD
OrganizationAffiliation:participating-organization	SHOULD	SHOULD
OrganizationAffiliation:primary-organization	SHOULD	SHOULD
HealthcareService:organization	SHOULD	SHOULD

OrganizationAffiliation

Supported Parameters

Parameter	Capability Statement - Consumer	Capability Statement - Supplier	Type
_id	SHALL	SHALL
_lastUpdated	SHALL	SHALL	date
active	SHOULD	SHOULD	token
date	SHOULD	SHOULD	date
identifier	SHALL	SHALL	token
participating-organization	SHOULD	SHOULD	reference
primary-organization	SHOULD	SHOULD	reference
role	SHOULD	SHOULD	token

_include

Parameter	Capability Statement - Consumer	Capability Statement - Supplier)
OrganizationAffiliation.endpoint	SHOULD	SHOULD

_revinclude

      N/A

Practitioner

Supported Parameters

Parameter	Capability Statement - Consumer	Capability Statement - Supplier	Type
_id	SHALL	SHALL
_lastUpdated	SHALL	SHALL	date
active	SHOULD	SHOULD	string
identifier	SHALL	SHALL	string
family	SHOULD	SHOULD	string
family:contains	SHOULD	SHOULD	string
family:exact	SHOULD	SHOULD	string
given	SHOULD	SHOULD	string
given:contains	SHOULD	SHOULD	string
give:exact	SHOULD	SHOULD	string
name	SHOULD	SHOULD	string
name:contains	SHOULD	SHOULD	string
name:exact	SHOULD	SHOULD	string

_include

      N/A

_revinclude

      N/A

PractitionerRole

Supported Parameters

Parameter	Capability Statement - Consumer	Capability Statement - Supplier	Type
_id	SHALL	SHALL
_lastUpdated	SHALL	SHALL	date
active	SHOULD	SHOULD	token
identifier	SHALL	SHOULD	token
location	SHOULD	SHOULD	reference
name	SHALL	SHOULD	string
name:contains	SHOULD	SHOULD	string
name:exact	SHOULD	SHOULD	string
organization	SHOULD	SHOULD	reference
service-type	SHALL	SHOULD	token

_include

Parameter	Capability Statement - Consumer	Capability Statement - Supplier
PractitionerRole:practitioner	SHOULD	SHOULD

_revinclude

      N/A