IPrimeSuiteAPI REST API Documentation


SchedulePatientAppointmentsGet


Method: POST

URI Template: https://api-test.greenwaymedical.com/Integration/RESTv1.0/PrimeSuiteAPIService/Scheduling/Appointment/SchedulePatientAppointmentsGet

Request Format: Xml or Json

Request XML Example (schema):

<?xml version="1.0" encoding="utf-16"?>
<PatientAppointmentsGetRequest>
  <PrimeSuitePatientID>0</PrimeSuitePatientID>
  <ExternalPatientID>0</ExternalPatientID>
  <InterfaceProviderID>0</InterfaceProviderID>
  <StartDateTime>0001-01-01T00:00:00</StartDateTime>
  <EndDateTime>0001-01-01T00:00:00</EndDateTime>
  <Header>
    <SourceSiteID>String Content</SourceSiteID>
    <DestinationSiteID>String Content</DestinationSiteID>
    <PrimeSuiteUserID>0</PrimeSuiteUserID>
  </Header>
  <Credentials>
    <PrimeSuiteCredential>
      <PrimeSuiteSiteId>String Content</PrimeSuiteSiteId>
      <PrimeSuiteUserName>String Content</PrimeSuiteUserName>
      <PrimeSuiteUserPassword>String Content</PrimeSuiteUserPassword>
      <PrimeSuiteUserAlias>String Content</PrimeSuiteUserAlias>
    </PrimeSuiteCredential>
    <VendorCredential>
      <VendorLogin>String Content</VendorLogin>
      <VendorPassword>String Content</VendorPassword>
    </VendorCredential>
  </Credentials>
</PatientAppointmentsGetRequest>

Request Json Example (schema):

{
  "PrimeSuitePatientID": 0,
  "ExternalPatientID": 0,
  "InterfaceProviderID": 0,
  "StartDateTime": "0001-01-01T00:00:00",
  "EndDateTime": "0001-01-01T00:00:00",
  "Header": {
    "SourceSiteID": "String Content",
    "DestinationSiteID": "String Content",
    "PrimeSuiteUserID": 0
  },
  "Credentials": {
    "PrimeSuiteCredential": {
      "PrimeSuiteSiteId": "String Content",
      "PrimeSuiteUserName": "String Content",
      "PrimeSuiteUserPassword": "String Content",
      "PrimeSuiteUserAlias": "String Content"
    },
    "VendorCredential": {
      "VendorLogin": "String Content",
      "VendorPassword": "String Content"
    }
  }
}

Response Format: Xml

Response XML Example (schema):

<?xml version="1.0" encoding="utf-16"?>
<PatientAppointmentsGetResponse>
  <Appointments>
    <AppointmentID>0</AppointmentID>
    <Category>
      <AppointmentCategoryID>0</AppointmentCategoryID>
      <AppointmentTypes>
        <Abbr>String Content</Abbr>
        <AltLabel>String Content</AltLabel>
        <AppointmentTypeID>0</AppointmentTypeID>
        <Duration>0</Duration>
        <Name>String Content</Name>
        <PatientInstructions>String Content</PatientInstructions>
        <ResourceCategories>
          <Name>String Content</Name>
          <ResourceCategoryID>0</ResourceCategoryID>
          <Resources>
            <AltLabel>String Content</AltLabel>
            <Description>String Content</Description>
            <Name>String Content</Name>
            <OverloadLimit>0</OverloadLimit>
            <OwnerCareProviderID>0</OwnerCareProviderID>
            <ResourceID>0</ResourceID>
            <PreferredDuration>0</PreferredDuration>
            <CareProviderName>String Content</CareProviderName>
          </Resources>
        </ResourceCategories>
      </AppointmentTypes>
      <Description>String Content</Description>
      <Name>String Content</Name>
    </Category>
    <Type>
      <Abbr>String Content</Abbr>
      <AltLabel>String Content</AltLabel>
      <AppointmentTypeID>0</AppointmentTypeID>
      <Duration>0</Duration>
      <Name>String Content</Name>
      <PatientInstructions>String Content</PatientInstructions>
      <ResourceCategories>
        <Name>String Content</Name>
        <ResourceCategoryID>0</ResourceCategoryID>
        <Resources>
          <AltLabel>String Content</AltLabel>
          <Description>String Content</Description>
          <Name>String Content</Name>
          <OverloadLimit>0</OverloadLimit>
          <OwnerCareProviderID>0</OwnerCareProviderID>
          <ResourceID>0</ResourceID>
          <PreferredDuration>0</PreferredDuration>
          <CareProviderName>String Content</CareProviderName>
        </Resources>
      </ResourceCategories>
    </Type>
    <Resource>
      <AltLabel>String Content</AltLabel>
      <Description>String Content</Description>
      <Name>String Content</Name>
      <OverloadLimit>0</OverloadLimit>
      <OwnerCareProviderID>0</OwnerCareProviderID>
      <ResourceID>0</ResourceID>
      <PreferredDuration>0</PreferredDuration>
      <CareProviderName>String Content</CareProviderName>
    </Resource>
    <ChiefComplaint>String Content</ChiefComplaint>
    <Comments>String Content</Comments>
    <EndTime>String Content</EndTime>
    <Patient>
      <PatientID>0</PatientID>
      <OtherID>String Content</OtherID>
      <PatientStatusID>0</PatientStatusID>
      <PatientAge>String Content</PatientAge>
      <PhotoPath>String Content</PhotoPath>
      <AccountBalanceCalcMethod>2</AccountBalanceCalcMethod>
      <AlternatePatientID>0</AlternatePatientID>
      <AssignmentOfBenifits>0</AssignmentOfBenifits>
      <CellPhoneNumber1>String Content</CellPhoneNumber1>
      <CellPhoneNumber2>String Content</CellPhoneNumber2>
      <Citizenship>0</Citizenship>
      <Credential>0</Credential>
      <CustomCredential>String Content</CustomCredential>
      <DateOfBirth>0001-01-01T00:00:00</DateOfBirth>
      <DateTimeOfBirth>String Content</DateTimeOfBirth>
      <Deceased>0</Deceased>
      <DeceasedDate>0001-01-01T00:00:00</DeceasedDate>
      <DoesPatientHaveResidentProof>false</DoesPatientHaveResidentProof>
      <DriversLicenseNumber>String Content</DriversLicenseNumber>
      <DriversLicenseState>0</DriversLicenseState>
      <EmailAddress1>String Content</EmailAddress1>
      <EmailAddress2>String Content</EmailAddress2>
      <Enabled>false</Enabled>
      <Ethnicity>0</Ethnicity>
      <SecondaryEthnicities>0</SecondaryEthnicities>
      <Firstname>String Content</Firstname>
      <FullName>String Content</FullName>
      <Gender>0</Gender>
      <GenderIdentity>0</GenderIdentity>
      <GenderIdentityDescription>String Content</GenderIdentityDescription>
      <SexualOrientation>0</SexualOrientation>
      <SexualOrientationDescription>String Content</SexualOrientationDescription>
      <IsFinancialRisk>false</IsFinancialRisk>
      <IsPatient>false</IsPatient>
      <LastName>String Content</LastName>
      <MaidenName>String Content</MaidenName>
      <MaritalStatus>0</MaritalStatus>
      <MiddleName1>String Content</MiddleName1>
      <MiddleName2>String Content</MiddleName2>
      <MothersMaidenName>String Content</MothersMaidenName>
      <Nickname>String Content</Nickname>
      <Notes>String Content</Notes>
      <NoteText>String Content</NoteText>
      <Occupation>String Content</Occupation>
      <OriginalPatientID>0</OriginalPatientID>
      <OriginalPatientIDString>String Content</OriginalPatientIDString>
      <PagerNumber>String Content</PagerNumber>
      <PreferredServiceLoc>String Content</PreferredServiceLoc>
      <PharmacyName>String Content</PharmacyName>
      <PharmacyNoteID>0</PharmacyNoteID>
      <PhoneNumber1>String Content</PhoneNumber1>
      <PhoneNumber2>String Content</PhoneNumber2>
      <PreferredCommunicationsID>0</PreferredCommunicationsID>
      <Prefix>0</Prefix>
      <PrimaryLanguage>0</PrimaryLanguage>
      <LanguageLookUpID>String Content</LanguageLookUpID>
      <PrimaryPhoneNumber>String Content</PrimaryPhoneNumber>
      <PrimaryPhysID>0</PrimaryPhysID>
      <PrimaryCareProvider>String Content</PrimaryCareProvider>
      <ReferringProvider>String Content</ReferringProvider>
      <PreferredProviderID>0</PreferredProviderID>
      <PreferredProvider>String Content</PreferredProvider>
      <PrimaryWorkPhone>String Content</PrimaryWorkPhone>
      <HomePhoneNumber>String Content</HomePhoneNumber>
      <Race>0</Race>
      <SecondaryRaces>0</SecondaryRaces>
      <ReleaseOfInformation>false</ReleaseOfInformation>
      <Religion>0</Religion>
      <SealedFlagID>0</SealedFlagID>
      <StudentStatusID>0</StudentStatusID>
      <SecondaryLanguage>0</SecondaryLanguage>
      <SSN>String Content</SSN>
      <Suffix>0</Suffix>
      <GuarantorID>0</GuarantorID>
      <LocalName>String Content</LocalName>
      <ResidentialAddress>
        <AddressID>0</AddressID>
        <Country>0</Country>
        <CountryName></CountryName>
        <AddressLine1>String Content</AddressLine1>
        <AddressLine2>String Content</AddressLine2>
        <City>String Content</City>
        <PostalCode>String Content</PostalCode>
        <State>0</State>
        <StateString></StateString>
        <County>String Content</County>
        <FaxNumber>String Content</FaxNumber>
        <PhoneNumber1>String Content</PhoneNumber1>
        <PhoneNumber2>String Content</PhoneNumber2>
      </ResidentialAddress>
      <PersonID>0</PersonID>
      <Picture>String Content</Picture>
      <PreferredServiceLocationID>0</PreferredServiceLocationID>
      <PreferredPharmacyID>0</PreferredPharmacyID>
      <PBMConsent>1</PBMConsent>
    </Patient>
    <ScheduleDate>String Content</ScheduleDate>
    <StartTime>String Content</StartTime>
    <Location>
      <Abbr>String Content</Abbr>
      <ResourceID>0</ResourceID>
      <ResourceCat>0</ResourceCat>
      <AppointmentType>0</AppointmentType>
      <AppointmentCat>0</AppointmentCat>
      <AppointmentCategories>
        <AppointmentCategoryID>0</AppointmentCategoryID>
        <AppointmentTypes>
          <Abbr>String Content</Abbr>
          <AltLabel>String Content</AltLabel>
          <AppointmentTypeID>0</AppointmentTypeID>
          <Duration>0</Duration>
          <Name>String Content</Name>
          <PatientInstructions>String Content</PatientInstructions>
          <ResourceCategories>
            <Name>String Content</Name>
            <ResourceCategoryID>0</ResourceCategoryID>
            <Resources>
              <AltLabel>String Content</AltLabel>
              <Description>String Content</Description>
              <Name>String Content</Name>
              <OverloadLimit>0</OverloadLimit>
              <OwnerCareProviderID>0</OwnerCareProviderID>
              <ResourceID>0</ResourceID>
              <PreferredDuration>0</PreferredDuration>
              <CareProviderName>String Content</CareProviderName>
            </Resources>
          </ResourceCategories>
        </AppointmentTypes>
        <Description>String Content</Description>
        <Name>String Content</Name>
      </AppointmentCategories>
      <LocationID>0</LocationID>
      <Name>String Content</Name>
      <Address>
        <AddressLine1>String Content</AddressLine1>
        <AddressLine2>String Content</AddressLine2>
        <City>String Content</City>
        <County>String Content</County>
        <State>String Content</State>
        <Country>String Content</Country>
        <PostalCode>String Content</PostalCode>
        <PhoneNumber1>String Content</PhoneNumber1>
        <PhoneNumber2>String Content</PhoneNumber2>
        <FaxNumber>String Content</FaxNumber>
      </Address>
    </Location>
    <Visit>
      <VisitID>0</VisitID>
      <VisitTypeID>0</VisitTypeID>
      <VisitTypeName>String Content</VisitTypeName>
      <CareProviderID>0</CareProviderID>
      <CareProviderName>String Content</CareProviderName>
      <ReferringProviderNPI>String Content</ReferringProviderNPI>
      <ReferringProviderID>0</ReferringProviderID>
      <ReferringProviderName>String Content</ReferringProviderName>
      <BillableCareProviderID>0</BillableCareProviderID>
      <BillableCareProviderNPI>String Content</BillableCareProviderNPI>
      <BillableCareProviderName>String Content</BillableCareProviderName>
      <FromDateTime>0001-01-01T00:00:00</FromDateTime>
      <ReleasedVisitInfoFlag>0</ReleasedVisitInfoFlag>
      <Quality>String Content</Quality>
      <PrimaryDiagnosis>String Content</PrimaryDiagnosis>
      <PatArrDateTime>String Content</PatArrDateTime>
      <PatientID>0</PatientID>
      <PatientArrivalFlag>String Content</PatientArrivalFlag>
      <PrimaryCareProviderID>0</PrimaryCareProviderID>
      <LastChangeUserID>0</LastChangeUserID>
      <CreateUserID>0</CreateUserID>
      <CreateDate>String Content</CreateDate>
      <ServiceLocationID>0</ServiceLocationID>
      <PracticeLocationID>0</PracticeLocationID>
      <ThroughDateTime>String Content</ThroughDateTime>
      <ChargeTicketID>0</ChargeTicketID>
      <sChargeTicketID>String Content</sChargeTicketID>
      <PrimaryComplaint>String Content</PrimaryComplaint>
      <VisitStatus>String Content</VisitStatus>
      <AccidentFlag>String Content</AccidentFlag>
      <AccidentState>String Content</AccidentState>
      <AccidentTypeID>0</AccidentTypeID>
      <DisabilityFromDate>String Content</DisabilityFromDate>
      <DisabilityToDate>String Content</DisabilityToDate>
      <HospitalAdmitDateTime>String Content</HospitalAdmitDateTime>
      <HospitalDischargeDateTime>String Content</HospitalDischargeDateTime>
      <FinanciallyResponsiblePartyID>0</FinanciallyResponsiblePartyID>
      <SimilarIllnessDate>String Content</SimilarIllnessDate>
      <SymptomDate>String Content</SymptomDate>
      <Comments>String Content</Comments>
      <SuperbillID>0</SuperbillID>
      <SuperBillStatus>String Content</SuperBillStatus>
      <ServiceDetail>
        <ServiceDetailDiagnosis>
          <SDDiagID>String Content</SDDiagID>
          <DiagnosisCode>String Content</DiagnosisCode>
          <DiagnosisPriority>String Content</DiagnosisPriority>
        </ServiceDetailDiagnosis>
        <ServiceDetailID>0</ServiceDetailID>
        <ChargeBatchID>0</ChargeBatchID>
        <ChargeAmount>String Content</ChargeAmount>
        <ChargeCreateDate>String Content</ChargeCreateDate>
        <ChargePostingDate>String Content</ChargePostingDate>
        <Diag1>String Content</Diag1>
        <Diag2>String Content</Diag2>
        <Diag3>String Content</Diag3>
        <Diag4>String Content</Diag4>
        <ICD10Diag1>String Content</ICD10Diag1>
        <ICD10Diag2>String Content</ICD10Diag2>
        <ICD10Diag3>String Content</ICD10Diag3>
        <ICD10Diag4>String Content</ICD10Diag4>
        <CoPayAmtApplied>String Content</CoPayAmtApplied>
        <ChargeType>String Content</ChargeType>
        <NonCoveredCharge>String Content</NonCoveredCharge>
        <RxNumber>String Content</RxNumber>
        <ProcedureAmount>String Content</ProcedureAmount>
        <BatchID>String Content</BatchID>
        <BalanceCalcMethod>String Content</BalanceCalcMethod>
        <BillableToPatient>false</BillableToPatient>
        <ProcedureCode>String Content</ProcedureCode>
        <TypeOfService>String Content</TypeOfService>
        <PlaceOfServiceID>String Content</PlaceOfServiceID>
        <ToDate>String Content</ToDate>
        <FromDate>String Content</FromDate>
        <NumberOfDaysOrUnits>String Content</NumberOfDaysOrUnits>
        <Charge>String Content</Charge>
        <PostingDate>String Content</PostingDate>
        <ReferringProviderID>0</ReferringProviderID>
        <RenderingProviderID>0</RenderingProviderID>
        <RenderingProviderNPI>String Content</RenderingProviderNPI>
        <PracticeLocationID>0</PracticeLocationID>
        <LocationID>0</LocationID>
        <NPI>String Content</NPI>
        <CareProviderID>0</CareProviderID>
        <ChargeID>0</ChargeID>
      </ServiceDetail>
      <CareProviderDirectEmailAddress>String Content</CareProviderDirectEmailAddress>
      <Documents>
        <ClinicalDocumentID>String Content</ClinicalDocumentID>
        <ClinicalDocumentName>String Content</ClinicalDocumentName>
        <ClinicalDocumentTypeID>String Content</ClinicalDocumentTypeID>
        <ClinicalDocumentType>String Content</ClinicalDocumentType>
        <ClinicalDocumentStatus>String Content</ClinicalDocumentStatus>
      </Documents>
      <IsCheckedOut>false</IsCheckedOut>
    </Visit>
    <Tracking>
      <TrackingID>0</TrackingID>
      <StatusID>0</StatusID>
      <AreaID>0</AreaID>
      <ResponsibleID>0</ResponsibleID>
      <Status>String Content</Status>
      <Area>String Content</Area>
      <Responsible>String Content</Responsible>
      <TimeIn>String Content</TimeIn>
      <TimeOut>String Content</TimeOut>
      <ChangedByTime>String Content</ChangedByTime>
      <TrackingUser>String Content</TrackingUser>
    </Tracking>
    <AppointmentTime>String Content</AppointmentTime>
    <RTC>String Content</RTC>
    <CopayPosted>String Content</CopayPosted>
    <Insurance>
      <PlanID>String Content</PlanID>
      <InsuranceID>String Content</InsuranceID>
      <InsuranceName>String Content</InsuranceName>
      <PlanName>String Content</PlanName>
      <InsDocVisitCoPay>0</InsDocVisitCoPay>
      <EffectiveFrom>String Content</EffectiveFrom>
      <EffectiveTo>String Content</EffectiveTo>
      <EligibilityStatus>String Content</EligibilityStatus>
      <CompanyName>String Content</CompanyName>
      <PlanNumber>String Content</PlanNumber>
      <Address>
        <AddressID>0</AddressID>
        <Country>0</Country>
        <CountryName></CountryName>
        <AddressLine1>String Content</AddressLine1>
        <AddressLine2>String Content</AddressLine2>
        <City>String Content</City>
        <PostalCode>String Content</PostalCode>
        <State>0</State>
        <StateString></StateString>
        <County>String Content</County>
        <FaxNumber>String Content</FaxNumber>
        <PhoneNumber1>String Content</PhoneNumber1>
        <PhoneNumber2>String Content</PhoneNumber2>
      </Address>
    </Insurance>
    <ChargesEntered>String Content</ChargesEntered>
    <Picture>false</Picture>
    <Options>0</Options>
  </Appointments>
</PatientAppointmentsGetResponse>

Response Format: Json

Response Example (schema):

Could not generate example for response. Failed with error: Specified cast is not valid.