NAV Navbar
  • Introduction
  • Getting Started
  • Patients
  • Facilities
  • Products
  • Procedures
  • Services
  • Providers
  • Packages
  • Bills
  • Appointments
  • Introduction

    The Nextech Practice+ APIs provide secure access to patient data through a RESTful implementation. Currently, the APIs are based on an internal standard.

    Available API functionality:

    Before you can start using our APIs, you must go through our registration process. If you're interested in API access for your practice, please contact us here. Otherwise, if you've been provided with credentials to authenticate, then continue to the Getting Started section for more information.

    Getting Started

    All API requests are performed over HTTPS. Although the FHIR® standard supports both JSON and XML, this API currently only supports JSON. Therefore any type explicitly defined in the request's Accept header will be ignored.

    Before you can access the Nextech API you must have the proper credentials to authenticate. These credentials will be provided to you by your Nextech representative.

    API Endpoint
    https://pmplus.nextech-api.com/api

    Patients

    GET /v1.0/{practiceId}/patients

    Returns all patients created within the date range

    Path Parameters

    practiceId string

    Headers

    Authorization string

    Query String

    beginCreatedDate string
    endCreatedDate string

    Responses

    200 OK
                                
    {
        "PatientId": 0,
        "FirstName": "string",
        "LastName": "string",
        "Gender": "string",
        "Birthdate": "2018-08-15T15:10:09.756Z",
        "Address1": "string",
        "Address2": "string",
        "City": "string",
        "State": "string",
        "Zip": "string",
        "Province": "string",
        "Country": "string",
        "HomePhone": "string",
        "MobilePhone": "string",
        "WorkPhone": "string",
        "Email": "string",
        "CreatedDate": "2018-08-15T15:10:09.756Z"
    }
                                
                            

    GET /v1.0/{practiceId}/patients/{id}

    Returns patient by id

    Path Parameters

    practiceId string
    id integer

    Headers

    Authorization string

    Responses

    200 OK
                                
        {
            "PatientId": 0,
            "FirstName": "string",
            "LastName": "string",
            "Gender": "string",
            "Birthdate": "2018-08-15T15:10:09.756Z",
            "Address1": "string",
            "Address2": "string",
            "City": "string",
            "State": "string",
            "Zip": "string",
            "Province": "string",
            "Country": "string",
            "HomePhone": "string",
            "MobilePhone": "string",
            "WorkPhone": "string",
            "Email": "string",
            "CreatedDate": "2018-08-15T15:10:09.756Z"
        }
                                
                            

    Facilities

    GET /v1.0/{practiceId}/facilities

    Returns all facilities created within the date range

    Path Parameters

    practiceId string

    Headers

    Authorization string

    Query String

    beginCreatedDate string
    endCreatedDate string

    Responses

    200 OK
    
    {
        "FacilityId": 0,
        "FacilityName": "string",
        "Address1": "string",
        "Address2": "string",
        "City": "string",
        "State": "string",
        "Zip": "string",
        "Province": "string",
        "Country": "string",
        "Phone": "string",
        "FacilityTypeCode": "string",
        "ExternalId": 0,
        "IsActive": true
    }
                        

    GET /v1.0/{practiceId}/facilities/{id}

    Returns facilities by id

    Path Parameters

    practiceId string
    id integer

    Headers

    Authorization string

    Responses

    200 OK
    
    {
        "FacilityId": 0,
        "FacilityName": "string",
        "Address1": "string",
        "Address2": "string",
        "City": "string",
        "State": "string",
        "Zip": "string",
        "Province": "string",
        "Country": "string",
        "Phone": "string",
        "FacilityTypeCode": "string",
        "ExternalId": 0,
        "IsActive": true
    }
                        

    Products

    GET /v1.0/{practiceId}/products

    Returns all products created within the date range

    Path Parameters

    practiceId string

    Headers

    Authorization string

    Query String

    beginCreatedDate string
    endCreatedDate string

    Responses

    200 OK
    
    {
        "Id": 0,
        "Name": "string",
        "IsActive": true
    }
                            

    GET /v1.0/{practiceId}/products/{id}

    Returns products by id

    Path Parameters

    practiceId string
    id integer

    Headers

    Authorization string

    Responses

    200 OK
    
        {
            "Id": 0,
            "Name": "string",
            "IsActive": true
        }
                                

    Procedures

    GET /v1.0/{practiceId}/procedures

    Returns all procedures created within the date range

    Path Parameters

    practiceId string

    Headers

    Authorization string

    Query String

    beginCreatedDate string
    endCreatedDate string

    Responses

    200 OK
    
    {
        "ProcedureId": 0,
        "Name": "string",
        "ProcedurePerformed": true
    }
                        
    >

    GET /v1.0/{practiceId}/procedures/{id}

    Returns procedures by id

    Path Parameters

    practiceId string
    id integer

    Headers

    Authorization string

    Responses

    200 OK
    
    {
        "ProcedureId": 0,
        "Name": "string",
        "ProcedurePerformed": true
    }
                            

    Services

    GET /v1.0/{practiceId}/services

    Returns all services created within the date range

    Path Parameters

    practiceId string

    Headers

    Authorization string

    Query String

    beginCreatedDate string
    endCreatedDate string

    Responses

    200 OK
    
    {
        "Id": 0,
        "Name": "string",
        "IsActive": true
    }
                        

    GET /v1.0/{practiceId}/services/{id}

    Returns services by id

    Path Parameters

    practiceId string
    id integer

    Headers

    Authorization string

    Responses

    200 OK
                                
    {
        "Id": 0,
        "Name": "string",
        "IsActive": true
    }
                                
                            

    Providers

    GET /v1.0/{practiceId}/providers

    Returns all providers created within the date range

    Path Parameters

    practiceId string

    Headers

    Authorization string

    Query String

    beginCreatedDate string
    endCreatedDate string

    Responses

    200 OK
                                
    {
        "ProviderId": 0,
        "FirstName": "string",
        "LastName": "string",
        "Npi": "string",
        "IsActive": true
    }
                                
                            

    GET /v1.0/{practiceId}/providers

    Returns all providers modified within the date range

    Path Parameters

    practiceId string

    Headers

    Authorization string

    Query String

    beginModifiedDate string
    endModifiedDate string

    Responses

    200 OK
                                    
    {
        "ProviderId": 0,
        "FirstName": "string",
        "LastName": "string",
        "Npi": "string",
        "IsActive": true
    }
                                    
                                

    GET /v1.0/{practiceId}/providers/{id}

    Returns providers by id

    Path Parameters

    practiceId string
    id integer

    Headers

    Authorization string

    Responses

    200 OK
                                    
    {
        "ProviderId": 0,
        "FirstName": "string",
        "LastName": "string",
        "Npi": "string",
        "IsActive": true
    }
                                    
                                

    Packages

    GET /v1.0/{practiceId}/packages

    Returns all packages created within the date range

    Path Parameters

    practiceId string

    Headers

    Authorization string

    Query String

    beginCreatedDate string
    endCreatedDate string

    Responses

    200 OK
    
    {
        "Id": 0,
        "Name": "string",
        "IsActive": true
    }
                        

    GET /v1.0/{practiceId}/packages/{id}

    Returns packages by id

    Path Parameters

    practiceId string
    id integer

    Headers

    Authorization string

    Responses

    200 OK
    
    {
        "Id": 0,
        "Name": "string",
        "IsActive": true
    }
                        

    Bills

    GET /v1.0/{practiceId}/bills

    Returns all bills created within the date range

    Path Parameters

    practiceId string

    Headers

    Authorization string

    Query String

    beginCreatedDate string
    endCreatedDate string

    Responses

    200 OK
    
    {
        "Id": 0,
        "PatientId": 0,
        "Date": "2018-08-15T15:10:09.689Z",
        "Description": "string",
        "FacilityId": 0
    }
                        

    GET /v1.0/{practiceId}/bills/{billid}/billDetails

    Returns all bill details that match a specific bill id

    Path Parameters

    practiceId string
    billid integer

    Headers

    Authorization string

    Responses

    200 OK
    
    {
        "Id": 0,
        "BillId": 0,
        "ProviderId": 0,
        "ServiceId": 0,
        "ProductId": 0,
        "PackageId": 0,
        "PriceQuoteId": 0,
        "CptCode": "string",
        "Description": "string",
        "Quantity": 0,
        "TotalAmount": 0
    }
                        

    GET /v1.0/{practiceId}/billDetails

    Returns all bill details created within the date range

    Path Parameters

    practiceId string

    Headers

    Authorization string

    Query String

    beginCreatedDate string
    endCreatedDate string

    Responses

    200 OK
    
    {
        "Id": 0,
        "BillId": 0,
        "ProviderId": 0,
        "ServiceId": 0,
        "ProductId": 0,
        "PackageId": 0,
        "PriceQuoteId": 0,
        "CptCode": "string",
        "Description": "string",
        "Quantity": 0,
        "TotalAmount": 0
    }
                        

    GET /v1.0/{practiceId}/bills/{id}

    Returns all specific bill by its id

    Path Parameters

    practiceId string
    id integer

    Headers

    Authorization string

    Responses

    200 OK
    
    {
        "Id": 0,
        "PatientId": 0,
        "Date": "2018-08-15T15:10:09.689Z",
        "Description": "string",
        "FacilityId": 0
    }
                        

    GET /v1.0/{practiceId}/billDetails/{id}

    Returns all specific bill details by its id

    Path Parameters

    practiceId string
    id integer

    Headers

    Authorization string

    Responses

    200 OK
    
    {
        "Id": 0,
        "BillId": 0,
        "ProviderId": 0,
        "ServiceId": 0,
        "ProductId": 0,
        "PackageId": 0,
        "PriceQuoteId": 0,
        "CptCode": "string",
        "Description": "string",
        "Quantity": 0,
        "TotalAmount": 0
    }
                        

    GET /v1.0/{practiceId}/patients/{patientid}/previousBalanceDetails

    Returns the previous balance details by practice and patient ID

    Path Parameters

    practiceId string
    patientid integer

    Headers

    Authorization string

    Query String

    includeCharges boolean

    Responses

    200 OK
    
    {
        "PatientId": 0,
        "AccountBalance": 0,
        "PatientChargesBalance": 0,
        "PatientUnappliedCredits": 0,
        "PatientUnappliedCopayCredits": 0,
        "PatientNetBalance": 0,
        "InsuranceChargesBalance": 0,
        "Charges": [
            {
            "LedgerEntryId": 0,
            "EncounterId": 0,
            "ExternalEncounterId": "string",
            "Code": "string",
            "Modifiers": [
                {
                "ChargeId": 0,
                "Modifier": "string"
                }
            ],
            "Description": "string",
            "PatientChargeBalance": 0,
            "InsuranceChargeBalance": 0,
            "DateOfService": "2018-08-15T15:10:09.721Z",
            "PayerName": "string",
            "PayerPriority": "string",
            "Claims": [
                {
                "ClaimId": 0,
                "StatusCode": "string",
                "StatusDesc": "string",
                "PayerName": "string",
                "PayerPriorityCode": "string",
                "PayerPriorityDesc": "string",
                "PayerInsuranceTypeCode": "string",
                "PayerInsuranceTypeDesc": "string"
                }
            ]
            }
        ]
    }
                        
    >

    Appointments

    GET /v1.0/{practiceId}/nonPatientAppointments

    Returns all non Patient appointments within the date range

    Path Parameters

    practiceId string

    Headers

    Authorization string

    Query String

    beginStartDate string
    endStartDate string

    Responses

    200 OK
    
    {
        "AppointmentId": 0,
        "PatientId": 0,
        "StartDateTime": "2018-08-13T18:47:08.793Z",
        "EndDateTime": "2018-08-13T18:47:08.794Z",
        "ProviderId": 0,
        "Description": "string",
        "IsNoShow": true,
        "IsCancellation": true,
        "IsConfirmed": true,
        "Address1": "string",
        "Address2": "string",
        "City": "string",
        "State": "string",
        "Zip": "string",
        "Province": "string",
        "Country": "string",
        "LegacyId": 0,
        "AppointmentResourceIds": [
            0
        ]
    }
                            

    GET /v1.0/{practiceId}/appointments

    Returns all Patient appointments within the date range

    Path Parameters

    practiceId string

    Headers

    Authorization string

    Query String

    beginStartDate string
    endEndDate string

    Responses

    200 OK
    
    {
        "AppointmentId": 0,
        "PatientId": 0,
        "StartDateTime": "2018-08-15T15:10:09.600Z",
        "EndDateTime": "2018-08-15T15:10:09.600Z",
        "ProviderId": 0,
        "Description": "string",
        "IsNoShow": true,
        "IsCancellation": true,
        "IsConfirmed": true,
        "Address1": "string",
        "Address2": "string",
        "City": "string",
        "State": "string",
        "Zip": "string",
        "Province": "string",
        "Country": "string",
        "LegacyId": 0,
        "AppointmentResourceIds": [
            0
        ]
    }
                        

    GET /v1.0/{practiceId}/AppointmentResources

    Returns all Appointment Resources created within the date range

    Path Parameters

    practiceId string

    Headers

    Authorization string

    Query String

    beginCreatedDate string
    endCreatedDate string
    includeInactive boolean

    Responses

    200 OK
    
    {
        "AppointmentResourceId": 0,
        "Name": "string",
        "IsActive": true
    }
                        

    GET /v1.0/{practiceId}/patients/{patientId}/appointments

    Returns all appointments for a particular patient

    Path Parameters

    practiceId string
    patientId integer

    Headers

    Authorization string

    Responses

    200 OK
    
    {
        "AppointmentId": 0,
        "PatientId": 0,
        "StartDateTime": "2018-08-15T15:10:09.600Z",
        "EndDateTime": "2018-08-15T15:10:09.600Z",
        "ProviderId": 0,
        "Description": "string",
        "IsNoShow": true,
        "IsCancellation": true,
        "IsConfirmed": true,
        "Address1": "string",
        "Address2": "string",
        "City": "string",
        "State": "string",
        "Zip": "string",
        "Province": "string",
        "Country": "string",
        "LegacyId": 0,
        "AppointmentResourceIds": [
            0
        ]
    }
                        

    GET /v1.0/{practiceId}/patients/{patientId}/appointments

    Returns all appointments for a particular patient

    Path Parameters

    practiceId string
    patientId integer

    Headers

    Authorization string

    Responses

    200 OK
    
    {
        "AppointmentId": 0,
        "PatientId": 0,
        "StartDateTime": "2018-08-15T15:10:09.600Z",
        "EndDateTime": "2018-08-15T15:10:09.600Z",
        "ProviderId": 0,
        "Description": "string",
        "IsNoShow": true,
        "IsCancellation": true,
        "IsConfirmed": true,
        "Address1": "string",
        "Address2": "string",
        "City": "string",
        "State": "string",
        "Zip": "string",
        "Province": "string",
        "Country": "string",
        "LegacyId": 0,
        "AppointmentResourceIds": [
            0
        ]
    }
                       

    GET /v1.0/{practiceId}/nonPatientAppointments/{id}

    Returns all non-patient appointments by its id

    Path Parameters

    practiceId string
    id integer

    Headers

    Authorization string

    Responses

    200 OK
    
    {
        "AppointmentId": 0,
        "PatientId": 0,
        "StartDateTime": "2018-08-15T15:10:09.600Z",
        "EndDateTime": "2018-08-15T15:10:09.600Z",
        "ProviderId": 0,
        "Description": "string",
        "IsNoShow": true,
        "IsCancellation": true,
        "IsConfirmed": true,
        "Address1": "string",
        "Address2": "string",
        "City": "string",
        "State": "string",
        "Zip": "string",
        "Province": "string",
        "Country": "string",
        "LegacyId": 0,
        "AppointmentResourceIds": [
            0
        ]
    }
                        

    GET /v1.0/{practiceId}/appointments/{id}

    Returns all patient appointments by its id

    Path Parameters

    practiceId string
    id integer

    Headers

    Authorization string

    Responses

    200 OK
    
    {
        "AppointmentId": 0,
        "PatientId": 0,
        "StartDateTime": "2018-08-15T15:10:09.600Z",
        "EndDateTime": "2018-08-15T15:10:09.600Z",
        "ProviderId": 0,
        "Description": "string",
        "IsNoShow": true,
        "IsCancellation": true,
        "IsConfirmed": true,
        "Address1": "string",
        "Address2": "string",
        "City": "string",
        "State": "string",
        "Zip": "string",
        "Province": "string",
        "Country": "string",
        "LegacyId": 0,
        "AppointmentResourceIds": [
            0
        ]
    }
                                                

    PUT /v1.0/{practiceId}/appointments/{id}/confirm

    Confirms a patient's appointment by its id

    Path Parameters

    practiceId string
    id integer

    Headers

    Authorization string

    Responses

    200 OK No response body

    GET /v1.0/{practiceId}/AppointmentResources/{id}

    Returns all AppointmentResources by its id

    Path Parameters

    practiceId string
    id integer

    Headers

    Authorization string

    Responses

    200 OK
    
    {
        "AppointmentResourceId": 0,
        "Name": "string",
        "IsActive": true
    }