POST PlanCare2Api/MedicalVaccination

Insert MedicalVaccination.

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

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

Request Information

URI Parameters

None.

Body Parameters

MedicalVaccination.

MedicalVaccination
NameDescriptionTypeAdditional information
MedicalCodeProductCodeId

Id of MedicalCodeProductCode (MedicalCodeListType.VaccinationProductCode).

globally unique identifier

None.

Dose

Dose in milliliters.

decimal number

None.

AdministeredBy

AdministeredBy.

string

None.

VaccinationDates

VaccinationDates.

Collection of MedicalVaccinationDate

None.

ReVaccinationDate

ReVaccinationDate.

date

None.

Remarks

Remarks.

string

None.

Id

Id of the registration.

integer

None.

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

None.

Request Formats

application/json, text/json

Sample:
{
  "MedicalCodeProductCodeId": "52f63f15-3d3a-4841-828f-54ccb277f4c3",
  "Dose": 2.0,
  "AdministeredBy": "sample string 3",
  "VaccinationDates": [
    {
      "$id": "2",
      "Id": 1,
      "VaccinationDate": "2026-05-26T22:10:21.3884626+02:00"
    },
    {
      "$ref": "2"
    }
  ],
  "ReVaccinationDate": "2026-05-26T22:10:21.3884626+02:00",
  "Remarks": "sample string 4",
  "Id": 5,
  "RelationId": 6,
  "RegistrationDateTime": "2026-05-26T22:10:21.3884626+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-26T22:10:21.3884626+02:00</RegistrationDateTime>
  <RelationId>6</RelationId>
  <Source>sample string 8</Source>
  <AdministeredBy>sample string 3</AdministeredBy>
  <Dose>2</Dose>
  <MedicalCodeProductCodeId>52f63f15-3d3a-4841-828f-54ccb277f4c3</MedicalCodeProductCodeId>
  <ReVaccinationDate>2026-05-26T22:10:21.3884626+02:00</ReVaccinationDate>
  <Remarks>sample string 4</Remarks>
  <VaccinationDates>
    <MedicalVaccinationDate>
      <Id>1</Id>
      <VaccinationDate>2026-05-26T22:10:21.3884626+02:00</VaccinationDate>
    </MedicalVaccinationDate>
    <MedicalVaccinationDate>
      <Id>1</Id>
      <VaccinationDate>2026-05-26T22:10:21.3884626+02:00</VaccinationDate>
    </MedicalVaccinationDate>
  </VaccinationDates>
</MedicalVaccination>

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.