POST api/Schedule/ScheduleAppointment

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Patient	PatientData	None.
DepartmentID	string	None.
DepartmentIDType	string	None.
ProviderID	string	None.
ProviderIDType	string	None.
VisitTypeID	string	None.
VisitTypeIDType	string	None.
Date	string	None.
Time	string	None.
Comments	Collection of string	None.
IsReviewOnly	boolean	None.
Insurance	SchedulingInsurance	None.

Request Formats

application/json, text/json

Sample:

{
  "Patient": {
    "PatientID": "sample string 1",
    "PatientIDType": "sample string 2",
    "FirstName": "sample string 3",
    "LastName": "sample string 4",
    "DepartmentID": "sample string 5",
    "DepartmentIDType": "sample string 6",
    "SSN": "sample string 7",
    "DOB": "sample string 8",
    "Gender": "sample string 9",
    "Email": "sample string 10",
    "CellNumber": "sample string 11",
    "HouseNumber": "sample string 12",
    "Street": "sample string 13",
    "City": "sample string 14",
    "State": "sample string 15",
    "Zip": "sample string 16",
    "PcpIDs": [
      "sample string 1",
      "sample string 2"
    ]
  },
  "DepartmentID": "sample string 1",
  "DepartmentIDType": "sample string 2",
  "ProviderID": "sample string 3",
  "ProviderIDType": "sample string 4",
  "VisitTypeID": "sample string 5",
  "VisitTypeIDType": "sample string 6",
  "Date": "sample string 7",
  "Time": "sample string 8",
  "Comments": [
    "sample string 1",
    "sample string 2"
  ],
  "IsReviewOnly": true,
  "Insurance": {
    "InsuranceName": "sample string 1",
    "MemberNumber": "sample string 2",
    "GroupNumber": "sample string 3",
    "SubscriberID": "sample string 4",
    "SubscriberName": "sample string 5",
    "SubscriberDOB": "sample string 6"
  }
}

application/xml, text/xml

Sample:

<SchedulingRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EpicCnx.Models">
  <Comments xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Comments>
  <Date>sample string 7</Date>
  <DepartmentID>sample string 1</DepartmentID>
  <DepartmentIDType>sample string 2</DepartmentIDType>
  <Insurance>
    <GroupNumber>sample string 3</GroupNumber>
    <InsuranceName>sample string 1</InsuranceName>
    <MemberNumber>sample string 2</MemberNumber>
    <SubscriberDOB>sample string 6</SubscriberDOB>
    <SubscriberID>sample string 4</SubscriberID>
    <SubscriberName>sample string 5</SubscriberName>
  </Insurance>
  <IsReviewOnly>true</IsReviewOnly>
  <Patient>
    <CellNumber>sample string 11</CellNumber>
    <City>sample string 14</City>
    <DOB>sample string 8</DOB>
    <DepartmentID>sample string 5</DepartmentID>
    <DepartmentIDType>sample string 6</DepartmentIDType>
    <Email>sample string 10</Email>
    <FirstName>sample string 3</FirstName>
    <Gender>sample string 9</Gender>
    <HouseNumber>sample string 12</HouseNumber>
    <LastName>sample string 4</LastName>
    <PatientID>sample string 1</PatientID>
    <PatientIDType>sample string 2</PatientIDType>
    <PcpIDs xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </PcpIDs>
    <SSN>sample string 7</SSN>
    <State>sample string 15</State>
    <Street>sample string 13</Street>
    <Zip>sample string 16</Zip>
  </Patient>
  <ProviderID>sample string 3</ProviderID>
  <ProviderIDType>sample string 4</ProviderIDType>
  <Time>sample string 8</Time>
  <VisitTypeID>sample string 5</VisitTypeID>
  <VisitTypeIDType>sample string 6</VisitTypeIDType>
</SchedulingRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AppointmentDetails

Name	Type	Additional information
ProviderName	string	None.
Specialty	string	None.
LocationName	string	None.
StreetAddress	string	None.
City	string	None.
State	string	None.
Zip	string	None.
Phone	string	None.
LocationInstructions	string	None.
ApptDate	string	None.
ApptTime	string	None.
ApptDuration	string	None.
PatientName	string	None.
PatientInstructions	string	None.
Error	string	None.

Response Formats

application/json, text/json

Sample:

{
  "ProviderName": "sample string 1",
  "Specialty": "sample string 2",
  "LocationName": "sample string 3",
  "StreetAddress": "sample string 4",
  "City": "sample string 5",
  "State": "sample string 6",
  "Zip": "sample string 7",
  "Phone": "sample string 8",
  "LocationInstructions": "sample string 9",
  "ApptDate": "sample string 10",
  "ApptTime": "sample string 11",
  "ApptDuration": "sample string 12",
  "PatientName": "sample string 13",
  "PatientInstructions": "sample string 14",
  "Error": "sample string 15"
}

application/xml, text/xml

Sample:

<AppointmentDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EpicCnx.Models">
  <ApptDate>sample string 10</ApptDate>
  <ApptDuration>sample string 12</ApptDuration>
  <ApptTime>sample string 11</ApptTime>
  <City>sample string 5</City>
  <Error>sample string 15</Error>
  <LocationInstructions>sample string 9</LocationInstructions>
  <LocationName>sample string 3</LocationName>
  <PatientInstructions>sample string 14</PatientInstructions>
  <PatientName>sample string 13</PatientName>
  <Phone>sample string 8</Phone>
  <ProviderName>sample string 1</ProviderName>
  <Specialty>sample string 2</Specialty>
  <State>sample string 6</State>
  <StreetAddress>sample string 4</StreetAddress>
  <Zip>sample string 7</Zip>
</AppointmentDetails>