GET API/V1/Customization/DoseForms
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| MedicationId |
Filters to the dose forms associated with the specified medication. |
integer |
None. |
| PdpId |
Filters to the dose forms associated with the specified Partial Data Product (PDP). |
integer |
None. |
| Id |
Direct lookup by Identifier.Id. When provided, all other filters are ignored; a non-matching id yields 404. |
integer |
None. |
| ExternalCode |
Exact, case-sensitive match on Identifier.Code. Dose forms with a null code are excluded. |
string |
None. |
| RouteId |
Filters to the dose forms associated with the specified route. |
integer |
None. |
| Category |
Filters by dose form category (matched against Category). |
string |
None. |
Body Parameters
None.
Response Information
Resource Description
Collection of iMDsoft.API.Metavision.Data.Customization.DoseFormCustomization| Name | Description | Type | Additional information |
|---|---|---|---|
| Identifier |
Primary identifier: Id (MetaVision id), Code (external code, may be null), Description (dose form name). |
iMDsoft.API.Metavision.Data.Data.CodedElement |
None. |
| Category |
Dose form category: Id (MetaVision id), Code (external code, may be null), Description (category name). |
iMDsoft.API.Metavision.Data.Data.CodedElement |
None. |
| OrderingType |
Ordering type configured for the dose form (e.g. how the dose form is ordered/administered). |
string |
None. |
| IsDrugInDiluent |
Indicates whether the dose form represents a drug administered in a diluent. |
boolean |
None. |
Response Formats
application/json, text/json
[
{
"identifier": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"category": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"orderingType": "sample string 1",
"isDrugInDiluent": true
},
{
"identifier": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"category": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"orderingType": "sample string 1",
"isDrugInDiluent": true
}
]