questionnaire responses
Create Questionnaire Response
post
/organizations/{organizationId}/fhir/3/QuestionnaireResponse
A structured set of questions and their answers. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the questionnaire being responded to.
Request
Headers
| content-type* | string | application/json|application/json+fhir | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug |
Body
| resourceType* | string | QuestionnaireResponse | This is a QuestionnaireResponse resource |
| identifier | Identifier | A business identifier assigned to a particular completed (or partially completed) questionnaire. | |
| basedOn | array(Reference) | The order, proposal or plan that is fulfilled in whole or in part by this QuestionnaireResponse. For example, a ProcedureRequest seeking an intake assessment or a decision support recommendation to assess for post-partum depression. | |
| parent | array(Reference) | A procedure or observation that this questionnaire was performed as part of the execution of. For example, the surgery a checklist was executed as part of. | |
| questionnaire | Reference | The Questionnaire that defines and organizes the questions for which answers are being provided. | |
| status | string | in-progress|completed|amended|entered-in-error|stopped | The position of the questionnaire response within its overall lifecycle. |
| subject | Reference | The subject of the questionnaire response. This could be a patient, organization, practitioner, device, etc. This is who/what the answers apply to, but is not necessarily the source of information. | |
| context | Reference | The encounter or episode of care with primary association to the questionnaire response. | |
| authored | string | The date and/or time that this set of answers were last changed. | |
| author | Reference | Person who received the answers to the questions in the QuestionnaireResponse and recorded them in the system. | |
| source | Reference | The person who answered the questions about the subject. | |
| item | array(QuestionnaireResponse_Item) | A group or question item from the original questionnaire for which answers are provided. |
Response
keyboard_arrow_down
Patch Questionnaire Response
patch
/organizations/{organizationId}/fhir/3/QuestionnaireResponse/{resourceId}
A structured set of questions and their answers. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the questionnaire being responded to.
Request
Headers
| content-type* | string | application/json-patch+json | application/json-patch+json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Body
| resourceType* | string | QuestionnaireResponse | This is a QuestionnaireResponse resource |
| identifier | Identifier | A business identifier assigned to a particular completed (or partially completed) questionnaire. | |
| basedOn | array(Reference) | The order, proposal or plan that is fulfilled in whole or in part by this QuestionnaireResponse. For example, a ProcedureRequest seeking an intake assessment or a decision support recommendation to assess for post-partum depression. | |
| parent | array(Reference) | A procedure or observation that this questionnaire was performed as part of the execution of. For example, the surgery a checklist was executed as part of. | |
| questionnaire | Reference | The Questionnaire that defines and organizes the questions for which answers are being provided. | |
| status | string | in-progress|completed|amended|entered-in-error|stopped | The position of the questionnaire response within its overall lifecycle. |
| subject | Reference | The subject of the questionnaire response. This could be a patient, organization, practitioner, device, etc. This is who/what the answers apply to, but is not necessarily the source of information. | |
| context | Reference | The encounter or episode of care with primary association to the questionnaire response. | |
| authored | string | The date and/or time that this set of answers were last changed. | |
| author | Reference | Person who received the answers to the questions in the QuestionnaireResponse and recorded them in the system. | |
| source | Reference | The person who answered the questions about the subject. | |
| item | array(QuestionnaireResponse_Item) | A group or question item from the original questionnaire for which answers are provided. |
Response
keyboard_arrow_down
Read Questionnaire Response
get
/organizations/{organizationId}/fhir/3/QuestionnaireResponse/{resourceId}
Request
Headers
| content-type* | string | application/json|application/json+fhir | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Response
keyboard_arrow_down
Read History Questionnaire Response
get
/organizations/{organizationId}/fhir/3/QuestionnaireResponse/{resourceId}/_history
Request
Headers
| content-type* | string | application/json|application/json+fhir | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
| _count | string | ||
| _since | string |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Response
keyboard_arrow_down
Read Version Questionnaire Response
get
/organizations/{organizationId}/fhir/3/QuestionnaireResponse/{resourceId}/_history/{versionId}
Request
Headers
| content-type* | string | application/json|application/json+fhir | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* | |||
| versionId* |
Response
keyboard_arrow_down
Remove Questionnaire Response
delete
/organizations/{organizationId}/fhir/3/QuestionnaireResponse/{resourceId}
Request
Headers
| content-type* | string | application/json|application/json+fhir | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Response
keyboard_arrow_down
Search Get Questionnaire Response
get
/organizations/{organizationId}/fhir/3/QuestionnaireResponse
Request
Headers
| content-type* | string | application/json|application/json+fhir | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
| _id | string | ||
| _language | string | ||
| author | string | ||
| authored | string | ||
| based-on | string | ||
| context | string | ||
| identifier | string | ||
| parent | string | ||
| patient | string | ||
| questionnaire | string | ||
| source | string | ||
| status | string | ||
| subject | string |
Params
| organizationId* | string|string | id|slug |
Response
keyboard_arrow_down
Search History Questionnaire Response
get
/organizations/{organizationId}/fhir/3/QuestionnaireResponse/_history
Request
Headers
| content-type* | string | application/json|application/json+fhir | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
| _count | string | ||
| _since | string |
Params
| organizationId* | string|string | id|slug |
Response
keyboard_arrow_down
Search Post Questionnaire Response
post
/organizations/{organizationId}/fhir/3/QuestionnaireResponse/_search
A structured set of questions and their answers. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the questionnaire being responded to.
Request
Headers
| content-type* | string | application/json|application/x-www-form-urlencoded | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
| _id | string | ||
| _language | string | ||
| author | string | ||
| authored | string | ||
| based-on | string | ||
| context | string | ||
| identifier | string | ||
| parent | string | ||
| patient | string | ||
| questionnaire | string | ||
| source | string | ||
| status | string | ||
| subject | string |
Params
| organizationId* | string|string | id|slug |
Body
| resourceType* | string | QuestionnaireResponse | This is a QuestionnaireResponse resource |
| identifier | Identifier | A business identifier assigned to a particular completed (or partially completed) questionnaire. | |
| basedOn | array(Reference) | The order, proposal or plan that is fulfilled in whole or in part by this QuestionnaireResponse. For example, a ProcedureRequest seeking an intake assessment or a decision support recommendation to assess for post-partum depression. | |
| parent | array(Reference) | A procedure or observation that this questionnaire was performed as part of the execution of. For example, the surgery a checklist was executed as part of. | |
| questionnaire | Reference | The Questionnaire that defines and organizes the questions for which answers are being provided. | |
| status | string | in-progress|completed|amended|entered-in-error|stopped | The position of the questionnaire response within its overall lifecycle. |
| subject | Reference | The subject of the questionnaire response. This could be a patient, organization, practitioner, device, etc. This is who/what the answers apply to, but is not necessarily the source of information. | |
| context | Reference | The encounter or episode of care with primary association to the questionnaire response. | |
| authored | string | The date and/or time that this set of answers were last changed. | |
| author | Reference | Person who received the answers to the questions in the QuestionnaireResponse and recorded them in the system. | |
| source | Reference | The person who answered the questions about the subject. | |
| item | array(QuestionnaireResponse_Item) | A group or question item from the original questionnaire for which answers are provided. |
Response
keyboard_arrow_down
Update Questionnaire Response
put
/organizations/{organizationId}/fhir/3/QuestionnaireResponse/{resourceId}
A structured set of questions and their answers. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the questionnaire being responded to.
Request
Headers
| content-type* | string | application/json|application/json+fhir | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Body
| resourceType* | string | QuestionnaireResponse | This is a QuestionnaireResponse resource |
| identifier | Identifier | A business identifier assigned to a particular completed (or partially completed) questionnaire. | |
| basedOn | array(Reference) | The order, proposal or plan that is fulfilled in whole or in part by this QuestionnaireResponse. For example, a ProcedureRequest seeking an intake assessment or a decision support recommendation to assess for post-partum depression. | |
| parent | array(Reference) | A procedure or observation that this questionnaire was performed as part of the execution of. For example, the surgery a checklist was executed as part of. | |
| questionnaire | Reference | The Questionnaire that defines and organizes the questions for which answers are being provided. | |
| status | string | in-progress|completed|amended|entered-in-error|stopped | The position of the questionnaire response within its overall lifecycle. |
| subject | Reference | The subject of the questionnaire response. This could be a patient, organization, practitioner, device, etc. This is who/what the answers apply to, but is not necessarily the source of information. | |
| context | Reference | The encounter or episode of care with primary association to the questionnaire response. | |
| authored | string | The date and/or time that this set of answers were last changed. | |
| author | Reference | Person who received the answers to the questions in the QuestionnaireResponse and recorded them in the system. | |
| source | Reference | The person who answered the questions about the subject. | |
| item | array(QuestionnaireResponse_Item) | A group or question item from the original questionnaire for which answers are provided. |
Response
keyboard_arrow_down