Notes
The Notes resource allows for the retrieval of detailed Medical Notes (Restrictive or Other). A given Coverage can contain zero or more detailed notes
MedicalNotes (by NoteId)
Request URL
GET Medical/v1/Notes
URI Parameters
| Name | Description | Type | Required / Optional |
|---|---|---|---|
| NoteId |
Medical Coverage NoteId used to search for Notes |
integer |
Required |
Resource Description of Response Object
MedicalCoverageNoteResponse| Name | Description | Type | Required / Optional |
|---|---|---|---|
| RuleNote | MedicalCoverageNote |
Optional |
Available Response Formats & Sample Data
{
"RuleNote": {
"NoteTypeId": 64,
"Note": "sample string 2"
}
}
<MedicalCoverageNoteResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.mmitnetwork.com/medical/notes">
<RuleNote>
<Note>sample string 2</Note>
<NoteTypeId>64</NoteTypeId>
</RuleNote>
</MedicalCoverageNoteResponse>
Build Request
| Name | Description | Input Value | Type | Required / Optional |
|---|---|---|---|---|
| NoteId |
Medical Coverage NoteId used to search for Notes |
integer |
Required |
Request URL
GET Medical/v1/Notes?NoteId=NoteId
Status
Response Details
MedicalNotes (by Product, Formulary, and Indication)
Request URL
GET Medical/v1/Notes/Product
URI Parameters
| Name | Description | Type | Required / Optional |
|---|---|---|---|
| ProductId |
Product Id |
integer |
Required |
| FormularyId |
Formulary Id |
integer |
Required |
| IndicationId |
Indication Id |
integer |
Required |
| NoteTypes |
List of note types |
Collection of integer |
Optional |
Resource Description of Response Object
MedicalCoverageNotesResponse| Name | Description | Type | Required / Optional |
|---|---|---|---|
| RuleNotes | Collection of MedicalCoverageNote |
Optional |
Available Response Formats & Sample Data
{
"RuleNotes": [
{
"NoteTypeId": 64,
"Note": "sample string 2"
},
{
"NoteTypeId": 64,
"Note": "sample string 2"
}
]
}
<MedicalCoverageNotesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.mmitnetwork.com/medical/notes">
<RuleNotes>
<MedicalCoverageNote>
<Note>sample string 2</Note>
<NoteTypeId>64</NoteTypeId>
</MedicalCoverageNote>
<MedicalCoverageNote>
<Note>sample string 2</Note>
<NoteTypeId>64</NoteTypeId>
</MedicalCoverageNote>
</RuleNotes>
</MedicalCoverageNotesResponse>
Build Request
| Name | Description | Input Value | Type | Required / Optional |
|---|---|---|---|---|
| ProductId |
Product Id |
integer |
Required |
|
| FormularyId |
Formulary Id |
integer |
Required |
|
| IndicationId |
Indication Id |
integer |
Required |
|
| NoteTypes |
List of note types |
Collection of integer |
Optional |
Request URL
GET Medical/v1/Notes/Product?ProductId=ProductId&FormularyId=FormularyId&IndicationId=IndicationId&NoteTypes=NoteTypes
Status
Response Details