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

Difference between revisions of "CDA Example Task Force"

From HL7Wiki
Jump to navigation Jump to search
Line 121: Line 121:
 
*[https://github.com/LisaRNelson/LRN_HL7_CDA_Examples/blob/master/Snippet-No%20Medications%20Taken%2020140227.xml Patient with no medications intended to be taken - current medication list has no medications.]  
 
*[https://github.com/LisaRNelson/LRN_HL7_CDA_Examples/blob/master/Snippet-No%20Medications%20Taken%2020140227.xml Patient with no medications intended to be taken - current medication list has no medications.]  
 
*[https://github.com/brettmarquard/HL7-C-CDA-Task-Force-Examples/blob/master/CCD_Transition_of_Care_Ambulatory_Complete_No_Known_Medications.xml Full alternative no known medications which validates]
 
*[https://github.com/brettmarquard/HL7-C-CDA-Task-Force-Examples/blob/master/CCD_Transition_of_Care_Ambulatory_Complete_No_Known_Medications.xml Full alternative no known medications which validates]
** Not Yet Approved
+
** Approved by: Not Yet Approved
 
** TemplateId(s) illustrated: Medication Activity where moodCode="INT" 2.16.840.1.113883.10.20.22.4.16
 
** TemplateId(s) illustrated: Medication Activity where moodCode="INT" 2.16.840.1.113883.10.20.22.4.16
 
** CDA Implementation Guide where template(s) is(are) defined: C-CDA R1.1
 
** CDA Implementation Guide where template(s) is(are) defined: C-CDA R1.1

Revision as of 14:18, 27 February 2014

SDWG formed the CDA template example task force to collect and share member submitted samples. The committee is currently hosting bi-weekly meetings on Thursdays from 12-1 PM Eastern. Subscribe to the SDWG listserv for more information.

Formatting of CDA Template Samples

PROTOTYPIC TEMPLATE

  • Meaningful template example name (hyperlinked)
    • Approved by: (list all approving bodies, including approval date)
    • TemplateId(s) illustrated: (include hyperlinks where possible)
    • CDA Implementation Guide where template(s) is(are) defined: (include hyperlinks where possible)
    • Reference to full CDA sample: Full example in validated document (hyperlinked)
    • Custodian: (who is the steward of the referenced sample? include email address)
    • Validation location: (list of all validators tested against)
    • Comments: (free text comments about the example)


Examples - Organized by Section

ALLERGIES AND ADVERSE REACTIONS


GENERAL PATTERN - NO INFORMATION


IMMUNIZATIONS


MEDICATIONS






PROBLEMS


RESULTS






KNOWN BAD EXAMPLES

  • Future bad examples will go here.

FEEDBACK AND AWAITING RESPONSE

  • Result with less than a specified value (via GitHub)- Awaiting review from Patrick Lloyd with OO



COMMUNITY REQUESTS FOR EXAMPLES (include name, email)

  • I would like an example of a preliminary lab result (John Doe, JohnDoe@email.com)
  • The SMART C-CDA Collaborative generated a list of approximately 50 requested samples here. See the section noted as "Annotated Examples." For more information on the SMART C-CDA Collaborative please visit here. (Ashley Swain, ashley.swain@lantanagroup.com, John D'Amore, jdamore@diameterhealth.com, Josh Mandel, jmandel@gmail.com)



DRAFT MATERIAL - PLEASE DON'T DELETE

How to Setup an XML example from GitHub

  • Sign up for GitHub account. It's free and quick
  • Once you've got an account, you will be able to fork repositories and comment on examples through the website
  • To post and manage examples, you will likely want to install a graphical user interface for GitHub. Here's where you can download: For Windows or For Mac
  • Once you've got the application installed, there are a few steps:
    • Click the "create" button to make a repository where you would like to upload/update to GitHub
    • Once you've created, the repository will exist online and on your local machine
    • On your local machine, place in new or revised files in the local folder (this will generally be under Documents/GitHub). It's good practice to include a text file named README.md, which appears online when people browse your repository. This is a good place to explain what you're working on.
    • Once you've made the edits (or new files) you want to post to GitHub, "commit" the sample entering a description and then hit the "sync" button to upload
    • At this point the changes and new files are posted online publicly
  • For an example GitHub repository with C-CDA samples, check out this one from Children's Hospital Boston


  • Add instructions for how to upload examples (to github, to other sites)
    • Add examples (to site of your choosing)
    • Add link and metadata too
  • enumerated lists
    • validators
    • approving bodies
      • SDWG
      • Infoway
      • NHS


HOW TO PREPARE A SAMPLE FOR APPROVAL BY SDWG

Observing these guidelines will streamline the process for all involved.

  • Include XML comments that will:
    • Make assumptions explicit
    • Annotate each lines
    • Highlight choices and key decisions that were made
  • Confirm statusCode/moodCode/effectiveTime are in agreement
  • Snippet should be in the context of a section
  • Confirm narrative to match entries - and content is linked
  • Does final sample name accurately reflect the final sample
  • Add disclaimer at the top of every sample: SAMPLE DEVELOPED BY HL7 SDWG SAMPLES TASK FORCE - PLEASE SEE http://wiki.hl7.org/index.php?title=CDA_Example_Task_Force FOR ADDITIONAL DETAILS
  • Copy and paste the template below, and complete for your sample
  • Allergy to Substance X
    • Approved by: SDWG (Oct 31, 2013); NHS (Oct 31, 2013)
    • TemplateId(s) illustrated: 2.16.840.1.113883.10.20.22.4.30; 2.16.840.1.113883.10.20.22.4.7
    • CDA Implementation Guide where template(s) is(are) defined: C-CDA R2
    • Reference to full CDA sample: N/A
    • Custodian: John Doe (John.Doe@email.com)
    • Validation location: validator.com
    • Comments: This is the best example EVER!