Location
Data container to represent location information.
Location data has following elements:
| facilityId | (string) | Unique location identifier. |
| name | (string) | Location name. |
| abbreviation | (string) | Location abbreviation. |
| active | (string) | Active flag. Do not use location if this flag set to false. |
| address | (object) | Address structure. |
| contactInfo | (object) | ContactInfo structure. |
| externalDetailPage | (string) | Practice specific hyperlink (for R10 function only). |
Notes:
- externalDetailPage field will be populated for R10 funciton only. It will have NULL value for non-R10 function.
- For R10 function a value externalDetailPage field will have a hyperlink defined by practice. Otherwise a hyperlink to Google Maps with location address.
XML Example:
JSON Example:
{
"facilityId": "13C69063-DD37-45E0-B1D5-2FFF6D9F300F",
"name": "Main clinic office",
"abbreviation": "MAINOFFICE",
"active": "true",
"address": {
"addr1": "1 Park Ave",
"addr2": "Unit 203",
"city": "Sunny Town",
"state": "IL",
"zip": "09111",
"zip4": "",
"country": "us"
},
"contactInfo": {
"phone": "8005551212",
"fax": "8005551313",
"email": "some@dadada.net"
},
"externalDetailPage": "http://someurl123.com/findme.html (This is for R10 function only)"
}
Note
Use GetLocations function to retrieve a list of practice locations.
See Also:
Address structure,
ContactInfo structure,
API Data,
GetLocations function