Location data model
View field support, webhooks, and list parameters for each integration on the Supported Integrations page.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier for the location |
created_at | string (date-time) | No | When the location record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | When the location record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
name | string | No | Name of the location |
description | string | No | Description of the location |
parent_id | string | No | The location this one is part of (e.g. a department within a hospital) |
organization_name | string | No | Name of the organization that manages the location |
address | object | No | Postal address of the location |
address.address1 | string | No | |
address.address2 | string | No | |
address.city | string | No | |
address.region | string | No | |
address.postal_code | string | No | |
address.country | string | No | |
telephones | HealthcareTelephone[] | No | Phone and fax numbers for the location |
telephones[].telephone | string | Yes | |
telephones[].type | enum | No | Values: WORK, HOME, MOBILE, FAX, OTHER |
emails | HealthcareEmail[] | No | Email addresses for the location |
emails[].email | string | Yes | |
emails[].type | enum | No | Values: WORK, HOME, OTHER |
latitude | number | No | Latitude of the location |
longitude | number | No | Longitude of the location |
identifiers | HealthcareIdentifier[] | No | Business identifiers for the location |
identifiers[].value | string | Yes | The identifier value |
identifiers[].type | enum | No | The kind of identifier Values: MRN, NPI, SSN, DRIVERS_LICENSE, PASSPORT, INSURANCE, OTHER |
identifiers[].system | string | No | The namespace/system URI that issued the identifier |
is_active | boolean | No | Whether the location is in active use |
metadata | HealthcareMetadata[] | No | |
metadata[].id | string | No | |
metadata[].value | object | No | |
metadata[].namespace | string | No | |
metadata[].format | enum | No | Values: TEXT, NUMBER, DATE, BOOLEAN, ARRAY, OBJECT |
metadata[].extra_data | object | No | |
metadata[].slug | string | No |
Are we missing anything? Let us know