Skip to main content

types

Types related to NextGen interactions.

Module​

Global variables​

  • NextGenEnterpriseAddressHistoriesJSON - JSON Object for patient address history information return object.

    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.

  • NextGenEnterpriseChartJSON - JSON Object for patient chart information return object.

    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.

  • NextGenEnterpriseEthnicitiesJSON - JSON Object for patient ethnicities information return object.

    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.

  • NextGenEnterpriseGenderIdentitiesJSON - JSON Object for patient gender identity information return object.

    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.

  • NextGenEnterpriseRacesJSON - JSON Object for patient races information return object.

    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.

  • NextGenEnterpriseSupportRolesJSON - JSON Object for patient support roles information return object.

    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.

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.

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.

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.

Variables​

  • static birthDate : str
  • static gender : str
  • static id : str
  • static resourceType : Literal['Patient']

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.

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.

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.

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 : str | None

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.

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.

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
  • static statusDescription : 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 : str | None

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.

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.

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 : str | None

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.

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.

Variables​

  • static id : str
  • static locationId : str
  • static locationName : str
  • static personId : str
  • static referringProviderName : str | None
  • static renderingProviderName : str | None
  • 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 : str | None

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.

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.

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.

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.

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 : str | None

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.

Variables​

  • static dateOfBirth : str
  • static firstName : str
  • static id : str
  • static lastName : str
  • static middleName : str | None
  • static sex : str

NextGenEnterprisePersonsEntryJSON​

class NextGenEnterprisePersonsEntryJSON(*args, **kwargs):

JSON Object for person listing entries from /persons.

Variables​

  • static createTimestamp : str
  • static createdBy : int
  • static enterpriseId : str
  • static modifiedBy : int
  • static modifyTimestamp : str
  • static personId : str
  • static practiceId : str

NextGenEnterprisePersonsJSON​

class NextGenEnterprisePersonsJSON(*args, **kwargs):

JSON Object for paginated /persons responses.

Ancestors​

Variables​

  • static count : int | None
  • static nextPageLink : str | None

Methods​

items​

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

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

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.

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.

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 : str | None

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.

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.

Variables​

  • static alcoholYearQuit : str | None
  • 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 : str | None

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.

PatientCodeDetails​

class PatientCodeDetails(    condition_codes: list[Condition] | None,    procedure_codes: list[Procedure] | None,    medication_codes: list[Medication] | None = None,    unsupported_fields: frozenset[str] = frozenset(),):

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

Variables​

  • static condition_codes : list[Condition] | None
  • static medication_codes : list[Medication] | None
  • static procedure_codes : list[Procedure] | None
  • static unsupported_fields : frozenset[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.

Variables​

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

PractitionerReferenceJSON​

class PractitionerReferenceJSON(*args, **kwargs):

JSON Object for Practitioner Reference.

Variables​

  • static display : str | None
  • static id : str | None
  • static reference : str | None

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.

Variables​

  • static cell_numbers : list[str]
  • static country : str | None
  • static date_of_birth : str | None
  • static emails : list[str]
  • static family_name : str | None
  • static gender : str | None
  • static given_name : str | None
  • static home_numbers : list[str]
  • static id : str
  • static mailing_address : str | None
  • static medical_record_number : list[str] | None
  • static postal_code : str | None