The FHIR R4 Organization resource defines entities responsible for providing, managing, or paying for healthcare services. This includes hospitals, clinics, health systems, payers, and other administrative or operational entities. In Health Gorilla, Organization is often referenced by PractitionerRole, Location, and Encounter resources.
Use Cases
- Identify the facility or organization associated with a provider
- Filter encounters or locations by managing organization
- Display organization contact and address information
Base URLs
- Production: https://api.healthgorilla.com/fhir/R4/Organization
- Sandbox: https://sandbox.healthgorilla.com/fhir/R4/Organization
Authentication
All requests require OAuth 2.0 authentication using a Bearer Token. Unauthorized requests return 401 Unauthorized responses.
Required Scopes
organization.readfor GETorganization.writefor POST, PUT, DELETE
For more information, go to: OAuth 2.0 Authentication.
Supported Methods
| Method | Operation | Description |
|---|---|---|
GET | Read Organization | Retrieves a specific Organization record by its FHIR ID. |
GET | Search Organization | Searches for Organization records using supported parameters. |
POST | Create Organization | Submits a new Organization record to the Health Gorilla FHIR server. |
PUT | Update Organization | Updates an existing Organization record by full resource replacement. |
DELETE | Delete Organization | Removes an existing Organization record from the system by full deletion. |
Frequently Used Search Parameters
| Parameter | Description | FHIR Value Set / Example Values | FHIR Data Type | Required |
|---|---|---|---|---|
name | Filters by the organization’s name | "Health Gorilla" | string | No |
identifier | Filters by organization identifier | NPI, TIN, or system-specific ID | token | No |
type | Filters by organization type | OrganizationType (prov, pay) | token | No |
_id | Filters by the Organization resource ID | Organization/{id} | token | No |
address | Matches any part of the address (city, zip, etc) | "Sunnyvale" | string | No |
Commonly Returned Resource Attributes
| Attribute | Description | Example Values | FHIR Data Type | Required |
|---|---|---|---|---|
id | Unique FHIR ID for the organization | org-123456 | id | Yes |
name | Name of the organization | Health Gorilla | string | Yes |
identifier | Unique business identifiers (NPI, TIN, etc.) | NPI: 1234567890 | Identifier[] | No |
type | Type of organization | prov (healthcare provider) | CodeableConcept[] | No |
active | Whether the organization record is currently active | true, false | boolean | No |
telecom | Contact information (e.g., phone, fax, email) | 408-555-1234 | ContactPoint[] | No |
address | Physical or mailing address | 123 Wellness Way, Sunnyvale, CA | Address[] | No |
partOf | Parent organization, if this is a branch or subdivision | Organization/{id} | Reference(Organization) | No |
endpoint | Reference to technical endpoints for services like Direct | Endpoint/{id} | Reference(Endpoint) | No |
Webhooks
Organization resources are not typically included in webhook notifications directly, but they are commonly referenced by webhook-triggering resources such as Encounter, PractitionerRole, and Location.
For more information, go to: Webhooks & Polling.
Error Handling
All Organization operations follow standard Health Gorilla error handling, including use of FHIR OperationOutcome for structured responses.
For more information, go to: Error Handling.