Skip to main content

types

Types related to NextGen interactions.

Classes​

BulkPatientInfo​

class BulkPatientInfo(    conditions: list[NextGenEnterpriseConditionsEntryJSON] = [],    procedures: list[NextGenEnterpriseProceduresEntryJSON] = [],    future_appointments: list[NextGenEnterpriseAppointmentsEntryJSON] = [],    past_appointments: list[NextGenEnterpriseAppointmentsEntryJSON] = [],):

Container class for NextGen EHR query results.

Variables​

FHIRBundleEntryJSON​

class FHIRBundleEntryJSON(*args, **kwargs):

JSON Object for patient search results entry objects.

Note: this is an incomplete JSON object, only containing the elements we care about.

Ancestors​

  • builtins.dict

Variables​

  • static fullUrl : str

FHIRBundleJSON​

class FHIRBundleJSON(*args, **kwargs):

JSON Object for patient search results.

Note: this is an incomplete JSON object, only containing the elements we care about.

Ancestors​

  • builtins.dict

Variables​

  • static resourceType : Literal['Bundle']

FHIRBundleResourceJSON​

class FHIRBundleResourceJSON(*args, **kwargs):

JSON Object for patient search results resource objects.

Note: this is an incomplete JSON object, only containing the elements we care about.

Ancestors​

  • builtins.dict

Variables​

  • static address : List[dict]
  • static birthDate : str
  • static gender : str
  • static id : str
  • static identifier : List
  • static resourceType : Literal['Patient']
  • static telecom : List[dict]

NextGenEnterpriseAppointmentsEntryJSON​

class NextGenEnterpriseAppointmentsEntryJSON(*args, **kwargs):

JSON Object for appointments return object entries.

i.e. entries from a call to [enterprise_url]/appointments?$expand=Appointment

Note: this is an incomplete JSON object, only containing the elements we care about.

Ancestors​

  • builtins.dict

Variables​

  • static appointmentConfirmed : bool
  • static appointmentDate : str
  • static appointmentNumber : int
  • static beginTime : str
  • static duration : int
  • static endTime : str
  • static eventId : str
  • static eventName : str
  • static firstName : str
  • static id : str
  • static isCancelled : bool
  • static isDeleted : bool
  • static lastName : str
  • static locationId : str
  • static locationName : str
  • static middleName : str
  • static personId : str

NextGenEnterpriseAppointmentsExpandedEntryJSON​

class NextGenEnterpriseAppointmentsExpandedEntryJSON(*args, **kwargs):

JSON Object for expanded appointments return object entries.

i.e. expanded entries from [enterprise_url]/appointments?$expand=Appointment

Note: this is an incomplete JSON object, only containing the elements we care about.

Ancestors​

  • builtins.dict

Variables​

  • static appointmentConfirmed : bool
  • static appointmentDate : str
  • static appointmentNumber : int
  • static beginTime : str
  • static duration : int
  • static endTime : str
  • static eventId : str
  • static eventName : str
  • static firstName : str
  • static id : str
  • static isCancelled : bool
  • static isDeleted : bool
  • static lastName : str
  • static locationId : str
  • static locationName : str
  • static middleName : str
  • static personId : str

NextGenEnterpriseAppointmentsJSON​

class NextGenEnterpriseAppointmentsJSON(*args, **kwargs):

JSON Object for appointments return object.

i.e. a call to [enterprise_url]/appointments?$expand=Appointment

Note: this is an incomplete JSON object, only containing the elements we care about.

Ancestors​

  • builtins.dict

Variables​

  • static nextPageLink : typing_extensions.NotRequired[Optional[str]]

Methods​

items​

def items(    ...,) ‑> list[NextGenEnterpriseAppointmentsEntryJSON]:

D.items() -> a set-like object providing a view on D's items

NextGenEnterpriseConditionsEntryJSON​

class NextGenEnterpriseConditionsEntryJSON(*args, **kwargs):

JSON Object for patient diagnoses return object entries.

i.e. entries from a call to [enterprise_url]/persons/[patient_id]/chart/diagnoses

Note: this is an incomplete JSON object, only containing the elements we care about.

Ancestors​

  • builtins.dict

Variables​

  • static billingDescription : str
  • static description : str
  • static encounterId : str
  • static encounterTimestamp : str
  • static encounterTimestampLocalUtcOffset : int
  • static encounterTimestampUtc : str
  • static icdCode : str
  • static icdCodeSystem : str
  • static id : str
  • static onsetDate : str
  • static personId : str

NextGenEnterpriseDiagnosesJSON​

class NextGenEnterpriseDiagnosesJSON(*args, **kwargs):

JSON Object for patient diagnoses return object.

i.e. a call to [enterprise_url]/persons/[patient_id]/chart/diagnoses

Note: this is an incomplete JSON object, only containing the elements we care about.

Ancestors​

  • builtins.dict

Variables​

  • static nextPageLink : typing_extensions.NotRequired[Optional[str]]

Methods​

items​

def items(    ...,) ‑> list[NextGenEnterpriseConditionsEntryJSON]:

D.items() -> a set-like object providing a view on D's items

NextGenEnterpriseProceduresEntryJSON​

class NextGenEnterpriseProceduresEntryJSON(*args, **kwargs):

JSON Object for patient procedures return object entries.

i.e. entries from a call to [enterprise_url]/persons/[patient_id]/chart/procedures

Note: this is an incomplete JSON object, only containing the elements we care about.

Ancestors​

  • builtins.dict

Variables​

  • static cpt4Code : str
  • static encounterId : str
  • static encounterTimestamp : str
  • static encounterTimestampLocalUtcOffset : int
  • static encounterTimestampUtc : str
  • static id : str
  • static isCompleted : bool
  • static personId : str
  • static serviceDate : str
  • static serviceItemDescription : str
  • static serviceItemId : str
  • static status : str

NextGenEnterpriseProceduresJSON​

class NextGenEnterpriseProceduresJSON(*args, **kwargs):

JSON Object for patient procedures return object.

i.e. a call to [enterprise_url]/persons/[patient_id]/chart/procedures

Note: this is an incomplete JSON object, only containing the elements we care about.

Ancestors​

  • builtins.dict

Variables​

  • static nextPageLink : typing_extensions.NotRequired[Optional[str]]

Methods​

items​

def items(    ...,) ‑> list[NextGenEnterpriseProceduresEntryJSON]:

D.items() -> a set-like object providing a view on D's items

PatientCodeDetails​

class PatientCodeDetails(    icd10_codes: dict[str, PatientCodeStatus], cpt4_codes: dict[str, PatientCodeStatus],):

Container indicating the status of various codes for a given patient.

Variables​

PatientCodeStatus​

class PatientCodeStatus(    value, names=None, *, module=None, qualname=None, type=None, start=1,):

Information on the status of a specific code for a patient.

Indicates whether a code was present or absent in a patient's records, or unknown if we were unable to establish one way or another.

Ancestors​

Variables​

  • static ABSENT
  • static PRESENT
  • static UNKNOWN

PatientNameJSON​

class PatientNameJSON(*args, **kwargs):

JSON Object for patient name objects.

Note: this is an incomplete JSON object, only containing the elements we care about.

Ancestors​

  • builtins.dict

Variables​

  • static family : str
  • static given : list[str]

RetrievedPatientDetailsJSON​

class RetrievedPatientDetailsJSON(*args, **kwargs):

JSON Object for patient details retrieved from Patient endpoint.

Note: this is an incomplete JSON object, only containing the elements we care about.

Ancestors​

  • builtins.dict

Variables​

  • static cell_numbers : List[str]
  • static date_of_birth : Optional[str]
  • static emails : List[str]
  • static family_name : Optional[str]
  • static gender : Optional[str]
  • static given_name : Optional[str]
  • static home_numbers : List[str]
  • static id : str
  • static mailing_address : Optional[str]
  • static medical_record_number : Optional[str]