Notes
The Notes resource allows for the retrieval of detailed Formulary Notes (Restrictive or Other). A given Coverage can contain zero or more detailed notes, and the resulting list will include the NoteTypeId for each.
|
StructuredNotes for PA (by ProductId, FormularyId and IndicationId) |
|
StructuredNotes for ST (by ProductId, FormularyId and IndicationId) |
CoverageNotes (by NoteId)
GET Formulary/v1/Notes/CoverageNotes
URI Parameters
| Name | Description | Type | Required / Optional |
|---|---|---|---|
| NoteId |
Coverage NoteId used to search for Notes |
integer |
Required |
Resource Description of Response Object
CoverageNotesResponse| Name | Description | Type | Required / Optional |
|---|---|---|---|
| RuleNotes | Collection of CoverageNote |
Optional |
Available Response Formats & Sample Data
{
"RuleNotes": [
{
"NoteTypeId": 64,
"Note": "sample string 2"
},
{
"NoteTypeId": 64,
"Note": "sample string 2"
}
]
}
<CoverageNotesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.mmitnetwork.com/formulary/notes">
<RuleNotes>
<CoverageNote>
<Note>sample string 2</Note>
<NoteTypeId>64</NoteTypeId>
</CoverageNote>
<CoverageNote>
<Note>sample string 2</Note>
<NoteTypeId>64</NoteTypeId>
</CoverageNote>
</RuleNotes>
</CoverageNotesResponse>
Build Request
| Name | Description | Input Value | Type | Required / Optional |
|---|---|---|---|---|
| NoteId |
Coverage NoteId used to search for Notes |
integer |
Required |
Request URL
GET Formulary/v1/Notes/CoverageNotes?NoteId=NoteId
Status
Response Details
Single CoverageNote (by NoteId and NoteTypeId)
GET Formulary/v1/Notes/CoverageNotes
URI Parameters
| Name | Description | Type | Required / Optional |
|---|---|---|---|
| NoteId |
Coverage NoteId used to search for Notes |
integer |
Required |
| NoteTypeId |
NoteTypeId used to search for Notes |
byte |
Required |
Resource Description of Response Object
CoverageNoteResponse| Name | Description | Type | Required / Optional |
|---|---|---|---|
| RuleNote | CoverageNote |
Optional |
Available Response Formats & Sample Data
{
"RuleNote": {
"NoteTypeId": 64,
"Note": "sample string 2"
}
}
<CoverageNoteResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.mmitnetwork.com/formulary/notes">
<RuleNote>
<Note>sample string 2</Note>
<NoteTypeId>64</NoteTypeId>
</RuleNote>
</CoverageNoteResponse>
Build Request
| Name | Description | Input Value | Type | Required / Optional |
|---|---|---|---|---|
| NoteId |
Coverage NoteId used to search for Notes |
integer |
Required |
|
| NoteTypeId |
NoteTypeId used to search for Notes |
byte |
Required |
Request URL
GET Formulary/v1/Notes/CoverageNotes?NoteId=NoteId&NoteTypeId=NoteTypeId
Status
Response Details
StructuredNotes for PA (by ProductId, FormularyId and IndicationId)
GET Formulary/v1/Notes/StructuredNotesPA
URI Parameters
| Name | Description | Type | Required / Optional |
|---|---|---|---|
| ProductId |
ProductId used to search for PA StructuredNotes |
integer |
Required |
| FormularyId |
FormularyId used to search for PA StructuredNotes |
integer |
Required |
| IndicationId |
IndicationId used to search for PA StructuredNotes |
integer |
Optional |
Resource Description of Response Object
StructuredNotesResponse| Name | Description | Type | Required / Optional |
|---|---|---|---|
| StructuredNotes | Collection of StructuredNote |
Optional |
Available Response Formats & Sample Data
{
"StructuredNotes": [
{
"IndicationId": 1,
"Note": "sample string 2"
},
{
"IndicationId": 1,
"Note": "sample string 2"
}
]
}
<StructuredNotesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.mmitnetwork.com/formulary/notes">
<StructuredNotes>
<StructuredNote>
<IndicationId>1</IndicationId>
<Note>sample string 2</Note>
</StructuredNote>
<StructuredNote>
<IndicationId>1</IndicationId>
<Note>sample string 2</Note>
</StructuredNote>
</StructuredNotes>
</StructuredNotesResponse>
Build Request
| Name | Description | Input Value | Type | Required / Optional |
|---|---|---|---|---|
| ProductId |
ProductId used to search for PA StructuredNotes |
integer |
Required |
|
| FormularyId |
FormularyId used to search for PA StructuredNotes |
integer |
Required |
|
| IndicationId |
IndicationId used to search for PA StructuredNotes |
integer |
Optional |
Request URL
GET Formulary/v1/Notes/StructuredNotesPA?ProductId=ProductId&FormularyId=FormularyId&IndicationId=IndicationId
Status
Response Details
StructuredNotes for ST (by ProductId, FormularyId and IndicationId)
GET Formulary/v1/Notes/StructuredNotesST
URI Parameters
| Name | Description | Type | Required / Optional |
|---|---|---|---|
| ProductId |
ProductId used to search for ST StructuredNotes |
integer |
Required |
| FormularyId |
FormularyId used to search for ST StructuredNotes |
integer |
Required |
| IndicationId |
IndicationId used to search for ST StructuredNotes |
integer |
Optional |
Resource Description of Response Object
StructuredNotesResponse| Name | Description | Type | Required / Optional |
|---|---|---|---|
| StructuredNotes | Collection of StructuredNote |
Optional |
Available Response Formats & Sample Data
{
"StructuredNotes": [
{
"IndicationId": 1,
"Note": "sample string 2"
},
{
"IndicationId": 1,
"Note": "sample string 2"
}
]
}
<StructuredNotesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.mmitnetwork.com/formulary/notes">
<StructuredNotes>
<StructuredNote>
<IndicationId>1</IndicationId>
<Note>sample string 2</Note>
</StructuredNote>
<StructuredNote>
<IndicationId>1</IndicationId>
<Note>sample string 2</Note>
</StructuredNote>
</StructuredNotes>
</StructuredNotesResponse>
Build Request
| Name | Description | Input Value | Type | Required / Optional |
|---|---|---|---|---|
| ProductId |
ProductId used to search for ST StructuredNotes |
integer |
Required |
|
| FormularyId |
FormularyId used to search for ST StructuredNotes |
integer |
Required |
|
| IndicationId |
IndicationId used to search for ST StructuredNotes |
integer |
Optional |
Request URL
GET Formulary/v1/Notes/StructuredNotesST?ProductId=ProductId&FormularyId=FormularyId&IndicationId=IndicationId
Status
Response Details