@ukkidney/ukrdc-axios-ts
    Preparing search index...

    Function PatientRecordsApiFp

    • PatientRecordsApi - functional programming interface

      Parameters

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

      • deletePatientLaborderDelete: function
        • Mark a particular lab order for deletion

          Parameters

          • orderId: string
          • pid: string
          • Optionaloptions: AxiosRequestConfig

            Override http request option.

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

      • deletePatientResultDelete: function
        • Mark a particular lab result for deletion

          Parameters

          • resultitemId: string
          • pid: string
          • Optionaloptions: AxiosRequestConfig

            Override http request option.

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

      • getPatient: function
        • Retreive a specific patient record

          Parameters

          • pid: string
          • Optionaloptions: AxiosRequestConfig

            Override http request option.

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

      • getPatientAudit: function
        • Retreive a page of audit events related to a particular master record.

          Parameters

          • pid: string
          • Optionalresource: Resource
          • Optionaloperation: AuditOperation
          • Optionalsince: string
          • Optionaluntil: string
          • OptionalsortBy: AccessEventAuditEventEnum
          • OptionalorderBy: OrderBy
          • Optionalpage: number
          • Optionalsize: number
          • Optionaloptions: AxiosRequestConfig

            Override http request option.

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

      • getPatientCauseOfDeath: function
        • Retreive a specific patient's cause of death

          Parameters

          • pid: string
          • Optionaloptions: AxiosRequestConfig

            Override http request option.

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

      • getPatientDiagnosis: function
        • Retreive a specific patient's diagnoses

          Parameters

          • pid: string
          • Optionaloptions: AxiosRequestConfig

            Override http request option.

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

      • getPatientDialysisSessions: function
        • Retreive a specific patient's lab orders

          Parameters

          • pid: string
          • OptionalsortBy: DialysisSessionEnum
          • OptionalorderBy: OrderBy
          • Optionalpage: number
          • Optionalsize: number
          • Optionaloptions: AxiosRequestConfig

            Override http request option.

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

      • getPatientDocument: function
        • Retreive a specific patient's document information

          Parameters

          • documentId: string
          • pid: string
          • Optionaloptions: AxiosRequestConfig

            Override http request option.

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

      • getPatientDocumentDownload: function
        • Retreive a specific patient's document file

          Parameters

          • documentId: string
          • pid: string
          • Optionaloptions: AxiosRequestConfig

            Override http request option.

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

      • getPatientDocuments: function
        • Retreive a specific patient's documents

          Parameters

          • pid: string
          • OptionalsortBy: DocumentEnum
          • OptionalorderBy: OrderBy
          • Optionalpage: number
          • Optionalsize: number
          • Optionaloptions: AxiosRequestConfig

            Override http request option.

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

      • getPatientLaborder: function
        • Retreive a particular lab order

          Parameters

          • orderId: string
          • pid: string
          • Optionaloptions: AxiosRequestConfig

            Override http request option.

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

      • getPatientLaborders: function
        • Retreive a specific patient's lab orders

          Parameters

          • pid: string
          • Optionalpage: number
          • Optionalsize: number
          • Optionaloptions: AxiosRequestConfig

            Override http request option.

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

      • getPatientMedications: function
        • Retreive a specific patient's medications

          Parameters

          • pid: string
          • OptionalsortBy: MedicationEnum
          • OptionalorderBy: OrderBy
          • Optionaloptions: AxiosRequestConfig

            Override http request option.

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

      • getPatientMessages: function
        • 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
          • Optionaluntil: string
          • Optionalstatus: string[]
          • Optionalchannel: string[]
          • OptionalsortBy: MessageEnum
          • OptionalorderBy: OrderBy
          • Optionalpage: number
          • Optionalsize: number
          • Optionaloptions: AxiosRequestConfig

            Override http request option.

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

      • getPatientObservationCodes: function
        • Retreive a list of observation codes available for a specific patient

          Parameters

          • pid: string
          • Optionaloptions: AxiosRequestConfig

            Override http request option.

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

      • getPatientObservations: function
        • Retreive a specific patient's lab orders

          Parameters

          • pid: string
          • Optionalcode: string[]
          • OptionalsortBy: ObservationEnum
          • OptionalorderBy: OrderBy
          • Optionalpage: number
          • Optionalsize: number
          • Optionaloptions: AxiosRequestConfig

            Override http request option.

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

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

          Parameters

          • pid: string
          • Optionaloptions: AxiosRequestConfig

            Override http request option.

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

      • getPatientRenalDiagnosis: function
        • Retreive a specific patient's renal diagnoses

          Parameters

          • pid: string
          • Optionaloptions: AxiosRequestConfig

            Override http request option.

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

      • getPatientResult: function
        • Retreive a particular lab result

          Parameters

          • resultitemId: string
          • pid: string
          • Optionaloptions: AxiosRequestConfig

            Override http request option.

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

      • getPatientResults: function
        • Retreive a specific patient's lab orders

          Parameters

          • pid: string
          • OptionalserviceId: string[]
          • OptionalorderId: string[]
          • Optionalsince: string
          • Optionaluntil: string
          • OptionalsortBy: ResultItemEnum
          • OptionalorderBy: OrderBy
          • Optionalpage: number
          • Optionalsize: number
          • Optionaloptions: AxiosRequestConfig

            Override http request option.

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

      • getPatientResultServices: function
        • Retreive a list of resultitem services available for a specific patient

          Parameters

          • pid: string
          • Optionaloptions: AxiosRequestConfig

            Override http request option.

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

      • getPatientSurveys: function
        • Retreive a specific patient's surveys

          Parameters

          • pid: string
          • OptionalsortBy: SurveyEnum
          • OptionalorderBy: OrderBy
          • Optionaloptions: AxiosRequestConfig

            Override http request option.

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

      • getPatientTransplants: function
        • Retreive a specific patient's transplant procedures

          Parameters

          • pid: string
          • OptionalsortBy: TransplantEnum
          • OptionalorderBy: OrderBy
          • Optionaloptions: AxiosRequestConfig

            Override http request option.

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

      • getPatientTreatments: function
        • Retreive a specific patient's treatments

          Parameters

          • pid: string
          • OptionalsortBy: TreatmentEnum
          • OptionalorderBy: OrderBy
          • Optionaloptions: AxiosRequestConfig

            Override http request option.

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

      • postPatientDelete: function
        • Delete a specific patient record and all its associated data

          Parameters

          • pid: string
          • OptionaldeletePidRequest: DeletePidRequest
          • Optionaloptions: AxiosRequestConfig

            Override http request option.

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

      • postPatientExportMrc: function
        • Export a specific patient's data to PKB.

          Parameters

          • pid: string
          • Optionaloptions: AxiosRequestConfig

            Override http request option.

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

      • postPatientExportPkb: function
        • Export a specific patient's data to PKB.

          Parameters

          • pid: string
          • Optionaloptions: AxiosRequestConfig

            Override http request option.

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

      • postPatientExportPv: function
        • Export a specific patient's data to PV

          Parameters

          • pid: string
          • Optionaloptions: AxiosRequestConfig

            Override http request option.

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

      • postPatientExportPvDocs: function
        • Export a specific patient's documents data to PV

          Parameters

          • pid: string
          • Optionaloptions: AxiosRequestConfig

            Override http request option.

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

      • postPatientExportPvTests: function
        • Export a specific patient's test data to PV

          Parameters

          • pid: string
          • Optionaloptions: AxiosRequestConfig

            Override http request option.

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

      • postPatientExportRadar: function
        • Export a specific patient's data to RaDaR

          Parameters

          • pid: string
          • Optionaloptions: AxiosRequestConfig

            Override http request option.

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

      • postPatientUpdateDemographics: function
        • 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: AxiosRequestConfig

            Override http request option.

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