API docs by Redocly

Omni - (2.21.0)

Download OpenAPI specification:Download

License: None

API specification for Omni's endpoints. Fast Pages Entities Schema Version - (4.2.2)

Omni Data

Retrieve clinician or department data using their identifiers.

Authorizations:
None
path Parameters
version
string

(Optional) The version of the API

Value: "2.21.0"
query Parameters
allLocations
boolean (allLocations)
Default: false

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 you're looking up a clinician's secondary department, such as when looking up a clinician by id, or when looking up a list of all clinicians at a department.

brand
required
string

(Required) - The brand to lookup results for. The results must exist in that brand's index, or they will be treated as though they don't exist.

departmentIds
Array of strings (departmentIds)

A list of department ids to lookup, separated by commas. Equivalent to passing the ids for the clinicians at that department.

departmentUrls
Array of strings (departmentUrls)

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 of strings (ids)

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 and may have to wait for the intermediate cache to refresh.

npis
Array of strings (npis)

A list of npis to lookup, separated by commas. Equivalent to passing the ids for the clinicians with those npis.

select
Array of strings (select)

A list of fields to be returned, separated by commas. Should be used to reduce response size where possible.

urls
Array of strings (urls)

A list of urls to lookup, separated by commas. Equivalent to passing the ids for the documents with those urls.

Responses

Response samples

Content type
application/json
Example
{
  • "@search.distance": {
    },
  • "@search.features": {
    },
  • "@search.highlights": {
    },
  • "@search.score": "4360.5723",
  • "adhoc": { },
  • "agesSeen": [
    ],
  • "badges": [
    ],
  • "bio": "<div>Zahidul I. Chowdhury, MD., earned his medical degree from Ross University...</div>",
  • "careTeam": [
    ],
  • "certifications": [
    ],
  • "cmsContent": {
    },
  • "conditionsTreated": [
    ],
  • "credentials": [
    ],
  • "departmentPrimaryUuid": "367fe424-6a0f-4852-bc6c-e32fc89531fe",
  • "departments": [
    ],
  • "education": [
    ],
  • "emrIdentifiers": [
    ],
  • "extended": { },
  • "gender": "Male",
  • "hospitalAffiliations": [
    ],
  • "id": "123456abcd",
  • "imageUrl": "https://www.universityhealth.com/photos/200/chowdhury-zahidul-1023458890.jpg",
  • "insurances": [
    ],
  • "isAcceptingNewPatients": true,
  • "isAffiliate": true,
  • "isBookableOnline": true,
  • "isBookablePhone": true,
  • "isBookableVirtual": true,
  • "isNewPatientEnabled": true,
  • "isReturningPatientEnabled": true,
  • "languages": [
    ],
  • "medicalInterests": [
    ],
  • "name": {
    },
  • "networks": [
    ],
  • "npi": "1234567890",
  • "pageDescription": "Dr. Yassmeen Abdel-Aty is an Otolaryngologist Head and Neck Surgeon who received additional training in the treatment of voice, airway, and swallowing disorders. She is currently practicing at the University Health General Hospital and is on faculty there.",
  • "pageTitle": "Zahidul Islam Chowdhury, MD - Seattle, WA",
  • "phone": {
    },
  • "profileUrls": [],
  • "resultType": "clinician",
  • "reviews": [
    ],
  • "specialty": null,
  • "specialties": [
    ],
  • "subSpecialties": [
    ],
  • "tier": 1,
  • "videoUrl": "https://www.universityhealth.com/videos/Jane+Scot+Doe/389345",
  • "version": "4.16.0"
}

Omni Analytics

Submit analytics events.

Authorizations:
None
query Parameters
brand
required
string

(Required) - The brand to lookup results for. The results must exist in that brand's index, or they will be treated as though they don't exist.

debug
boolean (debug)
Default: false

Set to true to include debug information in the response.

dh
string (dh)

(Ignored) - The document hostname is automatically determined based on brand.

event_name
string (event_name)

Name of event for GA.

tid
string (tid)
Default: "UA-1508202-16"

GA tracking ID. Defaults to UA-1508202-16 if not defined.

uip
string (uip)

(Ignored) - The IP address of the user is stripped from the request if included.

v
string (v)

(Ignored) - The protocol version is hardcoded to 1.

Responses

Response samples

Content type
application/json
{
  • "data": { },
  • "url": "string"
}

Omni Search Analytics

Proxy for Google Analytics (GA) collect endpoint, specifically for search page view events.

Authorizations:
None
query Parameters
brand
required
string

(Required) - The brand to lookup results for. The results must exist in that brand's index, or they will be treated as though they don't exist.

cid
required
string (properties-cid)

Client ID (unique user ID).

debug
boolean (debug)
Default: false

Set to true to include debug information in the response.

dp
string (dp)

Namespace. Either 'path' or 'dp' must be specified.

path
string (path)

Document path, i.e. the path portion of the page URL. Either 'path' or 'dp' must be specified.

tid
string (tid)
Default: "UA-1508202-16"

GA tracking ID. Defaults to UA-1508202-16 if not defined.

Responses

Response samples

Content type
application/json
{
  • "cid": "string",
  • "ga": { },
  • "url": "string"
}

Omni Sitemap

Retrieve a list of URLs (typically just pathnames) from the search index for a brand.

Authorizations:
None
query Parameters
brand
required
string

(Required) - The brand to lookup results for. The results must exist in that brand's index, or they will be treated as though they don't exist.

data
required
string (DataTag)
Enum: "clinicians" "departments" "locations"

The data type to lookup. The returned response will be an array of this type.

Responses

Response samples

Content type
application/json
{
  • "urls": [
    ]
}

Omni Slugs

The slugs endpoint is used during frontend page builds to add search optimization and to set default Omni search parameters like search terms, custom descriptions, and location.

Authorizations:
None
query Parameters
brand
required
string

(Required) - The brand to lookup results for. The results must exist in that brand's index, or they will be treated as though they don't exist.

name
required
string (name)

Slug name.

Responses

Response samples

Content type
application/json
{
  • "location": "string",
  • "name": "string",
  • "searchTerms": "string",
  • "text": "string"
}