GET API/V1/Customization/Products

Request Information

URI Parameters

Name	Description	Type	Additional information
MedicationID	Medication id	integer	None.
DoseFormID	Dose form id	integer	None.
Barcode	Barcode	string	None.
ExternalCode	ExternalCode	string	None.
GetProductByDepartmentTemplates	Get only the products which belong to the specified medication and are found in the department's order templates In case there are also templates with no product, an empty product will be returned to represent that	boolean	None.
LogicalUnitId	LogicalUnit Id	integer	None.
ProductId	Product Id	integer	None.
ExternalCodes	ExternalCodes	Collection of string	None.

Body Parameters

None.

Response Information

Resource Description

Collection of iMDsoft.API.Metavision.Data.Customization.Product

Name	Description	Type	Additional information
Identifier	Coded element with product id, product name as description, External code as the code	iMDsoft.API.Metavision.Data.Data.CodedElement	None.
Medication	Coded element with medication id, medication name as description, External code as the code	iMDsoft.API.Metavision.Data.Data.CodedElement	None.
DoseForm	Coded element with dose form id, dose form name as description, external code as the code	iMDsoft.API.Metavision.Data.Data.CodedElement	None.
Routes	List of Coded element with route id, route name as description, route code as the code	Collection of iMDsoft.API.Metavision.Data.Data.CodedElement	None.
Brand	Coded element with brand id, brand name as description, brand code as the code	iMDsoft.API.Metavision.Data.Data.CodedElement	None.
ProductUnit	Product unit id + name	iMDsoft.API.Metavision.Data.Data.CodedElement	None.
ProductConcentration	Product strength expressed as a ratio including strength and unit (e.g. 500 mg in 1 tablet)	iMDsoft.API.Metavision.Data.Data.UnitNameAndValueOfSystem.Decimal	None.
ProductConcentrationTarget	Product strength expressed as a ratio including strength and unit (e.g. 500 mg in 1 tablet)	iMDsoft.API.Metavision.Data.Data.UnitNameAndValueOfSystem.Decimal	None.
ProductMinimumDispensableVolume	Minimum dispensable amount as a number. 0 indicates that there is no limit to how small a dispensing amount can be used	decimal number	None.
Barcodes	List of barcodes (includes the product barcode, and the package.barcode of all packages)	Collection of string	None.
Formulary	Indicates whether the product is customized as a formulary product	boolean	None.
Preferred	Whether a product is preferred or not (taken from product attributes in database)	boolean	None.
InStock	Whether a product is in stock or not (taken from product attributes in database)	boolean	None.
Tags	Any additional Tags available for the product (taken from product attributes in database)	Collection of string	None.
Format	The customized format of the product. Returns one of the following enum values (regardless of the regional decimal separator): "1,234", "1,234.5", "1,234.5 (Include Zero)", "1,234.56", "1,234.56 (Include Zero)", "1,234.567", "1,234.567 (Include Zero)", "1,234.5678", "1,234.5678 (Include Zero)", "Unformatted"	string	None.
IsAvailable	Is product available for current login department	boolean	None.
ExternalCode	Product external code	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "identifier": {
      "id": 1,
      "code": "sample string 1",
      "description": "sample string 2"
    },
    "medication": {
      "id": 1,
      "code": "sample string 1",
      "description": "sample string 2"
    },
    "doseForm": {
      "id": 1,
      "code": "sample string 1",
      "description": "sample string 2"
    },
    "routes": [
      {
        "id": 1,
        "code": "sample string 1",
        "description": "sample string 2"
      },
      {
        "id": 1,
        "code": "sample string 1",
        "description": "sample string 2"
      }
    ],
    "brand": {
      "id": 1,
      "code": "sample string 1",
      "description": "sample string 2"
    },
    "productUnit": {
      "id": 1,
      "code": "sample string 1",
      "description": "sample string 2"
    },
    "productConcentration": {
      "unit": {
        "id": 1,
        "code": "sample string 1",
        "description": "sample string 2"
      },
      "value": 1.0
    },
    "productConcentrationTarget": {
      "unit": {
        "id": 1,
        "code": "sample string 1",
        "description": "sample string 2"
      },
      "value": 1.0
    },
    "productMinimumDispensableVolume": 1.0,
    "barcodes": [
      "sample string 1",
      "sample string 2"
    ],
    "formulary": true,
    "preferred": true,
    "inStock": true,
    "tags": [
      "sample string 1",
      "sample string 2"
    ],
    "format": "sample string 3",
    "isAvailable": true,
    "externalCode": "sample string 5"
  },
  {
    "identifier": {
      "id": 1,
      "code": "sample string 1",
      "description": "sample string 2"
    },
    "medication": {
      "id": 1,
      "code": "sample string 1",
      "description": "sample string 2"
    },
    "doseForm": {
      "id": 1,
      "code": "sample string 1",
      "description": "sample string 2"
    },
    "routes": [
      {
        "id": 1,
        "code": "sample string 1",
        "description": "sample string 2"
      },
      {
        "id": 1,
        "code": "sample string 1",
        "description": "sample string 2"
      }
    ],
    "brand": {
      "id": 1,
      "code": "sample string 1",
      "description": "sample string 2"
    },
    "productUnit": {
      "id": 1,
      "code": "sample string 1",
      "description": "sample string 2"
    },
    "productConcentration": {
      "unit": {
        "id": 1,
        "code": "sample string 1",
        "description": "sample string 2"
      },
      "value": 1.0
    },
    "productConcentrationTarget": {
      "unit": {
        "id": 1,
        "code": "sample string 1",
        "description": "sample string 2"
      },
      "value": 1.0
    },
    "productMinimumDispensableVolume": 1.0,
    "barcodes": [
      "sample string 1",
      "sample string 2"
    ],
    "formulary": true,
    "preferred": true,
    "inStock": true,
    "tags": [
      "sample string 1",
      "sample string 2"
    ],
    "format": "sample string 3",
    "isAvailable": true,
    "externalCode": "sample string 5"
  }
]