Place Data Properties
Place data fields define the types of Place data. This page lists all place data fields.
Place
Property | Type | Description |
---|---|---|
id | string | The Clinia Id of the resource. |
documentType | string | Type of document. This will always be set to health_facility . |
type | string | The type of the resource. Possible Place types are detailed here. |
name | string | The name of the resource. |
address | Address | The address of the resource. |
geoPoint | GeoPoint | The coordinates of the resource. Useful to locate resource on a map. |
distance | double | The distance (in meters) the is from the location used to filter the query. |
onlineBookingUrl | string | The url for the online booking system of the resource. |
openingHours | Dictionary<string , Array<Interval>> | The opening hours of the resource. This object has integers from 1 to 7 as keys, representing days of the week from Monday to Sunday as per ISO 8601. |
phones | Array<Phone> | Phones associated with this resource. |
socials | Array<Social> | The social links of the resource. Can be a website or a social media link. |
note | string | Special notes on the resource. |
services | Array<string > | The services offered by the resource. |
owner | string | The owner of the resource in the Clinia ecosystem. |
Address
Property | Type | Description |
---|---|---|
streetAddress | string | Street number plus route name. |
suiteNumber | string | Suite, door, appartment number. |
postalCode | string | Postal code. |
neighborhood | string | Neighborhood. |
locality | string | Locality. |
place | string | City. |
region | string | Name of the region. |
regionCode | string | ISO 3166-2 region code. |
country | string | Name of the country. |
countryCode | string | ISO 3166 country code |
Phone
Property | Type | Description |
---|---|---|
number | string | The phone number. |
extension | string | The extension of the phone number. |
countryCode | string | The country code associated with this phone number. |
type | string | The type of phone. |
isTollFree | boolean | If the number is toll free or not. |
The possible values for type
are :MAIN
ALTERNATE
RECEPTION
FAX
TEXT_TELEPHONE_TTY
INFO
OTHER
Interval
Property | Type | Description |
---|---|---|
start | string | Start time of the time interval. Format is HH:mm . |
end | string | End time of the time interval. Format is HH:mm . |
GeoPoint
Property | Type | Description |
---|---|---|
lat | float | Latitude |
lng | float | Longitude |
Social
Property | Type | Description |
---|---|---|
url | string | Url representing the link. |
type | string | Type of link. |