Documents
Document Retrieval of related Formulary documents based on the ProductID, FormularyID and IndicationID. These documents can be further filtered to either return or not return the Druglist Documents based on the 'IncludeDrugList' parameter value.
|
Pharmacy Documents (by ProductId, FormularyId and IndicationId) |
Document links (by ProductId, FormularyId and IndicationId)
GET Formulary/v1/Notes/Documents
URI Parameters
| Name | Description | Type | Required / Optional |
|---|---|---|---|
| ProductId |
ProductId used to search for Document Links |
integer |
Required |
| FormularyId |
FormularyId used to search for Document Links |
integer |
Required |
| IndicationId |
IndicationId used to search for Document Links |
integer |
Optional |
Resource Description of Response Object
DocumentLinksResponse| Name | Description | Type | Required / Optional |
|---|---|---|---|
| DocumentLinks | Collection of DocumentLink |
Optional |
Available Response Formats & Sample Data
{
"DocumentLinks": [
{
"IndicationId": 1,
"URLs": "sample string 2"
},
{
"IndicationId": 1,
"URLs": "sample string 2"
}
]
}
<DocumentLinksResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.mmitnetwork.com/formulary/notes">
<DocumentLinks>
<DocumentLink>
<IndicationId>1</IndicationId>
<URLs>sample string 2</URLs>
</DocumentLink>
<DocumentLink>
<IndicationId>1</IndicationId>
<URLs>sample string 2</URLs>
</DocumentLink>
</DocumentLinks>
</DocumentLinksResponse>
Build Request
| Name | Description | Input Value | Type | Required / Optional |
|---|---|---|---|---|
| ProductId |
ProductId used to search for Document Links |
integer |
Required |
|
| FormularyId |
FormularyId used to search for Document Links |
integer |
Required |
|
| IndicationId |
IndicationId used to search for Document Links |
integer |
Optional |
Request URL
GET Formulary/v1/Notes/Documents?ProductId=ProductId&FormularyId=FormularyId&IndicationId=IndicationId
Status
Response Details
Pharmacy Documents (by ProductId, FormularyId and IndicationId)
GET Formulary/v1/Notes/DocumentLinks
URI Parameters
| Name | Description | Type | Required / Optional |
|---|---|---|---|
| ProductId |
ProductId used to search for Document Links |
integer |
Required |
| FormularyId |
FormularyId used to search for Document Links |
integer |
Required |
| IndicationId |
IndicationId used to search for Document Links |
integer |
Required |
| IncludeDrugList |
1 = Include DrugLists when Pulling PAR Data, 0 = Do not |
integer |
Default value is 1 |
Resource Description of Response Object
Document| Name | Description | Type | Required / Optional |
|---|---|---|---|
| DocumentId | string |
Optional |
|
| DocumentName | string |
Optional |
|
| DocumentTypeName | string |
Optional |
Available Response Formats & Sample Data
{
"DocumentId": "sample string 1",
"DocumentName": "sample string 2",
"DocumentTypeName": "sample string 3"
}
<Document xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MMIT.Api.WebApplication.Models.Formulary.Notes"> <DocumentId>sample string 1</DocumentId> <DocumentName>sample string 2</DocumentName> <DocumentTypeName>sample string 3</DocumentTypeName> </Document>
Build Request
| Name | Description | Input Value | Type | Required / Optional |
|---|---|---|---|---|
| ProductId |
ProductId used to search for Document Links |
integer |
Required |
|
| FormularyId |
FormularyId used to search for Document Links |
integer |
Required |
|
| IndicationId |
IndicationId used to search for Document Links |
integer |
Required |
|
| IncludeDrugList |
1 = Include DrugLists when Pulling PAR Data, 0 = Do not |
integer |
Default value is 1 |
Request URL
GET Formulary/v1/Notes/DocumentLinks?ProductId=ProductId&FormularyId=FormularyId&IndicationId=IndicationId&IncludeDrugList=IncludeDrugList
Status
Response Details
Retrieve Documents by DocumentId
GET Formulary/v1/Notes/Documents/Lookup
URI Parameters
| Name | Description | Type | Required / Optional |
|---|---|---|---|
| DocumentId |
GUID (4F79B1F9-324C-4254-8506-C08E9917C2B6) or Numeric (613108) Format |
string |
Required |
Resource Description of Response Object
Binary Representation of a file. Returns Status Code of 500 when document not found.
HttpResponseMessage| Name | Description | Type | Required / Optional |
|---|---|---|---|
| Version | Version |
Optional |
|
| Content | HttpContent |
Optional |
|
| StatusCode | HttpStatusCode |
Optional |
|
| ReasonPhrase | string |
Optional |
|
| Headers | Collection of Object |
Optional |
|
| RequestMessage | HttpRequestMessage |
Optional |
|
| IsSuccessStatusCode | boolean |
Optional |
Available Response Formats & Sample Data
Build Request
| Name | Description | Input Value | Type | Required / Optional |
|---|---|---|---|---|
| DocumentId |
GUID (4F79B1F9-324C-4254-8506-C08E9917C2B6) or Numeric (613108) Format |
string |
Required |
Request URL
GET Formulary/v1/Notes/Documents/Lookup?DocumentId=DocumentId
Status
Response Details