GET api/v1/{practiceid}/clinical/encounters/{encounterId}/lookupprescription/{lookupfilter}

Get filtered Medicines

Request Information

URI Parameters

NameDescriptionTypeAdditional information
practiceid

Unique identifier of practice

 globally unique identifier

Required
encounterId

globally unique identifier

Required
lookupfilter

Minimum length of filter is 3 characters

 string

Required

Body Parameters

None.

Response Information

Resource Description

Template with array of Medicines

Collection of Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects.MedicationPrescriptionLine
NameDescriptionTypeAdditional information
Quantity

This is the quantity of the resource, as prescribed.

 integer

None.
LineNum

This element contains the current line item’s number. It is unique per Medication Prescription. If supplied, this element begins its numbering at ‘1’ (not ‘0’).

 integer

None.
MedicationDescription

A description of the medicine name or the consumable material utilised.

 string

None.
NappiCode

string

None.
DosageUnits

This defines the dosage to be taken by the patient at each instance (e.g. 2 tablets)

 decimal number

None.
DosageType

This defines the dosage to be taken by the patient at each instance (e.g. 2 tablets) Dosage Type (pills, tablet, ml, teaspoon)

 string

None.
FrequencyUnits

How often should the dosage be repeated. Works in conjunction with FrequecyUnits, FrequencyMax, PeriodUnits and Period fields. (e.g. "TWO times every one day") Naming of fields derived from FHIR 1.0.2: https://www.hl7.org/fhir/datatypes.html#Timing

 integer

None.
FrequencyMax

How often should the dosage be repeated. Works in conjunction with FrequecyUnits, FrequencyMax, PeriodUnits and Period fields. (e.g. "two - THREE times every one day") Optional field. Naming of fields derived from FHIR 1.0.2: https://www.hl7.org/fhir/datatypes.html#Timing

 integer

None.
PeriodUnit

How often should the dosage be repeated. Works in conjunction with FrequecyUnits, FrequencyMax, PeriodUnits and Period fields. (e.g. "two times every ONE day") Naming of fields derived from FHIR 1.0.2: https://www.hl7.org/fhir/datatypes.html#Timing

 integer

None.
PeriodType

How often should the dosage be repeated. Works in conjunction with FrequecyUnits, PeriodUnits and Period fields. (e.g. "two times every one DAY") Period (Hours, Days, Weeks, Months) Naming of fields derived from FHIR 1.0.2: https://www.hl7.org/fhir/datatypes.html#Timing

 string

None.
DurationUnit

For how long should the patient type the medication (e.g. for 2 weeks)

 integer

None.
DurationType

For how long should the patient type the medication (e.g. for 2 weeks) Duration Type (Hours, Days, Weeks, Months)

 string

None.
Repeat

Number of times the patient may refill the prescription at the pharmacy. NULL typically means "0", i.e. no repeats

 integer

None.
ChronicIndicator

Indicate medicine type: chronic or acute. Default is "false", i.e. Acute. Can be defaulted by the ChronicIndicator on the Encounter

 boolean

None.
AllowGeneric

Indicate to the dispensing pharmacist whether a Generic may be substituted

 boolean

None.
Diagnosis

Diagnosis that is applied to the particular line. For example, a particular medication may be linked to a Chronic condition explicitly, whereas cough medicine linked to a different condition the patient may have. In some instances conditions are not explicitly required, especially for over-the-counter medication.

 Collection of Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects.DiagnosisVo

None.
DispensingInstructions

This optional field may provide the Dispensing Pharmacist with additional instructions. For instance, explicitly suggesting substitutions as needed.

 string

None.
AdministrationInstructions

This optional field may provide the Patient with additional instructions for the administration of the medication. For instance, should be taken after meals, should be taken at night, etc.

 string

None.
Description

string

None.
CreatedFrom

string

None.
AccelerateLearning

boolean

None.
Parameters

Dictionary of string [key] and string [value]

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "Quantity": 1,
    "LineNum": 2,
    "MedicationDescription": "sample string 3",
    "NappiCode": "sample string 4",
    "DosageUnits": 5.0,
    "DosageType": "sample string 6",
    "FrequencyUnits": 7,
    "FrequencyMax": 8,
    "PeriodUnit": 9,
    "PeriodType": "sample string 10",
    "DurationUnit": 11,
    "DurationType": "sample string 12",
    "Repeat": 13,
    "ChronicIndicator": true,
    "AllowGeneric": true,
    "Diagnosis": [
      {
        "Id": "3e2f3364-990e-48a5-9f97-50da144cbe94",
        "DiagnosisCode": "sample string 2",
        "DiagnosisDescription": "sample string 3",
        "SpecificCode": true,
        "PrimaryIndicator": true,
        "ValidPrimary": true,
        "ValidSequelae": true,
        "MaxSpecificity": true,
        "Gender": "sample string 9",
        "AgeRangeStart": 1,
        "AgeRangeEnd": 1,
        "DiagnosisToken": "sample string 10",
        "DiagnosisTokenDescription": "sample string 11",
        "IcdSource": "sample string 12",
        "OrderNo": 13
      },
      {
        "Id": "3e2f3364-990e-48a5-9f97-50da144cbe94",
        "DiagnosisCode": "sample string 2",
        "DiagnosisDescription": "sample string 3",
        "SpecificCode": true,
        "PrimaryIndicator": true,
        "ValidPrimary": true,
        "ValidSequelae": true,
        "MaxSpecificity": true,
        "Gender": "sample string 9",
        "AgeRangeStart": 1,
        "AgeRangeEnd": 1,
        "DiagnosisToken": "sample string 10",
        "DiagnosisTokenDescription": "sample string 11",
        "IcdSource": "sample string 12",
        "OrderNo": 13
      }
    ],
    "DispensingInstructions": "sample string 16",
    "AdministrationInstructions": "sample string 17",
    "Description": "sample string 18",
    "CreatedFrom": "sample string 19",
    "AccelerateLearning": true,
    "Parameters": {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    }
  },
  {
    "Quantity": 1,
    "LineNum": 2,
    "MedicationDescription": "sample string 3",
    "NappiCode": "sample string 4",
    "DosageUnits": 5.0,
    "DosageType": "sample string 6",
    "FrequencyUnits": 7,
    "FrequencyMax": 8,
    "PeriodUnit": 9,
    "PeriodType": "sample string 10",
    "DurationUnit": 11,
    "DurationType": "sample string 12",
    "Repeat": 13,
    "ChronicIndicator": true,
    "AllowGeneric": true,
    "Diagnosis": [
      {
        "Id": "3e2f3364-990e-48a5-9f97-50da144cbe94",
        "DiagnosisCode": "sample string 2",
        "DiagnosisDescription": "sample string 3",
        "SpecificCode": true,
        "PrimaryIndicator": true,
        "ValidPrimary": true,
        "ValidSequelae": true,
        "MaxSpecificity": true,
        "Gender": "sample string 9",
        "AgeRangeStart": 1,
        "AgeRangeEnd": 1,
        "DiagnosisToken": "sample string 10",
        "DiagnosisTokenDescription": "sample string 11",
        "IcdSource": "sample string 12",
        "OrderNo": 13
      },
      {
        "Id": "3e2f3364-990e-48a5-9f97-50da144cbe94",
        "DiagnosisCode": "sample string 2",
        "DiagnosisDescription": "sample string 3",
        "SpecificCode": true,
        "PrimaryIndicator": true,
        "ValidPrimary": true,
        "ValidSequelae": true,
        "MaxSpecificity": true,
        "Gender": "sample string 9",
        "AgeRangeStart": 1,
        "AgeRangeEnd": 1,
        "DiagnosisToken": "sample string 10",
        "DiagnosisTokenDescription": "sample string 11",
        "IcdSource": "sample string 12",
        "OrderNo": 13
      }
    ],
    "DispensingInstructions": "sample string 16",
    "AdministrationInstructions": "sample string 17",
    "Description": "sample string 18",
    "CreatedFrom": "sample string 19",
    "AccelerateLearning": true,
    "Parameters": {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    }
  }
]

application/xml, text/xml

Sample: 
<ArrayOfMedicationPrescriptionLine xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://mpsapi.healthbridge.com/clinical/clinical/v1/medicationprescription/">
  <MedicationPrescriptionLine>
    <AccelerateLearning>true</AccelerateLearning>
    <AdministrationInstructions>sample string 17</AdministrationInstructions>
    <AllowGeneric>true</AllowGeneric>
    <ChronicIndicator>true</ChronicIndicator>
    <CreatedFrom>sample string 19</CreatedFrom>
    <Description>sample string 18</Description>
    <Diagnosis xmlns:d3p1="http://mpsapi.healthbridge.com/clinical/clinical/v1/encounter/">
      <d3p1:Diagnosis>
        <d3p1:AgeRangeEnd>1</d3p1:AgeRangeEnd>
        <d3p1:AgeRangeStart>1</d3p1:AgeRangeStart>
        <d3p1:DiagnosisCode>sample string 2</d3p1:DiagnosisCode>
        <d3p1:DiagnosisDescription>sample string 3</d3p1:DiagnosisDescription>
        <d3p1:DiagnosisToken>sample string 10</d3p1:DiagnosisToken>
        <d3p1:DiagnosisTokenDescription>sample string 11</d3p1:DiagnosisTokenDescription>
        <d3p1:Gender>sample string 9</d3p1:Gender>
        <d3p1:IcdSource>sample string 12</d3p1:IcdSource>
        <d3p1:Id>3e2f3364-990e-48a5-9f97-50da144cbe94</d3p1:Id>
        <d3p1:MaxSpecificity>true</d3p1:MaxSpecificity>
        <d3p1:OrderNo>13</d3p1:OrderNo>
        <d3p1:PrimaryIndicator>true</d3p1:PrimaryIndicator>
        <d3p1:SpecificCode>true</d3p1:SpecificCode>
        <d3p1:ValidPrimary>true</d3p1:ValidPrimary>
        <d3p1:ValidSequelae>true</d3p1:ValidSequelae>
      </d3p1:Diagnosis>
      <d3p1:Diagnosis>
        <d3p1:AgeRangeEnd>1</d3p1:AgeRangeEnd>
        <d3p1:AgeRangeStart>1</d3p1:AgeRangeStart>
        <d3p1:DiagnosisCode>sample string 2</d3p1:DiagnosisCode>
        <d3p1:DiagnosisDescription>sample string 3</d3p1:DiagnosisDescription>
        <d3p1:DiagnosisToken>sample string 10</d3p1:DiagnosisToken>
        <d3p1:DiagnosisTokenDescription>sample string 11</d3p1:DiagnosisTokenDescription>
        <d3p1:Gender>sample string 9</d3p1:Gender>
        <d3p1:IcdSource>sample string 12</d3p1:IcdSource>
        <d3p1:Id>3e2f3364-990e-48a5-9f97-50da144cbe94</d3p1:Id>
        <d3p1:MaxSpecificity>true</d3p1:MaxSpecificity>
        <d3p1:OrderNo>13</d3p1:OrderNo>
        <d3p1:PrimaryIndicator>true</d3p1:PrimaryIndicator>
        <d3p1:SpecificCode>true</d3p1:SpecificCode>
        <d3p1:ValidPrimary>true</d3p1:ValidPrimary>
        <d3p1:ValidSequelae>true</d3p1:ValidSequelae>
      </d3p1:Diagnosis>
    </Diagnosis>
    <DispensingInstructions>sample string 16</DispensingInstructions>
    <DosageType>sample string 6</DosageType>
    <DosageUnits>5</DosageUnits>
    <DurationType>sample string 12</DurationType>
    <DurationUnit>11</DurationUnit>
    <FrequencyMax>8</FrequencyMax>
    <FrequencyUnits>7</FrequencyUnits>
    <LineNum>2</LineNum>
    <MedicationDescription>sample string 3</MedicationDescription>
    <NappiCode>sample string 4</NappiCode>
    <Parameters xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value>sample string 2</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 3</d3p1:Key>
        <d3p1:Value>sample string 4</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Parameters>
    <PeriodType>sample string 10</PeriodType>
    <PeriodUnit>9</PeriodUnit>
    <Quantity>1</Quantity>
    <Repeat>13</Repeat>
  </MedicationPrescriptionLine>
  <MedicationPrescriptionLine>
    <AccelerateLearning>true</AccelerateLearning>
    <AdministrationInstructions>sample string 17</AdministrationInstructions>
    <AllowGeneric>true</AllowGeneric>
    <ChronicIndicator>true</ChronicIndicator>
    <CreatedFrom>sample string 19</CreatedFrom>
    <Description>sample string 18</Description>
    <Diagnosis xmlns:d3p1="http://mpsapi.healthbridge.com/clinical/clinical/v1/encounter/">
      <d3p1:Diagnosis>
        <d3p1:AgeRangeEnd>1</d3p1:AgeRangeEnd>
        <d3p1:AgeRangeStart>1</d3p1:AgeRangeStart>
        <d3p1:DiagnosisCode>sample string 2</d3p1:DiagnosisCode>
        <d3p1:DiagnosisDescription>sample string 3</d3p1:DiagnosisDescription>
        <d3p1:DiagnosisToken>sample string 10</d3p1:DiagnosisToken>
        <d3p1:DiagnosisTokenDescription>sample string 11</d3p1:DiagnosisTokenDescription>
        <d3p1:Gender>sample string 9</d3p1:Gender>
        <d3p1:IcdSource>sample string 12</d3p1:IcdSource>
        <d3p1:Id>3e2f3364-990e-48a5-9f97-50da144cbe94</d3p1:Id>
        <d3p1:MaxSpecificity>true</d3p1:MaxSpecificity>
        <d3p1:OrderNo>13</d3p1:OrderNo>
        <d3p1:PrimaryIndicator>true</d3p1:PrimaryIndicator>
        <d3p1:SpecificCode>true</d3p1:SpecificCode>
        <d3p1:ValidPrimary>true</d3p1:ValidPrimary>
        <d3p1:ValidSequelae>true</d3p1:ValidSequelae>
      </d3p1:Diagnosis>
      <d3p1:Diagnosis>
        <d3p1:AgeRangeEnd>1</d3p1:AgeRangeEnd>
        <d3p1:AgeRangeStart>1</d3p1:AgeRangeStart>
        <d3p1:DiagnosisCode>sample string 2</d3p1:DiagnosisCode>
        <d3p1:DiagnosisDescription>sample string 3</d3p1:DiagnosisDescription>
        <d3p1:DiagnosisToken>sample string 10</d3p1:DiagnosisToken>
        <d3p1:DiagnosisTokenDescription>sample string 11</d3p1:DiagnosisTokenDescription>
        <d3p1:Gender>sample string 9</d3p1:Gender>
        <d3p1:IcdSource>sample string 12</d3p1:IcdSource>
        <d3p1:Id>3e2f3364-990e-48a5-9f97-50da144cbe94</d3p1:Id>
        <d3p1:MaxSpecificity>true</d3p1:MaxSpecificity>
        <d3p1:OrderNo>13</d3p1:OrderNo>
        <d3p1:PrimaryIndicator>true</d3p1:PrimaryIndicator>
        <d3p1:SpecificCode>true</d3p1:SpecificCode>
        <d3p1:ValidPrimary>true</d3p1:ValidPrimary>
        <d3p1:ValidSequelae>true</d3p1:ValidSequelae>
      </d3p1:Diagnosis>
    </Diagnosis>
    <DispensingInstructions>sample string 16</DispensingInstructions>
    <DosageType>sample string 6</DosageType>
    <DosageUnits>5</DosageUnits>
    <DurationType>sample string 12</DurationType>
    <DurationUnit>11</DurationUnit>
    <FrequencyMax>8</FrequencyMax>
    <FrequencyUnits>7</FrequencyUnits>
    <LineNum>2</LineNum>
    <MedicationDescription>sample string 3</MedicationDescription>
    <NappiCode>sample string 4</NappiCode>
    <Parameters xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value>sample string 2</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 3</d3p1:Key>
        <d3p1:Value>sample string 4</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Parameters>
    <PeriodType>sample string 10</PeriodType>
    <PeriodUnit>9</PeriodUnit>
    <Quantity>1</Quantity>
    <Repeat>13</Repeat>
  </MedicationPrescriptionLine>
</ArrayOfMedicationPrescriptionLine>