Conformance-sdc-form-designer.json

SDC Form authoring system

{
  "resourceType": "Conformance",
  "id": "sdc-formdesigner",
  "text": {
    "status": "generated",
    "div": "<div>!-- Snipped for Brevity --></div>"
  },
  "name": "SDC Form Designer",
  "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 Form Designer'' role when conforming to the S&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": "draft",
  "date": "2014-07-06",
  "fhirVersion": "0.2",
  "acceptUnknown": false,
  "format": [
    "xml",
    "json"
  ],
  "rest": [
    {
      "mode": "client",
      "documentation": "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": "Implementations must meet the general security requirements documented in the [[sdc-security|SDC implementation guide]]."
      },
      "resource": [
        {
          "type": "Questionnaire",
          "profile": {
            "reference": "http://hl7.org/fhir/StructureDefinition/questionnaire-sdc-"
          },
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "search-type",
              "documentation": "Allows discovery of existing questionnaires for editing"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "read",
              "documentation": "Allows retrieval of a specific questionnaire by id"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "create",
              "documentation": "Allows submission of a new form design"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "update",
              "documentation": "Allows revision of an existing form design.  Note that certain types of updates may necessitate retiring the existing form and defining a new one."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "history-instance",
              "documentation": "Allows review of changes to questionnaire over time"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "vread",
              "documentation": "Allows retrieval of a historical version of a questionnaire"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "MAY"
                }
              ],
              "code": "delete",
              "documentation": "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."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "MAY"
                }
              ],
              "code": "validate",
              "documentation": "Allows verification that form is valid prior to submission - useful for some workflows."
            }
          ]
        },
        {
          "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 by questions in a form"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "read",
              "documentation": "Allows retrieval of a specific value set by id"
            },
            {
              "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 questions"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "update",
              "documentation": "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."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "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": "SHOULD"
                }
              ],
              "code": "vread",
              "documentation": "Allows retrieval of a historical version of a value set"
            },
            {
              "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."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "MAY"
                }
              ],
              "code": "validate",
              "documentation": "Allows verification that a value set is valid prior to submission - useful for some workflows."
            }
          ]
        },
        {
          "type": "DataElement",
          "profile": {
            "reference": "http://hl7.org/fhir/StructureDefinition/dataelement-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 for re-use in a form design"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "read",
              "documentation": "Allows retrieval of data elements referenced in an existing form design"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "vread",
              "documentation": "Allows viewing of specific versions of a data element if the form references a specific version"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "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": "MAY"
                }
              ],
              "code": "create",
              "documentation": "Allows defining new data elements for subsequent re-use while creating and editing forms"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "MAY"
                }
              ],
              "code": "update",
              "documentation": "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."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "MAY"
                }
              ],
              "code": "delete",
              "documentation": "Allows maintaining data elements while creating and editing forms.  Note that not all servers will support deleting data elements."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "MAY"
                }
              ],
              "code": "validate",
              "documentation": "Allows maintaining data elements while creating and editing forms - user can check that proposed data element is valid prior to submission"
            }
          ]
        }
      ]
    }
  ]
}