VICS Server

Version: 2.2

Schemes:

Summary

Path Operation Description
/meta/allergy/allergens GET

Lookup Allergens by search term, e.g. "CHOCOLATE"
/meta/allergy/signSymptoms GET

Lookup a Sign/Symptom
/meta/location GET

Lookup Clinics/Locations
/meta/problem/categories GET

Shows array of problem categories for user to select from
/meta/problem/lookup GET

Perform lexical search for problems
/meta/user/ GET

Return all users
/meta/user/authenticate POST

Authenticates user
/meta/vital/type GET

Retrieve list of vital types, with categories & qualifiers associated with types
/patient/allergy GET

List patient allergies, or return NKA message.
POST

Create a new Allergy and assign it to current patient
/patient/allergy/setNKA POST

Mark a patient's record as having 'No Known Allergies'
/patient/allergy/{allergyId} DELETE

Remove allergy
GET

Lookup Allergy information
PUT

Update an allergy.
/patient/data GET

Get list of patients
/patient/data/info GET

Get information data for a previously selected patient
/patient/data/report GET

Lookup report data for a previously selected patient
/patient/data/select GET

Select a specific patient
/patient/problem GET

Return detailed problem data
POST

Creates problem
/patient/problem/unremove/{problemId} PUT

Unremove problem associated with id
/patient/problem/{problemId} DELETE

Remove problem associated with id
GET

Return detailed single problem data
PUT

Updates problem associated with object
/patient/vital GET

Lists all vitals
POST

Creates a single vital
/patient/vital (MULTIPLE) POST

Creates multiple vitals
/patient/vital/{vitalId} DELETE

Remove vital associated with id
GET

Lookup vital associated with id

Security

Paths

Lookup Allergens by search term, e.g. "CHOCOLATE"

GET /meta/allergy/allergens

application/x-www-form-urlencoded

search

Allergy term to be looked up

 query string

application/json

200 OK

search complete

{
    "ALLERGENS": [
        {
            "allergyType": "DF",
            "id": "urn:national:120_82:3",
            "label": "CHOCOLATE",
            "synonymMatches": [
                "CHOCOLATES"
            ]
        }
    ],
    "DRUG CLASSES": [
    ],
    "DRUG INGREDIENTS": [
        {
            "allergyType": "D",
            "id": "urn:national:50_416:2014",
            "label": "CHOCOLATE FLAVORING"
        }
    ],
    "GENERICS": [
    ],
    "GENERICS TRADENAME": [
        {
            "allergyType": "D",
            "id": "urn:national:50_6:3811",
            "label": "CHOCOLATE LAXATIVE"
        }
    ]
}
allergens: object[]

list of allergens associated with the search

Allergen
generics: object[]

list of generic allergens associated with the search

Generics
generics_tradename: object[]

list of NDC/UPN allergens associated with the search

GenericsTradename
drug_ingredients: object[]

list of drug ingredients associated with the search

DrugIngredients
drug_classes: object[]

list of drug classes associated with the search

DrugClasses
500 Internal Server Error

Error

Lookup a Sign/Symptom

GET /meta/allergy/signSymptoms

Lookup sign/symptom by search term in optional sort direction (1 for ascending or -1 for descending)

application/x-www-form-urlencoded

searchTerm

Sign/symptom term to be looked up

 query string
direction

Sort order of list (1=Ascending, -1=Descending)

 query string , x ∈ { 1 (default) , -1 }

application/json

200 OK

Array of allergy signs and symptoms

SignSymptoms
500 Internal Server Error

Error

Lookup Clinics/Locations

GET /meta/location

Lookup Clinics/Locations by search term, sorted in ascending or descending order

application/x-www-form-urlencoded

search

Clinic/Location name to look up

 query string
direction

Sort order of list (1=Ascending, -1=Descending)

 query string , x ∈ { 1 (default) , -1 }

application/json

200 OK

search complete

ClinicLocation
Shows array of problem categories for user to select from

GET /meta/problem/categories

Returns array of problem categories for user to select from
id

Clinical Location URN ID

 query string
200 OK

List of Problem Categories

ProblemCategories
500 Internal Server Error

Error

Perform lexical search for problems

GET /meta/problem/lookup

Lookup expression data entries associated with problems that match a particu search term. The function will return two sets of results, PRIMARY results, which are problems that lexically match the search term, and SECONDARY results, which are problems whose terminology synonyms lexically match the search term
search

search term to use as query on problem data

 query string
synonyms

True to include synonym expressions, false for no synonyms

 query boolean

application/json

200 OK

search complete

ProblemLookupResults
500 Internal Server Error

Error when searching for problem.

Return all users

GET /meta/user/

Lookup all users with matching station Id

application/x-www-form-urlencoded

search

User name to lookup

 query string
limit

Maximum number of Users to query for

 query string 44

application/json

200 OK

search complete

SystemDefinition
500 Internal Server Error

Error when searching for users

Authenticates user

POST /meta/user/authenticate

Associates Client Address to Current Session

Problem Object contains data required to add new problem to selected user

body: object
200 OK

Authentication successful

500 Internal Server Error

Error

Retrieve list of vital types, with categories & qualifiers associated with types

GET /meta/vital/type
vitalTypes

Comma-delimited list of vital type abbreviations to look up. If this parameter is not specified, then all vital types available will be returned

 query string

application/json

200 OK

Array of vital type objects, which should also contain categories and qualifiers

VitalTypes
500 Internal Server Error

Error

List patient allergies, or return NKA message.

GET /patient/allergy

application/x-www-form-urlencoded

application/json

200 OK

successfully fetched list of allergies

allergyList: object[]
AllergyRes
400 Bad Request

NKA error message

error: string , x ∈ { No Known allergies , No Allergy Assessment }

Error message

500 Internal Server Error

Internal Server error

Create a new Allergy and assign it to current patient

POST /patient/allergy

application/x-www-form-urlencoded

Object describing the Allergy to create

AllergyCreate

application/json

200 OK

successfully created Allergy

{
    "allergyId": "urn:vista:999:120_8:1",
    "success": "Successfully created allergy ID urn:vista:999:120_8:1"
}
success: string

Success message

allergyId: string

URN ID of created allergy

500 Internal Server Error

Internal server error

Mark a patient's record as having 'No Known Allergies'

POST /patient/allergy/setNKA

Creates a 'No Known Allergies' Allergy Assessment record or returns an error message if patient has active allergies or already has an NKA assessment

application/x-www-form-urlencoded

application/json

200 OK

Successfully created Allergy Assessment

success: string

Success message

500 Internal Server Error

Internal server error

Remove allergy

DELETE /patient/allergy/{allergyId}

Marked allergy as removed, with optional comment

application/x-www-form-urlencoded

allergyId

Allergy URN ID

 path string
comment

Optional comment/reason for allergy removal

 query string

application/json

200 OK

Successfully marked allergy as removed

success: string

Success message

400 Bad Request

Error - Allergy already marked as removed

error: string

Error message

500 Internal Server Error

Internal server error

Lookup Allergy information

GET /patient/allergy/{allergyId}

Return information about a specified allergy. Note - filtered out chartMarked & idBandMarked properties

application/x-www-form-urlencoded

allergyId

Allergy URN ID

 path integer

application/json

200 OK #/definitions/AllergyLookup

successfully looked up Allergy

500 Internal Server Error

Internal server error

Update an allergy.

PUT /patient/allergy/{allergyId}

Update the specified allergy properties.

application/x-www-form-urlencoded

Allergy Object with ID & properties to change.

AllergyUpdate

application/json

200 OK

Successfully updated allergy

success: string

Success message

500 Internal Server Error

Internal server error

Get list of patients

GET /patient/data

Given a search term, list patients before (-1) or after (1) the search term index

application/x-www-form-urlencoded

search

Patient name to lookup

 query string
direction

Direction of search (-1=Before search term, 1=After search term)

 query string , x ∈ { 1 (default) , -1 }
limit

Maximum number of Patients to query for

 query string 44

application/json

200 OK

listing complete

PatientList
Get information data for a previously selected patient

GET /patient/data/info

Lookup current patient information for the patient selected via the select patient endpoint

application/x-www-form-urlencoded

application/json

200 OK

lookup complete

PatientInfo
Lookup report data for a previously selected patient

GET /patient/data/report

This assumes that you have already selected a patient with the select patient routine

application/x-www-form-urlencoded

application/json

200 OK

Lookup complete

PatientReport
Select a specific patient

GET /patient/data/select

Pick a patient for the current user session context. All patient operations from this point on will use the selected patient.
id

Patient URN identifier, retrieved from 'listPatients'

 query string

application/json

200 OK

Patient Information

PatientSelect
Return detailed problem data

GET /patient/problem

Returns problems available
activeFilter

Filter criteria relating to active/inactive status

 query string
200 OK

Success, list of problems

object
problemStatus: string 
"ACTIVE"
condition: string 
"PERMANENT"
snomedCTConceptCode: string 
"73211009"
snomedCTDesignationCode: string 
"121589010"
codingSystem: string 
"10D"
priority: string 
"ACUTE"
name: string 
"Cisplatin Injection (50 mg) (SCT 73211009)"
icdd: string 
"Puncture wound with foreign body of oral cavity, subsequent encounter"
id: string 
"urn:vista:999:9000011:1"
clinic: string 
"CLInicB"
responsibleProvider: string 
"ALEXANDER,ROBERT"
enteredBy: string 
"ALEXANDER,ROBERT"
problem: string 
"Diabetes mellitus"
facility: string 
"VISTA HEALTH CARE"
providerNarrative: string 
"Cisplatin Injection (50 mg)"
patient: string 
"CARTER,DAVID"
diagnosis: string 
"S01.542D"
probName: string 
"Cisplatin Injection (50 mg) (SCT 73211009)"
serviceConnectedConditions: object 
{
    "isAgentOrangeExposure": false,
    "isCombatVeteran": false,
    "isHeadAndOrNeckCancer": false,
    "isIonizingRadiationExposure": false,
    "isMilitarySexualTrauma": false,
    "isPersianGulfExposure": false,
    "isShipboardHazardDefense": false
}
isRemoved: boolean
500 Internal Server Error

Error

Creates problem

POST /patient/problem

Creates an new problem record

Problem Object contains data required to add new problem to selected user

diagnosis: string 
"urn:national:80:522489"
problem: string 
"urn:national:757_01:7130783"
problemStatus: string , x ∈ { ACTIVE , INACTIVE }
providerNarrative: string 
"Cisplatin Injection"
condition: string , x ∈ { TRANSCRIBED , PERMANENT , HIDDEN }
snomedCTConceptCode: string 
"73211009"
snomedCTDesignationCode: string 
"121589010"
codingSystem: string 
"10D"
facility: string 
"urn:vista:999:4:2957"
clinic: string 
"urn:vista:999:44:8"
priority: string , x ∈ { ACUTE , CHRONIC }
enteredBy: string 
"urn:vista:999:200:64"
responsibleProvider: string 
"urn:vista:999:200:64"
isAgentOrangeExposure: boolean
isIonizingRadiationExposure: boolean
isPersianGulfExposure: boolean
isHeadAndOrNeckCancer: boolean
isMilitarySexualTrauma: boolean
isShipboardHazardDefense: boolean
isCombatVeteran: boolean
enteredDate: string 
"2018-03-06T00:53:03.414Z"
lastModifiedDate: string 
"2018-03-06T00:53:03.414Z"
onsetDate: string 
"2018-03-06T00:53:03.414Z"
resolvedDate: string 
"2018-03-06T00:53:03.414Z"
interestDate: string 
"2018-03-06T00:53:03.414Z"
isServiceConnected: boolean
uniqueNewTermRequested: boolean
comments: object[]
object
commentText: string 
"This is a comment"
enteredDate: string 
"2018-03-06T00:53:03.414Z"
200 OK

Created

500 Internal Server Error

Error

Unremove problem associated with id

PUT /patient/problem/unremove/{problemId}

Unremoves an existing problem record
problemId

Problem URN ID

 path string
200 OK

Success

500 Internal Server Error

Error

Remove problem associated with id

DELETE /patient/problem/{problemId}

Removes an existing problem record
problemId

Problem URN ID

 path string
200 OK

Success

500 Internal Server Error

Error

Return detailed single problem data

GET /patient/problem/{problemId}

Returns single problem available
problemId

Problem URN ID

 path string
200 OK

Success, list of problems

problemStatus: string 
"ACTIVE"
condition: string 
"PERMANENT"
snomedCTConceptCode: string 
"73211009"
snomedCTDesignationCode: string 
"121589010"
codingSystem: string 
"10D"
priority: string 
"ACUTE"
name: string 
"Cisplatin Injection (50 mg) (SCT 73211009)"
icdd: string 
"Puncture wound with foreign body of oral cavity, subsequent encounter"
id: string 
"urn:vista:999:9000011:1"
clinic: string 
"CLInicB"
responsibleProvider: string 
"ALEXANDER,ROBERT"
enteredBy: string 
"ALEXANDER,ROBERT"
problem: string 
"Diabetes mellitus"
facility: string 
"VISTA HEALTH CARE"
providerNarrative: string 
"Cisplatin Injection (50 mg)"
patient: string 
"CARTER,DAVID"
diagnosis: string 
"S01.542D"
probName: string 
"Cisplatin Injection (50 mg) (SCT 73211009)"
isAgentOrangeExposure: boolean
isIonizingRadiationExposure: boolean
isPersianGulfExposure: boolean
isHeadAndOrNeckCancer: boolean
isMilitarySexualTrauma: boolean
isCombatVeteran: boolean
isShipboardHazardDefense: boolean
comments: object[]
object
commentText: string
commentId: number
enteredBy: object
id: string
label: string
enteredDate: string
lastModifiedDate: string
interestDate: string
facility: object
id: string
label: string
500 Internal Server Error

Error

Updates problem associated with object

PUT /patient/problem/{problemId}

Updates an existing problem record

Problem Object contains data required to update a patient's problem record

id: string 
"urn:vista:999:9000011:1"
problem: string 
"urn:national:757_01:7130783"
problemStatus: string , x ∈ { ACTIVE , INACTIVE }
condition: string , x ∈ { TRANSCRIBED , PERMANENT , HIDDEN }
priority: string , x ∈ { ACUTE , CHRONIC }
providerNarrative: string 
"Cisplatin Injection"
snomedCTConceptCode: string 
"73211009"
snomedCTDesignationCode: string 
"121589010"
diagnosis: string 
"urn:national:80:522489"
codingSystem: string 
"10D"
isRemoved: boolean
facility: string 
"urn:vista:999:4:2957"
clinic: string 
"urn:vista:999:44:8"
enteredBy: string 
"urn:vista:999:200:64"
responsibleProvider: string 
"urn:vista:999:200:64"
isAgentOrangeExposure: boolean
isIonizingRadiationExposure: boolean
isPersianGulfExposure: boolean
isHeadAndOrNeckCancer: boolean
isMilitarySexualTrauma: boolean
isShipboardHazardDefense: boolean
isCombatVeteran: boolean
enteredDate: string 
"2018-03-06T00:53:03.414Z"
lastModifiedDate: string 
"2018-03-06T00:53:03.414Z"
onsetDate: string 
"2018-03-06T00:53:03.414Z"
resolvedDate: string 
"2018-03-06T00:53:03.414Z"
interestDate: string 
"2018-03-06T00:53:03.414Z"
isServiceConnected: boolean
uniqueNewTermRequested: boolean
comments: string[]
string
newComments: string[]
string
problemId

Problem URN ID

 path string
200 OK

Success

500 Internal Server Error

Error

Lists all vitals

GET /patient/vital

Returns list of vitals objects associated with context patient

Vital list options to specify search

startDate: string 
"2017-01-01T18:06:04.493Z"
endDate: string 
"2017-08-01T18:06:04.493Z"
sortOrder: number 
-1
group: boolean
typeFilter: string[] 
[
    "BLOOD PRESSURE",
    "TEMPERATURE"
]
string
200 OK

List of vitals

string
500 Internal Server Error

Error

Creates a single vital

POST /patient/vital

Recorded vital data including date/time of measurements, hospital location, provider information, value, vital type, and units of measurements.

Vital measurements including date/time, vital type, hospital location, and measurement value

VitalSingle
200 OK

Successfully created vital

500 Internal Server Error

Internal server error

Creates multiple vitals

POST /patient/vital (MULTIPLE)

Recorded multiple vital data including date/time of measurements, hospital location, provider information, value, vital type, and units of measurements.

application/x-www-form-urlencoded

Multiple vital measurements including date/time, vital type, hospital location, and measurement value

VitalMultiple

application/json

200 OK

Successfully created vitals

500 Internal Server Error

Internal server error

Remove vital associated with id

DELETE /patient/vital/{vitalId}

Removes an existing Vital record
vitalId

Vital URN ID to search for

 path string
200 OK

Success

500 Internal Server Error

Error

Lookup vital associated with id

GET /patient/vital/{vitalId}

Returns single vital object associated with the context object
vitalId

Vital URN ID

 path string
200 OK

Single vital object

vitalsTakenDateTime: string

Time vitals was taken

"2019-01-01T18:06:04.493Z"
vitalsEnteredDateTime: string

Time vitals was entered

"2018-04-24T19:39:48.204Z"
value: string

Value of vital measurement

"32"
units: string

Unit of vital measurement

"in"
metricUnits: string

Metric unit of vital measurement

"cm"
metricValue: string

Metric value of vital measurement

"81.28"
id: string

Vital id

"urn:vista:999:120_5:2"
enteredBy: string

Provider name

"ALEXANDER,ROBERT"
vitalType: string

Name of vital type

"CIRCUMFERENCE/GIRTH"
hospitalLocation: string

Hospital where vital was taken

"CLINICX"
500 Internal Server Error

Error

Parameter definitions

Response definitions

Schema definitions

Allergen: object

id: string

URN ID of the allergen

label: string

Display name of the allergen

allergyType: string , x ∈ { D , F , O }

Type of allergy (D=Drug, F=Food, O=Other)

synonymMatches: string[]

List of synonym matches

string

AllergyCreate: object 

{
    "allergySeverity": "MODERATE",
    "allergyType": "FOOD",
    "comments": [
        "don't give him shellfish, either..."
    ],
    "dateOccurred": "2016-02-18",
    "mechanism": "ALLERGY",
    "observedOrHistorical": "OBSERVED",
    "reactant": {
        "id": "urn:national:120_82:5",
        "label": "SHELLFISH"
    },
    "reactions": [
        {
            "reaction": {
                "id": "urn:national:120_83:1",
                "label": "HIVES"
            }
        },
        {
            "reaction": {
                "id": "urn:national:120_83:2",
                "label": "ITCHING,WATERING EYES"
            }
        }
    ],
    "type": "Allergy"
}
type: string Allergy
reactant: object
id: string
label: string
allergyType: string , x ∈ { D , F , DF , O , DRUG , FOOD , DRUG, FOOD , OTHER }

D=DRUG, F=FOOD, DF=DRUG, FOOD, O=OTHER

dateOccurred: string (date-time)
observedOrHistorical: string , x ∈ { o , OBSERVED , h , HISTORICAL }

o=OBSERVED, h=HISTORICAL

mechanism: string , x ∈ { A , P , U , ALLERGY , PHARMACOLOGIC , UNKNOWN }

Allergy mechanism (A=ALLERGY, P=PHARMACOLOGIC, U=UNKNOWN)

reactions: object[]
ReactionCreate
allergySeverity: string , x ∈ { MILD , MODERATE , SEVERE }
comments: string[]
string

AllergyLookup: object

successfully looked up Allergy

{
    "allergyId": "urn:vista:999:120_8:1",
    "success": "Successfully created allergy ID urn:vista:999:120_8:1"
}
reactant: Reactant
reactantDetails: ReactantDetails
mechanism: string , x ∈ { A , P , U , ALLERGY , PHARMACOLOGIC , UNKNOWN }

Allergy mechanism (A=ALLERGY, P=PHARMACOLOGIC, U=UNKNOWN)

enteredBy: EnteredBy
allergyType: string , x ∈ { D , F , DF , O , DRUG , FOOD , DRUG, FOOD , OTHER }

D=DRUG, F=FOOD, DF=DRUG, FOOD, O=OTHER

dateTimeEntered: string (date-time)

Date entered into system

dateOccurred: string (date-time)

Date occurred

allergySeverity: string , x ∈ { MILD , MODERATE , SEVERE }
verified: boolean

true if verified/signed, otherwise false

observedOrHistorical: string

Observed or Historical Allergy?

comments: object[]

List of comment objects

Comment
reactions: object[]

List of reaction objects

ReactionLookup

AllergyRes: object 

{
    "allergyList": [
        {
            "allergySeverity": "MODERATE",
            "dateTimeEntered": "2018-08-20T19:59:22.563Z",
            "enteredAtFacility": {
                "id": "urn:vista:999:4:2957",
                "label": "VISTA HEALTH CARE"
            },
            "id": "urn:vista:999:120_8:1",
            "reactant": {
                "id": "urn:national:120_82:5",
                "label": "SHELLFISH"
            },
            "reactions": [
                "HIVES - ITCHING,WATERING EYES"
            ]
        }
    ]
}
id: string

URN ID of Allergy

reactant: object

Allergy reactant

id: string

URN ID of reactant

label: string

Display name of reactant

enteredAtFacility: object

the division/facility that the allergy was recorded at

id: string

URN ID of division

label: string

Display name of division

dateTimeEntered: string

date/time entered into database

allergySeverity: string , x ∈ { MILD , MODERATE , SEVERE }
reactions: string[]

List of reactions

string

Display name of reaction

AllergyUpdate: object

allergyId: string

URN ID of the Allergy to update

anyAllergyProperty: AnyValue

AnyValue: object

Any allergy property that is in the schema.

ClinicLocation: object[]

Clinic/Location properties

[
    {
        "label": "Clinic2",
        "urn": "urn:vista:999:44:5"
    },
    {
        "label": "VISTA HEALTH CARE",
        "urn": "urn:vista:999:44:3"
    }
]
object
urn: string

URN ID of Clinic/Location

label: string

Display name of Clinic/Location

CombatService: object

serviceIndicated: boolean
fromDate: string (date-time)
toDate: string (date-time)
combatVeteranEndDate: string (date-time)
cvDateEdited: string (date-time)
serviceLocation: object
label: string

Comment: object

A single comment

comment: string

Comment string

dateTimeEntered: string (date-time)

Date entered into system

enteredby: string

Display name of author

Contact: object

designee: object
name: string
phoneNumber: string
primaryEmergencyContact: object
name: string
phoneNumber: string

DrugClass: object

id: string

URN ID of drug class

label: string

display name of drug class

DrugClasses: object

id: string

URN ID of the class

classification: string

Display name of the class

DrugIngredient: object

id: string

URN ID of drug ingredient

label: string

display name of drug ingredient

DrugIngredients: object

id: string

URN ID of the ingredient

label: string

Display name of the ingredient

EnteredBy: object

Originator information

id: string

URN ID of Originator

label: string

display name of Originator

Generics: object

id: string

URN ID of the allergen

label: string

Display name of the allergen

GenericsTradename: object

id: string

URN ID of the allergen

label: string

Display name of the allergen

allergyType: string , x ∈ { D , F , O }

Type of allergy (D=Drug, F=Food, O=Other)

MilitaryService: object

combatService: CombatService
powStatus: PowStatus
branchLast: string
dischargeTypeLast: string
periodOfService: string

PatientInfo: object

Patient information

{
    "dateOfBirth": "1981-03-02T00:00:00.000Z",
    "id": "urn:vista:999:2:25",
    "isVeteran": true,
    "name": "CARTER,DAVID",
    "sex": "MALE",
    "socialSecurityNumber": "000000113"
}
id: string

URN ID of Patient

socialSecurityNumber: string
dateOfBirth: string (date-time)
sex: string , x ∈ { MALE , FEMALE }
isVeteran: boolean
serviceConnectedPercentage: integer , { x ∈ ℤ | 0 ≤ x ≤ 100 }
wardLocation: string
roombed: string
name: string

Display name of Patient

PatientList: object

Patient name and ID

[
    {
        "id": "urn:vista:999:2:22",
        "name": "EIGHTEEN,PATIENT R"
    },
    {
        "id": "urn:vista:999:2:17",
        "name": "EIGHT,PATIENT H"
    },
    {
        "id": "urn:vista:999:2:25",
        "name": "CARTER,DAVID"
    }
]
id: string

URN ID of Patient

name: string

Display name of Patient

PatientReport: object

Patient information

id: string

URN ID of Patient

socialSecurityNumber: string
dateOfBirth: string (date-time)
sex: string , x ∈ { MALE , FEMALE }
name: string

Display name of Patient

patientEligibilities: string[]
string
ethnicityInformation: string[]
string
raceInformation: string[]
string
militaryService: object[]
MilitaryService
treatmentFactors: object
radiationExposure: boolean
agentOrangeExposure: boolean
southwestAsianConditions: boolean
coveredByHealthInsurance: string , x ∈ { YES , NO }
contacts: object[]
Contact
patientContact: object
phoneNumberResidence: string
emailAddress: string
phoneNumberWork: string
phoneNumberCellular: string
temporaryAddress: boolean
permanentAddress: object
street1: string
city: string
county: integer
zipCode: string
country: object
label: string
state: object
label: string
religiousPreference: string

PatientSelect: object

Patient select info

id: string

URN ID of the patient

"urn:vista:999:2:25"
name: string

Display name of the patient

"CARTER,DAVID"
sex: string

Gender of the patient

"MALE"
type: string

The patient type with respect to treatment at a VA facility

"NSC VETERAN"
dob: string

ISO Date string representing the patient's date of birth

"1981-03-02T00:00:00.000Z"
ssn: string 
"000000113"

PowStatus: object

statusIndicated: string , x ∈ { YES , NO }
statusVerified: string (date-time)

ProblemCategories: object

name: string 
"VA-NATIONAL PROBLEM SELECTION LIST"
class: string 
"National"
categories: object[]
object
name: string 
"VA-PRIMARY CARE"
sequence: integer 
1
subheader: string 
"Primary Care (VA)"
showProblems: boolean 
true

ProblemDefinition: object

id: string

URN ID of the problem type

"urn:national:757_01:7001949"
label: string

Textual description of the problem type

"Benign essential hypertension"
snomedDesignationCode: string 
"3135013"
subsets: string[]
string 
"SCT"
codes: object[]
object
code: string 
"4448006"
source: string 
"SCT"
isActive: boolean 
true
synonyms: object[]
object
label: string 
"Lumbar puncture headache"
snomedDesignationCode: string 
"1786602019"

ProblemLookupResults: object

PRIMARY: object[]
ProblemDefinition
SECONDARY: object[]
ProblemDefinition

Reactant: object

Reactant information

id: string

URN ID of reactant

label: string

display name of reactant

ReactantDetails: object

Reactant details

drugClasses: object[]

List of drug classes

object
drugIngredients: object[]

List of drug ingredients

object

ReactionCreate: object

reaction: object
id: string
label: string

ReactionLookup: object

A reaction object

id: string

URN ID of reaction

label: string

Display name of reaction

SignSymptoms: object[]

object
id: string 
"urn:national:120_83:425"
label: string 
"UPPER AIRWAY OBSTRUCTION"
matchedSynonym: string 
"ACUTE UPPER AIRWAY OBSTRUCTION"

SystemDefinition: object

name: string 
"nodeVISTA"
stationId: number 
"999"
readOnly: boolean

UserDefinition: object

name: string 
"ALEXANDER,ROBERT"
id: string 
"urn:vista:999:200:64"

UserLookupResults: object

type: object
items: UserDefinition

VitalMultiple: object[]

VitalSingle

VitalSingle: object

vitalsTakenDateTime: string 
"2019-01-01T18:06:04.493Z"
vitalType: string 
"urn:national:120_51:20"
hospitalLocation: string 
"urn:vista:999:44:6"
value: string 
"32"
enteredBy: string 
"urn:vista:999:200:20"
qualifier: string[] 
[
    "urn:national:120_52:1",
    "urn:national:120_52:51"
]
string 
"urn:national:120_52:1"

VitalTypes: object[]

object
id: string 
"urn:national:120_51:1"
label: string 
"BLOOD PRESSURE"
abbreviation: string 
"BP"
qualifiers: object
additionalProperties: object[]
object
id: string 
"urn:national:120_52:1"
label: string 
"R ARM"
pattern: string 
"^\\d{1,3}$"