Operation-questionnaire-populate.xml

Operation Definition

Raw XML

<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="Questionnaire-populate"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><!-- Snipped for brevity --></div>
  </text>
  <url value="http://hl7.org/fhir/OperationDefinition/Questionnaire-populate"/>
  <name value="Populate Questionnaire"/>
  <publisher value="HL7 (FHIR Project)"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://hl7.org/fhir"/>
    </telecom>
    <telecom>
      <system value="email"/>
      <value value="fhir@lists.hl7.org"/>
    </telecom>
  </contact>
  <description value="Generates a [[[QuestionnaireAnswers]]] instance  based on a specified [[[Questionnaire]]],
   filling in answers to questions where possible based on information provided as part of
   the operation or already known by the server about the subject of the [[[Questionnaire]]].
    If the operation is not called at the instance level, one of the identifier or questionnaire
   'in' parameters must be provided.  (If called at the instance level, these parameters
   will be ignored.)  The response will contain a [[[QuestionnaireAnswers]]] instance based
   on the specified [[[Questionnaire]]] and/or an [[[OperationOutcome]]] resource with errors
   or warnings.  The [[[QuestionnaireAnswers]]] instance will be populated with an unanswered
   set of questions following the group and question structure of the specified [[[Questionnaire]]].
    If  *content* parameters were specified or the *local* parameter was set to true, some
   of the questions may have answers filled in as well.  In the case of repeating questions
   or groups, typically only one repetition will be provided unless answer values exist that
   would support populating multiple repetitions.  Population of the [[[QuestionnaireAnswers]]]
   with appropriate data is dependent on the questions and/or groups in the [[[Questionnaire]]]
   having metadata that allows the server to recognize the questions.  This might be through
   *Questionnaire.group.question.code*, through extensions such as the [[http://hl7.org/fhir/ExtensionD
  efinition/questionnaire-deReference|deReference]] extension or through us of the [[ConceptMap]]
   resource.  Regardless of the mechanism used to link the questions in a questionnaire to
   a &quot;known&quot; mapable concept, solutions using this operation should ensure that
   the details of the question and associated linkage element are sufficiently similar as
   to safely allow auto-population.  I.e. the question text and context must be sufficiently
   the same, the value set for the question must fall within the value set for the mapped
   element, the data types must be the same or convertable, etc."/>
  <status value="draft"/>
  <date value="2015-02-23T09:07:27+11:00"/>
  <kind value="operation"/>
  <code value="populate"/>
  <notes value="While it is theoretically possible for a [[[QuestionnaireAnswers]]] instance to be completely
   auto-populated and submitted without human review, the intention of this transaction is
   merely to reduce redundant data entry.  A client **SHOULD** ensure that a human submitter
   has an opportunity to review the auto-populated answers to confirm correctness as well
   as to complete or expand on information provided by the auto-population process.  Complex
   form designs with conditional logic or tight constraints on cardinalities may be challenging
   to auto-populate.  A server MAY choose to traverse the questionnaire as if it were a human
   respondant, answering only those questions that are enabled based on previously answered
   questions.  However doing so may result in minimal population.  Alternatively, systems
   may choose to populate all known answers, independent of dependencies and other constraints.
    This may cause questions to be answered that should not be answered.  It will be up to
   the client to appropriately prune the final populated questionnaire once human review
   has taken place.  Invoking this operation with the ''content'' parameter may involve the
   disclosure of personally identifiable healthcare information to the system which is performing
   the population process.  No such disclosures should be made unless the system on which
   the operation is being invoked is a &quot;trusted&quot; system and appropriate agreements
   are in place to protect the confidentiality of any information shared with that system."/>
  <system value="false"/>
  <type value="Questionnaire"/>
  <instance value="true"/>
  <parameter>
    <name value="identifier"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="A logical questionnaire identifier (i.e. ''Questionnaire.identifier''). The server must
     know the questionnaire or be able to retrieve it from other known repositories."/>
    <type value="uri"/>
  </parameter>
  <parameter>
    <name value="questionnaire"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="The [[[Questionnaire]]] is provided directly as part of the request. Servers may choose
     not to accept questionnaires in this fashion"/>
    <type value="Questionnaire"/>
  </parameter>
  <parameter>
    <name value="subject"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation value="The resource that is to be the *QuestionnaireAnswers.subject*. The [[[QuestionnaireAnswers]]]
     instance will reference the provided subject.  In addition, if the *local* parameter is
     set to true, server information about the specified subject will be used to populate the
     instance."/>
    <type value="Any"/>
  </parameter>
  <parameter>
    <name value="content"/>
    <use value="in"/>
    <min value="0"/>
    <max value="*"/>
    <documentation value="Resources containing information to be used to help populate the [[[QuestionnaireAnswers]]].
      These may be FHIR resources or may be Binaries containing FHIR documents, CDA documents
     or other source materials.  Servers may not support all possible source materials and
     may ignore materials they do not recognize.  (They MAY provide warnings if ignoring submitted
     resources.)"/>
    <type value="string"/>
  </parameter>
  <parameter>
    <name value="local"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="If specified and set to 'true' (and the server is capable), the server should use what
     resources and other knowledge it has about the referenced subject when pre-populating
     answers to questions."/>
    <type value="boolean"/>
  </parameter>
  <parameter>
    <name value="return"/>
    <use value="out"/>
    <min value="1"/>
    <max value="1"/>
    <documentation value="The partially (or fully)-populated set of answers for the specified Questionnaire"/>
    <type value="QuestionnaireAnswers"/>
  </parameter>
</OperationDefinition>