GET Medication Orders by Id

Developer Tools

GET api/v1/{EMRSystem}/MedicationOrders/{MedicationOrderId}

Returns medication details for a given medication order ID.

HTTP Method

GET

Applicable Emissary Products

Chart Retrieval

Clinical Analytics

Interactive Workflow

Allscripts

Released

Athena

In Dev

Cerner

Released

Meditech

Released

Sandbox

In Dev

Don't see the data field you are looking for?

Request Information

URI Parameters

NAME	DESCRIPTION	TYPE	ADDITIONAL INFO
EMRSystem	The emr system.	EMRsystem	Required
MedicationOrderId	Medication Order Identifier	string	Required
UserId	Gets or sets the user identifier.	string	Required
UserType	Gets or sets the type of the user.	UserType	None
IncludeRxNorm	Gets or sets a value indicating whether [include rx norm].	boolean	None
IncludeAdmins	Gets or sets a value indicating whether [include admins].	boolean	None
IncludeDetails	Gets or sets a value indicating whether [include details].	boolean	None

Body Parameters

None

Response Information

Resource Description

Http response containing a single Medication Order.

NAME	DESCRIPTION	TYPE	ADDITIONAL INFO
MedicationOrder	Gets or sets the medication order.	MedicationOrderResponseViewModel	None.

Response Codes

Http Status Code 200 – Returns Sansoro.Shared.SansoroServiceBus.Models.MedicationOrderResponseViewModel

Http Status Code 400 – Indicates that the request did not contain all the required fields.

Http Status Code 404 – Indicates that the resource to get could not be found.

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, text/json
application/xml, text/xml

Sample Message

Download Json Schema

{
  "MedicationOrder": {
    "AHFS": [
      "sample string 1",
      "sample string 2"
    ],
    "Action": "sample string 1",
    "AdminInstructions": "sample string 2",
    "AlternativeMedicationName": "sample string 3",
    "DrugForm": "sample string 4",
    "Duration": "sample string 5",
    "DurationUnit": "sample string 6",
    "EncounterId": "sample string 7",
    "EncounterType": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "Frequency": "sample string 8",
    "FrequencyType": "sample string 9",
    "MedAdministrations": [
      {
        "AdministrationAction": "sample string 1",
        "AdministrationClinician": "sample string 2",
        "AdministrationDateTime": "2018-02-13T19:10:31.0800943Z",
        "DocumentedDateTime": "2018-02-13T19:10:31.0800943Z",
        "Dose": "sample string 3",
        "DoseUnit": "sample string 4",
        "DoseDuration": "sample string 5",
        "Rate": "sample string 6",
        "RateUnit": "sample string 7"
      },
      {
        "AdministrationAction": "sample string 1",
        "AdministrationClinician": "sample string 2",
        "AdministrationDateTime": "2018-02-13T19:10:31.0800943Z",
        "DocumentedDateTime": "2018-02-13T19:10:31.0800943Z",
        "Dose": "sample string 3",
        "DoseUnit": "sample string 4",
        "DoseDuration": "sample string 5",
        "Rate": "sample string 6",
        "RateUnit": "sample string 7"
      }
    ],
    "MedicationAlias": "sample string 10",
    "MedicationCategory": "sample string 11",
    "MedicationClinicalDisplayLineLong": "sample string 12",
    "MedicationClinicalDisplayLineShort": "sample string 13",
    "MedicationComments": "sample string 14",
    "MedicationCommunicationType": "sample string 15",
    "MedicationDepartmentStatus": "sample string 16",
    "MedicationDetails": [
      {
        "Code": "sample string 1",
        "Display": "sample string 2",
        "DisplaySequence": "sample string 3",
        "GroupSequence": "sample string 4",
        "Value": "sample string 5"
      },
      {
        "Code": "sample string 1",
        "Display": "sample string 2",
        "DisplaySequence": "sample string 3",
        "GroupSequence": "sample string 4",
        "Value": "sample string 5"
      }
    ],
    "MedicationName": "sample string 17",
    "MedicationOrderBasis": "sample string 18",
    "MedicationOrderId": "sample string 19",
    "MedicationOrderingProvider": "sample string 20",
    "MedicationOrderingProviderId": "sample string 21",
    "MedicationOrderPriority": "sample string 22",
    "MedicationOrderType": "sample string 23",
    "MedicationStatus": "sample string 24",
    "MedicationType": "sample string 25",
    "Ingredients": [
      {
        "AHFS": [
          "sample string 1",
          "sample string 2"
        ],
        "IngredientId": "sample string 1",
        "IngredientName": "sample string 2",
        "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 3",
        "Dose": "sample string 4",
        "DoseUnit": "sample string 5"
      },
      {
        "AHFS": [
          "sample string 1",
          "sample string 2"
        ],
        "IngredientId": "sample string 1",
        "IngredientName": "sample string 2",
        "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 3",
        "Dose": "sample string 4",
        "DoseUnit": "sample string 5"
      }
    ],
    "OrderedDateTime": "2018-02-13T19:10:31.0800943Z",
    "PatientId": "sample string 26",
    "PatientClass": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "PCA": true,
    "Pharmacy": {
      "PharmacyId": "sample string 1",
      "PharmacyName": "sample string 2",
      "NCPDP": "sample string 3",
      "IsIntegratedRetail": true
    },
    "ReferenceType": "sample string 27",
    "Route": "sample string 28",
    "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": "2018-02-13T19:10:31.0800943Z",
    "StopDateTime": "2018-02-13T19:10:31.0800943Z",
    "StopType": "sample string 29",
    "StrengthDose": "sample string 30",
    "StrengthDoseUnit": "sample string 31",
    "Titrate": true,
    "TherapeuticSubClass": "sample string 32",
    "TherapeuticClass": "sample string 33",
    "VolumeDose": "sample string 34",
    "VolumeDoseUnit": "sample string 35",
    "NDC": "sample string 36",
    "IsPRN": true,
    "PrnReasons": [
      {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      {
        "Id": "sample string 1",
        "Name": "sample string 2"
      }
    ],
    "PrnComment": "sample string 37",
    "Refills": "sample string 38",
    "LongTermMedication": true,
    "PreviousOrderId": "sample string 39",
    "DispenseAsWritten": true,
    "DEASchedule": "sample string 40",
    "MedicationBrandName": "sample string 41",
    "MedicationGenericName": "sample string 42",
    "Diagnoses": [
      {
        "DiagnosisName": "sample string 1",
        "Codes": [
          {
            "CodeSet": "sample string 1",
            "Code": "sample string 2",
            "Description": "sample string 3"
          },
          {
            "CodeSet": "sample string 1",
            "Code": "sample string 2",
            "Description": "sample string 3"
          }
        ],
        "Comment": "sample string 2",
        "Qualifier": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        }
      },
      {
        "DiagnosisName": "sample string 1",
        "Codes": [
          {
            "CodeSet": "sample string 1",
            "Code": "sample string 2",
            "Description": "sample string 3"
          },
          {
            "CodeSet": "sample string 1",
            "Code": "sample string 2",
            "Description": "sample string 3"
          }
        ],
        "Comment": "sample string 2",
        "Qualifier": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        }
      }
    ]
  }
}

Sample Message

<MedicationSingleOrderResponseViewModel xmlns:i="https://www.w3.org/2001/XMLSchema-instance" xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models">
  <MedicationOrder>
    <AHFS xmlns:d3p1="https://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </AHFS>
    <Action>sample string 1</Action>
    <AdminInstructions>sample string 2</AdminInstructions>
    <AlternativeMedicationName>sample string 3</AlternativeMedicationName>
    <DEASchedule>sample string 40</DEASchedule>
    <Diagnoses xmlns:d3p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:OrderDiagnosisViewModel>
        <d3p1:Codes>
          <d3p1:DiagnosisCodeViewModel>
            <d3p1:Code>sample string 2</d3p1:Code>
            <d3p1:CodeSet>sample string 1</d3p1:CodeSet>
            <d3p1:Description>sample string 3</d3p1:Description>
          </d3p1:DiagnosisCodeViewModel>
          <d3p1:DiagnosisCodeViewModel>
            <d3p1:Code>sample string 2</d3p1:Code>
            <d3p1:CodeSet>sample string 1</d3p1:CodeSet>
            <d3p1:Description>sample string 3</d3p1:Description>
          </d3p1:DiagnosisCodeViewModel>
        </d3p1:Codes>
        <d3p1:Comment>sample string 2</d3p1:Comment>
        <d3p1:DiagnosisName>sample string 1</d3p1:DiagnosisName>
        <d3p1:Qualifier>
          <d3p1:Id>sample string 1</d3p1:Id>
          <d3p1:Name>sample string 2</d3p1:Name>
        </d3p1:Qualifier>
      </d3p1:OrderDiagnosisViewModel>
      <d3p1:OrderDiagnosisViewModel>
        <d3p1:Codes>
          <d3p1:DiagnosisCodeViewModel>
            <d3p1:Code>sample string 2</d3p1:Code>
            <d3p1:CodeSet>sample string 1</d3p1:CodeSet>
            <d3p1:Description>sample string 3</d3p1:Description>
          </d3p1:DiagnosisCodeViewModel>
          <d3p1:DiagnosisCodeViewModel>
            <d3p1:Code>sample string 2</d3p1:Code>
            <d3p1:CodeSet>sample string 1</d3p1:CodeSet>
            <d3p1:Description>sample string 3</d3p1:Description>
          </d3p1:DiagnosisCodeViewModel>
        </d3p1:Codes>
        <d3p1:Comment>sample string 2</d3p1:Comment>
        <d3p1:DiagnosisName>sample string 1</d3p1:DiagnosisName>
        <d3p1:Qualifier>
          <d3p1:Id>sample string 1</d3p1:Id>
          <d3p1:Name>sample string 2</d3p1:Name>
        </d3p1:Qualifier>
      </d3p1:OrderDiagnosisViewModel>
    </Diagnoses>
    <DispenseAsWritten>true</DispenseAsWritten>
    <DrugForm>sample string 4</DrugForm>
    <Duration>sample string 5</Duration>
    <DurationUnit>sample string 6</DurationUnit>
    <EncounterId>sample string 7</EncounterId>
    <EncounterType xmlns:d3p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:Id>sample string 1</d3p1:Id>
      <d3p1:Name>sample string 2</d3p1:Name>
    </EncounterType>
    <Frequency>sample string 8</Frequency>
    <FrequencyType>sample string 9</FrequencyType>
    <Ingredients xmlns:d3p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:IngredientViewModel>
        <d3p1:AHFS xmlns:d5p1="https://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </d3p1:AHFS>
        <d3p1:Dose>sample string 4</d3p1:Dose>
        <d3p1:DoseUnit>sample string 5</d3p1:DoseUnit>
        <d3p1:IngredientId>sample string 1</d3p1:IngredientId>
        <d3p1:IngredientName>sample string 2</d3p1:IngredientName>
        <d3p1:IngredientRxNorms>
          <d3p1:RxNormViewModel>
            <d3p1:Code>sample string 1</d3p1:Code>
            <d3p1:CodeType>sample string 2</d3p1:CodeType>
            <d3p1:TermType>sample string 3</d3p1:TermType>
          </d3p1:RxNormViewModel>
          <d3p1:RxNormViewModel>
            <d3p1:Code>sample string 1</d3p1:Code>
            <d3p1:CodeType>sample string 2</d3p1:CodeType>
            <d3p1:TermType>sample string 3</d3p1:TermType>
          </d3p1:RxNormViewModel>
        </d3p1:IngredientRxNorms>
        <d3p1:NDC>sample string 3</d3p1:NDC>
      </d3p1:IngredientViewModel>
      <d3p1:IngredientViewModel>
        <d3p1:AHFS xmlns:d5p1="https://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </d3p1:AHFS>
        <d3p1:Dose>sample string 4</d3p1:Dose>
        <d3p1:DoseUnit>sample string 5</d3p1:DoseUnit>
        <d3p1:IngredientId>sample string 1</d3p1:IngredientId>
        <d3p1:IngredientName>sample string 2</d3p1:IngredientName>
        <d3p1:IngredientRxNorms>
          <d3p1:RxNormViewModel>
            <d3p1:Code>sample string 1</d3p1:Code>
            <d3p1:CodeType>sample string 2</d3p1:CodeType>
            <d3p1:TermType>sample string 3</d3p1:TermType>
          </d3p1:RxNormViewModel>
          <d3p1:RxNormViewModel>
            <d3p1:Code>sample string 1</d3p1:Code>
            <d3p1:CodeType>sample string 2</d3p1:CodeType>
            <d3p1:TermType>sample string 3</d3p1:TermType>
          </d3p1:RxNormViewModel>
        </d3p1:IngredientRxNorms>
        <d3p1:NDC>sample string 3</d3p1:NDC>
      </d3p1:IngredientViewModel>
    </Ingredients>
    <IsPRN>true</IsPRN>
    <LongTermMedication>true</LongTermMedication>
    <MedAdministrations xmlns:d3p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:MedAdministrationViewModel>
        <d3p1:AdministrationAction>sample string 1</d3p1:AdministrationAction>
        <d3p1:AdministrationClinician>sample string 2</d3p1:AdministrationClinician>
        <d3p1:AdministrationDateTime>2018-02-13T13:10:31.0800943-06:00</d3p1:AdministrationDateTime>
        <d3p1:DocumentedDateTime>2018-02-13T13:10:31.0800943-06:00</d3p1:DocumentedDateTime>
        <d3p1:Dose>sample string 3</d3p1:Dose>
        <d3p1:DoseDuration>sample string 5</d3p1:DoseDuration>
        <d3p1:DoseUnit>sample string 4</d3p1:DoseUnit>
        <d3p1:Rate>sample string 6</d3p1:Rate>
        <d3p1:RateUnit>sample string 7</d3p1:RateUnit>
      </d3p1:MedAdministrationViewModel>
      <d3p1:MedAdministrationViewModel>
        <d3p1:AdministrationAction>sample string 1</d3p1:AdministrationAction>
        <d3p1:AdministrationClinician>sample string 2</d3p1:AdministrationClinician>
        <d3p1:AdministrationDateTime>2018-02-13T13:10:31.0800943-06:00</d3p1:AdministrationDateTime>
        <d3p1:DocumentedDateTime>2018-02-13T13:10:31.0800943-06:00</d3p1:DocumentedDateTime>
        <d3p1:Dose>sample string 3</d3p1:Dose>
        <d3p1:DoseDuration>sample string 5</d3p1:DoseDuration>
        <d3p1:DoseUnit>sample string 4</d3p1:DoseUnit>
        <d3p1:Rate>sample string 6</d3p1:Rate>
        <d3p1:RateUnit>sample string 7</d3p1:RateUnit>
      </d3p1:MedAdministrationViewModel>
    </MedAdministrations>
    <MedicationAlias>sample string 10</MedicationAlias>
    <MedicationBrandName>sample string 41</MedicationBrandName>
    <MedicationCategory>sample string 11</MedicationCategory>
    <MedicationClinicalDisplayLineLong>sample string 12</MedicationClinicalDisplayLineLong>
    <MedicationClinicalDisplayLineShort>sample string 13</MedicationClinicalDisplayLineShort>
    <MedicationComments>sample string 14</MedicationComments>
    <MedicationCommunicationType>sample string 15</MedicationCommunicationType>
    <MedicationDepartmentStatus>sample string 16</MedicationDepartmentStatus>
    <MedicationDetails xmlns:d3p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:MedicationDetailViewModel>
        <d3p1:Code>sample string 1</d3p1:Code>
        <d3p1:Display>sample string 2</d3p1:Display>
        <d3p1:DisplaySequence>sample string 3</d3p1:DisplaySequence>
        <d3p1:GroupSequence>sample string 4</d3p1:GroupSequence>
        <d3p1:Value>sample string 5</d3p1:Value>
      </d3p1:MedicationDetailViewModel>
      <d3p1:MedicationDetailViewModel>
        <d3p1:Code>sample string 1</d3p1:Code>
        <d3p1:Display>sample string 2</d3p1:Display>
        <d3p1:DisplaySequence>sample string 3</d3p1:DisplaySequence>
        <d3p1:GroupSequence>sample string 4</d3p1:GroupSequence>
        <d3p1:Value>sample string 5</d3p1:Value>
      </d3p1:MedicationDetailViewModel>
    </MedicationDetails>
    <MedicationGenericName>sample string 42</MedicationGenericName>
    <MedicationName>sample string 17</MedicationName>
    <MedicationOrderBasis>sample string 18</MedicationOrderBasis>
    <MedicationOrderId>sample string 19</MedicationOrderId>
    <MedicationOrderPriority>sample string 22</MedicationOrderPriority>
    <MedicationOrderType>sample string 23</MedicationOrderType>
    <MedicationOrderingProvider>sample string 20</MedicationOrderingProvider>
    <MedicationOrderingProviderId>sample string 21</MedicationOrderingProviderId>
    <MedicationStatus>sample string 24</MedicationStatus>
    <MedicationType>sample string 25</MedicationType>
    <NDC>sample string 36</NDC>
    <OrderedDateTime>2018-02-13T13:10:31.0800943-06:00</OrderedDateTime>
    <PCA>true</PCA>
    <PatientClass xmlns:d3p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:Id>sample string 1</d3p1:Id>
      <d3p1:Name>sample string 2</d3p1:Name>
    </PatientClass>
    <PatientId>sample string 26</PatientId>
    <Pharmacy xmlns:d3p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:IsIntegratedRetail>true</d3p1:IsIntegratedRetail>
      <d3p1:NCPDP>sample string 3</d3p1:NCPDP>
      <d3p1:PharmacyId>sample string 1</d3p1:PharmacyId>
      <d3p1:PharmacyName>sample string 2</d3p1:PharmacyName>
    </Pharmacy>
    <PreviousOrderId>sample string 39</PreviousOrderId>
    <PrnComment>sample string 37</PrnComment>
    <PrnReasons xmlns:d3p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:CodedObjectViewModel>
        <d3p1:Id>sample string 1</d3p1:Id>
        <d3p1:Name>sample string 2</d3p1:Name>
      </d3p1:CodedObjectViewModel>
      <d3p1:CodedObjectViewModel>
        <d3p1:Id>sample string 1</d3p1:Id>
        <d3p1:Name>sample string 2</d3p1:Name>
      </d3p1:CodedObjectViewModel>
    </PrnReasons>
    <ReferenceType>sample string 27</ReferenceType>
    <Refills>sample string 38</Refills>
    <Route>sample string 28</Route>
    <RxNorms xmlns:d3p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:RxNormViewModel>
        <d3p1:Code>sample string 1</d3p1:Code>
        <d3p1:CodeType>sample string 2</d3p1:CodeType>
        <d3p1:TermType>sample string 3</d3p1:TermType>
      </d3p1:RxNormViewModel>
      <d3p1:RxNormViewModel>
        <d3p1:Code>sample string 1</d3p1:Code>
        <d3p1:CodeType>sample string 2</d3p1:CodeType>
        <d3p1:TermType>sample string 3</d3p1:TermType>
      </d3p1:RxNormViewModel>
    </RxNorms>
    <StartDateTime>2018-02-13T13:10:31.0800943-06:00</StartDateTime>
    <StopDateTime>2018-02-13T13:10:31.0800943-06:00</StopDateTime>
    <StopType>sample string 29</StopType>
    <StrengthDose>sample string 30</StrengthDose>
    <StrengthDoseUnit>sample string 31</StrengthDoseUnit>
    <TherapeuticClass>sample string 33</TherapeuticClass>
    <TherapeuticSubClass>sample string 32</TherapeuticSubClass>
    <Titrate>true</Titrate>
    <VolumeDose>sample string 34</VolumeDose>
    <VolumeDoseUnit>sample string 35</VolumeDoseUnit>
  </MedicationOrder>
</MedicationSingleOrderResponseViewModel>