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

Gets the actual MedicalIntoxicationTobaccoSummary of the specified relation.

Relation(s) must be of the following type: Client

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

Request Information

URI Parameters

NameDescriptionTypeAdditional information
relationId

The id of the relation.

integer

Required

Body Parameters

None.

Response Information

Resource Description

Actual MedicalIntoxicationTobaccoSummary.

MedicalIntoxicationTobaccoSummary
NameDescriptionTypeAdditional information
StartDate

StartDate.

date

None.

StopDate

StopDate.

date

None.

MedicalCodeTobaccoStatusDescription

Description of MedicalCodeTobaccoStatus.

string

None.

MedicalCodeTobaccoTypeUserDescription

Description of MedicalCodeTobaccoTypeUser.

string

None.

Amount

Amount.

integer

None.

PackYears

PackYears.

integer

None.

Remarks

Remarks.

string

None.

Id

Id of the registration.

integer

None.

RegistrationDateTime

DateTime of measurement.

date

None.

Source

Source of registration (example: name of the questionnaire).

string

None.

ChangedOn

DateTime when registration is last changed (readOnly).

date

None.

ChangedByRelationLookupName

LookupName of the relation who made the change (readOnly).

string

None.

TextValue

The compound value of the registration (readOnly).

string

None.

Response Formats

application/json, text/json

Sample:
{
  "StartDate": "2026-05-26T22:10:14.4665612+02:00",
  "StopDate": "2026-05-26T22:10:14.4665612+02:00",
  "MedicalCodeTobaccoStatusDescription": "sample string 1",
  "MedicalCodeTobaccoTypeUserDescription": "sample string 2",
  "Amount": 1,
  "PackYears": 1,
  "Remarks": "sample string 3",
  "Id": 4,
  "RegistrationDateTime": "2026-05-26T22:10:14.4665612+02:00",
  "Source": "sample string 6",
  "ChangedOn": "2026-05-26T22:10:14.4665612+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-26T22:10:14.4665612+02:00</ChangedOn>
  <Id>4</Id>
  <RegistrationDateTime>2026-05-26T22:10:14.4665612+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-26T22:10:14.4665612+02:00</StartDate>
  <StopDate>2026-05-26T22:10:14.4665612+02:00</StopDate>
</MedicalIntoxicationTobaccoSummary>