Organization
Use the Organization resource to obtain information about Practices, Laboratories, Hospitals and other facilities that exist in the Health Gorilla catalog.
FHIR Resource: Organization https://www.hl7.org/fhir/organization.html
Supported Attributes
Field Name | Comments |
---|---|
active | |
type | There are several value sets supported: https://www.hl7.org/fhir/valueset-organization-type.html https://www.healthgorilla.com/fhir/ValueSet/facility-type * https://www.healthgorilla.com/fhir/ValueSet/organization-type |
name | |
telecom | |
address | |
partOf | Link to the department or to the parent Organization. |
https://api.healthgorilla.com/fhir/Organization
FHIR Operations
The following operations are currently supported:
1. Read
HTTP Request | Method | Action |
---|---|---|
/Organization/{ID} | GET | Retrieve organization by ID |
2. Search
HTTP Request | Method | Action |
---|---|---|
/Organization?[parameter={value}] | GET | Retrieve Organizations by the specified search criteria |
Search Parameters:
Name | Type | Description |
---|---|---|
type | Token | Code for the type of organization. |
name | string | Portion of the organization's name or alias. |
address-state | string | State in the organization's address. |
address-city | string | City in the organization's address. |
address-postalcode | string | Postal code in the organization's address. |
near-distance | Quantity | Miles |
ordering-enabled | token | Ordering-enabled property. Use to get only organizations that support ordering, e.g. diagnostic laboratories. These organizations can be referenced in 'performer' attribute of the RequestGroup resource. |
_count | number | Positive integer. If specified then the server will not return more than _count results. |
_offset | number | Positive integer. Specifies the position to return search results from. |
Examples:
2.1 Search laboratories with name LabCorp that support ordering:
https://api.healthgorilla.com/fhir/Organization?
type=http://hl7.org/fhir/organization-type|prov&name=LabCorp
&ordering-enabled=true
2.2 Search healthcare practices in Sunnyvale:
https://api.healthgorilla.com/fhir/Organization?
type=https://www.healthgorilla.com/fhir/organization-type|PR&address-city=Sunnyvale
&name=HealthCenter
2.3 Search AETNA insurance companies in California
https://api.healthgorilla.com/fhir/Organization?
type=http://hl7.org/fhir/organization-type|ins&name=AETNA&address-state=CA
&_count=15
3. Create
HTTP Request | Method | Action |
---|---|---|
/Organization | POST | Creates a new organization |
The following attributes are required to create a new organization:
Name | Details |
---|---|
active | true |
name | Name of the organization |
address | Address of the organization |
type | Only a few types are supported. See below. |
Only the following two organization types are supported:
Code System | Code | Description |
---|---|---|
http://hl7.org/fhir/organization-type | ins | Insurance Provider |
https://www.healthgorilla.com/fhir/organization-type | IP | Insurance Provider |
Examples
3.1 Create new Insurance Provider
{
"resourceType":"Organization",
"active":true,
"type":[
{
"coding":[
{
"system":"http://hl7.org/fhir/organization-type",
"code":"ins",
"display":"Insurance Company"
}
],
"text":"Insurance Company"
}
],
"name":"HealthGorilla",
"telecom":[
{
"system":"phone",
"value":"1 (844) 446-7455"
}
],
"address":[
{
"line":[
"185 N Wolfe Rd"
],
"city":"Sunnyvale",
"state":"CA",
"postalCode":"94085",
"country":"USA"
}
]
}
3.2An attempt to create duplicate
Health Gorilla does not allow duplicates, so if the supplied organization already exists, then the operation fails with an error.
{
"resourceType": "OperationOutcome",
"issue": [
{
"severity": "error",
"code": "duplicate",
"details": {
"text": "The supplied record duplicates the existing one."
},
"diagnostics": "Failed to create duplicate."
}
]
}
You can find the identifier of an existing resource in 'Existing-Resource-Id' header.
4. Update
HTTP Request | Method | Action |
---|---|---|
/Organization/{ID} | PUT | Updates the Organization resource or creates a new one. |
Restrictions
- You can only update local Organizations (insurance providers) that you created.
- You can't modify an existing insurance provider to become a duplicate of another insurance provider. The endpoint rejects such requests.
5. Delete
HTTP Request | Method | Action |
---|---|---|
/Organization/{ID} | DELETE | Deletes the Organization resource |
Restrictions
- You can only delete local insurance providers.
Updated about 2 months ago