Root Schema : QuestionnaireResponseUpdateBody
Type: object
Show Source
-
id(required):
string
The logical ID of the resource.
Example: SH-12508041
-
item(required):
array item
A group or question item from the original questionnaire for which answers are provided.
-
questionnaire(required):
string
The questionnaire that defines and organizes the questions for which answers are being provided.
Example: https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Questionnaire/SH-12508041
-
resourceType(required):
string
Allowed Values: [
"QuestionnaireResponse"
]
The type of the FHIR resource.
-
status(required):
string
Allowed Values: [
"in-progress"
]
The position of the questionnaire response within its overall lifecycle.
-
subject(required):
object subject
The subject of the questionnaire response. This subject is the patient that the answers apply to, but is not necessarily the source of information.
{
"type":"object",
"required":[
"resourceType",
"id",
"questionnaire",
"status",
"subject",
"item"
],
"properties":{
"resourceType":{
"description":"<p>The type of the FHIR resource.</p>\n",
"type":"string",
"enum":[
"QuestionnaireResponse"
]
},
"id":{
"description":"<p>The logical ID of the resource.</p>\n",
"type":"string",
"example":"SH-12508041"
},
"questionnaire":{
"description":"<p>The questionnaire that defines and organizes the questions for which answers are being provided.</p>\n",
"type":"string",
"example":"https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Questionnaire/SH-12508041"
},
"status":{
"description":"<p>The position of the questionnaire response within its overall lifecycle.</p>\n",
"type":"string",
"enum":[
"in-progress"
]
},
"subject":{
"description":"<p>The subject of the questionnaire response. This subject is the patient that the answers apply to, but is not necessarily the source of information.</p>\n",
"type":"object",
"properties":{
"reference":{
"type":"string",
"example":"Patient/12508041"
}
}
},
"item":{
"description":"<p>A group or question item from the original questionnaire for which answers are provided.</p>\n",
"type":"array",
"items":{
"type":"object",
"required":[
"linkId"
],
"properties":{
"id":{
"type":"string",
"description":"<p>Unique ID for inter-element referencing.</p>\n<p><b>Note:</b> If an <code>item.id</code> is returned on a read, it must be provided on an update.</p>\n",
"example":"111"
},
"linkId":{
"description":"<p>The item from the questionnaire that corresponds with this item in the QuestionnaireResponse resource.</p>\n",
"example":"93"
},
"extension":{
"description":"<p>Additional details about a given questionnaire response group item.</p>\n<p><b>Note:</b> Notes can only be added, not replaced or deleted.</p>\n",
"type":"array",
"items":{
"type":"object",
"properties":{
"url":{
"type":"string",
"enum":[
"https://fhir-ehr.cerner.com/r4/StructureDefinition/note"
]
},
"valueAnnotation":{
"type":"object",
"required":[
"text"
],
"properties":{
"text":{
"type":"string",
"example":"category/group comment"
}
}
}
}
}
},
"item":{
"type":"array",
"description":"<p>Questions nested beneath a group.</p>\n",
"items":{
"type":"object",
"required":[
"linkId",
"answer"
],
"properties":{
"linkId":{
"type":"string",
"description":"<p>The item from the questionnaire that corresponds with this item in the QuestionnaireResponse resource.</p>\n",
"example":"93-123"
},
"extension":{
"description":"<p>Whether the answers come from a list of options.</p>\n<p><b>Note:</b> Extension must be provided when answering a choice or open choice type of question.</p>\n",
"type":"array",
"items":{
"type":"object",
"required":[
"url",
"valueBoolean"
],
"properties":{
"url":{
"type":"string",
"enum":[
"https://fhir-ehr.cerner.com/r4/StructureDefinition/choice-answer"
]
},
"valueBoolean":{
"type":"boolean",
"enum":[
true
]
}
}
}
},
"answer":{
"description":"<p>The respondent's answer to the question.</p>\n<p><b>Note:</b> Only answer value types of String, Quantity, and Coding are supported.</p>\n",
"type":"array",
"items":{
"description":"<p>Single-valued answer to the question.</p>\n",
"type":"object",
"properties":{
"valueString":{
"type":"string",
"minLength":1,
"example":"Answer text"
},
"valueCoding":{
"type":"object",
"required":[
"system",
"code"
],
"properties":{
"system":{
"type":"string",
"example":"https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/nomenclature"
},
"code":{
"type":"string",
"example":"960439"
}
}
},
"valueQuantity":{
"type":"object",
"required":[
"value"
],
"properties":{
"value":{
"type":"number",
"example":20
}
}
}
}
}
}
}
}
}
}
}
}
},
"example":{
"resourceType":"QuestionnaireResponse",
"id":"SH-12508041",
"questionnaire":"https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Questionnaire/SH-12508041",
"status":"in-progress",
"subject":{
"reference":"Patient/12508041"
},
"item":[
{
"id":"111",
"linkId":"93",
"extension":[
{
"url":"https://fhir-ehr.cerner.com/r4/StructureDefinition/note",
"valueAnnotation":{
"text":"category/group comment"
}
}
],
"item":[
{
"linkId":"93-123",
"answer":[
{
"valueQuantity":{
"value":"20",
"unit":"year (iso1000)",
"system":"http://unitsofmeasure.org",
"code":"a"
}
}
]
},
{
"linkId":"93-456",
"answer":[
{
"valueString":"Answer text"
}
]
},
{
"linkId":"93-789",
"extension":[
{
"url":"https://fhir-ehr.cerner.com/r4/StructureDefinition/choice-answer",
"valueBoolean":true
}
],
"answer":[
{
"valueCoding":{
"system":"https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/nomenclature",
"code":"960439"
}
},
{
"valueString":"Other answer text"
}
]
}
]
}
]
}
}
Example:
{
"resourceType":"QuestionnaireResponse",
"id":"SH-12508041",
"questionnaire":"https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Questionnaire/SH-12508041",
"status":"in-progress",
"subject":{
"reference":"Patient/12508041"
},
"item":[
{
"id":"111",
"linkId":"93",
"extension":[
{
"url":"https://fhir-ehr.cerner.com/r4/StructureDefinition/note",
"valueAnnotation":{
"text":"category/group comment"
}
}
],
"item":[
{
"linkId":"93-123",
"answer":[
{
"valueQuantity":{
"value":"20",
"unit":"year (iso1000)",
"system":"http://unitsofmeasure.org",
"code":"a"
}
}
]
},
{
"linkId":"93-456",
"answer":[
{
"valueString":"Answer text"
}
]
},
{
"linkId":"93-789",
"extension":[
{
"url":"https://fhir-ehr.cerner.com/r4/StructureDefinition/choice-answer",
"valueBoolean":true
}
],
"answer":[
{
"valueCoding":{
"system":"https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/nomenclature",
"code":"960439"
}
},
{
"valueString":"Other answer text"
}
]
}
]
}
]
}
Nested Schema : item
Type: array
A group or question item from the original questionnaire for which answers are provided.
Show Source
{
"description":"<p>A group or question item from the original questionnaire for which answers are provided.</p>\n",
"type":"array",
"items":{
"type":"object",
"required":[
"linkId"
],
"properties":{
"id":{
"type":"string",
"description":"<p>Unique ID for inter-element referencing.</p>\n<p><b>Note:</b> If an <code>item.id</code> is returned on a read, it must be provided on an update.</p>\n",
"example":"111"
},
"linkId":{
"description":"<p>The item from the questionnaire that corresponds with this item in the QuestionnaireResponse resource.</p>\n",
"example":"93"
},
"extension":{
"description":"<p>Additional details about a given questionnaire response group item.</p>\n<p><b>Note:</b> Notes can only be added, not replaced or deleted.</p>\n",
"type":"array",
"items":{
"type":"object",
"properties":{
"url":{
"type":"string",
"enum":[
"https://fhir-ehr.cerner.com/r4/StructureDefinition/note"
]
},
"valueAnnotation":{
"type":"object",
"required":[
"text"
],
"properties":{
"text":{
"type":"string",
"example":"category/group comment"
}
}
}
}
}
},
"item":{
"type":"array",
"description":"<p>Questions nested beneath a group.</p>\n",
"items":{
"type":"object",
"required":[
"linkId",
"answer"
],
"properties":{
"linkId":{
"type":"string",
"description":"<p>The item from the questionnaire that corresponds with this item in the QuestionnaireResponse resource.</p>\n",
"example":"93-123"
},
"extension":{
"description":"<p>Whether the answers come from a list of options.</p>\n<p><b>Note:</b> Extension must be provided when answering a choice or open choice type of question.</p>\n",
"type":"array",
"items":{
"type":"object",
"required":[
"url",
"valueBoolean"
],
"properties":{
"url":{
"type":"string",
"enum":[
"https://fhir-ehr.cerner.com/r4/StructureDefinition/choice-answer"
]
},
"valueBoolean":{
"type":"boolean",
"enum":[
true
]
}
}
}
},
"answer":{
"description":"<p>The respondent's answer to the question.</p>\n<p><b>Note:</b> Only answer value types of String, Quantity, and Coding are supported.</p>\n",
"type":"array",
"items":{
"description":"<p>Single-valued answer to the question.</p>\n",
"type":"object",
"properties":{
"valueString":{
"type":"string",
"minLength":1,
"example":"Answer text"
},
"valueCoding":{
"type":"object",
"required":[
"system",
"code"
],
"properties":{
"system":{
"type":"string",
"example":"https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/nomenclature"
},
"code":{
"type":"string",
"example":"960439"
}
}
},
"valueQuantity":{
"type":"object",
"required":[
"value"
],
"properties":{
"value":{
"type":"number",
"example":20
}
}
}
}
}
}
}
}
}
}
}
}
Nested Schema : subject
Type: object
The subject of the questionnaire response. This subject is the patient that the answers apply to, but is not necessarily the source of information.
Show Source
{
"description":"<p>The subject of the questionnaire response. This subject is the patient that the answers apply to, but is not necessarily the source of information.</p>\n",
"type":"object",
"properties":{
"reference":{
"type":"string",
"example":"Patient/12508041"
}
}
}
Nested Schema : items
Type: object
Show Source
-
extension:
array extension
Additional details about a given questionnaire response group item.
Note: Notes can only be added, not replaced or deleted.
-
id:
string
Unique ID for inter-element referencing.
Note: If an item.id
is returned on a read, it must be provided on an update.
Example: 111
-
item:
array item
Questions nested beneath a group.
-
linkId(required):
The item from the questionnaire that corresponds with this item in the QuestionnaireResponse resource.
Example: 93
{
"type":"object",
"required":[
"linkId"
],
"properties":{
"id":{
"type":"string",
"description":"<p>Unique ID for inter-element referencing.</p>\n<p><b>Note:</b> If an <code>item.id</code> is returned on a read, it must be provided on an update.</p>\n",
"example":"111"
},
"linkId":{
"description":"<p>The item from the questionnaire that corresponds with this item in the QuestionnaireResponse resource.</p>\n",
"example":"93"
},
"extension":{
"description":"<p>Additional details about a given questionnaire response group item.</p>\n<p><b>Note:</b> Notes can only be added, not replaced or deleted.</p>\n",
"type":"array",
"items":{
"type":"object",
"properties":{
"url":{
"type":"string",
"enum":[
"https://fhir-ehr.cerner.com/r4/StructureDefinition/note"
]
},
"valueAnnotation":{
"type":"object",
"required":[
"text"
],
"properties":{
"text":{
"type":"string",
"example":"category/group comment"
}
}
}
}
}
},
"item":{
"type":"array",
"description":"<p>Questions nested beneath a group.</p>\n",
"items":{
"type":"object",
"required":[
"linkId",
"answer"
],
"properties":{
"linkId":{
"type":"string",
"description":"<p>The item from the questionnaire that corresponds with this item in the QuestionnaireResponse resource.</p>\n",
"example":"93-123"
},
"extension":{
"description":"<p>Whether the answers come from a list of options.</p>\n<p><b>Note:</b> Extension must be provided when answering a choice or open choice type of question.</p>\n",
"type":"array",
"items":{
"type":"object",
"required":[
"url",
"valueBoolean"
],
"properties":{
"url":{
"type":"string",
"enum":[
"https://fhir-ehr.cerner.com/r4/StructureDefinition/choice-answer"
]
},
"valueBoolean":{
"type":"boolean",
"enum":[
true
]
}
}
}
},
"answer":{
"description":"<p>The respondent's answer to the question.</p>\n<p><b>Note:</b> Only answer value types of String, Quantity, and Coding are supported.</p>\n",
"type":"array",
"items":{
"description":"<p>Single-valued answer to the question.</p>\n",
"type":"object",
"properties":{
"valueString":{
"type":"string",
"minLength":1,
"example":"Answer text"
},
"valueCoding":{
"type":"object",
"required":[
"system",
"code"
],
"properties":{
"system":{
"type":"string",
"example":"https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/nomenclature"
},
"code":{
"type":"string",
"example":"960439"
}
}
},
"valueQuantity":{
"type":"object",
"required":[
"value"
],
"properties":{
"value":{
"type":"number",
"example":20
}
}
}
}
}
}
}
}
}
}
}
Nested Schema : extension
Type: array
Additional details about a given questionnaire response group item.
Note: Notes can only be added, not replaced or deleted.
Show Source
{
"description":"<p>Additional details about a given questionnaire response group item.</p>\n<p><b>Note:</b> Notes can only be added, not replaced or deleted.</p>\n",
"type":"array",
"items":{
"type":"object",
"properties":{
"url":{
"type":"string",
"enum":[
"https://fhir-ehr.cerner.com/r4/StructureDefinition/note"
]
},
"valueAnnotation":{
"type":"object",
"required":[
"text"
],
"properties":{
"text":{
"type":"string",
"example":"category/group comment"
}
}
}
}
}
}
Nested Schema : item
Type: array
Questions nested beneath a group.
Show Source
{
"type":"array",
"description":"<p>Questions nested beneath a group.</p>\n",
"items":{
"type":"object",
"required":[
"linkId",
"answer"
],
"properties":{
"linkId":{
"type":"string",
"description":"<p>The item from the questionnaire that corresponds with this item in the QuestionnaireResponse resource.</p>\n",
"example":"93-123"
},
"extension":{
"description":"<p>Whether the answers come from a list of options.</p>\n<p><b>Note:</b> Extension must be provided when answering a choice or open choice type of question.</p>\n",
"type":"array",
"items":{
"type":"object",
"required":[
"url",
"valueBoolean"
],
"properties":{
"url":{
"type":"string",
"enum":[
"https://fhir-ehr.cerner.com/r4/StructureDefinition/choice-answer"
]
},
"valueBoolean":{
"type":"boolean",
"enum":[
true
]
}
}
}
},
"answer":{
"description":"<p>The respondent's answer to the question.</p>\n<p><b>Note:</b> Only answer value types of String, Quantity, and Coding are supported.</p>\n",
"type":"array",
"items":{
"description":"<p>Single-valued answer to the question.</p>\n",
"type":"object",
"properties":{
"valueString":{
"type":"string",
"minLength":1,
"example":"Answer text"
},
"valueCoding":{
"type":"object",
"required":[
"system",
"code"
],
"properties":{
"system":{
"type":"string",
"example":"https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/nomenclature"
},
"code":{
"type":"string",
"example":"960439"
}
}
},
"valueQuantity":{
"type":"object",
"required":[
"value"
],
"properties":{
"value":{
"type":"number",
"example":20
}
}
}
}
}
}
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"url":{
"type":"string",
"enum":[
"https://fhir-ehr.cerner.com/r4/StructureDefinition/note"
]
},
"valueAnnotation":{
"type":"object",
"required":[
"text"
],
"properties":{
"text":{
"type":"string",
"example":"category/group comment"
}
}
}
}
}
Nested Schema : valueAnnotation
Type: object
Show Source
{
"type":"object",
"required":[
"text"
],
"properties":{
"text":{
"type":"string",
"example":"category/group comment"
}
}
}
Nested Schema : items
Type: object
Show Source
-
answer(required):
array answer
The respondent's answer to the question.
Note: Only answer value types of String, Quantity, and Coding are supported.
-
extension:
array extension
Whether the answers come from a list of options.
Note: Extension must be provided when answering a choice or open choice type of question.
-
linkId(required):
string
The item from the questionnaire that corresponds with this item in the QuestionnaireResponse resource.
Example: 93-123
{
"type":"object",
"required":[
"linkId",
"answer"
],
"properties":{
"linkId":{
"type":"string",
"description":"<p>The item from the questionnaire that corresponds with this item in the QuestionnaireResponse resource.</p>\n",
"example":"93-123"
},
"extension":{
"description":"<p>Whether the answers come from a list of options.</p>\n<p><b>Note:</b> Extension must be provided when answering a choice or open choice type of question.</p>\n",
"type":"array",
"items":{
"type":"object",
"required":[
"url",
"valueBoolean"
],
"properties":{
"url":{
"type":"string",
"enum":[
"https://fhir-ehr.cerner.com/r4/StructureDefinition/choice-answer"
]
},
"valueBoolean":{
"type":"boolean",
"enum":[
true
]
}
}
}
},
"answer":{
"description":"<p>The respondent's answer to the question.</p>\n<p><b>Note:</b> Only answer value types of String, Quantity, and Coding are supported.</p>\n",
"type":"array",
"items":{
"description":"<p>Single-valued answer to the question.</p>\n",
"type":"object",
"properties":{
"valueString":{
"type":"string",
"minLength":1,
"example":"Answer text"
},
"valueCoding":{
"type":"object",
"required":[
"system",
"code"
],
"properties":{
"system":{
"type":"string",
"example":"https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/nomenclature"
},
"code":{
"type":"string",
"example":"960439"
}
}
},
"valueQuantity":{
"type":"object",
"required":[
"value"
],
"properties":{
"value":{
"type":"number",
"example":20
}
}
}
}
}
}
}
}
Nested Schema : answer
Type: array
The respondent's answer to the question.
Note: Only answer value types of String, Quantity, and Coding are supported.
Show Source
{
"description":"<p>The respondent's answer to the question.</p>\n<p><b>Note:</b> Only answer value types of String, Quantity, and Coding are supported.</p>\n",
"type":"array",
"items":{
"description":"<p>Single-valued answer to the question.</p>\n",
"type":"object",
"properties":{
"valueString":{
"type":"string",
"minLength":1,
"example":"Answer text"
},
"valueCoding":{
"type":"object",
"required":[
"system",
"code"
],
"properties":{
"system":{
"type":"string",
"example":"https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/nomenclature"
},
"code":{
"type":"string",
"example":"960439"
}
}
},
"valueQuantity":{
"type":"object",
"required":[
"value"
],
"properties":{
"value":{
"type":"number",
"example":20
}
}
}
}
}
}
Nested Schema : extension
Type: array
Whether the answers come from a list of options.
Note: Extension must be provided when answering a choice or open choice type of question.
Show Source
{
"description":"<p>Whether the answers come from a list of options.</p>\n<p><b>Note:</b> Extension must be provided when answering a choice or open choice type of question.</p>\n",
"type":"array",
"items":{
"type":"object",
"required":[
"url",
"valueBoolean"
],
"properties":{
"url":{
"type":"string",
"enum":[
"https://fhir-ehr.cerner.com/r4/StructureDefinition/choice-answer"
]
},
"valueBoolean":{
"type":"boolean",
"enum":[
true
]
}
}
}
}
Nested Schema : items
Type: object
Single-valued answer to the question.
Show Source
{
"description":"<p>Single-valued answer to the question.</p>\n",
"type":"object",
"properties":{
"valueString":{
"type":"string",
"minLength":1,
"example":"Answer text"
},
"valueCoding":{
"type":"object",
"required":[
"system",
"code"
],
"properties":{
"system":{
"type":"string",
"example":"https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/nomenclature"
},
"code":{
"type":"string",
"example":"960439"
}
}
},
"valueQuantity":{
"type":"object",
"required":[
"value"
],
"properties":{
"value":{
"type":"number",
"example":20
}
}
}
}
}
Nested Schema : valueCoding
Type: object
Show Source
{
"type":"object",
"required":[
"system",
"code"
],
"properties":{
"system":{
"type":"string",
"example":"https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/nomenclature"
},
"code":{
"type":"string",
"example":"960439"
}
}
}
Nested Schema : valueQuantity
Type: object
Show Source
{
"type":"object",
"required":[
"value"
],
"properties":{
"value":{
"type":"number",
"example":20
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"required":[
"url",
"valueBoolean"
],
"properties":{
"url":{
"type":"string",
"enum":[
"https://fhir-ehr.cerner.com/r4/StructureDefinition/choice-answer"
]
},
"valueBoolean":{
"type":"boolean",
"enum":[
true
]
}
}
}