This wiki has undergone a migration to Confluence found Here
<meta name="googlebot" content="noindex">

Difference between revisions of "201605 FHIR Structured Data Capture"

From HL7Wiki
Jump to navigation Jump to search
(Created page with "{{subst::Template for FHIR Connectathon Track Proposals}}")
 
 
(8 intermediate revisions by the same user not shown)
Line 2: Line 2:
 
[[Category:201605_FHIR_Connectathon_Track_Proposals|May 2016 Proposals]]
 
[[Category:201605_FHIR_Connectathon_Track_Proposals|May 2016 Proposals]]
 
__NOTOC__
 
__NOTOC__
−
=Track Name=
+
=Structured Data Capture=
  
 
==Submitting WG/Project/Implementer Group==
 
==Submitting WG/Project/Implementer Group==
−
<!-- Who is asking for this track? -->
+
Orders and Observations (O&O)
  
 
==Justification==
 
==Justification==
−
<!--Why is this an important track to include in the connectathon - include implementer need, impact on ballot, FMM readiness of the resources, etc. -->
+
 
 +
The Structured Data Capture (SDC) FHIR profile has undergone testing in virtual connectathons and at the FHIR Connectathons in October 2015 and January 2016. This connectathon is an opportunity to progress the profile and further familiarize the implementer community with the profile.
  
 
==Proposed Track Lead==
 
==Proposed Track Lead==
−
<!-- Name, email and Skype id of individual who will coordinate the track at the connectathon -->
+
Lloyd McKenzie
−
See [[Connectathon_Track_Lead_Responsibilities]]
+
:Skype ID: lmckenzi
 +
:Email: lmckenzie@gevityinc.com
  
 
==Expected participants==
 
==Expected participants==
 
<!-- List of the individuals and/or organizations that have indicated a desire to attend the connectathon and implement this track -->
 
<!-- List of the individuals and/or organizations that have indicated a desire to attend the connectathon and implement this track -->
 +
 +
Expected participants include individuals from the EHR vendor community, payers, researchers and health care provider organizations.
  
 
==Roles==
 
==Roles==
 
<!-- Roles are sets of functionality (generally defined by a Conformance resource) that a single system can take on -->
 
<!-- Roles are sets of functionality (generally defined by a Conformance resource) that a single system can take on -->
−
===Role 1 Name===
+
===Form Designer===
−
<!-- Provide a description of the capabilities this role will have within the connectathon -->
+
 
 +
Creates, submits, and revises SDC Questionnaires
 +
 
 +
===Form Filler===
 +
 
 +
Captures user form input
 +
 
 +
===Form Manager===
 +
Serves as the repository for form definitions and may also perform pre-population
 +
 
 +
===Form Receiver===
 +
Serves as a repository for completed forms
 +
 
 +
===Data Element Registry===
 +
Serves as a repository for data elements
  
 
==Scenarios==
 
==Scenarios==
 
<!-- What will be the actions performed by participants? -->
 
<!-- What will be the actions performed by participants? -->
  
−
===Scenario Step 1 Name===
+
===Forms===
−
:Action: <!--Who does what?  (Use the role names listed above when referring to the participants -->
+
Objective: Test the form creation language defined by the SDC specification
−
:Precondition: <!-- What setup is required prior to executing this step? -->
+
 
−
:Success Criteria: <!-- How will the participants know if the test was successful? -->
+
1. Create an SDC-conformant form
−
:Bonus point: <!-- Any additional complexity to make the scenario more challenging -->
+
:Action: SDC Form Designed creates a new Questionnaire instance that is conformant with the SC Questionnaire profile
 +
:Precondition: none
 +
:Success Criteria: Form passes validation against the Questionnaire schema and the Questionnaire schematron, and is identified as valid against the SDC Questionnaire profile by the FHIR profile validation tool
 +
:Bonus Point: Define a Questionnaire that includes conditional display
 +
:Bonus Point: Define a Questionnaire that includes special rendering/style requirements
 +
:Bonus Point: Define contained or independently persisted value sets
 +
 
 +
2. Submit form
 +
:Action: SDC Form Designer submits Questionnaire to an SDC Form Manager for storage
 +
:Precondition: Questionnaire has been defined, Form Designer knows base URL for form manager
 +
:Success Criteria: Questionnaire is sorted on Form Manager Server
 +
 
 +
3. Query forms
 +
:Action: SDC Form Filler or SDC Form Designer searchers an SDC Form Manager for Questionnaires using one or more of the SDC-supported search criteria
 +
:Precondition: Questionnaires are available on the SDC Form Manager
 +
:Success Criteria: Set of matching Questionnaires is returned
 +
:Bonus Point: Make use of sorting and paging parameters
 +
 
 +
4. Update form
 +
:Action: the SDC Form Designer revises an existing Questionnaire previously stored in the SDC Form Manager and submits an update
 +
:Precondition: A version of the Questionnaire exists on the SDC Form Manager and the Form Designer
 +
:Success Criteria: A new version of the Questionnaire exists on the SDC Form Manager. The original version remains accessible via a history query
 +
:Bonus Point: Hand collision detection using e-tags
 +
 
 +
5. Data elements
 +
:Action: the SDC Form Designer allows the form author to search for an appropriate data element on an SDC Data Element Registry and link to that data element from a question before storing the Questionnaire
 +
:Precondition: A set of DataElements are available for query
 +
:Success Criteria: A Questionnaire exists on an SDC Form Manager having questions linked to DataElements
 +
 
 +
===Completed Forms===
 +
Objective: Test the ability to render, navigate, and capture data based on forms defined using SDC syntax
 +
 
 +
1. Render SDC form for input
 +
:Action: SDC Form Filler converts the definition of an SDC Questionnaire into a user interface that can solicit data from a human
 +
:Precondition: SDC Questionnaire has been retrieved
 +
:Success Criteria: Human can fill out the form populating the questions and groups within the Questionnaire
 +
:Bonus Point: Enforce conditional display while the user populates the Questionnaire
 +
:Bonus Point: Render the Questionnaire taking into account the special rendering/style requirements
 +
:Bonus Point: Provider appropriate interfaces to select from a referenced ValueSet
 +
 
 +
2. Record answers
 +
:Action: SDC Form Filler submits completed QuestionnaireAnswers to an SDC Form Receiver
 +
:Precondition: SDC Questionnaire has been received and populated
 +
:Success Criteria: QuestionnaireAnswers instance is available for query on the SDC Form Filler
 +
:Bonus Point: Store a partially-completed QuestionnaireAnswers
 +
:Bonus Point: Validate that the QuestionnaireAnswers instance is valid against the Questionnaire and referenced ValueSets
 +
 
 +
3. Update answers
 +
:Action: SDC Form Filler retrieves QuestionnaireAnswers instance and associated Questionnaire and displays the Questionnaire with data populated for update
 +
:Precondition: SDC Questionnaire and QuestionnaireAnswers instances are available for query
 +
:Success Criteria: Revised QuestionnaireAnswers instance is stored on SDC Form Receiver reflecting user's edits
 +
:Bonus Point: Ensure conditional display rules are enforced based on already populated data
 +
 
 +
===Form Population===
 +
Objective: Test ability to pre-populate/auto-populate forms
 +
 
 +
1. Pre-populate a form
 +
:Action: SDC Form Filler invokes the $populate operation on an SDC Form Manager passing a Questionnaire id and a C-CDA instance
 +
:Precondition:SDC Form Filler has retrieved an SDC Form referencing DataElements which contain xpath mappings to a C-CDA document where the specified paths exist in the test C-CDA instance
 +
:Success Criteria: The SDC Form Filler receives a QuestionnaireAnswers instance with the matching questions populated
 +
:Bonus Point: SDC Form Filler renders content appropriately following conditional display values - including hiding the populated elements that aren't allowed to be displayed
 +
 
 +
===Data Elements===
 +
Objective: Test SDC curation requirements
 +
 
 +
1. Record Data Element
 +
:Action: SDC Data Element Curator records a new data element in an SDC Data Element Registry
 +
:Precondition: none
 +
:Success Criteria: The data element is now available in the SDC Data Element Registry for query
 +
:Bonus Point: Create a complex data type (one with components)
  
−
<!-- Provide a description of each task -->
+
2. Query Data Elements
 +
:Action: SDC Data Element Curator searches an SDC Data Element Registry for DataElements matching a set of search criteria
 +
:Precondition: The SDC Data Element Registry has data elements available for query
 +
:Success Criteria: The SDC Data Element Curator receives a set of matching data elements
 +
:Bonus Point: Make use of paging and sorting parameters
  
−
==TestScript(s)==
+
3. Update Data Element
−
<!-- Optional (for initial proposal): Provide links to the TestScript instance(s) that define the behavior to be tested. 
+
:Action: SDC Data Element Curator makes revisions to an existing DataElement in an SDC Data Element Registry
−
These should be committed to SVN under trunk/connectathons/[connectathon]
+
Precondition: DataElement exists in SDC Data Element Registry
−
-->
+
:Success Criteria: Revision version is posted to the registry

Latest revision as of 17:55, 27 January 2016


Structured Data Capture

Submitting WG/Project/Implementer Group

Orders and Observations (O&O)

Justification

The Structured Data Capture (SDC) FHIR profile has undergone testing in virtual connectathons and at the FHIR Connectathons in October 2015 and January 2016. This connectathon is an opportunity to progress the profile and further familiarize the implementer community with the profile.

Proposed Track Lead

Lloyd McKenzie

Skype ID: lmckenzi
Email: lmckenzie@gevityinc.com

Expected participants

Expected participants include individuals from the EHR vendor community, payers, researchers and health care provider organizations.

Roles

Form Designer

Creates, submits, and revises SDC Questionnaires

Form Filler

Captures user form input

Form Manager

Serves as the repository for form definitions and may also perform pre-population

Form Receiver

Serves as a repository for completed forms

Data Element Registry

Serves as a repository for data elements

Scenarios

Forms

Objective: Test the form creation language defined by the SDC specification

1. Create an SDC-conformant form

Action: SDC Form Designed creates a new Questionnaire instance that is conformant with the SC Questionnaire profile
Precondition: none
Success Criteria: Form passes validation against the Questionnaire schema and the Questionnaire schematron, and is identified as valid against the SDC Questionnaire profile by the FHIR profile validation tool
Bonus Point: Define a Questionnaire that includes conditional display
Bonus Point: Define a Questionnaire that includes special rendering/style requirements
Bonus Point: Define contained or independently persisted value sets

2. Submit form

Action: SDC Form Designer submits Questionnaire to an SDC Form Manager for storage
Precondition: Questionnaire has been defined, Form Designer knows base URL for form manager
Success Criteria: Questionnaire is sorted on Form Manager Server

3. Query forms

Action: SDC Form Filler or SDC Form Designer searchers an SDC Form Manager for Questionnaires using one or more of the SDC-supported search criteria
Precondition: Questionnaires are available on the SDC Form Manager
Success Criteria: Set of matching Questionnaires is returned
Bonus Point: Make use of sorting and paging parameters

4. Update form

Action: the SDC Form Designer revises an existing Questionnaire previously stored in the SDC Form Manager and submits an update
Precondition: A version of the Questionnaire exists on the SDC Form Manager and the Form Designer
Success Criteria: A new version of the Questionnaire exists on the SDC Form Manager. The original version remains accessible via a history query
Bonus Point: Hand collision detection using e-tags

5. Data elements

Action: the SDC Form Designer allows the form author to search for an appropriate data element on an SDC Data Element Registry and link to that data element from a question before storing the Questionnaire
Precondition: A set of DataElements are available for query
Success Criteria: A Questionnaire exists on an SDC Form Manager having questions linked to DataElements

Completed Forms

Objective: Test the ability to render, navigate, and capture data based on forms defined using SDC syntax

1. Render SDC form for input

Action: SDC Form Filler converts the definition of an SDC Questionnaire into a user interface that can solicit data from a human
Precondition: SDC Questionnaire has been retrieved
Success Criteria: Human can fill out the form populating the questions and groups within the Questionnaire
Bonus Point: Enforce conditional display while the user populates the Questionnaire
Bonus Point: Render the Questionnaire taking into account the special rendering/style requirements
Bonus Point: Provider appropriate interfaces to select from a referenced ValueSet

2. Record answers

Action: SDC Form Filler submits completed QuestionnaireAnswers to an SDC Form Receiver
Precondition: SDC Questionnaire has been received and populated
Success Criteria: QuestionnaireAnswers instance is available for query on the SDC Form Filler
Bonus Point: Store a partially-completed QuestionnaireAnswers
Bonus Point: Validate that the QuestionnaireAnswers instance is valid against the Questionnaire and referenced ValueSets

3. Update answers

Action: SDC Form Filler retrieves QuestionnaireAnswers instance and associated Questionnaire and displays the Questionnaire with data populated for update
Precondition: SDC Questionnaire and QuestionnaireAnswers instances are available for query
Success Criteria: Revised QuestionnaireAnswers instance is stored on SDC Form Receiver reflecting user's edits
Bonus Point: Ensure conditional display rules are enforced based on already populated data

Form Population

Objective: Test ability to pre-populate/auto-populate forms

1. Pre-populate a form

Action: SDC Form Filler invokes the $populate operation on an SDC Form Manager passing a Questionnaire id and a C-CDA instance
Precondition:SDC Form Filler has retrieved an SDC Form referencing DataElements which contain xpath mappings to a C-CDA document where the specified paths exist in the test C-CDA instance
Success Criteria: The SDC Form Filler receives a QuestionnaireAnswers instance with the matching questions populated
Bonus Point: SDC Form Filler renders content appropriately following conditional display values - including hiding the populated elements that aren't allowed to be displayed

Data Elements

Objective: Test SDC curation requirements

1. Record Data Element

Action: SDC Data Element Curator records a new data element in an SDC Data Element Registry
Precondition: none
Success Criteria: The data element is now available in the SDC Data Element Registry for query
Bonus Point: Create a complex data type (one with components)

2. Query Data Elements

Action: SDC Data Element Curator searches an SDC Data Element Registry for DataElements matching a set of search criteria
Precondition: The SDC Data Element Registry has data elements available for query
Success Criteria: The SDC Data Element Curator receives a set of matching data elements
Bonus Point: Make use of paging and sorting parameters

3. Update Data Element

Action: SDC Data Element Curator makes revisions to an existing DataElement in an SDC Data Element Registry

Precondition: DataElement exists in SDC Data Element Registry

Success Criteria: Revision version is posted to the registry
Retrieved from "https://wiki.hl7.org/w/index.php?title=201605_FHIR_Structured_Data_Capture&oldid=114201"