PATCH api/formularies/{formularyid}/formularycompanystepmedications/{id}

Patches an existing Formulary Company Step Medication object

Request Information

URI Parameters

Name	Description	Type	Additional information
formularyid	The id of the formulary for which step medication	integer	Required
id	Step Medication identifier	integer	Required

Body Parameters

The json formatted patch document (https://tools.ietf.org/html/rfc6902) containing operations to apply to the target formulary company step medication object

JsonPatchDocument

Name	Description	Type	Additional information
Operations		Collection of Operation	None.

Request Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.

application/json-patch+json

Sample:

Sample not available.

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

A patched Formulary Company Step Medication object

FormularyCompanyStepMedicationModel

Name	Description	Type	Additional information
CompanyStepMedicationSeqNo	Gets or sets the value indicating whether this formulary step medication is inheriting from a global/company-level step medication.	integer	None.
CompanyStepMedicationUrl	Gets the url where the global/company-level step medication resource can be found	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 the ProductID value set on 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.
Name	Gets or sets the description of the step medication resource	string	None.
NoOfDrugsToTry	Gets or sets the value of the number of drugs to try for this step medication	integer	None.
StepOrder	Gets or sets the suggested order in which the step medication should be tried	string	None.
DiagnosisCode	Gets or sets the ICD9 code identifying the diagnosis of the patient	string	None.
EffectiveStartDate	Gets or sets the Effective Start Date of this resource	date	None.
EffectiveEndDate	Gets or sets the Effective End Date of this resource	date	None.
Active	Gets or sets the value indicating whether this step medication is currently active.	boolean	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 CompanyStepMedicationStepDrugModel	None.
MultiSourceCodes		Collection of CompanyStepMedicationMultiSourceCodeModel	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

Sample:

{
  "url": "sample string 11",
  "id": 12,
  "companyStepMedicationSeqNo": 1,
  "companyStepMedicationUrl": "sample string 1",
  "productID": "sample string 3",
  "productIDType": "sample string 4",
  "name": "sample string 5",
  "noOfDrugsToTry": 1,
  "stepOrder": "sample string 6",
  "diagnosisCode": "sample string 7",
  "effectiveStartDate": "2025-05-30T20:58:58.9832465-05:00",
  "effectiveEndDate": "2025-05-30T20:58:58.9832465-05:00",
  "active": true,
  "stepDrugMultiSourceCodesUrl": "sample string 9",
  "stepDrugProductsUrl": "sample string 10",
  "stepDrugs": [
    {
      "url": "sample string 7",
      "id": 0,
      "seqNo": 1,
      "companyStepMedicationSeqNo": 2,
      "stepDrugProductID": "sample string 3",
      "stepDrugProductIDType": "sample string 4",
      "stepDrugClassID": "sample string 5",
      "stepDrugSubClassID": "sample string 6",
      "isActive": true,
      "createdOn": "2025-05-30T20:58:58.9832465-05:00",
      "changedOn": "2025-05-30T20:58:58.9832465-05:00"
    },
    {
      "url": "sample string 7",
      "id": 0,
      "seqNo": 1,
      "companyStepMedicationSeqNo": 2,
      "stepDrugProductID": "sample string 3",
      "stepDrugProductIDType": "sample string 4",
      "stepDrugClassID": "sample string 5",
      "stepDrugSubClassID": "sample string 6",
      "isActive": true,
      "createdOn": "2025-05-30T20:58:58.9832465-05:00",
      "changedOn": "2025-05-30T20:58:58.9832465-05:00"
    }
  ],
  "multiSourceCodes": [
    {
      "url": "sample string 4",
      "id": 0,
      "seqNo": 1,
      "companyStepMedicationSeqNo": 2,
      "multiSourceCode": "sample string 3",
      "isActive": true,
      "createdOn": "2025-05-30T20:58:58.9832465-05:00",
      "changedOn": "2025-05-30T20:58:58.9832465-05:00"
    },
    {
      "url": "sample string 4",
      "id": 0,
      "seqNo": 1,
      "companyStepMedicationSeqNo": 2,
      "multiSourceCode": "sample string 3",
      "isActive": true,
      "createdOn": "2025-05-30T20:58:58.9832465-05:00",
      "changedOn": "2025-05-30T20:58:58.9832465-05:00"
    }
  ]
}