myCARES REST Web Service
Please start with our XML Upload Process page for important notes related to uploading data.
If you are already submitting files to myCARES and do not wish to use the SOAP web service, you can use the process that is already in place. There are a few things to note:
- When a file is submitted, there is response text available that provides a GUID to access the validation results. This can be used to search for particular records in the File Upload Validation Report using the Filename filter.
- Files submitted using the REST web service are validated against the NEMSIS 3.3.4, 3.4.0, or 3.5.0 XSD. The version of XSD is determined from the contents of the file (using xsi:schemaLocation attribute). Vendors are advised to pass a parameter with name "xsdversion" and a value of EITHER "3.3.4", "3.4.0" or "3.5.0", which will be used as a fallback. If XSD version cannot be determined from the file AND valid "xsdversion" value was not passed, the file will be rejected.
- Records that already exist in the database are not overwritten. The first submission, if successful, is the only one saved. Existing records are determined by three pieces of information in each PatientCareReport: agencyid (custom element AgencyId), Incident Number (eResponse.03) and Date of Arrest (custom element servicedate) values. The file/XML will still go through the validation process and will be rejected in the final steps of saving the record if the call already exists.
- XSD failures and schematron results are available in the File Upload Validation Report, accessed via account login at mycares.net.
Resources
Please use the following documents for upload setup, if needed. The documents explain a way to send files, but vendors may implement file submission however they choose.
Test data sent to the Beta server should not contain any PHI.
