Calyx RIM 7.1 API Documentation

Comparison Table API changes between Calyx RIM 7.1 and Calyx RIM 7.0

This table describes the API changes between Calyx RIM 7.1 and Calyx RIM 7.0.

Entity Name API/Controller endpoint API 7.1 Updates Description
Attribute Column
License PackageSetTypeRegistrationRestController "/license/packageset-registration" The following field is added:
  • atcFlag
  • column ATC_FLAG
  • size 1
  • values "T", "F", "X" 
<attr name="T">title.license.atcFlag.applied</attr>
<attr name="F">title.license.atcFlag.notApplied</attr>
<attr name="X">title.license.atcFlag.notApplicable</attr>
ProductLicense ProductTypeRegistrationRestController "/license/product-registration" The following field is added:
  • atcFlag
  • column ATC_FLAG
  • size 1
  • values "T", "F", "X" 
<attr name="T">title.license.atcFlag.applied</attr>
<attr name="F">title.license.atcFlag.notApplied</attr>
<attr name="X">title.license.atcFlag.notApplicable</attr>
LicensePackageSet LicensePackageSetController "/license/packageset"

The EU Presentation Number is renamed to Package Set License Code.

euPresentationNumber/EU_PRESENTATION_NUMBER size 100 changed to packageSetLicenseCode/LICENSE_CODE size 100

licenseCode/PACKSET_LICENSE_CODE mapping changed to licenseCode/REGISTRATION_CODE

The following fields are added:
  • legalBasisId
  • authorisationStatusId
  • authorisationStatusDate
  • LEGAL_BASIS_TYPE_ID

    This field is foreign key to: Class name: LegalBasisType

    DB table: ism.legal_basis_type.

  • AUTHORISATION_STATUS_TYPE_ID

    This field is foreign key to: Class name: RegistrationStatus

    DB table: ism.lic_status_type.

  • AUTHORISATION_STATUS_DATE
LicensePackageSetCountry LicensePackageSetCountryRestController "/license/packageset/country" The following fields are added:
  • dataCarrierType
  • dataCarrierIdentifier
  • dataCarrierLanguageId
  • riskOfSupplyShortageFlag
  • riskOfSupplyShortageComment
  • marketingStatusReasonTypeId
  • DATA_CARRIER_TYPE_ID

    This field is foreign key to:

    This field is foreign key to: Class name: DataCarrierType; DB table: ism.data_carrier_type.

  • DATA_CARRIER_IDENTIFIER

    size 100

  • DATA_CARRIER_LANGUAGE_TYPE_ID

    This field is foreign key to: Class name: Language; DB table: ism.language_type.

  • RISK_OF_SUPPLY_SHORTAGE_FLAG

    Y/N

  • RISK_OF_SUPPLY_SHORTAGE_COMMENT

    size 4000

  • MARKETING_STATUS_REASON_TYPE_ID

    This field is foreign key to: Class name: MarketingStatusReason; DB table: ISM.MARKETING_STATUS_REASON_TYPE

  • Class name: LicensePackageSetCountry
  • DB table: ISM.LIC_PRODDET_COUNTRY

  • DB view: ISM.DV_LIC_PRODDET_COUNTR

ManufacturingFunctionGlobalDetail ManufacturingFunctionGlobalDetailRestController "/data-admin/manufacturing-function-global-detail" The following field is added:
  • confidentialityIndicator

DATA_CLASSIFICATION_TYPE_ID

This field is foreign key to: Class name: DataClassificationType; DB table: ism.data_classification_type.

ActiveIngredientDetail ActiveIngredientDetailRestController "/detail/ai" Removed fields:
  • measureTypeId
  • lowNumeratorValue
  • lowNumeratorPrefixId
  • lowNumeratorUnitId
  • lowDenominatorValue
  • lowDenominatorPrefixId
  • lowDenominatorUnitId
  • highNumeratorValue
  • highNumeratorPrefixId
  • highNumeratorUnitId
  • highDenominatorValue
  • highDenominatorPrefixId
  • highDenominatorUnitId
  • measurementPoint
Those fields are taken from Active Ingredient under component now.
MedicalDeviceDetail MedicalDeviceDetailRestController "/detail/medical-device" The following fields are added:
  • deviceCombinationTypeId
  • deviceTypeId
  • deviceIdentifier
  • deviceTradeName
  • DEVICE_COMBINATION_TYPE_ID

    This field is foreign key to: Class name: DeviceCombinationType

    DB table: MGR.DEVICE_COMBINATION_TYPE.

  • DEVICE_TYPE_ID

    This field is foreign key to: Class name: DeviceType; DB table: MGR.DEVICE_TYPE

  • DEVICE_IDENTIFIER

    String field.

  • DEVICE_TRADENAME

    String field.

  • Class name: MedicalDeviceDetail
  • DB table: MGR.PDS_MED_DEVICE_CHANGE
  • DB view: ISM.DV_PDS_MED_DEVICE
SubstanceDetail SubstanceDetailRestController "/detail/substance" The following fields are added:
  • presentationMeasureTypeId
  • presentationLowNumeratorValue
  • presentationLowNumeratorUnitOfMeasurement
  • presentationLowNumeratorUnitOfPresentation
  • presentationHighNumeratorValue
  • presentationHighNumeratorValue
  • presentationHighNumeratorUnitOfPresentation
  • concentrationLowNumeratorValue
  • concentrationLowNumeratorUnitOfMeasurement
  • concentrationLowDenominatorValue
  • concentrationLowDenominatorUnitOfMeasurement
  • concentrationHighNumeratorValue
  • concentrationHighNumeratorUnitOfMeasurement
  • concentrationHighDenominatorValue
  • concentrationHighDenominatorUnitOfMeasurement
  • MEASURE_TYPE_ID column of MGR.CONCENTRATION_VALUE table

    DB table: ism.legal_basis_type.

  • PRESENTATION_LOW_AMT_NUMER_VALUE column of MGR.CONCENTRATION_VALUE table

    String field.

  • PRESENTATION_LOW_AMT_NUMER_UNIT_TYPE_ID column of MGR.CONCENTRATION_VALUE table
  • PRESENTATION_LOW_AMT_NUMER_UOP_TYPE_ID column of MGR.CONCENTRATION_VALUE table.
  • PRESENTATION_HI_AMT_NUMER_VALUE column of MGR.CONCENTRATION_VALUE table

    String field.

  • PRESENTATION_HI_AMT_NUMER_VALUE column of MGR.CONCENTRATION_VALUE table

    String field.

  • PRESENTATION_HI_AMT_NUMER_UOP_TYPE_ID column of MGR.CONCENTRATION_VALUE table
  • CONCENTRATION_LOW_AMT_NUMER_VALUE column of MGR.CONCENTRATION_VALUE table.

    String field.

  • CONCENTRATION_LOW_AMT_DENOM_VALUE column of MGR.CONCENTRATION_VALUE table

    String field.

  • CONCENTRATION_LOW_AMT_DENOM_UNIT_TYPE_ID column of MGR.CONCENTRATION_VALUE table
  • CONCENTRATION_HI_AMT_NUMER_VALUE column of MGR.CONCENTRATION_VALUE table

    String field.

  • CONCENTRATION_HI_AMT_NUMER_UNIT_TYPE_ID column of MGR.CONCENTRATION_VALUE table
  • CONCENTRATION_HI_AMT_DENOM_VALUE column of MGR.CONCENTRATION_VALUE table

    String field.

  • CONCENTRATION_HI_AMT_DENOM_UNIT_TYPE_ID column of MGR.CONCENTRATION_VALUE table
  • Class name:SubstanceDetail
  • DB table:MGR.PDS_SUBSTANCE_CHANGE
  • DB view:ISM.DV_PDS_SUBSTANCE