PATCH api/globalcompanystepmedications/{id}

Patches an existing Global Company Step Medication object

Request Information

URI Parameters

Name	Description	Type	Additional information
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 global 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 Global Company Step Medication object

CompanyStepMedicationModel

Name	Description	Type	Additional information
Name	Gets or sets the description of the step medication resource	string	None.
IsGlobal	Gets or sets whether this is a global step medication resource (true if Global, false if Formulary-level) Obsolete - will be removed at a later date	boolean	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.
IsActive	Gets or sets value to indicate the Active status	boolean	None.
CreatedOn	Gets or sets the Created On Date for this resource	date	None.
AuditNote	Gets or sets the value indicating (for audit purposes) why the most current change was made	string	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 9",
  "id": 10,
  "name": "sample string 2",
  "isGlobal": true,
  "noOfDrugsToTry": 1,
  "stepOrder": "sample string 3",
  "diagnosisCode": "sample string 4",
  "diagnosisCodeQualifier": "sample string 5",
  "isActive": true,
  "createdOn": "2025-05-30T20:48:29.6143618-05:00",
  "auditNote": "sample string 6",
  "active": true,
  "stepDrugMultiSourceCodesUrl": "sample string 7",
  "stepDrugProductsUrl": "sample string 8",
  "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:48:29.6143618-05:00",
      "changedOn": "2025-05-30T20:48:29.6143618-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:48:29.6143618-05:00",
      "changedOn": "2025-05-30T20:48:29.6143618-05:00"
    }
  ],
  "multiSourceCodes": [
    {
      "url": "sample string 4",
      "id": 0,
      "seqNo": 1,
      "companyStepMedicationSeqNo": 2,
      "multiSourceCode": "sample string 3",
      "isActive": true,
      "createdOn": "2025-05-30T20:48:29.6153625-05:00",
      "changedOn": "2025-05-30T20:48:29.6153625-05:00"
    },
    {
      "url": "sample string 4",
      "id": 0,
      "seqNo": 1,
      "companyStepMedicationSeqNo": 2,
      "multiSourceCode": "sample string 3",
      "isActive": true,
      "createdOn": "2025-05-30T20:48:29.6153625-05:00",
      "changedOn": "2025-05-30T20:48:29.6153625-05:00"
    }
  ]
}