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

Gets list of MedicalMenstruationSummary of the specified relation.

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

Requires 'Read' permission for function MedicalMenstruation {CBFB685F-5829-4F51-AE15-1CDEA5780052}

Request Information

URI Parameters

NameDescriptionTypeAdditional 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 MedicalMenstruationSummary.

Collection of MedicalMenstruationSummary
NameDescriptionTypeAdditional information
BloodLoss

BloodLoss.

string

None.

Duration

Duration.

string

None.

Mood

Mood.

string

None.

Stressed

Stressed.

boolean

None.

Complaints

List of complaints.

Collection of 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 (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:
[
  {
    "$id": "1",
    "BloodLoss": "sample string 1",
    "Duration": "sample string 2",
    "Mood": "sample string 3",
    "Stressed": true,
    "Complaints": [
      "sample string 1",
      "sample string 2"
    ],
    "Remarks": "sample string 5",
    "Id": 6,
    "RegistrationDateTime": "2026-05-26T21:12:11.773661+02:00",
    "Source": "sample string 8",
    "ChangedOn": "2026-05-26T21:12:11.773661+02:00",
    "ChangedByRelationLookupName": "sample string 10",
    "TextValue": "sample string 11"
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:
<ArrayOfMedicalMenstruationSummary xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Medical">
  <MedicalMenstruationSummary>
    <ChangedByRelationLookupName>sample string 10</ChangedByRelationLookupName>
    <ChangedOn>2026-05-26T21:12:11.773661+02:00</ChangedOn>
    <Id>6</Id>
    <RegistrationDateTime>2026-05-26T21:12:11.773661+02:00</RegistrationDateTime>
    <Source>sample string 8</Source>
    <TextValue>sample string 11</TextValue>
    <BloodLoss>sample string 1</BloodLoss>
    <Complaints xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Complaints>
    <Duration>sample string 2</Duration>
    <Mood>sample string 3</Mood>
    <Remarks>sample string 5</Remarks>
    <Stressed>true</Stressed>
  </MedicalMenstruationSummary>
  <MedicalMenstruationSummary>
    <ChangedByRelationLookupName>sample string 10</ChangedByRelationLookupName>
    <ChangedOn>2026-05-26T21:12:11.773661+02:00</ChangedOn>
    <Id>6</Id>
    <RegistrationDateTime>2026-05-26T21:12:11.773661+02:00</RegistrationDateTime>
    <Source>sample string 8</Source>
    <TextValue>sample string 11</TextValue>
    <BloodLoss>sample string 1</BloodLoss>
    <Complaints xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Complaints>
    <Duration>sample string 2</Duration>
    <Mood>sample string 3</Mood>
    <Remarks>sample string 5</Remarks>
    <Stressed>true</Stressed>
  </MedicalMenstruationSummary>
</ArrayOfMedicalMenstruationSummary>