SEO.JSONLD.CDCPMDRecord (SEO v0.3.0-rc.0)

A CDCPMDRecord is a data structure representing a record in a CDC tabular data format used for hospital data reporting. See documentation for details, and the linked CDC materials for authoritative definitions used as the source here.

Helper for building a Schema.org CDCPMDRecord JSON-LD structure.

Summary

Types

attrs()

t()

A JSON-LD map ready to be nested or rendered. String-keyed, always includes "@type" set to "CDCPMDRecord", plus any camelCased field keys the caller provided (see build/1). "@context" is added at render time by SEO.JSONLD.meta/1 on the top-level node only.

Functions

build(attrs)

Build a CDCPMDRecord JSON-LD map.

Types

attrs()

@type attrs() ::
  %{
    optional(:cvd_collection_date) =>
      String.t() | DateTime.t() | NaiveDateTime.t(),
    optional(:cvd_facility_county) => String.t(),
    optional(:cvd_facility_id) => String.t(),
    optional(:cvd_num_beds) => number(),
    optional(:cvd_num_beds_occ) => number(),
    optional(:cvd_num_c19_died) => number(),
    optional(:cvd_num_c19_ho_pats) => number(),
    optional(:cvd_num_c19_hosp_pats) => number(),
    optional(:cvd_num_c19_mech_vent_pats) => number(),
    optional(:cvd_num_c19_of_mech_vent_pats) => number(),
    optional(:cvd_num_c19_overflow_pats) => number(),
    optional(:cvd_num_icu_beds) => number(),
    optional(:cvd_num_icu_beds_occ) => number(),
    optional(:cvd_num_tot_beds) => number(),
    optional(:cvd_num_vent) => number(),
    optional(:cvd_num_vent_use) => number(),
    optional(:date_posted) =>
      DateTime.t() | NaiveDateTime.t() | String.t() | Date.t(),
    optional(:additional_type) => String.t() | URI.t(),
    optional(:alternate_name) => String.t(),
    optional(:description) => SEO.JSONLD.TextObject.t() | map() | String.t(),
    optional(:disambiguating_description) => String.t(),
    optional(:identifier) =>
      String.t() | URI.t() | SEO.JSONLD.PropertyValue.t() | map(),
    optional(:image) =>
      URI.t() | String.t() | SEO.JSONLD.ImageObject.t() | map(),
    optional(:main_entity_of_page) =>
      SEO.JSONLD.CreativeWork.t() | map() | URI.t() | String.t(),
    optional(:name) => String.t(),
    optional(:owner) =>
      SEO.JSONLD.Organization.t() | map() | SEO.JSONLD.Person.t(),
    optional(:potential_action) => SEO.JSONLD.Action.t() | map(),
    optional(:same_as) => URI.t() | String.t(),
    optional(:subject_of) =>
      SEO.JSONLD.Event.t() | map() | SEO.JSONLD.CreativeWork.t(),
    optional(:url) => URI.t() | String.t()
  }
  | [
      cvd_collection_date: String.t() | DateTime.t() | NaiveDateTime.t(),
      cvd_facility_county: String.t(),
      cvd_facility_id: String.t(),
      cvd_num_beds: number(),
      cvd_num_beds_occ: number(),
      cvd_num_c19_died: number(),
      cvd_num_c19_ho_pats: number(),
      cvd_num_c19_hosp_pats: number(),
      cvd_num_c19_mech_vent_pats: number(),
      cvd_num_c19_of_mech_vent_pats: number(),
      cvd_num_c19_overflow_pats: number(),
      cvd_num_icu_beds: number(),
      cvd_num_icu_beds_occ: number(),
      cvd_num_tot_beds: number(),
      cvd_num_vent: number(),
      cvd_num_vent_use: number(),
      date_posted: DateTime.t() | NaiveDateTime.t() | String.t() | Date.t(),
      additional_type: String.t() | URI.t(),
      alternate_name: String.t(),
      description: SEO.JSONLD.TextObject.t() | map() | String.t(),
      disambiguating_description: String.t(),
      identifier: String.t() | URI.t() | SEO.JSONLD.PropertyValue.t() | map(),
      image: URI.t() | String.t() | SEO.JSONLD.ImageObject.t() | map(),
      main_entity_of_page:
        SEO.JSONLD.CreativeWork.t() | map() | URI.t() | String.t(),
      name: String.t(),
      owner: SEO.JSONLD.Organization.t() | map() | SEO.JSONLD.Person.t(),
      potential_action: SEO.JSONLD.Action.t() | map(),
      same_as: URI.t() | String.t(),
      subject_of: SEO.JSONLD.Event.t() | map() | SEO.JSONLD.CreativeWork.t(),
      url: URI.t() | String.t()
    ]

t()

@type t() :: %{required(String.t()) => term()}

Functions

build(attrs)

@spec build(attrs()) :: t()

Build a CDCPMDRecord JSON-LD map.

Fields

:cvd_collection_date - collectiondate - Date for which patient counts are reported.
:cvd_facility_county - Name of the County of the NHSN facility that this data record applies to. Use cvdFacilityId to identify the facility. To provide other details, healthcareReportingData can be used on a SEO.JSONLD.Hospital entry.
:cvd_facility_id - Identifier of the NHSN facility that this data record applies to. Use cvdFacilityCounty to indicate the county. To provide other details, healthcareReportingData can be used on a SEO.JSONLD.Hospital entry.
:cvd_num_beds - numbeds - HOSPITAL INPATIENT BEDS: Inpatient beds, including all staffed, licensed, and overflow (surge) beds used for inpatients.
:cvd_num_beds_occ - numbedsocc - HOSPITAL INPATIENT BED OCCUPANCY: Total number of staffed inpatient beds that are occupied.
:cvd_num_c19_died - numc19died - DEATHS: Patients with suspected or confirmed COVID-19 who died in the hospital, ED, or any overflow location.
:cvd_num_c19_ho_pats - numc19hopats - HOSPITAL ONSET: Patients hospitalized in an NHSN inpatient care location with onset of suspected or confirmed COVID-19 14 or more days after hospitalization.
:cvd_num_c19_hosp_pats - numc19hosppats - HOSPITALIZED: Patients currently hospitalized in an inpatient care location who have suspected or confirmed COVID-19.
:cvd_num_c19_mech_vent_pats - numc19mechventpats - HOSPITALIZED and VENTILATED: Patients hospitalized in an NHSN inpatient care location who have suspected or confirmed COVID-19 and are on a mechanical ventilator.
:cvd_num_c19_of_mech_vent_pats - numc19ofmechventpats - 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.
:cvd_num_c19_overflow_pats - numc19overflowpats - ED/OVERFLOW: Patients with suspected or confirmed COVID-19 who are in the ED or any overflow location awaiting an inpatient bed.
:cvd_num_icu_beds - numicubeds - ICU BEDS: Total number of staffed inpatient intensive care unit (ICU) beds.
:cvd_num_icu_beds_occ - numicubedsocc - ICU BED OCCUPANCY: Total number of staffed inpatient ICU beds that are occupied.
:cvd_num_tot_beds - numtotbeds - 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.
:cvd_num_vent - numvent - MECHANICAL VENTILATORS: Total number of ventilators available.
:cvd_num_vent_use - numventuse - MECHANICAL VENTILATORS IN USE: Total number of ventilators in use.
:date_posted - Publication date of an online listing.

Inherited properties

Additional properties are available through the inheritance chain. See each ancestor's docs for its properties:

SEO.JSONLD.Thing