NEnexhealth
Medical History

View medical history items (beta)

🚧 Beta

Send Nex-Api-Version: v3.1.0 to use this endpoint. It is still changing, and access is limited to approved partner institutions. Contact NexHealth before you build on it.

Returns a list of medical history items (allergies, conditions, or medications) for the given location.

get/medical_history/items

Request

  • Base URL
    https://nexhealth.info
  • URL
    https://nexhealth.info/medical_history/items
  • Auth
    API key in header Authorization

Query parameters

subdomainstring required

Used to scope the request to the specified institution

location_idinteger required

Used to scope the request to the specified location

category'allergies' | 'conditions' | 'medications' required

Category of medical history items to return (allergies, conditions, medications)

search_termstring

Filter items whose name matches the search string

start_cursorstring

First item of the current page. Starts empty

end_cursorstring

Last item of the current page. Starts empty

per_pageinteger

Number of results to return per page. Maximum allowed amount is 1000.

Headers

Nex-Api-Versionstring required

The NexHealth API version

Response

Successful

codeboolean

Indicates the success or failure of the request

descriptionstring

Additional context on the request to help with debugging.

errorstring[]

Any errors that occur during the execution of the request.

page_infoobject

Pagination information that can be used for fetching previous and next pages.

Example response

{
  "description": "Description",
  "error": [
    "Error message"
  ],
  "data": [
    {
      "id": 415,
      "name": "Aspirin"
    }
  ],
  "page_info": {
    "has_previous_page": false,
    "has_next_page": false,
    "start_cursor": "AAAAA",
    "end_cursor": "BBBBBB"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.