Skip to main content

Practitioner

Trial Use 3 Base

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

Endpoints​

alphahttps://api.dev.ovok.com/fhir/R4/Practitioner
InteractionMethodPath
ReadGET/fhir/R4/Practitioner/[id]
VreadGET/fhir/R4/Practitioner/[id]/_history/[vid]
UpdatePUT/fhir/R4/Practitioner/[id]
PatchPATCH/fhir/R4/Practitioner/[id]
DeleteDELETE/fhir/R4/Practitioner/[id]
CreatePOST/fhir/R4/Practitioner
SearchGET/fhir/R4/Practitioner
HistoryGET/fhir/R4/Practitioner/[id]/_history

Top-level elements​

ElementType(s)CardinalityDescription
identifierIdentifier0..*An identifier for the person as this agent
activeboolean0..1Whether this practitioner's record is in active use
nameHumanName0..*The name(s) associated with the practitioner
telecomContactPoint0..*A contact detail for the practitioner (that apply to all roles)
addressAddress0..*Address(es) of the practitioner that are not role specific (typically home address)
gendercode0..1male | female | other | unknown
birthDatedate0..1The date on which the practitioner was born
photoAttachment0..*Image of the person
qualificationBackboneElement0..*Certification, licenses, or training pertaining to the provision of care
communicationCodeableConcept0..*A language the practitioner can use in patient communication

Resource-specific search parameters​

ParameterTypeDescription
_compartmentstring
_countstringhttps://www.hl7.org/fhir/search.html#_count
_elementsstringhttps://www.hl7.org/fhir/search.html#_elements
_idstring
_lastUpdatedstring
_profilestring
_securitystring
_sortstringhttps://www.hl7.org/fhir/search.html#_sort
_sourcestring
_summarystringhttps://www.hl7.org/fhir/search.html#_summary
_tagstring
_totalstringhttps://www.hl7.org/fhir/search.html#_total
activestringhttp://hl7.org/fhir/SearchParameter/Practitioner-active
addressstringhttp://hl7.org/fhir/SearchParameter/individual-address
address-citystringhttp://hl7.org/fhir/SearchParameter/individual-address-city
address-countrystringhttp://hl7.org/fhir/SearchParameter/individual-address-country
address-postalcodestringhttp://hl7.org/fhir/SearchParameter/individual-address-postalcode
address-statestringhttp://hl7.org/fhir/SearchParameter/individual-address-state
address-usestringhttp://hl7.org/fhir/SearchParameter/individual-address-use
communicationstringhttp://hl7.org/fhir/SearchParameter/Practitioner-communication
emailstringhttp://hl7.org/fhir/SearchParameter/individual-email
familystringhttp://hl7.org/fhir/SearchParameter/individual-family
genderstringhttp://hl7.org/fhir/SearchParameter/individual-gender
givenstringhttp://hl7.org/fhir/SearchParameter/individual-given
identifierstringhttp://hl7.org/fhir/SearchParameter/Practitioner-identifier
namestringhttp://hl7.org/fhir/SearchParameter/Practitioner-name
phonestringhttp://hl7.org/fhir/SearchParameter/individual-phone
phoneticstringhttp://hl7.org/fhir/SearchParameter/individual-phonetic
qualification-codestringhttps://medplum.com/fhir/SearchParameter/Practitioner-qualification-code
telecomstringhttp://hl7.org/fhir/SearchParameter/individual-telecom

Reference​

  • Official FHIR R4 spec: Practitioner
  • Maturity: Trial Use 3 (FMM 3).