Public | Automated Build

Last pushed: 2 years ago
Short Description
Short description is empty for this repo.
Full Description

Predictive Search API

Autocomplete Suggestions

Autocomplete request must be of the following form:

http://<hostname>:<port>/solr/carebundle/suggestions/v1?parameters
Parameter Description
q Required. URL encoded partial search terms or natural language phrases as typed by user e.g q=back%20pai

Autocomplete Response

Autocomplete responses are returned in JSON format. In this example API response for a request with “neck pain” search query as shown below. Note that the actual JSON response doesn’t contain extra whitespace used for formatting. You should not make assumptions about the amount or format of whitespace in the response.

{"suggestions":
    [{"phrase":"Neck Pain - Primary Care Physician",
      "highlighted":"<b>Neck Pain</b> - Primary Care Physician",
      "href":"/solr/carebudle/select/v1?q=Neck+Pain+-+Primary+Care+Physician"},
     {"phrase":"Neck Pain - Cervical Spine Fusion",
      "highlighted":"<b>Neck Pain</b> - Cervical Spine Fusion",
      "href":"/solr/carebundle/select/v1?q=Neck+Pain+-+Cervical+Spine+Fusion"},
     {"phrase":"Neck Pain",
      "highlighted":"<b>Neck Pain</b>",
      "href":"/solr/carebundle/select/v1?q=Neck+Pain"}
    ]}

Carebundle Selection

It is inteded to be used in combination with Autocomplete. Submiting search terms not suggested by Autocomplete may not yield relevant results or any results at all. Carebundle Selection request must be of the following form:

http://<hostname>:<port>/solr/carebundle/select/v1?parameters
Parameter Description
q Required. URL encoded query terms as suggested by Autocomplete
rows Optional. Number of records to return. Default: 10. E.g. rows=5
start Optional. Starting records. Typically is used for pagination. E.g. start=10

Carepath Selection Response

Carepath Selection responses are returned in JSON format. In this example API response for a request with "Cervical Spine Fusion" search query as shown below. Note that the actual JSON response doesn't contain extra whitespace used for formatting. You should not make assumptions about the amount or format of whitespace in the response.

{"carebundlesFound":2, "start":0,
 "carebundles":[{"id":"BP008","carebundle":"Back Pain - Lumbar Fusion"},
                {"id":"CF001","carebundle":"Cervical Spine Fusion"}
            ],
 "specialties":[{"name":"Chiropractic Clinic",
                 "href":"/solr/carebundle/select/v1?q=%22Neck+Pain+-+Cervical+Spine+Fusion%22&fq=specialties:%22Chiropractic+Clinic%22"},
                {"name":"Free Standing MRI Center",
                 "href":"/solr/carebundle/select/v1?q=%22Neck+Pain+-+Cervical+Spine+Fusion%22&fq=specialties:%22Free+Standing+MRI+Center%22"},
                {"name":"Free Standing Radiology Facility",
                 "href":"/solr/carebundle/select/v1?q=%22Neck+Pain+-+Cervical+Spine+Fusion%22&fq=specialties:%22Free+Standing+Radiology+Facility%22"}
               ],
"conditions":[{"name":"Cervical Spine Fusion",
               "href":"/solr/carebundle/select/v1?q=%22Cervical+Spine+Fusion%22&fq=conditions:%22Cervical+Spine+Fusion%22"},
              {"name":"Pain in Neck",
               "href":"/solr/carebundle/select/v1?q=%22Cervical+Spine+Fusion%22&fq=conditions:%22Pain+in+Neck%22"},
              {"name":"Cervical Fusion",
               "href":"/solr/carebundle/select/v1?q=%22Cervical+Spine+Fusion%22&fq=conditions:%22Cervical+Fusion%22"},
              {"name":"Cervicalgia",
               "href":"/solr/carebundle/select/v1?q=%22Cervical+Spine+Fusion%22&fq=conditions:%22Cervicalgia%22"},
              {"name":"Curvature of Spine","href":"/solr/carebundle/select/v1?q=%22Cervical+Spine+Fusion%22&fq=conditions:%22Curvature+of+Spine%22"}
              ]}

Carebundle Search

It is intended for free form searches e.g. user not selecting any Autocomplete suggestions and hitting search button. Carebundle Search request must be of the following form:

http://<hostname>:<port>/solr/carebundle/search/v1?parameters
Parameter Description
q Required. URL encoded search terms and natural language phrases as entered by user
rows Optional. Number of records to return. Default: 10. E.g. rows=5
start Optional. Starting records. Typically is used for pagination. E.g. start=10

Carebundle Search Response

Carebandle Search responses are returned in JSON format. In this example API response for a request with "Cervical Spine Fusion" search query as shown below. Note that the actual JSON response doesn't contain extra whitespace used for formatting. You should not make assumptions about the amount or format of whitespace in the response.

{"carebundlesFound":10,"start":0,
 "carebundles":[{"id":"CF001","carebundle":"Cervical Spine Fusion"},
                {"id":"CF002","carebundle":"Neck Pain - Primary Care Physician"},
                {"id":"XR024","carebundle":"X-ray - Cervical Spine"},
                {"id":"BP008","carebundle":"Back Pain - Lumbar Fusion"},
                {"id":"MR007","carebundle":"MRI Neck Spine w/o Dye"},
                {"id":"XR025","carebundle":"X-ray - Lumbar Spine"},
                {"id":"LW019","carebundle":"Pap Smear"},
                {"id":"XR010","carebundle":"Dual-Energy X-Ray Absorptiometry Bone Density, Axial"},
                {"id":"MR003","carebundle":"MRI Scan - Lower Spine"},
                {"id":"CR037","carebundle":"Cancer - Neck Lymph Node Removal"}],
 "specialties":[{"name":"Family Practice Clinic",
                 "href":"/solr/carebundle/search/v1?q=cervical+spine+fusion&fq=specialties:%22Family+Practice+Clinic%22"},
                 {"name":"Internal Medicine Clinic",
                 "href":"/solr/carebundle/search/v1?q=cervical+spine+fusion&fq=specialties:%22Internal+Medicine+Clinic%22"},
                 {"name":"Primary Care Physician Clinic",
                 "href":"/solr/carebundle/search/v1?q=cervical+spine+fusion&fq=specialties:%22Primary+Care+Physician+Clinic%22"},
                 {"name":"General Practice",
                 "href":"/solr/carebundle/search/v1?q=cervical+spine+fusion&fq=specialties:%22General+Practice%22"},
                 {"name":"Pediatric (Children) Clinic",
                 "href":"/solr/carebundle/search/v1q=cervical+spine+fusion&fq=specialties:%22Pediatric+%28Children%29+Clinic%22"}
               ],
"conditions":[{"name":"Cervical Spine Fusion",
               "href":"/solr/carebundle/select/v1?q=%22Cervical+Spine+Fusion%22&fq=conditions:%22Cervical+Spine+Fusion%22"},
               {"name":"Pain in Neck",
                "href":"/solr/carebundle/select/v1?q=%22Cervical+Spine+Fusion%22&fq=conditions:%22Pain+in+Neck%22"},
              {"name":"Cervical Fusion",
               "href":"/solr/carebundle/select/v1?q=%22Cervical+Spine+Fusion%22&fq=conditions:%22Cervical+Fusion%22"},
              {"name":"Cervicalgia",
               "href":"/solr/carebundle/select/v1?q=%22Cervical+Spine+Fusion%22&fq=conditions:%22Cervicalgia%22"},
              {"name":"Curvature of Spine","href":"/solr/carebundle/select/v1?q=%22Cervical+Spine+Fusion%22&fq=conditions:%22Curvature+of+Spine%22"}
              ]}

Related Carebundles

This call finds related carebundles for a given carebundle based on similarity score. Related Carebundles request must be of the following form:

http://<hostname>:<port>/solr/carebundle/related/v1?parameters
Parameter Description
q Required. Carebundle id, e.g. 'q=AB001'
mlt.count Optional. Number of related carebundles to return. Default: 5. E.g. mlt.count=5

Related Carebundles Response

Related Carebundles responses are returned in JSON format. In this example API response for a request with "AB001" search query as shown below. Note that the actual JSON response doesn't contain extra whitespace used for formatting. You should not make assumptions about the amount or format of whitespace in the response.

{"matchedCarebundle":{"id":"AB001","carebundle":"Acute Bronchitis"},
 "related":[{"id":"AB003","carebundle":"Asthma"},
            {"id":"AB002","carebundle":"COPD - Chronic Obstructive Pulmonary Disease"},
            {"id":"EI001","carebundle":"Acute Ear Infection"},
            {"id":"SI001","carebundle":"Sinusitis - Acute"},
            {"id":"CC001","carebundle":"Cough and Cold"}]}

Glossary

This call generates a list of available carebandles grouped by prefix e.g. first letter in alphabetical order. It is recommened to leverage client side caching utilizing 304 http codes. Glossary request must be of the following form:

http://<hostname>:<port>/solr/carebundle/glossary/v1

Glossary response is returned in JSON format as shown in this example:

{"glossary":[{"prefix":"A",
              "carebundles":[{"id":"AB001","carebundle":"Acute Bronchitis"},
                             {"id":"AB003","carebundle":"Asthma"},
                             {"id":"AC001","carebundle":"Acne Pimples"},
                             {"id":"AF001","carebundle":"Athletes Foot"},
                             {"id":"AP001","carebundle":"Ankle Pain"}]},
             {"prefix":"B",
              "carebundles":[{"id":"BD001","carebundle":"Blood Draw"},
                             {"id":"BP002","carebundle":"Back Pain - Primary Care Physician"},
                             {"id":"BP004","carebundle":"Back Pain - Physical Therapy"},
                             {"id":"BP005","carebundle":"Back Pain - Chiropractor"},
                             {"id":"BP006","carebundle":"Back Pain - Epidural Steroid Injection"}]}
            ]
}
Docker Pull Command
Owner
afilimonov
Source Repository

Comments (0)