Place Data Properties

Place data fields define the types of Place data. This page lists all place data fields.

Place

PropertyTypeDescription
idstringThe Clinia Id of the resource.
documentTypestringType of document. This will always be set to health_facility.
typestringThe type of the resource. Possible Place types are detailed here.
namestringThe name of the resource.
addressAddressThe address of the resource.
geoPointGeoPointThe coordinates of the resource. Useful to locate resource on a map.
distancedoubleThe distance (in meters) the is from the location used to filter the query.
onlineBookingUrlstringThe url for the online booking system of the resource.
openingHoursDictionary<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.
phonesArray<Phone>Phones associated with this resource.
socialsArray<Social>The social links of the resource. Can be a website or a social media link.
notestringSpecial notes on the resource.
servicesArray<string>The services offered by the resource.
ownerstringThe owner of the resource in the Clinia ecosystem.

Address

PropertyTypeDescription
streetAddressstringStreet number plus route name.
suiteNumberstringSuite, door, appartment number.
postalCodestringPostal code.
neighborhoodstringNeighborhood.
localitystringLocality.
placestringCity.
regionstringName of the region.
regionCodestringISO 3166-2 region code.
countrystringName of the country.
countryCodestringISO 3166 country code

Phone

PropertyTypeDescription
numberstringThe phone number.
extensionstringThe extension of the phone number.
countryCodestringThe country code associated with this phone number.
typestringThe type of phone.
isTollFreebooleanIf the number is toll free or not.

The possible values for type are :
MAIN
ALTERNATE
RECEPTION
FAX
TEXT_TELEPHONE_TTY
INFO
OTHER

Interval

PropertyTypeDescription
startstringStart time of the time interval. Format is HH:mm.
endstringEnd time of the time interval. Format is HH:mm.

GeoPoint

PropertyTypeDescription
latfloatLatitude
lngfloatLongitude

Social

PropertyTypeDescription
urlstringUrl representing the link.
typestringType of link.