questionnaire responses

Create Questionnaire Response

post
/organizations/{organizationId}/fhir/4/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*This is a QuestionnaireResponse resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedarray(ResourceList)These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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 ServiceRequest seeking an intake assessment or a decision support recommendation to assess for post-partum depression.
partOfarray(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.
questionnairecanonicalThe Questionnaire that defines and organizes the questions for which answers are being provided.
statusin-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.
encounterReferenceThe Encounter during which this questionnaire response was created or to which the creation of this record is tightly associated.
authoreddateTimeThe 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/4/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*This is a QuestionnaireResponse resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedarray(ResourceList)These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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 ServiceRequest seeking an intake assessment or a decision support recommendation to assess for post-partum depression.
partOfarray(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.
questionnairecanonicalThe Questionnaire that defines and organizes the questions for which answers are being provided.
statusin-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.
encounterReferenceThe Encounter during which this questionnaire response was created or to which the creation of this record is tightly associated.
authoreddateTimeThe 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/4/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/4/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/4/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/4/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/4/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
encounterstring
identifierstring
part-ofstring
patientstring
questionnairestring
sourcestring
statusstring
subjectstring

Params

organizationId*string|stringid|slug

Response

Search History Questionnaire Response

get
/organizations/{organizationId}/fhir/4/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/4/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
encounterstring
identifierstring
part-ofstring
patientstring
questionnairestring
sourcestring
statusstring
subjectstring

Params

organizationId*string|stringid|slug

Body

resourceType*This is a QuestionnaireResponse resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedarray(ResourceList)These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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 ServiceRequest seeking an intake assessment or a decision support recommendation to assess for post-partum depression.
partOfarray(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.
questionnairecanonicalThe Questionnaire that defines and organizes the questions for which answers are being provided.
statusin-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.
encounterReferenceThe Encounter during which this questionnaire response was created or to which the creation of this record is tightly associated.
authoreddateTimeThe 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/4/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*This is a QuestionnaireResponse resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedarray(ResourceList)These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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 ServiceRequest seeking an intake assessment or a decision support recommendation to assess for post-partum depression.
partOfarray(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.
questionnairecanonicalThe Questionnaire that defines and organizes the questions for which answers are being provided.
statusin-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.
encounterReferenceThe Encounter during which this questionnaire response was created or to which the creation of this record is tightly associated.
authoreddateTimeThe 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