/healthgrades/hospitals

POST /api/healthgrades/hospitals

Price: 20 credits

Get a Healthgrades hospital profile by id (e.g. 22df4b), profile slug or profile URL: name, address, phone, quality awards with years, clinical quality star ratings by procedure area, patient-safety indicators, patient-experience (HCAHPS) survey results vs national averages, a sample of affiliated providers, recent provider reviews and frequently asked questions.

How to use it

Fetch one Healthgrades hospital by id (e.g. 22df4b), slug or profile URL. Returns name, address/city/state/zip_code, phone, latitude/longitude, image/images, provider_count, awards (with years), clinical_ratings (star ratings by procedure area), safety_indicators, patient_experience (HCAHPS results with national averages), providers (sample of affiliated doctors), provider_reviews and faqs.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• hospital string required — Healthgrades hospital id (e.g. 22df4b), profile slug or profile URL (examples: "22df4b"; minLength: 1)

Response

• @type string (default: "HealthgradesHospital")
• id string required
• name string required
• phone string nullable
• address string nullable
• city string nullable
• state string nullable
• zip_code string nullable
• latitude number nullable
• longitude number nullable
• image string nullable
• images array (default: [])
• profile_url string nullable
• provider_count integer nullable
• awards array (default: [])
  • @type string (default: "HealthgradesHospitalAward")
  • code string nullable
  • name string nullable
  • award_type string nullable
  • years array (default: [])
  • description string nullable
  • image string nullable
  • is_50_best boolean nullable
  • is_best boolean nullable
• clinical_ratings array (default: [])
  • @type string (default: "HealthgradesClinicalRating")
  • area string nullable
  • procedures array (default: [])
    • @type string (default: "HealthgradesClinicalProcedure")
    • name string nullable
    • stars integer nullable
• safety_indicators array (default: [])
  • @type string (default: "HealthgradesSafetyIndicator")
  • description string nullable
  • rate string nullable
• patient_experience array (default: [])
  • @type string (default: "HealthgradesHcahps")
  • question string nullable
  • answer string nullable
  • percent integer nullable
  • national_average_percent integer nullable
  • category string nullable
  • surveyed_count integer nullable
  • response_rate_percent integer nullable
• providers array (default: [])
  • @type string (default: "HealthgradesProviderCard")
  • id string nullable
  • name string nullable
  • npi string nullable
  • image string nullable
  • specialty string nullable
  • rating number nullable
  • rating_count integer nullable
  • profile_url string nullable
• provider_reviews array (default: [])
  • @type string (default: "HealthgradesHospitalProviderReview")
  • rating integer nullable
  • text string nullable
  • provider_name string nullable
  • provider_id string nullable
  • provider_url string nullable
  • created_at string nullable
• faqs array (default: [])
  • @type string (default: "HealthgradesFaq")
  • question string nullable
  • answer string nullable
  • faq_type string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Hospital not found (well-formed id with no Healthgrades profile) Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.