Practitioner
A person who is directly or indirectly involved in the provisioning of healthcare or related services.
Endpoints
dev
https://api.sandbox.ovok.com/fhir/R5/Practitioner| Interaction | Method | Path |
|---|---|---|
| Read | GET | /fhir/R5/Practitioner/[id] |
| Vread | GET | /fhir/R5/Practitioner/[id]/_history/[vid] |
| Update | PUT | /fhir/R5/Practitioner/[id] |
| Patch | PATCH | /fhir/R5/Practitioner/[id] |
| Delete | DELETE | /fhir/R5/Practitioner/[id] |
| Create | POST | /fhir/R5/Practitioner |
| Search | GET | /fhir/R5/Practitioner?... |
| History | GET | /fhir/R5/Practitioner/[id]/_history |
| Type-history | GET | /fhir/R5/Practitioner/_history |
Top-level elements
| Element | Type(s) | Cardinality | Description |
|---|---|---|---|
identifier | Identifier | 0..* | An identifier for the person as this agent |
active | boolean | 0..1 | Whether this practitioner's record is in active use modifier |
name | HumanName | 0..* | The name(s) associated with the practitioner |
telecom | ContactPoint | 0..* | A contact detail for the practitioner (that apply to all roles) |
gender | code | 0..1 | male |
birthDate | date | 0..1 | The date on which the practitioner was born |
deceased[x] | boolean / dateTime | 0..1 | Indicates if the practitioner is deceased or not |
address | Address | 0..* | Address(es) of the practitioner that are not role specific (typically home address) |
photo | Attachment | 0..* | Image of the person |
qualification | BackboneElement | 0..* | Qualifications, certifications, accreditations, licenses, training, etc. pertaining to the provision of care |
communication | BackboneElement | 0..* | A language which may be used to communicate with the practitioner |
Resource-specific search parameters
| Parameter | Type | Description |
|---|---|---|
active | token | Whether the practitioner record is 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 |
address-city | string | A city specified in an address |
address-country | string | A country specified in an address |
address-postalcode | string | A postalCode specified in an address |
address-state | string | A state specified in an address |
address-use | token | A use code specified in an address |
communication | token | A language to communicate with the practitioner |
death-date | date | The date of death has been provided and satisfies this search value |
deceased | token | This Practitioner has been marked as deceased, or has a death date entered |
email | token | A value in an email contact |
family | string | A portion of the family name of the patient |
gender | token | Gender of the patient |
given | string | A portion of the given name of the patient |
identifier | token | A practitioner's 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 |
phone | token | A value in a phone contact |
phonetic | string | A portion of either family or given name using some kind of phonetic matching algorithm |
qualification-period | date | The date(s) a qualification is valid for |
telecom | token | The value in any kind of telecom details of the patient |
Reference
- Official FHIR R5 spec:
Practitioner - Maturity: Normative (FMM 5).