Schema.org

- Documentation
- Schemas
- About

Note: you are viewing the development version of schema.org. See How we work for more details.

## Schema.org COVID-19: US CDC Data Table fields

Editor:
  Dan Brickley <danbri@google.com>
Last Updated:
  2020-04-02

This document specifies a Schema.org representation of the following US CDC (Centers for Disease Control and Prevention) data format definition:

- Title: Importing COVID-19 Patient Module Denominator data for Patient Safety Component (PSC)
- URL: https://www.cdc.gov/nhsn/pdfs/covid19/import-covid19-data-508.pdf

The representation defined here is intended to be 1:1 with the original representation and round-trippable. The CDC document defines several data fields in a tabular format. These are represented in Schema.org as properties of an object of type CDCPMDRecord.

For all formal matters of interpretation for the properties listed in the table below, please refer to the source CDC documentation for authoritative definitions and official updates. This document (and accompanying schemas) may be updated in the future to track changes from CDC, but we cannot guarantee to do this immediately. Implementors are cautioned to check the CDC site for updates and clarifications. We expect that some aspects of the CDC definitions may change.

The purpose of this schema definition is to provide a standards-based representation that can be used to encode and exchange records that correspond to the CDC format. Depending on context, any of the formats and standards that work with Schema.org may be applicable, including the Microdata, RDFa and JSON-LD data formats, as well as related technologies such as W3C SPARQL for data query. JSON-LD is in most cases likely to be the most appropriate format. There is no assumption that data encoded using this schema should necessarily be published on the public Web, nor that it would be used by search engines.

- https://www.cdc.gov/nhsn/acute-care-hospital/covid19/index.html
  - The above source PDF is linked under Resources section,
  - "How to import COVID-19 Summary Data [PDF – 200 KB], Alongside CSV File Template [CSV – 250 B]
- https://www.cms.gov/files/document/32920-hospital-letter-vice-president-pence.pdf

## Schema.org vocabulary:

The following additions were made to Schema.org (in the Pending area, pending review and implementation feedback):

- 1 new type: Thing > Intangible > StructuredValue > CDCPMDRecord
- 14 new properties: cvdCollectionDate, cvdNumBeds, cvdNumTotBeds, cvdNumBedsOcc, cvdNumICUBeds, cvdNumICUBedsOcc, cvdNumVent, cvdNumVentUse, cvdNumC19HospPats, cvdNumC19MechVentPats, cvdNumC19HOPats, cvdNumC19OverflowPats, cvdNumC19OFMechVentPats, cvdNumC19Died.
- In addition, a new healthcareReportingData property can be used to relate a Hospital to a CDCPMDRecord.
- The datePosted property can also be used on a CDCPMDRecord.
- Use cvdFacilityId to identify the NHSN facility, and (optionally)cvdFacilityCounty for its county name.

New properties: this adds several new properties (see "Schema.org name" column). Most are Number (with additional application-level constraints summarized in "Notes" column).

The reason for prefixing each name with cvd is to avoid clashing with similar or identical names already in use at Schema.org. For example, https://schema.org/numberOfBeds already exists for describing hotel rooms, apartments etc.; for the COVID-19 case it is simplest to keep things relatively self-contained.

CDC name | Schema.org name | Expected Value | Notes (see CDC for authoritative guidance) | Definition
collectiondate | cvdCollectionDate | Text, mm/dd/yyyy [or ISO 8601 DateTime] | CDC required. Original date format for collectiondate was mm/dd/yyyy, which can be ambiguous outside of a US context, so we provide the option of using ISO-8601 dates instead | Date for which patient counts are reported.
numbeds | cvdNumBeds | Number | CDC required. 0 to 10000 Must be a whole number Must be <= numTotBeds | HOSPITAL INPATIENT BEDS: Inpatient beds, including all staffed, licensed, and overflow (surge) beds used for inpatients.
numtotbeds | cvdNumTotBeds | Number | Must be a whole number 0 to 10000 | ALL HOSPITAL BEDS: Total number of all Inpatient and outpatient beds, including all staffed,ICU, licensed, and overflow (surge) beds used for inpatients or outpatients.
numbedsocc | cvdNumBedsOcc | Number | 0 to 10000 Must be a whole number Must be <= numBeds | HOSPITAL INPATIENT BED OCCUPANCY: Total number of staffed inpatient beds that are occupied.
numicubeds | cvdNumICUBeds | Number | 0 to 10000 Must be a whole number Must be <= numBeds | ICU BEDS: Total number of staffed inpatient intensive care unit (ICU) beds.
numicubedsocc | cvdNumICUBedsOcc | Number | 0 to 10000 Must be a whole number Must be <= numICUBeds | ICU BED OCCUPANCY: Total number of staffed inpatient ICU beds that are occupied.
numvent | cvdNumVent | Number | 0 to 10000 Must be a whole number Must be <= numTotBeds or <= 10,000 | MECHANICAL VENTILATORS: Total number of ventilators available.
numventuse | cvdNumVentUse | Number | 0 to 10000 Must be a whole number Must be <= numVent or <= 10,000 | MECHANICAL VENTILATORS IN USE: Total number of ventilators in use.
numc19hosppats | cvdNumC19HospPats | Number | 0 to 10000 Must be a whole number Must be <= numBedsOcc | HOSPITALIZED: Patients currently hospitalized in an inpatient care location who have suspected or confirmed COVID-19.
numc19mechventpats | cvdNumC19MechVentPats | Number | 0 to 10000 Must be a whole number Must be <= numVentUse | HOSPITALIZED and VENTILATED: Patients hospitalized in an NHSN inpatient care location who have suspected or confirmed COVID-19 and are on a mechanical ventilator.
numc19hopats | cvdNumC19HOPats | Number | 0 to 10000 Must be a whole number Must be <= numBedsOcc | HOSPITAL ONSET: Patients hospitalized in an NHSN inpatient care location with onset of suspected or confirmed COVID-19 14 or more days after hospitalization.
numc19overflowpats | cvdNumC19OverflowPats | Number | 0 to 2000 Must be a whole number Must be <=2000 | ED/OVERFLOW: Patients with suspected or confirmed COVID-19 who are in the ED or any overflow location awaiting an inpatient bed.
numc19ofmechventpats | cvdNumC19OFMechVentPats | Number | 0 to 10000 Must be a whole number Must be <= numVentUse | ED/OVERFLOW and VENTILATED: Patients with suspected or confirmed COVID-19 who are in the ED or any overflow location awaiting an inpatient bed and on a mechanical ventilator.
numc19died | cvdNumC19Died | Number | 0 to 1500 Must be a whole number Must be <= 1500 | DEATHS: Patients with suspected or confirmed COVID-19 who died in the hospital, ED, or any overflow location.

## Change Log

- 2020-04-02: Initial version.