POST api/clinicians/{clinicianId}

Request Information

URI Parameters

Name	Description	Type	Additional information
clinicianId		integer	Required

Body Parameters

AddEditClinicianRequest

Name	Type	Additional information
Prefix	string	String length: inclusive between 0 and 10
FirstName	string	Required
MiddleName	string	String length: inclusive between 0 and 35
LastName	string	Required
Suffix	string	String length: inclusive between 0 and 10
DateOfBirth	date	Required
Email	string	None.
Address1	string	Required String length: inclusive between 0 and 35
Address2	string	String length: inclusive between 0 and 35
City	string	Required
State	string	Required
ZipCode	string	Required
PrimaryPhone	string	Required
PrimaryPhoneType	PhoneTypes	None.
PrimaryFax	string	Required String length: inclusive between 0 and 25
PhoneAdditional1	string	String length: inclusive between 0 and 25
PhoneAdditionalType1	PhoneTypes	None.
PhoneAdditional2	string	String length: inclusive between 0 and 25
PhoneAdditionalType2	PhoneTypes	None.
PhoneAdditional3	string	String length: inclusive between 0 and 25
PhoneAdditionalType3	PhoneTypes	None.
DEANumber	string	Matching regular expression pattern: ^[A-Z][A-Z9][0-9]{7}(-[A-Z0-9]{1,7})?$
DEANumbers	Collection of DeaNumber	None.
NADEANumbers	Collection of NaDeaNumber	None.
MedicalLicenseNumbers	Collection of MedicalLicenseNumber	None.
NPINumber	string	None.
ClinicianRoleType	Collection of ClinicianRoleType	Required
EPCSRequested	boolean	None.
Active	boolean	None.
PDMPRoleType	PDMPRoleType	None.
ClinicianSpecialtyType	ClinicianSpecialtyType	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-17T07:34:33.0031649+00:00",
  "Email": "sample string 7",
  "Address1": "sample string 8",
  "Address2": "sample string 9",
  "City": "sample string 10",
  "State": "sample string 11",
  "ZipCode": "sample string 12",
  "PrimaryPhone": "sample string 13",
  "PrimaryPhoneType": 0,
  "PrimaryFax": "sample string 14",
  "PhoneAdditional1": "sample string 15",
  "PhoneAdditionalType1": 0,
  "PhoneAdditional2": "sample string 16",
  "PhoneAdditionalType2": 0,
  "PhoneAdditional3": "sample string 17",
  "PhoneAdditionalType3": 0,
  "DEANumber": "sample string 18",
  "DEANumbers": [
    {
      "DEANumber": "sample string 1",
      "State": "sample string 2",
      "ClinicId": "sample string 3"
    },
    {
      "DEANumber": "sample string 1",
      "State": "sample string 2",
      "ClinicId": "sample string 3"
    }
  ],
  "NADEANumbers": [
    {
      "NADEANumber": "sample string 1",
      "State": "sample string 2",
      "ClinicId": "sample string 3"
    },
    {
      "NADEANumber": "sample string 1",
      "State": "sample string 2",
      "ClinicId": "sample string 3"
    }
  ],
  "MedicalLicenseNumbers": [
    {
      "LicenseNumber": "sample string 1",
      "State": "sample string 2",
      "ClinicId": "sample string 3"
    },
    {
      "LicenseNumber": "sample string 1",
      "State": "sample string 2",
      "ClinicId": "sample string 3"
    }
  ],
  "NPINumber": "sample string 19",
  "ClinicianRoleType": [
    1,
    1
  ],
  "EPCSRequested": true,
  "Active": true,
  "PDMPRoleType": 1,
  "ClinicianSpecialtyType": 1
}

application/xml, text/xml

Sample:

<AddEditClinicianRequest 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>
  <ClinicianId>1</ClinicianId>
  <ClinicianRoleType>
    <ClinicianRoleType>PrescribingClinician</ClinicianRoleType>
    <ClinicianRoleType>PrescribingClinician</ClinicianRoleType>
  </ClinicianRoleType>
  <ClinicianSpecialtyType>AllergyAndImmunology</ClinicianSpecialtyType>
  <DEANumber>sample string 18</DEANumber>
  <DEANumbers xmlns:d2p1="http://schemas.datacontract.org/2004/07/DoseSpot.UI.API.DataContracts._13.Objects">
    <d2p1:DeaNumber>
      <d2p1:ClinicId>sample string 3</d2p1:ClinicId>
      <d2p1:DEANumber>sample string 1</d2p1:DEANumber>
      <d2p1:State>sample string 2</d2p1:State>
    </d2p1:DeaNumber>
    <d2p1:DeaNumber>
      <d2p1:ClinicId>sample string 3</d2p1:ClinicId>
      <d2p1:DEANumber>sample string 1</d2p1:DEANumber>
      <d2p1:State>sample string 2</d2p1:State>
    </d2p1:DeaNumber>
  </DEANumbers>
  <DateOfBirth>2024-05-17T07:34:33.0031649+00:00</DateOfBirth>
  <EPCSRequested>true</EPCSRequested>
  <Email>sample string 7</Email>
  <FirstName>sample string 2</FirstName>
  <LastName>sample string 4</LastName>
  <MedicalLicenseNumbers xmlns:d2p1="http://schemas.datacontract.org/2004/07/DoseSpot.UI.API.DataContracts._13.Objects">
    <d2p1:MedicalLicenseNumber>
      <d2p1:ClinicId>sample string 3</d2p1:ClinicId>
      <d2p1:LicenseNumber>sample string 1</d2p1:LicenseNumber>
      <d2p1:State>sample string 2</d2p1:State>
    </d2p1:MedicalLicenseNumber>
    <d2p1:MedicalLicenseNumber>
      <d2p1:ClinicId>sample string 3</d2p1:ClinicId>
      <d2p1:LicenseNumber>sample string 1</d2p1:LicenseNumber>
      <d2p1:State>sample string 2</d2p1:State>
    </d2p1:MedicalLicenseNumber>
  </MedicalLicenseNumbers>
  <MiddleName>sample string 3</MiddleName>
  <NADEANumbers xmlns:d2p1="http://schemas.datacontract.org/2004/07/DoseSpot.UI.API.DataContracts._13.Objects">
    <d2p1:NaDeaNumber>
      <d2p1:ClinicId>sample string 3</d2p1:ClinicId>
      <d2p1:NADEANumber>sample string 1</d2p1:NADEANumber>
      <d2p1:State>sample string 2</d2p1:State>
    </d2p1:NaDeaNumber>
    <d2p1:NaDeaNumber>
      <d2p1:ClinicId>sample string 3</d2p1:ClinicId>
      <d2p1:NADEANumber>sample string 1</d2p1:NADEANumber>
      <d2p1:State>sample string 2</d2p1:State>
    </d2p1:NaDeaNumber>
  </NADEANumbers>
  <NPINumber>sample string 19</NPINumber>
  <PDMPRoleType>Physician</PDMPRoleType>
  <PhoneAdditional1>sample string 15</PhoneAdditional1>
  <PhoneAdditional2>sample string 16</PhoneAdditional2>
  <PhoneAdditional3>sample string 17</PhoneAdditional3>
  <PhoneAdditionalType1>Undefined</PhoneAdditionalType1>
  <PhoneAdditionalType2>Undefined</PhoneAdditionalType2>
  <PhoneAdditionalType3>Undefined</PhoneAdditionalType3>
  <Prefix>sample string 1</Prefix>
  <PrimaryFax>sample string 14</PrimaryFax>
  <PrimaryPhone>sample string 13</PrimaryPhone>
  <PrimaryPhoneType>Undefined</PrimaryPhoneType>
  <State>sample string 11</State>
  <Suffix>sample string 5</Suffix>
  <ZipCode>sample string 12</ZipCode>
</AddEditClinicianRequest>

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>