STU 2 Ballot

This page is part of the Structured Data Capture - Data Element Exchange Specification (v1.6: STU 2 Ballot 1) based on FHIR v1.6.0. The current version which supercedes this version is 2.0. For a full list of available versions, see the Directory of published versions

1 SDC Data Element Manager

Formats: XML, JSON, Turtle

SDC Data Element Manager

(Requirements Definition)

http://hl7.org/fhir/us/sdcde/Conformance/conformance-sdc-de-registry Published: 2014-07-06 (draft)

Published by: U.S. Office of the National Coordinator (ONC)

This profile defines the expected capabilities of the SDC Data Element Manager role when conforming to the S&I Framework's 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.

General

FHIR Version: $ver$
Supported formats: xml, json

REST behavior

The primary focus of the repository is the definition of DataElements. However, ValueSets and CodeSystems 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:

Implementations must meet the general security requirements documented in the SDC implementation guide.

Resource summary

Resource Search Read Read Version Instance History Resource History Create Update Delete
DataElement (Profile) SHALL SHALL SHALL SHALL SHALL SHALL MAY
ValueSet (Profile) SHALL SHALL SHALL SHALL SHALL SHALL MAY
CodeSystem (Profile) SHALL SHALL SHALL SHALL SHALL SHALL MAY


DataElement

Interactions

Name Conformance Description
  search-type SHALL

Allows a user to search for existing data elements
  read SHALL

Allows retrieval of a specific known data element
  vread SHALL

Allows retrieval of a specific version of a data element
  history-instance SHALL

Allows review of changes to a data element over time
  create SHALL

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'.
  update SHALL

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.
  delete MAY

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.

Search

Supported Includes: DataElement.binding.valueSet

Parameter Conformance Type Definition & Chaining
code SHALL token
context SHALL token
date SHALL date
description SHALL string
identifier SHALL token
name SHALL string
publisher SHALL string
status SHALL token
stringency SHALL token
url SHALL uri
version SHALL string
meaning SHALL token
objectClass SHALL token
property SHALL token


ValueSet

Interactions

Name Conformance Description
  search-type SHALL

Allows discovery of existing value sets for use in authoring data elements
  read SHALL

Allows retrieval of a specific value set referenced within a data element
  vread SHALL

Allows retrieval of a historical version of a value set as referenced within a data element
  history-instance SHALL

Allows review of changes to a value set over time
  create SHALL

Allows definition of a new value set used by one or more data elements
  update SHALL

Allows existing value sets referenced by one or more data elements to be maintained
  delete MAY

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.

Search

Supported Includes: ValueSet.compose.import

Parameter Conformance Type Definition & Chaining
code SHALL token
date SHALL date
description SHALL string
identifier SHALL token
name SHALL string
publisher SHALL string
reference SHALL string
status SHALL token
version SHALL token


CodeSystem

Interactions

Name Conformance Description
  search-type SHALL

Allows discovery of existing code systems for use in authoring data elements
  read SHALL

Allows retrieval of a specific code system referenced within a data element
  vread SHALL

Allows retrieval of a historical version of a code system as referenced within a data element
  history-instance SHALL

Allows review of changes to a code system over time
  create SHALL

Allows definition of a new code system used by one or more data elements
  update SHALL

Allows existing code systems referenced by one or more data element value sets to be maintained
  delete MAY

Not all servers will support deletion of code systems. Status change to 'retired' will be more typical, though deletion of draft code systems may keep repositories cleaner.

Search

Supported Includes: ValueSet.compose.import

Parameter Conformance Type Definition & Chaining
code SHALL token
context SHALL token
date SHALL date
description SHALL string
identifier SHALL token
name SHALL string
publisher SHALL string
status SHALL token
system SHALL uri
url SHALL uri
version SHALL token