GET API/V1/Customization/Medications

Request Information

URI Parameters

Name	Description	Type	Additional information
Id	Direct lookup by Identifier.Id. When provided, all other filters are ignored; a non-matching id yields 404.	integer	None.
Type	Filters by entity type. Allowed values: "medication", "pdp". May be specified multiple times (OR).	Collection of string	None.
NameContains	Case-insensitive substring match on Identifier.Description (orderable name).	string	None.
ExternalCode	Exact, case-sensitive match on Identifier.Code. Entities with a null code are excluded.	string	None.
SearchTag	Exact match on a single search tag (medications only; PDPs excluded). May be specified multiple times (AND).	Collection of string	None.
SearchTagStartsWith	Matches medications whose search tags begin with this value (medications only; PDPs excluded).	string	None.
DepartmentId	Filters to medications available for the specified department (medications only; PDPs excluded).	integer	None.
Count	Maximum number of items per page. 0 (or omitted) disables pagination and returns all matches as a plain array.	integer	None.
Offset	Number of items to skip before returning results. Ignored when Count is 0/omitted.	integer	None.

Body Parameters

None.

Response Information

Resource Description

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

Name	Description	Type	Additional information
Type	Customization entity type. One of: "medication", "pdp".	string	None.
Identifier	Primary identifier: Id (MetaVision id), Code (external code, may be null), Description (orderable name).	iMDsoft.API.Metavision.Data.Data.CodedElement	None.
Unit	Primary unit used for ordering and display (e.g. mg, ml). Code may be null.	iMDsoft.API.Metavision.Data.Data.CodedElement	None.
DoseForms	Dose forms associated with the entity (reference only). For PDPs an empty list means no dose forms are known (all dose forms can be used).	Collection of iMDsoft.API.Metavision.Data.Data.CodedElement	None.
Routes	Routes associated with the entity, independent of dose forms. For medications an empty list means none configured; for PDPs an empty list means all routes can be used.	Collection of iMDsoft.API.Metavision.Data.Data.CodedElement	None.
Frequencies	Allowed frequencies (mode + selected list). Returned as null for PDPs.	iMDsoft.API.Metavision.Data.Customization.FrequencySpec	None.
Increment	Default increment when increasing/decreasing quantity. Returned as null for PDPs.	decimal number	None.
Formulary	Indicates whether the entity is marked as formulary.	boolean	None.
SearchTags	Configured search tags (e.g. ATC codes). Empty array if none configured for a medication. Returned as null for PDPs.	Collection of string	None.
Format	Customized display format. One of: "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.
AdditionalInformation	Configured additional information entries. Empty array if none for a medication. Returned as null for PDPs.	Collection of iMDsoft.API.Metavision.Data.Customization.MedicationAdditionalInformation	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "type": "sample string 1",
    "identifier": {
      "id": 1,
      "code": "sample string 1",
      "description": "sample string 2"
    },
    "unit": {
      "id": 1,
      "code": "sample string 1",
      "description": "sample string 2"
    },
    "doseForms": [
      {
        "id": 1,
        "code": "sample string 1",
        "description": "sample string 2"
      },
      {
        "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"
      }
    ],
    "frequencies": {
      "mode": "sample string 1",
      "selected": [
        {
          "id": 1,
          "code": "sample string 1",
          "description": "sample string 2"
        },
        {
          "id": 1,
          "code": "sample string 1",
          "description": "sample string 2"
        }
      ]
    },
    "increment": 1.0,
    "formulary": true,
    "searchTags": [
      "sample string 1",
      "sample string 2"
    ],
    "format": "sample string 3",
    "additionalInformation": [
      {
        "type": "sample string 1",
        "name": "sample string 2",
        "availableFor": "sample string 3",
        "freeText": "sample string 4",
        "parameter": {
          "id": 1,
          "code": "sample string 1",
          "description": "sample string 2"
        },
        "parameterValue": "sample string 5",
        "url": "sample string 6"
      },
      {
        "type": "sample string 1",
        "name": "sample string 2",
        "availableFor": "sample string 3",
        "freeText": "sample string 4",
        "parameter": {
          "id": 1,
          "code": "sample string 1",
          "description": "sample string 2"
        },
        "parameterValue": "sample string 5",
        "url": "sample string 6"
      }
    ]
  },
  {
    "type": "sample string 1",
    "identifier": {
      "id": 1,
      "code": "sample string 1",
      "description": "sample string 2"
    },
    "unit": {
      "id": 1,
      "code": "sample string 1",
      "description": "sample string 2"
    },
    "doseForms": [
      {
        "id": 1,
        "code": "sample string 1",
        "description": "sample string 2"
      },
      {
        "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"
      }
    ],
    "frequencies": {
      "mode": "sample string 1",
      "selected": [
        {
          "id": 1,
          "code": "sample string 1",
          "description": "sample string 2"
        },
        {
          "id": 1,
          "code": "sample string 1",
          "description": "sample string 2"
        }
      ]
    },
    "increment": 1.0,
    "formulary": true,
    "searchTags": [
      "sample string 1",
      "sample string 2"
    ],
    "format": "sample string 3",
    "additionalInformation": [
      {
        "type": "sample string 1",
        "name": "sample string 2",
        "availableFor": "sample string 3",
        "freeText": "sample string 4",
        "parameter": {
          "id": 1,
          "code": "sample string 1",
          "description": "sample string 2"
        },
        "parameterValue": "sample string 5",
        "url": "sample string 6"
      },
      {
        "type": "sample string 1",
        "name": "sample string 2",
        "availableFor": "sample string 3",
        "freeText": "sample string 4",
        "parameter": {
          "id": 1,
          "code": "sample string 1",
          "description": "sample string 2"
        },
        "parameterValue": "sample string 5",
        "url": "sample string 6"
      }
    ]
  }
]