v1

latestSwagger 2.02026-08-061791731.4 MB

Smoking Status

{{baseUrl}}/persons/:personId/chart/tobacco-usage

Gets a list of tobacco usage for the given person id after applying additional OData query operations.

get/persons/{personId}/chart/tobacco-usage

Path parameters

personIdstring required

(Required) (Required) The id of the patient whose tobacco usage is being retrieved

Query parameters

$topstring required

$filterstring required

$orderbystring required

$skipstring required

$inlinecountstring required

$countstring required

Headers

Acceptstring required

Response

NextPageLinkstring required

Countstring required

Example response

{
  "Items": [
    {
      "encounterId": "<string>",
      "personId": "<string>",
      "sequenceNumber": "<string>",
      "createTimestamp": "<string>",
      "maximumTobaccoFreeDuration": "<string>",
      "packYears": "<string>",
      "passiveExposure": "<string>",
      "relapseReason": "<string>",
      "tobaccoType": "<string>",
      "socialHistoryTobaccoType": "<string>",
      "tobaccoUseStatus": "<string>",
      "totalPackYears": "<string>",
      "triedToQuit": "<string>",
      "unitsPerDay": "<string>",
      "yearQuit": "<string>",
      "yearsUsed": "<string>",
      "ageStarted": "<string>",
      "ageStopped": "<string>",
      "dateStarted": "<string>",
      "dateStopped": "<string>",
      "smokingStatus": "<string>",
      "tobaccoStatus": "<string>",
      "usagePerDay": "<string>",
      "socialHistoryCreateTimestamp": "<string>",
      "tobaccoUserProfileCode": "<string>",
      "tobaccoUserProfile": "<string>",
      "useDailyCigarette": "<string>",
      "ageStartedCigarette": "<string>",
      "ageStoppedCigarette": "<string>",
      "usagePerDayCigarette": "<string>",
      "useDailyCigarillo": "<string>",
      "ageStartedCigarillo": "<string>",
      "ageStoppedCigarillo": "<string>",
      "usagePerDayCigarillo": "<string>",
      "useDailyCigar": "<string>",
      "ageStartedCigar": "<string>",
      "ageStoppedCigar": "<string>",
      "usagePerDayCigar": "<string>",
      "useDailyPipe": "<string>",
      "ageStartedPipe": "<string>",
      "ageStoppedPipe": "<string>",
      "usagePerDayPipe": "<string>",
      "_links": [
        {
          "href": "<string>",
          "method": "<string>",
          "rel": "<string>",
          "description": "<string>",
          "vendorExtensions": "<string>"
        },
        {
          "href": "<string>",
          "method": "<string>",
          "rel": "<string>",
          "description": "<string>",
          "vendorExtensions": "<string>"
        }
      ]
    },
    {
      "encounterId": "<string>",
      "personId": "<string>",
      "sequenceNumber": "<string>",
      "createTimestamp": "<string>",
      "maximumTobaccoFreeDuration": "<string>",
      "packYears": "<string>",
      "passiveExposure": "<string>",
      "relapseReason": "<string>",
      "tobaccoType": "<string>",
      "socialHistoryTobaccoType": "<string>",
      "tobaccoUseStatus": "<string>",
      "totalPackYears": "<string>",
      "triedToQuit": "<string>",
      "unitsPerDay": "<string>",
      "yearQuit": "<string>",
      "yearsUsed": "<string>",
      "ageStarted": "<string>",
      "ageStopped": "<string>",
      "dateStarted": "<string>",
      "dateStopped": "<string>",
      "smokingStatus": "<string>",
      "tobaccoStatus": "<string>",
      "usagePerDay": "<string>",
      "socialHistoryCreateTimestamp": "<string>",
      "tobaccoUserProfileCode": "<string>",
      "tobaccoUserProfile": "<string>",
      "useDailyCigarette": "<string>",
      "ageStartedCigarette": "<string>",
      "ageStoppedCigarette": "<string>",
      "usagePerDayCigarette": "<string>",
      "useDailyCigarillo": "<string>",
      "ageStartedCigarillo": "<string>",
      "ageStoppedCigarillo": "<string>",
      "usagePerDayCigarillo": "<string>",
      "useDailyCigar": "<string>",
      "ageStartedCigar": "<string>",
      "ageStoppedCigar": "<string>",
      "usagePerDayCigar": "<string>",
      "useDailyPipe": "<string>",
      "ageStartedPipe": "<string>",
      "ageStoppedPipe": "<string>",
      "usagePerDayPipe": "<string>",
      "_links": [
        {
          "href": "<string>",
          "method": "<string>",
          "rel": "<string>",
          "description": "<string>",
          "vendorExtensions": "<string>"
        },
        {
          "href": "<string>",
          "method": "<string>",
          "rel": "<string>",
          "description": "<string>",
          "vendorExtensions": "<string>"
        }
      ]
    }
  ],
  "NextPageLink": "<string>",
  "Count": "<string>"
}