POST api/patients/{patientId}

Request Information

URI Parameters

Name	Description	Type	Additional information
patientId		integer	Required

Body Parameters

AddEditPatientRequest

Name	Type	Additional information
Prefix	string	String length: inclusive between 0 and 10
FirstName	string	Required String length: inclusive between 0 and 35
MiddleName	string	String length: inclusive between 0 and 35
LastName	string	Required String length: inclusive between 0 and 35
Suffix	string	String length: inclusive between 0 and 10
DateOfBirth	date	Required
Gender	GenderType	Required
Email	string	String length: inclusive between 0 and 80
Address1	string	Required String length: inclusive between 0 and 35
Address2	string	String length: inclusive between 0 and 35
City	string	Required String length: inclusive between 0 and 35
State	string	Required String length: inclusive between 0 and 50
ZipCode	string	Required String length: inclusive between 0 and 10
PhoneAdditional1	string	String length: inclusive between 0 and 25
PhoneAdditional2	string	String length: inclusive between 0 and 25
PhoneAdditionalType1	PhoneTypes	None.
PhoneAdditionalType2	PhoneTypes	None.
PrimaryPhone	string	Required String length: inclusive between 0 and 25
PrimaryPhoneType	PhoneTypes	Required
Weight	decimal number	None.
WeightMetric	WeightUnitItem	None.
Height	decimal number	None.
HeightMetric	HeightUnitItem	None.
NonDoseSpotMedicalRecordNumber	string	String length: inclusive between 0 and 35
Active	boolean	Required
Encounter	string	String length: inclusive between 0 and 50
IsHospice	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "Prefix": "sample string 1",
  "FirstName": "sample string 2",
  "MiddleName": "sample string 3",
  "LastName": "sample string 4",
  "Suffix": "sample string 5",
  "DateOfBirth": "2024-05-16T05:26:39.4649487+00:00",
  "Gender": 1,
  "Email": "sample string 7",
  "Address1": "sample string 8",
  "Address2": "sample string 9",
  "City": "sample string 10",
  "State": "sample string 11",
  "ZipCode": "sample string 12",
  "PhoneAdditional1": "sample string 13",
  "PhoneAdditional2": "sample string 14",
  "PhoneAdditionalType1": 0,
  "PhoneAdditionalType2": 0,
  "PrimaryPhone": "sample string 15",
  "PrimaryPhoneType": 0,
  "Weight": 1.1,
  "WeightMetric": 1,
  "Height": 1.1,
  "HeightMetric": 1,
  "NonDoseSpotMedicalRecordNumber": "sample string 16",
  "Active": true,
  "Encounter": "sample string 17",
  "IsHospice": true
}

application/xml, text/xml

Sample:

<AddEditPatientRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DoseSpot.UI.API.DataContracts._13">
  <Active>true</Active>
  <Address1>sample string 8</Address1>
  <Address2>sample string 9</Address2>
  <City>sample string 10</City>
  <DateOfBirth>2024-05-16T05:26:39.4649487+00:00</DateOfBirth>
  <Email>sample string 7</Email>
  <Encounter>sample string 17</Encounter>
  <FirstName>sample string 2</FirstName>
  <Gender>Male</Gender>
  <Height>1.1</Height>
  <HeightMetric>inch</HeightMetric>
  <IsHospice>true</IsHospice>
  <LastName>sample string 4</LastName>
  <MiddleName>sample string 3</MiddleName>
  <NonDoseSpotMedicalRecordNumber>sample string 16</NonDoseSpotMedicalRecordNumber>
  <PatientId>1</PatientId>
  <PhoneAdditional1>sample string 13</PhoneAdditional1>
  <PhoneAdditional2>sample string 14</PhoneAdditional2>
  <PhoneAdditionalType1>Undefined</PhoneAdditionalType1>
  <PhoneAdditionalType2>Undefined</PhoneAdditionalType2>
  <Prefix>sample string 1</Prefix>
  <PrimaryPhone>sample string 15</PrimaryPhone>
  <PrimaryPhoneType>Undefined</PrimaryPhoneType>
  <State>sample string 11</State>
  <Suffix>sample string 5</Suffix>
  <Weight>1.1</Weight>
  <WeightMetric>lb</WeightMetric>
  <ZipCode>sample string 12</ZipCode>
</AddEditPatientRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IdentifierResponse

Name	Description	Type	Additional information
Id		integer	None.
Result		Result	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "Result": {
    "ResultCode": "sample string 1",
    "ResultDescription": "sample string 2"
  }
}

application/xml, text/xml

Sample:

<IdentifierResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DoseSpot.UI.API.DataContracts._13">
  <Result>
    <ResultCode>sample string 1</ResultCode>
    <ResultDescription>sample string 2</ResultDescription>
  </Result>
  <Id>1</Id>
</IdentifierResponse>