Skip to main content

Practitioner

Normative Base

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

Endpoints

devhttps://api.sandbox.ovok.com/fhir/R5/Practitioner
InteractionMethodPath
ReadGET/fhir/R5/Practitioner/[id]
VreadGET/fhir/R5/Practitioner/[id]/_history/[vid]
UpdatePUT/fhir/R5/Practitioner/[id]
PatchPATCH/fhir/R5/Practitioner/[id]
DeleteDELETE/fhir/R5/Practitioner/[id]
CreatePOST/fhir/R5/Practitioner
SearchGET/fhir/R5/Practitioner?...
HistoryGET/fhir/R5/Practitioner/[id]/_history
Type-historyGET/fhir/R5/Practitioner/_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 modifier
nameHumanName0..*The name(s) associated with the practitioner
telecomContactPoint0..*A contact detail for the practitioner (that apply to all roles)
gendercode0..1male
birthDatedate0..1The date on which the practitioner was born
deceased[x]boolean / dateTime0..1Indicates if the practitioner is deceased or not
addressAddress0..*Address(es) of the practitioner that are not role specific (typically home address)
photoAttachment0..*Image of the person
qualificationBackboneElement0..*Qualifications, certifications, accreditations, licenses, training, etc. pertaining to the provision of care
communicationBackboneElement0..*A language which may be used to communicate with the practitioner

Resource-specific search parameters

ParameterTypeDescription
activetokenWhether the practitioner record is active
addressstringA 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-citystringA city specified in an address
address-countrystringA country specified in an address
address-postalcodestringA postalCode specified in an address
address-statestringA state specified in an address
address-usetokenA use code specified in an address
communicationtokenA language to communicate with the practitioner
death-datedateThe date of death has been provided and satisfies this search value
deceasedtokenThis Practitioner has been marked as deceased, or has a death date entered
emailtokenA value in an email contact
familystringA portion of the family name of the patient
gendertokenGender of the patient
givenstringA portion of the given name of the patient
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
phonetokenA value in a phone contact
phoneticstringA portion of either family or given name using some kind of phonetic matching algorithm
qualification-perioddateThe date(s) a qualification is valid for
telecomtokenThe value in any kind of telecom details of the patient

Reference

  • Official FHIR R5 spec: Practitioner
  • Maturity: Normative (FMM 5).