Introduction
...
This page documents the implementation of the FHIR Practitioner resource (DSTU2) for the OpenMRS FHIR Module.
...
Practitioner resource represents a person who is directly or indirectly involved in the provisioning of healthcare.
...
Populating the FHIR Practitioner Resource
Shown below is how attributes of the FHIR Practitioner Resource map to the attributes of the OpenMRS Practitioner object. The left side of the relationship indicates the OpenMRS attribute; the right indicates the FHIR Practitioner resource mapping.
| Code Block | ||
|---|---|---|
| ||
None to date |
Example FHIR Practitioner Resource
Shown below is a fleshed out FHIR Practitioner Resource.
| Code Block | ||
|---|---|---|
| ||
{
"resourceType": "Practitioner",
"id": "a846f32f-5401-4d53-871a-68354c22c3f9",
identifier: [1]
0: {
"system": "http://www.acme.org/practitioners",
value: "clerk"
},
"name": {
"family": [
"Careful"
],
"given": [
"Adam"
]
},
address: [1]
0: {
use: "home"
city: "E. Kanateng"
},
gender: {
coding: [1]
0: {
system: "http://hl7.org/fhir/v3/AdministrativeGender"
code: "M"
}
},
birthDate: "2009-08-11T00:00:00"
} |
Available RESTful web services for the Practitioner Resource supported by the API
GET Requests
| Read | |
|---|---|
| URL | Description |
| /ws/fhir/Practitioner/{id} | Returns a FHIR Practitioner resource identified by a Practitioner UUID Outcomes:
|
| Search | |
| /ws/fhir/Practitioner?_id={id} | Above request will fetch all the Practitioners using the given id value. This will give a List of Practitioners as the response. Here _id parameter represents, the logical resource id associated with the resource. |
| /ws/fhir/Practitioner?family={familyName} | Above request will fetch all the Practitioners using the given family name. This will give a List of Practitioners as the response. Here family parameter represents, the family name of the Practitioner. |
| /ws/fhir/Practitioner?name={name} | Above request will fetch all the Practitioners using the name. This will give a List of Practitioners as the response. Here name parameter represents, the name of the Practitioner. |
| /ws/fhir/Practitioner?identifier={identifier} | Above request will fetch all the Practitioners using the given identifier. This will give a List of Practitioners as the response. Here identifier parameter represents, the identifier of the Practitioner. Here we use name as the identifier. |
| /ws/fhir/Practitioner?given={givenName} | Above request will fetch all the Practitioners using the given name. This will give a List of Practitioners as the response. Here given parameter represents, the given name of the Practitioner. |
| Operations | |
| None to date | |
POST Requests
None to datePractitioner covers all individuals who are engaged in the healthcare process and healthcare-related services as part of their formal responsibilities.
Supported Elements
The following properties are supported by OpenMrs FHIR Module:
- Practitioner.id
- Practitioner.identifier
- Practitioner.active
- Practitioner.name
- Practitioner.telecom
- Practitioner.address
- Practitioner.gender
- Practitioner.birthDate
OpenMRS ↔ FHIR Mapping
| OpenMrs Provider Data Model | FHIR Resource Element |
|---|---|
Provider.uuid | Practitioner.id |
Provider.identifier | Practitioner.identifier |
Provider.retired | Practitioner.active |
Provider.providerAttribute (attribute type == user defined value) | Practitioner.telecom (system == phone) |
Provider.person.address | Practitioner.address |
Provider.person.name | Practitioner.name |
Provider.person.gender | Practitioner.gender |
Provider.person.birthDate | Practitioner.birthDate |
OpenMrs User Data Model | FHIR Resource Element |
|---|---|
User.uuid | Practitioner.id |
User.userId | Practitioner.identifier |
User.person.personAttribute (attribute type == user defined value) | Practitioner.telecom (system == phone) |
User.person.gender | Practitioner.gender |
User.person.name | Practitioner.name |
User.person.address | Practitioner.address |
User.person.birthDate | Practitioner.birthDate |
Available RESTful Endpoints
Note: placeholder "{release}" below must be replaced by the FHIR Release - currently "R3" and "R4" are implemented. See more on the FHIR Release support page.
GET
URL | Description |
|---|---|
/ws/fhir2/{release}/Practitioner/{uuid} | Gets a specific practitioner |
/ws/fhir2/{release}/Practitioner?name={String} | searches for the practitioner by name |
/ws/fhir2/{release}/Practitioner?identifier={String} | searches for the practitioner by identifier |