xCaliber healthCare Data Mesh

PractitionerRole

Overview

The PractitionerRole API allows managing provider roles, specialties, locations, availability, and healthcare services. Healthcare developers can use it to build applications for provider search and scheduling, privilege management, and integration with clinical workflows.

Use Cases

  • Provider Directory - Maintain provider profiles with associated roles, specialties, qualifications.
  • Scheduling - Build scheduling systems using role info on provider availability and services.
  • Clinical Workflows - Integrate role data like specialties and privileges into order sets and documentation.
  • Referral Management - Create role profiles to enable intelligent referral suggestions and routing.
  • Utilization Management - Analyze role data to identify gaps or duplication in services and specialties.
  • Privileging - Manage facility-specific provider privileges and restrictions using role profiles.
  • Compliance Reporting - Generate reports on role distribution, access, and auditing to meet compliance needs.
  • Patient Assignment - Map patients to appropriate providers based on role specialties and skills.
  • Telehealth - Define provider virtual care roles with services, availability, and technology details.
  • Credentialing - Validate credentials and maintain certifications associated with practitioner roles.

EHR Data Model

EHRSupported?Mapped Source Object
Athena
Elation
Epic

Object Definition

{
  "resourceType": "PractitionerRole",
  "id": "example",
  "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/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"
    }
  ],
  "meta": {
    "tag": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/v3-ActReason",
        "code": "HTEST",
        "display": "test health data"
      }
    ]
  }
}

Data Fields

Data FieldTypeDescription
resourceTypePractitionerRoleThis is a PractitionerRole resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedBackboneElementThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionExtensionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtensionExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifierIdentifierBusiness Identifiers that are specific to a role/location.
activebooleanWhether this practitioner role record is in active use.
periodPeriodThe period during which the person is authorized to act as a practitioner in these role(s) for the organization.
practitionerReferencePractitioner that is able to provide the defined services for the organization.
organizationReferenceThe organization where the Practitioner performs the roles associated.
codeCodeableConceptRoles which this practitioner is authorized to perform for the organization.
specialtyCodeableConceptSpecific specialty of the practitioner.
locationReferenceThe location(s) at which this practitioner provides care.
healthcareServiceReferenceThe list of healthcare services that this worker provides for this role's Organization/Location(s).
telecomContactPointContact details that are specific to the role/location/service.
availableTimeBackboneElementA collection of times the practitioner is available or performing this role at the location and/or healthcareservice.
availableTime.idstringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
availableTime.extensionExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
availableTime.modifierExtensionExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
availableTime.daysOfWeekcodeIndicates which days of the week are available between the start and end Times.
availableTime.allDaybooleanIs this always available? (hence times are irrelevant) e.g. 24 hour service.
availableTime.availableStartTimetimeThe opening time of day. Note: If the AllDay flag is set, then this time is ignored.
availableTime.availableEndTimetimeThe closing time of day. Note: If the AllDay flag is set, then this time is ignored.
notAvailableBackboneElementThe practitioner is not available or performing this role during this period of time due to the provided reason.
notAvailable.idstringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
notAvailable.extensionExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
notAvailable.modifierExtensionExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
notAvailable.descriptionstringThe reason that can be presented to the user as to why this time is not available.
notAvailable.duringPeriodService is not available (seasonally or for a public holiday) from this date.
availabilityExceptionsstringA description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times.
endpointReferenceTechnical endpoints providing access to services operated for the practitioner with this role.

Extensions

NameURL

Operations & APIs

PractitionerRole-GET

PractitionerRole-POST

PractitionerRole ID-GET

PractitionerRole ID-PUT

PractitionerRole ID-DELETE