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

Gets list of MedicalVaccinationSummary of the specified relation.

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

Requires 'Read' permission for function MedicalVaccination {D0D9C9C6-5EA5-45CB-8AC2-24D6EEF784CF}

Request Information

URI Parameters

Name	Description	Type	Additional information
relationId	The id of the relation.	integer	Required
registrationDateTimeFrom	RegistrationDateTime filter from.	date	Nullable
registrationDateTimeUntil	RegistrationDateTime filter until.	date	Nullable

Body Parameters

None.

Response Information

Resource Description

List of MedicalVaccinationSummary.

Collection of MedicalVaccinationSummary

Name	Description	Type	Additional information
MedicalCodeProductCodeDescription	ProductCode.	string	-
Dose	Dose in milliliters.	decimal number	-
AdministeredBy	AdministeredBy.	string	-
VaccinationDates	VaccinationDates.	Collection of MedicalVaccinationDate	-
ReVaccinationDate	ReVaccinationDate.	date	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:

[
  {
    "$id": "1",
    "MedicalCodeProductCodeDescription": "sample string 1",
    "Dose": 2.0,
    "AdministeredBy": "sample string 3",
    "VaccinationDates": [
      {
        "$id": "2",
        "Id": 1,
        "VaccinationDate": "2026-05-26T23:13:14.0563517+02:00"
      },
      {
        "$ref": "2"
      }
    ],
    "ReVaccinationDate": "2026-05-26T23:13:14.0563517+02:00",
    "Remarks": "sample string 4",
    "Id": 5,
    "RegistrationDateTime": "2026-05-26T23:13:14.0563517+02:00",
    "Source": "sample string 7",
    "ChangedOn": "2026-05-26T23:13:14.0563517+02:00",
    "ChangedByRelationLookupName": "sample string 9",
    "TextValue": "sample string 10"
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:

<ArrayOfMedicalVaccinationSummary xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Medical">
  <MedicalVaccinationSummary>
    <ChangedByRelationLookupName>sample string 9</ChangedByRelationLookupName>
    <ChangedOn>2026-05-26T23:13:14.0563517+02:00</ChangedOn>
    <Id>5</Id>
    <RegistrationDateTime>2026-05-26T23:13:14.0563517+02:00</RegistrationDateTime>
    <Source>sample string 7</Source>
    <TextValue>sample string 10</TextValue>
    <AdministeredBy>sample string 3</AdministeredBy>
    <Dose>2</Dose>
    <MedicalCodeProductCodeDescription>sample string 1</MedicalCodeProductCodeDescription>
    <ReVaccinationDate>2026-05-26T23:13:14.0563517+02:00</ReVaccinationDate>
    <Remarks>sample string 4</Remarks>
    <VaccinationDates>
      <MedicalVaccinationDate>
        <Id>1</Id>
        <VaccinationDate>2026-05-26T23:13:14.0563517+02:00</VaccinationDate>
      </MedicalVaccinationDate>
      <MedicalVaccinationDate>
        <Id>1</Id>
        <VaccinationDate>2026-05-26T23:13:14.0563517+02:00</VaccinationDate>
      </MedicalVaccinationDate>
    </VaccinationDates>
  </MedicalVaccinationSummary>
  <MedicalVaccinationSummary>
    <ChangedByRelationLookupName>sample string 9</ChangedByRelationLookupName>
    <ChangedOn>2026-05-26T23:13:14.0563517+02:00</ChangedOn>
    <Id>5</Id>
    <RegistrationDateTime>2026-05-26T23:13:14.0563517+02:00</RegistrationDateTime>
    <Source>sample string 7</Source>
    <TextValue>sample string 10</TextValue>
    <AdministeredBy>sample string 3</AdministeredBy>
    <Dose>2</Dose>
    <MedicalCodeProductCodeDescription>sample string 1</MedicalCodeProductCodeDescription>
    <ReVaccinationDate>2026-05-26T23:13:14.0563517+02:00</ReVaccinationDate>
    <Remarks>sample string 4</Remarks>
    <VaccinationDates>
      <MedicalVaccinationDate>
        <Id>1</Id>
        <VaccinationDate>2026-05-26T23:13:14.0563517+02:00</VaccinationDate>
      </MedicalVaccinationDate>
      <MedicalVaccinationDate>
        <Id>1</Id>
        <VaccinationDate>2026-05-26T23:13:14.0563517+02:00</VaccinationDate>
      </MedicalVaccinationDate>
    </VaccinationDates>
  </MedicalVaccinationSummary>
</ArrayOfMedicalVaccinationSummary>