Releases: Chicago/lead-safe-api-docs
Releases · Chicago/lead-safe-api-docs
v1.0.0-rc.3
v1.0.0-rc.1
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
New Features:
- API returns
risk_score_notes
which instructs clinical staff on steps based onrisk_score
.
Documentation:
- Eligibility criteria is included to provide information on requirements for all Lead Safe API users.
v0.5.0
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
v0.4.0
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 topatient_id
to be generalized to other versionsvisit_date
was removed from the submission and from the responsenetwork_id
has been added to identify different health networksnetwork_id
,clinic_id
, andlocation_id
have been added to response document- Noted that
visit
andlabs
are optional elements for submission - Harmonized timestamps
v0.3.0
Initial "steady", but beta, release of the Lead Safe API.