Skip to content

Releases: Chicago/lead-safe-api-docs

v1.0.0-rc.3

12 Apr 16:25
0d30309
Compare
Choose a tag to compare
v1.0.0-rc.3 Pre-release
Pre-release

API Changes:

  • Add "Expected Delivery Date" so pregnant women can be identified separately from children #35, #36
  • Placed a maximum character limitation for submitted files #37

Minor edits:

  • Remove "Test Submission:" from subject line when an application is submitted #34
  • Clarified the contents of the risk score and risk score notes #39

v1.0.0-rc.1

27 Feb 16:48
4249be3
Compare
Choose a tag to compare
v1.0.0-rc.1 Pre-release
Pre-release

This is the first Release Candidate of the Lead Safe API. There are no modifications planned prior to the release of v1.0.0, which will be made available to health networks. Only modifications will be made prior to v1.0.0 if issues are identified during the final round of testing.

New Features:

  • API submissions require token to submit patient records for scoring
  • New endpoint (/oauth/token) to obtain a token from a client ID.

Fixes:

  • API documentation is broken-out into its own section for clarity.
  • Fixes some broken links in the application form #24
  • Removed unnecessary fillers (e.g. "XXXXXX")

v0.6.0

05 Feb 17:20
ec6046a
Compare
Choose a tag to compare
v0.6.0 Pre-release
Pre-release

New Features:

  • API returns risk_score_notes which instructs clinical staff on steps based on risk_score.

Documentation:

  • Eligibility criteria is included to provide information on requirements for all Lead Safe API users.

v0.5.0

20 Jan 00:31
de0276d
Compare
Choose a tag to compare
v0.5.0 Pre-release
Pre-release

API

  • API documentation specifies an error field which provides any error messages from the request. (#17, #14)
  • Error codes follow HTTP status code conventions

Application Form

  • Added application page that allows list of eligible hospitals to select and apply #2
  • Added required fields needed to apply (from both the clinical and technical point-of-contact)
  • Provided a terms of service (TOS) required to use the service #1
  • Within the TOS, noted this is for children between 0 and 1 years old #10
    • Likewise, have added an error code if the patient is over 1 years-old.

Clinical Content

  • Added FAQ section in both Spanish and English #16
  • Provided PDF download of both Spanish and English FAQ
  • Added a downloadable map of where elevated blood-lead levels exist throughout Chicago. #16

v0.4.0

15 Sep 23:21
Compare
Choose a tag to compare
v0.4.0 Pre-release
Pre-release

This release contains a number of tweaks and small changes to naming conventions and descriptions. The purpose of this release is to harmonize naming conventions and create a steady basis for future API releases toward v1.0.0.

This release contains a number of significant changes:

  • alliance_id was renamed to patient_id to be generalized to other versions
  • visit_date was removed from the submission and from the response
  • network_id has been added to identify different health networks
  • network_id, clinic_id, and location_id have been added to response document
  • Noted that visit and labs are optional elements for submission
  • Harmonized timestamps

v0.3.0

08 Sep 20:08
Compare
Choose a tag to compare
v0.3.0 Pre-release
Pre-release

Initial "steady", but beta, release of the Lead Safe API.