Conformance-sdc-de-curator.xml

SDC Data Elements author/maintenance system (id = "conformance-sdc-de-curator")

Raw XML

<Conformance xmlns="http://hl7.org/fhir">
  <id value="conformance-sdc-de-curator"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
         
      <h2>SDC Data Element Curator</h2>
         
      <p>(Requirements Definition)</p>
         
      <p>Published: 2014-07-06 (draft)</p>
         
      <p>Published by: 
        <b>U.S. Office of the National Coordinator (ONC)</b>
         
      </p>
         
      <p>This profile defines the expected capabilities of the 
        <i>SDC Data Element Curator</i> role when conforming to the S&amp;I Framework's 
        <a href="sdc.html">Structured Data Capture FHIR Data Element Exchange implementation guide</a>.  This role is responsible for defining and updating data elements stored in a repository.
      </p>
         
      <h2>General</h2>
         
      <table>
            
        <tbody>
               
          <tr>
                  
            <th>FHIR Version:</th>
                  
            <td>1.0.0</td>
               
          </tr>
               
          <tr>
                  
            <th>Supported formats:</th>
                  
            <td>xml, json</td>
               
          </tr>
            
        </tbody>
         
      </table>
         
      <h2>REST  behavior</h2>
         
      <p>The primary focus of the curator is the definition and maintenance of 
        <a href="dataelement.html">DataElement</a>s.  However, 
        <a href="valueset.html">ValueSet</a>s must also be supported to allow definition of coded data elements.  Some data elements
         will choose to maintain value sets as 'contained' resources, meaning the value set exists
         only in the context of the data element and cannot be referenced or maintained without
         also updating the data element.  However, systems should support value set re-use across
         data elements.  (Version-specific referencing can be used to avoid value sets from changing
         independent of the referencing 
        <a href="questionnaire.html">Questionnaire</a>.)
      </p>
         
      <p>
            
        <b>Security:</b>
         
      </p>
         
      <p>Implementations must meet the general security requirements documented in the 
        <a href="sdc-security.html">SDC implementation guide</a>.
      </p>
         
      <h3>Summary</h3>
         
      <table class="grid">
            
        <thead>
               
          <tr>
                  
            <th>Resource</th>
                  
            <th>Search</th>
                  
            <th>Read</th>
                  
            <th>Read Version</th>
                  
            <th>Instance History</th>
                  
            <th>Resource History</th>
                  
            <th>Validate</th>
                  
            <th>Create</th>
                  
            <th>Update</th>
                  
            <th>Delete</th>
               
          </tr>
            
        </thead>
            
        <tbody>
               
          <tr>
                  
            <th>DataElement</th>
                  
            <td>
                     
              <a href="#DataElement-search-type" title="Allows a user to search for existing data elements">SHALL</a>
                  
            </td>
                  
            <td>
                     
              <a href="#DataElement-read" title="Allows retrieval of a specific known data element">SHALL</a>
                  
            </td>
                  
            <td>
                     
              <a href="#DataElement-vread" title="Allows retrieval of a specific version of a data element">SHALL</a>
                  
            </td>
                  
            <td>
                     
              <a href="#DataElement-history-instance" title="Allows review of changes to a data element over time">SHALL</a>
                  
            </td>
                  
            <td/>
                  
            <td>
                     
              <a href="#DataElement-validate" title="Allows a client to verify whether a particular new data element or revision of an existing
               data element would be accepted based on validation and other business rules.  Useful for
               some workflows">SHOULD</a>
                  
            </td>
                  
            <td>
                     
              <a href="#DataElement-create" title="Allows defining a new data element.  Repositories requiring curation of submitted data
               elements may require all new data elements to have a status of 'draft'.">SHALL</a>
                  
            </td>
                  
            <td>
                     
              <a href="#DataElement-update" title="Allows maintaining data elements, such as adding additional mappings, display names, etc.
                Servers may choose to prohibit certain types of edits, instead requiring the creation
               of a new data element (and potentially the retiring of the existing data element).  Servers
               may also limit who can change particular data elements.">SHALL</a>
                  
            </td>
                  
            <td>
                     
              <a href="#DataElement-delete" title="Allows removal of an existing data element.  Servers may choose to not support deletions
               or may limit deletions to data elements meeting certain requirements.  E.g. only elements
               with a status of draft or only elements that have been retired for at least two years,
               etc.">MAY</a>
                  
            </td>
               
          </tr>
               
          <tr>
                  
            <th>ValueSet</th>
                  
            <td>
                     
              <a href="#ValueSet-search-type" title="Allows discovery of existing value sets for use in authoring data elements">SHALL</a>
                  
            </td>
                  
            <td>
                     
              <a href="#ValueSet-read" title="Allows retrieval of a specific value set referenced within a data element">SHALL</a>
                  
            </td>
                  
            <td>
                     
              <a href="#ValueSet-vread" title="Allows retrieval of a historical version of a value set as referenced within a data element">SHALL</a>
                  
            </td>
                  
            <td>
                     
              <a href="#ValueSet-history-instance" title="Allows review of changes to a value set over time">SHALL</a>
                  
            </td>
                  
            <td/>
                  
            <td>
                     
              <a href="#ValueSet-validate" title="Allows verification that a value set is valid prior to submission - useful for some workflows.">SHOULD</a>
                  
            </td>
                  
            <td>
                     
              <a href="#ValueSet-create" title="Allows definition of a new value set used by one or more data elements">SHALL</a>
                  
            </td>
                  
            <td>
                     
              <a href="#ValueSet-update" title="Allows existing value sets referenced by one or more data elements to be maintained">SHALL</a>
                  
            </td>
                  
            <td>
                     
              <a href="#ValueSet-delete" title="Not all servers will support deletion of value sets.  Status change to 'retired' will
               be more typical, though deletion of draft value sets may keep repositories cleaner.">MAY</a>
                  
            </td>
               
          </tr>
            
        </tbody>
         
      </table>
         
      <br/>
         
      <br/>
         
      <h3>
            
        <a href="dataelement.html">DataElement</a>
         
      </h3>
         
      <h4>Interactions</h4>
         
      <table class="list">
            
        <thead>
               
          <tr>
                  
            <th>Name</th>
                  
            <th>Conformance</th>
                  
            <th>Description</th>
               
          </tr>
            
        </thead>
            
        <tbody>
               
          <tr>
                  
            <th>
                     
              <a name="DataElement-search-type"> </a>
                     
              <span>search-type</span>
                  
            </th>
                  
            <td>SHALL</td>
                  
            <td>
                     
              <p>Allows a user to search for existing data elements</p>
                  
            </td>
               
          </tr>
               
          <tr>
                  
            <th>
                     
              <a name="DataElement-read"> </a>
                     
              <span>read</span>
                  
            </th>
                  
            <td>SHALL</td>
                  
            <td>
                     
              <p>Allows retrieval of a specific known data element</p>
                  
            </td>
               
          </tr>
               
          <tr>
                  
            <th>
                     
              <a name="DataElement-vread"> </a>
                     
              <span>vread</span>
                  
            </th>
                  
            <td>SHALL</td>
                  
            <td>
                     
              <p>Allows retrieval of a specific version of a data element</p>
                  
            </td>
               
          </tr>
               
          <tr>
                  
            <th>
                     
              <a name="DataElement-history-instance"> </a>
                     
              <span>history-instance</span>
                  
            </th>
                  
            <td>SHALL</td>
                  
            <td>
                     
              <p>Allows review of changes to a data element over time</p>
                  
            </td>
               
          </tr>
               
          <tr>
                  
            <th>
                     
              <a name="DataElement-create"> </a>
                     
              <span>create</span>
                  
            </th>
                  
            <td>SHALL</td>
                  
            <td>
                     
              <p>Allows defining a new data element.  Repositories requiring curation of submitted data
                 elements may require all new data elements to have a status of 'draft'.</p>
                  
            </td>
               
          </tr>
               
          <tr>
                  
            <th>
                     
              <a name="DataElement-update"> </a>
                     
              <span>update</span>
                  
            </th>
                  
            <td>SHALL</td>
                  
            <td>
                     
              <p>Allows maintaining data elements, such as adding additional mappings, display names, etc.
                  Servers may choose to prohibit certain types of edits, instead requiring the creation
                 of a new data element (and potentially the retiring of the existing data element).  Servers
                 may also limit who can change particular data elements.</p>
                  
            </td>
               
          </tr>
               
          <tr>
                  
            <th>
                     
              <a name="DataElement-validate"> </a>
                     
              <span>validate</span>
                  
            </th>
                  
            <td>SHOULD</td>
                  
            <td>
                     
              <p>Allows a client to verify whether a particular new data element or revision of an existing
                 data element would be accepted based on validation and other business rules.  Useful for
                 some workflows</p>
                  
            </td>
               
          </tr>
               
          <tr>
                  
            <th>
                     
              <a name="DataElement-delete"> </a>
                     
              <span>delete</span>
                  
            </th>
                  
            <td>MAY</td>
                  
            <td>
                     
              <p>Allows removal of an existing data element.  Servers may choose to not support deletions
                 or may limit deletions to data elements meeting certain requirements.  E.g. only elements
                 with a status of draft or only elements that have been retired for at least two years,
                 etc.</p>
                  
            </td>
               
          </tr>
            
        </tbody>
         
      </table>
         
      <br/>
         
      <br/>
         
      <h3>
            
        <a href="valueset.html">ValueSet</a>
         
      </h3>
         
      <h4>Interactions</h4>
         
      <table class="list">
            
        <thead>
               
          <tr>
                  
            <th>Name</th>
                  
            <th>Conformance</th>
                  
            <th>Description</th>
               
          </tr>
            
        </thead>
            
        <tbody>
               
          <tr>
                  
            <th>
                     
              <a name="ValueSet-search-type"> </a>
                     
              <span>search-type</span>
                  
            </th>
                  
            <td>SHALL</td>
                  
            <td>
                     
              <p>Allows discovery of existing value sets for use in authoring data elements</p>
                  
            </td>
               
          </tr>
               
          <tr>
                  
            <th>
                     
              <a name="ValueSet-read"> </a>
                     
              <span>read</span>
                  
            </th>
                  
            <td>SHALL</td>
                  
            <td>
                     
              <p>Allows retrieval of a specific value set referenced within a data element</p>
                  
            </td>
               
          </tr>
               
          <tr>
                  
            <th>
                     
              <a name="ValueSet-vread"> </a>
                     
              <span>vread</span>
                  
            </th>
                  
            <td>SHALL</td>
                  
            <td>
                     
              <p>Allows retrieval of a historical version of a value set as referenced within a data element</p>
                  
            </td>
               
          </tr>
               
          <tr>
                  
            <th>
                     
              <a name="ValueSet-history-instance"> </a>
                     
              <span>history-instance</span>
                  
            </th>
                  
            <td>SHALL</td>
                  
            <td>
                     
              <p>Allows review of changes to a value set over time</p>
                  
            </td>
               
          </tr>
               
          <tr>
                  
            <th>
                     
              <a name="ValueSet-create"> </a>
                     
              <span>create</span>
                  
            </th>
                  
            <td>SHALL</td>
                  
            <td>
                     
              <p>Allows definition of a new value set used by one or more data elements</p>
                  
            </td>
               
          </tr>
               
          <tr>
                  
            <th>
                     
              <a name="ValueSet-update"> </a>
                     
              <span>update</span>
                  
            </th>
                  
            <td>SHALL</td>
                  
            <td>
                     
              <p>Allows existing value sets referenced by one or more data elements to be maintained</p>
                  
            </td>
               
          </tr>
               
          <tr>
                  
            <th>
                     
              <a name="ValueSet-validate"> </a>
                     
              <span>validate</span>
                  
            </th>
                  
            <td>SHOULD</td>
                  
            <td>
                     
              <p>Allows verification that a value set is valid prior to submission - useful for some workflows.</p>
                  
            </td>
               
          </tr>
               
          <tr>
                  
            <th>
                     
              <a name="ValueSet-delete"> </a>
                     
              <span>delete</span>
                  
            </th>
                  
            <td>MAY</td>
                  
            <td>
                     
              <p>Not all servers will support deletion of value sets.  Status change to 'retired' will
                 be more typical, though deletion of draft value sets may keep repositories cleaner.</p>
                  
            </td>
               
          </tr>
            
        </tbody>
         
      </table>
      
    </div>
  </text>
  <name value="SDC Data Element Curator"/>
  <status value="draft"/>
  <publisher value="U.S. Office of the National Coordinator (ONC)"/>
  <contact>
    <telecom>
      <system value="other"/>
      <value value="http://wiki.siframework.org/Structured+Data+Capture+Initiative"/>
    </telecom>
  </contact>
  <date value="2014-07-06"/>
  <description value="This profile defines the expected capabilities of the ''SDC Data Element Curator'' role
   when conforming to the S&amp;I Framework's [[sdc|Structured Data Capture FHIR Data Element
   Exchange implementation guide]].  This role is responsible for defining and updating data
   elements stored in a repository."/>
  <kind value="requirements"/>
  <fhirVersion value="1.0.0"/>
  <acceptUnknown value="extensions"/>
  <format value="xml"/>
  <format value="json"/>
  <rest>
    <mode value="server"/>
    <documentation value="The primary focus of the curator is the definition and maintenance of [[DataElement]]s.
      However, [[ValueSet]]s must also be supported to allow definition of coded data elements.
      Some data elements will choose to maintain value sets as 'contained' resources, meaning
     the value set exists only in the context of the data element and cannot be referenced
     or maintained without also updating the data element.  However, systems should support
     value set re-use across data elements.  (Version-specific referencing can be used to avoid
     value sets from changing independent of the referencing [[Questionnaire]].)"/>
    <security>
      <description value="Implementations must meet the general security requirements documented in the [[sdc-security|SDC
       implementation guide]]."/>
    </security>
    <resource>
      <type value="DataElement"/>
      <profile>
        <reference value="http://hl7.org/fhir/StructureDefinition/dataelement-sdc-de"/>
      </profile>
      <interaction>
        <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="search-type"/>
        <documentation value="Allows a user to search for existing data elements"/>
      </interaction>
      <interaction>
        <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="read"/>
        <documentation value="Allows retrieval of a specific known data element"/>
      </interaction>
      <interaction>
        <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="vread"/>
        <documentation value="Allows retrieval of a specific version of a data element"/>
      </interaction>
      <interaction>
        <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="history-instance"/>
        <documentation value="Allows review of changes to a data element over time"/>
      </interaction>
      <interaction>
        <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="create"/>
        <documentation value="Allows defining a new data element.  Repositories requiring curation of submitted data
         elements may require all new data elements to have a status of 'draft'."/>
      </interaction>
      <interaction>
        <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="update"/>
        <documentation value="Allows maintaining data elements, such as adding additional mappings, display names, etc.
          Servers may choose to prohibit certain types of edits, instead requiring the creation
         of a new data element (and potentially the retiring of the existing data element).  Servers
         may also limit who can change particular data elements."/>
      </interaction>
      <interaction>
        <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <code value="validate"/>
        <documentation value="Allows a client to verify whether a particular new data element or revision of an existing
         data element would be accepted based on validation and other business rules.  Useful for
         some workflows"/>
      </interaction>
      <interaction>
        <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation">
          <valueCode value="MAY"/>
        </extension>
        <code value="delete"/>
        <documentation value="Allows removal of an existing data element.  Servers may choose to not support deletions
         or may limit deletions to data elements meeting certain requirements.  E.g. only elements
         with a status of draft or only elements that have been retired for at least two years,
         etc."/>
      </interaction>
    </resource>
    <resource>
      <type value="ValueSet"/>
      <profile>
        <reference value="http://hl7.org/fhir/StructureDefinition/valueset-sdc-de"/>
      </profile>
      <interaction>
        <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="search-type"/>
        <documentation value="Allows discovery of existing value sets for use in authoring data elements"/>
      </interaction>
      <interaction>
        <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="read"/>
        <documentation value="Allows retrieval of a specific value set referenced within a data element"/>
      </interaction>
      <interaction>
        <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="vread"/>
        <documentation value="Allows retrieval of a historical version of a value set as referenced within a data element"/>
      </interaction>
      <interaction>
        <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="history-instance"/>
        <documentation value="Allows review of changes to a value set over time"/>
      </interaction>
      <interaction>
        <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="create"/>
        <documentation value="Allows definition of a new value set used by one or more data elements"/>
      </interaction>
      <interaction>
        <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="update"/>
        <documentation value="Allows existing value sets referenced by one or more data elements to be maintained"/>
      </interaction>
      <interaction>
        <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <code value="validate"/>
        <documentation value="Allows verification that a value set is valid prior to submission - useful for some workflows."/>
      </interaction>
      <interaction>
        <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation">
          <valueCode value="MAY"/>
        </extension>
        <code value="delete"/>
        <documentation value="Not all servers will support deletion of value sets.  Status change to 'retired' will
         be more typical, though deletion of draft value sets may keep repositories cleaner."/>
      </interaction>
    </resource>
  </rest>
</Conformance>