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

Get filtered Modifier

Request Information

URI Parameters

Name	Description	Type	Additional 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 Procedures

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

Name	Description	Type	Additional information
DateOfService	This element contains the date of service.	date	None.
LineNum	This element contains the current line item’s number. It is unique per claim. If supplied, this element begins its numbering at ‘1’ (not ‘0’).	integer	None.
LineType	The type of line item. Valid options for this element are: • Procedure • Medicine • Mixture • Consumable • Modifier • Third Party Claim • Third Party Invoice • Optometry • Dental Lab Slip	string	None.
ChargeCode		string	None.
ChargeDesc	A description of the actual procedure performed or the medicine name or the consumable material utilised.	string	None.
NappiCode		string	None.
ChargeUnits	This is the unit of measurement for the above quantity. It is a fixed set of values and it consists of the following options: • Days • Hours • Kilometres • Minutes • Seconds • Units	string	None.
DosageUnit	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.
FrequencyUnit	How often should the dosage be repeated (e.g. twice per the day morning and night, once per week)	integer	None.
FrequencyType	How often should the dosage be repeated (e.g. twice per the day morning and night, once per week) Frequency Type (Hours, Days, Weeks, Months)	string	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.	integer	None.
ChronicIndicator	Indicate medicine type: chronic or acute	boolean	None.
ChargeQuan	This is the quantity of the resource, as prescribed.	integer	None.
TotalExcVat	This is the line amount being invoiced, excluding VAT, in Rands Calculated as: (Quantity * UnitPrice)	decimal number	None.
VatAmount	This is the portion of vat of Amount. Calculation: Round(AmountExVat * 0.14, 2) For procedures, no VAT is charged, or VAT of 0	decimal number	None.
TotalIncVat	This is the line amount being invoiced, including VAT, in Rands Calculated as: AmountExVat + VatAmount	decimal number	None.
Amount	This is the line amount being calculated based on modifier rule	decimal number	None.
Parameters		Dictionary of string [key] and string [value]	None.
Responses		Dictionary of string [key] and string [value]	None.
ChargeStart		date	None.
ChargeEnd		date	None.
PriceOverride	Indicate if TotalIncVat field contains manual price captured by the doctor	boolean	None.
AccelerateLearning		boolean	None.
UnitPrice	This is the UnitPrice for the line item.	decimal number	None.
SchemeRule	Status based on formulary list (allowed, disallowed, not applicable)	string	None.
CreatedFrom		string	None.
Diagnosis		Collection of Com.Healthbridge.Hhas.Billing.Interface.ValueObjects.DiagnosisVo	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "DateOfService": "2025-04-16T13:52:11Z",
    "LineNum": 2,
    "LineType": "sample string 3",
    "ChargeCode": "sample string 4",
    "ChargeDesc": "sample string 5",
    "NappiCode": "sample string 6",
    "ChargeUnits": "sample string 7",
    "DosageUnit": 8.1,
    "DosageType": "sample string 9",
    "FrequencyUnit": 10,
    "FrequencyType": "sample string 11",
    "PeriodUnit": 12,
    "PeriodType": "sample string 13",
    "DurationUnit": 14,
    "DurationType": "sample string 15",
    "Repeat": 16,
    "ChronicIndicator": true,
    "ChargeQuan": 18,
    "TotalExcVat": 19.0,
    "VatAmount": 20.0,
    "TotalIncVat": 21.0,
    "Amount": 22.0,
    "Parameters": {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    },
    "Responses": {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    },
    "ChargeStart": "2025-04-16T13:52:11Z",
    "ChargeEnd": "2025-04-16T13:52:11Z",
    "PriceOverride": true,
    "AccelerateLearning": true,
    "UnitPrice": 25.0,
    "SchemeRule": "sample string 26",
    "CreatedFrom": "sample string 27",
    "Diagnosis": [
      {
        "Id": "6b914579-6c15-4a6b-9adf-c0b626f3d5ef",
        "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
      },
      {
        "Id": "6b914579-6c15-4a6b-9adf-c0b626f3d5ef",
        "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
      }
    ]
  },
  {
    "DateOfService": "2025-04-16T13:52:11Z",
    "LineNum": 2,
    "LineType": "sample string 3",
    "ChargeCode": "sample string 4",
    "ChargeDesc": "sample string 5",
    "NappiCode": "sample string 6",
    "ChargeUnits": "sample string 7",
    "DosageUnit": 8.1,
    "DosageType": "sample string 9",
    "FrequencyUnit": 10,
    "FrequencyType": "sample string 11",
    "PeriodUnit": 12,
    "PeriodType": "sample string 13",
    "DurationUnit": 14,
    "DurationType": "sample string 15",
    "Repeat": 16,
    "ChronicIndicator": true,
    "ChargeQuan": 18,
    "TotalExcVat": 19.0,
    "VatAmount": 20.0,
    "TotalIncVat": 21.0,
    "Amount": 22.0,
    "Parameters": {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    },
    "Responses": {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    },
    "ChargeStart": "2025-04-16T13:52:11Z",
    "ChargeEnd": "2025-04-16T13:52:11Z",
    "PriceOverride": true,
    "AccelerateLearning": true,
    "UnitPrice": 25.0,
    "SchemeRule": "sample string 26",
    "CreatedFrom": "sample string 27",
    "Diagnosis": [
      {
        "Id": "6b914579-6c15-4a6b-9adf-c0b626f3d5ef",
        "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
      },
      {
        "Id": "6b914579-6c15-4a6b-9adf-c0b626f3d5ef",
        "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
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfEncounterLineItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://mpsapi.healthbridge.com/clinical/clinical/v1/encounter/">
  <EncounterLineItem>
    <AccelerateLearning>true</AccelerateLearning>
    <Amount>22</Amount>
    <ChargeCode>sample string 4</ChargeCode>
    <ChargeDesc>sample string 5</ChargeDesc>
    <ChargeEnd>2025-04-16T13:52:11.5634764+02:00</ChargeEnd>
    <ChargeQuan>18</ChargeQuan>
    <ChargeStart>2025-04-16T13:52:11.5634764+02:00</ChargeStart>
    <ChargeUnits>sample string 7</ChargeUnits>
    <ChronicIndicator>true</ChronicIndicator>
    <CreatedFrom>sample string 27</CreatedFrom>
    <DateOfService>2025-04-16T13:52:11.5634764+02:00</DateOfService>
    <Diagnosis xmlns:d3p1="http://mpsapi.healthbridge.com/rcm/billing/v1/invoice/">
      <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:Gender>sample string 9</d3p1:Gender>
        <d3p1:Id>6b914579-6c15-4a6b-9adf-c0b626f3d5ef</d3p1:Id>
        <d3p1:MaxSpecificity>true</d3p1:MaxSpecificity>
        <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:Gender>sample string 9</d3p1:Gender>
        <d3p1:Id>6b914579-6c15-4a6b-9adf-c0b626f3d5ef</d3p1:Id>
        <d3p1:MaxSpecificity>true</d3p1:MaxSpecificity>
        <d3p1:PrimaryIndicator>true</d3p1:PrimaryIndicator>
        <d3p1:SpecificCode>true</d3p1:SpecificCode>
        <d3p1:ValidPrimary>true</d3p1:ValidPrimary>
        <d3p1:ValidSequelae>true</d3p1:ValidSequelae>
      </d3p1:Diagnosis>
    </Diagnosis>
    <DosageType>sample string 9</DosageType>
    <DosageUnit>8.1</DosageUnit>
    <DurationType>sample string 15</DurationType>
    <DurationUnit>14</DurationUnit>
    <FrequencyType>sample string 11</FrequencyType>
    <FrequencyUnit>10</FrequencyUnit>
    <LineNum>2</LineNum>
    <LineType>sample string 3</LineType>
    <NappiCode>sample string 6</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 13</PeriodType>
    <PeriodUnit>12</PeriodUnit>
    <PriceOverride>true</PriceOverride>
    <Repeat>16</Repeat>
    <Responses 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>
    </Responses>
    <SchemeRule>sample string 26</SchemeRule>
    <TotalExcVat>19</TotalExcVat>
    <TotalIncVat>21</TotalIncVat>
    <UnitPrice>25</UnitPrice>
    <VatAmount>20</VatAmount>
  </EncounterLineItem>
  <EncounterLineItem>
    <AccelerateLearning>true</AccelerateLearning>
    <Amount>22</Amount>
    <ChargeCode>sample string 4</ChargeCode>
    <ChargeDesc>sample string 5</ChargeDesc>
    <ChargeEnd>2025-04-16T13:52:11.5634764+02:00</ChargeEnd>
    <ChargeQuan>18</ChargeQuan>
    <ChargeStart>2025-04-16T13:52:11.5634764+02:00</ChargeStart>
    <ChargeUnits>sample string 7</ChargeUnits>
    <ChronicIndicator>true</ChronicIndicator>
    <CreatedFrom>sample string 27</CreatedFrom>
    <DateOfService>2025-04-16T13:52:11.5634764+02:00</DateOfService>
    <Diagnosis xmlns:d3p1="http://mpsapi.healthbridge.com/rcm/billing/v1/invoice/">
      <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:Gender>sample string 9</d3p1:Gender>
        <d3p1:Id>6b914579-6c15-4a6b-9adf-c0b626f3d5ef</d3p1:Id>
        <d3p1:MaxSpecificity>true</d3p1:MaxSpecificity>
        <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:Gender>sample string 9</d3p1:Gender>
        <d3p1:Id>6b914579-6c15-4a6b-9adf-c0b626f3d5ef</d3p1:Id>
        <d3p1:MaxSpecificity>true</d3p1:MaxSpecificity>
        <d3p1:PrimaryIndicator>true</d3p1:PrimaryIndicator>
        <d3p1:SpecificCode>true</d3p1:SpecificCode>
        <d3p1:ValidPrimary>true</d3p1:ValidPrimary>
        <d3p1:ValidSequelae>true</d3p1:ValidSequelae>
      </d3p1:Diagnosis>
    </Diagnosis>
    <DosageType>sample string 9</DosageType>
    <DosageUnit>8.1</DosageUnit>
    <DurationType>sample string 15</DurationType>
    <DurationUnit>14</DurationUnit>
    <FrequencyType>sample string 11</FrequencyType>
    <FrequencyUnit>10</FrequencyUnit>
    <LineNum>2</LineNum>
    <LineType>sample string 3</LineType>
    <NappiCode>sample string 6</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 13</PeriodType>
    <PeriodUnit>12</PeriodUnit>
    <PriceOverride>true</PriceOverride>
    <Repeat>16</Repeat>
    <Responses 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>
    </Responses>
    <SchemeRule>sample string 26</SchemeRule>
    <TotalExcVat>19</TotalExcVat>
    <TotalIncVat>21</TotalIncVat>
    <UnitPrice>25</UnitPrice>
    <VatAmount>20</VatAmount>
  </EncounterLineItem>
</ArrayOfEncounterLineItem>

URI parameters

Headers | Add header

Body

Status

Headers

Body

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

Request Information

URI Parameters

Body Parameters

Response Information

Resource Description

Response Formats

application/json, text/json

application/xml, text/xml