Conformance-sdc-form-designer.xml

SDC Form authoring system (id = "sdc-formdesigner")

Raw XML

<Conformance xmlns="http://hl7.org/fhir">
  <id value="sdc-formdesigner"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><!-- Snipped for brevity --></div>
  </text>
  <name value="SDC Form Designer"/>
  <publisher value="U.S. Office of the National Coordinator (ONC)"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://wiki.siframework.org/Structured+Data+Capture+Initiative"/>
    </telecom>
  </contact>
  <description value="This profile defines the expected capabilities of the ''SDC Form Designer'' role when
   conforming to the S&amp;I Framework's [[sdc|Structured Data Capture FHIR implementation
   guide]].  This role is responsible for defining forms ([[Questionnaire]] resource instances)
   that include references to [[DataElement]] resouces which define the meaning of particular
   questions and can be used to aid in pre-populating and auto-populating forms."/>
  <status value="draft"/>
  <date value="2014-07-06"/>
  <fhirVersion value="0.2"/>
  <acceptUnknown value="false"/>
  <format value="xml"/>
  <format value="json"/>
  <rest>
    <mode value="client"/>
    <documentation value="The [[Questionnaire]] resource is used to create and maintain SDC-compliant forms.  The
     [[DataElement]] resource is used to look-up existing data elements that can be referenced
     in forms.  Optionally, [[DataElement]]s can also be created and maintained in conjunction
     with form editing.  This is an optional feature as not all environments will provide support
     for data element definitions from form authors.  The [[ValueSet]] resource is used to
     capture allowed values for questions that are to be answered from a pre-defined list of
     values.  For some forms, some or all of the referenced value sets will be handled as 'contained'
     resources, meaning the value set exists only in the context of the [[Questionnaire]] and
     cannot be referenced or maintained without also updating the form.  However, systems should
     support value set re-use across questionnaires.  (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="Questionnaire"/>
      <profile>
        <reference value="http://hl7.org/fhir/Profile/questionnaire-sdc-"/>
      </profile>
      <interaction>
        <extension url="http://hl7.org/fhir/ExtensionDefinition/conformance-common-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="search-type"/>
        <documentation value="Allows discovery of existing questionnaires for editing"/>
      </interaction>
      <interaction>
        <extension url="http://hl7.org/fhir/ExtensionDefinition/conformance-common-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="read"/>
        <documentation value="Allows retrieval of a specific questionnaire by id"/>
      </interaction>
      <interaction>
        <extension url="http://hl7.org/fhir/ExtensionDefinition/conformance-common-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="create"/>
        <documentation value="Allows submission of a new form design"/>
      </interaction>
      <interaction>
        <extension url="http://hl7.org/fhir/ExtensionDefinition/conformance-common-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="update"/>
        <documentation value="Allows revision of an existing form design.  Note that certain types of updates may necessitate
         retiring the existing form and defining a new one."/>
      </interaction>
      <interaction>
        <extension url="http://hl7.org/fhir/ExtensionDefinition/conformance-common-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <code value="history-instance"/>
        <documentation value="Allows review of changes to questionnaire over time"/>
      </interaction>
      <interaction>
        <extension url="http://hl7.org/fhir/ExtensionDefinition/conformance-common-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <code value="vread"/>
        <documentation value="Allows retrieval of a historical version of a questionnaire"/>
      </interaction>
      <interaction>
        <extension url="http://hl7.org/fhir/ExtensionDefinition/conformance-common-expectation">
          <valueCode value="MAY"/>
        </extension>
        <code value="delete"/>
        <documentation value="Not all servers will support deletion of forms.  Status change to 'retired' will be more
         typical, though deletion of draft profiles may keep repositories cleaner."/>
      </interaction><!--    Should we include this in the conformance statement at all?    -->
      <interaction>
        <extension url="http://hl7.org/fhir/ExtensionDefinition/conformance-common-expectation">
          <valueCode value="MAY"/>
        </extension>
        <code value="validate"/>
        <documentation value="Allows verification that form is valid prior to submission - useful for some workflows."/>
      </interaction>
    </resource><!--    Do we want to define what search criteria must be supported?    -->
    <resource>
      <type value="ValueSet"/>
      <profile>
        <reference value="http://hl7.org/fhir/Profile/valueset-sdc"/>
      </profile>
      <interaction>
        <extension url="http://hl7.org/fhir/ExtensionDefinition/conformance-common-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="search-type"/>
        <documentation value="Allows discovery of existing value sets for use by questions in a form"/>
      </interaction>
      <interaction>
        <extension url="http://hl7.org/fhir/ExtensionDefinition/conformance-common-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="read"/>
        <documentation value="Allows retrieval of a specific value set by id"/>
      </interaction>
      <interaction>
        <extension url="http://hl7.org/fhir/ExtensionDefinition/conformance-common-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="create"/>
        <documentation value="Allows definition of a new value set used by one or more questions"/>
      </interaction>
      <interaction>
        <extension url="http://hl7.org/fhir/ExtensionDefinition/conformance-common-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="update"/>
        <documentation value="Allows existing value sets referenced by a form to be maintained.  Note that certain types
         of updates may necessitate retiring the existing value set and defining a new one."/>
      </interaction>
      <interaction>
        <extension url="http://hl7.org/fhir/ExtensionDefinition/conformance-common-expectation">
          <valueCode value="SHOULD"/>
        </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/ExtensionDefinition/conformance-common-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <code value="vread"/>
        <documentation value="Allows retrieval of a historical version of a value set"/>
      </interaction>
      <interaction>
        <extension url="http://hl7.org/fhir/ExtensionDefinition/conformance-common-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><!--    Should we include this in the conformance statement at all?    -->
      <interaction>
        <extension url="http://hl7.org/fhir/ExtensionDefinition/conformance-common-expectation">
          <valueCode value="MAY"/>
        </extension>
        <code value="validate"/>
        <documentation value="Allows verification that a value set is valid prior to submission - useful for some workflows."/>
      </interaction>
    </resource><!--    Do we want to define what search criteria must be supported?    -->
    <resource>
      <type value="DataElement"/>
      <profile>
        <reference value="http://hl7.org/fhir/Profile/dataelement-sdc"/>
      </profile>
      <interaction>
        <extension url="http://hl7.org/fhir/ExtensionDefinition/conformance-common-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="search-type"/>
        <documentation value="Allows a user to search for existing data elements for re-use in a form design"/>
      </interaction>
      <interaction>
        <extension url="http://hl7.org/fhir/ExtensionDefinition/conformance-common-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="read"/>
        <documentation value="Allows retrieval of data elements referenced in an existing form design"/>
      </interaction>
      <interaction>
        <extension url="http://hl7.org/fhir/ExtensionDefinition/conformance-common-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <code value="vread"/>
        <documentation value="Allows viewing of specific versions of a data element if the form references a specific
         version"/>
      </interaction><!--    Do we need this to be SHALL too?    -->
      <interaction>
        <extension url="http://hl7.org/fhir/ExtensionDefinition/conformance-common-expectation">
          <valueCode value="SHOULD"/>
        </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/ExtensionDefinition/conformance-common-expectation">
          <valueCode value="MAY"/>
        </extension>
        <code value="create"/>
        <documentation value="Allows defining new data elements for subsequent re-use while creating and editing forms"/>
      </interaction>
      <interaction>
        <extension url="http://hl7.org/fhir/ExtensionDefinition/conformance-common-expectation">
          <valueCode value="MAY"/>
        </extension>
        <code value="update"/>
        <documentation value="Allows maintaining data elements while creating and editing forms.  Note that certain
         types of updates may necessitate retiring the existing data element and defining a new
         one."/>
      </interaction>
      <interaction>
        <extension url="http://hl7.org/fhir/ExtensionDefinition/conformance-common-expectation">
          <valueCode value="MAY"/>
        </extension>
        <code value="delete"/>
        <documentation value="Allows maintaining data elements while creating and editing forms.  Note that not all
         servers will support deleting data elements."/>
      </interaction>
      <interaction>
        <extension url="http://hl7.org/fhir/ExtensionDefinition/conformance-common-expectation">
          <valueCode value="MAY"/>
        </extension>
        <code value="validate"/>
        <documentation value="Allows maintaining data elements while creating and editing forms - user can check that
         proposed data element is valid prior to submission"/>
      </interaction>
    </resource>
  </rest>
</Conformance>