STU 3 Ballot
FoundationThis page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
. Page versions: R5 R3 R2
This resource has 3 operations associated with it:
| $populate | Populate Questionnaire |
| $populatehtml | Geneate HTML for Questionnaire |
| $populatelink | Generate a link to a Questionnaire completion webpage |
For more information about operations, including how they are invoked, see Operations.
Generates a QuestionnaireResponse 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 and only one of the identifier, questionnaire or questionnaireRef 'in' parameters must be provided. If called at the instance level, these parameters will be ignored.
The response will contain a QuestionnaireResponse instance based on the specified Questionnaire and/or an OperationOutcome resource with errors or warnings.
The QuestionnaireResponse 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 QuestionnaireResponse 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/StructureDefinition/questionnaire-deReference extension or through use of the ConceptMap resource.
Regardless of the mechanism used to link the questions in a questionnaire to a "known" mappable 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 convertible, etc.
Formal Definition (as a OperationDefinition).
URL: [base]/Questionnaire/$populate
URL: [base]/Questionnaire/[id]/$populate
| In Parameters: | |||||
| Name | Cardinality | Type | Binding | Profile | Documentation |
| identifier | 0..1 | uri | A logical questionnaire identifier (i.e. ''Questionnaire.identifier''). The server must know the questionnaire or be able to retrieve it from other known repositories. | ||
| questionnaire | 0..1 | Questionnaire | The Questionnaire is provided directly as part of the request. Servers may choose not to accept questionnaires in this fashion | ||
| questionnaireRef | 0..1 | Reference(Questionnaire) | The Questionnaire is provided as a resource reference. Servers may choose not to accept questionnaires in this fashion or may fail if they cannot resolve or access the referenced questionnaire. | ||
| subject | 1..1 | Reference(Any) | The resource that is to be the QuestionnaireResponse.subject. The QuestionnaireResponse 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. | ||
| content | 0..* | Reference(Any) | Resources containing information to be used to help populate the QuestionnaireResponse. 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.) | ||
| local | 0..1 | boolean | 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. | ||
| Out Parameters: | |||||
| Name | Cardinality | Type | Binding | Profile | Documentation |
| questionnaire | 1..1 | QuestionnaireResponse | The partially (or fully)-populated set of answers for the specified Questionnaire | ||
| issues | 0..1 | OperationOutcome | A list of hints and warnings about problems encountered while populating the questionnaire. These might be show to the user as an advisory note. Note: if the questionnaire cannot be populated at all, then the operation should fail, and an OperationOutcome is returned directly with the failure, rather than using this parameter | ||
While it is theoretically possible for a QuestionnaireResponse 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.
When creating an "empty" questionnaire, the general algorithm is to create a QuestionnaireResponse with one item for every item in the source Questionnaire, including items with "enableWhen", "display" items, etc. If a question has a default, the default answer should be populated. And the QuestionnaireResponse should point back to the originating Questionnaire. Repeating items will typically only include a single repetition. Other extensions and/or elements may also be populated if the system is aware of appropriate values.
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 respondent, 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 "trusted" system and appropriate agreements are in place to protect the confidentiality of any information shared with that system.
Request:
POST [base]/Questionnnaire/$populate
[other headers]
<Parameters xmlns="http://hl7.org/fhir" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://hl7.org/fhir ../../schema/parameters.xsd">
<parameter>
<name value="questionnaireRef"/>
<valueReference>
<reference value="http://hl7.org/fhir/Questionnaire/questionnaire-sdc-profile-example-ussg-fht"/>
</valueReference>
</parameter>
<parameter>
<name value="subject"/>
<valueReference>
<reference value="http://hl7.org/fhir/Patient/proband"/>
</valueReference>
</parameter>
<parameter>
<name value="local"/>
<valueBoolean value="true"/>
</parameter>
</Parameters>
Response:
HTTP/1.1 200 OK
[other headers]
<?xml version="1.0" encoding="UTF-8"?>
<Parameters xmlns="http://hl7.org/fhir">
<parameter>
<name value="questionnaire"/>
<resource>
<QuestionnaireResponse>
<id value="questionnaireresponse-sdc-example-ussg-fht-answers"/>
<questionnaire>
<reference value="Questionnaire/43127-6"/>
</questionnaire>
<status value="in-progress"/>
<subject>
<reference value="Patient/proband"/>
</subject>
<authored value="2008-01-17"/>
<group xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<linkId value="root"/>
<title value="US Surgeon General - Family Health Portrait"/>
<group>
<linkId value="0"/>
<question>
<linkId value="0.1"/>
<text value="Date Done"/>
<answer>
<valueDate value="2008-01-17"/>
</answer>
</question>
</group>
<group>
<linkId value="1"/>
<title value="Your health information"/>
<group>
<linkId value="1.1"/>
<question>
<linkId value="1.1.1"/>
<text value="Name"/>
<answer>
<valueString value="Annie Proband"/>
</answer>
</question>
<question>
<linkId value="1.1.2"/>
<text value="Gender"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA3-6"/>
<display value="Female"/>
</valueCoding>
</answer>
</question>
<question>
<linkId value="1.1.3"/>
<text value="Date of Birth"/>
<answer>
<valueDate value="1966-04-04"/>
</answer>
</question>
<question>
<linkId value="1.1.4"/>
<text value="Were you born a twin?"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA32-8"/>
<display value="No"/>
</valueCoding>
</answer>
</question>
<question>
<linkId value="1.1.5"/>
<text value="Were you adopted?"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA32-8"/>
<display value="No"/>
</valueCoding>
</answer>
</question>
<question>
<linkId value="1.1.6"/>
<text value="Are your parents related to each other in any way other than marriage?"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA32-8"/>
<display value="No"/>
</valueCoding>
</answer>
</question>
<question>
<linkId value="1.1.7"/>
<text value="Height"/>
<answer>
<valueDecimal value="63"/>
<group>
<linkId value="1.1.7.1"/>
<question>
<linkId value="1.1.7.1.1"/>
<text value="Units"/>
<answer>
<valueCoding>
<system value="http://unitsofmeasure.org"/>
<code value="[in_i]"/>
<display value="inches"/>
</valueCoding>
</answer>
</question>
</group>
</answer>
</question>
<question>
<linkId value="1.1.8"/>
<text value="Weight"/>
<answer>
<valueDecimal value="127"/>
<group>
<linkId value="1.1.8.1"/>
<question>
<linkId value="1.1.8.1.1"/>
<text value="Units"/>
<answer>
<valueCoding>
<system value="http://unitsofmeasure.org"/>
<code value="lb"/>
<display value="pounds"/>
</valueCoding>
</answer>
</question>
</group>
</answer>
</question>
<question>
<linkId value="1.1.9"/>
<text value="Body mass index (BMI) [Ratio]"/>
<answer>
<valueDecimal value="22.5"/>
</answer>
</question>
<question>
<linkId value="1.1.10"/>
<text value="Race"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA4457-3"/>
<display value="White"/>
</valueCoding>
</answer>
</question>
<question>
<linkId value="1.1.11"/>
<text value="Ethnicity"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA10602-3"/>
<display value="-- Mexican"/>
</valueCoding>
</answer>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA10606-4"/>
<display value="-- South American"/>
</valueCoding>
</answer>
</question>
</group>
</group>
<group>
<linkId value="2"/>
<title value="Family member health information"/>
<group>
<linkId value="2.1"/>
<group>
<linkId value="2.1.1"/>
<question>
<linkId value="2.1.1.1"/>
<text value="Relationship to you"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA10405-1"/>
<display value="Daughter"/>
</valueCoding>
</answer>
</question>
<question>
<linkId value="2.1.1.2"/>
<text value="Name"/>
<answer>
<valueString value="Susan"/>
</answer>
</question>
<question>
<linkId value="2.1.1.3"/>
<text value="Gender"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA3-6"/>
<display value="Female"/>
</valueCoding>
</answer>
</question>
<question>
<linkId value="2.1.1.4"/>
<text value="Living?"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA33-6"/>
<display value="Yes"/>
</valueCoding>
<group>
<linkId value="2.1.1.4.2"/>
<question>
<linkId value="2.1.1.4.2.2"/>
<text value="Age"/>
<answer>
<valueDecimal value="17"/>
</answer>
</question>
</group>
</answer>
</question>
<question>
<linkId value="2.1.1.5"/>
<text value="Was this person born a twin?"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA32-8"/>
<display value="No"/>
</valueCoding>
</answer>
</question>
<question>
<linkId value="2.1.1.6"/>
<text value="Was this person adopted?"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA32-8"/>
<display value="No"/>
</valueCoding>
</answer>
</question>
</group>
</group>
<group>
<linkId value="2.1"/>
<group>
<linkId value="2.1.1"/>
<question>
<linkId value="2.1.1.1"/>
<text value="Relationship to you"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA10415-0"/>
<display value="Brother"/>
</valueCoding>
</answer>
</question>
<question>
<linkId value="2.1.1.2"/>
<text value="Name"/>
<answer>
<valueString value="Brian"/>
</answer>
</question>
<question>
<linkId value="2.1.1.3"/>
<text value="Gender"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA2-8"/>
<display value="Male"/>
</valueCoding>
</answer>
</question>
<question>
<linkId value="2.1.1.4"/>
<text value="Living?"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA33-6"/>
<display value="Yes"/>
</valueCoding>
<group>
<linkId value="2.1.1.4.2"/>
<question>
<linkId value="2.1.1.4.2.2"/>
<text value="Age"/>
<answer>
<valueDecimal value="32"/>
</answer>
</question>
</group>
</answer>
</question>
<question>
<linkId value="2.1.1.5"/>
<text value="Was this person born a twin?"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA32-8"/>
<display value="No"/>
</valueCoding>
</answer>
</question>
<question>
<linkId value="2.1.1.6"/>
<text value="Was this person adopted?"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA32-8"/>
<display value="No"/>
</valueCoding>
</answer>
</question>
</group>
<group>
<linkId value="2.1.2"/>
<title value="This family member's history of disease"/>
<question>
<linkId value="2.1.2.1"/>
<text value="Disease or Condition"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA10550-4"/>
<display value="-- Other Cancer"/>
</valueCoding>
</answer>
</question>
<question>
<linkId value="2.1.2.2"/>
<text value="Age at Diagnosis"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA10397-0"/>
<display value="30-39"/>
</valueCoding>
</answer>
</question>
</group>
</group>
<group>
<linkId value="2.1"/>
<group>
<linkId value="2.1.1"/>
<question>
<linkId value="2.1.1.1"/>
<text value="Relationship to you"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA10418-4"/>
<display value="Sister"/>
</valueCoding>
</answer>
</question>
<question>
<linkId value="2.1.1.2"/>
<text value="Name"/>
<answer>
<valueString value="Janet"/>
</answer>
</question>
<question>
<linkId value="2.1.1.3"/>
<text value="Gender"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA3-6"/>
<display value="Female"/>
</valueCoding>
</answer>
</question>
<question>
<linkId value="2.1.1.4"/>
<text value="Living?"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA33-6"/>
<display value="Yes"/>
</valueCoding>
<group>
<linkId value="2.1.1.4.2"/>
<question>
<linkId value="2.1.1.4.2.2"/>
<text value="Age"/>
<answer>
<valueDecimal value="36"/>
</answer>
</question>
</group>
</answer>
</question>
<question>
<linkId value="2.1.1.5"/>
<text value="Was this person born a twin?"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA32-8"/>
<display value="No"/>
</valueCoding>
</answer>
</question>
<question>
<linkId value="2.1.1.6"/>
<text value="Was this person adopted?"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA32-8"/>
<display value="No"/>
</valueCoding>
</answer>
</question>
</group>
<group>
<linkId value="2.1.2"/>
<title value="This family member's history of disease"/>
<question>
<linkId value="2.1.2.1"/>
<text value="Disease or Condition"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA10536-3"/>
<display value="-- Breast Cancer"/>
</valueCoding>
</answer>
</question>
<question>
<linkId value="2.1.2.2"/>
<text value="Age at Diagnosis"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA10397-0"/>
<display value="30-39"/>
</valueCoding>
</answer>
</question>
</group>
</group>
<group>
<linkId value="2.1"/>
<group>
<linkId value="2.1.1"/>
<question>
<linkId value="2.1.1.1"/>
<text value="Relationship to you"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA10419-2"/>
<display value="Nephew"/>
</valueCoding>
</answer>
</question>
<question>
<linkId value="2.1.1.2"/>
<text value="Name"/>
<answer>
<valueString value="Ian"/>
</answer>
</question>
<question>
<linkId value="2.1.1.3"/>
<text value="Gender"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA2-8"/>
<display value="Male"/>
</valueCoding>
</answer>
</question>
<question>
<linkId value="2.1.1.4"/>
<text value="Living?"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA33-6"/>
<display value="Yes"/>
</valueCoding>
<group>
<linkId value="2.1.1.4.2"/>
<question>
<linkId value="2.1.1.4.2.2"/>
<text value="Age"/>
<answer>
<valueDecimal value="16"/>
</answer>
</question>
</group>
</answer>
</question>
<question>
<linkId value="2.1.1.5"/>
<text value="Was this person born a twin?"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA32-8"/>
<display value="No"/>
</valueCoding>
</answer>
</question>
<question>
<linkId value="2.1.1.6"/>
<text value="Was this person adopted?"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA32-8"/>
<display value="No"/>
</valueCoding>
</answer>
</question>
</group>
</group>
<group>
<linkId value="2.1"/>
<group>
<linkId value="2.1.1"/>
<question>
<linkId value="2.1.1.1"/>
<text value="Relationship to you"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA10420-0"/>
<display value="Niece"/>
</valueCoding>
</answer>
</question>
<question>
<linkId value="2.1.1.2"/>
<text value="Name"/>
<answer>
<valueString value="Helen"/>
</answer>
</question>
<question>
<linkId value="2.1.1.3"/>
<text value="Gender"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA3-6"/>
<display value="Female"/>
</valueCoding>
</answer>
</question>
<question>
<linkId value="2.1.1.4"/>
<text value="Living?"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA33-6"/>
<display value="Yes"/>
</valueCoding>
<group>
<linkId value="2.1.1.4.2"/>
<question>
<linkId value="2.1.1.4.2.2"/>
<text value="Age"/>
<answer>
<valueDecimal value="15"/>
</answer>
</question>
</group>
</answer>
</question>
<question>
<linkId value="2.1.1.5"/>
<text value="Was this person born a twin?"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA32-8"/>
<display value="No"/>
</valueCoding>
</answer>
</question>
<question>
<linkId value="2.1.1.6"/>
<text value="Was this person adopted?"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA32-8"/>
<display value="No"/>
</valueCoding>
</answer>
</question>
</group>
</group>
<group>
<linkId value="2.1"/>
<group>
<linkId value="2.1.1"/>
<question>
<linkId value="2.1.1.1"/>
<text value="Relationship to you"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA10416-8"/>
<display value="Father"/>
</valueCoding>
</answer>
</question>
<question>
<linkId value="2.1.1.2"/>
<text value="Name"/>
<answer>
<valueString value="Donald"/>
</answer>
</question>
<question>
<linkId value="2.1.1.3"/>
<text value="Gender"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA2-8"/>
<display value="Male"/>
</valueCoding>
</answer>
</question>
<question>
<linkId value="2.1.1.4"/>
<text value="Living?"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA33-6"/>
<display value="Yes"/>
</valueCoding>
<group>
<linkId value="2.1.1.4.2"/>
<question>
<linkId value="2.1.1.4.2.2"/>
<text value="Age"/>
<answer>
<valueDecimal value="52"/>
</answer>
</question>
</group>
</answer>
</question>
<question>
<linkId value="2.1.1.5"/>
<text value="Was this person born a twin?"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA32-8"/>
<display value="No"/>
</valueCoding>
</answer>
</question>
<question>
<linkId value="2.1.1.6"/>
<text value="Was this person adopted?"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA32-8"/>
<display value="No"/>
</valueCoding>
</answer>
</question>
</group>
</group>
<group>
<linkId value="2.1"/>
<group>
<linkId value="2.1.1"/>
<question>
<linkId value="2.1.1.1"/>
<text value="Relationship to you"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA10425-9"/>
<display value="Paternal Uncle"/>
</valueCoding>
</answer>
</question>
<question>
<linkId value="2.1.1.2"/>
<text value="Name"/>
<answer>
<valueString value="Eric"/>
</answer>
</question>
<question>
<linkId value="2.1.1.3"/>
<text value="Gender"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA2-8"/>
<display value="Male"/>
</valueCoding>
</answer>
</question>
<question>
<linkId value="2.1.1.4"/>
<text value="Living?"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA33-6"/>
<display value="Yes"/>
</valueCoding>
<group>
<linkId value="2.1.1.4.2"/>
<question>
<linkId value="2.1.1.4.2.2"/>
<text value="Age"/>
<answer>
<valueDecimal value="56"/>
</answer>
</question>
</group>
</answer>
</question>
<question>
<linkId value="2.1.1.5"/>
<text value="Was this person born a twin?"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA32-8"/>
<display value="No"/>
</valueCoding>
</answer>
</question>
<question>
<linkId value="2.1.1.6"/>
<text value="Was this person adopted?"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA32-8"/>
<display value="No"/>
</valueCoding>
</answer>
</question>
</group>
</group>
<group>
<linkId value="2.1"/>
<group>
<linkId value="2.1.1"/>
<question>
<linkId value="2.1.1.1"/>
<text value="Relationship to you"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA10421-8"/>
<display value="Paternal Aunt"/>
</valueCoding>
</answer>
</question>
<question>
<linkId value="2.1.1.2"/>
<text value="Name"/>
<answer>
<valueString value="Fiona"/>
</answer>
</question>
<question>
<linkId value="2.1.1.3"/>
<text value="Gender"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA3-6"/>
<display value="Female"/>
</valueCoding>
</answer>
</question>
<question>
<linkId value="2.1.1.4"/>
<text value="Living?"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA33-6"/>
<display value="Yes"/>
</valueCoding>
<group>
<linkId value="2.1.1.4.2"/>
<question>
<linkId value="2.1.1.4.2.2"/>
<text value="Age"/>
<answer>
<valueDecimal value="57"/>
</answer>
</question>
</group>
</answer>
</question>
<question>
<linkId value="2.1.1.5"/>
<text value="Was this person born a twin?"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA32-8"/>
<display value="No"/>
</valueCoding>
</answer>
</question>
<question>
<linkId value="2.1.1.6"/>
<text value="Was this person adopted?"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA32-8"/>
<display value="No"/>
</valueCoding>
</answer>
</question>
</group>
<group>
<linkId value="2.1.2"/>
<title value="This family member's history of disease"/>
<question>
<linkId value="2.1.2.1"/>
<text value="Disease or Condition"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA10543-9"/>
<display value="-- Skin Cancer"/>
</valueCoding>
</answer>
</question>
</group>
</group>
<group>
<linkId value="2.1"/>
<group>
<linkId value="2.1.1"/>
<question>
<linkId value="2.1.1.1"/>
<text value="Relationship to you"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA10423-4"/>
<display value="Paternal Grandfather"/>
</valueCoding>
</answer>
</question>
<question>
<linkId value="2.1.1.2"/>
<text value="Name"/>
<answer>
<valueString value="Bob"/>
</answer>
</question>
<question>
<linkId value="2.1.1.3"/>
<text value="Gender"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA2-8"/>
<display value="Male"/>
</valueCoding>
</answer>
</question>
<question>
<linkId value="2.1.1.4"/>
<text value="Living?"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA32-8"/>
<display value="No"/>
</valueCoding>
<group>
<linkId value="2.1.1.4.1"/>
<question>
<linkId value="2.1.1.4.1.1"/>
<text value="Cause of Death"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA10537-1"/>
<display value="-- Colon Cancer"/>
</valueCoding>
</answer>
</question>
<question>
<linkId value="2.1.1.4.1.2"/>
<text value="Age at Death"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA10400-2"/>
<display value="OVER 60"/>
</valueCoding>
</answer>
</question>
</group>
</answer>
</question>
<question>
<linkId value="2.1.1.5"/>
<text value="Was this person born a twin?"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA32-8"/>
<display value="No"/>
</valueCoding>
</answer>
</question>
<question>
<linkId value="2.1.1.6"/>
<text value="Was this person adopted?"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA32-8"/>
<display value="No"/>
</valueCoding>
</answer>
</question>
</group>
<group>
<linkId value="2.1.2"/>
<title value="This family member's history of disease"/>
<question>
<linkId value="2.1.2.1"/>
<text value="Disease or Condition"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA10537-1"/>
<display value="-- Colon Cancer"/>
</valueCoding>
</answer>
</question>
<question>
<linkId value="2.1.2.2"/>
<text value="Age at Diagnosis"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA10400-2"/>
<display value="OVER 60"/>
</valueCoding>
</answer>
</question>
</group>
</group>
<group>
<linkId value="2.1"/>
<group>
<linkId value="2.1.1"/>
<question>
<linkId value="2.1.1.1"/>
<text value="Relationship to you"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA10424-2"/>
<display value="Paternal Grandmother"/>
</valueCoding>
</answer>
</question>
<question>
<linkId value="2.1.1.2"/>
<text value="Name"/>
<answer>
<valueString value="Claire"/>
</answer>
</question>
<question>
<linkId value="2.1.1.3"/>
<text value="Gender"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA3-6"/>
<display value="Female"/>
</valueCoding>
</answer>
</question>
<question>
<linkId value="2.1.1.4"/>
<text value="Living?"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA32-8"/>
<display value="No"/>
</valueCoding>
<group>
<linkId value="2.1.1.4.1"/>
<question>
<linkId value="2.1.1.4.1.1"/>
<text value="Cause of Death"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA10589-2"/>
<display value="-- Other/Unexpected"/>
</valueCoding>
<group>
<linkId value="2.1.1.4.1.1.1"/>
<question>
<text value="Please specify"/>
<answer>
<valueString value="Lou Gehrigs"/>
</answer>
</question>
</group>
</answer>
</question>
<question>
<linkId value="2.1.1.4.1.2"/>
<text value="Age at Death"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA10400-2"/>
<display value="OVER 60"/>
</valueCoding>
</answer>
</question>
</group>
</answer>
</question>
<question>
<linkId value="2.1.1.5"/>
<text value="Was this person born a twin?"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA32-8"/>
<display value="No"/>
</valueCoding>
</answer>
</question>
<question>
<linkId value="2.1.1.6"/>
<text value="Was this person adopted?"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA32-8"/>
<display value="No"/>
</valueCoding>
</answer>
</question>
</group>
</group>
<group>
<linkId value="2.1"/>
<group>
<linkId value="2.1.1"/>
<question>
<linkId value="2.1.1.1"/>
<text value="Relationship to you"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA10417-6"/>
<display value="Mother"/>
</valueCoding>
</answer>
</question>
<question>
<linkId value="2.1.1.2"/>
<text value="Name"/>
<answer>
<valueString value="Harriet"/>
</answer>
</question>
<question>
<linkId value="2.1.1.3"/>
<text value="Gender"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA3-6"/>
<display value="Female"/>
</valueCoding>
</answer>
</question>
<question>
<linkId value="2.1.1.4"/>
<text value="Living?"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA32-8"/>
<display value="No"/>
</valueCoding>
<group>
<linkId value="2.1.1.4.1"/>
<question>
<linkId value="2.1.1.4.1.1"/>
<text value="Cause of Death"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA10539-7"/>
<display value="-- Ovarian Cancer"/>
</valueCoding>
</answer>
</question>
<question>
<linkId value="2.1.1.4.1.2"/>
<text value="Age at Death"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA10399-6"/>
<display value="50-59"/>
</valueCoding>
</answer>
</question>
</group>
</answer>
</question>
<question>
<linkId value="2.1.1.5"/>
<text value="Was this person born a twin?"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA32-8"/>
<display value="No"/>
</valueCoding>
</answer>
</question>
<question>
<linkId value="2.1.1.6"/>
<text value="Was this person adopted?"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA32-8"/>
<display value="No"/>
</valueCoding>
</answer>
</question>
</group>
<group>
<linkId value="2.1.2"/>
<title value="This family member's history of disease"/>
<question>
<linkId value="2.1.2.1"/>
<text value="Disease or Condition"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA10539-7"/>
<display value="-- Ovarian Cancer"/>
</valueCoding>
</answer>
</question>
<question>
<linkId value="2.1.2.2"/>
<text value="Age at Diagnosis"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA10398-8"/>
<display value="40-49"/>
</valueCoding>
</answer>
</question>
</group>
</group>
<group>
<linkId value="2.1"/>
<group>
<linkId value="2.1.1"/>
<question>
<linkId value="2.1.1.1"/>
<text value="Relationship to you"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA10414-3"/>
<display value="Maternal Uncle"/>
</valueCoding>
</answer>
</question>
<question>
<linkId value="2.1.1.2"/>
<text value="Name"/>
<answer>
<valueString value="Rudy"/>
</answer>
</question>
<question>
<linkId value="2.1.1.3"/>
<text value="Gender"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA2-8"/>
<display value="Male"/>
</valueCoding>
</answer>
</question>
<question>
<linkId value="2.1.1.4"/>
<text value="Living?"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA33-6"/>
<display value="Yes"/>
</valueCoding>
<group>
<linkId value="2.1.1.4.2"/>
<question>
<linkId value="2.1.1.4.2.2"/>
<text value="Age"/>
<answer>
<valueDecimal value="60"/>
</answer>
</question>
</group>
</answer>
</question>
<question>
<linkId value="2.1.1.5"/>
<text value="Was this person born a twin?"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA32-8"/>
<display value="No"/>
</valueCoding>
</answer>
</question>
<question>
<linkId value="2.1.1.6"/>
<text value="Was this person adopted?"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA32-8"/>
<display value="No"/>
</valueCoding>
</answer>
</question>
</group>
</group>
<group>
<linkId value="2.1"/>
<group>
<linkId value="2.1.1"/>
<question>
<linkId value="2.1.1.1"/>
<text value="Relationship to you"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA10410-1"/>
<display value="Maternal Aunt"/>
</valueCoding>
</answer>
</question>
<question>
<linkId value="2.1.1.2"/>
<text value="Name"/>
<answer>
<valueString value="Julie"/>
</answer>
</question>
<question>
<linkId value="2.1.1.3"/>
<text value="Gender"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA3-6"/>
<display value="Female"/>
</valueCoding>
</answer>
</question>
<question>
<linkId value="2.1.1.4"/>
<text value="Living?"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA33-6"/>
<display value="Yes"/>
</valueCoding>
<group>
<linkId value="2.1.1.4.2"/>
<question>
<linkId value="2.1.1.4.2.2"/>
<text value="Age"/>
<answer>
<valueDecimal value="57"/>
</answer>
</question>
</group>
</answer>
</question>
<question>
<linkId value="2.1.1.5"/>
<text value="Was this person born a twin?"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA32-8"/>
<display value="No"/>
</valueCoding>
</answer>
</question>
<question>
<linkId value="2.1.1.6"/>
<text value="Was this person adopted?"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA32-8"/>
<display value="No"/>
</valueCoding>
</answer>
</question>
</group>
</group>
<group>
<linkId value="2.1"/>
<group>
<linkId value="2.1.1"/>
<question>
<linkId value="2.1.1.1"/>
<text value="Relationship to you"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA10412-7"/>
<display value="Maternal Grandfather"/>
</valueCoding>
</answer>
</question>
<question>
<linkId value="2.1.1.2"/>
<text value="Name"/>
<answer>
<valueString value="Ian"/>
</answer>
</question>
<question>
<linkId value="2.1.1.3"/>
<text value="Gender"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA2-8"/>
<display value="Male"/>
</valueCoding>
</answer>
</question>
<question>
<linkId value="2.1.1.4"/>
<text value="Living?"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA32-8"/>
<display value="No"/>
</valueCoding>
<group>
<linkId value="2.1.1.4.1"/>
<question>
<linkId value="2.1.1.4.1.1"/>
<text value="Cause of Death"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA10558-7"/>
<display value="-- Heart Attack"/>
</valueCoding>
</answer>
</question>
<question>
<linkId value="2.1.1.4.1.2"/>
<text value="Age at Death"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA10400-2"/>
<display value="OVER 60"/>
</valueCoding>
</answer>
</question>
</group>
</answer>
</question>
<question>
<linkId value="2.1.1.5"/>
<text value="Was this person born a twin?"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA32-8"/>
<display value="No"/>
</valueCoding>
</answer>
</question>
<question>
<linkId value="2.1.1.6"/>
<text value="Was this person adopted?"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA32-8"/>
<display value="No"/>
</valueCoding>
</answer>
</question>
</group>
</group>
<group>
<linkId value="2.1"/>
<group>
<linkId value="2.1.1"/>
<question>
<linkId value="2.1.1.1"/>
<text value="Relationship to you"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA10413-5"/>
<display value="Maternal Grandmother"/>
</valueCoding>
</answer>
</question>
<question>
<linkId value="2.1.1.2"/>
<text value="Name"/>
<answer>
<valueString value="Gladys"/>
</answer>
</question>
<question>
<linkId value="2.1.1.3"/>
<text value="Gender"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA3-6"/>
<display value="Female"/>
</valueCoding>
</answer>
</question>
<question>
<linkId value="2.1.1.4"/>
<text value="Living?"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA32-8"/>
<display value="No"/>
</valueCoding>
<group>
<linkId value="2.1.1.4.1"/>
<question>
<linkId value="2.1.1.4.1.1"/>
<text value="Cause of Death"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA10571-0"/>
<display value="-- Other/Unknown"/>
</valueCoding>
</answer>
</question>
<question>
<linkId value="2.1.1.4.1.2"/>
<text value="Age at Death"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA10400-2"/>
<display value="OVER 60"/>
</valueCoding>
</answer>
</question>
</group>
</answer>
</question>
<question>
<linkId value="2.1.1.5"/>
<text value="Was this person born a twin?"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA32-8"/>
<display value="No"/>
</valueCoding>
</answer>
</question>
<question>
<linkId value="2.1.1.6"/>
<text value="Was this person adopted?"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA32-8"/>
<display value="No"/>
</valueCoding>
</answer>
</question>
</group>
<group>
<linkId value="2.1.2"/>
<title value="This family member's history of disease"/>
<question>
<linkId value="2.1.2.1"/>
<text value="Disease or Condition"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA10536-3"/>
<display value="-- Breast Cancer"/>
</valueCoding>
</answer>
</question>
<question>
<linkId value="2.1.2.2"/>
<text value="Age at Diagnosis"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA10399-6"/>
<display value="50-59"/>
</valueCoding>
</answer>
</question>
</group>
<group>
<linkId value="2.1.2"/>
<title value="This family member's history of disease"/>
<question>
<linkId value="2.1.2.1"/>
<text value="Disease or Condition"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA10564-5"/>
<display value="-- Asthma"/>
</valueCoding>
</answer>
</question>
<question>
<linkId value="2.1.2.2"/>
<text value="Age at Diagnosis"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA10395-4"/>
<display value="Childhood"/>
</valueCoding>
</answer>
</question>
</group>
</group>
<group>
<linkId value="2.1"/>
<group>
<linkId value="2.1.1"/>
<question>
<linkId value="2.1.1.1"/>
<text value="Relationship to you"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA10411-9"/>
<display value="Maternal Cousin"/>
</valueCoding>
</answer>
</question>
<question>
<linkId value="2.1.1.2"/>
<text value="Name"/>
<answer>
<valueString value="Karren"/>
</answer>
</question>
<question>
<linkId value="2.1.1.3"/>
<text value="Gender"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA3-6"/>
<display value="Female"/>
</valueCoding>
</answer>
</question>
<question>
<linkId value="2.1.1.4"/>
<text value="Living?"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA33-6"/>
<display value="Yes"/>
</valueCoding>
<group>
<linkId value="2.1.1.4.2"/>
<question>
<linkId value="2.1.1.4.2.2"/>
<text value="Age"/>
<answer>
<valueDecimal value="30"/>
</answer>
</question>
</group>
</answer>
</question>
<question>
<linkId value="2.1.1.5"/>
<text value="Was this person born a twin?"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA32-8"/>
<display value="No"/>
</valueCoding>
</answer>
</question>
<question>
<linkId value="2.1.1.6"/>
<text value="Was this person adopted?"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA32-8"/>
<display value="No"/>
</valueCoding>
</answer>
</question>
</group>
<group>
<linkId value="2.1.2"/>
<title value="This family member's history of disease"/>
<question>
<linkId value="2.1.2.1"/>
<text value="Disease or Condition"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA10536-3"/>
<display value="-- Breast Cancer"/>
</valueCoding>
</answer>
</question>
<question>
<linkId value="2.1.2.2"/>
<text value="Age at Diagnosis"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA10397-0"/>
<display value="30-39"/>
</valueCoding>
</answer>
</question>
</group>
</group>
<group>
<linkId value="2.1"/>
<group>
<linkId value="2.1.1"/>
<question>
<linkId value="2.1.1.1"/>
<text value="Relationship to you"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA10411-9"/>
<display value="Maternal Cousin"/>
</valueCoding>
</answer>
</question>
<question>
<linkId value="2.1.1.2"/>
<text value="Name"/>
<answer>
<valueString value="Mary"/>
</answer>
</question>
<question>
<linkId value="2.1.1.3"/>
<text value="Gender"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA3-6"/>
<display value="Female"/>
</valueCoding>
</answer>
</question>
<question>
<linkId value="2.1.1.4"/>
<text value="Living?"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA33-6"/>
<display value="Yes"/>
</valueCoding>
<group>
<linkId value="2.1.1.4.2"/>
<question>
<linkId value="2.1.1.4.2.2"/>
<text value="Age"/>
<answer>
<valueDecimal value="31"/>
</answer>
</question>
</group>
</answer>
</question>
<question>
<linkId value="2.1.1.5"/>
<text value="Was this person born a twin?"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA32-8"/>
<display value="No"/>
</valueCoding>
</answer>
</question>
<question>
<linkId value="2.1.1.6"/>
<text value="Was this person adopted?"/>
<answer>
<valueCoding>
<system value="http://loinc.org"/>
<code value="LA32-8"/>
<display value="No"/>
</valueCoding>
</answer>
</question>
</group>
</group>
</group>
</group>
</QuestionnaireResponse>
</resource>
</parameter>
</Parameters>
Generates an HTML page as a Binary 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 and only one of the identifier, questionnaire or questionnaireRef 'in' parameters must be provided. If called at the instance level, these parameters will be ignored.
The response will contain a Binary instance containing an HTML page for filling in and submitting the specified Questionnaire and/or an OperationOutcome resource with errors or warnings.
The generated HTML form 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 HTML form 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/StructureDefinition/questionnaire-deReference extension or through use of the ConceptMap resource.
Regardless of the mechanism used to link the questions in a questionnaire to a "known" mappable 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 convertible, etc.
Formal Definition (as a OperationDefinition).
URL: [base]/Questionnaire/$populatehtml
URL: [base]/Questionnaire/[id]/$populatehtml
| In Parameters: | |||||
| Name | Cardinality | Type | Binding | Profile | Documentation |
| identifier | 0..1 | uri | A logical questionnaire identifier (i.e. ''Questionnaire.identifier''). The server must know the questionnaire or be able to retrieve it from other known repositories. | ||
| questionnaire | 0..1 | Questionnaire | The Questionnaire is provided directly as part of the request. Servers may choose not to accept questionnaires in this fashion | ||
| questionnaireRef | 0..1 | Reference(Questionnaire) | The Questionnaire is provided as a resource reference. Servers may choose not to accept questionnaires in this fashion or may fail if they cannot resolve or access the referenced questionnaire. | ||
| content | 0..* | Reference(Any) | Resources containing information to be used to help populate the generated HTML form. 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.) | ||
| local | 0..1 | boolean | 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. | ||
| Out Parameters: | |||||
| Name | Cardinality | Type | Binding | Profile | Documentation |
| form | 1..1 | uri | The URL for the web form that supports capturing the information defined by questionnaire, possibly partially (or fully)-populated with a set of answers for the specified Questionnaire | ||
| issues | 0..1 | OperationOutcome | A list of hints and warnings about problems encountered while populating the questionnaire. These might be show to the user as an advisory note. Note: if the questionnaire cannot be populated at all, then the operation should fail, and an OperationOutcome is returned directly with the failure, rather than using this parameter | ||
While it is theoretically possible for an HTML form to be completely auto-populated and submitted without human review, the intention of this transaction is merely to reduce redundant data entry. The HTML form 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 respondent, 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. The generated HTML form is responsible for pruning 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 "trusted" system and appropriate agreements are in place to protect the confidentiality of any information shared with that system.
Request:
POST [base]/Questionnnaire/$populatehtml
[other headers]
<Parameters xmlns="http://hl7.org/fhir" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://hl7.org/fhir ../../schema/parameters.xsd">
<parameter>
<name value="questionnaireRef"/>
<valueReference>
<reference value="http://hl7.org/fhir/Questionnaire/questionnaire-sdc-profile-example-ussg-fht"/>
</valueReference>
</parameter>
<parameter>
<name value="local"/>
<valueBoolean value="true"/>
</parameter>
</Parameters>
Response:
HTTP/1.1 200 OK
[other headers]
<?xml version="1.0" encoding="UTF-8"?>
<Parameters xmlns="http://hl7.org/fhir">
<parameter>
<name value="questionnaire"/>
<resource>
<Binary>
<contentType value="text/html"/>
<content><!--Base-64 encoded HTML form goes here--></content>
</Binary>
</resource>
</parameter>
</Parameters>
Generates a link to a web page to be used to answer a specified Questionnaire. The form at the specified location will be pre-filled with 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 and only one of the identifier, questionnaire or questionnaireRef 'in' parameters must be provided. If called at the instance level, these parameters will be ignored.
The response will contain a url for the web page to direct the user to. The page will allow the user to complete/verify the questionnaire answers and to submit the form.
The specified page 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 page 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/StructureDefinition/questionnaire-deReference extension or through use of the ConceptMap resource.
Regardless of the mechanism used to link the questions in a questionnaire to a "known" mappable 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 convertible, etc.
Formal Definition (as a OperationDefinition).
URL: [base]/Questionnaire/$populatelink
URL: [base]/Questionnaire/[id]/$populatelink
| In Parameters: | |||||
| Name | Cardinality | Type | Binding | Profile | Documentation |
| identifier | 0..1 | uri | A logical questionnaire identifier (i.e. ''Questionnaire.identifier''). The server must know the questionnaire or be able to retrieve it from other known repositories. | ||
| questionnaire | 0..1 | Questionnaire | The Questionnaire is provided directly as part of the request. Servers may choose not to accept questionnaires in this fashion | ||
| questionnaireRef | 0..1 | Reference(Questionnaire) | The Questionnaire is provided as a resource reference. Servers may choose not to accept questionnaires in this fashion or may fail if they cannot resolve or access the referenced questionnaire. | ||
| content | 0..* | Reference(Any) | Resources containing information to be used to help populate the generated HTML form. 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.) | ||
| local | 0..1 | boolean | 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. | ||
| Out Parameters: | |||||
| Name | Cardinality | Type | Binding | Profile | Documentation |
| link | 1..1 | Binary | The generated HTML page that supports capturing the information defined by questionnaire, possibly partially (or fully)-populated with a set of answers for the specified Questionnaire | ||
| issues | 0..1 | OperationOutcome | A list of hints and warnings about problems encountered while populating the questionnaire. These might be show to the user as an advisory note. Note: if the questionnaire cannot be populated at all, then the operation should fail, and an OperationOutcome is returned directly with the failure, rather than using this parameter | ||
While it is theoretically possible for the questionnaire response to be completely auto-populated and submitted without human review, the intention of this transaction is merely to reduce redundant data entry. The web page 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 respondent, 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. The web form is responsible for pruning 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 "trusted" system and appropriate agreements are in place to protect the confidentiality of any information shared with that system.
Request:
POST [base]/Questionnnaire/$populatelink
[other headers]
<Parameters xmlns="http://hl7.org/fhir" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://hl7.org/fhir ../../schema/parameters.xsd">
<parameter>
<name value="questionnaireRef"/>
<valueReference>
<reference value="http://hl7.org/fhir/Questionnaire/questionnaire-sdc-profile-example-ussg-fht"/>
</valueReference>
</parameter>
<parameter>
<name value="local"/>
<valueBoolean value="true"/>
</parameter>
</Parameters>
Response:
HTTP/1.1 200 OK
[other headers]
<?xml version="1.0" encoding="UTF-8"?>
<Parameters xmlns="http://hl7.org/fhir">
<parameter>
<name value="link"/>
<valueUri value="https://example.org/form/123457890a.asp"/>
</parameter>
</Parameters>
© HL7.org 2011+. FHIR STU3 Ballot (v1.6.0-9663) generated on Thu, Aug 11, 2016 17:07+1000. QA Page
Links: Search |
Version History |
Table of Contents |
Compare to DSTU2 |
|
Propose a change