The FHIR STU3 `PractitionerRole` resource is used to obtain information about healthcare providers known to Health Gorilla. You can also create new users (providers or staff) in your organization using this resource. FHIR Resource: Practitioner [https://www.hl7.org/fhir/practitionerrole.html](https://www.hl7.org/fhir/practitionerrole.html) # Supported Attributes

Field Name	Comments
identifier	* NPI * UID
active
code	Administrative Role * [http://hl7.org/fhir/practitioner-role](http://hl7.org/fhir/practitioner-role) * [https://www.healthgorilla.com/administrative-role](https://www.healthgorilla.com/administrative-role)
specialty
practitioner
organization
location
telecom
address

```http Endpoint URI https://api.healthgorilla.com/fhir/PractitionerRole ``` # FHIR Operations The following operations are currently supported: ## 1. Read | HTTP Request | Method | Action | | :---------------------- | :----- | :---------------------- | | /PractitionerRole/\{ID} | GET | Retrieve provider by ID | ## 2. Search | HTTP Request | Method | Action | | :-------------------------------------- | :----- | :-------------------------------------------------- | | /PractitionerRole?\[parameter=\{value}] | GET | Retrieve providers by the specified search criteria | Search Parameters:

Name	Type	Description
Identifier	Token	A practitioner's Identifier.
practitioner	Reference
organization	Reference
location	Reference
role	Token	The only value supported: doctor
speciality	Token
* include		Use to include related practitioner and organization into result Bundle.\ [https://www.hl7.org/fhir/STU3/search.html#include](https://www.hl7.org/fhir/STU3/search.html#include)

Available values for include directive: | Include | Criteria | Resource | | :-------- | :---------------------------- | :----------- | | \_include | PractitionerRole:location | Location | | \_include | PractitionerRole:organization | Organization | | \_include | PractitionerRole:practitioner | Practitioner | ### Examples #### 2.1 Search entries by NPI number: ```http HTTP GET https://api.healthgorilla.com/fhir/Practitioner?identifier=http://hl7.org/fhir/sid/us-npi|1234567893 ``` #### 2.2 Search entries by Health Gorilla assigned identifier: ```http HTTP GET https://api.healthgorilla.com/fhir/Practitioner?identifier=https://www.healthgorilla.com|f3c88f5b53910aba83b224f4 ``` #### 2.3 Search endocrinologists in the specified practice. Related Practitioner entries are also included into the result bundle: ```http HTTP GET https://api.healthgorilla.com/fhir/PractitionerRole ?organization=t-d5da4352af2201ace56ca725 &role=http://hl7.org/fhir/practitioner-role|doctor &specialty=Endocrinology &_include=PractitionerRole:practitioner ``` #### 2.4. Search nurses in the specified practice and location. Related Organization entries are also included into the result bundle: ```http HTTP GET https://api.healthgorilla.com/fhir/PractitionerRole ?organization=t-d5da4352af2201ace56ca725 &location=t-d5da4352af2201ace56ca725-f3c88f5b53910aba83b224f4 &role=http://hl7.org/fhir/practitioner-role|nurse &_include=PractitionerRole:organization ``` #### 2.5 Get PractitionerRole entries by Practitioner: ```http HTTP GET https://api.healthgorilla.com/fhir/PractitionerRole ?practitioner=d5da4352bb6290302c4cc8d7 ``` ## 3. Create Creates Health Gorilla user with roles Doctor, Staff, Nurse, Office Manager or Billing Staff.\ Health Gorilla uses additional attributes to specify initial password and login, defined as FHIR Extensions: * [https://www.healthgorilla.com/fhir/3.0/StructureDefinition/hg-practitioner-login](https://www.healthgorilla.com/fhir/3.0/StructureDefinition/hg-practitioner-login) * [https://www.healthgorilla.com/fhir/3.0/StructureDefinition/hg-practitioner-password](https://www.healthgorilla.com/fhir/3.0/StructureDefinition/hg-practitioner-password) Profile to determine Practitioner with specific attributes is [https://healthgorilla.com/fhir/StructureDefinition/hg-practitioner](https://healthgorilla.com/fhir/StructureDefinition/hg-practitioner) Health Gorilla supports the following roles: | Code System | System | | :----------------------------------------------------------------------------------------------------- | :------------ | | [http://hl7.org/fhir/practitioner-role](http://hl7.org/fhir/practitioner-role) | doctor | | [https://www.healthgorilla.com/administrative-role](https://www.healthgorilla.com/administrative-role) | provider | | [http://hl7.org/fhir/practitioner-role](http://hl7.org/fhir/practitioner-role) | nurse | | [https://www.healthgorilla.com/administrative-role](https://www.healthgorilla.com/administrative-role) | nurse | | [https://www.healthgorilla.com/administrative-role](https://www.healthgorilla.com/administrative-role) | staff | | [https://www.healthgorilla.com/administrative-role](https://www.healthgorilla.com/administrative-role) | officeManager | | [https://www.healthgorilla.com/administrative-role](https://www.healthgorilla.com/administrative-role) | billingStaff | ### Examples #### 3.1 Create Health Gorilla user with role Doctor ```http POST /fhir/PractitionerRole { "resourceType": "PractitionerRole", "contained": [ { "resourceType": "Practitioner", "id": "1", "meta": { "profile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner", "https://healthgorilla.com/fhir/StructureDefinition/hg-practitioner" ] }, "extension": [ { "url": "https://www.healthgorilla.com/fhir/3.0/StructureDefinition/hg-practitioner-login", "valueString": "sample_user_login_name" }, { "url": "https://www.healthgorilla.com/fhir/3.0/StructureDefinition/hg-practitioner-password", "valueString": "ChangeMe!" } ], "identifier": [ { "system": "http://hl7.org/fhir/sid/us-npi", "value": "123456789" } ], "active": true, "name": [ { "use": "official", "text": "Doctor 5 FHIR, MD", "family": "FHIR", "given": [ "Doctor", "5" ], "suffix": [ "MD" ] } ], "telecom": [ { "system": "email", "value": "testdocfhir@example.com", "use": "work" } ] } ], "active": true, "practitioner": { "reference": "#1" }, "code": [ { "coding": [ { "system": "https://www.healthgorilla.com/administrative-role", "code": "provider", "display": "Provider" }, { "system": "http://hl7.org/fhir/practitioner-role", "code": "doctor", "display": "Doctor" } ] } ] } ``` #### 3.2 Create Health Gorilla User with role Staff ```http POST /fhir/PractitionerRole { "resourceType": "PractitionerRole", "contained": [ { "resourceType": "Practitioner", "id": "1", "meta": { "profile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner", "https://healthgorilla.com/fhir/StructureDefinition/hg-practitioner" ] }, "extension": [ { "url": "https://www.healthgorilla.com/fhir/StructureDefinition/hg-practitioner-login", "valueString": "teststaff" }, { "url": "https://www.healthgorilla.com/fhir/StructureDefinition/hg-practitioner-password", "valueString": "ChangeMe!" } ], "active": true, "name": [ { "use": "official", "text": "Staff FHIR", "family": "FHIR", "given": [ "Staff" ] } ], "telecom": [ { "system": "email", "value": "testsfafffhir@example.com", "use": "work" } ] } ], "active": true, "practitioner": { "reference": "#1" }, "code": [ { "coding": [ { "system": "https://www.healthgorilla.com/administrative-role", "code": "officeManager", "display": "Office Manager" }, { "system": "http://hl7.org/fhir/practitioner-role", "code": "staff", "display": "Staff" } ] } ] } ``` ## 4. Update | HTTP Request | Method | Action | | :---------------------- | :----- | :-------------------------------- | | /PractitionerRole/\{ID} | PUT | Updates PractitionerRole resource | ## 5. Signature Attach a provider signature. Attaching a provider signature to the lab order will create a signature of type "Author's Signature". These APIs can be used in conjunction with the UI, where you can: * Read signatures created via UI * Add a new signature via FHIR * Read signatures created via FHIR * Sign an order with a signature created via FHIR | HTTP Request | Method | Action | | :----------------------------------------------- | :----- | :-------------------------------------------- | | /PractitionerRole/\{DOCTOR\_ID}/$signatures | GET | Returns list of signatures for a doctor | | /PractitionerRole/\{DOCTOR\_ID}/$addSignature | POST | Creates a signature for a doctor | | /PractitionerRole/\{DOCTOR\_ID}/$removeSignature | GET | Remove signature by signature ID for a doctor | ### Examples #### 5.1 Return a list of signatures for a doctor ```http HTTP GET https://api.healthgorilla.com/fhir/PractitionerRole/{DOCTOR_ID}/$signatures?_format=json ``` #### 5.2 Create a signature for a doctor ```http HTTP POST https://api.healthgorilla.com/fhir/PractitionerRole/{DOCTOR_ID}/$addSignature?_format=json ``` #### 5.3 Remove a signature associated with the doctor ```http HTTP GET https://api.healthgorilla.com/fhir/PractitionerRole/{DOCTOR_ID}/$removeSignature?_format=json&signatureId=fa35ac62e7039ac61ed63719 ```