@forske/nsw-ohmr NPM

OHMR Package

This package is part of the OHMR Research Activity Monitoring project.

Description

Use

npm install @forske/nsw-ohmr

// import typescript data types from package
import type { <data type> } from "@forske/nsw-ohmr"
// import common function from package
import { <function name> } from "@forske/nsw-ohmr"

Functions

Function	Arguments	Purpose	Returns	Async
Cache.Client		Create an redis client	Redis client
Cache.Json	keyclient:opt	Get a JSON object from the redis server	JSON data	:heavy_check_mark:
Cache.Keys	key_pattern:optclient:opt			:heavy_check_mark:
Cache.LastRun	keyclient:opt			:heavy_check_mark:
Cache.ScheduleKeys	keyclient:opt			:heavy_check_mark:
Cache.SendTo	keyvalueclient:opt			:heavy_check_mark:
Cache.SetRunTime	keywhenclient:opt			:heavy_check_mark:
Data.CreateObject	keysvalues			:heavy_check_mark:
Database.Server.Client				:heavy_check_mark:
Database.Server.Query				:heavy_check_mark:
Database.Snowflake.Client				:heavy_check_mark:
Database.Snowflake.Destroy				:heavy_check_mark:
Database.Snowflake.Query				:heavy_check_mark:
Database.PrepareStatement				:heavy_check_mark:
Database.Query				:heavy_check_mark:
Date.Parse	date
FileSystem.EnsureLocation	location			:heavy_check_mark:
FileSystem.Write	location:optfilenamecontentthrottle:opt			:heavy_check_mark:
Sleep	interval			:heavy_check_mark:
Sort.Ascend	aValuebValue
Sort.Descend	aValuebValue
Uuid.CheckV4	identifier			:heavy_check_mark:
Uuid.CreateV4				:heavy_check_mark:

Typescript definitions

Types

Parent	Name	Description
ANZCTR	Study
CTG	AnnotationSection
CTG	DerivedSection
CTG	DocumentSection
CTG	PageResponse
CTG	ProtocolSection
CTG	ResultSection
CTG	Study
OHMR	Base.Metadata
OHMR	Application.Base
OHMR	Application.Approver
OHMR	Application.Document
OHMR	Application.Identifier
OHMR	Application.Milestone
OHMR	Application.Submitter
OHMR	Application.Status
OHMR	Application.Type
OHMR	Application.Entity
OHMR	Column.Base
OHMR	Column.Name
OHMR	Column.Detail
OHMR	Column.Domain
OHMR	Column.Entity
OHMR	Committee.Base
OHMR	Document.Base
OHMR	Domain.Base
OHMR	Organisation.Base
OHMR	Person.Base
OHMR	Site.Base
OHMR	Source.Base
OHMR	Study.Base
OHMR	Table.Base
OHMR	Unit.Base
ORCID

Enums

Parent	Name	Description
ANZCTR	TimeField
ANZCTR	Gender
ANZCTR	StudyPurpose
ANZCTR	StudyPhase
ANZCTR	StudyAgeGroup
ANZCTR	StudyInterventionCode
ANZCTR	StudyConditionCategory
ANZCTR	StudyRecruitmentStatus
ANZCTR	StudyRecruitmentState
ANZCTR	StudyRecruitmentCountry
ANZCTR	StudyRecruitmentCountry
Common	HttpMethod
Common	QueryParam
CTG	AnnotationSection
CTG	DerivedSection
CTG	DocumentSection
CTG	PageResponse
CTG	ProtocolSection
CTG	ResultSection
CTG	Study
OHMR	Indicator
OHMR	AddressType
OHMR	ApplicationDocumentType
OHMR	ApplicationIdentifierType
OHMR	ApplicationMilestoneType
OHMR	ApplicationStatusType
OHMR	ApplicationTypeType
OHMR	CommitteeIdentifierType
OHMR	CommitteeMemberType
OHMR	CommitteeNameType
OHMR	CommitteeTypeType
OHMR	ContactType
OHMR	DetailType
OHMR	DocumentType
OHMR	PersonAffiliationType
OHMR	PersonIdentifierType
OHMR	PersonNameType
OHMR	PersonSalutationType
OHMR	OrganisationAffiliationType
OHMR	OrganisationIdentifierType
OHMR	OrganisationNameType
OHMR	OrganisationTypeType
OHMR	SiteDocumentType
OHMR	SiteIdentifierType
OHMR	SiteMilestoneType
OHMR	SiteTeamType
OHMR	SourceIdentifierType
OHMR	StudyClassType
OHMR	StudyDesignType
OHMR	StudyDocumentType
OHMR	StudyIdentifierType
OHMR	StudyMilestoneType
OHMR	StudyRiskType
OHMR	StudySpecialtyType
OHMR	StudySponsorType
OHMR	StudyStatusType
OHMR	StudyTagType
OHMR	StudyTeamType
OHMR	StudyTitleType
OHMR	StudyTypeType
OHMR	UnitIdentifierType
OHMR	UnitNameType
OHMR	UnitRoleType
OHMR	UnitTypeType
ORCID

Constants

Parent	Name	Description
OHMR	MetadataFields	The list of keys that are metadata available in each database table
OHMR	RemoveFields	The list of keys that should be removed when performing updates in the database