GET PlanCare2Api/MedicalIntoxicationTobacco/ActualValue?relationId={relationId}

Gets the actual MedicalIntoxicationTobaccoSummary of the specified relation.

Relation(s) can be of the following types: Client, Prospect

Requires 'Read' permission for function MedicalIntoxicationTobacco {579E3587-91BB-44F9-AD7D-BABC85B1E17D}

Request Information

URI Parameters

Name	Description	Type	Additional information
relationId	The id of the relation.	integer	Required

Body Parameters

None.

Response Information

Resource Description

Actual MedicalIntoxicationTobaccoSummary.

MedicalIntoxicationTobaccoSummary

Name	Description	Type	Additional information
StartDate	StartDate.	date	Nullable
StopDate	StopDate.	date	Nullable
MedicalCodeTobaccoStatusDescription	Description of MedicalCodeTobaccoStatus.	string	-
MedicalCodeTobaccoTypeUserDescription	Description of MedicalCodeTobaccoTypeUser.	string	-
Amount	Amount.	integer	Nullable
PackYears	PackYears.	integer	Nullable
Remarks	Remarks.	string	-
Id	Id of the registration.	integer	-
RegistrationDateTime	DateTime of measurement.	date	-
Source	Source of registration (example: name of the questionnaire).	string	-
ChangedOn	DateTime when registration is last changed (read-only).	date	-
ChangedByRelationLookupName	LookupName of the relation who made the change (read-only).	string	-
TextValue	The compound value of the registration (read-only).	string	-

Response Formats

application/json, text/json

Sample:

{
  "StartDate": "2026-05-26T21:12:09.2157924+02:00",
  "StopDate": "2026-05-26T21:12:09.2157924+02:00",
  "MedicalCodeTobaccoStatusDescription": "sample string 1",
  "MedicalCodeTobaccoTypeUserDescription": "sample string 2",
  "Amount": 1,
  "PackYears": 1,
  "Remarks": "sample string 3",
  "Id": 4,
  "RegistrationDateTime": "2026-05-26T21:12:09.2157924+02:00",
  "Source": "sample string 6",
  "ChangedOn": "2026-05-26T21:12:09.2157924+02:00",
  "ChangedByRelationLookupName": "sample string 8",
  "TextValue": "sample string 9"
}

application/xml, text/xml

Sample:

<MedicalIntoxicationTobaccoSummary xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Medical">
  <ChangedByRelationLookupName>sample string 8</ChangedByRelationLookupName>
  <ChangedOn>2026-05-26T21:12:09.2157924+02:00</ChangedOn>
  <Id>4</Id>
  <RegistrationDateTime>2026-05-26T21:12:09.2157924+02:00</RegistrationDateTime>
  <Source>sample string 6</Source>
  <TextValue>sample string 9</TextValue>
  <Amount>1</Amount>
  <MedicalCodeTobaccoStatusDescription>sample string 1</MedicalCodeTobaccoStatusDescription>
  <MedicalCodeTobaccoTypeUserDescription>sample string 2</MedicalCodeTobaccoTypeUserDescription>
  <PackYears>1</PackYears>
  <Remarks>sample string 3</Remarks>
  <StartDate>2026-05-26T21:12:09.2157924+02:00</StartDate>
  <StopDate>2026-05-26T21:12:09.2157924+02:00</StopDate>
</MedicalIntoxicationTobaccoSummary>