IPrimeSuiteAPI REST API Documentation


VisitDetailsGet


Method: POST

URI Template: https://api-test.greenwaymedical.com/Integration/RESTv1.0/PrimeSuiteAPIService/VisitDetailsGet

Request Format: Xml or Json

Request XML Example (schema):

<?xml version="1.0" encoding="utf-16"?>
<VisitDetailsGetRequest>
  <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>
  <VisitID>0</VisitID>
</VisitDetailsGetRequest>

Request Json Example (schema):

{
  "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"
    }
  },
  "VisitID": 0
}

Response Format: Xml

Response XML Example (schema):

<?xml version="1.0" encoding="utf-16"?>
<VisitDetailsGetResponse>
  <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>
  <CustomFields>
    <FieldID>0</FieldID>
    <FieldLabel>String Content</FieldLabel>
    <FieldValue>String Content</FieldValue>
    <Description>String Content</Description>
    <FieldType>String Content</FieldType>
    <FieldEnabled>false</FieldEnabled>
  </CustomFields>
</VisitDetailsGetResponse>

Response Format: Json

Response Example (schema):

{
  "Visit": {
    "VisitID": 0,
    "VisitTypeID": 0,
    "VisitTypeName": "String Content",
    "CareProviderID": 0,
    "CareProviderName": "String Content",
    "ReferringProviderNPI": "String Content",
    "ReferringProviderID": 0,
    "ReferringProviderName": "String Content",
    "BillableCareProviderID": 0,
    "BillableCareProviderNPI": "String Content",
    "BillableCareProviderName": "String Content",
    "FromDateTime": "0001-01-01T00:00:00",
    "ReleasedVisitInfoFlag": 0,
    "Quality": "String Content",
    "PrimaryDiagnosis": "String Content",
    "PatArrDateTime": "String Content",
    "PatientID": 0,
    "PatientArrivalFlag": "String Content",
    "PrimaryCareProviderID": 0,
    "LastChangeUserID": 0,
    "CreateUserID": 0,
    "CreateDate": "String Content",
    "ServiceLocationID": 0,
    "PracticeLocationID": 0,
    "ThroughDateTime": "String Content",
    "ChargeTicketID": 0,
    "sChargeTicketID": "String Content",
    "PrimaryComplaint": "String Content",
    "VisitStatus": "String Content",
    "AccidentFlag": "String Content",
    "AccidentState": "String Content",
    "AccidentTypeID": 0,
    "DisabilityFromDate": "String Content",
    "DisabilityToDate": "String Content",
    "HospitalAdmitDateTime": "String Content",
    "HospitalDischargeDateTime": "String Content",
    "FinanciallyResponsiblePartyID": 0,
    "SimilarIllnessDate": "String Content",
    "SymptomDate": "String Content",
    "Comments": "String Content",
    "SuperbillID": 0,
    "SuperBillStatus": "String Content",
    "ServiceDetail": [
      {
        "ServiceDetailDiagnosis": [
          {
            "SDDiagID": "String Content",
            "DiagnosisCode": "String Content",
            "DiagnosisPriority": "String Content"
          }
        ],
        "ServiceDetailID": 0,
        "ChargeBatchID": 0,
        "ChargeAmount": "String Content",
        "ChargeCreateDate": "String Content",
        "ChargePostingDate": "String Content",
        "Diag1": "String Content",
        "Diag2": "String Content",
        "Diag3": "String Content",
        "Diag4": "String Content",
        "ICD10Diag1": "String Content",
        "ICD10Diag2": "String Content",
        "ICD10Diag3": "String Content",
        "ICD10Diag4": "String Content",
        "CoPayAmtApplied": "String Content",
        "ChargeType": "String Content",
        "NonCoveredCharge": "String Content",
        "RxNumber": "String Content",
        "ProcedureAmount": "String Content",
        "BatchID": "String Content",
        "BalanceCalcMethod": "String Content",
        "BillableToPatient": false,
        "ProcedureCode": "String Content",
        "TypeOfService": "String Content",
        "PlaceOfServiceID": "String Content",
        "ToDate": "String Content",
        "FromDate": "String Content",
        "NumberOfDaysOrUnits": "String Content",
        "Charge": "String Content",
        "PostingDate": "String Content",
        "ReferringProviderID": 0,
        "RenderingProviderID": 0,
        "RenderingProviderNPI": "String Content",
        "PracticeLocationID": 0,
        "LocationID": 0,
        "NPI": "String Content",
        "CareProviderID": 0,
        "ChargeID": 0
      }
    ],
    "CareProviderDirectEmailAddress": "String Content",
    "Documents": [
      {
        "ClinicalDocumentID": "String Content",
        "ClinicalDocumentName": "String Content",
        "ClinicalDocumentTypeID": "String Content",
        "ClinicalDocumentType": "String Content",
        "ClinicalDocumentStatus": "String Content"
      }
    ],
    "IsCheckedOut": false
  },
  "CustomFields": [
    {
      "FieldID": 0,
      "FieldLabel": "String Content",
      "FieldValue": "String Content",
      "Description": "String Content",
      "FieldType": "String Content",
      "FieldEnabled": false
    }
  ]
}