Conformance-sdc-de-registry.xml

SDC Repository for Data Elements (id = "sdc-de-registry")

Raw XML

<Conformance xmlns="http://hl7.org/fhir">
  <id value="sdc-de-registry"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><!-- Snipped for brevity --></div>
  </text>
  <name value="SDC Data Element Manager"/>
  <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 Data Element Manager'' role
   when conforming to the S&amp;I Framework's [[sdc|Structured Data Capture FHIR implementation
   guide]].  This role is responsible for defining maintaining a repository of data elements
   used in designing forms, profiles and templates in support of SDC use-cases, including
   the pre-population and auto-population of 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="server"/>
    <documentation value="The primary focus of the repository is the definition 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/valueset-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 data elements"/>
      </interaction>
      <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 known data element"/>
      </interaction>
      <interaction>
        <extension url="http://hl7.org/fhir/StructureDefinition/conformance-common-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-common-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-common-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-common-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="update"/>
        <documentation value="Allows maintaining data elements while creating and editing forms.  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-common-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-common-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>
      <searchInclude value="DataElement.binding.valueSet"/>
      <searchParam>
        <extension url="http://hl7.org/fhir/StructureDefinition/conformance-common-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="category"/>
        <definition value="http://hl7.org/fhir/SearchParameter/dataelement#category"/>
        <type value="token"/>
      </searchParam>
      <searchParam>
        <extension url="http://hl7.org/fhir/StructureDefinition/conformance-common-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="code"/>
        <definition value="http://hl7.org/fhir/SearchParameter/dataelement#code"/>
        <type value="token"/>
      </searchParam>
      <searchParam>
        <extension url="http://hl7.org/fhir/StructureDefinition/conformance-common-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="date"/>
        <definition value="http://hl7.org/fhir/SearchParameter/dataelement#date"/>
        <type value="date"/>
      </searchParam>
      <searchParam>
        <extension url="http://hl7.org/fhir/StructureDefinition/conformance-common-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="description"/>
        <definition value="http://hl7.org/fhir/SearchParameter/dataelement#description"/>
        <type value="string"/>
      </searchParam>
      <searchParam>
        <extension url="http://hl7.org/fhir/StructureDefinition/conformance-common-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="identifier"/>
        <definition value="http://hl7.org/fhir/SearchParameter/dataelement#identifier"/>
        <type value="token"/>
      </searchParam>
      <searchParam>
        <extension url="http://hl7.org/fhir/StructureDefinition/conformance-common-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="name"/>
        <definition value="http://hl7.org/fhir/SearchParameter/dataelement#name"/>
        <type value="string"/>
      </searchParam>
      <searchParam>
        <extension url="http://hl7.org/fhir/StructureDefinition/conformance-common-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="publisher"/>
        <definition value="http://hl7.org/fhir/SearchParameter/dataelement#publisher"/>
        <type value="string"/>
      </searchParam>
      <searchParam>
        <extension url="http://hl7.org/fhir/StructureDefinition/conformance-common-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="status"/>
        <definition value="http://hl7.org/fhir/SearchParameter/dataelement#status"/>
        <type value="token"/>
      </searchParam>
      <searchParam>
        <extension url="http://hl7.org/fhir/StructureDefinition/conformance-common-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="version"/>
        <definition value="http://hl7.org/fhir/SearchParameter/dataelement#version"/>
        <type value="string"/>
      </searchParam>
      <searchParam>
        <extension url="http://hl7.org/fhir/StructureDefinition/conformance-common-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="meaning"/>
        <definition value="http://hl7.org/fhir/SearchParameter/11179-meaning"/>
        <type value="token"/>
      </searchParam>
      <searchParam>
        <extension url="http://hl7.org/fhir/StructureDefinition/conformance-common-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="objectClass"/>
        <definition value="http://hl7.org/fhir/SearchParameter/11179-objectClass"/>
        <type value="token"/>
      </searchParam>
      <searchParam>
        <extension url="http://hl7.org/fhir/StructureDefinition/conformance-common-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="property"/>
        <definition value="http://hl7.org/fhir/SearchParameter/11179-property"/>
        <type value="token"/>
      </searchParam>
    </resource>
    <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="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-common-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-common-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-common-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-common-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-common-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-common-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-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?    -->
      <searchInclude value="ValueSet.compose.import"/>
      <searchParam>
        <extension url="http://hl7.org/fhir/StructureDefinition/conformance-common-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="code"/>
        <definition value="http://hl7.org/fhir/SearchParameter/valueset#code"/>
        <type value="token"/>
      </searchParam>
      <searchParam>
        <extension url="http://hl7.org/fhir/StructureDefinition/conformance-common-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="date"/>
        <definition value="http://hl7.org/fhir/SearchParameter/valueset#date"/>
        <type value="date"/>
      </searchParam>
      <searchParam>
        <extension url="http://hl7.org/fhir/StructureDefinition/conformance-common-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="description"/>
        <definition value="http://hl7.org/fhir/SearchParameter/valueset#description"/>
        <type value="string"/>
      </searchParam>
      <searchParam>
        <extension url="http://hl7.org/fhir/StructureDefinition/conformance-common-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="identifier"/>
        <definition value="http://hl7.org/fhir/SearchParameter/valueset#identifier"/>
        <type value="token"/>
      </searchParam>
      <searchParam>
        <extension url="http://hl7.org/fhir/StructureDefinition/conformance-common-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="name"/>
        <definition value="http://hl7.org/fhir/SearchParameter/valueset#name"/>
        <type value="string"/>
      </searchParam>
      <searchParam>
        <extension url="http://hl7.org/fhir/StructureDefinition/conformance-common-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="publisher"/>
        <definition value="http://hl7.org/fhir/SearchParameter/valueset#publisher"/>
        <type value="string"/>
      </searchParam>
      <searchParam>
        <extension url="http://hl7.org/fhir/StructureDefinition/conformance-common-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="reference"/>
        <definition value="http://hl7.org/fhir/SearchParameter/valueset#reference"/>
        <type value="string"/>
      </searchParam>
      <searchParam>
        <extension url="http://hl7.org/fhir/StructureDefinition/conformance-common-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="status"/>
        <definition value="http://hl7.org/fhir/SearchParameter/valueset#status"/>
        <type value="token"/>
      </searchParam>
      <searchParam>
        <extension url="http://hl7.org/fhir/StructureDefinition/conformance-common-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="system"/>
        <definition value="http://hl7.org/fhir/SearchParameter/valueset#system"/>
        <type value="string"/>
      </searchParam>
      <searchParam>
        <extension url="http://hl7.org/fhir/StructureDefinition/conformance-common-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="version"/>
        <definition value="http://hl7.org/fhir/SearchParameter/valueset#version"/>
        <type value="string"/>
      </searchParam>
    </resource>
  </rest>
</Conformance>