PractitionerRole - FHIR Resource (stu3)


This PractitionerRole Resource uses the FHIR API standard for access and structure.

Validate an PractitionerRole FHIR Resource (stu3)



Resource Attributes

AttributeField is listTypeDescription
activefalseboolean# Whether this practitioner's record is in active use
availabilityExceptionsfalsestring# Description of availability exceptions
availableTimetrueData Type# Times the Service Site is available
codetrueCodeableConcept# Roles which this practitioner may perform
endpointtrueReference# Technical endpoints providing access to services operated for the practitioner with this role
healthcareServicetrueReference# The list of healthcare services that this worker provides for this role's Organization/Location(s)
identifiertrueIdentifier# Business Identifiers that are specific to a role/location
locationtrueReference# The location(s) at which this practitioner provides care
notAvailabletrueData Type# Not available during this time due to provided reason
organizationfalseReference# Organization where the roles are available
periodfalsePeriod# The period during which the practitioner is authorized to perform in these role(s)
practitionerfalseReference# Practitioner that is able to provide the defined services for the organation
specialtytrueCodeableConcept# Specific specialty of the practitioner
telecomtrueContactPoint# Contact details that are specific to the role/location/service

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 the like so:

https://api.1up.health/fhir/stu3/PractitionerRole?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
activetextactive
datedateperiod
emailtexttelecom.where
endpointreferenceendpoint
identifiertextidentifier
locationreferencelocation
organizationreferenceorganization
phonetexttelecom.where
practitionerreferencepractitioner
roletextcode
servicereferencehealthcareService
specialtytextspecialty
telecomtexttelecom