4.17 Questionnaire process response - JSON Representation

(back to narrative)

Raw json

{
  "resourceType" : "OperationDefinition",
  "id" : "Questionnaire-process-response",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns="http://www.w3.org/1999/xhtml"><h2>Questionnaire Process Response</h2><p>OPERATION: Questionnaire Process Response</p><p>The official URL for this operation definition is: </p><pre>http://hl7.org/fhir/us/sdc/OperationDefinition/Questionnaire-process-response</pre><div><p>This operation allows a system to 'receive' a QuestionnaireResponse for a particular Questionnaire.  It is intended to be used by systems that expect to receive completed questionnaires but which don't necessarily want to host a RESTful endpoint where those responses are subsequently queryable.  The receiver may choose to perform validation of the received response or against local business rules.  There no response beyond an HTTP 200 OK if the response is consumed successfully, though an OperationOutcome can optionally be returned identifying warnings.  If there are validation or other issues, the operation will fail with details in an OperationOutcome.  The specific action that occurs on receipt of a form will depend on both the type of form and the submitter.  It could trigger admission to a clinical trial, the beginning of an product investigation, the consideration of a patient's eligibility for coverage, etc.  Alternatively, the data may simply be consumed and aggregated with other information for analysis or other use.</p>
</div><p>URL: [base]/Questionnaire/$process-response</p><p>URL: [base]/Questionnaire/[id]/$process-response</p><p>Parameters</p><table class="grid"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>response</td><td>1..1</td><td>QuestionnaireResponse</td><td/><td><div><p>The questionnaire response to be accepted/processed</p>
</div></td></tr><tr><td>OUT</td><td>warnings</td><td>0..1</td><td>OperationOutcome</td><td/><td><div><p>If the response is successfully procssed, an OperationOutcome may still be returned indicating warnings.  For example, identifying questions that were incomplete, answers that were defaulted, etc.  It may also convey 'information' messages about the processing of the questionnaire response.</p>
</div></td></tr></table><div><p>Some receivers may accept responses that are still 'in progress', but others may reject instances with a status other than 'final' or possibly 'amended'.  If the operation is invoked on a particular Questionnaire, the submitted QuestionnaireResponse must be a response to the specified Questionnaire.  Otherwise, the QuestionnaireResponse will be validated against whatever Questionnaire the QuestionnaireResponse references.  It is an error for a QuestionnaireResponse that does not declare a questionnaire to be invoked directly on the Questionnaire endpoint.</p>
</div></div>"
  },
  "url" : "http://hl7.org/fhir/us/sdc/OperationDefinition/Questionnaire-process-response",
  "version" : "2.0",
  "name" : "Questionnaire Process Response",
  "status" : "draft",
  "kind" : "operation",
  "date" : "2017-03-19",
  "publisher" : "Health Level Seven",
  "contact" : [
    {
      "telecom" : [
        {
          "system" : "other",
          "value" : "http://hl7.org"
        }
      ]
    }
  ],
  "description" : "This operation allows a system to 'receive' a QuestionnaireResponse for a particular Questionnaire.  It is intended to be used by systems that expect to receive completed questionnaires but which don't necessarily want to host a RESTful endpoint where those responses are subsequently queryable.  The receiver may choose to perform validation of the received response or against local business rules.  There no response beyond an HTTP 200 OK if the response is consumed successfully, though an OperationOutcome can optionally be returned identifying warnings.  If there are validation or other issues, the operation will fail with details in an OperationOutcome.  The specific action that occurs on receipt of a form will depend on both the type of form and the submitter.  It could trigger admission to a clinical trial, the beginning of an product investigation, the consideration of a patient's eligibility for coverage, etc.  Alternatively, the data may simply be consumed and aggregated with other information for analysis or other use.",
  "code" : "process-response",
  "comment" : "Some receivers may accept responses that are still 'in progress', but others may reject instances with a status other than 'final' or possibly 'amended'.  If the operation is invoked on a particular Questionnaire, the submitted QuestionnaireResponse must be a response to the specified Questionnaire.  Otherwise, the QuestionnaireResponse will be validated against whatever Questionnaire the QuestionnaireResponse references.  It is an error for a QuestionnaireResponse that does not declare a questionnaire to be invoked directly on the Questionnaire endpoint.",
  "resource" : [
    "Questionnaire"
  ],
  "system" : false,
  "type" : true,
  "instance" : true,
  "parameter" : [
    {
      "name" : "response",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "The questionnaire response to be accepted/processed",
      "type" : "QuestionnaireResponse",
      "profile" : {
        "reference" : "http://hl7.org/fhir/us/sdc/StructureDefinition/sdc-questionnaireresponse"
      }
    },
    {
      "name" : "warnings",
      "use" : "out",
      "min" : 0,
      "max" : "1",
      "documentation" : "If the response is successfully procssed, an OperationOutcome may still be returned indicating warnings.  For example, identifying questions that were incomplete, answers that were defaulted, etc.  It may also convey 'information' messages about the processing of the questionnaire response.",
      "type" : "OperationOutcome"
    }
  ]
}