Cardiac
Arrest
Registry to
Enhance
Survival
CARES
Version 3.0
Data Dictionary
Designed by
Sansio
EMS Division
LAST UPDATED- 12/03/2014
WWW.MYCARES.NET
Cardiac Arrest Registry to Enhance Survival (CARES)
www.mycares.net
The CARES Dataset, Version 3.0 is composed of four separate components. 1) A CAD (Computer Aided Dispatch) Dataset provides a standardized set of definitions describing a CAD Event for a Cardiac Arrest event. 2) A First Responder Dataset provides a standardized set of definitions describing a First Responding Agency event for a Cardiac Arrest event. 3) An EMS Dataset provides a standardized set of definitions describing an EMS event. 4) A Hospital Dataset provides a standardized set of definitions describing a Hospital event.
Any implementation of the CARES Version 3.0 dataset must include the use of the EMS dataset, and XML standard.
Information provided in this document includes the following:
Þ Name of the Data Element
Þ Definition of the Data Element
Þ Data Type of the Data Element (many data elements have comments provided to assist in the implementation of a database schema)
Þ How to deal with missing or incomplete information (See Missing Data or Null Values below)
Þ What Data Elements are associated with the Data Element
Þ How the Data Element is related to other National Data Tools such as NHTSA Version 1, NFIRS, and Utstein
Þ Notes:
o Constraints- the constraints reflected in the fields in this document are meant to correspond to CARES constraints. See the NEMSIS definitions www.nemsis.org for more detailed element information.
o There may be more than one NEMSIS code mapped to a CARES field in enumerated elements. For instance, more than one NEMSIS code might map to CARES “Other” field as specified in the element definitions.
o If a dateTime field has no time component, such as Date Of Birth, use dateTime format and pass in midnight (all zeroes).
o PLEASE SEE https://mycares.net/downloads/Data%20Dictionary%20(2013).pdf for detailed clinical descriptions of fields. Use the codes for field values given in this document.
Þ PARSING NOTES
If an XML file contains a call that already exists in the system, with the same service date and incident number for a given agency (Custom element servicedate and eResponse.03), the file will not parse and none of the records within the XML file will be processed.
Cardiac Arrest Registry to Enhance Survival (CARES) Dataset
Version 3.0 (2012)
Table of Contents
HeaderGeneral Information / 1
CAD Dataset
CAD Information / 13
EMS Dataset
Call Information / 25
Arrest Information / 43
Resuscitation Information / 49
First Cardiac/ROSC Information / 60
Time Information / 65
Hypothermia Information / 80
EMS Interventions / 82
Hospital Dataset
Hospital Information / 96
Header - General Information
Agency ID
eCustomConfiguration - AgencyID
Data Format [number]
Definition
The number assigned to this agency within the myCares.net website.
V2 Element: H01_01
XSD Data Type xs:integer XSD Domain (Simple Type) AgencyID
Multiple Entry Configuration No Accepts Null No
Required in XSD Yes Minimum Constraint 2 Maximum Constraint 15
Field Values
A unique value; no variable list is possible.
Additional Information
● This field must match the agencyid assigned within the myCares.net website. All data within the import file will be associated to this agency id.
Import Version
eCustomConfiguration - ImportVersion
Data Format [string]
Definition
The version of the import specification used to create this file.
XSD Data Type xs:string XSD Domain (Simple Type) ImportVersion
Multiple Entry Configuration No Accepts Null No
Required in XSD Yes
Field Values
The version is currently 3.0
Form ID
eCustomConfiguration - FormID
Data Format [integer]
Definition
This field is used internally to determine which ‘form’ this data should be imported as.
XSD Data Type xs:integer XSD Domain (Simple Type) FormID
Multiple Entry Configuration No Accepts Null No
Required in XSD Yes
Field Values
This value should always be 90003
Import Method eCustomConfiguration - ImportMethod
Data Format [integer]
Definition
The method to use during the import.
XSD Data Type xs:integer XSD Domain (Simple Type) ImportMethod
Multiple Entry Configuration No Accepts Null No
Required in XSD Yes
Field Values
1 Import
9 Testing – Do Not Import
Software Used to Create This File
eRecord.03
Data Format [string]
Definition
The name of the software used to create this file.
V2 Element: H01_05_01
XSD Data Type xs:string XSD Domain (Simple Type) SoftwareName
Multiple Entry Configuration No Accepts Null No
Required in XSD Yes Minimum Constraint 1 char Maximum Constraint 50 chars
XSD Structure: H01_05_01 is a member of H01_05 Software Structure
Field Values
Software Version
eRecord.04
Data Format [string]
Definition
The version of the software used to create this file.
V2 Element: H01_05_02
XSD Data Type xs:string XSD Domain (Simple Type) SoftwareVersion
Multiple Entry Configuration No Accepts Null No
Required in XSD Yes Minimum Constraint 1 char Maximum Constraint 50 chars
XSD Structure: H01_05_02 is a member of H01_05 Software Structure
Field Values
Developer Contact Last Name
eCustomConfiguration -ContactLastName
Data Format [string]
Definition
The Last Name of the primary developer of the export file.
V2 Element: H01_05_03(just name-split into last/first)
XSD Data Type xs:string XSD Domain (Simple Type) ContactLastName
Multiple Entry Configuration No Accepts Null No
Required in XSD Yes Minimum Constraint 1 char Maximum Constraint 50 chars
XSD Structure: H01_05_03 is a member of H01_05 Software Structure
Field Values
Developer Contact First Name
eCustomConfiguration -ContactFirstName
Data Format [string]
Definition
The First Name of the primary developer of the export file.
V2 Element: H01_05_03 (just name-split into last/first)
XSD Data Type xs:string XSD Domain (Simple Type) ContactFirstName
Multiple Entry Configuration No Accepts Null No
Required in XSD Yes Minimum Constraint 1 char Maximum Constraint 50 chars
XSD Structure: H01_05_03 is a member of H01_05 Software Structure
Field Values
Developer Contact Phone #
eCustomConfiguration -ContactPhone
Data Format [string]
Definition
The phone number of the primary developer of the export file
V2 Element: H01_05_04
XSD Data Type xs:string XSD Domain (Simple Type) ContactPhone
Multiple Entry Configuration No Accepts Null No
Required in XSD Yes Minimum Constraint 1 char Maximum Constraint 50 chars
XSD Structure: H01_05_04 is a member of H01_05 Software Structure
Field Values
Developer Contact Email
eCustomConfiguration -ContactEmail
Data Format [string]
Definition
The email of the primary developer of the export file.
V2 Element: H01_05_05
XSD Data Type xs:string XSD Domain (Simple Type) ContactEmail
Multiple Entry Configuration No Accepts Null No
Required in XSD Yes Minimum Constraint 1 char Maximum Constraint 50 chars
XSD Structure: H01_05_05 is a member of H01_05 Software Structure
Field Values
Header – Header/Demographic Information Page 11 of 115
2012 CARES Dataset V.3.0
CAD Dataset
CAD Information
Booklet ID
eCustomConfiguration - BookletID
Data Format [number]
Definition
The myCares.net™/HealthEMS™ booklet number associated to this event.
XSD Data Type xs:integer XSD Domain (Simple Type) BookletID
Multiple Entry Configuration No Accepts Null Yes
Required in XSD No Minimum Constraint 5 Maximum Constraint 10
Field Values
A unique value; no variable list is possible.
Additional Information
● This field will most likely be blank. The only uses would be for HealthEMS™ users who choose to fill out the CARES form instead of the HealthEMS™ form and need to enter the HealthEMS™ bookletid on the CARES form to later match to a HealthEMS™ record to retrieve additional information. This field would then help assist that process.
Uses
● This will be used to help auto-match this CAD information to the corresponding EMS information
Data Collector
● This value would be pre-printed on the HealthEMS™ ePCR.
Agency CAD ID
eResponse.04
Data Format [text]
Definition
The CAD-assigned number given to this event
V2 Element: C01_03
XSD Data Type xs:string XSD Domain (Simple Type) AgencyCADID
Multiple Entry Configuration Yes Accepts Null Yes
Required in XSD No Minimum Constraint 0 Maximum Constraint 20
Field Values
● Optional Unique Identifier from CAD System
Additional Information
●
Uses
● Needs to be available for change management. If a record with this ID already exists, the current data will be over-written with this data.
● Also used to tie back to original CAD record in CAD system in case other data is ever needed.
Data Collector
● CAD System
Date of Arrest--CAD
eTimes.02
Data Format [date/time]
Definition
The date the event occurred. Date of Arrest
V2 Element: C01_05
XSD Data Type xs:dateTime XSD Domain (Simple Type) ServiceDate
Multiple Entry Configuration No Accepts Null No
Required in XSD Yes Minimum Constraint 2000 Maximum Constraint 2050
Field Values
● Valid date/time
Since this element is not nillable and does not except NV- please pass min value for NO value
1950-01-01T00:00:0000:00
Incident Address
eScene.15
Data Format [string]
Definition
Address where incident occurred
V2 Element: C01_25
XSD Data Type xs:string XSD Domain (Simple Type) IncidentAddress
Multiple Entry Configuration No Accepts Null Yes
Required in XSD No Minimum Constraint 1 Maximum Constraint 50*
Field Values
*CARES maximum constraint on string length=50
Incident City
eScene.17
Data Format [string]
Definition
City where incident occurred
V2 Element: C01_27
XSD Data Type xs:string XSD Domain (Simple Type) IncidentCity
Multiple Entry Configuration No Accepts Null Yes
Required in XSD No Minimum Constraint 0 Maximum Constraint 50 chars
Field Values
● CARES will accept the name of the city and not the code from the list affiliated with this NEMSIS element. Example: Cincinnati
Otherwise, please use the census code from the “State Files with Federal Codes” downloads at
http://geonames.usgs.gov/domestic/download_data.htm
If passing a census code from a state other than your agency’s state, please pass a value in eScene.18 for State.
Incident State ID
eScene.18
Data Format [string]
Definition
State where incident occurred.
V2 Element: C01_29
XSD Data Type xs:string XSD Domain (Simple Type) IncidentStateID
Multiple Entry Configuration No Accepts Null Yes
Required in XSD No Minimum Constraint 2 chars Maximum Constraint 2 chars
Field Values
● This can be the 2 character name of the state and not the code from the list affiliated with this NEMSIS element. Example: WA
Incident Zip Code
eScene.19
Data Format [string]
Definition
Zip code where incident occurred.
V2 Element: C01_30
XSD Data Type xs:string XSD Domain (Simple Type) IncidentZip
Multiple Entry Configuration No Accepts Null Yes
Required in XSD No Minimum Constraint 0 Maximum Constraint 10 chars
Field Values
● XXX
Patient First Name
ePatient.03
Data Format [string]
Definition
XXXXXXXXX
V2 Element: C01_31
XSD Data Type xs:string XSD Domain (Simple Type) PatientFName
Multiple Entry Configuration No Accepts Null Yes
Required in XSD No Minimum Constraint 1 Maximum Constraint 50
Field Values
● XXX
Patient Last Name
ePatient.02
Data Format [string]
Definition
XXXXXXXXX
V2 Element: C01_32
XSD Data Type xs:string XSD Domain (Simple Type) PatientLName
Multiple Entry Configuration No Accepts Null Yes
Required in XSD No Minimum Constraint 1 Maximum Constraint 50
Field Values
● XXX
CAD Dataset – CAD Information Page 18 of 115
2012 CARES Dataset V.3.0
EMS Dataset
Call Information
Date of Arrest/Service Date
eCustomConfiguration - servicedate
Data Format [date/time]
Definition
The date the event occurred. Date of Arrest. If none is passed, it will default to today’s date.
V2 Element: C01_05
XSD Data Type xs:dateTime XSD Domain (Simple Type) ServiceDate
Multiple Entry Configuration No Accepts Null No
Required in XSD Yes Minimum Constraint 2000 Maximum Constraint 2050
Field Values
● Valid date/time
Call Number
eResponse.03
Data Format [text]
Definition
The incident number given to this event.
V2 Element: E01_02
XSD Data Type xs:string XSD Domain (Simple Type) CallNumberID
Multiple Entry Configuration No Accepts Null No
Required in XSD Yes Minimum Constraint 0 chars Maximum Constraint 15 chars
Field Values
● A unique value; no variable list is possible.
● The combination of Service Date and Call Number must represent a unique event.
Uses
CARES does not accept Not Values or nil for this field. This must be present in every record.
Booklet ID
eCustomConfiguration - BookletID
Data Format [number]
Definition
The myCares.net™ HealthEMS™ booklet number associated to this event.
XSD Data Type xs:integer XSD Domain (Simple Type) BookletID
Multiple Entry Configuration No Accepts Null Yes
Required in XSD No Minimum Constraint 5 Maximum Constraint 10
Field Values
A unique value; no variable list is possible.
Additional Information
● This field will most likely be blank. The only uses would be for HealthEMS™ users who choose to fill out the CARES form instead of the HealthEMS™ form and need to enter the HealthEMS™ bookletid on the CARES form to later match to a HealthEMS™ record to retrieve additional information. This field would then help assist that process.
Uses
● This will be used to help auto-match this information to the corresponding CAD information
Incident Address
eScene.15
Data Format [string]
Definition
Address where incident occurred
V2 Element: E01_04
XSD Data Type xs:string XSD Domain (Simple Type) IncidentAddress
Multiple Entry Configuration No Accepts Null Yes
Required in XSD No Minimum Constraint 1 Maximum Constraint 50 chars
Field Values
*CARES maximum constraint on string length=50
Incident State ID
eScene.18
Data Format [string]
Definition
2-char state value where incident occurred
V2 Element: E01_06
XSD Data Type xs:string XSD Domain (Simple Type) IncidentStateID
Multiple Entry Configuration No Accepts Null Yes
Required in XSD No Minimum Constraint 2 chars Maximum Constraint 2 chars
Field Values
● XX
**REQUIRED FIELD IN 2012**
Incident Zip Code
eScene.19
Data Format [string]
Definition
Zip Code where incident occurred
V2 Element: E01_07
XSD Data Type xs:string XSD Domain (Simple Type) IncidentZip
Multiple Entry Configuration No Accepts Null Yes
Required in XSD No Minimum Constraint 0 Maximum Constraint 10 chars
Field Values
● XXX
**REQUIRED FIELD IN 2012**
Patient First Name
ePatient.03
Data Format [string]
Definition
Patient’s first name
V2 Element: E01_08
XSD Data Type xs:string XSD Domain (Simple Type) PatientFName
Multiple Entry Configuration No Accepts Null Yes