The PractitionerRole resource implements the FHIR R4 PractitionerRole specification and US Core v3.1.1 PractitionerRole profile

Fields

Name Type Cardinality Required Description
identifier Identifier 0..*   Business Identifiers that are specific to a role/location
active boolean 0..1   Whether this practitioner role record is in active use
period Period 0..1   The period during which the practitioner is authorized to perform in these role(s)
practitioner Reference(Practitioner) 0..1   Practitioner that is able to provide the defined services for the organization
organization Reference(Organization) 0..1   Organization where the roles are available
code CodeableConcept 0..*   Roles which this practitioner may perform Practitioner role ( Example )
specialty CodeableConcept 0..*   Specific specialty of the practitioner Practice Setting Code Value Set ( Preferred )
location Reference(Location) 0..*   The location(s) at which this practitioner provides care
healthcareService Reference(HealthcareService) 0..*   The list of healthcare services that this worker provides for this role’s Organization/Location(s)
telecom ContactPoint 0..*   Contact details that are specific to the role/location/service
availableTime BackboneElement 0..*   Times the Service Site is available
daysOfWeek code 0..*   mon | tue | wed | thu | fri | sat | sun DaysOfWeek ( Required )
allDay boolean 0..1   Always available? e.g. 24 hour service
availableStartTime time 0..1   Opening time of day (ignored if allDay = true)
availableEndTime time 0..1   Closing time of day (ignored if allDay = true)
notAvailable BackboneElement 0..*   Not available during this time due to provided reason
description string 1..1 * Reason presented to the user explaining why time not available
during Period 0..1   Service not available from this date
availabilityExceptions string 0..1   Description of availability exceptions
endpoint Reference(Endpoint) 0..*   Technical endpoints providing access to services operated for the practitioner with this role
PractitionerRole DomainResource     Roles/organizations the practitioner is associated withElements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
identifier Identifier 0..*   Business Identifiers that are specific to a role/location
active boolean 0..1   Whether this practitioner role record is in active use
period Period 0..1   The period during which the practitioner is authorized to perform in these role(s)
practitioner Reference(Practitioner) 0..1   Practitioner that is able to provide the defined services for the organization
organization Reference(Organization) 0..1   Organization where the roles are available
code CodeableConcept 0..*   Roles which this practitioner may perform Practitioner role ( Example )
specialty CodeableConcept 0..*   Specific specialty of the practitioner Practice Setting Code Value Set ( Preferred )
location Reference(Location) 0..*   The location(s) at which this practitioner provides care
healthcareService Reference(HealthcareService) 0..*   The list of healthcare services that this worker provides for this role’s Organization/Location(s)
telecom ContactPoint 0..*   Contact details that are specific to the role/location/service
availableTime BackboneElement 0..*   Times the Service Site is available
daysOfWeek code 0..*   mon | tue | wed | thu | fri | sat | sun DaysOfWeek ( Required )
allDay boolean 0..1   Always available? e.g. 24 hour service
availableStartTime time 0..1   Opening time of day (ignored if allDay = true)
availableEndTime time 0..1   Closing time of day (ignored if allDay = true)
notAvailable BackboneElement 0..*   Not available during this time due to provided reason
description string 1..1 * Reason presented to the user explaining why time not available
during Period 0..1   Service not available from this date
availabilityExceptions string 0..1   Description of availability exceptions
endpoint Reference(Endpoint) 0..*   Technical endpoints providing access to services operated for the practitioner with this role

Interactions

Read

Get a PractitionerRole entry by id

GET /PractitionerRole/:id

Example

Request

https://r4cert.medicasoft.us/api/fhir/PractitionerRole/f28570cc-a58a-4657-899b-e3277f7fc1a2

Response

{
  "resourceType": "PractitionerRole",
  "id": "f28570cc-a58a-4657-899b-e3277f7fc1a2",
  "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>"
  },
  "identifier": [
    {
      "system": "http://www.acme.org/practitioners",
      "value": "23"
    }
  ],
  "active": true,
  "period": {
    "start": "2012-01-01",
    "end": "2012-03-31"
  },
  "practitioner": {
    "reference": "Practitioner/bf185af6-4261-4732-bc97-044a552e2572",
    "display": "Dr Adam Careful"
  },
  "organization": {
    "reference": "Organization/1c76992d-6b88-4906-a2b2-0a109f549242"
  },
  "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/1c76992d-6b88-4906-a2b2-0a109f549242",
      "display": "South Wing, second floor"
    }
  ],
  "healthcareService": [
    {
      "reference": "HealthcareService/c56b47f7-41e4-4c51-8cd5-b767ea0c97da"
    }
  ],
  "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/1c76992d-6b88-4906-a2b2-0a109f549242"
    }
  ]
}

Query PractitionerRole resources

GET /PractitionerRole?:query_parameters

Parameters

Name Type Description
active token Whether this practitioner role record is in active use
date date The period during which the practitioner is authorized to perform in these role(s)
email token A value in an email contact
endpoint reference Technical endpoints providing access to services operated for the practitioner with this role
identifier token A practitioner’s Identifier
location reference One of the locations at which this practitioner provides care
organization reference The identity of the organization the practitioner represents / acts on behalf of
phone token A value in a phone contact
practitioner reference Practitioner that is able to provide the defined services for the organization
role token The practitioner can perform this role at for the organization
service reference The list of healthcare services that this worker provides for this role’s Organization/Location(s)
specialty token The practitioner has this specialty at an organization
telecom token The value in any kind of contact

Errors

Code Description
400 Invalid parameters
404 Resource not found