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*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*stringQuestionnaireResponseThis is a QuestionnaireResponse resource
identifierIdentifierA business identifier assigned to a particular completed (or partially completed) questionnaire.
basedOnarray(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.
parentarray(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.
questionnaireReferenceThe Questionnaire that defines and organizes the questions for which answers are being provided.
statusstringin-progress|completed|amended|entered-in-error|stoppedThe position of the questionnaire response within its overall lifecycle.
subjectReferenceThe 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.
contextReferenceThe encounter or episode of care with primary association to the questionnaire response.
authoredstringThe date and/or time that this set of answers were last changed.
authorReferencePerson who received the answers to the questions in the QuestionnaireResponse and recorded them in the system.
sourceReferenceThe person who answered the questions about the subject.
itemarray(QuestionnaireResponse_Item)A group or question item from the original questionnaire for which answers are provided.

Response

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*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringQuestionnaireResponseThis is a QuestionnaireResponse resource
identifierIdentifierA business identifier assigned to a particular completed (or partially completed) questionnaire.
basedOnarray(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.
parentarray(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.
questionnaireReferenceThe Questionnaire that defines and organizes the questions for which answers are being provided.
statusstringin-progress|completed|amended|entered-in-error|stoppedThe position of the questionnaire response within its overall lifecycle.
subjectReferenceThe 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.
contextReferenceThe encounter or episode of care with primary association to the questionnaire response.
authoredstringThe date and/or time that this set of answers were last changed.
authorReferencePerson who received the answers to the questions in the QuestionnaireResponse and recorded them in the system.
sourceReferenceThe person who answered the questions about the subject.
itemarray(QuestionnaireResponse_Item)A group or question item from the original questionnaire for which answers are provided.

Response

Read Questionnaire Response

get
/organizations/{organizationId}/fhir/3/QuestionnaireResponse/{resourceId}

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Questionnaire Response

get
/organizations/{organizationId}/fhir/3/QuestionnaireResponse/{resourceId}/_history

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

Read Version Questionnaire Response

get
/organizations/{organizationId}/fhir/3/QuestionnaireResponse/{resourceId}/_history/{versionId}

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Questionnaire Response

delete
/organizations/{organizationId}/fhir/3/QuestionnaireResponse/{resourceId}

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Questionnaire Response

get
/organizations/{organizationId}/fhir/3/QuestionnaireResponse

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
authorstring
authoredstring
based-onstring
contextstring
identifierstring
parentstring
patientstring
questionnairestring
sourcestring
statusstring
subjectstring

Params

organizationId*string|stringid|slug

Response

Search History Questionnaire Response

get
/organizations/{organizationId}/fhir/3/QuestionnaireResponse/_history

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

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*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
authorstring
authoredstring
based-onstring
contextstring
identifierstring
parentstring
patientstring
questionnairestring
sourcestring
statusstring
subjectstring

Params

organizationId*string|stringid|slug

Body

resourceType*stringQuestionnaireResponseThis is a QuestionnaireResponse resource
identifierIdentifierA business identifier assigned to a particular completed (or partially completed) questionnaire.
basedOnarray(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.
parentarray(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.
questionnaireReferenceThe Questionnaire that defines and organizes the questions for which answers are being provided.
statusstringin-progress|completed|amended|entered-in-error|stoppedThe position of the questionnaire response within its overall lifecycle.
subjectReferenceThe 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.
contextReferenceThe encounter or episode of care with primary association to the questionnaire response.
authoredstringThe date and/or time that this set of answers were last changed.
authorReferencePerson who received the answers to the questions in the QuestionnaireResponse and recorded them in the system.
sourceReferenceThe person who answered the questions about the subject.
itemarray(QuestionnaireResponse_Item)A group or question item from the original questionnaire for which answers are provided.

Response

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*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringQuestionnaireResponseThis is a QuestionnaireResponse resource
identifierIdentifierA business identifier assigned to a particular completed (or partially completed) questionnaire.
basedOnarray(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.
parentarray(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.
questionnaireReferenceThe Questionnaire that defines and organizes the questions for which answers are being provided.
statusstringin-progress|completed|amended|entered-in-error|stoppedThe position of the questionnaire response within its overall lifecycle.
subjectReferenceThe 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.
contextReferenceThe encounter or episode of care with primary association to the questionnaire response.
authoredstringThe date and/or time that this set of answers were last changed.
authorReferencePerson who received the answers to the questions in the QuestionnaireResponse and recorded them in the system.
sourceReferenceThe person who answered the questions about the subject.
itemarray(QuestionnaireResponse_Item)A group or question item from the original questionnaire for which answers are provided.

Response