SampleDocumentOID

From IHE Wiki
Jump to: navigation, search

Development Only

The PCC Wiki Content is used only for development of IHE PCC Content. The Normative content of the PCC Technical Framework and the current supplements can be found at http://www.ihe.net/Technical_Framework/index.cfm#PCC

Draft.gif Sample Document Specification SampleDocumentOID

Sample Document has one required section, and one entry that is required if known





Specification
Data Element Name Opt Template ID
Sample Section
Comment on section
R SampleSectionOID
Sample Entry
Comment on entry
R2 SampleEntryOID

Conformance

CDA Release 2.0 documents that conform to the requirements of this content module shall indicate their conformance by the inclusion of the appropriate <templateId> elements in the header of the document. This is shown in the sample document below.

Sample Sample Document Document
<ClinicalDocument xmlns='urn:hl7-org:v3'>
  <typeId extension="POCD_HD000040" root="2.16.840.1.113883.1.3"/>
  <templateId root='SampleDocumentOID'/>
  <id root=' ' extension=' '/>
  <code code=' ' displayName=' '
    codeSystem='2.16.840.1.113883.6.1' codeSystemName='LOINC'/>
  <title>Sample Document</title>
  <effectiveTime value='20200702012005'/>
  <confidentialityCode code='N' displayName='Normal' 
    codeSystem='2.16.840.1.113883.5.25' codeSystemName='Confidentiality' />
  <languageCode code='en-US'/>     
     :
  <component><structuredBody>
    <component>
      <section>
        <templateId root='SampleSectionOID'/>
        <!-- Required Sample Section Section content -->
      </section>
    </component>
    </structuredBody></component> </ClinicalDocument>
Schematron
<pattern name='Template_SampleDocumentOID'>
 <rule context='*[cda:templateId/@root="SampleDocumentOID"]'>
   <!-- Verify that the template id is used on the appropriate type of object -->
   <assert test='../cda:ClinicalDocument'>
     Error: The Sample Document can only be used on Clinical Documents.
   </assert> 
   <!-- Verify the document type code -->
   <assert test='cda:code[@code = "{{{LOINC}}}"]'>
     Error: The document type code of a Sample Document must be {{{LOINC}}}
   </assert>
   <assert test='cda:code[@codeSystem = "2.16.840.1.113883.6.1"]'>
     Error: The document type code must come from the LOINC code 
     system (2.16.840.1.113883.6.1).
   </assert> 
   <assert test='.//cda:templateId[@root = "SampleSectionOID"]'> 
     <!-- Verify that all required data elements are present -->
     Error: The Sample Document Document must contain a(n) Sample Section Section.
     See http://wiki.ihe.net/index.php?title=SampleDocumentOID 
   </assert> 
   <assert test='.//cda:templateId[@root = "SampleEntryOID"]'> 
     <!-- Alert on any missing required if known elements -->
     Warning: The  Sample Document Document should contain a(n) Sample Entry Entry.
     See http://wiki.ihe.net/index.php?title=SampleDocumentOID 
   </assert> 
 </rule>
</pattern>

}}

Instructions

This is a sample document demonstrating the use of the Template:CDA Document, Template:CDA Document Code and Template:CDA Document Content templates. To create a new document specification for an IHE PCC Profile, you simply create a new page, and enter the following wiki text and save it:

{{subst:Sample Document}}

This will include this Sample Document page. Change the content so that everywhere "Sample Document" appears, it now contains the name of the page you just created. Then update the rows appearing in the {{CDA Document Code| and {{CDA Document Content| rows to list the sections or entries that should appear in the document.

Update the description, and you have now created a CDA Document specification for the profile.

Click on the links within the table after you are finished editing the CDA Document Specification specification to begin work on each of the section or entry specifications in your folder. See Sample Section for an example section from which to work.