@ukkidney/ukrdc-axios-ts

@ukkidney/ukrdc-axios-ts@6.5.1

This generator creates TypeScript/JavaScript client that utilizes axios. The generated Node module can be used in the following environments:

Environment

• Node.js
• Webpack
• Browserify

Language level

• ES5 - you must have a Promises/A+ library installed
• ES6

Module system

• CommonJS
• ES6 module system

It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json. (Reference)

Building

To build and compile the typescript sources to javascript use:

npm install
npm run build
Copy

Publishing

First build the package then run npm publish

Consuming

navigate to the folder of your consuming project and run one of the following commands.

published:

npm install @ukkidney/ukrdc-axios-ts@6.5.1 --save
Copy

unPublished (not recommended):

npm install PATH_TO_GENERATED_PACKAGE --save
Copy

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
AdminApi	getAdminCounts	GET /api/admin/counts	Admin Counts
AdminApi	getDatahealthMultipleUkrdcids	GET /api/admin/datahealth/multiple_ukrdcids	Datahealth Multiple Ukrdcids
AdminApi	getDatahealthMultipleUkrdcidsLastRun	GET /api/admin/datahealth/multiple_ukrdcids/last_run	Datahealth Multiple Ukrdcids Last Run
AdminApi	getFullErrorsHistory	GET /api/admin/errors_history	Full Errors History
AdminApi	getFullWorkitemHistory	GET /api/admin/workitems_history	Full Workitem History
AdminApi	getRecordWorkitemCounts	GET /api/admin/datahealth/record_workitem_counts	Record Workitem Counts
AdminDataHealthApi	getDatahealthMultipleUkrdcids	GET /api/admin/datahealth/multiple_ukrdcids	Datahealth Multiple Ukrdcids
AdminDataHealthApi	getDatahealthMultipleUkrdcidsLastRun	GET /api/admin/datahealth/multiple_ukrdcids/last_run	Datahealth Multiple Ukrdcids Last Run
AdminDataHealthApi	getRecordWorkitemCounts	GET /api/admin/datahealth/record_workitem_counts	Record Workitem Counts
BackgroundTasksApi	getTask	GET /api/tasks/{task_id}	Task
BackgroundTasksApi	getTasks	GET /api/tasks	Tasks
CodesApi	getCodeDetails	GET /api/codes/list/{coding_standard}.{code}	Code Details
CodesApi	getCodeExclusions	GET /api/codes/exclusions	Code Exclusions
CodesApi	getCodeExclusionsExport	GET /api/codes/export/exclusions	Code Exclusions Export
CodesApi	getCodeList	GET /api/codes/list	Code List
CodesApi	getCodeListExport	GET /api/codes/export/list	Code List Export
CodesApi	getCodeMaps	GET /api/codes/maps	Code Maps
CodesApi	getCodeMapsExport	GET /api/codes/export/maps	Code Maps Export
CodesApi	getCodingStandardsList	GET /api/codes/standards	Coding Standards List
DashboardApi	getDashboard	GET /api/dash	Dashboard
FacilitiesApi	getFacility	GET /api/facilities/{code}	Facility
FacilitiesApi	getFacilityErrrorsHistory	GET /api/facilities/{code}/error_history	Facility Errrors History
FacilitiesApi	getFacilityExtracts	GET /api/facilities/{code}/extracts	Facility Extracts
FacilitiesApi	getFacilityList	GET /api/facilities	Facility List
FacilitiesApi	getFacilityPatientsLatestErrors	GET /api/facilities/{code}/patients_latest_errors	Facility Patients Latest Errors
FacilitiesApi	getFacilityRadarMissing	GET /api/facilities/{code}/reports/radar_missing	Facility Radar Missing
FacilitiesApi	getFacilityReportsCc001	GET /api/facilities/{code}/reports/cc001	Facility Reports Cc001
FacilitiesApi	getFacilityReportsPm001	GET /api/facilities/{code}/reports/pm001	Facility Reports Pm001
FacilitiesApi	getFacilityStatsDemographics	GET /api/facilities/{code}/stats/demographics	Facility Stats Demographics
FacilitiesApi	getFacilityStatsKrt	GET /api/facilities/{code}/stats/krt	Facility Stats Krt
FacilitiesReportsApi	getFacilityRadarMissing	GET /api/facilities/{code}/reports/radar_missing	Facility Radar Missing
FacilitiesReportsApi	getFacilityReportsCc001	GET /api/facilities/{code}/reports/cc001	Facility Reports Cc001
FacilitiesReportsApi	getFacilityReportsPm001	GET /api/facilities/{code}/reports/pm001	Facility Reports Pm001
FacilitiesStatsApi	getFacilityStatsDemographics	GET /api/facilities/{code}/stats/demographics	Facility Stats Demographics
FacilitiesStatsApi	getFacilityStatsKrt	GET /api/facilities/{code}/stats/krt	Facility Stats Krt
MasterRecordsApi	getMasterRecord	GET /api/masterrecords/{record_id}	Master Record
MasterRecordsApi	getMasterRecordLatestMessage	GET /api/masterrecords/{record_id}/latest_message	Master Record Latest Message
MasterRecordsApi	getMasterRecordLinkrecords	GET /api/masterrecords/{record_id}/linkrecords	Master Record Linkrecords
MasterRecordsApi	getMasterRecordMessages	GET /api/masterrecords/{record_id}/messages	Master Record Messages
MasterRecordsApi	getMasterRecordPatientrecords	GET /api/masterrecords/{record_id}/patientrecords	Master Record Patientrecords
MasterRecordsApi	getMasterRecordPersons	GET /api/masterrecords/{record_id}/persons	Master Record Persons
MasterRecordsApi	getMasterRecordRelated	GET /api/masterrecords/{record_id}/related	Master Record Related
MasterRecordsApi	getMasterRecordStatistics	GET /api/masterrecords/{record_id}/statistics	Master Record Statistics
MasterRecordsApi	getMasterRecordWorkitems	GET /api/masterrecords/{record_id}/workitems	Master Record Workitems
MessagesApi	getMessage	GET /api/messages/{message_id}	Message
MessagesApi	getMessagePatientrecords	GET /api/messages/{message_id}/patientrecords	Message Patientrecords
MessagesApi	getMessageSource	GET /api/messages/{message_id}/source	Message Source
MessagesApi	getMessageWorkitems	GET /api/messages/{message_id}/workitems	Message Workitems
MessagesApi	getMessages	GET /api/messages	Messages
MirthApi	getMirthChannel	GET /api/mirth/channels/{channel_id}	Mirth Channel
MirthApi	getMirthChannelMap	GET /api/mirth/channel_map	Mirth Channel Map
MirthApi	getMirthChannelMessage	GET /api/mirth/channels/{channel_id}/messages/{message_id}	Mirth Channel Message
MirthApi	getMirthChannelMessages	GET /api/mirth/channels/{channel_id}/messages	Mirth Channel Messages
MirthApi	getMirthChannels	GET /api/mirth/channels	Mirth Channels
MirthApi	getMirthGroups	GET /api/mirth/groups	Mirth Groups
PatientIndexOperationsApi	postEmpiMerge	POST /api/empi/merge	Empi Merge
PatientIndexOperationsApi	postEmpiUnlink	POST /api/empi/unlink	Empi Unlink
PatientRecordsApi	deletePatientLaborderDelete	DELETE /api/patientrecords/{pid}/laborders/{order_id}	Patient Laborder Delete
PatientRecordsApi	deletePatientResultDelete	DELETE /api/patientrecords/{pid}/results/{resultitem_id}	Patient Result Delete
PatientRecordsApi	getPatient	GET /api/patientrecords/{pid}	Patient
PatientRecordsApi	getPatientAudit	GET /api/patientrecords/{pid}/audit	Patient Audit
PatientRecordsApi	getPatientCauseOfDeath	GET /api/patientrecords/{pid}/diagnoses/causeofdeath	Patient Cause Of Death
PatientRecordsApi	getPatientDiagnosis	GET /api/patientrecords/{pid}/diagnoses/diagnosis	Patient Diagnosis
PatientRecordsApi	getPatientDialysisSessions	GET /api/patientrecords/{pid}/dialysissessions	Patient Dialysis Sessions
PatientRecordsApi	getPatientDocument	GET /api/patientrecords/{pid}/documents/{document_id}	Patient Document
PatientRecordsApi	getPatientDocumentDownload	GET /api/patientrecords/{pid}/documents/{document_id}/download	Patient Document Download
PatientRecordsApi	getPatientDocuments	GET /api/patientrecords/{pid}/documents	Patient Documents
PatientRecordsApi	getPatientLaborder	GET /api/patientrecords/{pid}/laborders/{order_id}	Patient Laborder
PatientRecordsApi	getPatientLaborders	GET /api/patientrecords/{pid}/laborders	Patient Laborders
PatientRecordsApi	getPatientMedications	GET /api/patientrecords/{pid}/medications	Patient Medications
PatientRecordsApi	getPatientMessages	GET /api/patientrecords/{pid}/messages	Patient Messages
PatientRecordsApi	getPatientObservationCodes	GET /api/patientrecords/{pid}/observation_codes	Patient Observation Codes
PatientRecordsApi	getPatientObservations	GET /api/patientrecords/{pid}/observations	Patient Observations
PatientRecordsApi	getPatientRecordLatestMessage	GET /api/patientrecords/{pid}/latest_message	Patient Record Latest Message
PatientRecordsApi	getPatientRenalDiagnosis	GET /api/patientrecords/{pid}/diagnoses/renaldiagnosis	Patient Renal Diagnosis
PatientRecordsApi	getPatientResult	GET /api/patientrecords/{pid}/results/{resultitem_id}	Patient Result
PatientRecordsApi	getPatientResultServices	GET /api/patientrecords/{pid}/result_services	Patient Result Services
PatientRecordsApi	getPatientResults	GET /api/patientrecords/{pid}/results	Patient Results
PatientRecordsApi	getPatientSurveys	GET /api/patientrecords/{pid}/surveys	Patient Surveys
PatientRecordsApi	getPatientTransplants	GET /api/patientrecords/{pid}/transplants	Patient Transplants
PatientRecordsApi	getPatientTreatments	GET /api/patientrecords/{pid}/treatments	Patient Treatments
PatientRecordsApi	postPatientDelete	POST /api/patientrecords/{pid}/delete	Patient Delete
PatientRecordsApi	postPatientExportMrc	POST /api/patientrecords/{pid}/export/mrc	Patient Export Mrc
PatientRecordsApi	postPatientExportPkb	POST /api/patientrecords/{pid}/export/pkb	Patient Export Pkb
PatientRecordsApi	postPatientExportPv	POST /api/patientrecords/{pid}/export/pv	Patient Export Pv
PatientRecordsApi	postPatientExportPvDocs	POST /api/patientrecords/{pid}/export/pv-docs	Patient Export Pv Docs
PatientRecordsApi	postPatientExportPvTests	POST /api/patientrecords/{pid}/export/pv-tests	Patient Export Pv Tests
PatientRecordsApi	postPatientExportRadar	POST /api/patientrecords/{pid}/export/radar	Patient Export Radar
PatientRecordsApi	postPatientUpdateDemographics	POST /api/patientrecords/{pid}/update/demographics	Patient Update Demographics
PatientRecordsExportApi	postPatientExportMrc	POST /api/patientrecords/{pid}/export/mrc	Patient Export Mrc
PatientRecordsExportApi	postPatientExportPkb	POST /api/patientrecords/{pid}/export/pkb	Patient Export Pkb
PatientRecordsExportApi	postPatientExportPv	POST /api/patientrecords/{pid}/export/pv	Patient Export Pv
PatientRecordsExportApi	postPatientExportPvDocs	POST /api/patientrecords/{pid}/export/pv-docs	Patient Export Pv Docs
PatientRecordsExportApi	postPatientExportPvTests	POST /api/patientrecords/{pid}/export/pv-tests	Patient Export Pv Tests
PatientRecordsExportApi	postPatientExportRadar	POST /api/patientrecords/{pid}/export/radar	Patient Export Radar
PatientRecordsUpdateApi	postPatientUpdateDemographics	POST /api/patientrecords/{pid}/update/demographics	Patient Update Demographics
SearchApi	getSearchMasterrecords	GET /api/search	Search Masterrecords
SearchApi	getSearchRecords	GET /api/search/records	Search Records
SystemInfoApi	getSystemInfo	GET /api/system/info	System Info
SystemInfoApi	getSystemUser	GET /api/system/user	System User
SystemInfoApi	getSystemUserPreferences	GET /api/system/user/preferences	System User Preferences
SystemInfoApi	putUpdateSystemUserPreferences	PUT /api/system/user/preferences	Update System User Preferences
UKRDCRecordGroupApi	getUkrdcidRecords	GET /api/ukrdcid/{ukrdcid}/records	Ukrdcid Records
UKRDCRecordGroupApi	postUkrdcidMembershipsCreateMrc	POST /api/ukrdcid/{ukrdcid}/memberships/create/mrc	Ukrdcid Memberships Create Mrc
UKRDCRecordGroupApi	postUkrdcidMembershipsCreatePkb	POST /api/ukrdcid/{ukrdcid}/memberships/create/pkb	Ukrdcid Memberships Create Pkb
WorkItemsApi	getWorkitem	GET /api/workitems/{workitem_id}	Workitem
WorkItemsApi	getWorkitemCollection	GET /api/workitems/{workitem_id}/colection	Workitem Collection
WorkItemsApi	getWorkitemMessages	GET /api/workitems/{workitem_id}/messages	Workitem Messages
WorkItemsApi	getWorkitemRelated	GET /api/workitems/{workitem_id}/related	Workitem Related
WorkItemsApi	getWorkitems	GET /api/workitems	Workitems
WorkItemsApi	postWorkitemClose	POST /api/workitems/{workitem_id}/close	Workitem Close
WorkItemsApi	putWorkitemUpdate	PUT /api/workitems/{workitem_id}	Workitem Update

Documentation For Models

• AccessEventAuditEventEnum
• AccessEventSchema
• AddressSchema
• AdminCountsSchema
• AuditEventSchema
• AuditOperation
• AxisLabels2d
• ChannelFullModel
• ChannelGroupModel
• ChannelMapModel
• ChannelMessageModel
• ChannelStatistics
• CloseWorkItemRequest
• CodeExclusionSchema
• CodeMapSchema
• CodeSchema
• ConnectorMessageData
• ConnectorMessageModel
• ContactDetailSchema
• DashboardSchema
• DeletePidRequest
• DemographicUpdateRequest
• DemographicsMetadata
• DemographicsStats
• DialysisSessionEnum
• DialysisSessionSchema
• DocumentEnum
• DocumentSchema
• DocumentSummarySchema
• ExportResponseSchema
• ExtendedCauseOfDeathSchema
• ExtendedCodeSchema
• ExtendedDiagnosisSchema
• ExtendedRenalDiagnosisSchema
• FacilityDataFlowSchema
• FacilityDetailsSchema
• FacilityExtractsSchema
• FacilitySorterEnum
• FacilityStatisticsSchema
• FamilyDoctorSchema
• GPInfo
• HTTPValidationError
• HistoryPoint
• KRTMetadata
• KRTStats
• LabOrderSchema
• LabOrderShortSchema
• Labelled2d
• Labelled2dData
• Labelled2dMetadata
• LastRunTime
• LinkRecordSchema
• LocationInner
• MasterRecordSchema
• MasterRecordStatisticsSchema
• MedicationEnum
• MedicationSchema
• MergeRequest
• MessageEnum
• MessagePage
• MessageSchema
• MessageSourceSchema
• MinimalMessageSchema
• MirthMessageResponseSchema
• MultipleUKRDCIDGroup
• MultipleUKRDCIDGroupItem
• NameSchema
• NumberSchema
• ObservationEnum
• ObservationSchema
• OrderBy
• PVDataSchema
• PageAuditEventSchema
• PageCodeExclusionSchema
• PageCodeMapSchema
• PageCodeSchema
• PageDialysisSessionSchema
• PageDocumentSummarySchema
• PageLabOrderShortSchema
• PageMasterRecordSchema
• PageMessageSchema
• PageMultipleUKRDCIDGroup
• PageObservationSchema
• PagePatientRecordSummarySchema
• PageResultItemSchema
• PageTrackableTaskSchema
• PageWorkItemGroup
• PageWorkItemSchema
• PatientRecordSchema
• PatientRecordSummarySchema
• PatientSchema
• PersonSchema
• PidXRefSchema
• ProgramMembershipSchema
• RadarMissingPagePatientRecordSummarySchema
• Resource
• ResultItemEnum
• ResultItemSchema
• ResultItemServiceSchema
• SurveyEnum
• SurveyLevelSchema
• SurveyQuestionSchema
• SurveySchema
• SurveyScoreSchema
• SystemInfoSchema
• TrackableTaskSchema
• TransplantEnum
• TransplantSchema
• TreatmentEnum
• TreatmentSchema
• UnitLevelKRTStats
• UnlinkRequest
• UpdateWorkItemRequest
• UserPreferences
• UserPreferencesRequest
• UserSchema
• ValidationError
• WorkItemAttributes
• WorkItemDestinationSchema
• WorkItemEnum
• WorkItemExtendedSchema
• WorkItemGroup
• WorkItemGroupSorterEnum
• WorkItemIncomingSchema
• WorkItemSchema
• YInner

Documentation For Authorization

Authentication schemes defined for the API:

OktaJWTBearer

• Type: OAuth
• Flow: accessCode
• Authorization URL: https://sso.ukkidney.org/oauth2/ausn7fa9zfh1DC2La5d6/v1/authorize
• Scopes: N/A