Search

Retrieves risk assessment survey responses between the given date range.

URL
https://secure.healthx.com/api/RiskAssessmentV1/Search

HTTP Verb
POST

Parameters

  • begindate: A date in YYYY-MM-DD format.
  • enddate: A date in YYYY-MM-DD format.
  • start: The index of the first record to return (starting with 1).
  • count: The number of records to return (maximum: 100).
  • searchmodifiers: A set of name:value pairs, delimited by the pipe character. The allowable names and values are as follows:
    • sortdir: ascending or descending (default: ascending)
    • sortfield: SurveyID, QuestionName, QuestionText, Answer, Source (multiple sortfields can be specified by separating each by a comma)

Example Request

 <Search>
    <begindate>1973-01-01</begindate>
    <enddate>2020-01-01</enddate>
    <start>1</start>
    <count>100</count>                                                        <searchmodifiers>sortfield:SurveyID,QuestionName|sortdir:ascending</searchmodifiers>
  </Search>
            

Example Response

  <SearchResults>
       <Records>
          <RiskAssessmentSurveyResponse>
              <SurveyID>3d8f9e55-1218-430f-8447-60ff343fa318</SurveyID>
              <QuestionName>Q1</QuestionName>
              <QuestionText>Do you smoke?</QuestionText>
              <Answer>No</Answer>
              <Source>ACME Wellness</Source>
           </RiskAssessmentSurveyResponse>
        </Records>
        <TotalRecordCount>1</TotalRecordCount>
        <DeniedRecordCount>0</DeniedRecordCount>
  </SearchResults>
            
Comments