Documents
Document Retrieval of related Medical documents based on the ProductID, FormularyID and IndicationID. The Documents ID's retrieved can be further used to download the physical documents.
|
Medical Documents (by ProductId, FormularyId and IndicationId) |
Document links (by ProductId, FormularyId and IndicationId)
GET Medical/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 Medical/v1/Notes/Documents?ProductId=ProductId&FormularyId=FormularyId&IndicationId=IndicationId
Status
Response Details
Medical Documents (by ProductId, FormularyId and IndicationId)
GET Medical/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 |
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 |
Request URL
GET Medical/v1/Notes/DocumentLinks?ProductId=ProductId&FormularyId=FormularyId&IndicationId=IndicationId
Status
Response Details
Retrieve Documents by DocumentId
GET Medical/v1/Notes/Documents/Lookup
URI Parameters
| Name | Description | Type | Required / Optional |
|---|---|---|---|
| DocumentId |
The Id of the document to download (e.g. 9A6251F4-86C6-4371-938B-BB98473450AC) |
string |
Required |
Resource Description of Response Object
Physical Document Download
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 |
The Id of the document to download (e.g. 9A6251F4-86C6-4371-938B-BB98473450AC) |
string |
Required |
Request URL
GET Medical/v1/Notes/Documents/Lookup?DocumentId=DocumentId
Status
Response Details