Universal API Implementation Guide
1.1.19 - ci-build
Universal API Implementation Guide - Local Development build (v1.1.19). See the Directory of published versions
Questionnaire is a list of questions which are required to complete the enrollment of a patient. They may be related to the patient, medication or services which the patient is being enrolled for.
Some questions in the questionnaire are applicable only when a specific service(s) is requested in the bundle. To identify these questions, custom “metadata” questions are introduced in each Questionnaire definition. These metadata questions have “required” property set to false. Below is the list of metadata questions:
Example of metadata question:
{
"linkId" : "applied-for-pf",
"text" : "Patient Foundation Service Request Applied?",
"type" : "boolean",
"required" : false
},
Actual questions which need to be answered have “required” property set to true, and their dependency on specific Service requested is defined using “enabledWhen” property with reference to specific metadata question, for example:
{
"linkId" : "alecensa-confirmed-positive-alk",
"text" : "Confirmed positive for anaplastic lymphoma kinase (ALK)?",
"type" : "choice",
"enableWhen" : [
{
"question" : "applied-for-copay",
"operator" : "=",
"answerBoolean" : true
},
{
"question" : "applied-for-starter",
"operator" : "=",
"answerBoolean" : true
}
],
"enableBehavior" : "any",
"required" : true
},
Questionnaires consist of:
| Type | Example | Other Characteristics | When are they asked? | |
|---|---|---|---|---|
| Medical attestation questions (MAQ) | Metastatic non-small cell lung cancer (NSCLC)? | - Product specific - Linked to a Service Request type |
Enrolling a patient for Access Solutions or Genentech Patient Foundation services | |
| Non-clinical questions | Ok to send a text message? | - Not product specific - Linked to a Patient |
- Enrolling a patient for Access Solutions or Genentech Patient Foundation services - Submitting Patient Consent information |
|
| Metadata questions | Applied for BIPA | Not Specific to a Product or Patient but determines the type of services requested and enables the set of questions required for that service for e.g “Applied for BIPA”. Answer to this question should be Yes if “BI/PA” service requested so that questions required to do BIPA would be determined | - Enrolling a patient for Access Solutions or Genentech Patient Foundation services - Submitting Patient Consent information |
Questionnaires are accessed by external partners by requesting Questionnaire definitions from the Genentech FHIR Server. Based on product and version number, Genentech will respond back with questionnaires that are specific for that product.
Link to Questionnaire endpoint: {UAPI_URL}/questionnaire?name=Lucentis&version=1.0
Questionnaire Response: Vendor will include response to the questionnaires in the bundle utilizing the QuestionnaireResponse resource. Examples of responses: