POST api/patients/{patientId}/precheckInteractions
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
patientId | integer |
Required |
Body Parameters
PreCheckInteractionsRequestName | Description | Type | Additional information |
---|---|---|---|
LexiGenProductId | integer |
Required |
|
LexiDrugSynId | integer |
Required |
|
LexiSynonymTypeId | integer |
Required |
Request Formats
application/json, text/json
Sample:
{ "LexiGenProductId": 1, "LexiDrugSynId": 1, "LexiSynonymTypeId": 1 }
application/xml, text/xml
Sample:
<PreCheckInteractionsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DoseSpot.UI.API.DataContracts._13"> <LexiDrugSynId>1</LexiDrugSynId> <LexiGenProductId>1</LexiGenProductId> <LexiSynonymTypeId>1</LexiSynonymTypeId> </PreCheckInteractionsRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
PreCheckInteractionsResponseName | Description | Type | Additional information |
---|---|---|---|
AllergyInteractions | Collection of AllergyInteraction |
None. |
|
DrugInteractions | Collection of DrugDrugInteraction |
None. |
|
Result | Result |
None. |
Response Formats
application/json, text/json
Sample:
{ "AllergyInteractions": [ { "Message": "sample string 1", "Reaction": "sample string 2", "ReactionType": 1 }, { "Message": "sample string 1", "Reaction": "sample string 2", "ReactionType": 1 } ], "DrugInteractions": [ { "Drug1Source": 0, "Drug1LexiGenDrugId": "sample string 1", "Drug1LexiGenProductId": 2, "Drug1LexiDrugSynId": 3, "Drug1LexiSynonymTypeId": 4, "Drug1LexiGenericDrugName": "sample string 5", "Drug1LexiBaseDrugSynonymDisplayName": "sample string 6", "Drug2Source": 0, "Drug2LexiGenDrugId": "sample string 7", "Drug2LexiGenProductId": 8, "Drug2LexiDrugSynId": 9, "Drug2LexiSynonymTypeId": 10, "Drug2LexiGenericDrugName": "sample string 11", "Drug2LexiBaseDrugSynonymDisplayName": "sample string 12", "ConsumerText": [ "sample string 1", "sample string 2" ], "InteractionDescription": "sample string 13", "InteractionID": 14, "InteractionMessage": "sample string 15", "SeverityDescription": "sample string 16", "SeverityID": 17, "IsProspective": true }, { "Drug1Source": 0, "Drug1LexiGenDrugId": "sample string 1", "Drug1LexiGenProductId": 2, "Drug1LexiDrugSynId": 3, "Drug1LexiSynonymTypeId": 4, "Drug1LexiGenericDrugName": "sample string 5", "Drug1LexiBaseDrugSynonymDisplayName": "sample string 6", "Drug2Source": 0, "Drug2LexiGenDrugId": "sample string 7", "Drug2LexiGenProductId": 8, "Drug2LexiDrugSynId": 9, "Drug2LexiSynonymTypeId": 10, "Drug2LexiGenericDrugName": "sample string 11", "Drug2LexiBaseDrugSynonymDisplayName": "sample string 12", "ConsumerText": [ "sample string 1", "sample string 2" ], "InteractionDescription": "sample string 13", "InteractionID": 14, "InteractionMessage": "sample string 15", "SeverityDescription": "sample string 16", "SeverityID": 17, "IsProspective": true } ], "Result": { "ResultCode": "sample string 1", "ResultDescription": "sample string 2" } }
application/xml, text/xml
Sample:
<PreCheckInteractionsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DoseSpot.UI.API.DataContracts._13"> <Result> <ResultCode>sample string 1</ResultCode> <ResultDescription>sample string 2</ResultDescription> </Result> <AllergyInteractions> <AllergyInteraction> <Message>sample string 1</Message> <Reaction>sample string 2</Reaction> <ReactionType>Allergy</ReactionType> </AllergyInteraction> <AllergyInteraction> <Message>sample string 1</Message> <Reaction>sample string 2</Reaction> <ReactionType>Allergy</ReactionType> </AllergyInteraction> </AllergyInteractions> <DrugInteractions> <DrugDrugInteraction> <ConsumerText xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>sample string 1</d4p1:string> <d4p1:string>sample string 2</d4p1:string> </ConsumerText> <Drug1LexiBaseDrugSynonymDisplayName>sample string 6</Drug1LexiBaseDrugSynonymDisplayName> <Drug1LexiDrugSynId>3</Drug1LexiDrugSynId> <Drug1LexiGenDrugId>sample string 1</Drug1LexiGenDrugId> <Drug1LexiGenProductId>2</Drug1LexiGenProductId> <Drug1LexiGenericDrugName>sample string 5</Drug1LexiGenericDrugName> <Drug1LexiSynonymTypeId>4</Drug1LexiSynonymTypeId> <Drug1Source>Unknown</Drug1Source> <Drug2LexiBaseDrugSynonymDisplayName>sample string 12</Drug2LexiBaseDrugSynonymDisplayName> <Drug2LexiDrugSynId>9</Drug2LexiDrugSynId> <Drug2LexiGenDrugId>sample string 7</Drug2LexiGenDrugId> <Drug2LexiGenProductId>8</Drug2LexiGenProductId> <Drug2LexiGenericDrugName>sample string 11</Drug2LexiGenericDrugName> <Drug2LexiSynonymTypeId>10</Drug2LexiSynonymTypeId> <Drug2Source>Unknown</Drug2Source> <InteractionDescription>sample string 13</InteractionDescription> <InteractionID>14</InteractionID> <InteractionMessage>sample string 15</InteractionMessage> <IsProspective>true</IsProspective> <SeverityDescription>sample string 16</SeverityDescription> <SeverityID>17</SeverityID> </DrugDrugInteraction> <DrugDrugInteraction> <ConsumerText xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>sample string 1</d4p1:string> <d4p1:string>sample string 2</d4p1:string> </ConsumerText> <Drug1LexiBaseDrugSynonymDisplayName>sample string 6</Drug1LexiBaseDrugSynonymDisplayName> <Drug1LexiDrugSynId>3</Drug1LexiDrugSynId> <Drug1LexiGenDrugId>sample string 1</Drug1LexiGenDrugId> <Drug1LexiGenProductId>2</Drug1LexiGenProductId> <Drug1LexiGenericDrugName>sample string 5</Drug1LexiGenericDrugName> <Drug1LexiSynonymTypeId>4</Drug1LexiSynonymTypeId> <Drug1Source>Unknown</Drug1Source> <Drug2LexiBaseDrugSynonymDisplayName>sample string 12</Drug2LexiBaseDrugSynonymDisplayName> <Drug2LexiDrugSynId>9</Drug2LexiDrugSynId> <Drug2LexiGenDrugId>sample string 7</Drug2LexiGenDrugId> <Drug2LexiGenProductId>8</Drug2LexiGenProductId> <Drug2LexiGenericDrugName>sample string 11</Drug2LexiGenericDrugName> <Drug2LexiSynonymTypeId>10</Drug2LexiSynonymTypeId> <Drug2Source>Unknown</Drug2Source> <InteractionDescription>sample string 13</InteractionDescription> <InteractionID>14</InteractionID> <InteractionMessage>sample string 15</InteractionMessage> <IsProspective>true</IsProspective> <SeverityDescription>sample string 16</SeverityDescription> <SeverityID>17</SeverityID> </DrugDrugInteraction> </DrugInteractions> </PreCheckInteractionsResponse>