Skip to main content

Practitioner

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

These interaction paths describe standard FHIR R4 patterns. Availability can depend on the API capabilities enabled for your Ovok project.

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​

ElementTypeCardinalityDescription
idstring0..1Logical id of this artifact
metaMeta0..1Metadata about the resource
implicitRulesuri0..1A set of rules under which this content was created
languagecode0..1Language of the resource content
textNarrative0..1Text summary of the resource, for human interpretation
containedResource0..*Contained, inline Resources
extensionExtension0..*Additional content defined by implementations
modifierExtensionExtension0..*Extensions that cannot be ignored
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
activetokenWhether the practitioner record is active
addressstringMultiple Resources: Patient: 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 ; Person: 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: 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 ; RelatedPerson: 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
address-citystringMultiple Resources: Patient: A city specified in an address ; Person: A city specified in an address ; Practitioner: A city specified in an address ; RelatedPerson: A city specified in an address
address-countrystringMultiple Resources: Patient: A country specified in an address ; Person: A country specified in an address ; Practitioner: A country specified in an address ; RelatedPerson: A country specified in an address
address-postalcodestringMultiple Resources: Patient: A postalCode specified in an address ; Person: A postal code specified in an address ; Practitioner: A postalCode specified in an address ; RelatedPerson: A postal code specified in an address
address-statestringMultiple Resources: Patient: A state specified in an address ; Person: A state specified in an address ; Practitioner: A state specified in an address ; RelatedPerson: A state specified in an address
address-usetokenMultiple Resources: Patient: A use code specified in an address ; Person: A use code specified in an address ; Practitioner: A use code specified in an address ; RelatedPerson: A use code specified in an address
communicationtokenOne of the languages that the practitioner can communicate with
emailtokenMultiple Resources: Patient: A value in an email contact ; Person: A value in an email contact ; Practitioner: A value in an email contact ; PractitionerRole: A value in an email contact ; RelatedPerson: A value in an email contact
familystringMultiple Resources: Patient: A portion of the family name of the patient ; Practitioner: A portion of the family name
gendertokenMultiple Resources: Patient: Gender of the patient ; Person: The gender of the person ; Practitioner: Gender of the practitioner ; RelatedPerson: Gender of the related person
givenstringMultiple Resources: Patient: A portion of the given name of the patient ; Practitioner: A portion of the given name
identifiertokenA practitioner's Identifier
namestringA server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text
phonetokenMultiple Resources: Patient: A value in a phone contact ; Person: A value in a phone contact ; Practitioner: A value in a phone contact ; PractitionerRole: A value in a phone contact ; RelatedPerson: A value in a phone contact
phoneticstringMultiple Resources: Patient: A portion of either family or given name using some kind of phonetic matching algorithm ; Person: A portion of name using some kind of phonetic matching algorithm ; Practitioner: A portion of either family or given name using some kind of phonetic matching algorithm ; RelatedPerson: A portion of name using some kind of phonetic matching algorithm
telecomtokenMultiple Resources: Patient: The value in any kind of telecom details of the patient ; Person: The value in any kind of contact ; Practitioner: The value in any kind of contact ; PractitionerRole: The value in any kind of contact ; RelatedPerson: The value in any kind of contact

Reference​

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