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

Gets the actual MedicalHeartrateSummary of the specified relation.

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

Requires 'Read' permission for function MedicalHeartrate {286E9B8E-458A-43C9-9F10-BE93EC5E923A}

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 MedicalHeartrateSummary.

MedicalHeartrateSummary

Name	Description	Type	Additional information
Frequency	Frequency per minute.	integer	-
MedicalCodeHeartrateRegularityDescription	Description of MedicalCodeHeartrateRegularity.	string	-
MedicalCodeHeartrateMethodDescription	Description of MedicalCodeHeartrateMethod.	string	-
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:

{
  "Frequency": 1,
  "MedicalCodeHeartrateRegularityDescription": "sample string 2",
  "MedicalCodeHeartrateMethodDescription": "sample string 3",
  "Remarks": "sample string 4",
  "Id": 5,
  "RegistrationDateTime": "2026-05-26T21:12:05.8423118+02:00",
  "Source": "sample string 7",
  "ChangedOn": "2026-05-26T21:12:05.8423118+02:00",
  "ChangedByRelationLookupName": "sample string 9",
  "TextValue": "sample string 10"
}

application/xml, text/xml

Sample:

<MedicalHeartrateSummary 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 9</ChangedByRelationLookupName>
  <ChangedOn>2026-05-26T21:12:05.8423118+02:00</ChangedOn>
  <Id>5</Id>
  <RegistrationDateTime>2026-05-26T21:12:05.8423118+02:00</RegistrationDateTime>
  <Source>sample string 7</Source>
  <TextValue>sample string 10</TextValue>
  <Frequency>1</Frequency>
  <MedicalCodeHeartrateMethodDescription>sample string 3</MedicalCodeHeartrateMethodDescription>
  <MedicalCodeHeartrateRegularityDescription>sample string 2</MedicalCodeHeartrateRegularityDescription>
  <Remarks>sample string 4</Remarks>
</MedicalHeartrateSummary>