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

    Function PatientRecordsApiAxiosParamCreator

    • PatientRecordsApi - axios parameter creator

      Parameters

      Returns {
          deletePatientLaborderDelete: (
              orderId: string,
              pid: string,
              options?: AxiosRequestConfig,
          ) => Promise<RequestArgs>;
          deletePatientResultDelete: (
              resultitemId: string,
              pid: string,
              options?: AxiosRequestConfig,
          ) => Promise<RequestArgs>;
          getPatient: (
              pid: string,
              options?: AxiosRequestConfig,
          ) => Promise<RequestArgs>;
          getPatientAudit: (
              pid: string,
              resource?: Resource,
              operation?: AuditOperation,
              since?: string,
              until?: string,
              sortBy?: AccessEventAuditEventEnum,
              orderBy?: OrderBy,
              page?: number,
              size?: number,
              options?: AxiosRequestConfig,
          ) => Promise<RequestArgs>;
          getPatientCauseOfDeath: (
              pid: string,
              options?: AxiosRequestConfig,
          ) => Promise<RequestArgs>;
          getPatientDiagnosis: (
              pid: string,
              options?: AxiosRequestConfig,
          ) => Promise<RequestArgs>;
          getPatientDialysisSessions: (
              pid: string,
              sortBy?: DialysisSessionEnum,
              orderBy?: OrderBy,
              page?: number,
              size?: number,
              options?: AxiosRequestConfig,
          ) => Promise<RequestArgs>;
          getPatientDocument: (
              documentId: string,
              pid: string,
              options?: AxiosRequestConfig,
          ) => Promise<RequestArgs>;
          getPatientDocumentDownload: (
              documentId: string,
              pid: string,
              options?: AxiosRequestConfig,
          ) => Promise<RequestArgs>;
          getPatientDocuments: (
              pid: string,
              sortBy?: DocumentEnum,
              orderBy?: OrderBy,
              page?: number,
              size?: number,
              options?: AxiosRequestConfig,
          ) => Promise<RequestArgs>;
          getPatientLaborder: (
              orderId: string,
              pid: string,
              options?: AxiosRequestConfig,
          ) => Promise<RequestArgs>;
          getPatientLaborders: (
              pid: string,
              page?: number,
              size?: number,
              options?: AxiosRequestConfig,
          ) => Promise<RequestArgs>;
          getPatientMedications: (
              pid: string,
              sortBy?: MedicationEnum,
              orderBy?: OrderBy,
              options?: AxiosRequestConfig,
          ) => Promise<RequestArgs>;
          getPatientMessages: (
              pid: string,
              since?: string,
              until?: string,
              status?: string[],
              channel?: string[],
              sortBy?: MessageEnum,
              orderBy?: OrderBy,
              page?: number,
              size?: number,
              options?: AxiosRequestConfig,
          ) => Promise<RequestArgs>;
          getPatientObservationCodes: (
              pid: string,
              options?: AxiosRequestConfig,
          ) => Promise<RequestArgs>;
          getPatientObservations: (
              pid: string,
              code?: string[],
              sortBy?: ObservationEnum,
              orderBy?: OrderBy,
              page?: number,
              size?: number,
              options?: AxiosRequestConfig,
          ) => Promise<RequestArgs>;
          getPatientRecordLatestMessage: (
              pid: string,
              options?: AxiosRequestConfig,
          ) => Promise<RequestArgs>;
          getPatientRenalDiagnosis: (
              pid: string,
              options?: AxiosRequestConfig,
          ) => Promise<RequestArgs>;
          getPatientResult: (
              resultitemId: string,
              pid: string,
              options?: AxiosRequestConfig,
          ) => Promise<RequestArgs>;
          getPatientResults: (
              pid: string,
              serviceId?: string[],
              orderId?: string[],
              since?: string,
              until?: string,
              sortBy?: ResultItemEnum,
              orderBy?: OrderBy,
              page?: number,
              size?: number,
              options?: AxiosRequestConfig,
          ) => Promise<RequestArgs>;
          getPatientResultServices: (
              pid: string,
              options?: AxiosRequestConfig,
          ) => Promise<RequestArgs>;
          getPatientSurveys: (
              pid: string,
              sortBy?: SurveyEnum,
              orderBy?: OrderBy,
              options?: AxiosRequestConfig,
          ) => Promise<RequestArgs>;
          getPatientTransplants: (
              pid: string,
              sortBy?: TransplantEnum,
              orderBy?: OrderBy,
              options?: AxiosRequestConfig,
          ) => Promise<RequestArgs>;
          getPatientTreatments: (
              pid: string,
              sortBy?: TreatmentEnum,
              orderBy?: OrderBy,
              options?: AxiosRequestConfig,
          ) => Promise<RequestArgs>;
          postPatientDelete: (
              pid: string,
              deletePidRequest?: DeletePidRequest,
              options?: AxiosRequestConfig,
          ) => Promise<RequestArgs>;
          postPatientExportMrc: (
              pid: string,
              options?: AxiosRequestConfig,
          ) => Promise<RequestArgs>;
          postPatientExportPkb: (
              pid: string,
              options?: AxiosRequestConfig,
          ) => Promise<RequestArgs>;
          postPatientExportPv: (
              pid: string,
              options?: AxiosRequestConfig,
          ) => Promise<RequestArgs>;
          postPatientExportPvDocs: (
              pid: string,
              options?: AxiosRequestConfig,
          ) => Promise<RequestArgs>;
          postPatientExportPvTests: (
              pid: string,
              options?: AxiosRequestConfig,
          ) => Promise<RequestArgs>;
          postPatientExportRadar: (
              pid: string,
              options?: AxiosRequestConfig,
          ) => Promise<RequestArgs>;
          postPatientUpdateDemographics: (
              pid: string,
              demographicUpdateRequest: DemographicUpdateRequest,
              options?: AxiosRequestConfig,
          ) => Promise<RequestArgs>;
      }

      • deletePatientLaborderDelete: (
            orderId: string,
            pid: string,
            options?: AxiosRequestConfig,
        ) => Promise<RequestArgs>

        Mark a particular lab order for deletion

      • deletePatientResultDelete: (
            resultitemId: string,
            pid: string,
            options?: AxiosRequestConfig,
        ) => Promise<RequestArgs>

        Mark a particular lab result for deletion

      • getPatient: (pid: string, options?: AxiosRequestConfig) => Promise<RequestArgs>

        Retreive a specific patient record

      • getPatientAudit: (
            pid: string,
            resource?: Resource,
            operation?: AuditOperation,
            since?: string,
            until?: string,
            sortBy?: AccessEventAuditEventEnum,
            orderBy?: OrderBy,
            page?: number,
            size?: number,
            options?: AxiosRequestConfig,
        ) => Promise<RequestArgs>

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

      • getPatientCauseOfDeath: (pid: string, options?: AxiosRequestConfig) => Promise<RequestArgs>

        Retreive a specific patient's cause of death

      • getPatientDiagnosis: (pid: string, options?: AxiosRequestConfig) => Promise<RequestArgs>

        Retreive a specific patient's diagnoses

      • getPatientDialysisSessions: (
            pid: string,
            sortBy?: DialysisSessionEnum,
            orderBy?: OrderBy,
            page?: number,
            size?: number,
            options?: AxiosRequestConfig,
        ) => Promise<RequestArgs>

        Retreive a specific patient's lab orders

      • getPatientDocument: (
            documentId: string,
            pid: string,
            options?: AxiosRequestConfig,
        ) => Promise<RequestArgs>

        Retreive a specific patient's document information

      • getPatientDocumentDownload: (
            documentId: string,
            pid: string,
            options?: AxiosRequestConfig,
        ) => Promise<RequestArgs>

        Retreive a specific patient's document file

      • getPatientDocuments: (
            pid: string,
            sortBy?: DocumentEnum,
            orderBy?: OrderBy,
            page?: number,
            size?: number,
            options?: AxiosRequestConfig,
        ) => Promise<RequestArgs>

        Retreive a specific patient's documents

      • getPatientLaborder: (
            orderId: string,
            pid: string,
            options?: AxiosRequestConfig,
        ) => Promise<RequestArgs>

        Retreive a particular lab order

      • getPatientLaborders: (
            pid: string,
            page?: number,
            size?: number,
            options?: AxiosRequestConfig,
        ) => Promise<RequestArgs>

        Retreive a specific patient's lab orders

      • getPatientMedications: (
            pid: string,
            sortBy?: MedicationEnum,
            orderBy?: OrderBy,
            options?: AxiosRequestConfig,
        ) => Promise<RequestArgs>

        Retreive a specific patient's medications

      • getPatientMessages: (
            pid: string,
            since?: string,
            until?: string,
            status?: string[],
            channel?: string[],
            sortBy?: MessageEnum,
            orderBy?: OrderBy,
            page?: number,
            size?: number,
            options?: AxiosRequestConfig,
        ) => Promise<RequestArgs>

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

      • getPatientObservationCodes: (pid: string, options?: AxiosRequestConfig) => Promise<RequestArgs>

        Retreive a list of observation codes available for a specific patient

      • getPatientObservations: (
            pid: string,
            code?: string[],
            sortBy?: ObservationEnum,
            orderBy?: OrderBy,
            page?: number,
            size?: number,
            options?: AxiosRequestConfig,
        ) => Promise<RequestArgs>

        Retreive a specific patient's lab orders

      • getPatientRecordLatestMessage: (pid: string, options?: AxiosRequestConfig) => Promise<RequestArgs>

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

      • getPatientRenalDiagnosis: (pid: string, options?: AxiosRequestConfig) => Promise<RequestArgs>

        Retreive a specific patient's renal diagnoses

      • getPatientResult: (
            resultitemId: string,
            pid: string,
            options?: AxiosRequestConfig,
        ) => Promise<RequestArgs>

        Retreive a particular lab result

      • getPatientResults: (
            pid: string,
            serviceId?: string[],
            orderId?: string[],
            since?: string,
            until?: string,
            sortBy?: ResultItemEnum,
            orderBy?: OrderBy,
            page?: number,
            size?: number,
            options?: AxiosRequestConfig,
        ) => Promise<RequestArgs>

        Retreive a specific patient's lab orders

      • getPatientResultServices: (pid: string, options?: AxiosRequestConfig) => Promise<RequestArgs>

        Retreive a list of resultitem services available for a specific patient

      • getPatientSurveys: (
            pid: string,
            sortBy?: SurveyEnum,
            orderBy?: OrderBy,
            options?: AxiosRequestConfig,
        ) => Promise<RequestArgs>

        Retreive a specific patient's surveys

      • getPatientTransplants: (
            pid: string,
            sortBy?: TransplantEnum,
            orderBy?: OrderBy,
            options?: AxiosRequestConfig,
        ) => Promise<RequestArgs>

        Retreive a specific patient's transplant procedures

      • getPatientTreatments: (
            pid: string,
            sortBy?: TreatmentEnum,
            orderBy?: OrderBy,
            options?: AxiosRequestConfig,
        ) => Promise<RequestArgs>

        Retreive a specific patient's treatments

      • postPatientDelete: (
            pid: string,
            deletePidRequest?: DeletePidRequest,
            options?: AxiosRequestConfig,
        ) => Promise<RequestArgs>

        Delete a specific patient record and all its associated data

      • postPatientExportMrc: (pid: string, options?: AxiosRequestConfig) => Promise<RequestArgs>

        Export a specific patient's data to PKB.

      • postPatientExportPkb: (pid: string, options?: AxiosRequestConfig) => Promise<RequestArgs>

        Export a specific patient's data to PKB.

      • postPatientExportPv: (pid: string, options?: AxiosRequestConfig) => Promise<RequestArgs>

        Export a specific patient's data to PV

      • postPatientExportPvDocs: (pid: string, options?: AxiosRequestConfig) => Promise<RequestArgs>

        Export a specific patient's documents data to PV

      • postPatientExportPvTests: (pid: string, options?: AxiosRequestConfig) => Promise<RequestArgs>

        Export a specific patient's test data to PV

      • postPatientExportRadar: (pid: string, options?: AxiosRequestConfig) => Promise<RequestArgs>

        Export a specific patient's data to RaDaR

      • postPatientUpdateDemographics: (
            pid: string,
            demographicUpdateRequest: DemographicUpdateRequest,
            options?: AxiosRequestConfig,
        ) => Promise<RequestArgs>

        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]

    Settings

    Member Visibility