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.

  • NextGenEnterpriseDosageOrdersJSON - JSON Object for a medication's dosage orders return object.

    i.e. a call to [enterprise_url]/persons/[patient_id]/chart/medications/[medication_id]/dosage-orders

    DEV: A bare array, not the {"items": [...]} envelope the paginated chart routes return — confirmed against a live sandbox. /persons/lookup answers the same way.

    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.

NextGenEnterpriseAllergiesEntryJSON​

class NextGenEnterpriseAllergiesEntryJSON(*args, **kwargs):

JSON Object for patient allergies return object entries.

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

allergyId is a First DataBank (FDB) allergen identifier, not a public code system, and it is only unique within an allergyTypeId — the same allergyId names a different substance under a different type (e.g. 1000 is "Guiatuss DM" under type 2 and "vitamin A" under type 6). Use the (allergyId, allergyTypeId) pair as the identity, and prefer rxNormCode for anything leaving the SDK.

rxNormCode and snomedCode are backed by the same underlying column in NextGen, so at most one of the two is populated for any given entry — never both.

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

Variables​

  • static allergyClinicalStatus : str | None
  • static allergyId : str | None
  • static allergyType : str | None
  • static allergyTypeId : int | None
  • static allergyVerificationStatus : str | None
  • static comment : str | None
  • static criticalityCode : str | None
  • static description : str | None
  • static encounterId : str | None
  • static id : str
  • static onsetDate : str | None
  • static personId : str
  • static reactionDescription : str | None
  • static resolvedDate : str | None
  • static rxNormCode : str | None
  • static rxNormDescription : str | None
  • static snomedCode : str | None
  • static snomedDescription : str | None

NextGenEnterpriseAllergiesJSON​

class NextGenEnterpriseAllergiesJSON(*args, **kwargs):

JSON Object for patient allergies return object.

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

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

Ancestors​

Variables​

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

Methods​

items​

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

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

NextGenEnterpriseAllergyReactionJSON​

class NextGenEnterpriseAllergyReactionJSON(*args, **kwargs):

JSON Object for one entry of an allergy's reactions list.

i.e. entries embedded by $expand=Reactions on [enterprise_url]/persons/[patient_id]/chart/allergies, matching the shape the /persons/{personId}/chart/encounters/{encounterId}/allergies/{allergyId} /reactions sub-route returns.

Only present when $expand=Reactions is passed. The key is absent entirely without that $expand, and an empty list when the allergy has no reactions recorded — so an absent key and [] are distinguishable.

snomedCode codes the manifestation (the symptom — e.g. "Dizziness", SNOMED 404640003), not the substance that provoked it. FHIR's AllergyIntolerance.reaction.substance has no NextGen equivalent; see NextGenPatientQuerier.get_patient_allergies.

DEV: id carries the reaction description rather than a GUID (observed against a live sandbox), and the same reaction can be repeated within one reactions list, so entries are deduplicated on read.

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

Variables​

  • static id : str
  • static patientAllergyId : str
  • static rank : int | None
  • static reactionDescription : str | None
  • static severityCode : int | None
  • static severityDescription : str | None
  • static snomedCode : str | None

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

NextGenEnterpriseDevicesEntryJSON​

class NextGenEnterpriseDevicesEntryJSON(*args, **kwargs):

JSON Object for patient implantable device return object entries.

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

A device record is built from the FDA GUDID catalogue, which carries no SNOMED CT concept, so snoMedCtCode/snoMedCtDescription are both None on a device added that way and gmdnProductName — a Global Medical Device Nomenclature term — is the only thing naming it. A device imported from a C-CDA document through Clinical Reconciliation can carry a SNOMED concept instead.

snoMedCtCode is typed Edm.Decimal by the server's OData model, and number/format: double by the 8.4.0 spec. Neither says how a value reaches the wire, and no non-null value has ever been observed — every device read from the sandbox had null here. The type is left wide and the value coerced on the way in, rather than assuming one form.

deviceIdentifier is the UDI-DI: it names one manufacturer's product, not a kind of device, so it is not usable as a type code.

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

Variables​

  • static assigningAuthority : str | None
  • static assigningAuthorityOid : str | None
  • static deviceIdentifier : str | None
  • static deviceStatusObservation : str | None
  • static encounterId : str | None
  • static gmdnProductName : str | None
  • static id : str
  • static isDeleted : bool | None
  • static personId : str
  • static snoMedCtCode : float | int | str | None
  • static snoMedCtDescription : str | None

NextGenEnterpriseDevicesJSON​

class NextGenEnterpriseDevicesJSON(*args, **kwargs):

JSON Object for patient implantable devices return object.

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

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

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

NextGenEnterpriseDosageOrderJSON​

class NextGenEnterpriseDosageOrderJSON(*args, **kwargs):

JSON Object for one entry of a medication's dosage orders.

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

The route returns FDB's catalogue of dosage options for the drug — thirteen for an oxycodone tablet, three for metformin — not the one prescribed. Which was chosen is identified by the medication's own fdbDosageId (matching fdbDosageOrderId), or, when that is 0, by its customDosageId (matching customDosageOrderId) for an order a provider wrote themselves.

The selected entry is where a prescription's dosage is structured: sigDescription is rendered from these fields rather than the other way round, so "every 4 - 6 hours" is intervalLow 4 and intervalHigh 6.

A High counterpart of 0 means "no upper bound", not zero — only a non-zero value differing from its Low is a genuine range.

dosageLow/dosageUnitLow give the dose as an amount of drug ("10 MG"); dosageFormAmountLow/dosageFormAmountUnitLow give it as a count of the dose form ("1 tablet"). A product measured by concentration carries only the latter — latanoprost drops are "1 drop", with no mass at all.

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

Variables​

  • static customDosageOrderId : str | None
  • static dosageFormAmountHigh : float | None
  • static dosageFormAmountLow : float | None
  • static dosageFormAmountUnitHigh : str | None
  • static dosageFormAmountUnitLow : str | None
  • static dosageHigh : float | None
  • static dosageLow : float | None
  • static dosageOrderType : str | None
  • static dosageUnitHigh : str | None
  • static dosageUnitLow : str | None
  • static fdbDosageOrderId : float | None
  • static frequencyHigh : float | None
  • static frequencyLow : float | None
  • static intervalHigh : float | None
  • static intervalLow : float | None
  • static intervalUnitHigh : str | None
  • static intervalUnitLow : str | None
  • static route : str | None
  • static sigDescription : str | None

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.

NextGenEnterpriseLabResultsEntryJSON​

class NextGenEnterpriseLabResultsEntryJSON(*args, **kwargs):

JSON Object for patient lab result return object entries.

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

/chart/orders/results returns a byte-identical payload for the same patient, so only this endpoint is read.

A result is coded only when the lab interface supplied a code. Of five results read from the sandbox, one carried a loincCode. The others carried a free-text resultCode alone, which is a local string rather than a code in any terminology, so resultDescription is the only thing naming them. observationId and observationBatteryId are HL7 CE triplets (identifier^text^codingSystem) whose coding system is local (H and L), so neither is usable as a coded identifier either.

observationValue is a string, and the UI does not constrain it: NEGATIVE, <0.02, a and b were all accepted. It is parsed rather than coerced, so a value stating a limit keeps the limit.

Dates: collectionDateTime is when the specimen was taken and is populated on every result. observationDateTime is when it was resolved and was populated on one of five. They can differ by weeks, so the former is the clinical date. Only observationDateTime has a ...Utc variant.

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

Variables​

  • static clinicalName : str | None
  • static collectionDateTime : str | None
  • static encounterId : str | None
  • static isDeleted : bool | None
  • static loincCode : str | None
  • static ngTestDescription : str | None
  • static observationDateTime : str | None
  • static observationDateTimeUtc : str | None
  • static observationId : str | None
  • static observationValue : str | None
  • static personId : str
  • static resultCode : str | None
  • static resultDescription : str | None
  • static units : str | None

NextGenEnterpriseLabResultsJSON​

class NextGenEnterpriseLabResultsJSON(*args, **kwargs):

JSON Object for patient lab results return object.

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

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

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]

The linked diagnoses are each an ICD code string (e.g. "H27.02"), not an internal identifier, and carry no description — resolve one against the patient's /chart/diagnoses, whose entries pair icdCode with description and icdCodeSystem.

fdbDosageId and customDosageId say which of a drug's dosage orders was prescribed. A medication using neither carries 0 and a null GUID, rather than leaving either unset.

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

Variables​

  • static customDosageId : str | None
  • static diagnosisCode : str | None
  • static fdbDosageId : int | None
  • static id : str
  • static secondaryDiagnosisCode : str | None
  • static tertiaryDiagnosisCode : str | None

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

Confirmed against a live NextGen Enterprise sandbox. A medication chosen from the FDB catalogue carries both rxNormCode and ndcId; one entered as free text carries neither, and its ndcId is a placeholder prefixed UDM (user-defined medication) with a negative medicationId.

dose is the product's strength ("500 mg"), not the amount taken per administration — that is stated only in sigDescription, as free text.

stopDate is a planned end, not evidence of discontinuation: it is set from a finite course's duration while the medication is still Active. Use status for whether the patient is currently taking it.

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

Variables​

  • static brandName : str | None
  • static deaClassCode : int | None
  • static dose : str | None
  • static doseForm : str | None
  • static encounterId : str | None
  • static fdbName : str | None
  • static genericName : str | None
  • static id : str
  • static inactiveReason : str | None
  • static isDeleted : bool | None
  • static isGenericSelected : bool | None
  • static isPrescribedElsewhere : bool | None
  • static isSensitive : bool | None
  • static isSuppressOutreach : bool | None
  • static isSuppressPortal : bool | None
  • static medicationId : int | None
  • static medicationName : str | None
  • static ndcId : str | None
  • static originalStartDate : str | None
  • static personId : str
  • static providerId : str | None
  • static route : str | None
  • static rxNormCode : str | None
  • static rxQuantity : str | None
  • static rxRefills : str | None
  • static sigDescription : str | None
  • static startDate : str | None
  • static status : str | None
  • static stopDate : str | None

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.

NextGenEnterpriseVitalsEntryJSON​

class NextGenEnterpriseVitalsEntryJSON(*args, **kwargs):

JSON Object for patient vitals return object entries.

i.e. entries from a call to [enterprise_url]/persons/[patient_id]/chart/health-concerns/vitals

Despite the path, this returns every vitals record rather than only ones flagged as a health concern.

Each measurement contributes a {measure}Value, {measure}Unit, {measure}Category and {measure}HealthConcern. Blood pressure is the exception: it has a systolic and a diastolic value sharing one unit. Category and Unit are present for all nine measurements whether or not anything was recorded, so a reading is detected by its Value alone. HealthConcern is a readable label, e.g. "Blood Pressure - 120/35 mm/Hg".

encounterTimestamp is the encounter's time, not the measurement's, and is shared by every record from one encounter — two sandbox readings four hours apart carried the same value. /chart/vitals holds the real time, joined on id.

Units are not UCUM: mm/Hg, per min, percent and C are all stated as the server writes them. bmiUnit is declared for symmetry with the other eight measurements, but no payload has ever carried it — the mapping supplies kg/m2 instead.

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

Variables​

  • static bloodPressureDiastolicValue : float | int | None
  • static bloodPressureHealthConcern : str | None
  • static bloodPressureSystolicValue : float | int | None
  • static bloodPressureUnit : str | None
  • static bmiHealthConcern : str | None
  • static bmiUnit : str | None
  • static bmiValue : float | int | None
  • static bodyTemperatureHealthConcern : str | None
  • static bodyTemperatureUnit : str | None
  • static bodyTemperatureValue : float | int | None
  • static encounterTimestamp : str | None
  • static headCircumferenceHealthConcern : str | None
  • static headCircumferenceUnit : str | None
  • static headCircumferenceValue : float | int | None
  • static heartRateHealthConcern : str | None
  • static heartRateUnit : str | None
  • static heartRateValue : float | int | None
  • static heightHealthConcern : str | None
  • static heightUnit : str | None
  • static heightValue : float | int | None
  • static id : str
  • static o2BldCOximetryHealthConcern : str | None
  • static o2BldCOximetryUnit : str | None
  • static o2BldCOximetryValue : float | int | None
  • static personId : str
  • static respiratoryRateHealthConcern : str | None
  • static respiratoryRateUnit : str | None
  • static respiratoryRateValue : float | int | None
  • static weightHealthConcern : str | None
  • static weightUnit : str | None
  • static weightValue : float | int | None

NextGenEnterpriseVitalsJSON​

class NextGenEnterpriseVitalsJSON(*args, **kwargs):

JSON Object for patient vitals return object.

i.e. entries from a call to [enterprise_url]/persons/[patient_id]/chart/health-concerns/vitals

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

NextGenEnterpriseVitalsTimesEntryJSON​

class NextGenEnterpriseVitalsTimesEntryJSON(*args, **kwargs):

JSON Object for patient vitals timing return object entries.

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

Read only for vitalsTimestampUtc, the instant a vitals record was measured, which the values payload does not carry. Joined to NextGenEnterpriseVitalsEntryJSON on id.

vitalSignsDate and vitalSignsTime state the same instant split across two fields, the second as a locale string such as "7:37 AM". vitalsTimestampUtc states it once and needs no parsing, so it is preferred.

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

Variables​

  • static encounterId : str | None
  • static id : str
  • static personId : str
  • static vitalsTimestampUtc : str | None

NextGenEnterpriseVitalsTimesJSON​

class NextGenEnterpriseVitalsTimesJSON(*args, **kwargs):

JSON Object for patient vitals timing return object.

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

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

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