ChallengesDocs

Data Endpoints

Download the health system's inventory export, facility by facility

Data Endpoints

The data is one health system's medical equipment inventory: four medical centers (A to D) and a group of clinics and smaller sites (E). Every candidate gets the same records with the same record IDs. Record IDs stay the same for the whole round, so you can store them and refer to them in your answers.

Every endpoint needs your Round 2 API key in the API-KEY header. Without one you get 401. To get a key, register.

List Facilities

GET /api/v2/hospitals

{
  "facilities": [
    {
      "id": "A",
      "name": "Medical Center A",
      "record_count": 6905,
      "columns": [
        "Customer",
        "Hospital Department",
        "Billing Business Unit",
        "CEID",
        "Serial Number",
        "Manufacturer (MFG)",
        "Model Name",
        "Description ID",
        "Manufactured Date"
      ],
      "records_url": "/api/v2/hospitals/A/records"
    }
  ]
}

Every facility has the same columns. Values are exactly as the health system exported them, messy entries included, with these exceptions:

  • Customer names the facility: Medical Center A to Medical Center D, or Clinic 01, Clinic 02 and so on for the sites in E. Real facility names are removed.
  • CEID is the health system's own asset ID. Each record is one asset.
  • Manufactured Date is YYYY-MM-DD, or blank when it isn't known.
  • Location columns and a few internal columns are left out.

Get Records

GET /api/v2/hospitals/:id/records

QueryNotes
limit1-500, default 500
cursorThe next_cursor from the previous page
{
  "facility": "A",
  "total": 6905,
  "records": [
    {
      "record_id": "A-2h4h3r",
      "Customer": "Medical Center A",
      "Hospital Department": "2NE 2ASD AMC",
      "Billing Business Unit": "10.101.61100",
      "CEID": "31829716",
      "Serial Number": "DE752K5076",
      "Manufacturer (MFG)": "PHILIPS MEDICAL SYSTEMS",
      "Model Name": "INTELLIVUE MX100",
      "Description ID": "MONITORS PATIENT PHYSIOLOGIC MODULAR",
      "Manufactured Date": "2021-09-29"
    }
  ],
  "next_cursor": "NTAw"
}

next_cursor is null on the last page. There's no bulk download: page through each facility.

Device Types

The Device Types endpoints return Equiply's device-type reference and useful lives.

Rate Limit

60 requests per minute per API key, shared by every Round 2 endpoint. Over the limit you get 429 with a Retry-After header in seconds. Records don't change during the round, so save them locally instead of downloading them again.