Skip to main content

types

Types related to NextGen interactions.

Classes​

BulkPatientInfo​

class BulkPatientInfo(    conditions: list[NextGenEnterpriseDiagnosesEntryJSON] = [],    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]

NextGenEnterpriseAddressHistoriesEntryJSON​

class NextGenEnterpriseAddressHistoriesEntryJSON(*args, **kwargs):

JSON Object for patient address history information return object entry.

i.e. a call to [enterprise_url]/persons/[patient_id]/address-histories

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

Ancestors​

  • builtins.dict

NextGenEnterpriseAppointmentJSON​

class NextGenEnterpriseAppointmentJSON(*args, **kwargs):

JSON Object for appointment return object.

i.e. entries from [enterprise_url]/appointments/[appointment_id]

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

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

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​

Variables​

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

Methods​

items​

def items(...) ‑> list[~T]:

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

NextGenEnterpriseChartEntryJSON​

class NextGenEnterpriseChartEntryJSON(*args, **kwargs):

JSON Object for patient chart information return object entry.

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

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

Ancestors​

  • builtins.dict

Variables​

  • static medicalRecordNumber : str
  • static personId : str

NextGenEnterpriseDiagnosesEntryJSON​

class NextGenEnterpriseDiagnosesEntryJSON(*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​

Variables​

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

Methods​

items​

def items(...) ‑> list[~T]:

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

NextGenEnterpriseDiagnosisJSON​

class NextGenEnterpriseDiagnosisJSON(*args, **kwargs):

JSON Object for specific patient diagnosis return object.

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

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

Ancestors​

  • builtins.dict

NextGenEnterpriseDocumentsEntryJSON​

class NextGenEnterpriseDocumentsEntryJSON(*args, **kwargs):

JSON Object for patient documents return object entries.

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

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

Ancestors​

  • builtins.dict

Variables​

  • static createTimestamp : str
  • static createTimestampLocalUtcOffset : int
  • static createTimestampUtc : str
  • static description : str
  • static encounterId : str
  • static fileType : str
  • static id : str
  • static isSensitive : bool
  • static itemType : str
  • static personId : str

NextGenEnterpriseDocumentsJSON​

class NextGenEnterpriseDocumentsJSON(*args, **kwargs):

JSON Object for patient documents return object.

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

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

Ancestors​

Variables​

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

Methods​

items​

def items(...) ‑> list[~T]:

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

NextGenEnterpriseEncounterJSON​

class NextGenEnterpriseEncounterJSON(*args, **kwargs):

JSON Object for specific patient encounter return object.

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

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

Ancestors​

  • builtins.dict

NextGenEnterpriseEncountersEntryJSON​

class NextGenEnterpriseEncountersEntryJSON(*args, **kwargs):

JSON Object for patient encounters return object entries.

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

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

Ancestors​

  • builtins.dict

Variables​

  • static id : str
  • static locationId : str
  • static locationName : str
  • static personId : str
  • static referringProviderName : Optional[str]
  • static renderingProviderName : Optional[str]
  • static status : str
  • static timestamp : str

NextGenEnterpriseEncountersJSON​

class NextGenEnterpriseEncountersJSON(*args, **kwargs):

JSON Object for patient encounters return object.

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

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

Ancestors​

Variables​

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

Methods​

items​

def items(...) ‑> list[~T]:

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

NextGenEnterpriseEthnicitiesEntryJSON​

class NextGenEnterpriseEthnicitiesEntryJSON(*args, **kwargs):

JSON Object for patient ethnicities information return object entry.

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

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

Ancestors​

  • builtins.dict

Variables​

  • static description : str
  • static id : str
  • static personId : str

NextGenEnterpriseGenderIdentitiesEntryJSON​

class NextGenEnterpriseGenderIdentitiesEntryJSON(*args, **kwargs):

JSON Object for patient gender identity information return object entry.

i.e. a call to [enterprise_url]/persons/[patient_id]/gender-identities

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

Ancestors​

  • builtins.dict

NextGenEnterpriseMedicationJSON​

class NextGenEnterpriseMedicationJSON(*args, **kwargs):

JSON Object for specific patient medication return object.

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

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

Ancestors​

  • builtins.dict

NextGenEnterpriseMedicationsEntryJSON​

class NextGenEnterpriseMedicationsEntryJSON(*args, **kwargs):

JSON Object for patient medications return object entries.

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

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

Ancestors​

  • builtins.dict

Variables​

NextGenEnterpriseMedicationsJSON​

class NextGenEnterpriseMedicationsJSON(*args, **kwargs):

JSON Object for patient medications return object.

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

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

Ancestors​

Variables​

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

Methods​

items​

def items(...) ‑> list[~T]:

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

NextGenEnterprisePersonJSON​

class NextGenEnterprisePersonJSON(*args, **kwargs):

JSON Object for patient information return object.

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

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

Ancestors​

  • builtins.dict

Variables​

  • static dateOfBirth : str
  • static firstName : str
  • static id : str
  • static lastName : str
  • static middleName : typing_extensions.NotRequired[Optional[str]]
  • static sex : str

NextGenEnterpriseProcedureJSON​

class NextGenEnterpriseProcedureJSON(*args, **kwargs):

JSON Object for specific patient procedure return object.

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

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

Ancestors​

  • builtins.dict

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​

Variables​

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

Methods​

items​

def items(...) ‑> list[~T]:

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

NextGenEnterpriseRacesEntryJSON​

class NextGenEnterpriseRacesEntryJSON(*args, **kwargs):

JSON Object for patient races information return object entry.

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

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

Ancestors​

  • builtins.dict

Variables​

  • static description : str
  • static id : str
  • static personId : str

NextGenEnterpriseSocialHistoryEntryJSON​

class NextGenEnterpriseSocialHistoryEntryJSON(*args, **kwargs):

JSON Object for social history return object entries.

i.e. entries from a call to [enterprise_url]/persons/[patient_id]/chart/social-history

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

Ancestors​

  • builtins.dict

Variables​

  • static alcoholYearQuit : Optional[str]
  • static personId : str
  • static smokingStatus : str

NextGenEnterpriseSocialHistoryJSON​

class NextGenEnterpriseSocialHistoryJSON(*args, **kwargs):

JSON Object for social history return object.

i.e. a call to [enterprise_url]/persons/[patient_id]/chart/social-history

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

Ancestors​

Variables​

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

Methods​

items​

def items(...) ‑> list[~T]:

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

NextGenEnterpriseSupportRolesEntryJSON​

class NextGenEnterpriseSupportRolesEntryJSON(*args, **kwargs):

JSON Object for patient support roles information return object entry.

i.e. a call to [enterprise_url]/persons/[patient_id]/chart/support-roles

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

Ancestors​

  • builtins.dict

PatientCodeDetails​

class PatientCodeDetails(    condition_codes: Optional[list[str]], procedure_codes: Optional[list[str]],):

Container indicating the diagnosis and treatment codes for a given patient.

Variables​

  • static condition_codes : Optional[list[str]]
  • static procedure_codes : Optional[list[str]]

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.

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]

NextGenEnterpriseAddressHistoriesJSON​

class NextGenEnterpriseAddressHistoriesJSON(*args, **kwargs):

Built-in mutable sequence.

If no argument is given, the constructor creates a new empty list. The argument must be an iterable if specified.

Ancestors​

  • builtins.list

Methods​

append​

def append(self, object, /):

Append object to the end of the list.

clear​

def clear(self, /):

Remove all items from list.

copy​

def copy(self, /):

Return a shallow copy of the list.

count​

def count(self, value, /):

Return number of occurrences of value.

extend​

def extend(self, iterable, /):

Extend list by appending elements from the iterable.

index​

def index(self, value, start=0, stop=9223372036854775807, /):

Return first index of value.

Raises ValueError if the value is not present.

insert​

def insert(self, index, object, /):

Insert object before index.

pop​

def pop(self, index=-1, /):

Remove and return item at index (default last).

Raises IndexError if list is empty or index is out of range.

remove​

def remove(self, value, /):

Remove first occurrence of value.

Raises ValueError if the value is not present.

reverse​

def reverse(self, /):

Reverse IN PLACE.

sort​

def sort(self, /, *, key=None, reverse=False):

Sort the list in ascending order and return None.

The sort is in-place (i.e. the list itself is modified) and stable (i.e. the order of two equal elements is maintained).

If a key function is given, apply it once to each list item and sort them, ascending or descending, according to their function values.

The reverse flag can be set to sort in descending order.

NextGenEnterpriseGenderIdentitiesJSON​

class NextGenEnterpriseGenderIdentitiesJSON(*args, **kwargs):

Built-in mutable sequence.

If no argument is given, the constructor creates a new empty list. The argument must be an iterable if specified.

Ancestors​

  • builtins.list

Methods​

append​

def append(self, object, /):

Append object to the end of the list.

clear​

def clear(self, /):

Remove all items from list.

copy​

def copy(self, /):

Return a shallow copy of the list.

count​

def count(self, value, /):

Return number of occurrences of value.

extend​

def extend(self, iterable, /):

Extend list by appending elements from the iterable.

index​

def index(self, value, start=0, stop=9223372036854775807, /):

Return first index of value.

Raises ValueError if the value is not present.

insert​

def insert(self, index, object, /):

Insert object before index.

pop​

def pop(self, index=-1, /):

Remove and return item at index (default last).

Raises IndexError if list is empty or index is out of range.

remove​

def remove(self, value, /):

Remove first occurrence of value.

Raises ValueError if the value is not present.

reverse​

def reverse(self, /):

Reverse IN PLACE.

sort​

def sort(self, /, *, key=None, reverse=False):

Sort the list in ascending order and return None.

The sort is in-place (i.e. the list itself is modified) and stable (i.e. the order of two equal elements is maintained).

If a key function is given, apply it once to each list item and sort them, ascending or descending, according to their function values.

The reverse flag can be set to sort in descending order.

NextGenEnterpriseEthnicitiesJSON​

class NextGenEnterpriseEthnicitiesJSON(*args, **kwargs):

Built-in mutable sequence.

If no argument is given, the constructor creates a new empty list. The argument must be an iterable if specified.

Ancestors​

  • builtins.list

Methods​

append​

def append(self, object, /):

Append object to the end of the list.

clear​

def clear(self, /):

Remove all items from list.

copy​

def copy(self, /):

Return a shallow copy of the list.

count​

def count(self, value, /):

Return number of occurrences of value.

extend​

def extend(self, iterable, /):

Extend list by appending elements from the iterable.

index​

def index(self, value, start=0, stop=9223372036854775807, /):

Return first index of value.

Raises ValueError if the value is not present.

insert​

def insert(self, index, object, /):

Insert object before index.

pop​

def pop(self, index=-1, /):

Remove and return item at index (default last).

Raises IndexError if list is empty or index is out of range.

remove​

def remove(self, value, /):

Remove first occurrence of value.

Raises ValueError if the value is not present.

reverse​

def reverse(self, /):

Reverse IN PLACE.

sort​

def sort(self, /, *, key=None, reverse=False):

Sort the list in ascending order and return None.

The sort is in-place (i.e. the list itself is modified) and stable (i.e. the order of two equal elements is maintained).

If a key function is given, apply it once to each list item and sort them, ascending or descending, according to their function values.

The reverse flag can be set to sort in descending order.

NextGenEnterpriseRacesJSON​

class NextGenEnterpriseRacesJSON(*args, **kwargs):

Built-in mutable sequence.

If no argument is given, the constructor creates a new empty list. The argument must be an iterable if specified.

Ancestors​

  • builtins.list

Methods​

append​

def append(self, object, /):

Append object to the end of the list.

clear​

def clear(self, /):

Remove all items from list.

copy​

def copy(self, /):

Return a shallow copy of the list.

count​

def count(self, value, /):

Return number of occurrences of value.

extend​

def extend(self, iterable, /):

Extend list by appending elements from the iterable.

index​

def index(self, value, start=0, stop=9223372036854775807, /):

Return first index of value.

Raises ValueError if the value is not present.

insert​

def insert(self, index, object, /):

Insert object before index.

pop​

def pop(self, index=-1, /):

Remove and return item at index (default last).

Raises IndexError if list is empty or index is out of range.

remove​

def remove(self, value, /):

Remove first occurrence of value.

Raises ValueError if the value is not present.

reverse​

def reverse(self, /):

Reverse IN PLACE.

sort​

def sort(self, /, *, key=None, reverse=False):

Sort the list in ascending order and return None.

The sort is in-place (i.e. the list itself is modified) and stable (i.e. the order of two equal elements is maintained).

If a key function is given, apply it once to each list item and sort them, ascending or descending, according to their function values.

The reverse flag can be set to sort in descending order.

NextGenEnterpriseSupportRolesJSON​

class NextGenEnterpriseSupportRolesJSON(*args, **kwargs):

Built-in mutable sequence.

If no argument is given, the constructor creates a new empty list. The argument must be an iterable if specified.

Ancestors​

  • builtins.list

Methods​

append​

def append(self, object, /):

Append object to the end of the list.

clear​

def clear(self, /):

Remove all items from list.

copy​

def copy(self, /):

Return a shallow copy of the list.

count​

def count(self, value, /):

Return number of occurrences of value.

extend​

def extend(self, iterable, /):

Extend list by appending elements from the iterable.

index​

def index(self, value, start=0, stop=9223372036854775807, /):

Return first index of value.

Raises ValueError if the value is not present.

insert​

def insert(self, index, object, /):

Insert object before index.

pop​

def pop(self, index=-1, /):

Remove and return item at index (default last).

Raises IndexError if list is empty or index is out of range.

remove​

def remove(self, value, /):

Remove first occurrence of value.

Raises ValueError if the value is not present.

reverse​

def reverse(self, /):

Reverse IN PLACE.

sort​

def sort(self, /, *, key=None, reverse=False):

Sort the list in ascending order and return None.

The sort is in-place (i.e. the list itself is modified) and stable (i.e. the order of two equal elements is maintained).

If a key function is given, apply it once to each list item and sort them, ascending or descending, according to their function values.

The reverse flag can be set to sort in descending order.

NextGenEnterpriseChartJSON​

class NextGenEnterpriseChartJSON(*args, **kwargs):

Built-in mutable sequence.

If no argument is given, the constructor creates a new empty list. The argument must be an iterable if specified.

Ancestors​

  • builtins.list

Methods​

append​

def append(self, object, /):

Append object to the end of the list.

clear​

def clear(self, /):

Remove all items from list.

copy​

def copy(self, /):

Return a shallow copy of the list.

count​

def count(self, value, /):

Return number of occurrences of value.

extend​

def extend(self, iterable, /):

Extend list by appending elements from the iterable.

index​

def index(self, value, start=0, stop=9223372036854775807, /):

Return first index of value.

Raises ValueError if the value is not present.

insert​

def insert(self, index, object, /):

Insert object before index.

pop​

def pop(self, index=-1, /):

Remove and return item at index (default last).

Raises IndexError if list is empty or index is out of range.

remove​

def remove(self, value, /):

Remove first occurrence of value.

Raises ValueError if the value is not present.

reverse​

def reverse(self, /):

Reverse IN PLACE.

sort​

def sort(self, /, *, key=None, reverse=False):

Sort the list in ascending order and return None.

The sort is in-place (i.e. the list itself is modified) and stable (i.e. the order of two equal elements is maintained).

If a key function is given, apply it once to each list item and sort them, ascending or descending, according to their function values.

The reverse flag can be set to sort in descending order.