PractitionerRole
A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.
Columns
Header row
# |
path |
type |
required |
description |
0 |
resourceType |
string |
* |
Resource type identifier. Must be string "PractitionerRole" |
1 |
|
integer |
* |
Number of subrows |
2 |
id |
string |
* |
Logical id of this artifact |
3 |
active |
boolean |
|
Whether this practitioner role record is in active use |
|
period |
Period |
|
The period during which the practitioner is authorized to perform in these role(s) |
4 |
period.start |
dateTime |
|
Starting time with inclusive boundary |
5 |
period.end |
dateTime |
|
End time with inclusive boundary, if not ongoing |
|
practitioner |
Reference |
|
Practitioner that is able to provide the defined services for the organization |
6 |
practitioner.reference |
string |
|
Literal reference, Relative, internal or absolute URL |
7 |
practitioner.type |
uri |
|
Type the reference refers to (e.g. "Patient") |
|
practitioner.identifier |
Identifier |
|
Logical reference, when literal reference is not known |
8 |
practitioner.identifier.use |
code |
|
usual | official | temp | secondary | old (If known) |
|
practitioner.identifier.type |
CodeableConcept |
|
Description of identifier |
|
practitioner.identifier.type.coding |
Coding |
|
Code defined by a terminology system |
9 |
practitioner.identifier.type.coding.system |
uri |
|
Identity of the terminology system |
10 |
practitioner.identifier.type.coding.version |
string |
|
Version of the system - if relevant |
11 |
practitioner.identifier.type.coding.code |
code |
|
Symbol in syntax defined by the system |
12 |
practitioner.identifier.type.coding.display |
string |
|
Representation defined by the system |
13 |
practitioner.identifier.type.coding.userSelected |
boolean |
|
If this coding was chosen directly by the user |
14 |
practitioner.identifier.type.text |
string |
|
Plain text representation of the concept |
15 |
practitioner.identifier.system |
uri |
|
The namespace for the identifier value |
16 |
practitioner.identifier.value |
string |
|
The value that is unique |
|
practitioner.identifier.period |
Period |
|
Time period when id is/was valid for use |
17 |
practitioner.identifier.period.start |
dateTime |
|
Starting time with inclusive boundary |
18 |
practitioner.identifier.period.end |
dateTime |
|
End time with inclusive boundary, if not ongoing |
19 |
practitioner.display |
string |
|
Text alternative for the resource |
|
organization |
Reference |
|
Organization where the roles are available |
20 |
organization.reference |
string |
|
Literal reference, Relative, internal or absolute URL |
21 |
organization.type |
uri |
|
Type the reference refers to (e.g. "Patient") |
|
organization.identifier |
Identifier |
|
Logical reference, when literal reference is not known |
22 |
organization.identifier.use |
code |
|
usual | official | temp | secondary | old (If known) |
|
organization.identifier.type |
CodeableConcept |
|
Description of identifier |
|
organization.identifier.type.coding |
Coding |
|
Code defined by a terminology system |
23 |
organization.identifier.type.coding.system |
uri |
|
Identity of the terminology system |
24 |
organization.identifier.type.coding.version |
string |
|
Version of the system - if relevant |
25 |
organization.identifier.type.coding.code |
code |
|
Symbol in syntax defined by the system |
26 |
organization.identifier.type.coding.display |
string |
|
Representation defined by the system |
27 |
organization.identifier.type.coding.userSelected |
boolean |
|
If this coding was chosen directly by the user |
28 |
organization.identifier.type.text |
string |
|
Plain text representation of the concept |
29 |
organization.identifier.system |
uri |
|
The namespace for the identifier value |
30 |
organization.identifier.value |
string |
|
The value that is unique |
|
organization.identifier.period |
Period |
|
Time period when id is/was valid for use |
31 |
organization.identifier.period.start |
dateTime |
|
Starting time with inclusive boundary |
32 |
organization.identifier.period.end |
dateTime |
|
End time with inclusive boundary, if not ongoing |
33 |
organization.display |
string |
|
Text alternative for the resource |
34 |
availabilityExceptions |
string |
|
Description of availability exceptions |
Row identifier
# |
path |
type |
required |
description |
0 |
|
string |
* |
Subrow identifier. Must be string "identifier" |
|
identifier |
Identifier |
|
Business Identifiers that are specific to a role/location |
1 |
identifier.use |
code |
|
usual | official | temp | secondary | old (If known) |
|
identifier.type |
CodeableConcept |
|
Description of identifier |
|
identifier.type.coding |
Coding |
|
Code defined by a terminology system |
2 |
identifier.type.coding.system |
uri |
|
Identity of the terminology system |
3 |
identifier.type.coding.version |
string |
|
Version of the system - if relevant |
4 |
identifier.type.coding.code |
code |
|
Symbol in syntax defined by the system |
5 |
identifier.type.coding.display |
string |
|
Representation defined by the system |
6 |
identifier.type.coding.userSelected |
boolean |
|
If this coding was chosen directly by the user |
7 |
identifier.type.text |
string |
|
Plain text representation of the concept |
8 |
identifier.system |
uri |
|
The namespace for the identifier value |
9 |
identifier.value |
string |
|
The value that is unique |
|
identifier.period |
Period |
|
Time period when id is/was valid for use |
10 |
identifier.period.start |
dateTime |
|
Starting time with inclusive boundary |
11 |
identifier.period.end |
dateTime |
|
End time with inclusive boundary, if not ongoing |
Row code
# |
path |
type |
required |
description |
0 |
|
string |
* |
Subrow identifier. Must be string "code" |
|
code |
CodeableConcept |
|
Roles which this practitioner may perform |
|
code.coding |
Coding |
|
Code defined by a terminology system |
1 |
code.coding.system |
uri |
|
Identity of the terminology system |
2 |
code.coding.version |
string |
|
Version of the system - if relevant |
3 |
code.coding.code |
code |
|
Symbol in syntax defined by the system |
4 |
code.coding.display |
string |
|
Representation defined by the system |
5 |
code.coding.userSelected |
boolean |
|
If this coding was chosen directly by the user |
6 |
code.text |
string |
|
Plain text representation of the concept |
Row specialty
# |
path |
type |
required |
description |
0 |
|
string |
* |
Subrow identifier. Must be string "specialty" |
|
specialty |
CodeableConcept |
|
Specific specialty of the practitioner |
|
specialty.coding |
Coding |
|
Code defined by a terminology system |
1 |
specialty.coding.system |
uri |
|
Identity of the terminology system |
2 |
specialty.coding.version |
string |
|
Version of the system - if relevant |
3 |
specialty.coding.code |
code |
|
Symbol in syntax defined by the system |
4 |
specialty.coding.display |
string |
|
Representation defined by the system |
5 |
specialty.coding.userSelected |
boolean |
|
If this coding was chosen directly by the user |
6 |
specialty.text |
string |
|
Plain text representation of the concept |
Row location
# |
path |
type |
required |
description |
0 |
|
string |
* |
Subrow identifier. Must be string "location" |
|
location |
Reference |
|
The location(s) at which this practitioner provides care |
1 |
location.reference |
string |
|
Literal reference, Relative, internal or absolute URL |
2 |
location.type |
uri |
|
Type the reference refers to (e.g. "Patient") |
|
location.identifier |
Identifier |
|
Logical reference, when literal reference is not known |
3 |
location.identifier.use |
code |
|
usual | official | temp | secondary | old (If known) |
|
location.identifier.type |
CodeableConcept |
|
Description of identifier |
|
location.identifier.type.coding |
Coding |
|
Code defined by a terminology system |
4 |
location.identifier.type.coding.system |
uri |
|
Identity of the terminology system |
5 |
location.identifier.type.coding.version |
string |
|
Version of the system - if relevant |
6 |
location.identifier.type.coding.code |
code |
|
Symbol in syntax defined by the system |
7 |
location.identifier.type.coding.display |
string |
|
Representation defined by the system |
8 |
location.identifier.type.coding.userSelected |
boolean |
|
If this coding was chosen directly by the user |
9 |
location.identifier.type.text |
string |
|
Plain text representation of the concept |
10 |
location.identifier.system |
uri |
|
The namespace for the identifier value |
11 |
location.identifier.value |
string |
|
The value that is unique |
|
location.identifier.period |
Period |
|
Time period when id is/was valid for use |
12 |
location.identifier.period.start |
dateTime |
|
Starting time with inclusive boundary |
13 |
location.identifier.period.end |
dateTime |
|
End time with inclusive boundary, if not ongoing |
14 |
location.display |
string |
|
Text alternative for the resource |
Row healthcareService
# |
path |
type |
required |
description |
0 |
|
string |
* |
Subrow identifier. Must be string "healthcareService" |
|
healthcareService |
Reference |
|
The list of healthcare services that this worker provides for this role's Organization/Location(s) |
1 |
healthcareService.reference |
string |
|
Literal reference, Relative, internal or absolute URL |
2 |
healthcareService.type |
uri |
|
Type the reference refers to (e.g. "Patient") |
|
healthcareService.identifier |
Identifier |
|
Logical reference, when literal reference is not known |
3 |
healthcareService.identifier.use |
code |
|
usual | official | temp | secondary | old (If known) |
|
healthcareService.identifier.type |
CodeableConcept |
|
Description of identifier |
|
healthcareService.identifier.type.coding |
Coding |
|
Code defined by a terminology system |
4 |
healthcareService.identifier.type.coding.system |
uri |
|
Identity of the terminology system |
5 |
healthcareService.identifier.type.coding.version |
string |
|
Version of the system - if relevant |
6 |
healthcareService.identifier.type.coding.code |
code |
|
Symbol in syntax defined by the system |
7 |
healthcareService.identifier.type.coding.display |
string |
|
Representation defined by the system |
8 |
healthcareService.identifier.type.coding.userSelected |
boolean |
|
If this coding was chosen directly by the user |
9 |
healthcareService.identifier.type.text |
string |
|
Plain text representation of the concept |
10 |
healthcareService.identifier.system |
uri |
|
The namespace for the identifier value |
11 |
healthcareService.identifier.value |
string |
|
The value that is unique |
|
healthcareService.identifier.period |
Period |
|
Time period when id is/was valid for use |
12 |
healthcareService.identifier.period.start |
dateTime |
|
Starting time with inclusive boundary |
13 |
healthcareService.identifier.period.end |
dateTime |
|
End time with inclusive boundary, if not ongoing |
14 |
healthcareService.display |
string |
|
Text alternative for the resource |
Row telecom
# |
path |
type |
required |
description |
0 |
|
string |
* |
Subrow identifier. Must be string "telecom" |
|
telecom |
ContactPoint |
|
Contact details that are specific to the role/location/service |
1 |
telecom.system |
code |
|
phone | fax | email | pager | url | sms | other |
2 |
telecom.value |
string |
|
The actual contact point details |
3 |
telecom.use |
code |
|
home | work | temp | old | mobile - purpose of this contact point |
4 |
telecom.rank |
positiveInt |
|
Specify preferred order of use (1 = highest) |
|
telecom.period |
Period |
|
Time period when the contact point was/is in use |
5 |
telecom.period.start |
dateTime |
|
Starting time with inclusive boundary |
6 |
telecom.period.end |
dateTime |
|
End time with inclusive boundary, if not ongoing |
Row availableTime
# |
path |
type |
required |
description |
0 |
|
string |
* |
Subrow identifier. Must be string "availableTime" |
|
availableTime |
|
|
Times the Service Site is available |
1 |
availableTime.daysOfWeek |
code |
|
mon | tue | wed | thu | fri | sat | sun |
2 |
availableTime.allDay |
boolean |
|
Always available? e.g. 24 hour service |
3 |
availableTime.availableStartTime |
time |
|
Opening time of day (ignored if allDay = true) |
4 |
availableTime.availableEndTime |
time |
|
Closing time of day (ignored if allDay = true) |
Row notAvailable
# |
path |
type |
required |
description |
0 |
|
string |
* |
Subrow identifier. Must be string "notAvailable" |
|
notAvailable |
|
|
Not available during this time due to provided reason |
1 |
notAvailable.description |
string |
|
Reason presented to the user explaining why time not available |
|
notAvailable.during |
Period |
|
Service not available from this date |
2 |
notAvailable.during.start |
dateTime |
|
Starting time with inclusive boundary |
3 |
notAvailable.during.end |
dateTime |
|
End time with inclusive boundary, if not ongoing |
Row endpoint
# |
path |
type |
required |
description |
0 |
|
string |
* |
Subrow identifier. Must be string "endpoint" |
|
endpoint |
Reference |
|
Technical endpoints providing access to services operated for the practitioner with this role |
1 |
endpoint.reference |
string |
|
Literal reference, Relative, internal or absolute URL |
2 |
endpoint.type |
uri |
|
Type the reference refers to (e.g. "Patient") |
|
endpoint.identifier |
Identifier |
|
Logical reference, when literal reference is not known |
3 |
endpoint.identifier.use |
code |
|
usual | official | temp | secondary | old (If known) |
|
endpoint.identifier.type |
CodeableConcept |
|
Description of identifier |
|
endpoint.identifier.type.coding |
Coding |
|
Code defined by a terminology system |
4 |
endpoint.identifier.type.coding.system |
uri |
|
Identity of the terminology system |
5 |
endpoint.identifier.type.coding.version |
string |
|
Version of the system - if relevant |
6 |
endpoint.identifier.type.coding.code |
code |
|
Symbol in syntax defined by the system |
7 |
endpoint.identifier.type.coding.display |
string |
|
Representation defined by the system |
8 |
endpoint.identifier.type.coding.userSelected |
boolean |
|
If this coding was chosen directly by the user |
9 |
endpoint.identifier.type.text |
string |
|
Plain text representation of the concept |
10 |
endpoint.identifier.system |
uri |
|
The namespace for the identifier value |
11 |
endpoint.identifier.value |
string |
|
The value that is unique |
|
endpoint.identifier.period |
Period |
|
Time period when id is/was valid for use |
12 |
endpoint.identifier.period.start |
dateTime |
|
Starting time with inclusive boundary |
13 |
endpoint.identifier.period.end |
dateTime |
|
End time with inclusive boundary, if not ongoing |
14 |
endpoint.display |
string |
|
Text alternative for the resource |
Examples
Example #1
Input CSV
PractitionerRole,11,"example",true,"2012-01-01","2012-03-31","Practitioner/example",,,,,,,,,,,,,"Dr Adam Careful","Organization/f001",,,,,,,,,,,,,,"Adam is generally unavailable on public holidays and during the Christmas/New Year break"
identifier,,,,,,,,"http://www.acme.org/practitioners","23",,
code,"http://terminology.hl7.org/CodeSystem/v2-0286",,"RP",,,
specialty,"http://snomed.info/sct",,"408443003","General medical practice",,
location,"Location/1",,,,,,,,,,,,,"South Wing, second floor"
healthcareService,"HealthcareService/example",,,,,,,,,,,,,
telecom,"phone","(03) 5555 6473","work",,,
telecom,"email","adam.southern@example.org","work",,,
availableTime,"mon",,"09:00:00","16:30:00"
availableTime,"thu",,"09:00:00","12:00:00"
notAvailable,"Adam will be on extended leave during May 2017","2017-05-01","2017-05-20"
endpoint,"Endpoint/example",,,,,,,,,,,,,
Resulting resource
{
"resourceType": "PractitionerRole",
"id": "example",
"identifier": [
{
"system": "http://www.acme.org/practitioners",
"value": "23"
}
],
"active": true,
"period": {
"start": "2012-01-01",
"end": "2012-03-31"
},
"practitioner": {
"reference": "Practitioner/example",
"display": "Dr Adam Careful"
},
"organization": {
"reference": "Organization/f001"
},
"code": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0286",
"code": "RP"
}
]
}
],
"specialty": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "408443003",
"display": "General medical practice"
}
]
}
],
"location": [
{
"reference": "Location/1",
"display": "South Wing, second floor"
}
],
"healthcareService": [
{
"reference": "HealthcareService/example"
}
],
"telecom": [
{
"system": "phone",
"value": "(03) 5555 6473",
"use": "work"
},
{
"system": "email",
"value": "adam.southern@example.org",
"use": "work"
}
],
"availableTime": [
{
"daysOfWeek": [
"mon",
"tue",
"wed"
],
"availableStartTime": "09:00:00",
"availableEndTime": "16:30:00"
},
{
"daysOfWeek": [
"thu",
"fri"
],
"availableStartTime": "09:00:00",
"availableEndTime": "12:00:00"
}
],
"notAvailable": [
{
"description": "Adam will be on extended leave during May 2017",
"during": {
"start": "2017-05-01",
"end": "2017-05-20"
}
}
],
"availabilityExceptions": "Adam is generally unavailable on public holidays and during the Christmas/New Year break",
"endpoint": [
{
"reference": "Endpoint/example"
}
]
}
Example #2
Input CSV
PractitionerRole,2,"f003-0",,,,"Practitioner/f003",,,,,,,,,,,,,"Marc Versteegh","Organization/f001",,,,,,,,,,,,,"BMC",
code,"urn:oid:2.16.840.1.113883.2.4.15.111",,"01.000","Arts",,"Care role"
specialty,"urn:oid:2.16.840.1.113883.2.4.15.111",,"01.011","Cardiothoracal surgery",,"specialization"
Resulting resource
{
"resourceType": "PractitionerRole",
"id": "f003-0",
"practitioner": {
"reference": "Practitioner/f003",
"display": "Marc Versteegh"
},
"organization": {
"reference": "Organization/f001",
"display": "BMC"
},
"code": [
{
"coding": [
{
"system": "urn:oid:2.16.840.1.113883.2.4.15.111",
"code": "01.000",
"display": "Arts"
}
],
"text": "Care role"
}
],
"specialty": [
{
"coding": [
{
"system": "urn:oid:2.16.840.1.113883.2.4.15.111",
"code": "01.011",
"display": "Cardiothoracal surgery"
}
],
"text": "specialization"
}
]
}
Example #3
Input CSV
PractitionerRole,6,"example-0",,"2012-01-01","2012-03-31","Practitioner/example",,,,,,,,,,,,,"Adam Careful","Organization/f001",,,,,,,,,,,,,,
identifier,,,,,,,,"http://example.org/role-identifier","52",,
code,"http://terminology.hl7.org/CodeSystem/v2-0286",,"RP",,,
location,"Location/1",,,,,,,,,,,,,"South Wing, second floor"
healthcareService,"HealthcareService/example",,,,,,,,,,,,,
telecom,"email","dr.adam.careful@example.org",,,,
endpoint,"Endpoint/example",,,,,,,,,,,,,
Resulting resource
{
"resourceType": "PractitionerRole",
"id": "example-0",
"identifier": [
{
"system": "http://example.org/role-identifier",
"value": "52"
}
],
"period": {
"start": "2012-01-01",
"end": "2012-03-31"
},
"practitioner": {
"reference": "Practitioner/example",
"display": "Adam Careful"
},
"organization": {
"reference": "Organization/f001"
},
"code": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0286",
"code": "RP"
}
]
}
],
"location": [
{
"reference": "Location/1",
"display": "South Wing, second floor"
}
],
"healthcareService": [
{
"reference": "HealthcareService/example"
}
],
"telecom": [
{
"system": "email",
"value": "dr.adam.careful@example.org"
}
],
"endpoint": [
{
"reference": "Endpoint/example"
}
]
}
Example #4
Input CSV
PractitionerRole,0,"example-1",,"2012-01-01",,"Practitioner/example",,,,,,,,,,,,,"Adam Careful","Organization/2",,,,,,,,,,,,,"Good Health Clinic",
Resulting resource
{
"resourceType": "PractitionerRole",
"id": "example-1",
"period": {
"start": "2012-01-01"
},
"practitioner": {
"reference": "Practitioner/example",
"display": "Adam Careful"
},
"organization": {
"reference": "Organization/2",
"display": "Good Health Clinic"
}
}
Example #5
Input CSV
PractitionerRole,3,"example-2",,"2016-07-01","2017-06-30","Practitioner/example",,,,,,,,,,,,,"Adam Careful","Organization/2",,,,,,,,,,,,,"Good Health Clinic","Public Holidays"
code,,,,,,"On call physcologist"
telecom,"phone","555 123456","mobile",,,
availableTime,"sat",true,,
Resulting resource
{
"resourceType": "PractitionerRole",
"id": "example-2",
"period": {
"start": "2016-07-01",
"end": "2017-06-30"
},
"practitioner": {
"reference": "Practitioner/example",
"display": "Adam Careful"
},
"organization": {
"reference": "Organization/2",
"display": "Good Health Clinic"
},
"code": [
{
"text": "On call physcologist"
}
],
"telecom": [
{
"system": "phone",
"value": "555 123456",
"use": "mobile"
}
],
"availableTime": [
{
"daysOfWeek": [
"sat",
"sun"
],
"allDay": true
}
],
"availabilityExceptions": "Public Holidays"
}