C# Class pokitdokcsharp.PlatformClient

PokitDok Platform Client for C# Consumes the REST based PokitDok platform API https://platform.pokitdok.com/documentation/v4#/#overview
Inheritance: OauthApplicationClient, IDisposable
Mostrar archivo Open project: pokitdok/pokitdok-csharp Class Usage Examples

Public Methods

Method Description
Dispose ( ) : void
PlatformClient ( string clientId, string clientSecret, int requestTimeout = DEFAULT_TIMEOUT, OauthAccessToken accessToken = null, Uri redirectUrl = null, TokenRefreshDelegate tokenRefresh = null, string scope = null, string authCode = null ) : System

Initializes a new instance of the pokitdokcsharp.PlatformClient class.

activities ( ) : ResponseData

Call the activities endpoint for a list of all current activities See docs here: https://platform.pokitdok.com/documentation/v4#/#activities

activities ( string>.Dictionary parameters = null ) : ResponseData

Call the activities endpoint to get a listing of current activities, a query string parameter ‘parent_id’ may also be used with this API to get information about sub-activities that were initiated from a batch file upload. See docs here: https://platform.pokitdok.com/documentation/v4#/#activities

activities ( string activityId ) : ResponseData

Call the activities endpoint for a specific activityId. See docs here: https://platform.pokitdok.com/documentation/v4#/#activities

appointmentTypes ( string appointment_type_uuid = "" ) : ResponseData

Get a list of appointment types, their UUIDs, and descriptions.

appointments ( string>.Dictionary parameters ) : ResponseData

Query for open appointment slots (using pd_provider_uuid and location) or booked appointments (using patient_uuid) given query parameters. See https://platform.pokitdok.com/documentation See https://platform.pokitdok.com/documentation

appointments ( string appointment_uuid = "" ) : ResponseData

Query for an open appointment slot or a booked appointment given a specific {pd_appointment_uuid}, the (PokitDok unique appointment identifier). See https://platform.pokitdok.com/documentation

authorizations ( object>.Dictionary postData ) : ResponseData

Submit an authorization request. See docs here: https://platform.pokitdok.com/documentation/v4#/#authorizations

bookAppointment ( string appointment_uuid, object>.Dictionary putData ) : ResponseData

Book appointment for an open slot. Post data contains patient attributes and description. See https://platform.pokitdok.com/documentation

cancelAppointment ( string appointment_uuid ) : ResponseData

Cancel appointment given its {pd_appointment_uuid}. See https://platform.pokitdok.com/documentation

claims ( object>.Dictionary postData ) : ResponseData

Create a new claim, via the filing of an EDI 837 Professional Claims, to the designated Payer. See docs here: https://platform.pokitdok.com/documentation/v4#/#claims

claimsConvert ( object>.Dictionary postData ) : ResponseData

Convert an X12 837 claims file into a claims request model See docs here: https://platform.pokitdok.com/documentation/v4/#claims-convert

claimsStatus ( object>.Dictionary postData ) : ResponseData

Ascertain the status of the specified claim, via the filing of an EDI 276 Claims Status. See docs here: https://platform.pokitdok.com/documentation/v4#/#claimstatus

createIdentity ( object>.Dictionary parameters ) : ResponseData

Creates an identity resource. Returns the created resource with a uuid

createSlot ( object>.Dictionary postData ) : ResponseData

Create an available appointment slot in the PokitDok scheduler system

eligibility ( object>.Dictionary postData ) : ResponseData

Determine eligibility via an EDI 270 Request For Eligibility. See docs here: https://platform.pokitdok.com/documentation/v4#/#eligibility

enrollment ( object>.Dictionary postData ) : ResponseData

File an EDI 834 benefit enrollment. See docs here: https://platform.pokitdok.com/documentation/v4#/#enrollment

enrollmentSnapshot ( ) : ResponseData

List enrollment snapshots owned by the current application

enrollmentSnapshot ( string id ) : ResponseData

Get information about a specific enrollment snapshot owned by the current application

enrollmentSnapshot ( string tradingPartnerId, string filepath ) : ResponseData

Submit a X12 834 file as the current snapshot of a group’s benefits enrollment data

enrollmentSnapshotData ( string id ) : ResponseData

List enrollment data associated with a specific enrollment snapshot owned by the current application

icdConvert ( string icd9_code ) : ResponseData

retrieve ICD-9 to ICD-10 mapping information

identity ( string uuid ) : ResponseData

Queries for an identity with a given uuid.

identityHistory ( string uuid ) : ResponseData

Queries for a historical identity record

init ( ) : void

Init this instance.

medicalProcedureCode ( string>.Dictionary parameters ) : ResponseData

The Medical Procedure Code resource provides access to clinical and consumer friendly information related to medical procedures.

medicalProcedureCode ( string medical_procedure_code ) : ResponseData

The Medical Procedure Code resource provides access to clinical and consumer friendly information related to medical procedures.

payers ( ) : ResponseData

Use the /payers/ API to determine available payer_id values for use with other endpoints The Payers endpoint will be deprecated in v5. Use Trading Partners instead. See docs here: https://platform.pokitdok.com/documentation/v4#/#payers

pharmacyFormulary ( string>.Dictionary parameters ) : ResponseData

Pharmacy Formulary information See https://platform.pokitdok.com/documentation

pharmacyNetwork ( string>.Dictionary parameters ) : ResponseData

Search for in-network pharmacies See https://platform.pokitdok.com/documentation

pharmacyNetwork ( string npi, string>.Dictionary parameters ) : ResponseData

Check if a pharmacy is in-network using an NPI See https://platform.pokitdok.com/documentation

pharmacyPlans ( string>.Dictionary parameters ) : ResponseData

Pharmacy Plan information See https://platform.pokitdok.com/documentation

plans ( string>.Dictionary parameters = null ) : ResponseData

Retrieve data on plans based on the parameters given. See docs here: https://platform.pokitdok.com/documentation/v4#/#plans

pricesCash ( string>.Dictionary parameters = null ) : ResponseData

Return a list of cash prices for a given procedure (by CPT Code) in a given region (by ZIP Code). See docs here: https://platform.pokitdok.com/documentation/v4#/#cashprices

pricesInsurance ( string>.Dictionary parameters = null ) : ResponseData

Return a list of insurance prices for a given procedure (by CPT Code) in a given region (by ZIP Code). See docs here: https://platform.pokitdok.com/documentation/v4#/#insuranceprices

providers ( string>.Dictionary parameters ) : ResponseData

Retrieve providers data matching specified query parameters See docs here: https://platform.pokitdok.com/documentation/v4#/#providers

providers ( string npi ) : ResponseData

Retrieve the data for a specified provider. See docs here: https://platform.pokitdok.com/documentation/v4#/#providers

referrals ( object>.Dictionary postData ) : ResponseData

Request approval for a referral to another health care provider. See docs here: https://platform.pokitdok.com/documentation/v4#/#referrals

request ( string endpoint, string method, object parameters = null ) : ResponseData

Submit a request to any endpoint.

request ( string endpoint, string postFilePath, string postFileContentDispositionName, string postFileContentType, string>.Dictionary parameters = null ) : ResponseData

POST a file to a given endpoint.

schedulers ( string scheduler_uuid = "" ) : ResponseData

Get a list of supported scheduling systems and their UUIDs and descriptions.

tradingPartners ( string npi = "" ) : ResponseData

Retrieve a list of trading partners or submit an id to get info for a specific trading partner. See docs here: https://platform.pokitdok.com/documentation/v4#/#tradingpartners

updateAppointment ( string appointment_uuid, object>.Dictionary putData ) : ResponseData

Update appointment description. See https://platform.pokitdok.com/documentation

updateIdentity ( string uuid, object>.Dictionary parameters ) : ResponseData

Updates an identity resource with a given uuid. Returns the updated identity resource.

usage ( ) : dynamic

Usage statistics for most recent request See docs here: https://platform.pokitdok.com/documentation/v4#/#overview

Private Methods

Method Description
applyResponse ( ResponseData response ) : ResponseData

Applies the response data to extract usage, data and error members.

Method Details

Dispose() public method

public Dispose ( ) : void
return void

PlatformClient() public method

Initializes a new instance of the pokitdokcsharp.PlatformClient class.
public PlatformClient ( string clientId, string clientSecret, int requestTimeout = DEFAULT_TIMEOUT, OauthAccessToken accessToken = null, Uri redirectUrl = null, TokenRefreshDelegate tokenRefresh = null, string scope = null, string authCode = null ) : System
clientId string Client identifier.
clientSecret string Client secret.
requestTimeout int Request timeout.
accessToken OauthAccessToken Access token.
redirectUrl System.Uri The application OAuth2 redirect url.
tokenRefresh TokenRefreshDelegate Method to invoke when access token refresh save occurs.
scope string Array of OAuth2 scopes requested
authCode string The code received from an authorization code grant flow.
return System

activities() public method

Call the activities endpoint for a list of all current activities See docs here: https://platform.pokitdok.com/documentation/v4#/#activities
Thrown when unknown system error occurs.
public activities ( ) : ResponseData
return ResponseData

activities() public method

Call the activities endpoint to get a listing of current activities, a query string parameter ‘parent_id’ may also be used with this API to get information about sub-activities that were initiated from a batch file upload. See docs here: https://platform.pokitdok.com/documentation/v4#/#activities
Thrown when unknown system error occurs.
public activities ( string>.Dictionary parameters = null ) : ResponseData
parameters string>.Dictionary /// Query parameters: /// _id, {string} ID of this Activity /// name, {string} Activity name /// callback_url, {string} URL that will be invoked to notify the client application that this Activity has completed. /// We recommend that you always use https for callback URLs used by your application. /// history, {list} Historical status of the progress of this Activity /// state, {dict} Current state of this Activity /// transition_path, {list} The list of state transitions that will be used for this Activity. /// remaining_transitions, {list} The list of remaining state transitions that the activity has yet to go through. /// parameters, {dict} The parameters that were originally supplied to the activity /// units_of_work, {int} The number of ‘units of work’ that the activity is operating on. /// This will typically be 1 for real-time requests like /eligibility. If an activity /// does show a value greater than 1 for units_of_work, the client application can fetch detailed information /// about each one of the activities processing those units of work by using the /// /activities/?parent_id=<activity_id> API ///
return ResponseData

activities() public method

Call the activities endpoint for a specific activityId. See docs here: https://platform.pokitdok.com/documentation/v4#/#activities
Thrown when unknown system error occurs.
public activities ( string activityId ) : ResponseData
activityId string Activity identifier.
return ResponseData

appointmentTypes() public method

Get a list of appointment types, their UUIDs, and descriptions.
Thrown when unknown system error occurs.
public appointmentTypes ( string appointment_type_uuid = "" ) : ResponseData
appointment_type_uuid string Optional, Retrieve the data for a specified appointment type.
return ResponseData

appointments() public method

Query for open appointment slots (using pd_provider_uuid and location) or booked appointments (using patient_uuid) given query parameters. See https://platform.pokitdok.com/documentation See https://platform.pokitdok.com/documentation
Thrown when unknown system error occurs.
public appointments ( string>.Dictionary parameters ) : ResponseData
parameters string>.Dictionary See https://platform.pokitdok.com/documentation
return ResponseData

appointments() public method

Query for an open appointment slot or a booked appointment given a specific {pd_appointment_uuid}, the (PokitDok unique appointment identifier). See https://platform.pokitdok.com/documentation
Thrown when unknown system error occurs.
public appointments ( string appointment_uuid = "" ) : ResponseData
appointment_uuid string The (PokitDok unique appointment identifier).
return ResponseData

authorizations() public method

Submit an authorization request. See docs here: https://platform.pokitdok.com/documentation/v4#/#authorizations
Thrown when unknown system error occurs.
public authorizations ( object>.Dictionary postData ) : ResponseData
postData object>.Dictionary Dictionary representing JSON post data.
return ResponseData

bookAppointment() public method

Book appointment for an open slot. Post data contains patient attributes and description. See https://platform.pokitdok.com/documentation
Thrown when unknown system error occurs.
public bookAppointment ( string appointment_uuid, object>.Dictionary putData ) : ResponseData
appointment_uuid string The (PokitDok unique appointment identifier).
putData object>.Dictionary See https://platform.pokitdok.com/documentation
return ResponseData

cancelAppointment() public method

Cancel appointment given its {pd_appointment_uuid}. See https://platform.pokitdok.com/documentation
Thrown when unknown system error occurs.
public cancelAppointment ( string appointment_uuid ) : ResponseData
appointment_uuid string The (PokitDok unique appointment identifier).
return ResponseData

claims() public method

Create a new claim, via the filing of an EDI 837 Professional Claims, to the designated Payer. See docs here: https://platform.pokitdok.com/documentation/v4#/#claims
Thrown when unknown system error occurs.
public claims ( object>.Dictionary postData ) : ResponseData
postData object>.Dictionary Dictionary representing JSON post data.
return ResponseData

claimsConvert() public method

Convert an X12 837 claims file into a claims request model See docs here: https://platform.pokitdok.com/documentation/v4/#claims-convert
Thrown when unknown system error occurs.
public claimsConvert ( object>.Dictionary postData ) : ResponseData
postData object>.Dictionary Dictionary represnting JSON post data
return ResponseData

claimsStatus() public method

Ascertain the status of the specified claim, via the filing of an EDI 276 Claims Status. See docs here: https://platform.pokitdok.com/documentation/v4#/#claimstatus
Thrown when unknown system error occurs.
public claimsStatus ( object>.Dictionary postData ) : ResponseData
postData object>.Dictionary Dictionary representing JSON post data.
return ResponseData

createIdentity() public method

Creates an identity resource. Returns the created resource with a uuid
public createIdentity ( object>.Dictionary parameters ) : ResponseData
parameters object>.Dictionary
return ResponseData

createSlot() public method

Create an available appointment slot in the PokitDok scheduler system
Thrown when unknown system error occurs.
public createSlot ( object>.Dictionary postData ) : ResponseData
postData object>.Dictionary Available appointment slot details.
return ResponseData

eligibility() public method

Determine eligibility via an EDI 270 Request For Eligibility. See docs here: https://platform.pokitdok.com/documentation/v4#/#eligibility
Thrown when unknown system error occurs.
public eligibility ( object>.Dictionary postData ) : ResponseData
postData object>.Dictionary Dictionary representing an EDI 270 Request For Eligibility. ///
return ResponseData

enrollment() public method

File an EDI 834 benefit enrollment. See docs here: https://platform.pokitdok.com/documentation/v4#/#enrollment
Thrown when unknown system error occurs.
public enrollment ( object>.Dictionary postData ) : ResponseData
postData object>.Dictionary Post data.
return ResponseData

enrollmentSnapshot() public method

List enrollment snapshots owned by the current application
public enrollmentSnapshot ( ) : ResponseData
return ResponseData

enrollmentSnapshot() public method

Get information about a specific enrollment snapshot owned by the current application
public enrollmentSnapshot ( string id ) : ResponseData
id string
return ResponseData

enrollmentSnapshot() public method

Submit a X12 834 file as the current snapshot of a group’s benefits enrollment data
public enrollmentSnapshot ( string tradingPartnerId, string filepath ) : ResponseData
tradingPartnerId string
filepath string
return ResponseData

enrollmentSnapshotData() public method

List enrollment data associated with a specific enrollment snapshot owned by the current application
public enrollmentSnapshotData ( string id ) : ResponseData
id string
return ResponseData

icdConvert() public method

retrieve ICD-9 to ICD-10 mapping information
public icdConvert ( string icd9_code ) : ResponseData
icd9_code string
return ResponseData

identity() public method

Queries for an identity with a given uuid.
public identity ( string uuid ) : ResponseData
uuid string
return ResponseData

identityHistory() public method

Queries for a historical identity record
public identityHistory ( string uuid ) : ResponseData
uuid string
return ResponseData

init() public method

Init this instance.
public init ( ) : void
return void

medicalProcedureCode() public method

The Medical Procedure Code resource provides access to clinical and consumer friendly information related to medical procedures.
Thrown when unknown system error occurs.
public medicalProcedureCode ( string>.Dictionary parameters ) : ResponseData
parameters string>.Dictionary /// Query parameters: /// name, Search medical procedure information by consumer friendly name /// description, A partial or full description to be used to locate medical procedure information ///
return ResponseData

medicalProcedureCode() public method

The Medical Procedure Code resource provides access to clinical and consumer friendly information related to medical procedures.
Thrown when unknown system error occurs.
public medicalProcedureCode ( string medical_procedure_code ) : ResponseData
medical_procedure_code string Retrieve the data for a specific procedure code.
return ResponseData

payers() public method

Use the /payers/ API to determine available payer_id values for use with other endpoints The Payers endpoint will be deprecated in v5. Use Trading Partners instead. See docs here: https://platform.pokitdok.com/documentation/v4#/#payers
Thrown when unknown system error occurs.
public payers ( ) : ResponseData
return ResponseData

pharmacyFormulary() public method

Pharmacy Formulary information See https://platform.pokitdok.com/documentation
Thrown when unknown system error occurs.
public pharmacyFormulary ( string>.Dictionary parameters ) : ResponseData
parameters string>.Dictionary See https://platform.pokitdok.com/documentation
return ResponseData

pharmacyNetwork() public method

Search for in-network pharmacies See https://platform.pokitdok.com/documentation
Thrown when unknown system error occurs.
public pharmacyNetwork ( string>.Dictionary parameters ) : ResponseData
parameters string>.Dictionary See https://platform.pokitdok.com/documentation
return ResponseData

pharmacyNetwork() public method

Check if a pharmacy is in-network using an NPI See https://platform.pokitdok.com/documentation
Thrown when unknown system error occurs.
public pharmacyNetwork ( string npi, string>.Dictionary parameters ) : ResponseData
npi string
parameters string>.Dictionary See https://platform.pokitdok.com/documentation
return ResponseData

pharmacyPlans() public method

Pharmacy Plan information See https://platform.pokitdok.com/documentation
Thrown when unknown system error occurs.
public pharmacyPlans ( string>.Dictionary parameters ) : ResponseData
parameters string>.Dictionary See https://platform.pokitdok.com/documentation
return ResponseData

plans() public method

Retrieve data on plans based on the parameters given. See docs here: https://platform.pokitdok.com/documentation/v4#/#plans
Thrown when unknown system error occurs.
public plans ( string>.Dictionary parameters = null ) : ResponseData
parameters string>.Dictionary /// Query parameters: /// trading_partner_id, The trading partner id of the payer offering the plan /// county, The county in which the plan is available. /// state, The state in which the plan is available. /// plan_id, The identifier for the plan. /// plan_type, The type of the plan (e.g. EPO, PPO, HMO, POS). /// plan_name, The name of the plan. /// metallic_level, The metal level of the plan. ///
return ResponseData

pricesCash() public method

Return a list of cash prices for a given procedure (by CPT Code) in a given region (by ZIP Code). See docs here: https://platform.pokitdok.com/documentation/v4#/#cashprices
Thrown when unknown system error occurs.
public pricesCash ( string>.Dictionary parameters = null ) : ResponseData
parameters string>.Dictionary /// Query parameters: /// cpt_code, {string} The CPT code of the procedure in question. /// zip_code, {string} Postal code in which to search for procedures ///
return ResponseData

pricesInsurance() public method

Return a list of insurance prices for a given procedure (by CPT Code) in a given region (by ZIP Code). See docs here: https://platform.pokitdok.com/documentation/v4#/#insuranceprices
Thrown when unknown system error occurs.
public pricesInsurance ( string>.Dictionary parameters = null ) : ResponseData
parameters string>.Dictionary /// Query parameters: /// cpt_code, {string} The CPT code of the procedure in question. /// zip_code, {string} Postal code in which to search for procedures ///
return ResponseData

providers() public method

Retrieve providers data matching specified query parameters See docs here: https://platform.pokitdok.com/documentation/v4#/#providers
Thrown when unknown system error occurs.
public providers ( string>.Dictionary parameters ) : ResponseData
parameters string>.Dictionary /// Query parameters: /// organization_name, The business practice name /// first_name, Provider first name /// last_name, Provider first name /// specialty, Provider specialty name from NUCC/NPI taxonomy /// city, Provider city /// state, Provider state /// zipcode, Provider 5-digit zip code /// radius, Search distance from geographic centerpoint, with unit (e.g. “1mi” or “50mi”) /// (Only used when city, state, or zipcode is passed) ///
return ResponseData

providers() public method

Retrieve the data for a specified provider. See docs here: https://platform.pokitdok.com/documentation/v4#/#providers
Thrown when unknown system error occurs.
public providers ( string npi ) : ResponseData
npi string Provider NPI identifier.
return ResponseData

referrals() public method

Request approval for a referral to another health care provider. See docs here: https://platform.pokitdok.com/documentation/v4#/#referrals
Thrown when unknown system error occurs.
public referrals ( object>.Dictionary postData ) : ResponseData
postData object>.Dictionary Dictionary representing JSON post data.
return ResponseData

request() public method

Submit a request to any endpoint.
public request ( string endpoint, string method, object parameters = null ) : ResponseData
endpoint string e.g. `/activities`, `/eligibility`, etc.
method string POST, PUT, GET, DELETE
parameters object A dictionary of either (string, object) or (string, string)
return ResponseData

request() public method

POST a file to a given endpoint.
public request ( string endpoint, string postFilePath, string postFileContentDispositionName, string postFileContentType, string>.Dictionary parameters = null ) : ResponseData
endpoint string e.g. `/activities`, `/eligibility`, etc.
postFilePath string
postFileContentDispositionName string
postFileContentType string
parameters string>.Dictionary
return ResponseData

schedulers() public method

Get a list of supported scheduling systems and their UUIDs and descriptions.
Thrown when unknown system error occurs.
public schedulers ( string scheduler_uuid = "" ) : ResponseData
scheduler_uuid string Optional, Retrieve the data for a specified scheduling system.
return ResponseData

tradingPartners() public method

Retrieve a list of trading partners or submit an id to get info for a specific trading partner. See docs here: https://platform.pokitdok.com/documentation/v4#/#tradingpartners
Thrown when unknown system error occurs.
public tradingPartners ( string npi = "" ) : ResponseData
npi string Trading Partner Identifier.
return ResponseData

updateAppointment() public method

Update appointment description. See https://platform.pokitdok.com/documentation
Thrown when unknown system error occurs.
public updateAppointment ( string appointment_uuid, object>.Dictionary putData ) : ResponseData
appointment_uuid string The (PokitDok unique appointment identifier).
putData object>.Dictionary See https://platform.pokitdok.com/documentation
return ResponseData

updateIdentity() public method

Updates an identity resource with a given uuid. Returns the updated identity resource.
public updateIdentity ( string uuid, object>.Dictionary parameters ) : ResponseData
uuid string
parameters object>.Dictionary
return ResponseData

usage() public method

Usage statistics for most recent request See docs here: https://platform.pokitdok.com/documentation/v4#/#overview
Thrown when unknown system error occurs.
public usage ( ) : dynamic
return dynamic