PractitionerRole - FHIR Resource (stu3)
This PractitionerRole Resource uses the FHIR API standard for access and structure.
Validate an PractitionerRole FHIR Resource (stu3)
PractitionerRole Attributes
AttributeField is listTypeDescription
Description: Roles which this practitioner may perform
FHIR Version: stu3
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"code": [
{
"coding": [
{
"code": "RP",
"system": "http://hl7.org/fhir/v2/0286"
}
]
}
]Learn more about the (PractitionerRole) code FHIR attribute
Description: Practitioner that is able to provide the defined services for the organation
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"practitioner": {
"display": "Dr Adam Careful",
"reference": "Practitioner/example"
}Learn more about the (PractitionerRole) practitioner FHIR attribute
Description: Business Identifiers that are specific to a role/location
FHIR Version: stu3
Attribute Type : Identifier
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"identifier": [
{
"system": "http://www.acme.org/practitioners",
"value": "23"
}
]Learn more about the (PractitionerRole) identifier FHIR attribute
Description: Contact details that are specific to the role/location/service
FHIR Version: stu3
Attribute Type : ContactPoint
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"telecom": [
{
"use": "work",
"system": "phone",
"value": "(03) 5555 6473"
},
{
"use": "work",
"system": "email",
"value": "adam.southern@example.org"
}
]Learn more about the (PractitionerRole) telecom FHIR attribute
Description: Description of availability exceptions
FHIR Version: stu3
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"availabilityExceptions": "Adam is generally unavailable on public holidays and during the Christmas/New Year break"Learn more about the (PractitionerRole) availabilityExceptions FHIR attribute
Description: Times the Service Site is available
FHIR Version: stu3
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"availableTime": [
{
"availableStartTime": "09:00:00",
"availableEndTime": "16:30:00",
"daysOfWeek": [
"mon",
"tue",
"wed"
]
},
{
"availableStartTime": "09:00:00",
"availableEndTime": "12:00:00",
"daysOfWeek": [
"thu",
"fri"
]
}
]Learn more about the (PractitionerRole) availableTime FHIR attribute
Description: The period during which the practitioner is authorized to perform in these role(s)
FHIR Version: stu3
Attribute Type : Period
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"period": {
"start": "2012-01-01",
"end": "2012-03-31"
}Learn more about the (PractitionerRole) period FHIR attribute
Description: Specific specialty of the practitioner
FHIR Version: stu3
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"specialty": [
{
"coding": [
{
"code": "408443003",
"system": "http://snomed.info/sct",
"display": "General medical practice"
}
]
}
]Learn more about the (PractitionerRole) specialty FHIR attribute
Description: Not available during this time due to provided reason
FHIR Version: stu3
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"notAvailable": [
{
"during": {
"start": "2017-05-01",
"end": "2017-05-20"
},
"description": "Adam will be on extended leave during May 2017"
}
]Learn more about the (PractitionerRole) notAvailable FHIR attribute
Description: Technical endpoints providing access to services operated for the practitioner with this role
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"endpoint": [
{
"reference": "Endpoint/example"
}
]Learn more about the (PractitionerRole) endpoint FHIR attribute
Description: The location(s) at which this practitioner provides care
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"location": [
{
"display": "South Wing, second floor",
"reference": "Location/1"
}
]Learn more about the (PractitionerRole) location FHIR attribute
Description: Whether this practitioner's record is in active use
FHIR Version: stu3
Attribute Type : boolean
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"active": trueLearn more about the (PractitionerRole) active FHIR attribute
Description: Organization where the roles are available
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"organization": {
"reference": "Organization/f001"
}Learn more about the (PractitionerRole) organization FHIR attribute
Description: The list of healthcare services that this worker provides for this role's Organization/Location(s)
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"healthcareService": [
{
"reference": "HealthcareService/example"
}
]Learn more about the (PractitionerRole) healthcareService FHIR attribute
PractitionerRole Example
{
"code": [
{
"coding": [
{
"code": "RP",
"system": "http://hl7.org/fhir/v2/0286"
}
]
}
],
"practitioner": {
"display": "Dr Adam Careful",
"reference": "Practitioner/example"
},
"endpoint": [
{
"reference": "Endpoint/example"
}
],
"resourceType": "PractitionerRole",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n\t\t\t<p>\n\t\t\t\tDr Adam Careful is a Referring Practitioner for Acme Hospital from 1-Jan 2012 to 31-Mar\n\t\t\t\t2012\n\t\t\t</p>\n\t\t</div>"
},
"availableTime": [
{
"availableStartTime": "09:00:00",
"availableEndTime": "16:30:00",
"daysOfWeek": [
"mon",
"tue",
"wed"
]
},
{
"availableStartTime": "09:00:00",
"availableEndTime": "12:00:00",
"daysOfWeek": [
"thu",
"fri"
]
}
],
"period": {
"start": "2012-01-01",
"end": "2012-03-31"
},
"specialty": [
{
"coding": [
{
"code": "408443003",
"system": "http://snomed.info/sct",
"display": "General medical practice"
}
]
}
],
"telecom": [
{
"use": "work",
"system": "phone",
"value": "(03) 5555 6473"
},
{
"use": "work",
"system": "email",
"value": "adam.southern@example.org"
}
],
"availabilityExceptions": "Adam is generally unavailable on public holidays and during the Christmas/New Year break",
"location": [
{
"display": "South Wing, second floor",
"reference": "Location/1"
}
],
"healthcareService": [
{
"reference": "HealthcareService/example"
}
],
"active": true,
"organization": {
"reference": "Organization/f001"
},
"identifier": [
{
"system": "http://www.acme.org/practitioners",
"value": "23"
}
],
"notAvailable": [
{
"during": {
"start": "2017-05-01",
"end": "2017-05-20"
},
"description": "Adam will be on extended leave during May 2017"
}
],
"id": "example"
}PractitionerRole Structure
{
"resourceType" : "PractitionerRole",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // Business Identifiers that are specific to a role/location
"active" : <boolean>, // Whether this practitioner's record is in active use
"period" : { Period }, // The period during which the practitioner is authorized to perform in these role(s)
"practitioner" : { Reference(Practitioner) }, // Practitioner that is able to provide the defined services for the organation
"organization" : { Reference(Organization) }, // Organization where the roles are available
"code" : [{ CodeableConcept }], // Roles which this practitioner may perform
"specialty" : [{ CodeableConcept }], // Specific specialty of the practitioner
"location" : [{ Reference(Location) }], // The location(s) at which this practitioner provides care
"healthcareService" : [{ Reference(HealthcareService) }], // The list of healthcare services that this worker provides for this role's Organization/Location(s)
"telecom" : [{ ContactPoint }], // Contact details that are specific to the role/location/service
"availableTime" : [{ // Times the Service Site is available
"daysOfWeek" : ["<code>"], // mon | tue | wed | thu | fri | sat | sun
"allDay" : <boolean>, // Always available? e.g. 24 hour service
"availableStartTime" : "<time>", // Opening time of day (ignored if allDay = true)
"availableEndTime" : "<time>" // Closing time of day (ignored if allDay = true)
}],
"notAvailable" : [{ // Not available during this time due to provided reason
"description" : "<string>", // R! Reason presented to the user explaining why time not available
"during" : { Period } // Service not availablefrom this date
}],
"availabilityExceptions" : "<string>", // Description of availability exceptions
"endpoint" : [{ Reference(Endpoint) }] // Technical endpoints providing access to services operated for the practitioner with this role
}
PractitionerRole Search Parameters
The following search parameters can be used to query PractitionerRole resources. Just submit them like so:
https://api.1up.health/fhir/stu3/PractitionerRole?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
active | text | active |
date | date | period |
email | text | telecom.where |
endpoint | reference | endpoint |
identifier | text | identifier |
location | reference | location |
organization | reference | organization |
phone | text | telecom.where |
practitioner | reference | practitioner |
role | text | code |
service | reference | healthcareService |
specialty | text | specialty |
telecom | text | telecom |
