Full BRD

Care Gaps Response

Element	Is Required	Type	Description	Example
Gap Display Name	Yes	string	A desired display name for the gap	Control High Blood Pressure
Gap ID	Yes	string	A unique identifier of a gap across all patients	1244324
Gap Code	No	string	Gap's code within the system	CBP
Notes	No	string	Additional information to be displayed regarding the gap	Should schedule yearly imaging
Gap Status	No	string	The gap's status. If not provided - default is that the gap is open and should be displayed	Open
Action Required	No	string	The action that needs to be taken by the health care provider	Perform & code B/P check. Controlled is BELOW 140/90. Take REPEAT if necessary.
Prior Values	No	string	Prior values for clinical tests or procedure results	Systolic / Diastolic: [X/Y]
Collection Date	No	date	The date where the prior values were documented	2020-10-15
CPT II Code	No	string	Recommended CPT II code associated with the gap	3074F
CPT II Description	No	string	Recommended CPT II description associated with the gap. If the description isn't provided, Vim will populate the official description from the American Medical Association.	Most recent systolic BP less than 130 mm Hg
Last Recorded DoS	No	date	Last date of a relevant service in the case of HEDIS	2021-03-19
Last Recorded NPI	No	number	Last coding provider NPI	123456789
Last Recorded Provider Name	No	string	Last coding provider full name	DR John Mock
Source	No	string	The source of the gap	2021 claims
Notes	No	string	Additional information to be displayed regarding the gap. Can be instructions, follow up notes, coding suggestions etc.	It's recommended to use category II codes claims for HEDIS

Diagnosis Gaps Response

Element	Is Required	Type	Description	Example
Gap ID	Yes	string/number	A unique identifier of a gap per patient. Used for multiple purposes including: (1) reporting ; (2) status management - note: to resurface the gap after addressed, the diagnosis needs to be sent with a new gap ID	1244324
HCC Code	Yes	number	Gap's code within the system	18
HCC Model	No	string	The specific model for HCC, required if the Gap System is HCC, the default is CMS	HHS-HCC
HCC Model Version	No	string (V24/V28)	The specific model version for CMS-HCC. If not provided, the default is v24	28
HCC Description	No	string	The title of the gap that would be displayed to the user. If not provided we would map the HCC code to its CMS standard description	Diabetes with chronic complications
Gap Type	No	string	Is this a known condition or a suspected condition? This information will be presented in a label next to gap in the UI	Suspected
Gap Status	No	string	The gap's status. If not provided - default is that the gap is open and should be displayed	Open
RAF Score	No	number	Risk adjustment factor	2.65
ICD Code	No	string	Gap ICD-10 code	E11.21
ICD Description	No	string	Description for the provided ICD code	DM with nephropathy
Last Recorded DoS	No	date	Last recorded date of the diagnosis being coded by a provider	2014-07-15
Last Recorded NPI	No	string	Last coding provider NPI	123456789
Last Recorded Provider Name	No	string	Last coding provider full name	William Johnson
Source	No	string	The source of the gap	2021 claims
Notes	No	string	Additional information to be displayed regarding the gap	Should schedule yearly imaging

Gaps Feedback Endpoint

Element	Type	Description
Patient
patient - patientID	string	The unique patient identifier sent from the customer.If the customer has more than one identifying field - all of them will be added to the payload (such as name, DOB, member ID, etc.)
User
User - organizationName	string	Provider’s (user in session) organization name
User - vimOrganizationId	number	Vim internal organization ID
User - userFirstName	string	Provider's (user in session) first name
User - userLastName	string	Provider's (user in session) last name
User - userNpi	string	Provider's (user in session) NPI, if available
User - ehrUsername	string	Provider's (user in session) EHR username
Gap
Gap - gapId	string	The unique ID for a gap as shared by the customer
Gap - gapType	string (options: "Dx" or "Qx")	Application type - Diagnosis or Care Gaps.
Gap - gapSystem	string	The type of codes presented in the application, as shared by the user
Gap - gapCode	string	The code of the gap selected during the session (HEDIS/HCC)
Gap - gapDescription	string	The description of the gap selected during the session
Gap - selectedMedicalCodes	Array of strings	When a gap was accepted - which medical codes were selected by the provider and written back to the EHR. ICD code for Diagnosis Gaps, CPT code for Care Gaps.
Feedback
Feedback - encounterDate	Date	The date of the patient EHR encounter in context (according to the organization's timezone, date format YYYY-MM-DD)
Feedback - actionType	string (options: "agree" or "dismiss")	The action the user selected to perform
Feedback - actionDate	date	The date of app interaction (date format YYYY-MM-DD)
Feedback - actionReason	string	The reason is associated with the action, as chosen by the user
Feedback - additionalComments	string	The free text as added by the user when dismissing the gap