GET api/v1/{EMRSystem}/Population/PharmacyInterventions

Returns all pharmacy interventions of all statuses for all patients for a given date range and filtered, optionally, by Locations (facilities).

Status: Released

URI Parameters

NameDescriptionTypeAdditional information
EMRSystem

The emr system.

EMRSystem

None.

LocationList

Gets or sets the location list.

string

None.

UserId

Identifier of the user initiating the request.

string

Required

FromDateTime

Gets or sets from date time.

datetime

Required if EMRSystem = Cerner, or Epic, or Meditech

ToDateTime

Gets or sets to date time.

datetime

None.

Header Parameters

NameDescriptionTypeAdditional information
LoginId

Gets or sets the login identifier. This Login Id will be encrypted and passed in Sansoro specific Http Request Headers.

string

Required if EMRSystem = Allscripts, or Athena, or Cerner, or Meditech, or Sandbox

Password

Gets or sets the password. This Password will be encrypted and passed in Sansoro specific Http Request Headers.

string

Data type: Password

Required if EMRSystem = Allscripts, or Athena, or Cerner, or Meditech, or Sandbox

EmrInstance

Gets or sets the emr instance. This emr instance info will be encrypted and passed in Sansoro specific Http Request Headers.

string

None.

ApplicationName

Gets or sets the requesting application name. This requesting application name will be encrypted and passed in Sansoro specific Http Request Headers.

string

Required if using application keys

ApplicationKey

Gets or sets the requesting application key. This requesting application key will be encrypted and passed in Sansoro specific Http Request Headers.

string

Data type: Password

Required if using application keys

AuthorizationToken

Gets or sets the custom authorization token. This requesting authorization token will be encrypted and passed in Sansoro specific Http Request Headers.

string

None.

RequestVerboseLogging

Enables verbose logging for a single request. When "true", verbose logging will occur. When "false", the configuration setting will be respected. This value will be passed in Sansoro specific Http Request Headers.

boolean

None.

Response Information

Collection of UdmPopulationPharmacyInterventionResponse
NameDescriptionTypeAdditional information
InterventionId

The intervention identifier.

string

None.

InterventionName

The name or description of the intervention.

string

None.

Types

The types of the intervention.

FormValues

None.

SubTypes

The subtypes of the intervention.

FormValues

None.

Status

The status of the intervention.

CodedObject

None.

Significance

The significance of the intervention. .

FormValues

None.

TimeSpent

The amount of time spent on the intervention.

FormValues

None.

Value

The estimated value of the intervention (usually monetary).

FormValues

None.

Response

The response to the intervention.

FormValues

None.

Outcomes

The eventual outcomes of the intervention.

FormValues

None.

AdditionalDetails

Additional custom fields in the intervention form.

Collection of FormValues

None.

CreatedBy

Intervention created by

Provider

None.

Pharmacy

Pharmacy associated with the intervention

HospitalPharmacy

None.

AssociatedUsers

List of users associated with the intervention

Collection of PharmacyInterventionUser

None.

LinkedOrders

The list of orders associated with the intervention.

Collection of PharmacyInterventionOrder

None.

ScoringSystem

Scoring system associated with the intervention

ScoringSystem

None.

Documentation

The text of the documentation for the intervention in rich text.

string

None.

Notes

The text for the notes for the intervention in rich text.

string

None.

CreatedDateTime

Datetime the intervention was created

datetime

None.

ClosedDateTime

Datetime the intervention was closed

datetime

None.

Audits

List of changes made to the intervention.

Collection of PharmacyInterventionAudit

None.

Patient

The patient associated with the intervention.

BasePatient

None.

Encounter

The encounter associated with the intervention.

Encounter

None.

CreatedUpdatedDateTime

The date/time the intervention was created or last updated.

datetime

None.

Response Codes

Http Status Code 200 - Indicates that the request was processed successfully.

Http Status Code 400 - Indicates that the request did not contain all the required fields or had an invalid value.

Http Status Code 401 - Indicates that authentication to the underlying EMR server using the provided LoginId and Password failed.

Http Status Code 403 - Indicates that there is an issue with the request UserId.

Http Status Code 408 - Indicates that the request to the underlying EMR server timed out.

Http Status Code 500 - Indicates that an internal server error occurred during processing of the request.

Http Status Code 502 - Indicates that a request made to the underlying EMR server could not be completed.

Response Formats

application/json

[
  {
    "InterventionId": "sample string 1",
    "InterventionName": "sample string 2",
    "Types": {
      "Section": {
        "Id": "sample string 1",
        "Name": "sample string 2",
        "Description": "sample string 3"
      },
      "Sequence": "sample string 1",
      "Field": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "CodedValues": [
        {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        {
          "Id": "sample string 1",
          "Name": "sample string 2"
        }
      ],
      "TextValues": [
        "sample string 1",
        "sample string 2"
      ]
    },
    "SubTypes": {
      "Section": {
        "Id": "sample string 1",
        "Name": "sample string 2",
        "Description": "sample string 3"
      },
      "Sequence": "sample string 1",
      "Field": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "CodedValues": [
        {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        {
          "Id": "sample string 1",
          "Name": "sample string 2"
        }
      ],
      "TextValues": [
        "sample string 1",
        "sample string 2"
      ]
    },
    "Status": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "Significance": {
      "Section": {
        "Id": "sample string 1",
        "Name": "sample string 2",
        "Description": "sample string 3"
      },
      "Sequence": "sample string 1",
      "Field": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "CodedValues": [
        {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        {
          "Id": "sample string 1",
          "Name": "sample string 2"
        }
      ],
      "TextValues": [
        "sample string 1",
        "sample string 2"
      ]
    },
    "TimeSpent": {
      "Section": {
        "Id": "sample string 1",
        "Name": "sample string 2",
        "Description": "sample string 3"
      },
      "Sequence": "sample string 1",
      "Field": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "CodedValues": [
        {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        {
          "Id": "sample string 1",
          "Name": "sample string 2"
        }
      ],
      "TextValues": [
        "sample string 1",
        "sample string 2"
      ]
    },
    "Value": {
      "Section": {
        "Id": "sample string 1",
        "Name": "sample string 2",
        "Description": "sample string 3"
      },
      "Sequence": "sample string 1",
      "Field": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "CodedValues": [
        {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        {
          "Id": "sample string 1",
          "Name": "sample string 2"
        }
      ],
      "TextValues": [
        "sample string 1",
        "sample string 2"
      ]
    },
    "Response": {
      "Section": {
        "Id": "sample string 1",
        "Name": "sample string 2",
        "Description": "sample string 3"
      },
      "Sequence": "sample string 1",
      "Field": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "CodedValues": [
        {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        {
          "Id": "sample string 1",
          "Name": "sample string 2"
        }
      ],
      "TextValues": [
        "sample string 1",
        "sample string 2"
      ]
    },
    "Outcomes": {
      "Section": {
        "Id": "sample string 1",
        "Name": "sample string 2",
        "Description": "sample string 3"
      },
      "Sequence": "sample string 1",
      "Field": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "CodedValues": [
        {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        {
          "Id": "sample string 1",
          "Name": "sample string 2"
        }
      ],
      "TextValues": [
        "sample string 1",
        "sample string 2"
      ]
    },
    "AdditionalDetails": [
      {
        "Section": {
          "Id": "sample string 1",
          "Name": "sample string 2",
          "Description": "sample string 3"
        },
        "Sequence": "sample string 1",
        "Field": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        "CodedValues": [
          {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          {
            "Id": "sample string 1",
            "Name": "sample string 2"
          }
        ],
        "TextValues": [
          "sample string 1",
          "sample string 2"
        ]
      },
      {
        "Section": {
          "Id": "sample string 1",
          "Name": "sample string 2",
          "Description": "sample string 3"
        },
        "Sequence": "sample string 1",
        "Field": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        "CodedValues": [
          {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          {
            "Id": "sample string 1",
            "Name": "sample string 2"
          }
        ],
        "TextValues": [
          "sample string 1",
          "sample string 2"
        ]
      }
    ],
    "CreatedBy": {
      "ProviderId": "sample string 1",
      "ProviderName": "sample string 2"
    },
    "Pharmacy": {
      "PharmacyId": "sample string 1",
      "PharmacyName": "sample string 2"
    },
    "AssociatedUsers": [
      {
        "User": {
          "ProviderId": "sample string 1",
          "ProviderName": "sample string 2"
        },
        "Role": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        }
      },
      {
        "User": {
          "ProviderId": "sample string 1",
          "ProviderName": "sample string 2"
        },
        "Role": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        }
      }
    ],
    "LinkedOrders": [
      {
        "Order": {
          "MedicationOrderId": "sample string 1",
          "MedicationOrderPriority": "sample string 2",
          "MedicationOrderExternalId": "sample string 3",
          "MedicationId": "sample string 4",
          "MedicationName": "sample string 5",
          "MedicationGenericName": "sample string 6",
          "MedicationItemId": "sample string 7",
          "MedicationOrderStatus": "sample string 8",
          "MedicationOrderingProvider": {
            "ProviderId": "sample string 1",
            "ProviderName": "sample string 2"
          },
          "NDC": "sample string 9",
          "RxNorms": [
            {
              "Code": "sample string 1",
              "CodeType": "sample string 2",
              "TermType": "sample string 3"
            },
            {
              "Code": "sample string 1",
              "CodeType": "sample string 2",
              "TermType": "sample string 3"
            }
          ],
          "Ingredients": [
            {
              "IngredientItemId": "sample string 1",
              "AHFS": [
                "sample string 1",
                "sample string 2"
              ],
              "IngredientId": "sample string 2",
              "IngredientName": "sample string 3",
              "IngredientRxNorms": [
                {
                  "Code": "sample string 1",
                  "CodeType": "sample string 2",
                  "TermType": "sample string 3"
                },
                {
                  "Code": "sample string 1",
                  "CodeType": "sample string 2",
                  "TermType": "sample string 3"
                }
              ],
              "NDC": "sample string 4",
              "Dose": "sample string 5",
              "DoseUnit": "sample string 6",
              "Strength": "sample string 7",
              "StrengthUnit": "sample string 8",
              "StrengthDose": "sample string 9",
              "StrengthDoseUnit": "sample string 10",
              "IngredientType": {
                "Id": "sample string 1",
                "Name": "sample string 2"
              }
            },
            {
              "IngredientItemId": "sample string 1",
              "AHFS": [
                "sample string 1",
                "sample string 2"
              ],
              "IngredientId": "sample string 2",
              "IngredientName": "sample string 3",
              "IngredientRxNorms": [
                {
                  "Code": "sample string 1",
                  "CodeType": "sample string 2",
                  "TermType": "sample string 3"
                },
                {
                  "Code": "sample string 1",
                  "CodeType": "sample string 2",
                  "TermType": "sample string 3"
                }
              ],
              "NDC": "sample string 4",
              "Dose": "sample string 5",
              "DoseUnit": "sample string 6",
              "Strength": "sample string 7",
              "StrengthUnit": "sample string 8",
              "StrengthDose": "sample string 9",
              "StrengthDoseUnit": "sample string 10",
              "IngredientType": {
                "Id": "sample string 1",
                "Name": "sample string 2"
              }
            }
          ],
          "ParentOrderId": "sample string 10",
          "OrderableCode": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          }
        },
        "LinkType": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        }
      },
      {
        "Order": {
          "MedicationOrderId": "sample string 1",
          "MedicationOrderPriority": "sample string 2",
          "MedicationOrderExternalId": "sample string 3",
          "MedicationId": "sample string 4",
          "MedicationName": "sample string 5",
          "MedicationGenericName": "sample string 6",
          "MedicationItemId": "sample string 7",
          "MedicationOrderStatus": "sample string 8",
          "MedicationOrderingProvider": {
            "ProviderId": "sample string 1",
            "ProviderName": "sample string 2"
          },
          "NDC": "sample string 9",
          "RxNorms": [
            {
              "Code": "sample string 1",
              "CodeType": "sample string 2",
              "TermType": "sample string 3"
            },
            {
              "Code": "sample string 1",
              "CodeType": "sample string 2",
              "TermType": "sample string 3"
            }
          ],
          "Ingredients": [
            {
              "IngredientItemId": "sample string 1",
              "AHFS": [
                "sample string 1",
                "sample string 2"
              ],
              "IngredientId": "sample string 2",
              "IngredientName": "sample string 3",
              "IngredientRxNorms": [
                {
                  "Code": "sample string 1",
                  "CodeType": "sample string 2",
                  "TermType": "sample string 3"
                },
                {
                  "Code": "sample string 1",
                  "CodeType": "sample string 2",
                  "TermType": "sample string 3"
                }
              ],
              "NDC": "sample string 4",
              "Dose": "sample string 5",
              "DoseUnit": "sample string 6",
              "Strength": "sample string 7",
              "StrengthUnit": "sample string 8",
              "StrengthDose": "sample string 9",
              "StrengthDoseUnit": "sample string 10",
              "IngredientType": {
                "Id": "sample string 1",
                "Name": "sample string 2"
              }
            },
            {
              "IngredientItemId": "sample string 1",
              "AHFS": [
                "sample string 1",
                "sample string 2"
              ],
              "IngredientId": "sample string 2",
              "IngredientName": "sample string 3",
              "IngredientRxNorms": [
                {
                  "Code": "sample string 1",
                  "CodeType": "sample string 2",
                  "TermType": "sample string 3"
                },
                {
                  "Code": "sample string 1",
                  "CodeType": "sample string 2",
                  "TermType": "sample string 3"
                }
              ],
              "NDC": "sample string 4",
              "Dose": "sample string 5",
              "DoseUnit": "sample string 6",
              "Strength": "sample string 7",
              "StrengthUnit": "sample string 8",
              "StrengthDose": "sample string 9",
              "StrengthDoseUnit": "sample string 10",
              "IngredientType": {
                "Id": "sample string 1",
                "Name": "sample string 2"
              }
            }
          ],
          "ParentOrderId": "sample string 10",
          "OrderableCode": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          }
        },
        "LinkType": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        }
      }
    ],
    "ScoringSystem": {
      "ScoringSystemId": "sample string 1",
      "ScoringSystemName": "sample string 2"
    },
    "Documentation": "sample string 3",
    "Notes": "sample string 4",
    "CreatedDateTime": "2025-12-12T20:52:59.2850652+00:00",
    "ClosedDateTime": "2025-12-12T20:52:59.2854169+00:00",
    "Audits": [
      {
        "Types": [
          {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          {
            "Id": "sample string 1",
            "Name": "sample string 2"
          }
        ],
        "SubTypes": [
          {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          {
            "Id": "sample string 1",
            "Name": "sample string 2"
          }
        ],
        "Status": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        "Significance": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        "TimeSpent": "sample string 1",
        "Value": "sample string 2",
        "Response": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        "Outcomes": [
          {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          {
            "Id": "sample string 1",
            "Name": "sample string 2"
          }
        ],
        "User": {
          "ProviderId": "sample string 1",
          "ProviderName": "sample string 2"
        },
        "OrderIds": [
          "sample string 1",
          "sample string 2"
        ],
        "AuditDateTime": "2025-12-12T20:52:59.2866182+00:00",
        "AuditComments": "sample string 3"
      },
      {
        "Types": [
          {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          {
            "Id": "sample string 1",
            "Name": "sample string 2"
          }
        ],
        "SubTypes": [
          {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          {
            "Id": "sample string 1",
            "Name": "sample string 2"
          }
        ],
        "Status": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        "Significance": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        "TimeSpent": "sample string 1",
        "Value": "sample string 2",
        "Response": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        "Outcomes": [
          {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          {
            "Id": "sample string 1",
            "Name": "sample string 2"
          }
        ],
        "User": {
          "ProviderId": "sample string 1",
          "ProviderName": "sample string 2"
        },
        "OrderIds": [
          "sample string 1",
          "sample string 2"
        ],
        "AuditDateTime": "2025-12-12T20:52:59.2866182+00:00",
        "AuditComments": "sample string 3"
      }
    ],
    "Patient": {
      "PatientId": "sample string 1",
      "DisplayName": "sample string 2",
      "LastName": "sample string 3",
      "FirstName": "sample string 4",
      "MiddleName": "sample string 5",
      "MRN": "sample string 6",
      "BirthDateTime": "2025-12-12T20:52:59.2869118+00:00",
      "Gender": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "DeceasedDateTime": "2025-12-12T20:52:59.2869156+00:00"
    },
    "Encounter": {
      "EncounterId": "sample string 1",
      "EncounterType": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "PatientClass": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "EncounterDateTime": "2025-12-12T20:52:59.2869665+00:00",
      "DischargeDateTime": "2025-12-12T20:52:59.2869682+00:00",
      "FinancialNumber": "sample string 2",
      "Location": {
        "BedId": "sample string 1",
        "Bed": "sample string 2",
        "RoomId": "sample string 3",
        "Room": "sample string 4",
        "UnitId": "sample string 5",
        "Unit": "sample string 6",
        "HospitalId": "sample string 7",
        "Hospital": "sample string 8"
      }
    },
    "CreatedUpdatedDateTime": "2025-12-12T20:52:59.287061+00:00"
  },
  {
    "InterventionId": "sample string 1",
    "InterventionName": "sample string 2",
    "Types": {
      "Section": {
        "Id": "sample string 1",
        "Name": "sample string 2",
        "Description": "sample string 3"
      },
      "Sequence": "sample string 1",
      "Field": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "CodedValues": [
        {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        {
          "Id": "sample string 1",
          "Name": "sample string 2"
        }
      ],
      "TextValues": [
        "sample string 1",
        "sample string 2"
      ]
    },
    "SubTypes": {
      "Section": {
        "Id": "sample string 1",
        "Name": "sample string 2",
        "Description": "sample string 3"
      },
      "Sequence": "sample string 1",
      "Field": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "CodedValues": [
        {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        {
          "Id": "sample string 1",
          "Name": "sample string 2"
        }
      ],
      "TextValues": [
        "sample string 1",
        "sample string 2"
      ]
    },
    "Status": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "Significance": {
      "Section": {
        "Id": "sample string 1",
        "Name": "sample string 2",
        "Description": "sample string 3"
      },
      "Sequence": "sample string 1",
      "Field": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "CodedValues": [
        {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        {
          "Id": "sample string 1",
          "Name": "sample string 2"
        }
      ],
      "TextValues": [
        "sample string 1",
        "sample string 2"
      ]
    },
    "TimeSpent": {
      "Section": {
        "Id": "sample string 1",
        "Name": "sample string 2",
        "Description": "sample string 3"
      },
      "Sequence": "sample string 1",
      "Field": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "CodedValues": [
        {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        {
          "Id": "sample string 1",
          "Name": "sample string 2"
        }
      ],
      "TextValues": [
        "sample string 1",
        "sample string 2"
      ]
    },
    "Value": {
      "Section": {
        "Id": "sample string 1",
        "Name": "sample string 2",
        "Description": "sample string 3"
      },
      "Sequence": "sample string 1",
      "Field": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "CodedValues": [
        {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        {
          "Id": "sample string 1",
          "Name": "sample string 2"
        }
      ],
      "TextValues": [
        "sample string 1",
        "sample string 2"
      ]
    },
    "Response": {
      "Section": {
        "Id": "sample string 1",
        "Name": "sample string 2",
        "Description": "sample string 3"
      },
      "Sequence": "sample string 1",
      "Field": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "CodedValues": [
        {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        {
          "Id": "sample string 1",
          "Name": "sample string 2"
        }
      ],
      "TextValues": [
        "sample string 1",
        "sample string 2"
      ]
    },
    "Outcomes": {
      "Section": {
        "Id": "sample string 1",
        "Name": "sample string 2",
        "Description": "sample string 3"
      },
      "Sequence": "sample string 1",
      "Field": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "CodedValues": [
        {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        {
          "Id": "sample string 1",
          "Name": "sample string 2"
        }
      ],
      "TextValues": [
        "sample string 1",
        "sample string 2"
      ]
    },
    "AdditionalDetails": [
      {
        "Section": {
          "Id": "sample string 1",
          "Name": "sample string 2",
          "Description": "sample string 3"
        },
        "Sequence": "sample string 1",
        "Field": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        "CodedValues": [
          {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          {
            "Id": "sample string 1",
            "Name": "sample string 2"
          }
        ],
        "TextValues": [
          "sample string 1",
          "sample string 2"
        ]
      },
      {
        "Section": {
          "Id": "sample string 1",
          "Name": "sample string 2",
          "Description": "sample string 3"
        },
        "Sequence": "sample string 1",
        "Field": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        "CodedValues": [
          {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          {
            "Id": "sample string 1",
            "Name": "sample string 2"
          }
        ],
        "TextValues": [
          "sample string 1",
          "sample string 2"
        ]
      }
    ],
    "CreatedBy": {
      "ProviderId": "sample string 1",
      "ProviderName": "sample string 2"
    },
    "Pharmacy": {
      "PharmacyId": "sample string 1",
      "PharmacyName": "sample string 2"
    },
    "AssociatedUsers": [
      {
        "User": {
          "ProviderId": "sample string 1",
          "ProviderName": "sample string 2"
        },
        "Role": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        }
      },
      {
        "User": {
          "ProviderId": "sample string 1",
          "ProviderName": "sample string 2"
        },
        "Role": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        }
      }
    ],
    "LinkedOrders": [
      {
        "Order": {
          "MedicationOrderId": "sample string 1",
          "MedicationOrderPriority": "sample string 2",
          "MedicationOrderExternalId": "sample string 3",
          "MedicationId": "sample string 4",
          "MedicationName": "sample string 5",
          "MedicationGenericName": "sample string 6",
          "MedicationItemId": "sample string 7",
          "MedicationOrderStatus": "sample string 8",
          "MedicationOrderingProvider": {
            "ProviderId": "sample string 1",
            "ProviderName": "sample string 2"
          },
          "NDC": "sample string 9",
          "RxNorms": [
            {
              "Code": "sample string 1",
              "CodeType": "sample string 2",
              "TermType": "sample string 3"
            },
            {
              "Code": "sample string 1",
              "CodeType": "sample string 2",
              "TermType": "sample string 3"
            }
          ],
          "Ingredients": [
            {
              "IngredientItemId": "sample string 1",
              "AHFS": [
                "sample string 1",
                "sample string 2"
              ],
              "IngredientId": "sample string 2",
              "IngredientName": "sample string 3",
              "IngredientRxNorms": [
                {
                  "Code": "sample string 1",
                  "CodeType": "sample string 2",
                  "TermType": "sample string 3"
                },
                {
                  "Code": "sample string 1",
                  "CodeType": "sample string 2",
                  "TermType": "sample string 3"
                }
              ],
              "NDC": "sample string 4",
              "Dose": "sample string 5",
              "DoseUnit": "sample string 6",
              "Strength": "sample string 7",
              "StrengthUnit": "sample string 8",
              "StrengthDose": "sample string 9",
              "StrengthDoseUnit": "sample string 10",
              "IngredientType": {
                "Id": "sample string 1",
                "Name": "sample string 2"
              }
            },
            {
              "IngredientItemId": "sample string 1",
              "AHFS": [
                "sample string 1",
                "sample string 2"
              ],
              "IngredientId": "sample string 2",
              "IngredientName": "sample string 3",
              "IngredientRxNorms": [
                {
                  "Code": "sample string 1",
                  "CodeType": "sample string 2",
                  "TermType": "sample string 3"
                },
                {
                  "Code": "sample string 1",
                  "CodeType": "sample string 2",
                  "TermType": "sample string 3"
                }
              ],
              "NDC": "sample string 4",
              "Dose": "sample string 5",
              "DoseUnit": "sample string 6",
              "Strength": "sample string 7",
              "StrengthUnit": "sample string 8",
              "StrengthDose": "sample string 9",
              "StrengthDoseUnit": "sample string 10",
              "IngredientType": {
                "Id": "sample string 1",
                "Name": "sample string 2"
              }
            }
          ],
          "ParentOrderId": "sample string 10",
          "OrderableCode": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          }
        },
        "LinkType": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        }
      },
      {
        "Order": {
          "MedicationOrderId": "sample string 1",
          "MedicationOrderPriority": "sample string 2",
          "MedicationOrderExternalId": "sample string 3",
          "MedicationId": "sample string 4",
          "MedicationName": "sample string 5",
          "MedicationGenericName": "sample string 6",
          "MedicationItemId": "sample string 7",
          "MedicationOrderStatus": "sample string 8",
          "MedicationOrderingProvider": {
            "ProviderId": "sample string 1",
            "ProviderName": "sample string 2"
          },
          "NDC": "sample string 9",
          "RxNorms": [
            {
              "Code": "sample string 1",
              "CodeType": "sample string 2",
              "TermType": "sample string 3"
            },
            {
              "Code": "sample string 1",
              "CodeType": "sample string 2",
              "TermType": "sample string 3"
            }
          ],
          "Ingredients": [
            {
              "IngredientItemId": "sample string 1",
              "AHFS": [
                "sample string 1",
                "sample string 2"
              ],
              "IngredientId": "sample string 2",
              "IngredientName": "sample string 3",
              "IngredientRxNorms": [
                {
                  "Code": "sample string 1",
                  "CodeType": "sample string 2",
                  "TermType": "sample string 3"
                },
                {
                  "Code": "sample string 1",
                  "CodeType": "sample string 2",
                  "TermType": "sample string 3"
                }
              ],
              "NDC": "sample string 4",
              "Dose": "sample string 5",
              "DoseUnit": "sample string 6",
              "Strength": "sample string 7",
              "StrengthUnit": "sample string 8",
              "StrengthDose": "sample string 9",
              "StrengthDoseUnit": "sample string 10",
              "IngredientType": {
                "Id": "sample string 1",
                "Name": "sample string 2"
              }
            },
            {
              "IngredientItemId": "sample string 1",
              "AHFS": [
                "sample string 1",
                "sample string 2"
              ],
              "IngredientId": "sample string 2",
              "IngredientName": "sample string 3",
              "IngredientRxNorms": [
                {
                  "Code": "sample string 1",
                  "CodeType": "sample string 2",
                  "TermType": "sample string 3"
                },
                {
                  "Code": "sample string 1",
                  "CodeType": "sample string 2",
                  "TermType": "sample string 3"
                }
              ],
              "NDC": "sample string 4",
              "Dose": "sample string 5",
              "DoseUnit": "sample string 6",
              "Strength": "sample string 7",
              "StrengthUnit": "sample string 8",
              "StrengthDose": "sample string 9",
              "StrengthDoseUnit": "sample string 10",
              "IngredientType": {
                "Id": "sample string 1",
                "Name": "sample string 2"
              }
            }
          ],
          "ParentOrderId": "sample string 10",
          "OrderableCode": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          }
        },
        "LinkType": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        }
      }
    ],
    "ScoringSystem": {
      "ScoringSystemId": "sample string 1",
      "ScoringSystemName": "sample string 2"
    },
    "Documentation": "sample string 3",
    "Notes": "sample string 4",
    "CreatedDateTime": "2025-12-12T20:52:59.2850652+00:00",
    "ClosedDateTime": "2025-12-12T20:52:59.2854169+00:00",
    "Audits": [
      {
        "Types": [
          {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          {
            "Id": "sample string 1",
            "Name": "sample string 2"
          }
        ],
        "SubTypes": [
          {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          {
            "Id": "sample string 1",
            "Name": "sample string 2"
          }
        ],
        "Status": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        "Significance": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        "TimeSpent": "sample string 1",
        "Value": "sample string 2",
        "Response": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        "Outcomes": [
          {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          {
            "Id": "sample string 1",
            "Name": "sample string 2"
          }
        ],
        "User": {
          "ProviderId": "sample string 1",
          "ProviderName": "sample string 2"
        },
        "OrderIds": [
          "sample string 1",
          "sample string 2"
        ],
        "AuditDateTime": "2025-12-12T20:52:59.2866182+00:00",
        "AuditComments": "sample string 3"
      },
      {
        "Types": [
          {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          {
            "Id": "sample string 1",
            "Name": "sample string 2"
          }
        ],
        "SubTypes": [
          {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          {
            "Id": "sample string 1",
            "Name": "sample string 2"
          }
        ],
        "Status": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        "Significance": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        "TimeSpent": "sample string 1",
        "Value": "sample string 2",
        "Response": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        "Outcomes": [
          {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          {
            "Id": "sample string 1",
            "Name": "sample string 2"
          }
        ],
        "User": {
          "ProviderId": "sample string 1",
          "ProviderName": "sample string 2"
        },
        "OrderIds": [
          "sample string 1",
          "sample string 2"
        ],
        "AuditDateTime": "2025-12-12T20:52:59.2866182+00:00",
        "AuditComments": "sample string 3"
      }
    ],
    "Patient": {
      "PatientId": "sample string 1",
      "DisplayName": "sample string 2",
      "LastName": "sample string 3",
      "FirstName": "sample string 4",
      "MiddleName": "sample string 5",
      "MRN": "sample string 6",
      "BirthDateTime": "2025-12-12T20:52:59.2869118+00:00",
      "Gender": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "DeceasedDateTime": "2025-12-12T20:52:59.2869156+00:00"
    },
    "Encounter": {
      "EncounterId": "sample string 1",
      "EncounterType": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "PatientClass": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "EncounterDateTime": "2025-12-12T20:52:59.2869665+00:00",
      "DischargeDateTime": "2025-12-12T20:52:59.2869682+00:00",
      "FinancialNumber": "sample string 2",
      "Location": {
        "BedId": "sample string 1",
        "Bed": "sample string 2",
        "RoomId": "sample string 3",
        "Room": "sample string 4",
        "UnitId": "sample string 5",
        "Unit": "sample string 6",
        "HospitalId": "sample string 7",
        "Hospital": "sample string 8"
      }
    },
    "CreatedUpdatedDateTime": "2025-12-12T20:52:59.287061+00:00"
  }
]

'

GET api/v1/{EMRSystem}/Population/PharmacyInterventions

Returns all pharmacy interventions of all statuses for all patients for a given date range and filtered, optionally, by Locations (facilities).

Status: Released

URI Parameters


Required
Required if EMRSystem = Cerner, or Epic, or Meditech

Header Parameters

Required if EMRSystem = Allscripts, or Athena, or Cerner, or Meditech, or Sandbox
Data type: Password , Required if EMRSystem = Allscripts, or Athena, or Cerner, or Meditech, or Sandbox
Required if using application keys
Data type: Password , Required if using application keys

Request: {{ method }} {{ url }}

  • Http Request Headers
  • {{header.name}} : {{header.value}} ******
  • Http Request Body
  • {{httpRequestBody}}
  • Http Response Headers
  • {{header.name}} : {{header.value}} ******
  • Http Response Data
  • {{httpResponseData}}