GET api/groupplans/{groupplanid}/planonlystepmedications/{id}
Gets a plan only step medication by group plan identifier and plan only step medication id
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
groupplanid |
Group Plan Identifier |
integer |
Required |
id |
Plan Only Step Medication identifier |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
An plan only step medication resource
PlanStepMedicationModelName | Description | Type | Additional information |
---|---|---|---|
FormularyCompanyStepMedicationId |
Gets or sets the Formulary Company Step Medication ID |
integer |
None. |
FormularyCompanyStepMedicationUrl |
Gets or sets the Formulary Company Step Medication Url |
string |
None. |
ProductID |
Gets or sets the product ID for this resource. The value should be a valid NDC, DDID or GPI. |
string |
None. |
ProductIDType |
Gets or sets the product ID Type for this resource. The value will indicate whether the product ID for this resource is an NDC or DDID . String values other than 'NDC' or 'DDID' will not be valid. |
string |
None. |
NoOfDrugsToTry |
Gets or sets the number of Drugs to Try |
integer |
None. |
StepOrder |
Gets or sets the Step Order |
string |
None. |
DiagnosisCode |
Gets or sets the Diagnosis Code |
string |
None. |
DiagnosisCodeQualifier |
Gets or sets the Diagnosis Code Qualifier |
string |
None. |
NeedsReview |
Gets or sets the value indicating whether this needs review. |
boolean |
None. |
OptOut |
Gets or sets the value indicating whether to opt out. |
boolean |
None. |
Modified |
Gets or sets the value indicating whether is modified. |
boolean |
None. |
CreatedOn |
Gets or sets the Created On Date for this resource |
date |
None. |
StepDrugMultiSourceCodesUrl |
Gets or sets the URL that can be accessed to find the Multi Source Codes used to identify step medication products to try. This list of Multi Source Codes will be used in combination with the StepDrugProducts list to indicate which products should be tried as part of this step medication. |
string |
None. |
StepDrugProductsUrl |
Gets or sets the URL that can be accessed to find which ProductID's (NDC or GPI) should be tried as part of this Step Medication resource. This list of products will be used in combination with the Multi Source Code list to indicate which products should be tried as part of this step medication. |
string |
None. |
StepDrugs | Collection of PlanStepMedicationStepDrugModel |
None. |
|
MultiSourceCodes | Collection of PlanStepMedicationMultiSourceCodeModel |
None. |
|
Url |
Gets or sets the link representing a link back to the resource |
string |
None. |
ID |
Gets or sets the identifier for the resource |
integer |
None. |
Response Formats
application/json, text/json, application/json-patch+json
{ "url": "sample string 10", "id": 11, "formularyCompanyStepMedicationId": 1, "formularyCompanyStepMedicationUrl": "sample string 2", "productID": "sample string 3", "productIDType": "sample string 4", "noOfDrugsToTry": 1, "stepOrder": "sample string 5", "diagnosisCode": "sample string 6", "diagnosisCodeQualifier": "sample string 7", "needsReview": true, "optOut": true, "modified": true, "createdOn": "2025-05-30T21:19:44.8493125-05:00", "stepDrugMultiSourceCodesUrl": "sample string 8", "stepDrugProductsUrl": "sample string 9", "stepDrugs": [ { "url": "sample string 6", "id": 7, "planStepMedicationUrl": "sample string 1", "planStepMedicationId": 1, "stepDrugProductID": "sample string 2", "stepDrugProductIDType": "sample string 3", "stepDrugClassID": "sample string 4", "stepDrugSubClassID": "sample string 5", "createdOn": "2025-05-30T21:19:44.850316-05:00", "changedOn": "2025-05-30T21:19:44.850316-05:00" }, { "url": "sample string 6", "id": 7, "planStepMedicationUrl": "sample string 1", "planStepMedicationId": 1, "stepDrugProductID": "sample string 2", "stepDrugProductIDType": "sample string 3", "stepDrugClassID": "sample string 4", "stepDrugSubClassID": "sample string 5", "createdOn": "2025-05-30T21:19:44.850316-05:00", "changedOn": "2025-05-30T21:19:44.850316-05:00" } ], "multiSourceCodes": [ { "url": "sample string 3", "id": 4, "planStepMedicationUrl": "sample string 1", "planStepMedicationId": 1, "multiSourceCode": "sample string 2", "isActive": true, "createdOn": "2025-05-30T21:19:44.850316-05:00", "changedOn": "2025-05-30T21:19:44.850316-05:00" }, { "url": "sample string 3", "id": 4, "planStepMedicationUrl": "sample string 1", "planStepMedicationId": 1, "multiSourceCode": "sample string 2", "isActive": true, "createdOn": "2025-05-30T21:19:44.850316-05:00", "changedOn": "2025-05-30T21:19:44.850316-05:00" } ] }