From 06f488c2bc6e8b51beebf21e4bcf64ce7c2c320e Mon Sep 17 00:00:00 2001 From: Gene Leynes Date: Wed, 23 Aug 2017 13:16:46 -0500 Subject: [PATCH 01/24] fixed table (header area) --- docs/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/index.md b/docs/index.md index 9a2ebad..41016de 100644 --- a/docs/index.md +++ b/docs/index.md @@ -15,7 +15,7 @@ In order to integrate with Lead Safe, the health provider will need to make a RE ## API ### Submitting Prediction - + Submit a patient record and retrieved the estimated probability of having elevated blood-lead levels. ```bash @@ -126,7 +126,7 @@ POST {json file} /insert/ #### Header -| Field | Format | Constraints | +| Field | Format | Constraints | | |------------------|--------------|------------------|---------------------------------------------------------------------------------------------| | Date | Integer | N/A | ID of the record submitted. | | Server | Text | "Apache" | The type of the server providing the results | From 631cba1a76ddcc5dc6919c26186264e6992ff399 Mon Sep 17 00:00:00 2001 From: Gene Leynes Date: Fri, 8 Sep 2017 12:56:07 -0500 Subject: [PATCH 02/24] drafting more general version of patient_id based on alliance_id, updating spacing, adding breaks for ONC codes --- docs/index.md | 50 +++++++++++++++++++++++++------------------------- 1 file changed, 25 insertions(+), 25 deletions(-) diff --git a/docs/index.md b/docs/index.md index 41016de..aaedbcf 100644 --- a/docs/index.md +++ b/docs/index.md @@ -22,32 +22,32 @@ Submit a patient record and retrieved the estimated probability of having elevat POST {json file} /insert/ ``` -| Field | Format | Constraints | Notes/Questions | -|----------------|----------|------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| timestamp | TimeDate | yyyy-mm-dd hh:mm:ss.sss-hh.mm | Current Timestamp. RFC 3339 (ISO 8601 derivative). | -| clinic_id | Text | | Two Characted Organization ID (NN- NearNorth EF- ErieFamily) | -| location_id | Text | | Specific Location Abbreviation in Centricity | -| alliance_id | Text | AlphaNumeric | Uses CPS PatientProfile.patientID | -| address1 | Text | Address number, street direction, street name, street type | Patientprofile.address1 | -| address2 | Text | Additional address information, e.g. apartment number | patientprofile.address2 | -| city | Text | | patientprofile.city | -| state | Text | | patientprofile.state | -| zip | Text | 5 digit zip code | patientprofile.Zip | -| date_of_birth | Date | yyyy-mm-dd | | -| gender | Text | M/F/U | | -| race | Text | Code Values from Centricity | Standard ONC Race definitionsCode description1002-5 American Indian or Alaska Native2028-9 Asian 2054-5 Black or African American 2076-8 Native Hawaiian or Other Pacific Islander 2106-3 White UNK Unknown | -| ethnicity | Text | Code Values from Centricity | Standard ONC Ethnicity definitionsCode description2135-2 Hispanic or Latino 2186-5 Non Hispanic or Latino UNK Unknown | -| Visit Array | | | | -| visit.visit_id | Numeric | 16 Digit GE ID | Unique GE ID for specific visit (DocumentID) | -| visit.date | Date | yyyy-mm-dd | | -| visit.location | Text | | Text Abbreviation for facility of visit location | -| visit.provider | Text | | Full provider name, last name, or just NPI | -| Lab Array | | | | -| lab.lab_id | Numeric | 16 Digit GE ID | Unique GE ID for specific lab result (ObsID) | -| lab.type | Text | BLL | Static BLL unless we identify additional labs to include | +| Field | Format | Constraints | Notes/Questions | +|----------------|----------|------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------| +| timestamp | TimeDate | yyyy-mm-dd hh:mm:ss.sss-hh.mm | Current Timestamp. RFC 3339 (ISO 8601 derivative). | +| clinic_id | Text | | Two Characted Organization ID (NN- NearNorth EF- ErieFamily) | +| location_id | Text | | Specific Location Abbreviation in Centricity | +| patient_id | Text | AlphaNumeric | A id to identify individual patients, should be unique with secondary key. | +| address1 | Text | Address number, street direction, street name, street type | Patientprofile.address1 | +| address2 | Text | Additional address information, e.g. apartment number | patientprofile.address2 | +| city | Text | | patientprofile.city | +| state | Text | | patientprofile.state | +| zip | Text | 5 digit zip code | patientprofile.Zip | +| date_of_birth | Date | yyyy-mm-dd | | +| gender | Text | M/F/U | | +| race | Text | Code Values from Centricity | Standard ONC Race definitions

**Code / description**
1002-5 / American Indian or Alaska Native
2028-9 / Asian
2054-5 / Black or African American
2076-8 / Native Hawaiian or Other Pacific Islander
2106-3 / White
UNK / Unknown | +| ethnicity | Text | Code Values from Centricity | Standard ONC Ethnicity definitions

**Code / description**
2135-2 / Hispanic or Latino
2186-5 / Non Hispanic or Latino
UNK / Unknown | +| Visit Array | | | | +| visit.visit_id | Numeric | 16 Digit GE ID | Unique GE ID for specific visit (DocumentID) | +| visit.date | Date | yyyy-mm-dd | | +| visit.location | Text | | Text Abbreviation for facility of visit location | +| visit.provider | Text | | Full provider name, last name, or just NPI | +| Lab Array | | | | +| lab.lab_id | Numeric | 16 Digit GE ID | Unique GE ID for specific lab result (ObsID) | +| lab.type | Text | BLL | Static BLL unless we identify additional labs to include | | lab.date | Date | yyyy-mm-dd | | -| lab.route | Text | V | *Always "V" Veinous for Alliance sites | -| lab.result | Text | | Several values are possible; integer, non-integer numeric, ranges indicated by alphanumeric text. We'll use previous examples to essentially construct a dictionary. | +| lab.route | Text | V | *Always "V" Veinous for Alliance sites | +| lab.result | Text | | Several values are possible; integer, non-integer numeric, ranges indicated by alphanumeric text. We'll use previous examples to essentially construct a dictionary. | ```json { From 9ac4fbde20b6a4c77509ea72b9ec03a025f26407 Mon Sep 17 00:00:00 2001 From: Gene Leynes Date: Fri, 8 Sep 2017 13:27:32 -0500 Subject: [PATCH 03/24] updating date format in examples to reflect RFC 3339 standard --- docs/index.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/index.md b/docs/index.md index aaedbcf..5d7b177 100644 --- a/docs/index.md +++ b/docs/index.md @@ -35,7 +35,7 @@ POST {json file} /insert/ | zip | Text | 5 digit zip code | patientprofile.Zip | | date_of_birth | Date | yyyy-mm-dd | | | gender | Text | M/F/U | | -| race | Text | Code Values from Centricity | Standard ONC Race definitions

**Code / description**
1002-5 / American Indian or Alaska Native
2028-9 / Asian
2054-5 / Black or African American
2076-8 / Native Hawaiian or Other Pacific Islander
2106-3 / White
UNK / Unknown | +| race | Text | Code Values from Centricity | Standard ONC Race definitions

**Code / description**
1002-5 / American Indian or Alaska Native
2028-9 / Asian
2054-5 / Black or African American
2076-8 / Native Hawaiian or Other Pacific Islander
2106-3 / White
UNK / Unknown | | ethnicity | Text | Code Values from Centricity | Standard ONC Ethnicity definitions

**Code / description**
2135-2 / Hispanic or Latino
2186-5 / Non Hispanic or Latino
UNK / Unknown | | Visit Array | | | | | visit.visit_id | Numeric | 16 Digit GE ID | Unique GE ID for specific visit (DocumentID) | @@ -51,7 +51,7 @@ POST {json file} /insert/ ```json { - "timestamp": "2017-08-22 12:00:00.000000", + "timestamp": "2017-08-22 12:00:00.00+00:00", "clinic_id": "EF", "location_id": "examp_loc", "alliance_id": 9000, @@ -120,7 +120,7 @@ POST {json file} /insert/ "visit_date": "2017-07-25", "version": "0.3.0", "alliance_id": 6425, - "timestamp": "2017-08-11 19:20:29" + "timestamp": "2017-08-11 19:20:29.00+00:00" } ``` From 6ffbf262878181a46a8256135ba7be089d2a154e Mon Sep 17 00:00:00 2001 From: Gene Leynes Date: Fri, 8 Sep 2017 13:36:21 -0500 Subject: [PATCH 04/24] updating date format in examples to reflect RFC 3339 standard --- docs/index.md | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/docs/index.md b/docs/index.md index 5d7b177..db2f256 100644 --- a/docs/index.md +++ b/docs/index.md @@ -24,7 +24,7 @@ POST {json file} /insert/ | Field | Format | Constraints | Notes/Questions | |----------------|----------|------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------| -| timestamp | TimeDate | yyyy-mm-dd hh:mm:ss.sss-hh.mm | Current Timestamp. RFC 3339 (ISO 8601 derivative). | +| timestamp | TimeDate | yyyy-mm-dd hh:mm:ss.sss-hh:mm | Current Timestamp. RFC 3339 (ISO 8601 derivative). | | clinic_id | Text | | Two Characted Organization ID (NN- NearNorth EF- ErieFamily) | | location_id | Text | | Specific Location Abbreviation in Centricity | | patient_id | Text | AlphaNumeric | A id to identify individual patients, should be unique with secondary key. | @@ -51,7 +51,7 @@ POST {json file} /insert/ ```json { - "timestamp": "2017-08-22 12:00:00.00+00:00", + "timestamp": "2017-08-22 12:00:00.000-00:00", "clinic_id": "EF", "location_id": "examp_loc", "alliance_id": 9000, @@ -65,20 +65,20 @@ POST {json file} /insert/ "race": "2054-5", "ethnicity": "2186-5", "visit": [ - {"date": "2017-07-25 15:02:54.171755", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"}, - {"date": "2017-07-25 15:02:54.171755", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"}, - {"date": "2017-07-25 15:02:54.171755", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"}, - {"date": "2017-07-25 15:02:54.171755", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"}, - {"date": "2017-07-25 15:02:54.171755", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"}, - {"date": "2017-07-25 15:02:54.171755", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"}, - {"date": "2017-07-25 15:02:54.171755", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"}, - {"date": "2017-07-25 15:02:54.171755", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"}, - {"date": "2017-07-25 15:02:54.171755", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"}, - {"date": "2017-07-25 15:02:54.171755", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"}, - {"date": "2017-07-25 15:02:54.171755", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"}, - {"date": "2017-07-25 15:02:54.171755", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"}, - {"date": "2017-07-25 15:02:54.171755", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"}, - {"date": "2017-07-25 15:02:54.171755", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"} + {"date": "2017-07-25", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"}, + {"date": "2017-07-25", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"}, + {"date": "2017-07-25", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"}, + {"date": "2017-07-25", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"}, + {"date": "2017-07-25", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"}, + {"date": "2017-07-25", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"}, + {"date": "2017-07-25", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"}, + {"date": "2017-07-25", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"}, + {"date": "2017-07-25", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"}, + {"date": "2017-07-25", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"}, + {"date": "2017-07-25", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"}, + {"date": "2017-07-25", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"}, + {"date": "2017-07-25", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"}, + {"date": "2017-07-25", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"} ], "lab": [ {"lab_id": 1234567891011121, "route": "V", "healthcenterid": 5.0, "result": "None Detected ug/dL", "date": "2016-07-29", "type": "BLL"}, @@ -120,7 +120,7 @@ POST {json file} /insert/ "visit_date": "2017-07-25", "version": "0.3.0", "alliance_id": 6425, - "timestamp": "2017-08-11 19:20:29.00+00:00" + "timestamp": "2017-08-11 19:20:29.000-00:00" } ``` From 023a66b7202c1e60c7ee81d32703929286759c43 Mon Sep 17 00:00:00 2001 From: Gene Leynes Date: Fri, 8 Sep 2017 15:26:43 -0500 Subject: [PATCH 05/24] adding fields, making corrections, fixing more dates; updating specification for visit date, reverting date time for visit date example, updating version number, adding network_id, correcting alliance_id to patient_id, reordering response example to match documentation --- docs/index.md | 48 +++++++++++++++++++++++++----------------------- mkdocs.yml | 2 +- 2 files changed, 26 insertions(+), 24 deletions(-) diff --git a/docs/index.md b/docs/index.md index db2f256..eb80c84 100644 --- a/docs/index.md +++ b/docs/index.md @@ -25,6 +25,8 @@ POST {json file} /insert/ | Field | Format | Constraints | Notes/Questions | |----------------|----------|------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------| | timestamp | TimeDate | yyyy-mm-dd hh:mm:ss.sss-hh:mm | Current Timestamp. RFC 3339 (ISO 8601 derivative). | +| visit_date | Date | yyyy-mm-dd | Effective date of score | +| network_id | Text | | The parent entity of the submitting organization | | clinic_id | Text | | Two Characted Organization ID (NN- NearNorth EF- ErieFamily) | | location_id | Text | | Specific Location Abbreviation in Centricity | | patient_id | Text | AlphaNumeric | A id to identify individual patients, should be unique with secondary key. | @@ -37,15 +39,15 @@ POST {json file} /insert/ | gender | Text | M/F/U | | | race | Text | Code Values from Centricity | Standard ONC Race definitions

**Code / description**
1002-5 / American Indian or Alaska Native
2028-9 / Asian
2054-5 / Black or African American
2076-8 / Native Hawaiian or Other Pacific Islander
2106-3 / White
UNK / Unknown | | ethnicity | Text | Code Values from Centricity | Standard ONC Ethnicity definitions

**Code / description**
2135-2 / Hispanic or Latino
2186-5 / Non Hispanic or Latino
UNK / Unknown | -| Visit Array | | | | +| Visit Array | | | | | visit.visit_id | Numeric | 16 Digit GE ID | Unique GE ID for specific visit (DocumentID) | -| visit.date | Date | yyyy-mm-dd | | +| visit.date | Date | yyyy-mm-dd hh:mm:ss.sss-hh:mm | RFC 3339 (ISO 8601 derivative). | | visit.location | Text | | Text Abbreviation for facility of visit location | | visit.provider | Text | | Full provider name, last name, or just NPI | | Lab Array | | | | | lab.lab_id | Numeric | 16 Digit GE ID | Unique GE ID for specific lab result (ObsID) | | lab.type | Text | BLL | Static BLL unless we identify additional labs to include | -| lab.date | Date | yyyy-mm-dd | | +| lab.date | Date | yyyy-mm-dd | | | lab.route | Text | V | *Always "V" Veinous for Alliance sites | | lab.result | Text | | Several values are possible; integer, non-integer numeric, ranges indicated by alphanumeric text. We'll use previous examples to essentially construct a dictionary. | @@ -65,20 +67,20 @@ POST {json file} /insert/ "race": "2054-5", "ethnicity": "2186-5", "visit": [ - {"date": "2017-07-25", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"}, - {"date": "2017-07-25", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"}, - {"date": "2017-07-25", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"}, - {"date": "2017-07-25", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"}, - {"date": "2017-07-25", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"}, - {"date": "2017-07-25", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"}, - {"date": "2017-07-25", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"}, - {"date": "2017-07-25", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"}, - {"date": "2017-07-25", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"}, - {"date": "2017-07-25", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"}, - {"date": "2017-07-25", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"}, - {"date": "2017-07-25", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"}, - {"date": "2017-07-25", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"}, - {"date": "2017-07-25", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"} + {"date": "2017-07-25 15:02:54.171-0:00", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"}, + {"date": "2017-07-25 15:02:54.171-0:00", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"}, + {"date": "2017-07-25 15:02:54.171-0:00", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"}, + {"date": "2017-07-25 15:02:54.171-0:00", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"}, + {"date": "2017-07-25 15:02:54.171-0:00", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"}, + {"date": "2017-07-25 15:02:54.171-0:00", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"}, + {"date": "2017-07-25 15:02:54.171-0:00", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"}, + {"date": "2017-07-25 15:02:54.171-0:00", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"}, + {"date": "2017-07-25 15:02:54.171-0:00", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"}, + {"date": "2017-07-25 15:02:54.171-0:00", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"}, + {"date": "2017-07-25 15:02:54.171-0:00", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"}, + {"date": "2017-07-25 15:02:54.171-0:00", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"}, + {"date": "2017-07-25 15:02:54.171-0:00", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"}, + {"date": "2017-07-25 15:02:54.171-0:00", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"} ], "lab": [ {"lab_id": 1234567891011121, "route": "V", "healthcenterid": 5.0, "result": "None Detected ug/dL", "date": "2016-07-29", "type": "BLL"}, @@ -109,18 +111,18 @@ POST {json file} /insert/ | version | Text | "0.2.1" | Follows Semantic Versioning 2.0.0 http://semver.org/spec/v2.0.0.html | | timestamp | TimeDate | yyyy-mm-ddThh:mm:ss.sss-hh:mm | Current Timestamp. RFC 3339 (ISO 8601 derivative). | | visit_date | Date | yyyy-mm-dd | Effective date of score | -| alliance_id | Text | AlphaNumeric | Return value provided by Feed | +| patient_id | Text | AlphaNumeric | Return value provided by Feed | | risk_score | AlphaNumeric | 9.99 | Currently expecting numeric, future may be phrased by stating an odds ratio with the risk score. | | risk_score_notes | Text | Additional notes (referral, remediation funds, etc to be returned to provider ) | | ```json { - "risk_score": "0.309", - "risk_score_notes": "Risk Score Notes", - "visit_date": "2017-07-25", "version": "0.3.0", - "alliance_id": 6425, - "timestamp": "2017-08-11 19:20:29.000-00:00" + "timestamp": "2017-08-11 19:20:29.000-00:00", + "visit_date": "2017-07-25", + "patient_id": 6425, + "risk_score": "0.309", + "risk_score_notes": "Risk Score Notes" } ``` diff --git a/mkdocs.yml b/mkdocs.yml index d60aab4..ec59edd 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,6 +1,6 @@ # Site Information -site_name: Lead Safe API v0.3.0 +site_name: Lead Safe API v0.4.0 site_author: City of Chicago site_description: Lead Free API Documentation site_url: http://dev.cityofchicago.org/docs/lead-free From 0ab0875b020f81cd7ff3002fefbe0748945e107b Mon Sep 17 00:00:00 2001 From: Gene Leynes Date: Mon, 11 Sep 2017 09:55:18 -0500 Subject: [PATCH 06/24] fixing another alliance / patient_id reference --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index eb80c84..b5a9c32 100644 --- a/docs/index.md +++ b/docs/index.md @@ -56,7 +56,7 @@ POST {json file} /insert/ "timestamp": "2017-08-22 12:00:00.000-00:00", "clinic_id": "EF", "location_id": "examp_loc", - "alliance_id": 9000, + "patient_id": 9000, "address1": "333 S State St", "address2": "Ste 420", "city": "Chicago", From 020a425fabc52b02e4954d1cb5186cd24ae82f0f Mon Sep 17 00:00:00 2001 From: Gene Leynes Date: Mon, 11 Sep 2017 09:57:09 -0500 Subject: [PATCH 07/24] updating the Venus/Capillary field to remove Alliance reference and to be lab.sample_type --- docs/index.md | 56 +++++++++++++++++++++++++-------------------------- 1 file changed, 28 insertions(+), 28 deletions(-) diff --git a/docs/index.md b/docs/index.md index b5a9c32..f856e91 100644 --- a/docs/index.md +++ b/docs/index.md @@ -22,34 +22,34 @@ Submit a patient record and retrieved the estimated probability of having elevat POST {json file} /insert/ ``` -| Field | Format | Constraints | Notes/Questions | -|----------------|----------|------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------| -| timestamp | TimeDate | yyyy-mm-dd hh:mm:ss.sss-hh:mm | Current Timestamp. RFC 3339 (ISO 8601 derivative). | -| visit_date | Date | yyyy-mm-dd | Effective date of score | -| network_id | Text | | The parent entity of the submitting organization | -| clinic_id | Text | | Two Characted Organization ID (NN- NearNorth EF- ErieFamily) | -| location_id | Text | | Specific Location Abbreviation in Centricity | -| patient_id | Text | AlphaNumeric | A id to identify individual patients, should be unique with secondary key. | -| address1 | Text | Address number, street direction, street name, street type | Patientprofile.address1 | -| address2 | Text | Additional address information, e.g. apartment number | patientprofile.address2 | -| city | Text | | patientprofile.city | -| state | Text | | patientprofile.state | -| zip | Text | 5 digit zip code | patientprofile.Zip | -| date_of_birth | Date | yyyy-mm-dd | | -| gender | Text | M/F/U | | -| race | Text | Code Values from Centricity | Standard ONC Race definitions

**Code / description**
1002-5 / American Indian or Alaska Native
2028-9 / Asian
2054-5 / Black or African American
2076-8 / Native Hawaiian or Other Pacific Islander
2106-3 / White
UNK / Unknown | -| ethnicity | Text | Code Values from Centricity | Standard ONC Ethnicity definitions

**Code / description**
2135-2 / Hispanic or Latino
2186-5 / Non Hispanic or Latino
UNK / Unknown | -| Visit Array | | | | -| visit.visit_id | Numeric | 16 Digit GE ID | Unique GE ID for specific visit (DocumentID) | -| visit.date | Date | yyyy-mm-dd hh:mm:ss.sss-hh:mm | RFC 3339 (ISO 8601 derivative). | -| visit.location | Text | | Text Abbreviation for facility of visit location | -| visit.provider | Text | | Full provider name, last name, or just NPI | -| Lab Array | | | | -| lab.lab_id | Numeric | 16 Digit GE ID | Unique GE ID for specific lab result (ObsID) | -| lab.type | Text | BLL | Static BLL unless we identify additional labs to include | -| lab.date | Date | yyyy-mm-dd | | -| lab.route | Text | V | *Always "V" Veinous for Alliance sites | -| lab.result | Text | | Several values are possible; integer, non-integer numeric, ranges indicated by alphanumeric text. We'll use previous examples to essentially construct a dictionary. | +| Field | Format | Constraints | Notes/Questions | +|-----------------|----------|------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------| +| timestamp | TimeDate | yyyy-mm-dd hh:mm:ss.sss-hh:mm | Current Timestamp. RFC 3339 (ISO 8601 derivative). | +| visit_date | Date | yyyy-mm-dd | Effective date of score | +| network_id | Text | | The parent entity of the submitting organization | +| clinic_id | Text | | Two Characted Organization ID (NN- NearNorth EF- ErieFamily) | +| location_id | Text | | Specific Location Abbreviation in Centricity | +| patient_id | Text | AlphaNumeric | A id to identify individual patients, should be unique with secondary key. | +| address1 | Text | Address number, street direction, street name, street type | Patientprofile.address1 | +| address2 | Text | Additional address information, e.g. apartment number | patientprofile.address2 | +| city | Text | | patientprofile.city | +| state | Text | | patientprofile.state | +| zip | Text | 5 digit zip code | patientprofile.Zip | +| date_of_birth | Date | yyyy-mm-dd | | +| gender | Text | M/F/U | | +| race | Text | Code Values from Centricity | Standard ONC Race definitions

**Code / description**
1002-5 / American Indian or Alaska Native
2028-9 / Asian
2054-5 / Black or African American
2076-8 / Native Hawaiian or Other Pacific Islander
2106-3 / White
UNK / Unknown | +| ethnicity | Text | Code Values from Centricity | Standard ONC Ethnicity definitions

**Code / description**
2135-2 / Hispanic or Latino
2186-5 / Non Hispanic or Latino
UNK / Unknown | +| Visit Array | | | | +| visit.visit_id | Numeric | 16 Digit GE ID | Unique GE ID for specific visit (DocumentID) | +| visit.date | Date | yyyy-mm-dd hh:mm:ss.sss-hh:mm | RFC 3339 (ISO 8601 derivative). | +| visit.location | Text | | Text Abbreviation for facility of visit location | +| visit.provider | Text | | Full provider name, last name, or just NPI | +| Lab Array | | | | +| lab.lab_id | Numeric | 16 Digit GE ID | Unique GE ID for specific lab result (ObsID) | +| lab.type | Text | BLL | Static BLL unless we identify additional labs to include | +| lab.date | Date | yyyy-mm-dd | | +| lab.sample_type | Text | "V" or "C" | *Always "V" Veinous for Alliance sites | +| lab.result | Text | | Several values are possible; integer, non-integer numeric, ranges indicated by alphanumeric text. We'll use previous examples to essentially construct a dictionary. | ```json { From 4d13ac17cb26027b6bb19c96462a4dcf4ac7f608 Mon Sep 17 00:00:00 2001 From: Gene Leynes Date: Mon, 11 Sep 2017 10:17:56 -0500 Subject: [PATCH 08/24] updating V/C description --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index f856e91..58347e9 100644 --- a/docs/index.md +++ b/docs/index.md @@ -48,7 +48,7 @@ POST {json file} /insert/ | lab.lab_id | Numeric | 16 Digit GE ID | Unique GE ID for specific lab result (ObsID) | | lab.type | Text | BLL | Static BLL unless we identify additional labs to include | | lab.date | Date | yyyy-mm-dd | | -| lab.sample_type | Text | "V" or "C" | *Always "V" Veinous for Alliance sites | +| lab.sample_type | Text | "V" or "C" | "V" Veinous or "C" for Capillary | | lab.result | Text | | Several values are possible; integer, non-integer numeric, ranges indicated by alphanumeric text. We'll use previous examples to essentially construct a dictionary. | ```json From 14755fc1523d6d69299e1b2f8f507178be2ce029 Mon Sep 17 00:00:00 2001 From: Gene Leynes Date: Tue, 12 Sep 2017 12:55:39 -0500 Subject: [PATCH 09/24] updates for 0.4.0 merge request --- docs/index.md | 144 +++++++++++++++++++++++++------------------------- 1 file changed, 73 insertions(+), 71 deletions(-) diff --git a/docs/index.md b/docs/index.md index 58347e9..25f4abc 100644 --- a/docs/index.md +++ b/docs/index.md @@ -22,38 +22,40 @@ Submit a patient record and retrieved the estimated probability of having elevat POST {json file} /insert/ ``` -| Field | Format | Constraints | Notes/Questions | -|-----------------|----------|------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------| -| timestamp | TimeDate | yyyy-mm-dd hh:mm:ss.sss-hh:mm | Current Timestamp. RFC 3339 (ISO 8601 derivative). | -| visit_date | Date | yyyy-mm-dd | Effective date of score | -| network_id | Text | | The parent entity of the submitting organization | -| clinic_id | Text | | Two Characted Organization ID (NN- NearNorth EF- ErieFamily) | -| location_id | Text | | Specific Location Abbreviation in Centricity | -| patient_id | Text | AlphaNumeric | A id to identify individual patients, should be unique with secondary key. | -| address1 | Text | Address number, street direction, street name, street type | Patientprofile.address1 | -| address2 | Text | Additional address information, e.g. apartment number | patientprofile.address2 | -| city | Text | | patientprofile.city | -| state | Text | | patientprofile.state | -| zip | Text | 5 digit zip code | patientprofile.Zip | -| date_of_birth | Date | yyyy-mm-dd | | -| gender | Text | M/F/U | | -| race | Text | Code Values from Centricity | Standard ONC Race definitions

**Code / description**
1002-5 / American Indian or Alaska Native
2028-9 / Asian
2054-5 / Black or African American
2076-8 / Native Hawaiian or Other Pacific Islander
2106-3 / White
UNK / Unknown | -| ethnicity | Text | Code Values from Centricity | Standard ONC Ethnicity definitions

**Code / description**
2135-2 / Hispanic or Latino
2186-5 / Non Hispanic or Latino
UNK / Unknown | -| Visit Array | | | | -| visit.visit_id | Numeric | 16 Digit GE ID | Unique GE ID for specific visit (DocumentID) | -| visit.date | Date | yyyy-mm-dd hh:mm:ss.sss-hh:mm | RFC 3339 (ISO 8601 derivative). | -| visit.location | Text | | Text Abbreviation for facility of visit location | -| visit.provider | Text | | Full provider name, last name, or just NPI | -| Lab Array | | | | -| lab.lab_id | Numeric | 16 Digit GE ID | Unique GE ID for specific lab result (ObsID) | -| lab.type | Text | BLL | Static BLL unless we identify additional labs to include | -| lab.date | Date | yyyy-mm-dd | | -| lab.sample_type | Text | "V" or "C" | "V" Veinous or "C" for Capillary | -| lab.result | Text | | Several values are possible; integer, non-integer numeric, ranges indicated by alphanumeric text. We'll use previous examples to essentially construct a dictionary. | +| Field | Format | Constraints | Notes | +|-----------------|----------|------------------------------------|-------------------------------------------------------------------------------------------------------------------| +| timestamp | TimeDate | yyyy-mm-dd hh:mm:ss.sss-hh:mm | Current timestamp (RFC 3339 complient date) | +| visit_date | Date | yyyy-mm-dd | [OPTIONAL] Effective date of score | +| network_id | Text | | The parent entity of the submitting organization | +| clinic_id | Text | | Organization ID | +| location_id | Text | | Specific Location Abbreviation in Centricity | +| patient_id | Text | | AlphaNumeric patient identifier | +| address1 | Text | | Patient home address (street number, street direction, street name, street type) | +| address2 | Text | | Patient home address (additional information, e.g. apartment number) | +| city | Text | | Patient home address city | +| state | Text | | Patient home address state | +| zip | Text | | Patient home address zip code | +| date_of_birth | Date | yyyy-mm-dd | Patient date of birth | +| gender | Text | M/F/U | Patient gender | +| race | Text | Code Values from Centricity | Standard ONC Race definitions

**Code / description**
1002-5 / American Indian or Alaska Native
2028-9 / Asian
2054-5 / Black or African American
2076-8 / Native Hawaiian or Other Pacific Islander
2106-3 / White
UNK / Unknown | +| ethnicity | Text | Code Values from Centricity | Standard ONC Ethnicity definitions

**Code / description**
2135-2 / Hispanic or Latino
2186-5 / Non Hispanic or Latino
UNK / Unknown | +| VISIT ARRAY | | | | +| visit.visit_id | Numeric | 16 Digit GE ID | Unique GE ID for specific visit (DocumentID) | +| visit.date | Date | yyyy-mm-dd hh:mm:ss.sss-hh:mm | Date of visit (RFC 3339 complient date) | +| visit.location | Text | | Text Abbreviation for facility of visit location | +| visit.provider | Text | | Full provider name, last name, or just NPI | +| LAB ARRAY | | | | +| lab.lab_id | Numeric | 16 Digit GE ID | Unique GE ID for specific lab result (ObsID) | +| lab.type | Text | "BLL" | Static BLL unless we identify additional labs to include | +| lab.date | Date | yyyy-mm-dd | Date of lab results | +| lab.sample_type | Text | V/C | "V" Venous or "C" for Capillary | +| lab.result | Text | | Several values are possible; integer, non-integer numeric, ranges indicated by alphanumeric text. | ```json { "timestamp": "2017-08-22 12:00:00.000-00:00", + "visit_date": "2017-08-22", + "network_id": "Alliance Health", "clinic_id": "EF", "location_id": "examp_loc", "patient_id": 9000, @@ -67,38 +69,38 @@ POST {json file} /insert/ "race": "2054-5", "ethnicity": "2186-5", "visit": [ - {"date": "2017-07-25 15:02:54.171-0:00", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"}, - {"date": "2017-07-25 15:02:54.171-0:00", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"}, - {"date": "2017-07-25 15:02:54.171-0:00", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"}, - {"date": "2017-07-25 15:02:54.171-0:00", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"}, - {"date": "2017-07-25 15:02:54.171-0:00", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"}, - {"date": "2017-07-25 15:02:54.171-0:00", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"}, - {"date": "2017-07-25 15:02:54.171-0:00", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"}, - {"date": "2017-07-25 15:02:54.171-0:00", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"}, - {"date": "2017-07-25 15:02:54.171-0:00", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"}, - {"date": "2017-07-25 15:02:54.171-0:00", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"}, - {"date": "2017-07-25 15:02:54.171-0:00", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"}, - {"date": "2017-07-25 15:02:54.171-0:00", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"}, - {"date": "2017-07-25 15:02:54.171-0:00", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"}, - {"date": "2017-07-25 15:02:54.171-0:00", "visit_id": 1234567891011121, "location": "333 S State St", "provider": "John Doe"} + {"visit_id": 1234567891011121, "date": "2017-07-25 15:02:54.171-00:00", "location": "333 S State St", "provider": "John Doe"}, + {"visit_id": 1234567891011121, "date": "2017-07-25 15:02:54.171-00:00", "location": "333 S State St", "provider": "John Doe"}, + {"visit_id": 1234567891011121, "date": "2017-07-25 15:02:54.171-00:00", "location": "333 S State St", "provider": "John Doe"}, + {"visit_id": 1234567891011121, "date": "2017-07-25 15:02:54.171-00:00", "location": "333 S State St", "provider": "John Doe"}, + {"visit_id": 1234567891011121, "date": "2017-07-25 15:02:54.171-00:00", "location": "333 S State St", "provider": "John Doe"}, + {"visit_id": 1234567891011121, "date": "2017-07-25 15:02:54.171-00:00", "location": "333 S State St", "provider": "John Doe"}, + {"visit_id": 1234567891011121, "date": "2017-07-25 15:02:54.171-00:00", "location": "333 S State St", "provider": "John Doe"}, + {"visit_id": 1234567891011121, "date": "2017-07-25 15:02:54.171-00:00", "location": "333 S State St", "provider": "John Doe"}, + {"visit_id": 1234567891011121, "date": "2017-07-25 15:02:54.171-00:00", "location": "333 S State St", "provider": "John Doe"}, + {"visit_id": 1234567891011121, "date": "2017-07-25 15:02:54.171-00:00", "location": "333 S State St", "provider": "John Doe"}, + {"visit_id": 1234567891011121, "date": "2017-07-25 15:02:54.171-00:00", "location": "333 S State St", "provider": "John Doe"}, + {"visit_id": 1234567891011121, "date": "2017-07-25 15:02:54.171-00:00", "location": "333 S State St", "provider": "John Doe"}, + {"visit_id": 1234567891011121, "date": "2017-07-25 15:02:54.171-00:00", "location": "333 S State St", "provider": "John Doe"}, + {"visit_id": 1234567891011121, "date": "2017-07-25 15:02:54.171-00:00", "location": "333 S State St", "provider": "John Doe"} ], "lab": [ - {"lab_id": 1234567891011121, "route": "V", "healthcenterid": 5.0, "result": "None Detected ug/dL", "date": "2016-07-29", "type": "BLL"}, - {"lab_id": 1234567891011121, "route": "V", "healthcenterid": 5.0, "result": "1", "date": "2015-08-21", "type": "BLL"}, - {"lab_id": 1234567891011121, "route": "V", "healthcenterid": 5.0, "result": "1", "date": "2015-02-27", "type": "BLL"}, - {"lab_id": 1234567891011121, "route": "V", "healthcenterid": 5.0, "result": "1", "date": "2014-06-06", "type": "BLL"}, - {"lab_id": 1234567891011121, "route": "V", "healthcenterid": 1.0, "result": "3", "date": "2014-09-29", "type": "BLL"}, - {"lab_id": 1234567891011121, "route": "V", "healthcenterid": 1.0, "result": "4.1", "date": "2014-01-09", "type": "BLL"}, - {"lab_id": 1234567891011121, "route": "V", "healthcenterid": 1.0, "result": "4.1", "date": "2013-06-28", "type": "BLL"}, - {"lab_id": 1234567891011121, "route": "V", "healthcenterid": 1.0, "result": "6.3", "date": "2013-03-13", "type": "BLL"}, - {"lab_id": 1234567891011121, "route": "V", "healthcenterid": 1.0, "result": "9.7", "date": "2012-10-02", "type": "BLL"}, - {"lab_id": 1234567891011121, "route": "V", "healthcenterid": 1.0, "result": "16.3", "date": "2012-06-19", "type": "BLL"}, - {"lab_id": 1234567891011121, "route": "V", "healthcenterid": 1.0, "result": "3", "date": "2016-09-16", "type": "BLL"}, - {"lab_id": 1234567891011121, "route": "V", "healthcenterid": 1.0, "result": "3", "date": "2015-12-15", "type": "BLL"}, - {"lab_id": 1234567891011121, "route": "V", "healthcenterid": 1.0, "result": "3", "date": "2015-06-09", "type": "BLL"}, - {"lab_id": 1234567891011121, "route": "V", "healthcenterid": 1.0, "result": "13.6", "date": "2012-03-20", "type": "BLL"}, - {"lab_id": 1234567891011121, "route": "V", "healthcenterid": 1.0, "result": "15", "date": "2012-02-21", "type": "BLL"}, - {"lab_id": 1234567891011121, "route": "V", "healthcenterid": 1.0, "result": "5", "date": "2011-08-19", "type": "BLL"}] + {"lab_id": 1234567891011121, "type": "BLL", "date": "2016-07-29", "sample_type": "V", "result": "None Detected ug/dL"}, + {"lab_id": 1234567891011121, "type": "BLL", "date": "2015-08-21", "sample_type": "V", "result": "1"}, + {"lab_id": 1234567891011121, "type": "BLL", "date": "2015-02-27", "sample_type": "V", "result": "1"}, + {"lab_id": 1234567891011121, "type": "BLL", "date": "2014-06-06", "sample_type": "V", "result": "1"}, + {"lab_id": 1234567891011121, "type": "BLL", "date": "2014-09-29", "sample_type": "V", "result": "3"}, + {"lab_id": 1234567891011121, "type": "BLL", "date": "2014-01-09", "sample_type": "V", "result": "4.1"}, + {"lab_id": 1234567891011121, "type": "BLL", "date": "2013-06-28", "sample_type": "V", "result": "4.1"}, + {"lab_id": 1234567891011121, "type": "BLL", "date": "2013-03-13", "sample_type": "V", "result": "6.3"}, + {"lab_id": 1234567891011121, "type": "BLL", "date": "2012-10-02", "sample_type": "V", "result": "9.7"}, + {"lab_id": 1234567891011121, "type": "BLL", "date": "2012-06-19", "sample_type": "V", "result": "16.3"}, + {"lab_id": 1234567891011121, "type": "BLL", "date": "2016-09-16", "sample_type": "V", "result": "3"}, + {"lab_id": 1234567891011121, "type": "BLL", "date": "2015-12-15", "sample_type": "V", "result": "3"}, + {"lab_id": 1234567891011121, "type": "BLL", "date": "2015-06-09", "sample_type": "V", "result": "3"}, + {"lab_id": 1234567891011121, "type": "BLL", "date": "2012-03-20", "sample_type": "V", "result": "13.6"}, + {"lab_id": 1234567891011121, "type": "BLL", "date": "2012-02-21", "sample_type": "V", "result": "15"}, + {"lab_id": 1234567891011121, "type": "BLL", "date": "2011-08-19", "sample_type": "V", "result": "5"}] } ``` @@ -106,14 +108,14 @@ POST {json file} /insert/ #### Body -| Field | Format | Constraints | Notes/Questions | -|------------------|--------------|---------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------| -| version | Text | "0.2.1" | Follows Semantic Versioning 2.0.0 http://semver.org/spec/v2.0.0.html | -| timestamp | TimeDate | yyyy-mm-ddThh:mm:ss.sss-hh:mm | Current Timestamp. RFC 3339 (ISO 8601 derivative). | -| visit_date | Date | yyyy-mm-dd | Effective date of score | -| patient_id | Text | AlphaNumeric | Return value provided by Feed | -| risk_score | AlphaNumeric | 9.99 | Currently expecting numeric, future may be phrased by stating an odds ratio with the risk score. | -| risk_score_notes | Text | Additional notes (referral, remediation funds, etc to be returned to provider ) | | +| Field | Format | Constraints | Notes/Questions | +|------------------|--------------|-----------------------------------|--------------------------------------------------------------------------------------------------| +| version | Text | "0.2.1" | Follows Semantic Versioning 2.0.0 http://semver.org/spec/v2.0.0.html | +| timestamp | TimeDate | yyyy-mm-dd hh:mm:ss.sss-hh:mm | Current Timestamp. RFC 3339 (ISO 8601 derivative). | +| visit_date | Date | yyyy-mm-dd | Effective date of score | +| patient_id | Text | AlphaNumeric | Return value provided by Feed | +| risk_score | AlphaNumeric | 9.99 | Currently expecting numeric, future may be phrased by stating an odds ratio with the risk score. | +| risk_score_notes | Text | | Additional notes (referral, remediation funds, etc to be returned to provider ) | | ```json { @@ -130,13 +132,13 @@ POST {json file} /insert/ | Field | Format | Constraints | | |------------------|--------------|------------------|---------------------------------------------------------------------------------------------| -| Date | Integer | N/A | ID of the record submitted. | +| Date | Integer | | ID of the record submitted. | | Server | Text | "Apache" | The type of the server providing the results | -| Content-Location | URL | | Pernament location to retrieve the results | -| ETag | | | | +| Content-Location | URL | | Pernament location to retrieve the results | +| ETag | | | | | Content-Length | Integer | 225 | | | Content-Type | Text | application/json | Informs user that the content will be a JSON file | -| Set-Cookie | Text | | | +| Set-Cookie | Text | | | ``` HTTP/1.1 200 OK @@ -176,7 +178,7 @@ GET /get/ | Field | Format | Constraints | |-------------|--------------|----------------|--------------------------------------------------------------------------------------------------| -| id | Integer | N/A | ID of the record submitted. | +| id | Integer | | ID of the record submitted. | | processed | Text | "Y" or "N" | Whether the results are available. Results may be an error or blank if the record was incorrect. | ```json From 543c96a3b5f64a67b0f7dd755228f16b6210e943 Mon Sep 17 00:00:00 2001 From: Tom Schenk Jr Date: Tue, 12 Sep 2017 14:00:22 -0500 Subject: [PATCH 10/24] Some tweaks to notes/description of fields --- docs/index.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/index.md b/docs/index.md index 25f4abc..97fddd3 100644 --- a/docs/index.md +++ b/docs/index.md @@ -25,7 +25,7 @@ POST {json file} /insert/ | Field | Format | Constraints | Notes | |-----------------|----------|------------------------------------|-------------------------------------------------------------------------------------------------------------------| | timestamp | TimeDate | yyyy-mm-dd hh:mm:ss.sss-hh:mm | Current timestamp (RFC 3339 complient date) | -| visit_date | Date | yyyy-mm-dd | [OPTIONAL] Effective date of score | +| visit_date | Date | yyyy-mm-dd | Effective date of score | | network_id | Text | | The parent entity of the submitting organization | | clinic_id | Text | | Organization ID | | location_id | Text | | Specific Location Abbreviation in Centricity | @@ -110,10 +110,10 @@ POST {json file} /insert/ | Field | Format | Constraints | Notes/Questions | |------------------|--------------|-----------------------------------|--------------------------------------------------------------------------------------------------| -| version | Text | "0.2.1" | Follows Semantic Versioning 2.0.0 http://semver.org/spec/v2.0.0.html | -| timestamp | TimeDate | yyyy-mm-dd hh:mm:ss.sss-hh:mm | Current Timestamp. RFC 3339 (ISO 8601 derivative). | +| version | Text | "0.3.0" | Follows Semantic Versioning 2.0.0 http://semver.org/spec/v2.0.0.html | +| timestamp | TimeDate | yyyy-mm-dd hh:mm:ss.sss-hh:mm | Current Timestamp (RFC 3339 complient date). | | visit_date | Date | yyyy-mm-dd | Effective date of score | -| patient_id | Text | AlphaNumeric | Return value provided by Feed | +| patient_id | Text | AlphaNumeric | Same `patient_id` that was submitted to the API. | | risk_score | AlphaNumeric | 9.99 | Currently expecting numeric, future may be phrased by stating an odds ratio with the risk score. | | risk_score_notes | Text | | Additional notes (referral, remediation funds, etc to be returned to provider ) | | From 23a432bd594b963c914eb3cd722de3a0d9b70236 Mon Sep 17 00:00:00 2001 From: Tom Schenk Jr Date: Tue, 12 Sep 2017 15:04:46 -0500 Subject: [PATCH 11/24] Added column header to Header table --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index 97fddd3..570d91b 100644 --- a/docs/index.md +++ b/docs/index.md @@ -130,7 +130,7 @@ POST {json file} /insert/ #### Header -| Field | Format | Constraints | | +| Field | Format | Constraints | Notes | |------------------|--------------|------------------|---------------------------------------------------------------------------------------------| | Date | Integer | | ID of the record submitted. | | Server | Text | "Apache" | The type of the server providing the results | From 1983d1b7b9f1022046d73831d6ca8663b5e0a061 Mon Sep 17 00:00:00 2001 From: Tom Schenk Jr Date: Tue, 12 Sep 2017 15:06:57 -0500 Subject: [PATCH 12/24] Added Notes header to Response table --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index 1f2b4ab..7078391 100644 --- a/docs/index.md +++ b/docs/index.md @@ -175,7 +175,7 @@ GET /get/ ##### Response -| Field | Format | Constraints | +| Field | Format | Constraints | Notes | |-------------|--------------|----------------|--------------------------------------------------------------------------------------------------| | id | Integer | | ID of the record submitted. | | processed | Text | "Y" or "N" | Whether the results are available. Results may be an error or blank if the record was incorrect. | From 27f404668783dd82dbefe251f7474783e7be1ac0 Mon Sep 17 00:00:00 2001 From: Tom Schenk Jr Date: Thu, 14 Sep 2017 10:39:19 -0500 Subject: [PATCH 13/24] Removed `visit_date` --- .travis.yml | 25 +++++++++++++++++++++++++ docs/index.md | 4 ---- 2 files changed, 25 insertions(+), 4 deletions(-) create mode 100644 .travis.yml diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..4d46002 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,25 @@ +language: ruby +sudo: required +warnings_are_errors: true +rvm: + - 2.2 +script: + - pip install --user mkdocs + - mkdocs build --clean +notifications: + email: + on_success: change + on_failure: change + +deploy: + provider: s3 + access_key_id: AKIAJYDFNXTTXQULCHEQ + secret_access_key: + secure: Uuk9RE/KvOjGH0db43arjqg36pMhq1O6v3uhIZjG4F91z3XmZhpEgRXqH/3p688yDExTmKcUYWj7SP5hiCaaDLHtkJh06gycUhza8aA17T/BW//pjikZ52DW+0k00e+kwv2vceJKj6lhNqZbX3jOqdFNcmB5LDxRtMLwSG8cm//5qijwRFV9RQfXYVz6OySf5nPz2C03n/Qh2jR9+vwICIYVMaX2zNP4QQlfh0scBqvhEad8snydpblSHkr7ELv7HMIjlIrbRSQjule4H5yN/P8lT7ZsZrNRQTuQBR2t9/XJKJ1R5R8bP+meBH3i8Yge0I7NZ9NthpSMROsraVBJ73RPQJ4mt/zD2RGmQ7F7d7d67SJGdaz+eSfNDH1NXy8i9NDqpJ4S8g+drZcp0P87K715jU3VAvESOW0MSDakSUbO/y+APjvcDwp4p2SSh1EJVesRv3VeDjv7j5LrsSaD6V+vcSWcbnYjE76anHyT9AkvHSTKUA7qCSD/MKbY/6OSpJgEKW0pYkVchuFnJPfj0AIVuje/o1fdhrjLnQQwfY234wfx7TRmXWsuhyhLjOnPzT/Lk4sD4UN88M5PWHzqJzEdA+umvAwqBDSfaRnyx6sWOI+ShBNe7Ip+cC8LT3KvLMpIcSviqpy/x/Ol8UKF09f1UhEcfbdWVwj72vZOiDs= + skip_cleanup: true + bucket: dev.cityofchicago.org + local-dir: site/ + upload-dir: docs/lead-safe + on: + repo: Chicago/lead-safe-api-docs + branch: master diff --git a/docs/index.md b/docs/index.md index 7078391..347cbe8 100644 --- a/docs/index.md +++ b/docs/index.md @@ -25,7 +25,6 @@ POST {json file} /insert/ | Field | Format | Constraints | Notes | |-----------------|----------|------------------------------------|-------------------------------------------------------------------------------------------------------------------| | timestamp | TimeDate | yyyy-mm-dd hh:mm:ss.sss-hh:mm | Current timestamp (RFC 3339 complient date) | -| visit_date | Date | yyyy-mm-dd | Effective date of score | | network_id | Text | | The parent entity of the submitting organization | | clinic_id | Text | | Organization ID | | location_id | Text | | Specific Location Abbreviation in Centricity | @@ -54,7 +53,6 @@ POST {json file} /insert/ ```json { "timestamp": "2017-08-22 12:00:00.000-00:00", - "visit_date": "2017-08-22", "network_id": "Alliance Health", "clinic_id": "EF", "location_id": "examp_loc", @@ -112,7 +110,6 @@ POST {json file} /insert/ |------------------|--------------|-----------------------------------|--------------------------------------------------------------------------------------------------| | version | Text | "0.3.0" | Follows Semantic Versioning 2.0.0 http://semver.org/spec/v2.0.0.html | | timestamp | TimeDate | yyyy-mm-dd hh:mm:ss.sss-hh:mm | Current Timestamp (RFC 3339 complient date). | -| visit_date | Date | yyyy-mm-dd | Effective date of score | | patient_id | Text | AlphaNumeric | Same `patient_id` that was submitted to the API. | | risk_score | AlphaNumeric | 9.99 | Currently expecting numeric, future may be phrased by stating an odds ratio with the risk score. | | risk_score_notes | Text | | Additional notes (referral, remediation funds, etc to be returned to provider ) | | @@ -121,7 +118,6 @@ POST {json file} /insert/ { "version": "0.3.0", "timestamp": "2017-08-11 19:20:29.000-00:00", - "visit_date": "2017-07-25", "patient_id": 6425, "risk_score": "0.309", "risk_score_notes": "Risk Score Notes" From b9176fd5cfe84b41c03e89d75195c2469e64f855 Mon Sep 17 00:00:00 2001 From: Tom Schenk Jr Date: Thu, 14 Sep 2017 10:42:42 -0500 Subject: [PATCH 14/24] Shortened the number of examples in the array --- docs/index.md | 28 ++-------------------------- 1 file changed, 2 insertions(+), 26 deletions(-) diff --git a/docs/index.md b/docs/index.md index 347cbe8..3397a54 100644 --- a/docs/index.md +++ b/docs/index.md @@ -69,36 +69,12 @@ POST {json file} /insert/ "visit": [ {"visit_id": 1234567891011121, "date": "2017-07-25 15:02:54.171-00:00", "location": "333 S State St", "provider": "John Doe"}, {"visit_id": 1234567891011121, "date": "2017-07-25 15:02:54.171-00:00", "location": "333 S State St", "provider": "John Doe"}, - {"visit_id": 1234567891011121, "date": "2017-07-25 15:02:54.171-00:00", "location": "333 S State St", "provider": "John Doe"}, - {"visit_id": 1234567891011121, "date": "2017-07-25 15:02:54.171-00:00", "location": "333 S State St", "provider": "John Doe"}, - {"visit_id": 1234567891011121, "date": "2017-07-25 15:02:54.171-00:00", "location": "333 S State St", "provider": "John Doe"}, - {"visit_id": 1234567891011121, "date": "2017-07-25 15:02:54.171-00:00", "location": "333 S State St", "provider": "John Doe"}, - {"visit_id": 1234567891011121, "date": "2017-07-25 15:02:54.171-00:00", "location": "333 S State St", "provider": "John Doe"}, - {"visit_id": 1234567891011121, "date": "2017-07-25 15:02:54.171-00:00", "location": "333 S State St", "provider": "John Doe"}, - {"visit_id": 1234567891011121, "date": "2017-07-25 15:02:54.171-00:00", "location": "333 S State St", "provider": "John Doe"}, - {"visit_id": 1234567891011121, "date": "2017-07-25 15:02:54.171-00:00", "location": "333 S State St", "provider": "John Doe"}, - {"visit_id": 1234567891011121, "date": "2017-07-25 15:02:54.171-00:00", "location": "333 S State St", "provider": "John Doe"}, - {"visit_id": 1234567891011121, "date": "2017-07-25 15:02:54.171-00:00", "location": "333 S State St", "provider": "John Doe"}, - {"visit_id": 1234567891011121, "date": "2017-07-25 15:02:54.171-00:00", "location": "333 S State St", "provider": "John Doe"}, {"visit_id": 1234567891011121, "date": "2017-07-25 15:02:54.171-00:00", "location": "333 S State St", "provider": "John Doe"} ], "lab": [ {"lab_id": 1234567891011121, "type": "BLL", "date": "2016-07-29", "sample_type": "V", "result": "None Detected ug/dL"}, - {"lab_id": 1234567891011121, "type": "BLL", "date": "2015-08-21", "sample_type": "V", "result": "1"}, - {"lab_id": 1234567891011121, "type": "BLL", "date": "2015-02-27", "sample_type": "V", "result": "1"}, - {"lab_id": 1234567891011121, "type": "BLL", "date": "2014-06-06", "sample_type": "V", "result": "1"}, - {"lab_id": 1234567891011121, "type": "BLL", "date": "2014-09-29", "sample_type": "V", "result": "3"}, - {"lab_id": 1234567891011121, "type": "BLL", "date": "2014-01-09", "sample_type": "V", "result": "4.1"}, - {"lab_id": 1234567891011121, "type": "BLL", "date": "2013-06-28", "sample_type": "V", "result": "4.1"}, - {"lab_id": 1234567891011121, "type": "BLL", "date": "2013-03-13", "sample_type": "V", "result": "6.3"}, - {"lab_id": 1234567891011121, "type": "BLL", "date": "2012-10-02", "sample_type": "V", "result": "9.7"}, - {"lab_id": 1234567891011121, "type": "BLL", "date": "2012-06-19", "sample_type": "V", "result": "16.3"}, - {"lab_id": 1234567891011121, "type": "BLL", "date": "2016-09-16", "sample_type": "V", "result": "3"}, - {"lab_id": 1234567891011121, "type": "BLL", "date": "2015-12-15", "sample_type": "V", "result": "3"}, - {"lab_id": 1234567891011121, "type": "BLL", "date": "2015-06-09", "sample_type": "V", "result": "3"}, - {"lab_id": 1234567891011121, "type": "BLL", "date": "2012-03-20", "sample_type": "V", "result": "13.6"}, - {"lab_id": 1234567891011121, "type": "BLL", "date": "2012-02-21", "sample_type": "V", "result": "15"}, - {"lab_id": 1234567891011121, "type": "BLL", "date": "2011-08-19", "sample_type": "V", "result": "5"}] + {"lab_id": 1234567891011121, "type": "BLL", "date": "2015-08-21", "sample_type": "V", "result": "16.3"}, + {"lab_id": 1234567891011121, "type": "BLL", "date": "2015-02-27", "sample_type": "V", "result": "1"}] } ``` From ef66b025aaac6dad40c09b2495db279855dd7de9 Mon Sep 17 00:00:00 2001 From: Tom Schenk Jr Date: Thu, 14 Sep 2017 10:54:31 -0500 Subject: [PATCH 15/24] Modified language and fixed inconsistencies Modified some of the language to be consistent and better-represent the intent of the model. Also fixed inconsistencies in how patient_id is suppose to be a string in the submission and response. --- docs/index.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/index.md b/docs/index.md index 3397a54..4212b49 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,4 +1,4 @@ -"Lead Safe" is an API available to Chicago-area hospital and health networks to provide estimates on a child's potential exposure to elevated lead levels from household paint. Health network providers can provide information on the patient's demographics, address, and history on their past visits and blood-lead levels, the Lead Safe API will provide an estimate on the chance of elevated, unsafe blood-lead levels for children under 4 years-old. +"Lead Safe" is an API available to Chicago-area hospital and health networks to estimate the likelihood that a child will be exposed to lead-based paint hazards. Health network providers can provide information on the patient's demographics, address, and history on their past visits and blood-lead levels, the Lead Safe API will provide an estimate on the chance of elevated, unsafe blood-lead levels for children under 4 years-old. The API uses a predictive model developed by the University of Chicago[^1] that uses historical blood-lead level testing conducted by the State of Illinois. Data submitted through this API and subsequent testing conducted will improve the accuracy of the model, allowing for a more effective use of blood tests to prevent elevated lead levels. @@ -14,9 +14,9 @@ In order to integrate with Lead Safe, the health provider will need to make a RE ## API -### Submitting Prediction +### Submitting Patient Record -Submit a patient record and retrieved the estimated probability of having elevated blood-lead levels. +Submit a patient record and retrieve the estimated risk of having elevated blood-lead levels. ```bash POST {json file} /insert/ @@ -56,7 +56,7 @@ POST {json file} /insert/ "network_id": "Alliance Health", "clinic_id": "EF", "location_id": "examp_loc", - "patient_id": 9000, + "patient_id": "9000", "address1": "333 S State St", "address2": "Ste 420", "city": "Chicago", @@ -87,14 +87,14 @@ POST {json file} /insert/ | version | Text | "0.3.0" | Follows Semantic Versioning 2.0.0 http://semver.org/spec/v2.0.0.html | | timestamp | TimeDate | yyyy-mm-dd hh:mm:ss.sss-hh:mm | Current Timestamp (RFC 3339 complient date). | | patient_id | Text | AlphaNumeric | Same `patient_id` that was submitted to the API. | -| risk_score | AlphaNumeric | 9.99 | Currently expecting numeric, future may be phrased by stating an odds ratio with the risk score. | +| risk_score | Test | 9.99 | Currently expecting numeric, future may be phrased by stating an odds ratio with the risk score. | | risk_score_notes | Text | | Additional notes (referral, remediation funds, etc to be returned to provider ) | | ```json { "version": "0.3.0", "timestamp": "2017-08-11 19:20:29.000-00:00", - "patient_id": 6425, + "patient_id": "9000", "risk_score": "0.309", "risk_score_notes": "Risk Score Notes" } From 733fc162107b7c3b398c3476a239da50f87b7618 Mon Sep 17 00:00:00 2001 From: Tom Schenk Jr Date: Thu, 14 Sep 2017 10:59:54 -0500 Subject: [PATCH 16/24] Type-o fix --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index 4212b49..9c313ff 100644 --- a/docs/index.md +++ b/docs/index.md @@ -87,7 +87,7 @@ POST {json file} /insert/ | version | Text | "0.3.0" | Follows Semantic Versioning 2.0.0 http://semver.org/spec/v2.0.0.html | | timestamp | TimeDate | yyyy-mm-dd hh:mm:ss.sss-hh:mm | Current Timestamp (RFC 3339 complient date). | | patient_id | Text | AlphaNumeric | Same `patient_id` that was submitted to the API. | -| risk_score | Test | 9.99 | Currently expecting numeric, future may be phrased by stating an odds ratio with the risk score. | +| risk_score | Text | 9.99 | Currently expecting numeric, future may be phrased by stating an odds ratio with the risk score. | | risk_score_notes | Text | | Additional notes (referral, remediation funds, etc to be returned to provider ) | | ```json From 2db6b4d38cc86ba53d4af95d884242ddfad98c02 Mon Sep 17 00:00:00 2001 From: Gene Leynes Date: Thu, 14 Sep 2017 14:23:55 -0500 Subject: [PATCH 17/24] changed 'chance' to 'risk' to align more closely with other wording in the document --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index 9c313ff..7b2de73 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,4 +1,4 @@ -"Lead Safe" is an API available to Chicago-area hospital and health networks to estimate the likelihood that a child will be exposed to lead-based paint hazards. Health network providers can provide information on the patient's demographics, address, and history on their past visits and blood-lead levels, the Lead Safe API will provide an estimate on the chance of elevated, unsafe blood-lead levels for children under 4 years-old. +"Lead Safe" is an API available to Chicago-area hospital and health networks to estimate the likelihood that a child will be exposed to lead-based paint hazards. Health network providers can provide information on the patient's demographics, address, and history on their past visits and blood-lead levels, the Lead Safe API will provide an estimate of the risk of elevated, unsafe blood-lead levels for children under 4 years-old. The API uses a predictive model developed by the University of Chicago[^1] that uses historical blood-lead level testing conducted by the State of Illinois. Data submitted through this API and subsequent testing conducted will improve the accuracy of the model, allowing for a more effective use of blood tests to prevent elevated lead levels. From 8236865daa894e94343713ab5efc96d3a8c25f71 Mon Sep 17 00:00:00 2001 From: Gene Leynes Date: Thu, 14 Sep 2017 14:24:44 -0500 Subject: [PATCH 18/24] fixed spacing so that tables are easier to read --- docs/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/index.md b/docs/index.md index 7b2de73..6ea42db 100644 --- a/docs/index.md +++ b/docs/index.md @@ -28,7 +28,7 @@ POST {json file} /insert/ | network_id | Text | | The parent entity of the submitting organization | | clinic_id | Text | | Organization ID | | location_id | Text | | Specific Location Abbreviation in Centricity | -| patient_id | Text | | AlphaNumeric patient identifier | +| patient_id | Text | | AlphaNumeric patient identifier | | address1 | Text | | Patient home address (street number, street direction, street name, street type) | | address2 | Text | | Patient home address (additional information, e.g. apartment number) | | city | Text | | Patient home address city | @@ -87,7 +87,7 @@ POST {json file} /insert/ | version | Text | "0.3.0" | Follows Semantic Versioning 2.0.0 http://semver.org/spec/v2.0.0.html | | timestamp | TimeDate | yyyy-mm-dd hh:mm:ss.sss-hh:mm | Current Timestamp (RFC 3339 complient date). | | patient_id | Text | AlphaNumeric | Same `patient_id` that was submitted to the API. | -| risk_score | Text | 9.99 | Currently expecting numeric, future may be phrased by stating an odds ratio with the risk score. | +| risk_score | Text | 9.99 | Currently expecting numeric, future may be phrased by stating an odds ratio with the risk score. | | risk_score_notes | Text | | Additional notes (referral, remediation funds, etc to be returned to provider ) | | ```json From 2ebef3c4163b4c136180d4e501b1beb8b1bb311d Mon Sep 17 00:00:00 2001 From: Gene Leynes Date: Thu, 14 Sep 2017 14:25:20 -0500 Subject: [PATCH 19/24] added escape to NA so that it prints --- docs/index.md | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/docs/index.md b/docs/index.md index 6ea42db..745a002 100644 --- a/docs/index.md +++ b/docs/index.md @@ -25,15 +25,15 @@ POST {json file} /insert/ | Field | Format | Constraints | Notes | |-----------------|----------|------------------------------------|-------------------------------------------------------------------------------------------------------------------| | timestamp | TimeDate | yyyy-mm-dd hh:mm:ss.sss-hh:mm | Current timestamp (RFC 3339 complient date) | -| network_id | Text | | The parent entity of the submitting organization | -| clinic_id | Text | | Organization ID | -| location_id | Text | | Specific Location Abbreviation in Centricity | -| patient_id | Text | | AlphaNumeric patient identifier | -| address1 | Text | | Patient home address (street number, street direction, street name, street type) | -| address2 | Text | | Patient home address (additional information, e.g. apartment number) | -| city | Text | | Patient home address city | -| state | Text | | Patient home address state | -| zip | Text | | Patient home address zip code | +| network_id | Text | | The parent entity of the submitting organization | +| clinic_id | Text | | Organization ID | +| location_id | Text | | Specific Location Abbreviation in Centricity | +| patient_id | Text | | AlphaNumeric patient identifier | +| address1 | Text | | Patient home address (street number, street direction, street name, street type) | +| address2 | Text | | Patient home address (additional information, e.g. apartment number) | +| city | Text | | Patient home address city | +| state | Text | | Patient home address state | +| zip | Text | | Patient home address zip code | | date_of_birth | Date | yyyy-mm-dd | Patient date of birth | | gender | Text | M/F/U | Patient gender | | race | Text | Code Values from Centricity | Standard ONC Race definitions

**Code / description**
1002-5 / American Indian or Alaska Native
2028-9 / Asian
2054-5 / Black or African American
2076-8 / Native Hawaiian or Other Pacific Islander
2106-3 / White
UNK / Unknown | @@ -41,14 +41,14 @@ POST {json file} /insert/ | VISIT ARRAY | | | | | visit.visit_id | Numeric | 16 Digit GE ID | Unique GE ID for specific visit (DocumentID) | | visit.date | Date | yyyy-mm-dd hh:mm:ss.sss-hh:mm | Date of visit (RFC 3339 complient date) | -| visit.location | Text | | Text Abbreviation for facility of visit location | -| visit.provider | Text | | Full provider name, last name, or just NPI | +| visit.location | Text | | Text Abbreviation for facility of visit location | +| visit.provider | Text | | Full provider name, last name, or just NPI | | LAB ARRAY | | | | | lab.lab_id | Numeric | 16 Digit GE ID | Unique GE ID for specific lab result (ObsID) | | lab.type | Text | "BLL" | Static BLL unless we identify additional labs to include | | lab.date | Date | yyyy-mm-dd | Date of lab results | | lab.sample_type | Text | V/C | "V" Venous or "C" for Capillary | -| lab.result | Text | | Several values are possible; integer, non-integer numeric, ranges indicated by alphanumeric text. | +| lab.result | Text | | Several values are possible; integer, non-integer numeric, ranges indicated by alphanumeric text. | ```json { @@ -88,7 +88,7 @@ POST {json file} /insert/ | timestamp | TimeDate | yyyy-mm-dd hh:mm:ss.sss-hh:mm | Current Timestamp (RFC 3339 complient date). | | patient_id | Text | AlphaNumeric | Same `patient_id` that was submitted to the API. | | risk_score | Text | 9.99 | Currently expecting numeric, future may be phrased by stating an odds ratio with the risk score. | -| risk_score_notes | Text | | Additional notes (referral, remediation funds, etc to be returned to provider ) | | +| risk_score_notes | Text | | Additional notes (referral, remediation funds, etc to be returned to provider ) | | ```json { @@ -104,13 +104,13 @@ POST {json file} /insert/ | Field | Format | Constraints | Notes | |------------------|--------------|------------------|---------------------------------------------------------------------------------------------| -| Date | Integer | | ID of the record submitted. | +| Date | Integer | | ID of the record submitted. | | Server | Text | "Apache" | The type of the server providing the results | -| Content-Location | URL | | Pernament location to retrieve the results | -| ETag | | | | +| Content-Location | URL | | Pernament location to retrieve the results | +| ETag | | | | | Content-Length | Integer | 225 | | | Content-Type | Text | application/json | Informs user that the content will be a JSON file | -| Set-Cookie | Text | | | +| Set-Cookie | Text | | | ``` HTTP/1.1 200 OK @@ -149,7 +149,7 @@ GET /get/ | Field | Format | Constraints | Notes | |-------------|--------------|----------------|--------------------------------------------------------------------------------------------------| -| id | Integer | | ID of the record submitted. | +| id | Integer | | ID of the record submitted. | | processed | Text | "Y" or "N" | Whether the results are available. Results may be an error or blank if the record was incorrect. | ```json From 747c84146be4c762512560f207a8d1a23b66c696 Mon Sep 17 00:00:00 2001 From: Eric Potash Date: Thu, 14 Sep 2017 14:29:57 -0500 Subject: [PATCH 20/24] added my affiliation --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index 745a002..682c2ac 100644 --- a/docs/index.md +++ b/docs/index.md @@ -181,6 +181,6 @@ Thou shalt not... ## Acknowledgements -The "Lead Safe" API was developed by the [Chicago Department of Public Health](https://www.cityofchicago.org/city/en/depts/cdph.html), [University of Chicago's Center for Data Science and Public Policy](http://dsapp.uchicago.edu/), and the [Chicago Department of Innovation and Technology](https://www.cityofchicago.org/city/en/depts/doit.html). This project was made possible by a grant from the [Robert Wood Johnson Foundation](http://www.rwjf.org/). +The "Lead Safe" API was developed by the [Chicago Department of Public Health](https://www.cityofchicago.org/city/en/depts/cdph.html), University of Chicago's [Center for Data Science and Public Policy](http://dsapp.uchicago.edu/) and [Harris School of Public Policy](http://harris.uchicago.edu), and the [Chicago Department of Innovation and Technology](https://www.cityofchicago.org/city/en/depts/doit.html). This project was made possible by a grant from the [Robert Wood Johnson Foundation](http://www.rwjf.org/). [^1]: Potash _et al._ (2015) [Predictive Modeling for Public Health](ttps://dssg.uchicago.edu/wp-content/uploads/2016/01/p2039-potash.pdf). _Proceedings of the 21th ACM SIGKDD International Conference on Knowledge Discovery and Data Mining_ pp. 2039-2047. From 8f0ba40398f089fb18924966fee16af8e6acee61 Mon Sep 17 00:00:00 2001 From: Tom Schenk Jr Date: Fri, 15 Sep 2017 17:39:05 -0500 Subject: [PATCH 21/24] Visit and Lab history now optional --- docs/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/index.md b/docs/index.md index 682c2ac..0cdc046 100644 --- a/docs/index.md +++ b/docs/index.md @@ -38,12 +38,12 @@ POST {json file} /insert/ | gender | Text | M/F/U | Patient gender | | race | Text | Code Values from Centricity | Standard ONC Race definitions

**Code / description**
1002-5 / American Indian or Alaska Native
2028-9 / Asian
2054-5 / Black or African American
2076-8 / Native Hawaiian or Other Pacific Islander
2106-3 / White
UNK / Unknown | | ethnicity | Text | Code Values from Centricity | Standard ONC Ethnicity definitions

**Code / description**
2135-2 / Hispanic or Latino
2186-5 / Non Hispanic or Latino
UNK / Unknown | -| VISIT ARRAY | | | | +| VISIT ARRAY | | | _Optional_ May entirely omit the array if visit history does not exist or is unavailable. | | visit.visit_id | Numeric | 16 Digit GE ID | Unique GE ID for specific visit (DocumentID) | | visit.date | Date | yyyy-mm-dd hh:mm:ss.sss-hh:mm | Date of visit (RFC 3339 complient date) | | visit.location | Text | | Text Abbreviation for facility of visit location | | visit.provider | Text | | Full provider name, last name, or just NPI | -| LAB ARRAY | | | | +| LAB ARRAY | | | _Optional_ May entirely omit the array if visit history does not exist or is unavailable. | | lab.lab_id | Numeric | 16 Digit GE ID | Unique GE ID for specific lab result (ObsID) | | lab.type | Text | "BLL" | Static BLL unless we identify additional labs to include | | lab.date | Date | yyyy-mm-dd | Date of lab results | From 5ea64f5d8c65a2c0022d24270d7db817ad756d3b Mon Sep 17 00:00:00 2001 From: Tom Schenk Jr Date: Fri, 15 Sep 2017 17:47:43 -0500 Subject: [PATCH 22/24] Added `network_id`, `clinic_id`, `location_id` to response document --- docs/index.md | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/docs/index.md b/docs/index.md index 0cdc046..cb249c0 100644 --- a/docs/index.md +++ b/docs/index.md @@ -82,18 +82,24 @@ POST {json file} /insert/ #### Body -| Field | Format | Constraints | Notes/Questions | -|------------------|--------------|-----------------------------------|--------------------------------------------------------------------------------------------------| -| version | Text | "0.3.0" | Follows Semantic Versioning 2.0.0 http://semver.org/spec/v2.0.0.html | -| timestamp | TimeDate | yyyy-mm-dd hh:mm:ss.sss-hh:mm | Current Timestamp (RFC 3339 complient date). | -| patient_id | Text | AlphaNumeric | Same `patient_id` that was submitted to the API. | -| risk_score | Text | 9.99 | Currently expecting numeric, future may be phrased by stating an odds ratio with the risk score. | -| risk_score_notes | Text | | Additional notes (referral, remediation funds, etc to be returned to provider ) | | +| Field | Format | Constraints | Notes/Questions | +|------------------|----------|-------------------------------|--------------------------------------------------------------------------------------------| +| version | Text | "0.3.0" | Follows Semantic Versioning 2.0.0 http://semver.org/spec/v2.0.0.html | +| timestamp | TimeDate | yyyy-mm-dd hh:mm:ss.sss-hh:mm | Current Timestamp (RFC 3339 complient date). | +| network_id | Text | | Parent entity - same value as submitted to the API. | +| clinic_id | Text | | Organization ID - same value as submitted to the API. | +| location_id | Text | | Specific Location Abbreviation in Centricity - same value as submitted to the API. | +| patient_id | Text | AlphaNumeric | Identifier for the patient - same value as submitted to the API. | +| risk_score | Text | 9.99 | Currently expecting numeric, future may be phrased by stating an odds ratio with the risk score. | +| risk_score_notes | Text | | Additional notes (referral, remediation funds, etc to be returned to provider ) | ```json { "version": "0.3.0", "timestamp": "2017-08-11 19:20:29.000-00:00", + "network_id": "Alliance Health", + "clinic_id": "EF", + "location_id": "examp_loc", "patient_id": "9000", "risk_score": "0.309", "risk_score_notes": "Risk Score Notes" From 8152bb44400b53fe8c17378ff5b9133f1746ade0 Mon Sep 17 00:00:00 2001 From: Tom Schenk Jr Date: Fri, 15 Sep 2017 17:49:48 -0500 Subject: [PATCH 23/24] Didn't mean to commit travis file, undoing --- .travis.yml | 25 ------------------------- 1 file changed, 25 deletions(-) delete mode 100644 .travis.yml diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index 4d46002..0000000 --- a/.travis.yml +++ /dev/null @@ -1,25 +0,0 @@ -language: ruby -sudo: required -warnings_are_errors: true -rvm: - - 2.2 -script: - - pip install --user mkdocs - - mkdocs build --clean -notifications: - email: - on_success: change - on_failure: change - -deploy: - provider: s3 - access_key_id: AKIAJYDFNXTTXQULCHEQ - secret_access_key: - secure: Uuk9RE/KvOjGH0db43arjqg36pMhq1O6v3uhIZjG4F91z3XmZhpEgRXqH/3p688yDExTmKcUYWj7SP5hiCaaDLHtkJh06gycUhza8aA17T/BW//pjikZ52DW+0k00e+kwv2vceJKj6lhNqZbX3jOqdFNcmB5LDxRtMLwSG8cm//5qijwRFV9RQfXYVz6OySf5nPz2C03n/Qh2jR9+vwICIYVMaX2zNP4QQlfh0scBqvhEad8snydpblSHkr7ELv7HMIjlIrbRSQjule4H5yN/P8lT7ZsZrNRQTuQBR2t9/XJKJ1R5R8bP+meBH3i8Yge0I7NZ9NthpSMROsraVBJ73RPQJ4mt/zD2RGmQ7F7d7d67SJGdaz+eSfNDH1NXy8i9NDqpJ4S8g+drZcp0P87K715jU3VAvESOW0MSDakSUbO/y+APjvcDwp4p2SSh1EJVesRv3VeDjv7j5LrsSaD6V+vcSWcbnYjE76anHyT9AkvHSTKUA7qCSD/MKbY/6OSpJgEKW0pYkVchuFnJPfj0AIVuje/o1fdhrjLnQQwfY234wfx7TRmXWsuhyhLjOnPzT/Lk4sD4UN88M5PWHzqJzEdA+umvAwqBDSfaRnyx6sWOI+ShBNe7Ip+cC8LT3KvLMpIcSviqpy/x/Ol8UKF09f1UhEcfbdWVwj72vZOiDs= - skip_cleanup: true - bucket: dev.cityofchicago.org - local-dir: site/ - upload-dir: docs/lead-safe - on: - repo: Chicago/lead-safe-api-docs - branch: master From 33176a3d55d835b49c24d5c3e1ef74ba6eab8e3b Mon Sep 17 00:00:00 2001 From: Tom Schenk Jr Date: Fri, 15 Sep 2017 17:56:36 -0500 Subject: [PATCH 24/24] Tweaking format of submission table --- docs/index.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/index.md b/docs/index.md index cb249c0..2d0bd9f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -36,8 +36,8 @@ POST {json file} /insert/ | zip | Text | | Patient home address zip code | | date_of_birth | Date | yyyy-mm-dd | Patient date of birth | | gender | Text | M/F/U | Patient gender | -| race | Text | Code Values from Centricity | Standard ONC Race definitions

**Code / description**
1002-5 / American Indian or Alaska Native
2028-9 / Asian
2054-5 / Black or African American
2076-8 / Native Hawaiian or Other Pacific Islander
2106-3 / White
UNK / Unknown | -| ethnicity | Text | Code Values from Centricity | Standard ONC Ethnicity definitions

**Code / description**
2135-2 / Hispanic or Latino
2186-5 / Non Hispanic or Latino
UNK / Unknown | +| race | Text | Code Values from Centricity | Standard ONC Race definitions

**Code / description**
1002-5 / American Indian or Alaska Native
2028-9 / Asian
2054-5 / Black or African American
2076-8 / Native Hawaiian or Other Pacific Islander
2106-3 / White
UNK / Unknown | +| ethnicity | Text | Code Values from Centricity | Standard ONC Ethnicity definitions

**Code / description**
2135-2 / Hispanic or Latino
2186-5 / Non Hispanic or Latino
UNK / Unknown | | VISIT ARRAY | | | _Optional_ May entirely omit the array if visit history does not exist or is unavailable. | | visit.visit_id | Numeric | 16 Digit GE ID | Unique GE ID for specific visit (DocumentID) | | visit.date | Date | yyyy-mm-dd hh:mm:ss.sss-hh:mm | Date of visit (RFC 3339 complient date) | @@ -47,7 +47,7 @@ POST {json file} /insert/ | lab.lab_id | Numeric | 16 Digit GE ID | Unique GE ID for specific lab result (ObsID) | | lab.type | Text | "BLL" | Static BLL unless we identify additional labs to include | | lab.date | Date | yyyy-mm-dd | Date of lab results | -| lab.sample_type | Text | V/C | "V" Venous or "C" for Capillary | +| lab.sample_type | Text | V/C | "V" Venous
"C" for Capillary | | lab.result | Text | | Several values are possible; integer, non-integer numeric, ranges indicated by alphanumeric text. | ```json