This API exposes
8 operations
across 8 paths,
and defines 76 schemas.
It is described by OpenAPI 3.1.0, at version 2.21.0.
Requests are made against 4 base URLs: https://dev${brand}omni.azurewebsites.net, https://qa${brand}omni.azurewebsites.net, https://uat${brand}omni.azurewebsites.net, https://${brand}omni.azurewebsites.net.
The identity and technical contract details declared by the specification.
allLocations
boolean
If false, only a clinicians's primary department will be returned. If true, all departments for a clinician will be returned. Make sure to set this to true if…
departmentIds
array
A list of department ids to lookup, separated by commas. Equivalent to passing the ids for the clinicians at that department.
departmentUrls
array
A list of department urls to lookup, separated by commas. Equivalent to passing the ids for the clinicians at the department with that url.
ids
array
A list of ids to lookup, separated by commas. Use this parameter if possible since it does not require an intermediate lookup; other parameters will be slower…
npis
array
A list of npis to lookup, separated by commas. Equivalent to passing the ids for the clinicians with those npis.
select
array
A list of fields to be returned, separated by commas. Should be used to reduce response size where possible.
urls
array
A list of urls to lookup, separated by commas. Equivalent to passing the ids for the documents with those urls.
ErrorResponse
object
Error response
2 properties
1 required
clinicianFastPages
object
Fast Pages Clinician
47 properties
3 required
cmsContent
object
Content Management System Sections scope - OmniSearch OmniData
3 properties
1 required
businessLineFastPages
object
Business Line scope - OmniSearch OmniData OmniSearchNested OmniDataNested
2 properties
1 required
businessUnitFastPages
object
Business Unit scope - OmniSearch OmniData
2 properties
1 required
emrIdentifierFastPages
object
EMR Identifier
4 properties
3 required
hoursDayFastPages
object
Hours by day scope - OmniSearch OmniData OmniDataNested
5 properties
departmentFastPages
object
Fast Pages Department
50 properties
9 required
phoneNumberFastPages
object
Phone Number scope - OmniSearch OmniData OmniSearchNested OmniDataNested
4 properties
locationFastPages
object
Fast Pages Location
28 properties
7 required
specialtyFastPages
object
Medical Specialty
2 properties
1 required
visitTypeFastPages
object
Visit Type
16 properties
10 required
ratingDistributionFastPages
object
Rating Distribution
4 properties
reviewsFastPages
object
Reviews. Entire object required in OmniData response.
7 properties
acceptingNewPatients
boolean
When set to true, orders clinician results by those accepting new patients
childBrand
string
A child brand to filter results to, such as THR Breeze or Piedmont OrthoAtlanta.
cid
string
The client id that will be sent to GA for tracking.
clinicians
boolean
True if clinicians should be searched.
clinicVisits
boolean
When set to true, orders results by new clinic visits.
days
string
A list of days to filter by new clinic visits, entered as comma separated integers with 0 as Sunday through 6 as Saturday.
departments
boolean
True if departments should be searched.
distance
number
The maximum distance to search, in miles.
endDate
string
End of a date range to search for timeslots in the format YYYY-MM-DD. Also see related property startDate.
highlightPostTag
string
The string to put after each highlight.
highlightPreTag
string
The string to put before each highlight.
includeFallbackResults
boolean
If no matching documents are found, loosens the query to match anything instead of everything. If nothing is still found, return the default search.
inferLocationFromSearch
boolean
When set to true, will try to detect locations in the search string and update the location if one is found.
latitude
number
The user's latitude, must be combined with longitude.
location
string
The plaintext name of the user's location to pass to google maps. Should not be used with latitude or longitude.
locations
boolean
Set to true if locations should be searched.
longitude
number
The user's longitude, must be combined with latitude.
practiceGroup
string
Filters provider by practice group.
search
string
A plaintext search to match.
skip
string
Offsets for the results array, entered as comma separated numbers: ( of clinicians),( of departments).
soonest
boolean
When set to true, orders results by soonest new clinic visit.
startDate
string
Start of a date range to search for timeslots in the format YYYY-MM-DD. If no startDate date is specified, results will not be filtered by timeslot availabilit…
time
string
The time of day to filter by new clinic visits.
top
number
The number of results to return from the result array.
type
string
The type of search to peform.
videoVisits
boolean
When set to true, orders results by new video visits.
virtualCare
boolean
When set to true, orders results by virtual care.
GeoIP
object
11 properties
9 required
SearchFilter
object
5 properties
2 required
InfoLocations
object
2 properties
2 required
SearchInfo
object
7 properties
7 required
OmniSearchSuccessResponse
object
7 properties
4 required
count
boolean
Whether to include counts for each facet value
DataTag
string
The data type to lookup. The returned response will be an array of this type.
stringvalues
boolean
Whether to limit results to only string value type facets
OmniSearchFacetsSuccessResponse
object
1 property
1 required
debug
boolean
Set to true to include debug information in the response.
dh
string
(Ignored) - The document hostname is automatically determined based on brand.
event_name
string
Name of event for GA.
tid
string
GA tracking ID. Defaults to UA-1508202-16 if not defined.
uip
string
(Ignored) - The IP address of the user is stripped from the request if included.
v
string
(Ignored) - The protocol version is hardcoded to 1.
OmniAnalyticsSuccessResponse
object
Analytics response from GA
2 properties
properties-cid
string
Client ID (unique user ID).
dp
string
Namespace. Either 'path' or 'dp' must be specified.
path
string
Document path, i.e. the path portion of the page URL. Either 'path' or 'dp' must be specified.
OmniSearchAnalyticsSuccessResponse
object
3 properties
1 required
properties-search
string
A single search term to look up synonyms for.
OmniSynonymsSuccessResponse
object
1 property
1 required
OmniSitemapSuccessResponse
object
1 property
OmniSlugsSuccessResponse
object
4 properties
4 required
The full machine-readable OpenAPI contract behind this narrative.
