Conformance-sdc-form-filler.xml

SDC System for completing forms (id = "sdc-formfiller")

Raw XML

<Conformance xmlns="http://hl7.org/fhir">
  <id value="sdc-formfiller"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><!-- Snipped for brevity --></div>
  </text>
  <name value="SDC Form Filler"/>
  <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 Filler'' role when conforming
   to the S&amp;I Framework's [[sdc|Structured Data Capture FHIR implementation guide]].
    This role is responsible for retrieving pre-defined forms, requesting pre-population
   of forms and/or auto-populating forms, guiding the user through verifying populated data
   and submitting completed or partially-completed 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]] and [[ValueSet]] resources are retrieved to allow the system to
     guide the user through the entry process.  The [[Binary]] and [[DocumentReference]] resources
     allow the system to find existing clinical documents that can be within the pre-population
     process.  (Support for retrieval operations on these resources is optional as the relevant
     CDA or FHIR structures may also be directly generated by the ''Form Filler'' itself.)
      Finally, the [[QuestionnaireAnswer]] resource is used to record the populated form."/>
    <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="StructureDefinition/questionnaire-sdc.xml-StructuredDataCaptureForm"/>
      </profile>
      <interaction>
        <extension url="http://hl7.org/fhir/StructureDefinition/conformance-common-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="search-type"/>
        <documentation value="Allows discovery of existing questionnaires to be completed"/>
      </interaction>
      <interaction>
        <extension url="http://hl7.org/fhir/StructureDefinition/conformance-common-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <code value="read"/>
        <documentation value="Allows retrieval of a specific questionnaire by id.  Allows systems to maintain a 'favorites'
         list of forms and retrieve them by id."/>
      </interaction>
      <interaction>
        <extension url="http://hl7.org/fhir/StructureDefinition/conformance-common-expectation">
          <valueCode value="MAY"/>
        </extension>
        <code value="history-instance"/>
        <documentation value="Allows review of changes made to a questionnaire over time.  Of interest to some systems,
         but probably not most."/>
      </interaction>
      <interaction>
        <extension url="http://hl7.org/fhir/StructureDefinition/conformance-common-expectation">
          <valueCode value="MAY"/>
        </extension>
        <code value="vread"/>
        <documentation value="Allows retrieval of a historical version of a questionnaire.  Most systems will make use
         of the current version only."/>
      </interaction>
    </resource><!--    Do we want to define what search criteria must be supported?    -->
    <resource>
      <type value="ValueSet"/>
      <profile>
        <reference value="http://hl7.org/fhir/StructureDefinition/valueset-sdc"/>
      </profile>
      <interaction>
        <extension url="http://hl7.org/fhir/StructureDefinition/conformance-common-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="read"/>
        <documentation value="Allows retrieval of a specific value set by id (as referenced in a Questionnaire)"/>
      </interaction>
      <interaction>
        <extension url="http://hl7.org/fhir/StructureDefinition/conformance-common-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <code value="vread"/>
        <documentation value="Allows retrieval of a specific version of a value set (as referenced in a Questionnaire)"/>
      </interaction>
      <interaction>
        <extension url="http://hl7.org/fhir/StructureDefinition/conformance-common-expectation">
          <valueCode value="MAY"/>
        </extension>
        <code value="history-instance"/>
        <documentation value="Allows review of changes to a value set over time.  Of interest to some systems, but probably
         not most."/>
      </interaction>
    </resource>
    <resource>
      <type value="QuestionnaireAnswers"/>
      <profile>
        <reference value="http://hl7.org/fhir/StructureDefinition/dataelement-sdc"/>
      </profile>
      <interaction>
        <extension url="http://hl7.org/fhir/StructureDefinition/conformance-common-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="search-type"/>
        <documentation value="Allows a user to search for existing completed or partially-completed forms.  Generally
         used to find partially-completed forms for update."/>
      </interaction>
      <interaction>
        <extension url="http://hl7.org/fhir/StructureDefinition/conformance-common-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="create"/>
        <documentation value="Allows recording a completed or partially-completed form"/>
      </interaction>
      <interaction>
        <extension url="http://hl7.org/fhir/StructureDefinition/conformance-common-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="update"/>
        <documentation value="Allows updating an existing completed or partially-completed form.  (Systems may place
         rules on who can update forms and under what circumstances.)"/>
      </interaction>
      <interaction>
        <extension url="http://hl7.org/fhir/StructureDefinition/conformance-common-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="delete"/>
        <documentation value="Allows removal of a completed form from a repository.  Note that the removal may be logical
         rather than physical.  Some systems may have rules for who can remove a completed form
         and under what circumstances."/>
      </interaction>
      <interaction>
        <extension url="http://hl7.org/fhir/StructureDefinition/conformance-common-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <code value="history-instance"/>
        <documentation value="Allows review of prior versions of an answer set - allows reversion to previously recorded
         versions"/>
      </interaction>
      <interaction>
        <extension url="http://hl7.org/fhir/StructureDefinition/conformance-common-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <code value="validate"/>
        <documentation value="Allows checking an answer set for validity against submission rules without persisting
         any data"/>
      </interaction>
    </resource><!--    Do we want to define what search criteria must be supported?    -->
    <resource>
      <type value="DocumentReference"/>
      <profile>
        <reference value="http://hl7.org/fhir/StructureDefinition/documentreference-sdc"/>
      </profile>
      <interaction>
        <extension url="http://hl7.org/fhir/StructureDefinition/conformance-common-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <code value="search-type"/>
        <documentation value="Allows discovery of existing documents that may be included in a form pre-population request"/>
      </interaction>
    </resource><!--    Do we want to define what search criteria must be supported?    -->
    <resource>
      <type value="Binary"/>
      <profile>
        <reference value="http://hl7.org/fhir/StructureDefinition/binary-sdc"/>
      </profile>
      <interaction>
        <extension url="http://hl7.org/fhir/StructureDefinition/conformance-common-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <code value="read"/>
        <documentation value="Allows retrieval of a specific binary (as pointed to by a DocumentReference)"/>
      </interaction>
      <interaction>
        <extension url="http://hl7.org/fhir/StructureDefinition/conformance-common-expectation">
          <valueCode value="MAY"/>
        </extension>
        <code value="vread"/>
        <documentation value="Allows retrieval of a historical version of a binary.  In general, the most recent version
         would be appropriate, but some may prefer to use the specific version referenced by a
         DocumentReference."/>
      </interaction>
    </resource>
    <operation>
      <extension url="http://hl7.org/fhir/StructureDefinition/conformance-common-expectation">
        <valueCode value="MAY"/>
      </extension>
      <name value="populate"/>
      <definition><!--    Todo: Confirm the id for the operation    -->
        <reference value="http://hl7.org/fhir/OperationDefinition#questionnaire-populate"/>
        <display value="Populate Questionnaire"/>
      </definition>
    </operation>
  </rest>
</Conformance>