GET PlanCare2Api/MedicalHeartrate?relationId={relationId}&registrationDateTimeFrom={registrationDateTimeFrom}&registrationDateTimeUntil={registrationDateTimeUntil}

Gets list of MedicalHeartrateSummary of the specified relation.

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

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
registrationDateTimeFrom	RegistrationDateTime filter from.	date	None
registrationDateTimeUntil	RegistrationDateTime filter until.	date	None

Body Parameters

None.

Response Information

Resource Description

List of MedicalHeartrateSummary.

Collection of MedicalHeartrateSummary

Name	Description	Type	Additional information
Frequency	Frequency per minute.	integer	None
MedicalCodeHeartrateRegularityDescription	Description of MedicalCodeHeartrateRegularity.	string	None
MedicalCodeHeartrateMethodDescription	Description of MedicalCodeHeartrateMethod.	string	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 (read-only).	date	None
ChangedByRelationLookupName	LookupName of the relation who made the change (read-only).	string	None
TextValue	The compound value of the registration (read-only).	string	None

Response Formats

application/json, text/json

Sample:

[
  {
    "$id": "1",
    "Frequency": 1,
    "MedicalCodeHeartrateRegularityDescription": "sample string 2",
    "MedicalCodeHeartrateMethodDescription": "sample string 3",
    "Remarks": "sample string 4",
    "Id": 5,
    "RegistrationDateTime": "2026-05-26T21:11:33.8539944+02:00",
    "Source": "sample string 7",
    "ChangedOn": "2026-05-26T21:11:33.8539944+02:00",
    "ChangedByRelationLookupName": "sample string 9",
    "TextValue": "sample string 10"
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:

<ArrayOfMedicalHeartrateSummary xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Medical">
  <MedicalHeartrateSummary>
    <ChangedByRelationLookupName>sample string 9</ChangedByRelationLookupName>
    <ChangedOn>2026-05-26T21:11:33.8539944+02:00</ChangedOn>
    <Id>5</Id>
    <RegistrationDateTime>2026-05-26T21:11:33.8539944+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>
  <MedicalHeartrateSummary>
    <ChangedByRelationLookupName>sample string 9</ChangedByRelationLookupName>
    <ChangedOn>2026-05-26T21:11:33.8539944+02:00</ChangedOn>
    <Id>5</Id>
    <RegistrationDateTime>2026-05-26T21:11:33.8539944+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>
</ArrayOfMedicalHeartrateSummary>