PractitionerRole

PractitionerRole

practitionerroleGet

Get a PractitionerRole resource based on the resource ID, or search by practitioner, specialty, service, or location.


/practitionerrole/

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json,application/xml"\
"//practitionerrole/?_id=&practitioner=&specialty=&service=&location="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PractitionerRoleApi;

import java.io.File;
import java.util.*;

public class PractitionerRoleApiExample {

    public static void main(String[] args) {
        
        PractitionerRoleApi apiInstance = new PractitionerRoleApi();
        String id = id_example; // String | Resource ID.
        String practitioner = practitioner_example; // String | Practitioner name or identifier.
        String specialty = specialty_example; // String | The practitioner has this specialty at an organization.
        String service = service_example; // String | The list of healthcare services that this worker provides for this role's Organization/Location(s).
        String location = location_example; // String | One of the locations at which this practitioner provides care.
        try {
            PractitionerRole result = apiInstance.practitionerroleGet(id, practitioner, specialty, service, location);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PractitionerRoleApi#practitionerroleGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PractitionerRoleApi;

public class PractitionerRoleApiExample {

    public static void main(String[] args) {
        PractitionerRoleApi apiInstance = new PractitionerRoleApi();
        String id = id_example; // String | Resource ID.
        String practitioner = practitioner_example; // String | Practitioner name or identifier.
        String specialty = specialty_example; // String | The practitioner has this specialty at an organization.
        String service = service_example; // String | The list of healthcare services that this worker provides for this role's Organization/Location(s).
        String location = location_example; // String | One of the locations at which this practitioner provides care.
        try {
            PractitionerRole result = apiInstance.practitionerroleGet(id, practitioner, specialty, service, location);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PractitionerRoleApi#practitionerroleGet");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // Resource ID. (optional)
String *practitioner = practitioner_example; // Practitioner name or identifier. (optional)
String *specialty = specialty_example; // The practitioner has this specialty at an organization. (optional)
String *service = service_example; // The list of healthcare services that this worker provides for this role's Organization/Location(s). (optional)
String *location = location_example; // One of the locations at which this practitioner provides care. (optional)

PractitionerRoleApi *apiInstance = [[PractitionerRoleApi alloc] init];

[apiInstance practitionerroleGetWith:id
    practitioner:practitioner
    specialty:specialty
    service:service
    location:location
              completionHandler: ^(PractitionerRole output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PractitionerRole = require('practitioner_role');

var api = new PractitionerRole.PractitionerRoleApi()
var opts = { 
  'id': id_example, // {{String}} Resource ID.
  'practitioner': practitioner_example, // {{String}} Practitioner name or identifier.
  'specialty': specialty_example, // {{String}} The practitioner has this specialty at an organization.
  'service': service_example, // {{String}} The list of healthcare services that this worker provides for this role's Organization/Location(s).
  'location': location_example // {{String}} One of the locations at which this practitioner provides care.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.practitionerroleGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class practitionerroleGetExample
    {
        public void main()
        {

            var apiInstance = new PractitionerRoleApi();
            var id = id_example;  // String | Resource ID. (optional) 
            var practitioner = practitioner_example;  // String | Practitioner name or identifier. (optional) 
            var specialty = specialty_example;  // String | The practitioner has this specialty at an organization. (optional) 
            var service = service_example;  // String | The list of healthcare services that this worker provides for this role's Organization/Location(s). (optional) 
            var location = location_example;  // String | One of the locations at which this practitioner provides care. (optional) 

            try
            {
                PractitionerRole result = apiInstance.practitionerroleGet(id, practitioner, specialty, service, location);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PractitionerRoleApi.practitionerroleGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiPractitionerRoleApi();
$id = id_example; // String | Resource ID.
$practitioner = practitioner_example; // String | Practitioner name or identifier.
$specialty = specialty_example; // String | The practitioner has this specialty at an organization.
$service = service_example; // String | The list of healthcare services that this worker provides for this role's Organization/Location(s).
$location = location_example; // String | One of the locations at which this practitioner provides care.

try {
    $result = $api_instance->practitionerroleGet($id, $practitioner, $specialty, $service, $location);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PractitionerRoleApi->practitionerroleGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PractitionerRoleApi;

my $api_instance = WWW::SwaggerClient::PractitionerRoleApi->new();
my $id = id_example; # String | Resource ID.
my $practitioner = practitioner_example; # String | Practitioner name or identifier.
my $specialty = specialty_example; # String | The practitioner has this specialty at an organization.
my $service = service_example; # String | The list of healthcare services that this worker provides for this role's Organization/Location(s).
my $location = location_example; # String | One of the locations at which this practitioner provides care.

eval { 
    my $result = $api_instance->practitionerroleGet(id => $id, practitioner => $practitioner, specialty => $specialty, service => $service, location => $location);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PractitionerRoleApi->practitionerroleGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.PractitionerRoleApi()
id = id_example # String | Resource ID. (optional)
practitioner = practitioner_example # String | Practitioner name or identifier. (optional)
specialty = specialty_example # String | The practitioner has this specialty at an organization. (optional)
service = service_example # String | The list of healthcare services that this worker provides for this role's Organization/Location(s). (optional)
location = location_example # String | One of the locations at which this practitioner provides care. (optional)

try: 
    api_response = api_instance.practitionerrole_get(id=id, practitioner=practitioner, specialty=specialty, service=service, location=location)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PractitionerRoleApi->practitionerroleGet: %s\n" % e)

Parameters

Query parameters
Name Description
_id
String
Resource ID.
practitioner
String
Practitioner name or identifier.
specialty
String
The practitioner has this specialty at an organization.
service
String
The list of healthcare services that this worker provides for this role's Organization/Location(s).
location
String
One of the locations at which this practitioner provides care.

Responses

Status: 200 - Successful operation

Status: 400 - Bad request. The error was encountered when parsing the content into the appropriate FHIR resource.

Status: 401 - Unauthorized. Possible causes
  • a token failed authorization
  • a user could not be found

Status: 403 - Forbidden. Possible causes
  • a code or query parameter was not supported
  • a code may have had no valid equivalent in the EHR
  • a user does not have enough permissions to perform a certain action
  • a query was invalid, for example a search token value ended in an escape character

Status: 404 - Resource not found. Possible causes
  • an operation was not supported
  • the FHIR resource was not implemented by the product adapter
  • the FHIR resource was not found
  • the service was unable to generate the FHIR resource possibly because a required element was not provided
  • the specified patient could not be found in the EHR
  • the paging information that was sent to the product was not correct indicating that the request for the page could not be honored

Status: 405 - Method not allowed. Possible cause
  • resource does not exist

Status: 412 - Precondition failed. Possible causes
  • certain precondition checks failed, for example a version mismatch
  • an update could not be processed as the If-Match tag didn't match the version

Status: 413 - Request entity too large. Possible cause
  • a request could not be honored because it was too expensive for the server to execute, for example a search that would return a million records

Status: 422 - Unprocessable entity. Possible cause
  • an exception was thrown upon violated constraint, for example missing or invalid element for resource or if an update on a resource did not happen

Status: 429 - Too many requests. Possible causes
  • too many concurrent FHIR requests

Status: 500 - Internal server error. Possible causes
  • the system was missing configuration information, for example if a URL to a service was missing or a security group was not found for the user
  • none of the available exceptions are appropriate