Skip to content

Latest commit

 

History

History
348 lines (243 loc) · 11.1 KB

README.md

File metadata and controls

348 lines (243 loc) · 11.1 KB
Raw

Get Medical History

In the following, content returned by GET (both forms), and accepted as request data for both PUT and POST will be identify by the string "MEDICAL_HISTORY_DATA, which consists of the following:

clinic clinic resource id
patient patient resource id
tuberculosis true | false
pregnancy_duration integer
epilepsy true | false
cold_cough_fever true | false
pregnancy_complications true | false
allergymeds string
cancer true | false
relative_cleft true | false
meds string
parents_cleft true | false
athsma true | false
mother_alcohol true | false
troublespeaking true | false
diabetes true | false
congenitalheartdefect true | false
pregnancy_smoke true | false
troublehearing true | false
troubleeating true | false
birth_complications true | false
hivaids true | false
hepititis true | false
siblings_cleft true | false
anemia true | false
bleeding_problems true | false
first_crawl true | false
first_sit true | false
first_walk true | false
first_words true | false
birth_weight integer
birth_weight_metric true (kg) | false (lb)
height integer
height_metric true (cm) | false (in)
weight integer
weight_metric true (kg) | false (lb)
born_with_cleft_lip true | false
born_with_cleft_palate true | false

Returns json data about a single medicalhistory resource.

  • URL

    /tscharts/v1/medicalhistory/id

  • Method:

    GET

  • URL Params

    None

  • Data Params

    None

  • Success Response:

    • Code: 200
      Content:

    {"id" : id, "clinic" : id, "patient" : id, "time" : UTC date time string, MEDICAL_HISTORY_DATA}

  • Error Response:

    • Code: 404 NOT FOUND

  • Example:

GET /tscharts/v1/medicalhistory/12/ HTTP/1.1
Host: localhost
Content-Length: 2
Accept-Encoding: gzip, deflate, compress
Accept: */*
User-Agent: python-requests/2.2.1 CPython/2.7.6 Linux/4.2.0-27-generic
Content-Type: application/json
Authorization: Token 53f29e4dfc917c28a0e71f26525307250f1f8101


{}HTTP/1.1 200 OK
Date: Mon, 11 Dec 2017 01:02:24 GMT
Server: Apache/2.4.7 (Ubuntu)
Vary: Accept
X-Frame-Options: SAMEORIGIN
Allow: GET, POST, PUT, DELETE, HEAD, OPTIONS
Transfer-Encoding: chunked
Content-Type: application/json

2c5
{"first_walk":13,"birth_weight_metric":true, "born_with_cleft_lip":false, "born_with_cleft_lip":true, "height_metric":true, "weight_metric":true, "hepititis":true,"bleeding_problems":false,"first_crawl":8,"epilepsy":false,"clinic":6,"pregnancy_complications":false,"pregnancy_duration":8,"congenitalheartdefect_planforcare":false,"allergymeds":"","cancer":false,"first_sit":7,"relative_cleft":false,"id":12,"meds":"","parents_cleft":true,"athsma":false,"mother_alcohol":false,"troublespeaking":false,"anemia":false,"congenitalheartdefect":false,"pregnancy_smoke":false,"troublehearing":false,"patient":6,"troubleeating":false,"birth_complications":false,"hivaids":false,"tuberculosis":false,"siblings_cleft":true,"diabetes":false,"cold_cough_fever":false,"congenitalheartdefect_workup":false,"first_words":11,"time":"2017-12-11T01:02:24"}
0

Get Multiple Medical Histories

Returns data about all matching medicalhistory resources.

  • URL

    /tscharts/v1/medicalhistory/

  • Method:

    GET

  • URL Params

    Required:

    One or more of the following are used to filter the results.

    patient patient id
    clinic clinic id

    If both patient and clinic are specified, and the result of the query is a single object (which should be the case), then it is returned as a JSON object. Otherwise, the result is returned as a JSON array.

  • Data Params

    None

  • Success Response:

    • Code: 200
      Content: [{"id" : id, "clinic" : id, "patient" : id, "time" : UTC date time string, MEDICAL_HISTORY_DATA}, ...]

  • Error Response:

    • Code: 400 BAD REQUEST
    • Code: 403 NOT FOUND
    • Code: 500 SERVER ERROR

  • Example:

GET /tscharts/v1/medicalhistory/?clinic=3 HTTP/1.1
Host: localhost
Content-Length: 2
Accept-Encoding: gzip, deflate, compress
Accept: */*
User-Agent: python-requests/2.2.1 CPython/2.7.6 Linux/4.2.0-27-generic
Content-Type: application/json
Authorization: Token 53f29e4dfc917c28a0e71f26525307250f1f8101


{}HTTP/1.1 200 OK
Date: Mon, 11 Dec 2017 01:02:24 GMT
Server: Apache/2.4.7 (Ubuntu)
Vary: Accept
X-Frame-Options: SAMEORIGIN
Allow: GET, POST, PUT, DELETE, HEAD, OPTIONS
Transfer-Encoding: chunked
Content-Type: application/json


859
[{"birth_weight_metric":true, "height_metric":true, "born_with_cleft_lip":false, "born_with_cleft_lip":true, "weight_metric":true, "first_walk":13,"hepititis":false,"bleeding_problems":false,"first_crawl":8,"epilepsy":false,"clinic":3,"pregnancy_complications":false,"pregnancy_duration":9,"congenitalheartdefect_planforcare":false,"allergymeds":"","cancer":false,"first_sit":7,"relative_cleft":false,"id":3,"meds":"","parents_cleft":false,"athsma":false,"mother_alcohol":false,"troublespeaking":false,"anemia":false,"congenitalheartdefect":false,"pregnancy_smoke":false,"troublehearing":false,"patient":3,"troubleeating":false,"birth_complications":false,"hivaids":false,"tuberculosis":false,"siblings_cleft":false,"diabetes":false,"cold_cough_fever":false,"congenitalheartdefect_workup":false,"first_words":11,"time":"2017-12-11T01:02:24"},{"birth_weight_metric":true, "height_metric":true, "weight_metric":true, "born_with_cleft_lip":false, "born_with_cleft_lip":true, "first_walk":13,"hepititis":false,"bleeding_problems":false,"first_crawl":8,"epilepsy":false,"clinic":3,"pregnancy_complications":false,"pregnancy_duration":9,"congenitalheartdefect_planforcare":false,"allergymeds":"","cancer":false,"first_sit":7,"relative_cleft":false,"id":4,"meds":"","parents_cleft":false,"athsma":false,"mother_alcohol":false,"troublespeaking":false,"anemia":false,"congenitalheartdefect":false,"pregnancy_smoke":false,"troublehearing":false,"patient":4,"troubleeating":false,"birth_complications":false,"hivaids":false,"tuberculosis":false,"siblings_cleft":false,"diabetes":false,"cold_cough_fever":false,"congenitalheartdefect_workup":false,"first_words":11,"time":"2017-12-11T01:02:24"},{"birth_weight_metric":true, "height_metric":true, "weight_metric":true, "born_with_cleft_lip":false, "born_with_cleft_lip":true, "first_walk":13,"hepititis":false,"bleeding_problems":false,"first_crawl":8,"epilepsy":false,"clinic":3,"pregnancy_complications":false,"pregnancy_duration":9,"congenitalheartdefect_planforcare":false,"allergymeds":"","cancer":false,"first_sit":7,"relative_cleft":false,"id":5,"meds":"","parents_cleft":false,"athsma":false,"mother_alcohol":false,"troublespeaking":false,"anemia":false,"congenitalheartdefect":false,"pregnancy_smoke":false,"troublehearing":false,"patient":5,"troubleeating":false,"birth_complications":false,"hivaids":false,"tuberculosis":false,"siblings_cleft":false,"diabetes":false,"cold_cough_fever":false,"congenitalheartdefect_workup":false,"first_words":11,"time":"2017-12-11T01:02:24"}]
0

Create a Medical History

Create a medical history resource for a patient at a specific clinic.

  • URL

    /tscharts/v1/medicalhistory/

  • Method:

    POST

  • URL Params

    None

  • Data Params

    Required:

    clinic clinic resource id
    patient patient resource id
    MEDICAL_HISTORY_DATA

    Optional:

    None

  • Success Response:

    • Code: 200
      Content: { "id" : id }

  • Error Response:

    • Code: 400 BAD REQUEST
    • Code: 404 NOT FOUND
    • Code: 500 SERVER ERROR

  • Example:

POST /tscharts/v1/medicalhistory/ HTTP/1.1
Host: localhost
Content-Length: 738
Accept-Encoding: gzip, deflate, compress
Accept: */*
User-Agent: python-requests/2.2.1 CPython/2.7.6 Linux/4.2.0-27-generic
Content-Type: application/json
Authorization: Token 53f29e4dfc917c28a0e71f26525307250f1f8101


{"birth_weight_metric":true, "height_metric":true, "weight_metric":true, "born_with_cleft_lip":false, "born_with_cleft_lip":true, "first_walk": 13, "tuberculosis": false, "pregnancy_duration": 9, "troublehearing": false, "epilepsy": false, "clinic": 2, "pregnancy_complications": false, "congenitalheartdefect_planforcare": false, "allergymeds": "", "bleeding_problems": false, "first_sit": 7, "relative_cleft": false, "meds": "", "parents_cleft": false, "athsma": false, "siblings_cleft": false, "mother_alcohol": false, "troublespeaking": false, "diabetes": false, "congenitalheartdefect": false, "pregnancy_smoke": false, "first_crawl": 8, "patient": 2, "troubleeating": false, "birth_complications": false, "hivaids": false, "hepititis": false, "cancer": false, "anemia": false, "cold_cough_fever": false, "congenitalheartdefect_workup": false, "first_words": 11}HTTP/1.1 200 OK
Date: Mon, 11 Dec 2017 01:02:23 GMT
Server: Apache/2.4.7 (Ubuntu)
Vary: Accept
X-Frame-Options: SAMEORIGIN
Allow: GET, POST, PUT, DELETE, HEAD, OPTIONS
Transfer-Encoding: chunked
Content-Type: application/json


8
{"id":2}
0

Update a Medical History

Update a medicalhistory instance

  • URL

    /tscharts/v1/medicalhistory/id

  • Method:

    PUT

  • URL Params

    None

  • Data Params

    Required:

    One or more of the field/value pairs in MEDICAL_HISTORY_DATA

  • Success Response:

    • Code: 200

  • Error Response:

    • Code: 400 BAD REQUEST
    • Code: 404 NOT FOUND
    • Code: 500 SERVER ERROR

  • Example:

PUT /tscharts/v1/medicalhistory/24/ HTTP/1.1
Host: 127.0.0.1:8000
Content-Length: 18
Accept-Encoding: gzip, deflate, compress
Accept: */*
User-Agent: python-requests/2.2.1 CPython/2.7.6 Linux/4.2.0-27-generic
Content-Type: application/json
Authorization: Token b4e9102f85686fda0239562e4c8f7d3773438dae


{"relative_cleft": true}HTTP/1.0 200 OK
Date: Sun, 23 Apr 2017 01:19:21 GMT
Server: WSGIServer/0.1 Python/2.7.6
Vary: Accept
X-Frame-Options: SAMEORIGIN
Content-Type: application/json
Allow: GET, POST, PUT, DELETE, HEAD, OPTIONS


{}

Delete a Medical History

Delete a medical history resource. Use is not recommended except for unit test applications.

  • URL

    /tscharts/v1/medicalhistory/id

  • Method:

    DELETE

  • URL Params

    None

  • Data Params

    None

  • Success Response:

    • Code: 200
      Content: None

  • Error Response:

    • Code: 404 NOT FOUND

  • Example:

DELETE /tscharts/v1/medicalhistory/140/ HTTP/1.1
Host: 127.0.0.1:8000
Content-Length: 2
Accept-Encoding: gzip, deflate, compress
Accept: */*
User-Agent: python-requests/2.2.1 CPython/2.7.6 Linux/4.2.0-27-generic
Content-Type: application/json
Authorization: Token 53f29e4dfc917c28a0e71f26525307250f1f8101


{}HTTP/1.0 200 OK
Date: Fri, 21 Apr 2017 05:52:49 GMT
Server: WSGIServer/0.1 Python/2.7.6
Vary: Accept
X-Frame-Options: SAMEORIGIN
Content-Type: application/json
Allow: GET, POST, PUT, DELETE, HEAD, OPTIONS


{}