Questionnaire
Overview
The Questionnaire resource defines and organizes questions and the allowed answers to the questions typically used to collect patient healthcare information. A questionnaire is a snapshot in time and should be retrieved before each use. Examples of questionnaires are forms used to collect a patient’s social history or family member history. Currently, only social history is supported. In order to find a questionnaire for a specific patient, first search QuestionnaireResponse by patient. Then use the ‘questionnaire’ field from the QuestionnaireResponse to retrieve the original questionnaire.
The following fields are returned if valued:
Terminology Bindings
| Questionnaire.item.item.answerOption.valueCoding |
|
Extensions
Custom Extensions
URLs for custom extensions are defined as https://fhir-ehr.cerner.com/r4/StructureDefinition/{id}
| ID | Value[x] Type | Description |
|---|---|---|
note-allowed |
Boolean |
Whether a comment is allowed. |
Search
Search for Questionnaires that meet supplied query parameters:
GET /Questionnaire?:parameters
Authorization Types
Parameters
| Name | Required? | Type | Description |
|---|---|---|---|
_id |
Yes | token |
The logical resource id associated with the resource. |
Headers
Accept: application/fhir+json
Authorization: <OAuth2 Bearer Token>Example
Request
GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Questionnaire?_id=SH-12508041
Response
Status: 200 OK{
"resourceType": "Bundle",
"id": "902e1b49-b9c4-4786-b90b-c9612d478f2a",
"type": "searchset",
"link": [
{
"relation": "self",
"url": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Questionnaire?_id=SH-12508041"
}
],
"entry": [
{
"fullUrl": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Questionnaire/SH-12508041",
"resource": {
"resourceType": "Questionnaire",
"id": "SH-12508041",
"name": "Social_History",
"title": "Social History",
"status": "active",
"subjectType": [
"Patient"
],
"item": [
{
"linkId": "93",
"extension": [
{
"valueBoolean": true,
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/note-allowed"
}
],
"text": "Tobacco",
"type": "group",
"item": [
{
"linkId": "93-6930356",
"text": "Tobacco use per day:",
"type": "text",
"required": false,
"repeats": false,
"maxLength": 255
},
{
"linkId": "93-6930316",
"text": "Number of years:",
"type": "quantity",
"required": false,
"repeats": false
},
{
"linkId": "93-6930360",
"text": "Started at age:",
"type": "quantity",
"required": false,
"repeats": false
},
{
"linkId": "93-6930364",
"text": "Stopped at age:",
"type": "quantity",
"required": false,
"repeats": false
},
{
"linkId": "93-6930372",
"text": "Ready to change:",
"type": "choice",
"required": false,
"repeats": false,
"answerOption": [
{
"valueCoding": {
"system": "https://fhir.cerner.com/a758f80e-aa74-4118-80aa-98cc75846c76/nomenclature",
"code": "960439",
"display": "Yes"
}
},
{
"valueCoding": {
"system": "https://fhir.cerner.com/a758f80e-aa74-4118-80aa-98cc75846c76/nomenclature",
"code": "960441",
"display": "No"
}
}
]
},
{
"linkId": "93-6930376",
"text": "Concerns about tobacco use in household:",
"type": "open-choice",
"required": false,
"repeats": false,
"maxLength": 255,
"answerOption": [
{
"valueCoding": {
"system": "https://fhir.cerner.com/a758f80e-aa74-4118-80aa-98cc75846c76/nomenclature",
"code": "960439",
"display": "Yes"
}
},
{
"valueCoding": {
"system": "https://fhir.cerner.com/a758f80e-aa74-4118-80aa-98cc75846c76/nomenclature",
"code": "960441",
"display": "No"
}
}
]
},
{
"linkId": "93-6930380",
"text": "Total pack years:",
"type": "quantity",
"required": false,
"repeats": false
},
{
"extension": [
{
"valueInteger": 2,
"url": "http://hl7.org/fhir/StructureDefinition/maxDecimalPlaces"
}
],
"linkId": "93-4356884",
"text": "Weight",
"type": "quantity",
"required": false,
"repeats": false,
"maxLength": 6
}
]
}
]
}
}
]
}Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
Errors
The common errors and OperationOutcomes may be returned.
Retrieve by id
List an individual Questionnaire by its id:
GET /Questionnaire/:id
Authorization Types
Headers
Accept: application/fhir+json
Authorization: <OAuth2 Bearer Token>Example
Request
GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Questionnaire/SH-12508041
Response
Status: 200 OK{
"resourceType": "Questionnaire",
"id": "SH-12508041",
"name": "Social_History",
"title": "Social History",
"status": "active",
"subjectType": [
"Patient"
],
"item": [
{
"linkId": "93",
"extension": [
{
"valueBoolean": true,
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/note-allowed"
}
],
"text": "Tobacco",
"type": "group",
"item": [
{
"linkId": "93-6930356",
"text": "Tobacco use per day:",
"type": "text",
"required": false,
"repeats": false,
"maxLength": 255
},
{
"linkId": "93-6930316",
"text": "Number of years:",
"type": "quantity",
"required": false,
"repeats": false
},
{
"linkId": "93-6930360",
"text": "Started at age:",
"type": "quantity",
"required": false,
"repeats": false
},
{
"linkId": "93-6930364",
"text": "Stopped at age:",
"type": "quantity",
"required": false,
"repeats": false
},
{
"linkId": "93-6930372",
"text": "Ready to change:",
"type": "choice",
"required": false,
"repeats": false,
"answerOption": [
{
"valueCoding": {
"system": "https://fhir.cerner.com/a758f80e-aa74-4118-80aa-98cc75846c76/nomenclature",
"code": "960439",
"display": "Yes"
}
},
{
"valueCoding": {
"system": "https://fhir.cerner.com/a758f80e-aa74-4118-80aa-98cc75846c76/nomenclature",
"code": "960441",
"display": "No"
}
}
]
},
{
"linkId": "93-6930376",
"text": "Concerns about tobacco use in household:",
"type": "open-choice",
"required": false,
"repeats": false,
"maxLength": 255,
"answerOption": [
{
"valueCoding": {
"system": "https://fhir.cerner.com/a758f80e-aa74-4118-80aa-98cc75846c76/nomenclature",
"code": "960439",
"display": "Yes"
}
},
{
"valueCoding": {
"system": "https://fhir.cerner.com/a758f80e-aa74-4118-80aa-98cc75846c76/nomenclature",
"code": "960441",
"display": "No"
}
}
]
},
{
"linkId": "93-6930380",
"text": "Total pack years:",
"type": "quantity",
"required": false,
"repeats": false
},
{
"extension": [
{
"valueInteger": 2,
"url": "http://hl7.org/fhir/StructureDefinition/maxDecimalPlaces"
}
],
"linkId": "93-4356884",
"text": "Weight",
"type": "quantity",
"required": false,
"repeats": false,
"maxLength": 6
}
]
}
]
}Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
Errors
The common errors and OperationOutcomes may be returned.