Conformance-sdc-form-receiver.json

SDC Repository for completed forms

{
  "resourceType": "Conformance",
  "id": "sdc-formreceiver",
  "text": {
    "status": "generated",
    "div": "<div>!-- Snipped for Brevity --></div>"
  },
  "name": "SDC Form Receiver",
  "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 Receiver'' role when conforming to the S&I Framework's [[sdc|Structured Data Capture FHIR implementation guide]].  This role is responsible for storing and returning completed and partially-completed forms.",
  "status": "draft",
  "date": "2014-07-06",
  "fhirVersion": "0.2",
  "acceptUnknown": false,
  "format": [
    "xml",
    "json"
  ],
  "rest": [
    {
      "mode": "server",
      "security": {
        "description": "Implementations must meet the general security requirements documented in the [[sdc-security|SDC implementation guide]]."
      },
      "resource": [
        {
          "type": "QuestionnaireAnswers",
          "profile": {
            "reference": "http://hl7.org/fhir/Profile/dataelement-sdc"
          },
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/ExtensionDefinition/conformance-common-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "search-type",
              "documentation": "Allows a user to search for existing completed or partially-completed forms.  Generally used to find partially-completed forms for update."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/ExtensionDefinition/conformance-common-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "create",
              "documentation": "Allows recording a completed or partially-completed form"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/ExtensionDefinition/conformance-common-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "update",
              "documentation": "Allows updating an existing completed or partially-completed form.  (Systems may place rules on who can update forms and under what circumstances.)"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/ExtensionDefinition/conformance-common-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "delete",
              "documentation": "Allows removal of a completed form from a repository.  Note that the removal may be logical rather than physical.  Some systems may have rules for who can remove a completed form and under what circumstances."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/ExtensionDefinition/conformance-common-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "history-instance",
              "documentation": "Allows review of prior versions of an answer set - allows reversion to previously recorded versions"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/ExtensionDefinition/conformance-common-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "validate",
              "documentation": "Allows checking an answer set for validity against submission rules without persisting any data"
            }
          ],
          "searchInclude": [
            "QuestionnaireAnswers.questionnaire",
            "Questionnaire.group.question.options"
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/ExtensionDefinition/conformance-common-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "author",
              "definition": "http://hl7.org/fhir/SearchParameter/questionnaireanswers#author",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/ExtensionDefinition/conformance-common-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "authored",
              "definition": "http://hl7.org/fhir/SearchParameter/questionnaireanswers#authored",
              "type": "date"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/ExtensionDefinition/conformance-common-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "questionnaire",
              "definition": "http://hl7.org/fhir/SearchParameter/questionnaireanswers#questionnaire",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/ExtensionDefinition/conformance-common-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "status",
              "definition": "http://hl7.org/fhir/SearchParameter/questionnaireanswers#status",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/ExtensionDefinition/conformance-common-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "subject",
              "definition": "http://hl7.org/fhir/SearchParameter/questionnaireanswers#subject",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/ExtensionDefinition/conformance-common-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "encounter",
              "definition": "http://hl7.org/fhir/SearchParameter/questionnaireanswers#encounter",
              "type": "token"
            }
          ]
        }
      ]
    }
  ]
}