Conformance-sdc-de-registry.json

SDC Repository for Data Elements

{
  "resourceType": "Conformance",
  "id": "sdc-de-registry",
  "text": {
    "status": "generated",
    "div": "<div>!-- Snipped for Brevity --></div>"
  },
  "name": "SDC Data Element Manager",
  "publisher": "U.S. Office of the National Coordinator (ONC)",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://wiki.siframework.org/Structured+Data+Capture+Initiative"
        }
      ]
    }
  ],
  "description": "This profile defines the expected capabilities of the ''SDC Data Element Manager'' role when conforming to the S&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": "draft",
  "date": "2014-07-06",
  "fhirVersion": "0.2",
  "acceptUnknown": false,
  "format": [
    "xml",
    "json"
  ],
  "rest": [
    {
      "mode": "server",
      "documentation": "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": "Implementations must meet the general security requirements documented in the [[sdc-security|SDC implementation guide]]."
      },
      "resource": [
        {
          "type": "DataElement",
          "profile": {
            "reference": "http://hl7.org/fhir/StructureDefinition/valueset-sdc"
          },
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "search-type",
              "documentation": "Allows a user to search for existing data elements"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "read",
              "documentation": "Allows retrieval of a specific known data element"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "vread",
              "documentation": "Allows retrieval of a specific version of a data element"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "history-instance",
              "documentation": "Allows review of changes to a data element over time"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "create",
              "documentation": "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'."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "update",
              "documentation": "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."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "validate",
              "documentation": "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"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "MAY"
                }
              ],
              "code": "delete",
              "documentation": "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."
            }
          ],
          "searchInclude": [
            "DataElement.binding.valueSet"
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "category",
              "definition": "http://hl7.org/fhir/SearchParameter/dataelement#category",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "code",
              "definition": "http://hl7.org/fhir/SearchParameter/dataelement#code",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "date",
              "definition": "http://hl7.org/fhir/SearchParameter/dataelement#date",
              "type": "date"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "description",
              "definition": "http://hl7.org/fhir/SearchParameter/dataelement#description",
              "type": "string"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "identifier",
              "definition": "http://hl7.org/fhir/SearchParameter/dataelement#identifier",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "name",
              "definition": "http://hl7.org/fhir/SearchParameter/dataelement#name",
              "type": "string"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "publisher",
              "definition": "http://hl7.org/fhir/SearchParameter/dataelement#publisher",
              "type": "string"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "status",
              "definition": "http://hl7.org/fhir/SearchParameter/dataelement#status",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "version",
              "definition": "http://hl7.org/fhir/SearchParameter/dataelement#version",
              "type": "string"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "meaning",
              "definition": "http://hl7.org/fhir/SearchParameter/11179-meaning",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "objectClass",
              "definition": "http://hl7.org/fhir/SearchParameter/11179-objectClass",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "property",
              "definition": "http://hl7.org/fhir/SearchParameter/11179-property",
              "type": "token"
            }
          ]
        },
        {
          "type": "ValueSet",
          "profile": {
            "reference": "http://hl7.org/fhir/StructureDefinition/valueset-sdc"
          },
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "search-type",
              "documentation": "Allows discovery of existing value sets for use in authoring data elements"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "read",
              "documentation": "Allows retrieval of a specific value set referenced within a data element"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "vread",
              "documentation": "Allows retrieval of a historical version of a value set as referenced within a data element"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "history-instance",
              "documentation": "Allows review of changes to a value set over time"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "create",
              "documentation": "Allows definition of a new value set used by one or more data elements"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "update",
              "documentation": "Allows existing value sets referenced by one or more data elements to be maintained"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "validate",
              "documentation": "Allows verification that a value set is valid prior to submission - useful for some workflows."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "MAY"
                }
              ],
              "code": "delete",
              "documentation": "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."
            }
          ],
          "searchInclude": [
            "ValueSet.compose.import"
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "code",
              "definition": "http://hl7.org/fhir/SearchParameter/valueset#code",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "date",
              "definition": "http://hl7.org/fhir/SearchParameter/valueset#date",
              "type": "date"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "description",
              "definition": "http://hl7.org/fhir/SearchParameter/valueset#description",
              "type": "string"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "identifier",
              "definition": "http://hl7.org/fhir/SearchParameter/valueset#identifier",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "name",
              "definition": "http://hl7.org/fhir/SearchParameter/valueset#name",
              "type": "string"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "publisher",
              "definition": "http://hl7.org/fhir/SearchParameter/valueset#publisher",
              "type": "string"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "reference",
              "definition": "http://hl7.org/fhir/SearchParameter/valueset#reference",
              "type": "string"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "status",
              "definition": "http://hl7.org/fhir/SearchParameter/valueset#status",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "system",
              "definition": "http://hl7.org/fhir/SearchParameter/valueset#system",
              "type": "string"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "version",
              "definition": "http://hl7.org/fhir/SearchParameter/valueset#version",
              "type": "string"
            }
          ]
        }
      ]
    }
  ]
}