Practitioner

ResourceBase · IndividualsTrial useMaturity 3

A person who is directly or indirectly involved in the provisioning of healthcare.

StructureSearch parametersHL7 specificationStructureDefinition JSON

Tested supportFull test results →

Backends

PostgreSQLElasticsearch

Interactions

CreateReadUpdatePatchDelete

Search

17 of 17 parameters tested

Structure

Show inherited elements (11)

Element	Card.	Type	Description
identifierΣ	0..*	Identifier	An identifier for the person as this agent
activeΣ	0..1	boolean	Whether this practitioner's record is in active use
nameΣ	0..*	HumanName	The name(s) associated with the practitioner
telecomΣ	0..*	ContactPoint	A contact detail for the practitioner (that apply to all roles)
addressΣ	0..*	Address	Address(es) of the practitioner that are not role specific (typically home address)
genderΣ	0..1	code	male | female | other | unknownBinding (required): administrative-gender
birthDateΣ	0..1	date	The date on which the practitioner was born
photo	0..*	Attachment	Image of the person
qualification	0..*	BackboneElement	Certification, licenses, or training pertaining to the provision of care
identifier	0..*	Identifier	An identifier for this qualification for the practitioner
codeRequired	1..1	CodeableConcept	Coded representation of the qualificationBinding (example): v2-2.7-0360
period	0..1	Period	Period during which the qualification is valid
issuer	0..1	Reference(Organization)	Organization that regulates and issues the qualification
communication	0..*	CodeableConcept	A language the practitioner can use in patient communicationBinding (preferred): languages

Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey

Search parameters

Query with GET [base]/Practitioner?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.

Parameter	Type	Description	PG	ES
active	token	Whether the practitioner record is active Practitioner.active
address	string	A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text Practitioner.address
address-city	string	A city specified in an address Practitioner.address.city
address-country	string	A country specified in an address Practitioner.address.country
address-postalcode	string	A postalCode specified in an address Practitioner.address.postalCode
address-state	string	A state specified in an address Practitioner.address.state
address-use	token	A use code specified in an address Practitioner.address.use
communication	token	One of the languages that the practitioner can communicate with Practitioner.communication
email	token	A value in an email contact Practitioner.telecom.where(system='email')
family	string	A portion of the family name Practitioner.name.family
gender	token	Gender of the practitioner Practitioner.gender
given	string	A portion of the given name Practitioner.name.given
identifier	token	A practitioner's Identifier Practitioner.identifier
name	string	A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text Practitioner.name
phone	token	A value in a phone contact Practitioner.telecom.where(system='phone')
phonetic	string	A portion of either family or given name using some kind of phonetic matching algorithm Practitioner.name
telecom	token	The value in any kind of contact Practitioner.telecom

PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet.

Common parameters on every resource (8)

_haste-health-author	reference	The author of the resource
_id	token	Logical id of this artifact
_lastUpdated	date	When the resource version last changed
_profile	uri	Profiles this resource claims to conform to
_security	token	Security Labels applied to this resource
_source	uri	Identifies where the resource comes from
_tag	token	Tags applied to this resource
_type	token	Derived from the R4B Definition