Terminology API (1.0)

Download OpenAPI specification:Download

The Terminology Service HTTP API

Cache

/api/util/Cache/allcachekeys

query Parameters

api-version

string

Default: "1.0"

The requested API version

Responses

Response samples

200
404
410

Content type

text/plain

No sample

/api/util/Cache/clearcache

query Parameters

api-version

string

Default: "1.0"

The requested API version

Responses

Response samples

404
410

Content type

text/plain

No sample

/api/util/Cache/cacheserverstatus

query Parameters

api-version

string

Default: "1.0"

The requested API version

Responses

Response samples

404
410

Content type

text/plain

No sample

/api/util/Cache/clearcache/{key}

path Parameters

key

required

string

query Parameters

api-version

string

Default: "1.0"

The requested API version

Responses

Response samples

200
404
410

Content type

text/plain

No sample

/api/util/Cache/reloadcache

query Parameters

api-version

string

Default: "1.0"

The requested API version

Responses

Response samples

404
410

Content type

text/plain

No sample

/api/util/Cache/reloadcache/{key}

path Parameters

key

required

string

query Parameters

api-version

string

Default: "1.0"

The requested API version

Responses

Response samples

200
404
410

Content type

text/plain

No sample

/api/util/Cache/cacheformularydetailruleboundbycode

query Parameters

api-version

string

Default: "1.0"

The requested API version

Responses

Response samples

404
410

Content type

text/plain

No sample

/api/util/Cache/cacheactiveformularydetailruleboundforcodes

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

404
410

Content type

text/plain

No sample

/api/util/Cache/flushcacheeactiveformularydetailruleboundforcodes/{allactive}

path Parameters

allactive

required

string

Default: "False"

query Parameters

allactive	boolean Default: false
api-version	string Default: "1.0" The requested API version

Request Body schema:
application/json

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

404
410

Content type

text/plain

No sample

/api/util/Cache/reloadlookupcache

query Parameters

api-version

string

Default: "1.0"

The requested API version

Responses

Response samples

404
410

Content type

text/plain

No sample

Configuration

/api/util/Configuration/getconfiguration/{configName}

path Parameters

configName

required

string

query Parameters

api-version

string

Default: "1.0"

The requested API version

Responses

Response samples

200
404
410

Content type

text/plain

No sample

/api/util/Configuration/saveconfiguration

query Parameters

api-version

string

Default: "1.0"

The requested API version

Responses

Response samples

200
404
410

Content type

text/plain

No sample

Formulary

/api/Formulary/searchformularies

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

header Parameters

sortByStat	boolean Default: true
considerOnlyActive	boolean Default: true

Request Body schema:
application/json

searchTerm	string or null
hideArchived	boolean or null
recStatusCds	Array of strings or null
formularyStatusCd	Array of strings or null
	object (CategoryDiffenceFilter)
flags	Array of strings or null
showOnlyDuplicate	boolean or null
includeDeleted	boolean or null
source	string or null
productType	string or null
includeChangeDetails	boolean
includeInvalid	boolean or null

Responses

Request samples

Payload

Content type

application/json

{"searchTerm": "string",
"hideArchived": true,
"recStatusCds": ["string"
],
"formularyStatusCd": ["string"
],
"categoryDifference": {"isDetailChanged": true,
"isPosologyChanged": true,
"isGuidanceChanged": true,
"isFlagsChanged": true,
"isInvalid": true,
"isDeleted": true
},
"flags": ["string"
],
"showOnlyDuplicate": true,
"includeDeleted": true,
"source": "string",
"productType": "string",
"includeChangeDetails": true,
"includeInvalid": true
}

Response samples

200
404
410

Content type

text/plain

No sample

/api/Formulary/getformularychangelogforcodes

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

200
404
410

Content type

text/plain

No sample

/api/Formulary/getformularychangelogforcodeswithchangedetailonly

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

200
404
410

Content type

text/plain

No sample

/api/Formulary/searchformulariesaslist

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

searchTerm	string or null
hideArchived	boolean or null
recStatusCds	Array of strings or null
formularyStatusCd	Array of strings or null
	object (CategoryDiffenceFilter)
flags	Array of strings or null
showOnlyDuplicate	boolean or null
includeDeleted	boolean or null
source	string or null
productType	string or null
includeChangeDetails	boolean
includeInvalid	boolean or null

Responses

Request samples

Payload

Content type

application/json

{"searchTerm": "string",
"hideArchived": true,
"recStatusCds": ["string"
],
"formularyStatusCd": ["string"
],
"categoryDifference": {"isDetailChanged": true,
"isPosologyChanged": true,
"isGuidanceChanged": true,
"isFlagsChanged": true,
"isInvalid": true,
"isDeleted": true
},
"flags": ["string"
],
"showOnlyDuplicate": true,
"includeDeleted": true,
"source": "string",
"productType": "string",
"includeChangeDetails": true,
"includeInvalid": true
}

Response samples

200
404
410

Content type

text/plain

No sample

/api/Formulary/getlatestformulariesheaderonly

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Responses

Response samples

404

Content type

text/plain

No sample

/api/Formulary/getlatestformulariesheaderonlybynameorcode

Authorizations:

oauth2

query Parameters

nameOrCode	string
productType	string
isExactSearch	boolean Default: false
api-version	string Default: "1.0" The requested API version

Responses

Response samples

404

Content type

text/plain

No sample

/api/Formulary/getlatesttoplevelformulariesbasicinfo

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Responses

Response samples

404

Content type

text/plain

No sample

/api/Formulary/getformulariesasdiluents

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Responses

Response samples

200
404
410

Content type

text/plain

No sample

/api/Formulary/getdescendentformulariesforcodes

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

codes	Array of strings or null
onlyNonDeleted	boolean

Responses

Request samples

Payload

Content type

application/json

{"codes": ["string"
],
"onlyNonDeleted": true
}

Response samples

200
404

Content type

text/plain

No sample

/api/Formulary/getimmediatedescendentformulariesforformularyversionids

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

formularyVersionIds	Array of strings or null
onlyNonDeleted	boolean

Responses

Request samples

Payload

Content type

application/json

{"formularyVersionIds": ["string"
],
"onlyNonDeleted": true
}

Response samples

200
404

Content type

text/plain

No sample

/api/Formulary/updatestatus

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

Array of objects or null (UpdateFormularyRecordStatusRequestData)

Responses

Request samples

Payload

Content type

application/json

{"requestData": [{"formularyVersionId": "string",
"recordStatusCode": "string",
"recordStatusCodeChangeMsg": "string"
}
]
}

Response samples

200
404

Content type

text/plain

No sample

/api/Formulary/bulkupdatestatus

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

Array of objects or null (UpdateFormularyRecordStatusRequestData)

Responses

Request samples

Payload

Content type

application/json

{"requestData": [{"formularyVersionId": "string",
"recordStatusCode": "string",
"recordStatusCodeChangeMsg": "string"
}
]
}

Response samples

200
404

Content type

text/plain

No sample

/api/Formulary/create

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

Array of objects or null (FormularyDTO)

Responses

Request samples

Payload

Content type

application/json

{"requestsData": [{"rowId": "string",
"createddate": "2019-08-24T14:15:22Z",
"createdby": "string",
"updateddate": "2019-08-24T14:15:22Z",
"updatedby": "string",
"formularyId": "string",
"versionId": 0,
"formularyVersionId": "string",
"code": "string",
"name": "string",
"productType": "string",
"parentCode": "string",
"parentName": "string",
"parentProductType": "string",
"recStatusCode": "string",
"recStatuschangeTs": "2019-08-24T14:15:22Z",
"recStatuschangeDate": "2019-08-24T14:15:22Z",
"recStatuschangeTzname": "string",
"recStatuschangeTzoffset": 0,
"isDuplicate": true,
"recStatuschangeMsg": "string",
"duplicateOfFormularyId": "string",
"isLatest": true,
"recSource": "string",
"vtmId": "string",
"vmpId": "string",
"codeSystem": "string",
"isDmdInvalid": true,
"isDmdDeleted": true,
"parentFormularyId": "string",
"prevCode": "string",
"formularyAdditionalCodes": [{"rowId": "string",
"createddate": "2019-08-24T14:15:22Z",
"createdby": "string",
"formularyVersionId": "string",
"additionalCode": "string",
"additionalCodeOriginal": "string",
"additionalCodeSystem": "string",
"additionalCodeDesc": "string",
"attr1": "string",
"metaJson": "string",
"source": "string",
"codeType": "string",
"isDefault": true,
"dmdCode": "string",
"isFromSibling": true
}
],
"detail": {"rowId": "string",
"createddate": "2019-08-24T14:15:22Z",
"createdby": "string",
"updateddate": "2019-08-24T14:15:22Z",
"updatedby": "string",
"formularyVersionId": "string",
"rnohFormularyStatuscd": "string",
"rnohFormularyStatusDesc": "string",
"outpatientMedicationCd": "string",
"prescribingStatusCd": "string",
"prescribingStatusDesc": "string",
"unlicensedMedicationCd": "string",
"definedDailyDose": "string",
"notForPrn": "string",
"highAlertMedication": "string",
"highAlertMedicationSource": "string",
"ignoreDuplicateWarnings": "string",
"medusaPreparationInstructions": ["string"
],
"criticalDrug": "string",
"controlledDrugCategories": [{"cd": "string",
"desc": "string",
"type": "string",
"isDefault": true,
"recordstatus": 0,
"source": "string",
"additionalProperties": "string"
}
],
"cytotoxic": "string",
"clinicalTrialMedication": "string",
"ivToOral": "string",
"titrationTypes": [{"cd": "string",
"desc": "string",
"type": "string",
"isDefault": true,
"recordstatus": 0,
"source": "string",
"additionalProperties": "string"
}
],
"roundingFactorCd": "string",
"roundingFactorDesc": "string",
"maxDoseNumerator": 0,
"witnessingRequired": "string",
"niceTas": ["string"
],
"basisOfPreferredNameCd": "string",
"basisOfPreferredNameDesc": "string",
"sugarFree": "string",
"glutenFree": "string",
"preservativeFree": "string",
"cfcFree": "string",
"doseFormCd": "string",
"doseFormDesc": "string",
"unitDoseFormSize": 0,
"unitDoseFormUnits": "string",
"unitDoseFormUnitsDesc": "string",
"unitDoseUnitOfMeasureCd": "string",
"unitDoseUnitOfMeasureDesc": "string",
"formCd": "string",
"formDesc": "string",
"tradeFamilyCd": "string",
"tradeFamilyName": "string",
"expensiveMedication": "string",
"blackTriangle": "string",
"blackTriangleSource": "string",
"supplierCd": "string",
"supplierName": "string",
"currentLicensingAuthorityCd": "string",
"currentLicensingAuthorityDesc": "string",
"emaAdditionalMonitoring": "string",
"parallelImport": "string",
"restrictionsOnAvailabilityCd": "string",
"restrictionsOnAvailabilityDesc": "string",
"drugClass": "string",
"restrictionNote": "string",
"sideEffects": [{"cd": "string",
"desc": "string",
"type": "string",
"isDefault": true,
"recordstatus": 0,
"source": "string",
"additionalProperties": "string"
}
],
"cautions": [{"cd": "string",
"desc": "string",
"type": "string",
"isDefault": true,
"recordstatus": 0,
"source": "string",
"additionalProperties": "string"
}
],
"contraIndications": [{"cd": "string",
"desc": "string",
"type": "string",
"isDefault": true,
"recordstatus": 0,
"source": "string",
"additionalProperties": "string"
}
],
"safetyMessages": [{"cd": "string",
"desc": "string",
"type": "string",
"isDefault": true,
"recordstatus": 0,
"source": "string",
"additionalProperties": "string"
}
],
"customWarnings": [{"warning": "string",
"needResponse": true,
"source": "string"
}
],
"reminders": [{"reminder": "string",
"duration": 0,
"active": true,
"source": "string"
}
],
"endorsements": ["string"
],
"licensedUses": [{"cd": "string",
"desc": "string",
"type": "string",
"isDefault": true,
"recordstatus": 0,
"source": "string",
"additionalProperties": "string"
}
],
"unLicensedUses": [{"cd": "string",
"desc": "string",
"type": "string",
"isDefault": true,
"recordstatus": 0,
"source": "string",
"additionalProperties": "string"
}
],
"localLicensedUses": [{"cd": "string",
"desc": "string",
"type": "string",
"isDefault": true,
"recordstatus": 0,
"source": "string",
"additionalProperties": "string"
}
],
"localUnLicensedUses": [{"cd": "string",
"desc": "string",
"type": "string",
"isDefault": true,
"recordstatus": 0,
"source": "string",
"additionalProperties": "string"
}
],
"isBloodProduct": true,
"isDiluent": true,
"isModifiedRelease": true,
"isGastroResistant": true,
"prescribable": true,
"prescribableSource": "string",
"isCustomControlledDrug": true,
"isPrescriptionPrintingRequired": true,
"diluents": [{"cd": "string",
"desc": "string",
"type": "string",
"isDefault": true,
"recordstatus": 0,
"source": "string",
"additionalProperties": "string"
}
],
"isIndicationMandatory": true,
"childFormulations": [{"cd": "string",
"desc": "string",
"type": "string",
"isDefault": true,
"recordstatus": 0,
"source": "string",
"additionalProperties": "string"
}
],
"modifiedReleases": ["string"
]
},
"formularyIngredients": [{"rowId": "string",
"createddate": "2019-08-24T14:15:22Z",
"createdby": "string",
"updateddate": "2019-08-24T14:15:22Z",
"updatedby": "string",
"formularyVersionId": "string",
"ingredientCd": "string",
"ingredientName": "string",
"basisOfPharmaceuticalStrengthCd": "string",
"basisOfPharmaceuticalStrengthDesc": "string",
"strengthValueNumerator": "string",
"strengthValueNumeratorUnitCd": "string",
"strengthValueNumeratorUnitDesc": "string",
"strengthValueDenominator": "string",
"strengthValueDenominatorUnitCd": "string",
"strengthValueDenominatorUnitDesc": "string"
}
],
"formularyRouteDetails": [{"rowId": "string",
"createddate": "2019-08-24T14:15:22Z",
"createdby": "string",
"updateddate": "2019-08-24T14:15:22Z",
"updatedby": "string",
"formularyVersionId": "string",
"routeCd": "string",
"routeDesc": "string",
"routeFieldTypeCd": "string",
"routeFieldTypeDesc": "string",
"source": "string"
}
],
"formularyLocalRouteDetails": [{"rowId": "string",
"createddate": "2019-08-24T14:15:22Z",
"createdby": "string",
"updateddate": "2019-08-24T14:15:22Z",
"updatedby": "string",
"formularyVersionId": "string",
"routeCd": "string",
"routeDesc": "string",
"routeFieldTypeCd": "string",
"routeFieldTypeDesc": "string",
"source": "string"
}
],
"formularyExcipients": [{"rowId": "string",
"createdtimestamp": "2019-08-24T14:15:22Z",
"createddate": "2019-08-24T14:15:22Z",
"createdby": "string",
"timezonename": "string",
"timezoneoffset": 0,
"tenant": "string",
"formularyVersionId": "string",
"ingredientCd": "string",
"strength": "string",
"strengthUnitCd": "string",
"updatedtimestamp": "2019-08-24T14:15:22Z",
"updateddate": "2019-08-24T14:15:22Z",
"updatedby": "string",
"ingredientName": "string",
"strengthUnitDesc": "string"
}
],
"validationResult": {"statusCode": 0,
"statusMessage": "string",
"errors": ["string"
]
}
}
]
}

Response samples

200
404

Content type

text/plain

No sample

/api/Formulary/update

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

Array of objects or null (FormularyDTO)

Responses

Request samples

Payload

Content type

application/json

{"requestsData": [{"rowId": "string",
"createddate": "2019-08-24T14:15:22Z",
"createdby": "string",
"updateddate": "2019-08-24T14:15:22Z",
"updatedby": "string",
"formularyId": "string",
"versionId": 0,
"formularyVersionId": "string",
"code": "string",
"name": "string",
"productType": "string",
"parentCode": "string",
"parentName": "string",
"parentProductType": "string",
"recStatusCode": "string",
"recStatuschangeTs": "2019-08-24T14:15:22Z",
"recStatuschangeDate": "2019-08-24T14:15:22Z",
"recStatuschangeTzname": "string",
"recStatuschangeTzoffset": 0,
"isDuplicate": true,
"recStatuschangeMsg": "string",
"duplicateOfFormularyId": "string",
"isLatest": true,
"recSource": "string",
"vtmId": "string",
"vmpId": "string",
"codeSystem": "string",
"isDmdInvalid": true,
"isDmdDeleted": true,
"parentFormularyId": "string",
"prevCode": "string",
"formularyAdditionalCodes": [{"rowId": "string",
"createddate": "2019-08-24T14:15:22Z",
"createdby": "string",
"formularyVersionId": "string",
"additionalCode": "string",
"additionalCodeOriginal": "string",
"additionalCodeSystem": "string",
"additionalCodeDesc": "string",
"attr1": "string",
"metaJson": "string",
"source": "string",
"codeType": "string",
"isDefault": true,
"dmdCode": "string",
"isFromSibling": true
}
],
"detail": {"rowId": "string",
"createddate": "2019-08-24T14:15:22Z",
"createdby": "string",
"updateddate": "2019-08-24T14:15:22Z",
"updatedby": "string",
"formularyVersionId": "string",
"rnohFormularyStatuscd": "string",
"rnohFormularyStatusDesc": "string",
"outpatientMedicationCd": "string",
"prescribingStatusCd": "string",
"prescribingStatusDesc": "string",
"unlicensedMedicationCd": "string",
"definedDailyDose": "string",
"notForPrn": "string",
"highAlertMedication": "string",
"highAlertMedicationSource": "string",
"ignoreDuplicateWarnings": "string",
"medusaPreparationInstructions": ["string"
],
"criticalDrug": "string",
"controlledDrugCategories": [{"cd": "string",
"desc": "string",
"type": "string",
"isDefault": true,
"recordstatus": 0,
"source": "string",
"additionalProperties": "string"
}
],
"cytotoxic": "string",
"clinicalTrialMedication": "string",
"ivToOral": "string",
"titrationTypes": [{"cd": "string",
"desc": "string",
"type": "string",
"isDefault": true,
"recordstatus": 0,
"source": "string",
"additionalProperties": "string"
}
],
"roundingFactorCd": "string",
"roundingFactorDesc": "string",
"maxDoseNumerator": 0,
"witnessingRequired": "string",
"niceTas": ["string"
],
"basisOfPreferredNameCd": "string",
"basisOfPreferredNameDesc": "string",
"sugarFree": "string",
"glutenFree": "string",
"preservativeFree": "string",
"cfcFree": "string",
"doseFormCd": "string",
"doseFormDesc": "string",
"unitDoseFormSize": 0,
"unitDoseFormUnits": "string",
"unitDoseFormUnitsDesc": "string",
"unitDoseUnitOfMeasureCd": "string",
"unitDoseUnitOfMeasureDesc": "string",
"formCd": "string",
"formDesc": "string",
"tradeFamilyCd": "string",
"tradeFamilyName": "string",
"expensiveMedication": "string",
"blackTriangle": "string",
"blackTriangleSource": "string",
"supplierCd": "string",
"supplierName": "string",
"currentLicensingAuthorityCd": "string",
"currentLicensingAuthorityDesc": "string",
"emaAdditionalMonitoring": "string",
"parallelImport": "string",
"restrictionsOnAvailabilityCd": "string",
"restrictionsOnAvailabilityDesc": "string",
"drugClass": "string",
"restrictionNote": "string",
"sideEffects": [{"cd": "string",
"desc": "string",
"type": "string",
"isDefault": true,
"recordstatus": 0,
"source": "string",
"additionalProperties": "string"
}
],
"cautions": [{"cd": "string",
"desc": "string",
"type": "string",
"isDefault": true,
"recordstatus": 0,
"source": "string",
"additionalProperties": "string"
}
],
"contraIndications": [{"cd": "string",
"desc": "string",
"type": "string",
"isDefault": true,
"recordstatus": 0,
"source": "string",
"additionalProperties": "string"
}
],
"safetyMessages": [{"cd": "string",
"desc": "string",
"type": "string",
"isDefault": true,
"recordstatus": 0,
"source": "string",
"additionalProperties": "string"
}
],
"customWarnings": [{"warning": "string",
"needResponse": true,
"source": "string"
}
],
"reminders": [{"reminder": "string",
"duration": 0,
"active": true,
"source": "string"
}
],
"endorsements": ["string"
],
"licensedUses": [{"cd": "string",
"desc": "string",
"type": "string",
"isDefault": true,
"recordstatus": 0,
"source": "string",
"additionalProperties": "string"
}
],
"unLicensedUses": [{"cd": "string",
"desc": "string",
"type": "string",
"isDefault": true,
"recordstatus": 0,
"source": "string",
"additionalProperties": "string"
}
],
"localLicensedUses": [{"cd": "string",
"desc": "string",
"type": "string",
"isDefault": true,
"recordstatus": 0,
"source": "string",
"additionalProperties": "string"
}
],
"localUnLicensedUses": [{"cd": "string",
"desc": "string",
"type": "string",
"isDefault": true,
"recordstatus": 0,
"source": "string",
"additionalProperties": "string"
}
],
"isBloodProduct": true,
"isDiluent": true,
"isModifiedRelease": true,
"isGastroResistant": true,
"prescribable": true,
"prescribableSource": "string",
"isCustomControlledDrug": true,
"isPrescriptionPrintingRequired": true,
"diluents": [{"cd": "string",
"desc": "string",
"type": "string",
"isDefault": true,
"recordstatus": 0,
"source": "string",
"additionalProperties": "string"
}
],
"isIndicationMandatory": true,
"childFormulations": [{"cd": "string",
"desc": "string",
"type": "string",
"isDefault": true,
"recordstatus": 0,
"source": "string",
"additionalProperties": "string"
}
],
"modifiedReleases": ["string"
]
},
"formularyIngredients": [{"rowId": "string",
"createddate": "2019-08-24T14:15:22Z",
"createdby": "string",
"updateddate": "2019-08-24T14:15:22Z",
"updatedby": "string",
"formularyVersionId": "string",
"ingredientCd": "string",
"ingredientName": "string",
"basisOfPharmaceuticalStrengthCd": "string",
"basisOfPharmaceuticalStrengthDesc": "string",
"strengthValueNumerator": "string",
"strengthValueNumeratorUnitCd": "string",
"strengthValueNumeratorUnitDesc": "string",
"strengthValueDenominator": "string",
"strengthValueDenominatorUnitCd": "string",
"strengthValueDenominatorUnitDesc": "string"
}
],
"formularyRouteDetails": [{"rowId": "string",
"createddate": "2019-08-24T14:15:22Z",
"createdby": "string",
"updateddate": "2019-08-24T14:15:22Z",
"updatedby": "string",
"formularyVersionId": "string",
"routeCd": "string",
"routeDesc": "string",
"routeFieldTypeCd": "string",
"routeFieldTypeDesc": "string",
"source": "string"
}
],
"formularyLocalRouteDetails": [{"rowId": "string",
"createddate": "2019-08-24T14:15:22Z",
"createdby": "string",
"updateddate": "2019-08-24T14:15:22Z",
"updatedby": "string",
"formularyVersionId": "string",
"routeCd": "string",
"routeDesc": "string",
"routeFieldTypeCd": "string",
"routeFieldTypeDesc": "string",
"source": "string"
}
],
"formularyExcipients": [{"rowId": "string",
"createdtimestamp": "2019-08-24T14:15:22Z",
"createddate": "2019-08-24T14:15:22Z",
"createdby": "string",
"timezonename": "string",
"timezoneoffset": 0,
"tenant": "string",
"formularyVersionId": "string",
"ingredientCd": "string",
"strength": "string",
"strengthUnitCd": "string",
"updatedtimestamp": "2019-08-24T14:15:22Z",
"updateddate": "2019-08-24T14:15:22Z",
"updatedby": "string",
"ingredientName": "string",
"strengthUnitDesc": "string"
}
],
"validationResult": {"statusCode": 0,
"statusMessage": "string",
"errors": ["string"
]
}
}
]
}

Response samples

200
404

Content type

text/plain

No sample

/api/Formulary/fileimport

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

Array of objects or null (FormularyDTO)

Responses

Request samples

Payload

Content type

application/json

{"requestsData": [{"rowId": "string",
"createddate": "2019-08-24T14:15:22Z",
"createdby": "string",
"updateddate": "2019-08-24T14:15:22Z",
"updatedby": "string",
"formularyId": "string",
"versionId": 0,
"formularyVersionId": "string",
"code": "string",
"name": "string",
"productType": "string",
"parentCode": "string",
"parentName": "string",
"parentProductType": "string",
"recStatusCode": "string",
"recStatuschangeTs": "2019-08-24T14:15:22Z",
"recStatuschangeDate": "2019-08-24T14:15:22Z",
"recStatuschangeTzname": "string",
"recStatuschangeTzoffset": 0,
"isDuplicate": true,
"recStatuschangeMsg": "string",
"duplicateOfFormularyId": "string",
"isLatest": true,
"recSource": "string",
"vtmId": "string",
"vmpId": "string",
"codeSystem": "string",
"isDmdInvalid": true,
"isDmdDeleted": true,
"parentFormularyId": "string",
"prevCode": "string",
"formularyAdditionalCodes": [{"rowId": "string",
"createddate": "2019-08-24T14:15:22Z",
"createdby": "string",
"formularyVersionId": "string",
"additionalCode": "string",
"additionalCodeOriginal": "string",
"additionalCodeSystem": "string",
"additionalCodeDesc": "string",
"attr1": "string",
"metaJson": "string",
"source": "string",
"codeType": "string",
"isDefault": true,
"dmdCode": "string",
"isFromSibling": true
}
],
"detail": {"rowId": "string",
"createddate": "2019-08-24T14:15:22Z",
"createdby": "string",
"updateddate": "2019-08-24T14:15:22Z",
"updatedby": "string",
"formularyVersionId": "string",
"rnohFormularyStatuscd": "string",
"rnohFormularyStatusDesc": "string",
"outpatientMedicationCd": "string",
"prescribingStatusCd": "string",
"prescribingStatusDesc": "string",
"unlicensedMedicationCd": "string",
"definedDailyDose": "string",
"notForPrn": "string",
"highAlertMedication": "string",
"highAlertMedicationSource": "string",
"ignoreDuplicateWarnings": "string",
"medusaPreparationInstructions": ["string"
],
"criticalDrug": "string",
"controlledDrugCategories": [{"cd": "string",
"desc": "string",
"type": "string",
"isDefault": true,
"recordstatus": 0,
"source": "string",
"additionalProperties": "string"
}
],
"cytotoxic": "string",
"clinicalTrialMedication": "string",
"ivToOral": "string",
"titrationTypes": [{"cd": "string",
"desc": "string",
"type": "string",
"isDefault": true,
"recordstatus": 0,
"source": "string",
"additionalProperties": "string"
}
],
"roundingFactorCd": "string",
"roundingFactorDesc": "string",
"maxDoseNumerator": 0,
"witnessingRequired": "string",
"niceTas": ["string"
],
"basisOfPreferredNameCd": "string",
"basisOfPreferredNameDesc": "string",
"sugarFree": "string",
"glutenFree": "string",
"preservativeFree": "string",
"cfcFree": "string",
"doseFormCd": "string",
"doseFormDesc": "string",
"unitDoseFormSize": 0,
"unitDoseFormUnits": "string",
"unitDoseFormUnitsDesc": "string",
"unitDoseUnitOfMeasureCd": "string",
"unitDoseUnitOfMeasureDesc": "string",
"formCd": "string",
"formDesc": "string",
"tradeFamilyCd": "string",
"tradeFamilyName": "string",
"expensiveMedication": "string",
"blackTriangle": "string",
"blackTriangleSource": "string",
"supplierCd": "string",
"supplierName": "string",
"currentLicensingAuthorityCd": "string",
"currentLicensingAuthorityDesc": "string",
"emaAdditionalMonitoring": "string",
"parallelImport": "string",
"restrictionsOnAvailabilityCd": "string",
"restrictionsOnAvailabilityDesc": "string",
"drugClass": "string",
"restrictionNote": "string",
"sideEffects": [{"cd": "string",
"desc": "string",
"type": "string",
"isDefault": true,
"recordstatus": 0,
"source": "string",
"additionalProperties": "string"
}
],
"cautions": [{"cd": "string",
"desc": "string",
"type": "string",
"isDefault": true,
"recordstatus": 0,
"source": "string",
"additionalProperties": "string"
}
],
"contraIndications": [{"cd": "string",
"desc": "string",
"type": "string",
"isDefault": true,
"recordstatus": 0,
"source": "string",
"additionalProperties": "string"
}
],
"safetyMessages": [{"cd": "string",
"desc": "string",
"type": "string",
"isDefault": true,
"recordstatus": 0,
"source": "string",
"additionalProperties": "string"
}
],
"customWarnings": [{"warning": "string",
"needResponse": true,
"source": "string"
}
],
"reminders": [{"reminder": "string",
"duration": 0,
"active": true,
"source": "string"
}
],
"endorsements": ["string"
],
"licensedUses": [{"cd": "string",
"desc": "string",
"type": "string",
"isDefault": true,
"recordstatus": 0,
"source": "string",
"additionalProperties": "string"
}
],
"unLicensedUses": [{"cd": "string",
"desc": "string",
"type": "string",
"isDefault": true,
"recordstatus": 0,
"source": "string",
"additionalProperties": "string"
}
],
"localLicensedUses": [{"cd": "string",
"desc": "string",
"type": "string",
"isDefault": true,
"recordstatus": 0,
"source": "string",
"additionalProperties": "string"
}
],
"localUnLicensedUses": [{"cd": "string",
"desc": "string",
"type": "string",
"isDefault": true,
"recordstatus": 0,
"source": "string",
"additionalProperties": "string"
}
],
"isBloodProduct": true,
"isDiluent": true,
"isModifiedRelease": true,
"isGastroResistant": true,
"prescribable": true,
"prescribableSource": "string",
"isCustomControlledDrug": true,
"isPrescriptionPrintingRequired": true,
"diluents": [{"cd": "string",
"desc": "string",
"type": "string",
"isDefault": true,
"recordstatus": 0,
"source": "string",
"additionalProperties": "string"
}
],
"isIndicationMandatory": true,
"childFormulations": [{"cd": "string",
"desc": "string",
"type": "string",
"isDefault": true,
"recordstatus": 0,
"source": "string",
"additionalProperties": "string"
}
],
"modifiedReleases": ["string"
]
},
"formularyIngredients": [{"rowId": "string",
"createddate": "2019-08-24T14:15:22Z",
"createdby": "string",
"updateddate": "2019-08-24T14:15:22Z",
"updatedby": "string",
"formularyVersionId": "string",
"ingredientCd": "string",
"ingredientName": "string",
"basisOfPharmaceuticalStrengthCd": "string",
"basisOfPharmaceuticalStrengthDesc": "string",
"strengthValueNumerator": "string",
"strengthValueNumeratorUnitCd": "string",
"strengthValueNumeratorUnitDesc": "string",
"strengthValueDenominator": "string",
"strengthValueDenominatorUnitCd": "string",
"strengthValueDenominatorUnitDesc": "string"
}
],
"formularyRouteDetails": [{"rowId": "string",
"createddate": "2019-08-24T14:15:22Z",
"createdby": "string",
"updateddate": "2019-08-24T14:15:22Z",
"updatedby": "string",
"formularyVersionId": "string",
"routeCd": "string",
"routeDesc": "string",
"routeFieldTypeCd": "string",
"routeFieldTypeDesc": "string",
"source": "string"
}
],
"formularyLocalRouteDetails": [{"rowId": "string",
"createddate": "2019-08-24T14:15:22Z",
"createdby": "string",
"updateddate": "2019-08-24T14:15:22Z",
"updatedby": "string",
"formularyVersionId": "string",
"routeCd": "string",
"routeDesc": "string",
"routeFieldTypeCd": "string",
"routeFieldTypeDesc": "string",
"source": "string"
}
],
"formularyExcipients": [{"rowId": "string",
"createdtimestamp": "2019-08-24T14:15:22Z",
"createddate": "2019-08-24T14:15:22Z",
"createdby": "string",
"timezonename": "string",
"timezoneoffset": 0,
"tenant": "string",
"formularyVersionId": "string",
"ingredientCd": "string",
"strength": "string",
"strengthUnitCd": "string",
"updatedtimestamp": "2019-08-24T14:15:22Z",
"updateddate": "2019-08-24T14:15:22Z",
"updatedby": "string",
"ingredientName": "string",
"strengthUnitDesc": "string"
}
],
"validationResult": {"statusCode": 0,
"statusMessage": "string",
"errors": ["string"
]
}
}
]
}

Response samples

200
404

Content type

text/plain

No sample

/api/Formulary/getformularydetailrulebound/{id}

Authorizations:

oauth2

path Parameters

id

required

string

query Parameters

getAllAdditionalCodes	boolean
api-version	string Default: "1.0" The requested API version

Responses

Response samples

200
404
410

Content type

text/plain

No sample

/api/Formulary/getformularydetailruleboundforids/{getAllAdditionalCodes}

Authorizations:

oauth2

path Parameters

getAllAdditionalCodes

required

boolean

Default: false

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

200
404
410

Content type

text/plain

No sample

/api/Formulary/getformularyheaderonlyforfvids

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

200
404
410

Content type

text/plain

No sample

/api/Formulary/getformularydetailruleboundbycode/{code}

Authorizations:

oauth2

path Parameters

code

required

string

query Parameters

api-version

string

Default: "1.0"

The requested API version

header Parameters

fromCache	boolean Default: true
includeInvalid	boolean Default: false

Responses

Response samples

200
404
410

Content type

text/plain

No sample

/api/Formulary/getformularydetailruleboundbycodes

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

header Parameters

fromCache	boolean Default: true
includeInvalid	boolean Default: false

Request Body schema:
application/json

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

200
404
410

Content type

text/plain

No sample

/api/Formulary/getformularybasicdetailruleboundbycodes

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

header Parameters

fromCache	boolean Default: true
includeInvalid	boolean Default: false

Request Body schema:
application/json

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

200
404
410

Content type

text/plain

No sample

/api/Formulary/deriveproductnames

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

	Array of objects or null (FormularyIngredientDTO)
unitDoseFormSize	string or null
formulationName	string or null
supplierName	string or null
productType	string or null

Responses

Request samples

Payload

Content type

application/json

{"ingredients": [{"rowId": "string",
"createddate": "2019-08-24T14:15:22Z",
"createdby": "string",
"updateddate": "2019-08-24T14:15:22Z",
"updatedby": "string",
"formularyVersionId": "string",
"ingredientCd": "string",
"ingredientName": "string",
"basisOfPharmaceuticalStrengthCd": "string",
"basisOfPharmaceuticalStrengthDesc": "string",
"strengthValueNumerator": "string",
"strengthValueNumeratorUnitCd": "string",
"strengthValueNumeratorUnitDesc": "string",
"strengthValueDenominator": "string",
"strengthValueDenominatorUnitCd": "string",
"strengthValueDenominatorUnitDesc": "string"
}
],
"unitDoseFormSize": "string",
"formulationName": "string",
"supplierName": "string",
"productType": "string"
}

Response samples

200
404

Content type

text/plain

No sample

/api/Formulary/checkifproductexists

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

	Array of objects or null (FormularyIngredientDTO)
unitDoseFormSize	string or null
formulationName	string or null
supplierName	string or null
productType	string or null

Responses

Request samples

Payload

Content type

application/json

{"ingredients": [{"rowId": "string",
"createddate": "2019-08-24T14:15:22Z",
"createdby": "string",
"updateddate": "2019-08-24T14:15:22Z",
"updatedby": "string",
"formularyVersionId": "string",
"ingredientCd": "string",
"ingredientName": "string",
"basisOfPharmaceuticalStrengthCd": "string",
"basisOfPharmaceuticalStrengthDesc": "string",
"strengthValueNumerator": "string",
"strengthValueNumeratorUnitCd": "string",
"strengthValueNumeratorUnitDesc": "string",
"strengthValueDenominator": "string",
"strengthValueDenominatorUnitCd": "string",
"strengthValueDenominatorUnitDesc": "string"
}
],
"unitDoseFormSize": "string",
"formulationName": "string",
"supplierName": "string",
"productType": "string"
}

Response samples

200
404

Content type

text/plain

No sample

/api/Formulary/gethistoryofformularies

Authorizations:

oauth2

query Parameters

PageNo	integer <int32>
PageSize	integer <int32>
	Array of objects (StringStringKeyValuePair)
FilterParams	string
NeedTotalRecords	boolean
api-version	string Default: "1.0" The requested API version

Responses

Response samples

200
404

Content type

text/plain

No sample

/api/Formulary/getlocallicenseduse

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

200
404

Content type

text/plain

No sample

/api/Formulary/getlocalunlicenseduse

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

200
404

Content type

text/plain

No sample

/api/Formulary/getlocallicensedroute

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

200
404

Content type

text/plain

No sample

/api/Formulary/getlocalunlicensedroute

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

200
404

Content type

text/plain

No sample

/api/Formulary/getcustomwarning

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

200
404

Content type

text/plain

No sample

/api/Formulary/getreminder

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

200
404

Content type

text/plain

No sample

/api/Formulary/getendorsement

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

200
404

Content type

text/plain

No sample

/api/Formulary/getmedusapreparationinstruction

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

200
404

Content type

text/plain

No sample

/api/Formulary/gettitrationtype

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

200
404

Content type

text/plain

No sample

/api/Formulary/getroundingfactor

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

200
404

Content type

text/plain

No sample

/api/Formulary/getcompatiblediluent

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

200
404

Content type

text/plain

No sample

/api/Formulary/getclinicaltrialmedication

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

200
404

Content type

text/plain

No sample

/api/Formulary/getgastroresistant

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

200
404

Content type

text/plain

No sample

/api/Formulary/getcriticaldrug

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

200
404

Content type

text/plain

No sample

/api/Formulary/getmodifiedrelease

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

200
404

Content type

text/plain

No sample

/api/Formulary/getexpensivemedication

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

200
404

Content type

text/plain

No sample

/api/Formulary/gethighalertmedication

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

200
404

Content type

text/plain

No sample

/api/Formulary/getivtooral

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

200
404

Content type

text/plain

No sample

/api/Formulary/getnotforprn

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

200
404

Content type

text/plain

No sample

/api/Formulary/getbloodproduct

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

200
404

Content type

text/plain

No sample

/api/Formulary/getdiluent

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

200
404

Content type

text/plain

No sample

/api/Formulary/getprescribable

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

200
404

Content type

text/plain

No sample

/api/Formulary/getoutpatientmedication

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

200
404

Content type

text/plain

No sample

/api/Formulary/getignoreduplicatewarning

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

200
404

Content type

text/plain

No sample

/api/Formulary/getcontrolleddrug

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

200
404

Content type

text/plain

No sample

/api/Formulary/getprescriptionprintingrequired

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

200
404

Content type

text/plain

No sample

/api/Formulary/getindicationmandatory

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

200
404

Content type

text/plain

No sample

/api/Formulary/getwitnessingrequired

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

200
404

Content type

text/plain

No sample

/api/Formulary/getformularystatus

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

200
404

Content type

text/plain

No sample

/api/Formulary/GetActiveFormularyCodes

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

200
404
410

Content type

text/plain

No sample

/api/Formulary/validateampstatuschange

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

Array of objects or null (ValidateFormularyStatusChangeRequestData)

Responses

Request samples

Payload

Content type

application/json

{"requestsData": [{"formularyVersionId": "string",
"formularyId": "string",
"recordStatusCode": "string",
"recordStatusCodeChangeMsg": "string"
}
]
}

Response samples

200
404

Content type

text/plain

No sample

/api/Formulary/getheaderrecordslock

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

200
400

Content type

text/plain

No sample

/api/Formulary/tryreleaseheaderrecordslock

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

400

Content type

text/plain

No sample

/api/Formulary/hasanyupdateinprogess

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Responses

Response samples

200

Content type

text/plain

No sample

/api/Formulary/localroutesforids

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

formularyVersionIds	Array of strings or null
routeFieldTypeCd	string or null

Responses

Request samples

Payload

Content type

application/json

{"formularyVersionIds": ["string"
],
"routeFieldTypeCd": "string"
}

Response samples

200

Content type

text/plain

No sample

/api/Formulary/routesforids

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

formularyVersionIds	Array of strings or null
routeFieldTypeCd	string or null

Responses

Request samples

Payload

Content type

application/json

{"formularyVersionIds": ["string"
],
"routeFieldTypeCd": "string"
}

Response samples

200

Content type

text/plain

No sample

/api/Formulary/import

Authorizations:

oauth2

query Parameters

formularyStatusCd	string Default: "002"
recordStatusCd	string Default: "001"
api-version	string Default: "1.0" The requested API version

Request Body schema:
application/json

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

200
404
410

Content type

text/plain

No sample

/api/Formulary/importalldmdcodes

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Responses

Response samples

200
404
410

Content type

text/plain

No sample

/api/Formulary/invokepostimportprocess

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

404
410

Content type

text/plain

No sample

/api/Formulary/importdeltas

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Responses

Response samples

404
410

Content type

text/plain

No sample

/api/Formulary/getrecordstatuslookup

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Responses

Response samples

200
404
410

Content type

text/plain

No sample

/api/Formulary/getformularystatuslookup

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Responses

Response samples

200
404
410

Content type

text/plain

No sample

/api/Formulary/gettitrationtypelookup

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Responses

Response samples

200
404
410

Content type

text/plain

No sample

/api/Formulary/getroundingfactorlookup

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Responses

Response samples

200
404
410

Content type

text/plain

No sample

/api/Formulary/getproducttypelookup

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Responses

Response samples

200
404
410

Content type

text/plain

No sample

/api/Formulary/getclassificationcodetypelookup

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Responses

Response samples

200
404
410

Content type

text/plain

No sample

/api/Formulary/getidentificationcodetypelookup

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Responses

Response samples

200
404
410

Content type

text/plain

No sample

/api/Formulary/getroutefieldtypelookup

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Responses

Response samples

200
404
410

Content type

text/plain

No sample

/api/Formulary/getformularyidorderinfolookup

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

200
404

Content type

text/plain

No sample

/api/Formulary/ChangeFDBDataSchema

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Responses

Response samples

200

Content type

text/plain

No sample

/api/Formulary/getusagestats

Authorizations:

oauth2

query Parameters

searchText	string
source	string
api-version	string Default: "1.0" The requested API version

Responses

Response samples

200
404
410

Content type

text/plain

No sample

/api/Formulary/saveusagestat

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

Array

name	string or null
fullName	string or null
code	string or null
formularyId	string or null
source	string or null

Responses

Request samples

Payload

Content type

application/json

[{"name": "string",
"fullName": "string",
"code": "string",
"formularyId": "string",
"source": "string"
}
]

FormularyUtil

/api/FormularyUtil/seedusagestats

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Responses

/api/FormularyUtil/FixExistingLocalAndUnlicensedIndications

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Responses

/api/FormularyUtil/FixExistingFDBCodesByDescription

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Responses

/api/FormularyUtil/UpdateExistingBNFCodesFromVMPTOAMPs

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Responses

/api/FormularyUtil/UpdateExistingFDBCodes

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Responses

/api/FormularyUtil/UpdateDefaultBNFClassification

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Responses

/api/FormularyUtil/UpdateBNFClassificationDescription

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Responses

/api/FormularyUtil/AddBNFClassificationsInHierarchy

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Responses

Home

/

query Parameters

api-version

string

Default: "1.0"

The requested API version

Responses

Terminology

/api/Terminology/searchdmd

query Parameters

q	string
api-version	string Default: "1.0" The requested API version

Responses

Response samples

200
404
410

Content type

text/plain

No sample

/api/Terminology/searchdmdwithalldescendents

query Parameters

q	string
api-version	string Default: "1.0" The requested API version

Responses

Response samples

200
404
410

Content type

text/plain

No sample

/api/Terminology/searchdmdsyncLog

query Parameters

q	string
api-version	string Default: "1.0" The requested API version

Responses

Response samples

200
404
410

Content type

text/plain

No sample

/api/Terminology/searchdmdwithallnodes

query Parameters

q	string
api-version	string Default: "1.0" The requested API version

Responses

Response samples

200
404
410

Content type

text/plain

No sample

/api/Terminology/getdmddescendent

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

200
404
410

Content type

text/plain

No sample

/api/Terminology/getdmdancestor

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

200
404
410

Content type

text/plain

No sample

/api/Terminology/searchdmdwithtopnodes

query Parameters

q	string
api-version	string Default: "1.0" The requested API version

Responses

Response samples

200
404
410

Content type

text/plain

No sample

/api/Terminology/getalldmdcodes

query Parameters

api-version

string

Default: "1.0"

The requested API version

Responses

Response samples

404

Content type

text/plain

No sample

/api/Terminology/getdmdsnomedversion

query Parameters

api-version

string

Default: "1.0"

The requested API version

Responses

Response samples

404
410

Content type

text/plain

No sample

/api/Terminology/getdmdfulldataforcodes

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

200
404
410

Content type

text/plain

No sample

/api/Terminology/getampexcipientsforcodes

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

200
404
410

Content type

text/plain

No sample

/api/Terminology/getampdrugroutesforcodes

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

200
404
410

Content type

text/plain

No sample

/api/Terminology/getvmpdrugroutesforcodes

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

200
404
410

Content type

text/plain

No sample

/api/Terminology/gettopdmdsynclog

query Parameters

api-version

string

Default: "1.0"

The requested API version

Responses

Response samples

200
404
410

Content type

text/plain

No sample

/api/Terminology/getdmdpendingsynclogs

query Parameters

api-version

string

Default: "1.0"

The requested API version

Responses

Response samples

200
404
410

Content type

text/plain

No sample

/api/Terminology/getdmdpendingsynclogsbypagination/{pageNo}/{pageSize}

path Parameters

pageNo required	integer <int32>
pageSize required	integer <int32>

query Parameters

api-version

string

Default: "1.0"

The requested API version

Responses

Response samples

200
404
410

Content type

text/plain

No sample

/api/Terminology/updateformularysyncstatus

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

404
410

Content type

text/plain

No sample

/api/Terminology/updateformularysyncstatusforallrecords

query Parameters

api-version

string

Default: "1.0"

The requested API version

Responses

Response samples

404
410

Content type

text/plain

No sample

/api/Terminology/getdmdroutelookup

query Parameters

ignoreCacheSource	boolean Default: false
api-version	string Default: "1.0" The requested API version

Responses

Response samples

200
404
410

Content type

text/plain

No sample

/api/Terminology/getdmdformlookup

query Parameters

ignoreCacheSource	boolean Default: false
api-version	string Default: "1.0" The requested API version

Responses

Response samples

200
404
410

Content type

text/plain

No sample

/api/Terminology/getdmdprescribingstatuslookup

query Parameters

ignoreCacheSource	boolean Default: false
api-version	string Default: "1.0" The requested API version

Responses

Response samples

200
404
410

Content type

text/plain

No sample

/api/Terminology/getdmdcontroldrugcategorylookup

query Parameters

ignoreCacheSource	boolean Default: false
api-version	string Default: "1.0" The requested API version

Responses

Response samples

200
404
410

Content type

text/plain

No sample

/api/Terminology/getdmdsupplierlookup

query Parameters

ignoreCacheSource	boolean Default: false
api-version	string Default: "1.0" The requested API version

Responses

Response samples

200
404
410

Content type

text/plain

No sample

/api/Terminology/getdmdlicensingauthoritylookup

query Parameters

ignoreCacheSource	boolean Default: false
api-version	string Default: "1.0" The requested API version

Responses

Response samples

200
404
410

Content type

text/plain

No sample

/api/Terminology/getdmduomlookup

query Parameters

ignoreCacheSource	boolean Default: false
api-version	string Default: "1.0" The requested API version

Responses

Response samples

200
404
410

Content type

text/plain

No sample

/api/Terminology/getdmdontformroutelookup

query Parameters

ignoreCacheSource	boolean Default: false
api-version	string Default: "1.0" The requested API version

Responses

Response samples

200
404
410

Content type

text/plain

No sample

/api/Terminology/getdmdbasisofnamelookup

query Parameters

ignoreCacheSource	boolean Default: false
api-version	string Default: "1.0" The requested API version

Responses

Response samples

200
404
410

Content type

text/plain

No sample

/api/Terminology/getdmdavailrestrictionslookup

query Parameters

ignoreCacheSource	boolean Default: false
api-version	string Default: "1.0" The requested API version

Responses

Response samples

200
404
410

Content type

text/plain

No sample

/api/Terminology/getdmddoseformlookup

query Parameters

ignoreCacheSource	boolean Default: false
api-version	string Default: "1.0" The requested API version

Responses

Response samples

200
404
410

Content type

text/plain

No sample

/api/Terminology/getdmdpharamceuticalstrengthlookup

query Parameters

ignoreCacheSource	boolean Default: false
api-version	string Default: "1.0" The requested API version

Responses

Response samples

200
404
410

Content type

text/plain

No sample

/api/Terminology/getdmdingredientlookup

query Parameters

ignoreCacheSource	boolean Default: false
api-version	string Default: "1.0" The requested API version

Responses

Response samples

200
404
410

Content type

text/plain

No sample

/api/Terminology/getatclookup

query Parameters

ignoreCacheSource	boolean Default: false
api-version	string Default: "1.0" The requested API version

Responses

Response samples

200
404
410

Content type

text/plain

No sample

/api/Terminology/getbnflookup

query Parameters

ignoreCacheSource	boolean Default: false
api-version	string Default: "1.0" The requested API version

Responses

Response samples

200
404
410

Content type

text/plain

No sample

/api/Terminology/getallatccodesfromdmd

query Parameters

ignoreCacheSource	boolean Default: false
api-version	string Default: "1.0" The requested API version

Responses

Response samples

200
404
410

Content type

text/plain

No sample

/api/Terminology/getallbnfcodesfromdmd

query Parameters

ignoreCacheSource	boolean Default: false
api-version	string Default: "1.0" The requested API version

Responses

Response samples

200
404
410

Content type

text/plain

No sample

/api/Terminology/snomedsemantics

query Parameters

api-version

string

Default: "1.0"

The requested API version

Responses

Response samples

200
404
410

Content type

text/plain

No sample

/api/Terminology/searchsnomed/{q}/{semanticTag}

path Parameters

q required	string
semanticTag required	string

query Parameters

api-version

string

Default: "1.0"

The requested API version

Responses

Response samples

200
404
410

Content type

text/plain

No sample

/api/Terminology/searchsnomed

query Parameters

q	string
semanticTag	string
api-version	string Default: "1.0" The requested API version

Responses

Response samples

200
404
410

Content type

text/plain

No sample

/api/Terminology/searchsnomedwithalldescendents

query Parameters

q	string
semanticTag	string
api-version	string Default: "1.0" The requested API version

Responses

Response samples

200
404
410

Content type

text/plain

No sample

/api/Terminology/getsnomeddescendent

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

200
404
410

Content type

text/plain

No sample

/api/Terminology/getsnomedancestor

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

200
404
410

Content type

text/plain

No sample

/api/Terminology/searchsnomedwithallparentnodes

query Parameters

q	string
semanticTag	string
api-version	string Default: "1.0" The requested API version

Responses

Response samples

200
404
410

Content type

text/plain

No sample

/api/Terminology/searchsnomedwithallnodes

query Parameters

q	string
semanticTag	string
api-version	string Default: "1.0" The requested API version

Responses

Response samples

200
404
410

Content type

text/plain

No sample

/api/Terminology/gettradefamilyforconceptids

query Parameters

api-version

string

Default: "1.0"

The requested API version

header Parameters

ignoreCacheSource

boolean

Default: false

Request Body schema:
application/json

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

200
404
410

Content type

text/plain

No sample

/api/Terminology/getmodifiedreleaseforconceptids

query Parameters

api-version

string

Default: "1.0"

The requested API version

header Parameters

ignoreCacheSource

boolean

Default: false

Request Body schema:
application/json

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

200
404
410

Content type

text/plain

No sample

Terminology API (1.0)

Cache

/api/util/Cache/allcachekeys

query Parameters

Responses

Response samples

/api/util/Cache/clearcache

query Parameters

Responses

Response samples

/api/util/Cache/cacheserverstatus

query Parameters

Responses

Response samples

/api/util/Cache/clearcache/{key}

path Parameters

query Parameters

Responses

Response samples

/api/util/Cache/reloadcache

query Parameters

Responses

Response samples

/api/util/Cache/reloadcache/{key}

path Parameters

query Parameters

Responses

Response samples

/api/util/Cache/cacheformularydetailruleboundbycode

query Parameters

Responses

Response samples

/api/util/Cache/cacheactiveformularydetailruleboundforcodes

query Parameters

Request Body schema: application/jsontext/jsonapplication/*+jsonapplication/json

Responses

Request samples

Response samples

/api/util/Cache/flushcacheeactiveformularydetailruleboundforcodes/{allactive}

path Parameters

query Parameters

Request Body schema: application/jsontext/jsonapplication/*+jsonapplication/json

Responses

Request samples

Response samples

/api/util/Cache/reloadlookupcache

query Parameters

Responses

Response samples

Configuration

/api/util/Configuration/getconfiguration/{configName}

path Parameters

query Parameters

Responses

Response samples

/api/util/Configuration/saveconfiguration

query Parameters

Responses

Response samples

Formulary

/api/Formulary/searchformularies

Authorizations:

query Parameters

header Parameters

Request Body schema: application/jsontext/jsonapplication/*+jsonapplication/json

Responses

Request samples

Response samples

/api/Formulary/getformularychangelogforcodes

Authorizations:

query Parameters

Request Body schema: application/jsontext/jsonapplication/*+jsonapplication/json

Responses

Request samples

Response samples

/api/Formulary/getformularychangelogforcodeswithchangedetailonly

Authorizations:

query Parameters

Request Body schema: application/jsontext/jsonapplication/*+jsonapplication/json

Responses

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json