Conformance-sdc-form-manager.json

SDC Repository for forms

{
  "resourceType": "Conformance",
  "id": "sdc-formmanager",
  "text": {
    "status": "generated",
    "div": "<div>!-- Snipped for Brevity --></div>"
  },
  "name": "SDC Form 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 Form Manager'' role when conforming to the S&I Framework's [[sdc|Structured Data Capture FHIR implementation guide]].  This role is responsible for maintaining a repository of form definitions and also of performing pre-population of form data.",
  "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 [[Questionnaires]].  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": "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 a user to search for existing forms"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "read",
              "documentation": "Allows retrieval of a specific known form"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "vread",
              "documentation": "Allows retrieval of a specific version of a form"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "history-instance",
              "documentation": "Allows review of changes to a form over time"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "create",
              "documentation": "Allows defining a new form.  Repositories requiring curation of submitted forms 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 an existing form to be updated.  Servers may choose to prohibit certain types of edits, instead requiring the creation of a new questionnaire (and potentially the retiring of the existing questionnaire).  Servers may also limit who can change particular forms."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "validate",
              "documentation": "SHOULD. Allows a client to verify whether a particular new form or revision of an existing form 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 form.  Servers may choose to not support deletions and instead require that the form's status be changed to 'retired'.  Other systems support deletions but limit them to forms meeting certain requirements.  E.g. only forms with a status of draft or only forms that have been retired for at least two years, etc."
            }
          ],
          "searchInclude": [
            "Questionnaire.group.question.options"
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "code",
              "definition": "http://hl7.org/fhir/SearchParameter/questionnaire#code",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "date",
              "definition": "http://hl7.org/fhir/SearchParameter/questionnaire#date",
              "type": "date"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "identifier",
              "definition": "http://hl7.org/fhir/SearchParameter/questionnaire#identifier",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "publisher",
              "definition": "http://hl7.org/fhir/SearchParameter/questionnaire#publisher",
              "type": "string"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "status",
              "definition": "http://hl7.org/fhir/SearchParameter/questionnaire#status",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "title",
              "definition": "http://hl7.org/fhir/SearchParameter/questionnaire#title",
              "type": "string"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "version",
              "definition": "http://hl7.org/fhir/SearchParameter/questionnaire#version",
              "type": "string"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "deReference",
              "definition": "http://hl7.org/fhir/SearchParameter/questionnaire-deReference",
              "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 questionnaires"
            },
            {
              "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 questionnaire"
            },
            {
              "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 questionnaire"
            },
            {
              "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 questionnaires"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "update",
              "documentation": "Allows existing value sets referenced by one or more questionnaires 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"
            }
          ]
        }
      ],
      "operation": [
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/conformance-common-expectation",
              "valueCode": "MAY"
            }
          ],
          "name": "populate",
          "definition": {
            "reference": "http://hl7.org/fhir/OperationDefinition#questionnaire-populate",
            "display": "Populate Questionnaire"
          }
        }
      ]
    }
  ]
}