Visit
A Visit represents an encounter that takes place between a patient and a provider.\
Endpoint
https://platform.wellviasolutions.com/clinical/v1/visit\
The Visit Object
Attributes
idstring :required
The unique identifier of the visit.
typeDetailobject :required
Specifics around the type of visit.
typestring :required
The unique type identifier specifying the type of visit. See the Visit Type Dictionary for possible values.
namestring :required
The friendly name of the type of visit.
descriptionstring :optional
A brief description of the type of visit.
durationnumeric :optional
The typical length of the visit, measured in minutes.
statusstring :required
The unique type identifier of the current status of the visit. See the Visit Status Dictionary for possible values.
dateCreatedtimestamp :required
The UTC timestamp of when the visit was requested.
communicationMethodstring :required
The unique type identifier of the chosen communication method for this visit. See the Communication Method Dictionary for possible values.
assignmentsobject :required
Details the assigned patient, provider, and other users who have access to participate in the visit.
patientobject :required
The patient the visit is assigned to. This is a Visit Assignment Object.
requestedByobject :optional
The user that requested the visit on behalf of the patient. Typically populated when a parent requests a visit on behalf of a child. This is a Visit Assignment Object.
providerobject :optional
The provider assigned to the visit. This is a Visit Assignment Object.
guestsobject :optional
Additional users that can participate in the visit. This is a list of Visit Assignment Objects.
reasonsForVisitlist of strings :required
A list of symptoms or other reasons the patient requested the visit.
patientPhoneNumberstring :required
The phone number provided by the patient when requesting the visit. This will return in E-164 format.
alternativeTreatmentMethodstring :required
Where the patient stated they would have gone for treatment if this service was not available. See the Alternative Treatment Methods Dictionary for possible values.
patientLocationobject :optional
Where the patient will be located during the visit.
stateProvincestring :required
The state or province the user will be located in during the visit. US-based locations should follow the 2 character USPS code.
countrystring :required
The country the user will be located in during the visit. The country code is in ISO 3166-1 format. Default Value is "US".
dateScheduleslist of objects :optional
A list of Visit Schedule Date Objects containing a list of requested and/or confirmed dates for the visit.
alternativeIdsdictionary :optional
A dictionary containing a list of alternative unique identifiers for this visit. To guarantee uniqueness, the key and its' value should both be taken into consideration.
keystring :required
A unique identifier for this visit.
valuestring :required
The type of identifier. See the Visit Identifier Type Dictionary for possible values.
pharmacyobject :optional
The pharmacy that was selected at the time of request. This pharmacy will be used if a provider chooses to submit a prescription. This is a Pharmacy Object.
languagestring :required
The language that the patient requested at the time of request. Data is in the ISO 639-1 format.
outcomeobject :optional
Details around the clinical results of the visit. This data is not included by default, and is only available after a visit is completed. This is a Visit Outcome Object.
Example
{
"id": "1234567",
"typeDetail": {
"type": "generalmedical",
"name": "General Medical",
"description": null,
"duration": null
},
"status": "completed",
"dateCreated": "2021-08-17T14:30:00.000",
"communicationMethod": "phone",
"assignments": {
"patient": {
"userId": "mem_78c0c8dabb5742bc96c256e56b1dc210",
"firstName": "Jane",
"lastName": "Doe",
"userType": "member",
"title": null
},
"requestedBy": null,
"provider": {
"userId": "prv_f49d22746d2a4643b72d4f7908dc2cb4",
"firstName": "Susan",
"lastName": "Smith",
"userType": "medicalpractitioner",
"title": "Dr."
},
"guests": []
},
"reasonsForVisit": [
"Respiratory infection."
],
"patientPhoneNumber": "+15551234567",
"alternativeTreatmentMethod": "urgentcare",
"patientLocation": {
"stateProvince": "TX",
"country": "US"
},
"dateSchedules": {
"2021-08-17T16:00:00.000" : "confirmed"
},
"alternativeIds": {
"friendlyid": "1234567"
},
"pharmacy": {
"id": "pharm_be0b8c4e7a36eb119fb400155dfc253f",
"source": "surescripts",
"name": "KROGER SOUTHWEST 584",
"ncpdpid": "4574162",
"npi": "1740353358",
"storeNumber": "035584",
"addressLine1": "3001 Matlock Rd",
"addressLine2": "",
"addressCity": "Mansfield",
"addressState": "TX",
"addressZip": "760633302",
"addressCountryCode": "US",
"addressCrossStreet": "",
"phoneNumber": "8174730081",
"faxNumber": "8174730972",
"startDate": "2008-05-22T13:18:13",
"endDate": "2099-05-22T13:18:13",
"services": [
"new",
"refill",
"controlledsubstance"
],
"specialties": [
"retail"
],
"coordinatesLongitude": -97.11759,
"coordinatesLatitude": 32.60718,
"coordinatesPrecise": true
},
"language": "en-us",
"outcome": {}
}The Visit Assignment Object
Attributes
userIdstring :required
The unique identifier of the user.
firstNamestring :required
The first name of the user.
lastNamestring :required
The last name of the user.
userTypestring :required
The unique type identifier of the user. See the User Type Dictionary for possible values.
titlestring :optional
A given title of the user.
Example
{
"userId": "prv_f49d22746d2a4643b72d4f7908dc2cb4",
"firstName": "Susan",
"lastName": "Smith",
"userType": "medicalpractitioner",
"title": "Dr."
}The Visit Schedule Date Object
Attributes
timestamptimestamp :required
The UTC timestamp representing the chosen date.
statusstring :required
The status of this specific date. See the Visit Schedule Date Status Dictionary for possible values.
orderOfPreferencenumeric :required
The order of preference as requested by the user.
Example
{
"timestamp": "2021-08-17T15:00:00.000",
"status": "requested",
"orderOfPreference": 1
},
{
"timestamp": "2021-08-17T16:00:00.000",
"status": "confirmed",
"orderOfPreference": 2
},
{
"timestamp": "2021-08-17T17:00:00.000",
"status": "requested",
"orderOfPreference": 3
}The Visit Outcome Object
Attributes
prescriptionslist of objects :optional
A list of prescriptions submitted by the provider as part of the treatment following this visit. This is a list of Prescription Object.
diagnoseslist of objects :optional
A list of diagnoses identified by the provider as a result of the visit. This is a list of ICD-10 Objects.
procedureslist of objects :optional
A list of procedures performed by the provider during the visit. This is a list of CPT Objects.
clinicalNoteslist of objects :optional
A list of clinical notes attached to the visit.
typestring :required
The clinical note type identifier. See the Clinical Note Type Dictionary for possible values.
notestring :required
The clinical note.
Example
{
"prescriptions": [
{
"id": "rx_eb5d400f06b0495fb558b53b53650966",
"dateCreated": "2021-08-17T16:27:41.82",
"visitId": "1234567",
"pharmacyId": "pharm_6e0f8c4e7a36eb119fb400155dfc253f",
"drug": {
"name": "Medrol Dosepak 4mg Tablet",
"upc": null,
"ndC9": null,
"ndC10": null,
"ndC11": "00009005604",
"availableQuantities": [],
"quantityUnitOfMeasureCode": "C48542",
"quantityUnitOfMeasureName": "Tablet",
"rxNorm": null,
"route": {
"id": 1,
"name": "Oral"
},
"strength": {
"value": "4",
"unit": {
"code": "mg",
"name": "milligram"
},
"formCode": "C42998",
"unitOfMeasureCode": "C28253"
},
"form": {
"fdaFormId": 37,
"fdaFormName": "Tab",
"description": "Tablet"
},
"drugKey": null
},
"quantity": 21.00000,
"refillCount": 0,
"daysSupply": null,
"substitutionsAllowed": true,
"directions": "Use as directed",
"pharmacyNote": "",
"wentByFax": false,
"status": {
"status": "accepted",
"message": ""
},
"submission": {
"method": "providertoeprescribe",
"submittedByUserId": "prv_f49d22746d2a4643b72d4f7908dc2cb4"
},
"dateAccepted": "2021-08-17T16:27:41.82"
}
],
"diagnoses": [
{
"code": "J06.9",
"description": "Acute upper respiratory infection, unspecified"
}
],
"procedures": [
{
"code": "99441",
"description": "telephone E/M service; 5-10 minutes of medical discussion"
}
],
"clinicalNotes": [
{
"type": "subjective",
"note": "Subject: 38 y/o female c/o flu like symptoms, sore throat, watery eyes, productive cough with discoloration ,stuffy nose Onset- 4 days OTC- robitussin, Vicks, Tylenol- no relief **negative for COVID**‘ No history of asthma, no history of Diabetes Mellitus, no history of smoking. No history of fever. no Covid-19 contact. No history of recent overseas travel. No history of working in a hospital or nursing home and no plan to work in a hospital or nursing home in the coming days. No history of shortness of breath, no history of wheezing. History of runny nose. post nasal drip. Hydrochlorothiazide. Orally once daily. Patient denies being on Oral Contraceptive Pills. No possibility of pregnancy per patient. status post Tubal ligation."
},
{
"type": "objective",
"note": "Via phone."
},
{
"type": "assessment",
"note": "Upper respiratory infection suspect viral."
},
{
"type": "plan",
"note": "Antibiotics are not necessary in this situation as most likely cause of symptoms is viral. Rest, increased fluids, tylenol prn, saline gargles prn. Ok to use otc cough syrups prn such as Robitussin DM. If increasing symptoms such as increasing cough, fever, nausea, vomitting, or shortness of breath please go to the nearest Urgent care center or ER. Measures to prevent spread of infection to others advised such as frequent hand washing, proper disposal of tissues and handkerchiefs, gloves, masks, Social distancing from others, regular cleaning of door handles, other surfaces with sanitizing solutions etc. Advised to check Centers for Disease Control website for more information."
}
]
}Updated about 1 year ago