Function PatientRecordsApiFp

Returns {
    deletePatientLaborderDelete(
        orderId: string,
        pid: string,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
    deletePatientResultDelete(
        resultitemId: string,
        pid: string,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
    getPatient(
        pid: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PatientRecordSchema>,
    >;
    getPatientAudit(
        pid: string,
        resource?: Resource | null,
        operation?: AuditOperation | null,
        since?: string | null,
        until?: string | null,
        page?: number,
        size?: number,
        sortBy?: AuditEventAccessEventEnum | null,
        orderBy?: OrderBy | null,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PageAuditEventSchema>,
    >;
    getPatientCauseOfDeath(
        pid: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ExtendedCauseOfDeathSchema[]>,
    >;
    getPatientDiagnosis(
        pid: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ExtendedDiagnosisSchema[]>,
    >;
    getPatientDialysisSessions(
        pid: string,
        page?: number,
        size?: number,
        sortBy?: DialysisSessionEnum | null,
        orderBy?: OrderBy | null,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PageDialysisSessionSchema>,
    >;
    getPatientDocument(
        documentId: string,
        pid: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<DocumentSchema>,
    >;
    getPatientDocumentDownload(
        documentId: string,
        pid: string,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
    getPatientDocuments(
        pid: string,
        page?: number,
        size?: number,
        sortBy?: DocumentEnum | null,
        orderBy?: OrderBy | null,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PageDocumentSummarySchema>,
    >;
    getPatientLaborder(
        orderId: string,
        pid: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<LabOrderSchema>,
    >;
    getPatientLaborders(
        pid: string,
        page?: number,
        size?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PageLabOrderShortSchema>,
    >;
    getPatientMedications(
        pid: string,
        sortBy?: MedicationEnum | null,
        orderBy?: OrderBy | null,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<MedicationSchema[]>,
    >;
    getPatientMessages(
        pid: string,
        since?: string | null,
        until?: string | null,
        status?: string[] | null,
        channel?: string[] | null,
        page?: number,
        size?: number,
        sortBy?: MessageEnum | null,
        orderBy?: OrderBy | null,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PageMessageSchema>,
    >;
    getPatientObservationCodes(
        pid: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<string[]>,
    >;
    getPatientObservations(
        pid: string,
        code?: string[] | null,
        page?: number,
        size?: number,
        sortBy?: ObservationEnum | null,
        orderBy?: OrderBy | null,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PageObservationSchema>,
    >;
    getPatientRecordLatestMessage(
        pid: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<MinimalMessageSchema>,
    >;
    getPatientRenalDiagnosis(
        pid: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ExtendedRenalDiagnosisSchema[]>,
    >;
    getPatientResult(
        resultitemId: string,
        pid: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ResultItemSchema>,
    >;
    getPatientResults(
        pid: string,
        serviceId?: string[] | null,
        orderId?: string[] | null,
        since?: string | null,
        until?: string | null,
        page?: number,
        size?: number,
        sortBy?: ResultItemEnum | null,
        orderBy?: OrderBy | null,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PageResultItemSchema>,
    >;
    getPatientResultServices(
        pid: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ResultItemServiceSchema[]>,
    >;
    getPatientSurveys(
        pid: string,
        sortBy?: SurveyEnum | null,
        orderBy?: OrderBy | null,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<SurveySchema[]>,
    >;
    getPatientTransplants(
        pid: string,
        sortBy?: TransplantEnum | null,
        orderBy?: OrderBy | null,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<TransplantSchema[]>,
    >;
    getPatientTreatments(
        pid: string,
        sortBy?: TreatmentEnum | null,
        orderBy?: OrderBy | null,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<TreatmentSchema[]>,
    >;
    getPidQuarterlyExtract(
        pid: string,
        quarter: number,
        centre: string,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
    postPatientDelete(
        pid: string,
        deletePidRequest?: DeletePidRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
    postPatientExportMrc(
        pid: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ExportResponseSchema>,
    >;
    postPatientExportPkb(
        pid: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ExportResponseSchema>,
    >;
    postPatientExportPv(
        pid: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ExportResponseSchema>,
    >;
    postPatientExportPvDocs(
        pid: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ExportResponseSchema>,
    >;
    postPatientExportPvTests(
        pid: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ExportResponseSchema>,
    >;
    postPatientExportRadar(
        pid: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ExportResponseSchema>,
    >;
    postPatientUpdateDemographics(
        pid: string,
        demographicUpdateRequest: DemographicUpdateRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<MirthMessageResponseSchema>,
    >;
}

• deletePatientLaborderDelete: function

  • deletePatientLaborderDelete(
        orderId: string,
        pid: string,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>

    Mark a particular lab order for deletion

    Parameters

    • orderId: string
    • pid: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>

    Throws

• deletePatientResultDelete: function

  • deletePatientResultDelete(
        resultitemId: string,
        pid: string,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>

    Mark a particular lab result for deletion

    Parameters

    • resultitemId: string
    • pid: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>

    Throws

• getPatient: function

  • getPatient(
        pid: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PatientRecordSchema>,
    >

    Retreive a specific patient record

    Parameters

    • pid: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PatientRecordSchema>,
    >

    Throws

• getPatientAudit: function

  • getPatientAudit(
        pid: string,
        resource?: Resource | null,
        operation?: AuditOperation | null,
        since?: string | null,
        until?: string | null,
        page?: number,
        size?: number,
        sortBy?: AuditEventAccessEventEnum | null,
        orderBy?: OrderBy | null,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PageAuditEventSchema>,
    >

    Retreive a page of audit events related to a particular master record.

    Parameters

    • pid: string
    • Optionalresource: Resource | null
    • Optionaloperation: AuditOperation | null
    • Optionalsince: string | null
    • Optionaluntil: string | null
    • Optionalpage: number

      Page number

    • Optionalsize: number

      Page size

    • OptionalsortBy: AuditEventAccessEventEnum | null
    • OptionalorderBy: OrderBy | null
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PageAuditEventSchema>,
    >

    Throws

• getPatientCauseOfDeath: function

  • getPatientCauseOfDeath(
        pid: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ExtendedCauseOfDeathSchema[]>,
    >

    Retreive a specific patient's cause of death

    Parameters

    • pid: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ExtendedCauseOfDeathSchema[]>,
    >

    Throws

• getPatientDiagnosis: function

  • getPatientDiagnosis(
        pid: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ExtendedDiagnosisSchema[]>,
    >

    Retreive a specific patient's diagnoses

    Parameters

    • pid: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ExtendedDiagnosisSchema[]>,
    >

    Throws

• getPatientDialysisSessions: function

  • getPatientDialysisSessions(
        pid: string,
        page?: number,
        size?: number,
        sortBy?: DialysisSessionEnum | null,
        orderBy?: OrderBy | null,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PageDialysisSessionSchema>,
    >

    Retreive a specific patient's lab orders

    Parameters

    • pid: string
    • Optionalpage: number

      Page number

    • Optionalsize: number

      Page size

    • OptionalsortBy: DialysisSessionEnum | null
    • OptionalorderBy: OrderBy | null
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PageDialysisSessionSchema>,
    >

    Throws

• getPatientDocument: function

  • getPatientDocument(
        documentId: string,
        pid: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<DocumentSchema>,
    >

    Retreive a specific patient's document information

    Parameters

    • documentId: string
    • pid: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<DocumentSchema>,
    >

    Throws

• getPatientDocumentDownload: function

  • getPatientDocumentDownload(
        documentId: string,
        pid: string,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>

    Retreive a specific patient's document file

    Parameters

    • documentId: string
    • pid: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>

    Throws

• getPatientDocuments: function

  • getPatientDocuments(
        pid: string,
        page?: number,
        size?: number,
        sortBy?: DocumentEnum | null,
        orderBy?: OrderBy | null,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PageDocumentSummarySchema>,
    >

    Retreive a specific patient's documents

    Parameters

    • pid: string
    • Optionalpage: number

      Page number

    • Optionalsize: number

      Page size

    • OptionalsortBy: DocumentEnum | null
    • OptionalorderBy: OrderBy | null
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PageDocumentSummarySchema>,
    >

    Throws

• getPatientLaborder: function

  • getPatientLaborder(
        orderId: string,
        pid: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<LabOrderSchema>,
    >

    Retreive a particular lab order

    Parameters

    • orderId: string
    • pid: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<LabOrderSchema>,
    >

    Throws

• getPatientLaborders: function

  • getPatientLaborders(
        pid: string,
        page?: number,
        size?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PageLabOrderShortSchema>,
    >

    Retreive a specific patient's lab orders

    Parameters

    • pid: string
    • Optionalpage: number

      Page number

    • Optionalsize: number

      Page size

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PageLabOrderShortSchema>,
    >

    Throws

• getPatientMedications: function

  • getPatientMedications(
        pid: string,
        sortBy?: MedicationEnum | null,
        orderBy?: OrderBy | null,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<MedicationSchema[]>,
    >

    Retreive a specific patient's medications

    Parameters

    • pid: string
    • OptionalsortBy: MedicationEnum | null
    • OptionalorderBy: OrderBy | null
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<MedicationSchema[]>,
    >

    Throws

• getPatientMessages: function

  • getPatientMessages(
        pid: string,
        since?: string | null,
        until?: string | null,
        status?: string[] | null,
        channel?: string[] | null,
        page?: number,
        size?: number,
        sortBy?: MessageEnum | null,
        orderBy?: OrderBy | null,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PageMessageSchema>,
    >

    Retreive a list of messages related to a particular patient record. By default returns message created within the last 365 days.

    Parameters

    • pid: string
    • Optionalsince: string | null
    • Optionaluntil: string | null
    • Optionalstatus: string[] | null
    • Optionalchannel: string[] | null
    • Optionalpage: number

      Page number

    • Optionalsize: number

      Page size

    • OptionalsortBy: MessageEnum | null
    • OptionalorderBy: OrderBy | null
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PageMessageSchema>,
    >

    Throws

• getPatientObservationCodes: function

  • getPatientObservationCodes(
        pid: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<string[]>,
    >

    Retreive a list of observation codes available for a specific patient

    Parameters

    • pid: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string[]>>

    Throws

• getPatientObservations: function

  • getPatientObservations(
        pid: string,
        code?: string[] | null,
        page?: number,
        size?: number,
        sortBy?: ObservationEnum | null,
        orderBy?: OrderBy | null,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PageObservationSchema>,
    >

    Retreive a specific patient's lab orders

    Parameters

    • pid: string
    • Optionalcode: string[] | null
    • Optionalpage: number

      Page number

    • Optionalsize: number

      Page size

    • OptionalsortBy: ObservationEnum | null
    • OptionalorderBy: OrderBy | null
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PageObservationSchema>,
    >

    Throws

• getPatientRecordLatestMessage: function

  • getPatientRecordLatestMessage(
        pid: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<MinimalMessageSchema>,
    >

    Retreive a minimal representation of the latest file received for the patient, if received within the last year.

    Parameters

    • pid: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<MinimalMessageSchema>,
    >

    Throws

• getPatientRenalDiagnosis: function

  • getPatientRenalDiagnosis(
        pid: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ExtendedRenalDiagnosisSchema[]>,
    >

    Retreive a specific patient's renal diagnoses

    Parameters

    • pid: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ExtendedRenalDiagnosisSchema[]>,
    >

    Throws

• getPatientResult: function

  • getPatientResult(
        resultitemId: string,
        pid: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ResultItemSchema>,
    >

    Retreive a particular lab result

    Parameters

    • resultitemId: string
    • pid: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ResultItemSchema>,
    >

    Throws

• getPatientResults: function

  • getPatientResults(
        pid: string,
        serviceId?: string[] | null,
        orderId?: string[] | null,
        since?: string | null,
        until?: string | null,
        page?: number,
        size?: number,
        sortBy?: ResultItemEnum | null,
        orderBy?: OrderBy | null,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PageResultItemSchema>,
    >

    Retreive a specific patient's lab orders

    Parameters

    • pid: string
    • OptionalserviceId: string[] | null
    • OptionalorderId: string[] | null
    • Optionalsince: string | null
    • Optionaluntil: string | null
    • Optionalpage: number

      Page number

    • Optionalsize: number

      Page size

    • OptionalsortBy: ResultItemEnum | null
    • OptionalorderBy: OrderBy | null
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PageResultItemSchema>,
    >

    Throws

• getPatientResultServices: function

  • getPatientResultServices(
        pid: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ResultItemServiceSchema[]>,
    >

    Retreive a list of resultitem services available for a specific patient

    Parameters

    • pid: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ResultItemServiceSchema[]>,
    >

    Throws

• getPatientSurveys: function

  • getPatientSurveys(
        pid: string,
        sortBy?: SurveyEnum | null,
        orderBy?: OrderBy | null,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<SurveySchema[]>,
    >

    Retreive a specific patient's surveys

    Parameters

    • pid: string
    • OptionalsortBy: SurveyEnum | null
    • OptionalorderBy: OrderBy | null
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<SurveySchema[]>,
    >

    Throws

• getPatientTransplants: function

  • getPatientTransplants(
        pid: string,
        sortBy?: TransplantEnum | null,
        orderBy?: OrderBy | null,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<TransplantSchema[]>,
    >

    Retreive a specific patient's transplant procedures

    Parameters

    • pid: string
    • OptionalsortBy: TransplantEnum | null
    • OptionalorderBy: OrderBy | null
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<TransplantSchema[]>,
    >

    Throws

• getPatientTreatments: function

  • getPatientTreatments(
        pid: string,
        sortBy?: TreatmentEnum | null,
        orderBy?: OrderBy | null,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<TreatmentSchema[]>,
    >

    Retreive a specific patient's treatments

    Parameters

    • pid: string
    • OptionalsortBy: TreatmentEnum | null
    • OptionalorderBy: OrderBy | null
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<TreatmentSchema[]>,
    >

    Throws

• getPidQuarterlyExtract: function

  • getPidQuarterlyExtract(
        pid: string,
        quarter: number,
        centre: string,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>

    Parameters

    • pid: string
    • quarter: number
    • centre: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>

    Throws

• postPatientDelete: function

  • postPatientDelete(
        pid: string,
        deletePidRequest?: DeletePidRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>

    Delete a specific patient record and all its associated data

    Parameters

    • pid: string
    • OptionaldeletePidRequest: DeletePidRequest
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>

    Throws

• postPatientExportMrc: function

  • postPatientExportMrc(
        pid: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ExportResponseSchema>,
    >

    Export a specific patient's data to PKB.

    Parameters

    • pid: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ExportResponseSchema>,
    >

    Throws

• postPatientExportPkb: function

  • postPatientExportPkb(
        pid: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ExportResponseSchema>,
    >

    Export a specific patient's data to PKB.

    Parameters

    • pid: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ExportResponseSchema>,
    >

    Throws

• postPatientExportPv: function

  • postPatientExportPv(
        pid: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ExportResponseSchema>,
    >

    Export a specific patient's data to PV

    Parameters

    • pid: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ExportResponseSchema>,
    >

    Throws

• postPatientExportPvDocs: function

  • postPatientExportPvDocs(
        pid: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ExportResponseSchema>,
    >

    Export a specific patient's documents data to PV

    Parameters

    • pid: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ExportResponseSchema>,
    >

    Throws

• postPatientExportPvTests: function

  • postPatientExportPvTests(
        pid: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ExportResponseSchema>,
    >

    Export a specific patient's test data to PV

    Parameters

    • pid: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ExportResponseSchema>,
    >

    Throws

• postPatientExportRadar: function

  • postPatientExportRadar(
        pid: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ExportResponseSchema>,
    >

    Export a specific patient's data to RaDaR

    Parameters

    • pid: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ExportResponseSchema>,
    >

    Throws

• postPatientUpdateDemographics: function

  • postPatientUpdateDemographics(
        pid: string,
        demographicUpdateRequest: DemographicUpdateRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<MirthMessageResponseSchema>,
    >

    Update the demographic data of a given patient record Args: demographics (DemographicUpdateSchema): [description] patient_record (PatientRecord, optional): [description]. Defaults to Depends(_get_patientrecord). mirth (MirthAPI, optional): [description]. Defaults to Depends(get_mirth). redis (Redis, optional): [description]. Defaults to Depends(get_redis). audit (Auditer, optional): [description]. Defaults to Depends(get_auditer). Returns: [type]: [description]

    Parameters

    • pid: string
    • demographicUpdateRequest: DemographicUpdateRequest
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<MirthMessageResponseSchema>,
    >

    Throws