| 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. |
| Status |
Customization status of the medication or PDP. One of: "active", "inactive", "retired". Never null. Inactive and retired entities are returned only when IncludeInactive is true. Nested dose forms and routes carry no status. |
string |
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. |