R10CommonData
Data structure to represent common elements for Registration Get\Post data.
R10CommonData data has following elements:
| patientId | (string) | Patient Id. |
| lang | (string) | UI language. Can be used to specify a lanuage for UI controls.
When customStrings element included, all customString.Display strings will be provided for a requested language.
|
| isMinor | (string) | Patient age is less than practice specifed max minor age. |
| dictionaries | (object) | All dictionaries needed to populate drop-down lists on UI. Specific for each function. |
| configParameters | (object) | Practice specific settings and parameters. Specific for each function. |
| sections | (object) | List of current state of each registration section. Used for a Hub Page data and to show on the left side of each other registration section. |
| customgStrings | (array) | For Get functions will have language specific text in "display" element for screen controls depends on "lang" parameter in a request. |
| languages | (array) | List of languages that can be used to select UI language. Set the value of "lang" element in a request based on used selection. |
| screenControls | (array) | TBD |
JSON Example: (Raw example)
{
"patientId": "3022",
"lang": "en",
"isMinor": "0",
"dictionaries": {
"sex": [ { "id": "f", "display": "Female" }, { "id": "m", "display": "Male" }, { "id": "u", "display": "Unknown or not specified" } ],
"maritalStatus": [ { "id": "3", "display": "Divorced" }, { "id": "2", "display": "Married" }, { "id": "5", "display": "Separated" }, { "id": "1", "display": "Single" }, { "id": "4", "display": "Widowed" } ],
"employment": [ { "id": "1", "display": "Employed Full-time" }, { "id": "2", "display": "Employed Part-time" }, { "id": "3", "display": "On Active Military Duty" }, { "id": "4", "display": "Retired" }, { "id": "8", "display": "Student" }, { "id": "6", "display": "Unemployed" }, { "id": "0", "display": "Unknown" } ],
"race": [ { "id": "8", "display": "African" }, { "id": "4", "display": "American Indian or Alaska Native" }, { "id": "7", "display": "Arabic / Middle Eastern" }, { "id": "5", "display": "Asian" }, { "id": "2", "display": "Black or African American" }, { "id": "1", "display": "Caucasian White" }, { "id": "3", "display": "Hispanic or Latino" }, { "id": "9", "display": "Indian" }, { "id": "6", "display": "Native Hawaiian or Other Pacific Islander" } ],
"ethnicity": [ { "id": "1", "display": "Hispanic or Latino" }, { "id": "2", "display": "Not Hispanic / Not Latino" }, { "id": "3", "display": "Undefined" } ],
"language": [ { "id": "7", "display": "Arabic" }, { "id": "8", "display": "Bengali" }, { "id": "5", "display": "Chinese" }, { "id": "18", "display": "Chinese (Cantonese)" }, { "id": "10", "display": "Chinese (Wu)" }, { "id": "1", "display": "English" }, { "id": "25", "display": "Farsi" }, { "id": "3", "display": "French" }, { "id": "12", "display": "German" }, { "id": "9", "display": "Hindi" }, { "id": "28", "display": "Hmong" }, { "id": "21", "display": "Italian" }, { "id": "4", "display": "Japanese" }, { "id": "13", "display": "Javanese" }, { "id": "14", "display": "Korean" }, { "id": "19", "display": "Marathi" }, { "id": "99", "display": "Other" }, { "id": "24", "display": "Polish" }, { "id": "11", "display": "Portuguese" }, { "id": "6", "display": "Russian" }, { "id": "27", "display": "Somali" }, { "id": "2", "display": "Spanish" }, { "id": "26", "display": "Swahili" }, { "id": "20", "display": "Tamil" }, { "id": "17", "display": "Telugu" }, { "id": "23", "display": "Thai" }, { "id": "15", "display": "Turkish" }, { "id": "22", "display": "Urdu" }, { "id": "16", "display": "Vietnamese" } ],
"states": [ { "id": "AL", "display": "Alabama" }, { "id": "AK", "display": "Alaska" }, { "id": "AZ", "display": "Arizona" }, { "id": "AR", "display": "Arkansas" }, { "id": "CA", "display": "California" }, { "id": "CO", "display": "Colorado" }, { "id": "CT", "display": "Connecticut" }, { "id": "DE", "display": "Delaware" }, { "id": "DC", "display": "DistrictofColumbia" }, { "id": "FL", "display": "Florida" }, { "id": "GA", "display": "Georgia" }, { "id": "HI", "display": "Hawaii" }, { "id": "ID", "display": "Idaho" }, { "id": "IL", "display": "Illinois" }, { "id": "IN", "display": "Indiana" }, { "id": "IA", "display": "Iowa" }, { "id": "KS", "display": "Kansas" }, { "id": "KY", "display": "Kentucky" }, { "id": "LA", "display": "Louisiana" }, { "id": "ME", "display": "Maine" }, { "id": "MD", "display": "Maryland" }, { "id": "MA", "display": "Massachusetts" }, { "id": "MI", "display": "Michigan" }, { "id": "MN", "display": "Minnesota" }, { "id": "MS", "display": "Mississippi" }, { "id": "MO", "display": "Missouri" }, { "id": "MT", "display": "Montana" }, { "id": "NE", "display": "Nebraska" }, { "id": "NV", "display": "Nevada" }, { "id": "NH", "display": "NewHampshire" }, { "id": "NJ", "display": "NewJersey" }, { "id": "NM", "display": "NewMexico" }, { "id": "NY", "display": "NewYork" }, { "id": "NC", "display": "NorthCarolina" }, { "id": "ND", "display": "NorthDakota" }, { "id": "OH", "display": "Ohio" }, { "id": "OK", "display": "Oklahoma" }, { "id": "OR", "display": "Oregon" }, { "id": "PA", "display": "Pennsylvania" }, { "id": "RI", "display": "RhodeIsland" }, { "id": "SC", "display": "SouthCarolina" }, { "id": "SD", "display": "SouthDakota" }, { "id": "TN", "display": "Tennessee" }, { "id": "TX", "display": "Texas" }, { "id": "UT", "display": "Utah" }, { "id": "VT", "display": "Vermont" }, { "id": "VA", "display": "Virginia" }, { "id": "WA", "display": "Washington" }, { "id": "WV", "display": "WestVirginia" }, { "id": "WI", "display": "Wisconsin" }, { "id": "WY", "display": "Wyoming" } ],
"relationshipGeneral": [ { "id": "9", "display": "Aunt/Uncle" }, { "id": "24", "display": "Brother" }, { "id": "16", "display": "Child" }, { "id": "15", "display": "Daughter" }, { "id": "21", "display": "Dependent" }, { "id": "20", "display": "Emancipated Minor" }, { "id": "26", "display": "Employee" }, { "id": "3", "display": "Father" }, { "id": "17", "display": "Foster Child" }, { "id": "7", "display": "Grandchild" }, { "id": "6", "display": "Grandparent" }, { "id": "22", "display": "Handicapped Dependent" }, { "id": "5", "display": "Legal Guardian" }, { "id": "12", "display": "Life Partner" }, { "id": "2", "display": "Mother" }, { "id": "8", "display": "Nephew/Niece" }, { "id": "27", "display": "Organ Donor" }, { "id": "29", "display": "Other" }, { "id": "4", "display": "Parent" }, { "id": "11", "display": "Partner" }, { "id": "1", "display": "Self" }, { "id": "13", "display": "Significant Other" }, { "id": "25", "display": "Sister" }, { "id": "14", "display": "Son" }, { "id": "23", "display": "Sponsored Dependent" }, { "id": "10", "display": "Spouse" }, { "id": "18", "display": "Step Child" }, { "id": "28", "display": "Unknown" }, { "id": "19", "display": "Ward" } ],
"relationshipParental": [ { "id": "3", "display": "Father" }, { "id": "5", "display": "Legal Guardian" }, { "id": "2", "display": "Mother" } ]
},
"configParameters": {
"NPR_Race": "True",
"SSN_Required": "1",
"NPRRace_Required": "1",
"NPRPrefLanguage": "1",
"NPRPrefLanguage_Required": "0",
"Minor_Max_Age": "16",
"NPR_Care_coordination": "True",
"NPR_Eyecare_Records": "True",
"NPR_Active": "True",
"PR_Active": "True"
},
"sections": {
"terms": { "required": "true", "state": "completed", "display": null, "expired": "false" },
"general": { "required": "true", "state": "new", "display": null, "expired": "false" },
"contact": { "required": "true", "state": "new", "display": null, "expired": "false" },
"payment": { "required": "true", "state": "new", "display": null, "expired": "false" },
"insurance": { "required": "true", "state": "new", "display": null, "expired": "false" },
"care": { "required": "true", "state": "new", "display": null, "expired": "false" },
"medication": { "required": "true", "state": "new", "display": null, "expired": "false" },
"history": { "required": "true", "state": "new", "display": null, "expired": "false" },
"questionnaire": { "required": "true", "state": "new", "display": null, "expired": "false" },
"symptoms": { "required": "true", "state": "new", "display": null, "expired": "false"}
},
"customStrings": [
{ "id": "hubactionEdit", "display": "edit", "lang": "en" },
{ "id": "hubactionReview", "display": "review", "lang": "en" },
{ "id": "hubactionStart", "display": "start", "lang": "en" },
{ "id": "hubheader1Caption", "display": "Demographic information", "lang": "en" },
{ "id": "hubheader1Text", "display": "It is recommended that you complete this section prior to your clinic visit for us to hold your scheduled appointment.", "lang": "en" },
{ "id": "hubheader2Caption", "display": "Medical History", "lang": "en" },
{ "id": "hubheader2Text", "display": "If you complete this information it will save you time at the clinic", "lang": "en" },
{ "id": "hublblCaption", "display": "Appointment Registration", "lang": "en" },
{ "id": "hublblCare", "display": "Care coordination", "lang": "en" },
{ "id": "hublblCurrent", "display": "Current symptoms", "lang": "en" },
{ "id": "hublblEmergency", "display": "Emergency Contact", "lang": "en" },
{ "id": "hublblHisory", "display": "Medical History", "lang": "en" },
{ "id": "hublblInsurance", "display": "Insurance Information", "lang": "en" },
{ "id": "hublblMedical", "display": "Medical History", "lang": "en" },
{ "id": "hublblMedications", "display": "Medications and allregies", "lang": "en" },
{ "id": "hublblPersonal", "display": "Personal Information", "lang": "en" },
{ "id": "hublblQuestions", "display": "Questionnaire", "lang": "en" },
{ "id": "hublblResponsible", "display": "Person responsible for payment", "lang": "en" },
{ "id": "hublblTerms", "display": "Terms", "lang": "en" },
{ "id": "piAddressCaption", "display": "Home Address", "lang": "en" },
{ "id": "piCityCaption", "display": "City", "lang": "en" },
{ "id": "piEmailCaption", "display": "Email Address", "lang": "en" },
{ "id": "piEmailDefault", "display": "Enter a valid email address", "lang": "en" },
{ "id": "piEmploymentCaption", "display": "Employment Status", "lang": "en" },
{ "id": "piEthnicityCaption", "display": "Ethnicity", "lang": "en" },
{ "id": "piFirstNameCaption", "display": "First Name", "lang": "en" },
{ "id": "piFirstNameDefault", "display": "Enter your first name", "lang": "en" },
{ "id": "piLanguageCaption", "display": "Preferred Language", "lang": "en" },
{ "id": "piLastNameCaption", "display": "Last Name", "lang": "en" },
{ "id": "piLastNameDefault", "display": "Enter your last name", "lang": "en" },
{ "id": "piLblHeader", "display": "Personal Information", "lang": "en" },
{ "id": "piMaritalCaption", "display": "Marital Status", "lang": "en" },
{ "id": "piNickCaption", "display": "How would the patient like to be addressed?", "lang": "en" },
{ "id": "piPhoneCaption", "display": "Phone", "lang": "en" },
{ "id": "piPhoneDefault", "display": "Enter a phone", "lang": "en" },
{ "id": "piPhoneText", "display": "We will use this phone number to contact you about appointments, billing, etc.We will never use your phone number for marketing purposes", "lang": "en" },
{ "id": "piRaceCaption", "display": "Race", "lang": "en" },
{ "id": "piReferralCaption", "display": "Do you have a referral for seeing us?", "lang": "en" },
{ "id": "piReferralNo", "display": "No", "lang": "en" },
{ "id": "piReferralText", "display": "A referral is an official doctor\u0027s form, usually filed through your insurance company so coverage is approved", "lang": "en" },
{ "id": "piReferralYes", "display": "Yes", "lang": "en" },
{ "id": "piSSNCaption", "display": "Social Security Number", "lang": "en" },
{ "id": "piSSNWarning", "display": "Important but not required", "lang": "en" },
{ "id": "piStateCaption", "display": "State", "lang": "en" },
{ "id": "piZipCaption", "display": "Zip/Postal Code", "lang": "en" }
],
"screenControls": null,
"languages": [ { "lang": "en", "name": "English" }, { "lang": "sp", "name": "Español" } ]
}
See also:
API Functions,
API Methods,
API Data