GET api/v1/{EMRSystem}/MedicationOrders/HomeMedications
Returns the Home Medications of all statuses for a given patient. FHIR connectors use the following resources for R4: MedicationRequest.Search, Patient.Read, Practitioner.Read, Encounter.Read, and Medication.Read.
Status: Released
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| EMRSystem |
The emr system. |
EMRSystem |
None. |
| UserId |
Gets or sets the user identifier. |
string |
Required |
| UserType |
Gets or sets the type of the user. |
UserType |
None. |
| PatientId |
Gets or sets the patient identifier. |
string |
Required |
| EncounterId |
Gets or sets the encounter identifier. |
string |
None. |
| OrderStatus |
Gets or sets the status of the order. |
OrderStatus |
None. |
| FromDateTime |
Gets or sets from date time. |
datetime |
None. |
| ToDateTime |
Gets or sets to date time. |
datetime |
None. |
| IncludeRxNorm |
Gets or sets a value indicating whether [include rx norm]. |
boolean |
None. |
| IncludeRxDischarge |
Gets or sets a value indicating whether [include discharge meds]. |
boolean |
None. |
Header Parameters
| Name | Description | Type | Additional 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
UdmHomeMedicationsResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| HomeMedications |
Gets or sets the Home Medications. |
Collection of UdmHomeMedicationResponse |
None. |
| MedicationHistory |
Gets or sets the Medication History. |
Collection of MedicationHistory |
None. |
| MedicationReconciliation |
Gets or sets the Medication Reconciliation. |
Collection of MedicationReconciliation |
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
{
"HomeMedications": [
{
"AdminInstructions": "sample string 1",
"AlternativeMedicationName": "sample string 2",
"Comments": [
{
"CommentText": "sample string 1",
"CommentUpdateDateTime": "2025-12-12T20:53:14.0219411+00:00",
"CommentUpdatePersonnel": "2025-12-12",
"InternalSequence": "sample string 2"
},
{
"CommentText": "sample string 1",
"CommentUpdateDateTime": "2025-12-12T20:53:14.0219411+00:00",
"CommentUpdatePersonnel": "2025-12-12",
"InternalSequence": "sample string 2"
}
],
"DrugForm": "sample string 3",
"EncounterId": "sample string 4",
"EncounterType": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"Frequency": "sample string 5",
"MedicationId": "sample string 6",
"MedicationCategory": "sample string 7",
"MedicationClinicalDisplayLineLong": "sample string 8",
"MedicationClinicalDisplayLineShort": "sample string 9",
"MedicationCommunicationType": "sample string 10",
"MedicationDepartmentStatus": "sample string 11",
"MedicationName": "sample string 12",
"MedicationOrderBasis": "sample string 13",
"MedicationOrderId": "sample string 14",
"MedicationOrderExternalId": "sample string 15",
"MedicationOrderingProvider": "sample string 16",
"MedicationOrderingProviderId": "sample string 17",
"MedicationOrderPriority": "sample string 18",
"MedicationOrderType": "sample string 19",
"MedicationStatus": "sample string 20",
"MedicationType": "sample string 21",
"OrderedDateTime": "2025-12-12T20:53:14.0230744+00:00",
"PatientId": "sample string 22",
"PatientClass": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"Route": "sample string 23",
"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"
}
],
"StartDateTime": "2025-12-12T20:53:14.0237642+00:00",
"StopDateTime": "2025-12-12T20:53:14.0238286+00:00",
"StopType": "sample string 24",
"RequestedDispenseAmount": "sample string 25",
"RequestedDispenseAmountUnit": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"StrengthDose": "sample string 26",
"StrengthDoseUnit": "sample string 27",
"TherapeuticSubClass": "sample string 28",
"TherapeuticClass": "sample string 29",
"VolumeDose": "sample string 30",
"VolumeDoseUnit": "sample string 31",
"NDC": "sample string 32",
"IsPRN": true,
"PrnReasons": [
{
"Id": "sample string 1",
"Name": "sample string 2"
},
{
"Id": "sample string 1",
"Name": "sample string 2"
}
],
"Refills": "sample string 33",
"DispenseAsWritten": true,
"DEASchedule": "sample string 34",
"MedicationBrandName": "sample string 35",
"MedicationGenericName": "sample string 36",
"OnFormulary": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"LastConfirmedStatus": "sample string 37",
"LastConfirmedDate": "2025-12-12T20:53:14.0245062+00:00",
"LastConfirmedUser": "sample string 38",
"LastTaken": "sample string 39",
"LastTakenDateTime": "2025-12-12T20:53:14.0245974+00:00",
"LastTakenDose": "sample string 40",
"RecordedBy": "sample string 41",
"RecordedDate": "2025-12-12T20:53:14.0246877+00:00",
"Category": "sample string 42"
},
{
"AdminInstructions": "sample string 1",
"AlternativeMedicationName": "sample string 2",
"Comments": [
{
"CommentText": "sample string 1",
"CommentUpdateDateTime": "2025-12-12T20:53:14.0219411+00:00",
"CommentUpdatePersonnel": "2025-12-12",
"InternalSequence": "sample string 2"
},
{
"CommentText": "sample string 1",
"CommentUpdateDateTime": "2025-12-12T20:53:14.0219411+00:00",
"CommentUpdatePersonnel": "2025-12-12",
"InternalSequence": "sample string 2"
}
],
"DrugForm": "sample string 3",
"EncounterId": "sample string 4",
"EncounterType": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"Frequency": "sample string 5",
"MedicationId": "sample string 6",
"MedicationCategory": "sample string 7",
"MedicationClinicalDisplayLineLong": "sample string 8",
"MedicationClinicalDisplayLineShort": "sample string 9",
"MedicationCommunicationType": "sample string 10",
"MedicationDepartmentStatus": "sample string 11",
"MedicationName": "sample string 12",
"MedicationOrderBasis": "sample string 13",
"MedicationOrderId": "sample string 14",
"MedicationOrderExternalId": "sample string 15",
"MedicationOrderingProvider": "sample string 16",
"MedicationOrderingProviderId": "sample string 17",
"MedicationOrderPriority": "sample string 18",
"MedicationOrderType": "sample string 19",
"MedicationStatus": "sample string 20",
"MedicationType": "sample string 21",
"OrderedDateTime": "2025-12-12T20:53:14.0230744+00:00",
"PatientId": "sample string 22",
"PatientClass": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"Route": "sample string 23",
"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"
}
],
"StartDateTime": "2025-12-12T20:53:14.0237642+00:00",
"StopDateTime": "2025-12-12T20:53:14.0238286+00:00",
"StopType": "sample string 24",
"RequestedDispenseAmount": "sample string 25",
"RequestedDispenseAmountUnit": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"StrengthDose": "sample string 26",
"StrengthDoseUnit": "sample string 27",
"TherapeuticSubClass": "sample string 28",
"TherapeuticClass": "sample string 29",
"VolumeDose": "sample string 30",
"VolumeDoseUnit": "sample string 31",
"NDC": "sample string 32",
"IsPRN": true,
"PrnReasons": [
{
"Id": "sample string 1",
"Name": "sample string 2"
},
{
"Id": "sample string 1",
"Name": "sample string 2"
}
],
"Refills": "sample string 33",
"DispenseAsWritten": true,
"DEASchedule": "sample string 34",
"MedicationBrandName": "sample string 35",
"MedicationGenericName": "sample string 36",
"OnFormulary": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"LastConfirmedStatus": "sample string 37",
"LastConfirmedDate": "2025-12-12T20:53:14.0245062+00:00",
"LastConfirmedUser": "sample string 38",
"LastTaken": "sample string 39",
"LastTakenDateTime": "2025-12-12T20:53:14.0245974+00:00",
"LastTakenDose": "sample string 40",
"RecordedBy": "sample string 41",
"RecordedDate": "2025-12-12T20:53:14.0246877+00:00",
"Category": "sample string 42"
}
],
"MedicationHistory": [
{
"NoKnownHomeMedications": true,
"Status": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"DocumentedDateTime": "2025-12-12T20:53:14.0251907+00:00",
"DocumentedBy": {
"ProviderId": "sample string 1",
"ProviderName": "sample string 2"
},
"EncounterId": "sample string 2"
},
{
"NoKnownHomeMedications": true,
"Status": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"DocumentedDateTime": "2025-12-12T20:53:14.0251907+00:00",
"DocumentedBy": {
"ProviderId": "sample string 1",
"ProviderName": "sample string 2"
},
"EncounterId": "sample string 2"
}
],
"MedicationReconciliation": [
{
"Type": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"Status": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"DocumentedDateTime": "2025-12-12T20:53:14.0256709+00:00",
"DocumentedBy": {
"ProviderId": "sample string 1",
"ProviderName": "sample string 2"
},
"EncounterId": "sample string 1"
},
{
"Type": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"Status": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"DocumentedDateTime": "2025-12-12T20:53:14.0256709+00:00",
"DocumentedBy": {
"ProviderId": "sample string 1",
"ProviderName": "sample string 2"
},
"EncounterId": "sample string 1"
}
]
}