GET PlanCare2Api/MedicalVaccination/{id}

Gets MedicalVaccination by id.

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

Request Information

URI Parameters

Name Description Type Additional information
id

The id of the MedicalVaccination.

integer

Required

Body Parameters

None.

Response Information

Resource Description

MedicalVaccination.

MedicalVaccination
Name Description Type Additional information
MedicalCodeProductCodeId

Id of MedicalCodeProductCode (MedicalCodeListType.VaccinationProductCode).

globally unique identifier

-

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

-

RelationId

Id of the relation which the registration belongs to.

integer

Required

RegistrationDateTime

DateTime of measurement.

date

Required

Source

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

string

-

Response Formats

application/json, text/json

Sample:
{
  "MedicalCodeProductCodeId": "9ef2a501-26be-4e5f-b46a-16072ca5ce34",
  "Dose": 2.0,
  "AdministeredBy": "sample string 3",
  "VaccinationDates": [
    {
      "$id": "2",
      "Id": 1,
      "VaccinationDate": "2026-05-26T21:12:09.4893421+02:00"
    },
    {
      "$ref": "2"
    }
  ],
  "ReVaccinationDate": "2026-05-26T21:12:09.4893421+02:00",
  "Remarks": "sample string 4",
  "Id": 5,
  "RelationId": 6,
  "RegistrationDateTime": "2026-05-26T21:12:09.4893421+02:00",
  "Source": "sample string 8"
}

application/xml, text/xml

Sample:
<MedicalVaccination xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Medical">
  <Id>5</Id>
  <RegistrationDateTime>2026-05-26T21:12:09.4893421+02:00</RegistrationDateTime>
  <RelationId>6</RelationId>
  <Source>sample string 8</Source>
  <AdministeredBy>sample string 3</AdministeredBy>
  <Dose>2</Dose>
  <MedicalCodeProductCodeId>9ef2a501-26be-4e5f-b46a-16072ca5ce34</MedicalCodeProductCodeId>
  <ReVaccinationDate>2026-05-26T21:12:09.4893421+02:00</ReVaccinationDate>
  <Remarks>sample string 4</Remarks>
  <VaccinationDates>
    <MedicalVaccinationDate>
      <Id>1</Id>
      <VaccinationDate>2026-05-26T21:12:09.4893421+02:00</VaccinationDate>
    </MedicalVaccinationDate>
    <MedicalVaccinationDate>
      <Id>1</Id>
      <VaccinationDate>2026-05-26T21:12:09.4893421+02:00</VaccinationDate>
    </MedicalVaccinationDate>
  </VaccinationDates>
</MedicalVaccination>