GET api/v2/{practiceId}/clinical/consumables?code={code}
Search consumable codes
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
practiceId | globally unique identifier |
Required |
|
code | string |
Required |
Body Parameters
None.
Response Information
Resource Description
Com.Healthbridge.Hhas.Billing.Impl.Utils.ConsumablesName | Description | Type | Additional information |
---|---|---|---|
ConsumableItem | Collection of Com.Healthbridge.Hhas.Billing.Impl.Utils.ConsumableItem |
None. |
|
ATC3Code | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "ConsumableItem": [ { "ProductUsageCategory": "sample string 1", "NAPPICode": "sample string 2", "ProductStrength": "sample string 3", "Rank": 1.1, "ATC5": "sample string 4", "NAPPICodePack": "sample string 5", "ProductName": "sample string 6", "Id": 1.1, "ConsumableInfo": { "NAPPICode7": "sample string 1", "GenericIndicator": "sample string 2", "MinSingleExitPricePerUnit": 1.1, "ProductName": "sample string 3", "hbATC4Code": "sample string 4", "ManufacturerCode": "sample string 5", "ATC2Code": "sample string 6", "ATC4Code": "sample string 7", "ManufacturerName": "sample string 8", "MedicineSchedule": 1.1, "VolumeUnits": "sample string 9", "hbATC5Code": "sample string 10", "Volume": "sample string 11", "Units": "sample string 12", "ATC3Code": "sample string 13", "ProductUsageCategory": "sample string 14", "NAPPICode": "sample string 15", "ProductStrength": "sample string 16", "ProductStatus": "sample string 17", "RouteOfAdministration": "sample string 18", "ATC5Code": "sample string 19", "PackInfo": [ { "SingleExitPriceEffectiveDate": { "_seconds": 1.1, "_nanoseconds": 1.1 }, "PackSize": 1.1, "SingleExitPricePerPack": 1.1, "SingleExitPricePerUnit": 1.1, "NAPPICode10": "sample string 1", "NAPPIPack": "sample string 2" }, { "SingleExitPriceEffectiveDate": { "_seconds": 1.1, "_nanoseconds": 1.1 }, "PackSize": 1.1, "SingleExitPricePerPack": 1.1, "SingleExitPricePerUnit": 1.1, "NAPPICode10": "sample string 1", "NAPPIPack": "sample string 2" } ], "hbATC2Code": "sample string 20", "ConsumableDrugFlag": 1.1, "ATC5Description": "sample string 21", "hbATC3Code": "sample string 22", "Flags": "sample string 23" } }, { "ProductUsageCategory": "sample string 1", "NAPPICode": "sample string 2", "ProductStrength": "sample string 3", "Rank": 1.1, "ATC5": "sample string 4", "NAPPICodePack": "sample string 5", "ProductName": "sample string 6", "Id": 1.1, "ConsumableInfo": { "NAPPICode7": "sample string 1", "GenericIndicator": "sample string 2", "MinSingleExitPricePerUnit": 1.1, "ProductName": "sample string 3", "hbATC4Code": "sample string 4", "ManufacturerCode": "sample string 5", "ATC2Code": "sample string 6", "ATC4Code": "sample string 7", "ManufacturerName": "sample string 8", "MedicineSchedule": 1.1, "VolumeUnits": "sample string 9", "hbATC5Code": "sample string 10", "Volume": "sample string 11", "Units": "sample string 12", "ATC3Code": "sample string 13", "ProductUsageCategory": "sample string 14", "NAPPICode": "sample string 15", "ProductStrength": "sample string 16", "ProductStatus": "sample string 17", "RouteOfAdministration": "sample string 18", "ATC5Code": "sample string 19", "PackInfo": [ { "SingleExitPriceEffectiveDate": { "_seconds": 1.1, "_nanoseconds": 1.1 }, "PackSize": 1.1, "SingleExitPricePerPack": 1.1, "SingleExitPricePerUnit": 1.1, "NAPPICode10": "sample string 1", "NAPPIPack": "sample string 2" }, { "SingleExitPriceEffectiveDate": { "_seconds": 1.1, "_nanoseconds": 1.1 }, "PackSize": 1.1, "SingleExitPricePerPack": 1.1, "SingleExitPricePerUnit": 1.1, "NAPPICode10": "sample string 1", "NAPPIPack": "sample string 2" } ], "hbATC2Code": "sample string 20", "ConsumableDrugFlag": 1.1, "ATC5Description": "sample string 21", "hbATC3Code": "sample string 22", "Flags": "sample string 23" } } ], "ATC3Code": "sample string 1" }
application/xml, text/xml
Sample:
<Consumables xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Hhas.Billing.Impl.Utils"> <ATC3Code>sample string 1</ATC3Code> <ConsumableItem> <ConsumableItem> <ATC5>sample string 4</ATC5> <ConsumableInfo> <ATC2Code>sample string 6</ATC2Code> <ATC3Code>sample string 13</ATC3Code> <ATC4Code>sample string 7</ATC4Code> <ATC5Code>sample string 19</ATC5Code> <ATC5Description>sample string 21</ATC5Description> <ConsumableDrugFlag>1.1</ConsumableDrugFlag> <Flags>sample string 23</Flags> <GenericIndicator>sample string 2</GenericIndicator> <HbATC2Code>sample string 20</HbATC2Code> <HbATC3Code>sample string 22</HbATC3Code> <HbATC4Code>sample string 4</HbATC4Code> <HbATC5Code>sample string 10</HbATC5Code> <ManufacturerCode>sample string 5</ManufacturerCode> <ManufacturerName>sample string 8</ManufacturerName> <MedicineSchedule>1.1</MedicineSchedule> <MinSingleExitPricePerUnit>1.1</MinSingleExitPricePerUnit> <NAPPICode>sample string 15</NAPPICode> <NAPPICode7>sample string 1</NAPPICode7> <PackInfo> <PackInfo> <NAPPICode10>sample string 1</NAPPICode10> <NAPPIPack>sample string 2</NAPPIPack> <PackSize>1.1</PackSize> <SingleExitPriceEffectiveDate> <_nanoseconds>1.1</_nanoseconds> <_seconds>1.1</_seconds> </SingleExitPriceEffectiveDate> <SingleExitPricePerPack>1.1</SingleExitPricePerPack> <SingleExitPricePerUnit>1.1</SingleExitPricePerUnit> </PackInfo> <PackInfo> <NAPPICode10>sample string 1</NAPPICode10> <NAPPIPack>sample string 2</NAPPIPack> <PackSize>1.1</PackSize> <SingleExitPriceEffectiveDate> <_nanoseconds>1.1</_nanoseconds> <_seconds>1.1</_seconds> </SingleExitPriceEffectiveDate> <SingleExitPricePerPack>1.1</SingleExitPricePerPack> <SingleExitPricePerUnit>1.1</SingleExitPricePerUnit> </PackInfo> </PackInfo> <ProductName>sample string 3</ProductName> <ProductStatus>sample string 17</ProductStatus> <ProductStrength>sample string 16</ProductStrength> <ProductUsageCategory>sample string 14</ProductUsageCategory> <RouteOfAdministration>sample string 18</RouteOfAdministration> <Units>sample string 12</Units> <Volume>sample string 11</Volume> <VolumeUnits>sample string 9</VolumeUnits> </ConsumableInfo> <Id>1.1</Id> <NAPPICode>sample string 2</NAPPICode> <NAPPICodePack>sample string 5</NAPPICodePack> <ProductName>sample string 6</ProductName> <ProductStrength>sample string 3</ProductStrength> <ProductUsageCategory>sample string 1</ProductUsageCategory> <Rank>1.1</Rank> </ConsumableItem> <ConsumableItem> <ATC5>sample string 4</ATC5> <ConsumableInfo> <ATC2Code>sample string 6</ATC2Code> <ATC3Code>sample string 13</ATC3Code> <ATC4Code>sample string 7</ATC4Code> <ATC5Code>sample string 19</ATC5Code> <ATC5Description>sample string 21</ATC5Description> <ConsumableDrugFlag>1.1</ConsumableDrugFlag> <Flags>sample string 23</Flags> <GenericIndicator>sample string 2</GenericIndicator> <HbATC2Code>sample string 20</HbATC2Code> <HbATC3Code>sample string 22</HbATC3Code> <HbATC4Code>sample string 4</HbATC4Code> <HbATC5Code>sample string 10</HbATC5Code> <ManufacturerCode>sample string 5</ManufacturerCode> <ManufacturerName>sample string 8</ManufacturerName> <MedicineSchedule>1.1</MedicineSchedule> <MinSingleExitPricePerUnit>1.1</MinSingleExitPricePerUnit> <NAPPICode>sample string 15</NAPPICode> <NAPPICode7>sample string 1</NAPPICode7> <PackInfo> <PackInfo> <NAPPICode10>sample string 1</NAPPICode10> <NAPPIPack>sample string 2</NAPPIPack> <PackSize>1.1</PackSize> <SingleExitPriceEffectiveDate> <_nanoseconds>1.1</_nanoseconds> <_seconds>1.1</_seconds> </SingleExitPriceEffectiveDate> <SingleExitPricePerPack>1.1</SingleExitPricePerPack> <SingleExitPricePerUnit>1.1</SingleExitPricePerUnit> </PackInfo> <PackInfo> <NAPPICode10>sample string 1</NAPPICode10> <NAPPIPack>sample string 2</NAPPIPack> <PackSize>1.1</PackSize> <SingleExitPriceEffectiveDate> <_nanoseconds>1.1</_nanoseconds> <_seconds>1.1</_seconds> </SingleExitPriceEffectiveDate> <SingleExitPricePerPack>1.1</SingleExitPricePerPack> <SingleExitPricePerUnit>1.1</SingleExitPricePerUnit> </PackInfo> </PackInfo> <ProductName>sample string 3</ProductName> <ProductStatus>sample string 17</ProductStatus> <ProductStrength>sample string 16</ProductStrength> <ProductUsageCategory>sample string 14</ProductUsageCategory> <RouteOfAdministration>sample string 18</RouteOfAdministration> <Units>sample string 12</Units> <Volume>sample string 11</Volume> <VolumeUnits>sample string 9</VolumeUnits> </ConsumableInfo> <Id>1.1</Id> <NAPPICode>sample string 2</NAPPICode> <NAPPICodePack>sample string 5</NAPPICodePack> <ProductName>sample string 6</ProductName> <ProductStrength>sample string 3</ProductStrength> <ProductUsageCategory>sample string 1</ProductUsageCategory> <Rank>1.1</Rank> </ConsumableItem> </ConsumableItem> </Consumables>