POST api/v2/{practiceId}/clinical/medicineinteractions

Get Medicine interactions from integration

Request Information

URI Parameters

NameDescriptionTypeAdditional information
practiceId

Id for the provider

 globally unique identifier

Required

Body Parameters

List of nappiCodes to check for interactions

Collection of string

Request Formats

application/json, text/json

Sample: 
[
  "sample string 1",
  "sample string 2"
]

application/xml, text/xml

Sample: 
<ArrayOfstring xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
  <string>sample string 1</string>
  <string>sample string 2</string>
</ArrayOfstring>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'System.Web.Http.ModelBinding.JQueryMvcFormUrlEncodedFormatter' to write type 'String[]'.

Response Information

Resource Description

Collection of Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects.MedicineInteractionVo
NameDescriptionTypeAdditional information
MedicineANappiCode

string

None.
MedicineBNappiCode

string

None.
MedicineAName

string

None.
MedicineBName

string

None.
Severity

integer

None.
Details

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

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "MedicineANappiCode": "sample string 1",
    "MedicineBNappiCode": "sample string 2",
    "MedicineAName": "sample string 3",
    "MedicineBName": "sample string 4",
    "Severity": 5,
    "Details": [
      {
        "Category": "sample string 1",
        "Description": "sample string 2"
      },
      {
        "Category": "sample string 1",
        "Description": "sample string 2"
      }
    ]
  },
  {
    "MedicineANappiCode": "sample string 1",
    "MedicineBNappiCode": "sample string 2",
    "MedicineAName": "sample string 3",
    "MedicineBName": "sample string 4",
    "Severity": 5,
    "Details": [
      {
        "Category": "sample string 1",
        "Description": "sample string 2"
      },
      {
        "Category": "sample string 1",
        "Description": "sample string 2"
      }
    ]
  }
]

application/xml, text/xml

Sample: 
<ArrayOfMedicineInteractionVo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects">
  <MedicineInteractionVo>
    <Details>
      <InteractionDetailVo>
        <Category>sample string 1</Category>
        <Description>sample string 2</Description>
      </InteractionDetailVo>
      <InteractionDetailVo>
        <Category>sample string 1</Category>
        <Description>sample string 2</Description>
      </InteractionDetailVo>
    </Details>
    <MedicineAName>sample string 3</MedicineAName>
    <MedicineANappiCode>sample string 1</MedicineANappiCode>
    <MedicineBName>sample string 4</MedicineBName>
    <MedicineBNappiCode>sample string 2</MedicineBNappiCode>
    <Severity>5</Severity>
  </MedicineInteractionVo>
  <MedicineInteractionVo>
    <Details>
      <InteractionDetailVo>
        <Category>sample string 1</Category>
        <Description>sample string 2</Description>
      </InteractionDetailVo>
      <InteractionDetailVo>
        <Category>sample string 1</Category>
        <Description>sample string 2</Description>
      </InteractionDetailVo>
    </Details>
    <MedicineAName>sample string 3</MedicineAName>
    <MedicineANappiCode>sample string 1</MedicineANappiCode>
    <MedicineBName>sample string 4</MedicineBName>
    <MedicineBNappiCode>sample string 2</MedicineBNappiCode>
    <Severity>5</Severity>
  </MedicineInteractionVo>
</ArrayOfMedicineInteractionVo>