Structured Data Capture
4.0.0 - STU 4
Structured Data Capture
4.0.0 - STU 4
Structured Data Capture, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 4.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/sdc/ and changes regularly. See the Directory of published versions
| Page standards status: Trial-use | Maturity Level: 4 |
{
"resourceType" : "CapabilityStatement",
"id" : "sdc-form-receiver",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CapabilityStatement sdc-form-receiver</b></p><a name=\"sdc-form-receiver\"> </a><a name=\"hcsdc-form-receiver\"> </a><h2 id=\"title\">SDC Form Receiver</h2><ul><li>Implementation Guide Version: 4.0.0 </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>xml</code>, <code>json</code></li><li>Published on: 2014-07-06 </li><li>Published by: HL7 International / FHIR Infrastructure </li></ul><blockquote class=\"impl-note\"><p><strong>Note to Implementers: FHIR Capabilities</strong></p><p>Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.</p></blockquote><h2 id=\"rest\">FHIR RESTful Capabilities</h2><h3 id=\"rest1\">REST Configuration: 1 </h3><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"mode1\" class=\"panel-title\">Mode: <code>server</code></h4></div><div class=\"panel-body\"><div class=\"lead\"><em>Security</em></div><blockquote><div><p>Implementations must meet the <a href=\"security.html\">general security requirements</a> documented in this implementation guide.html.</p>\n</div></blockquote><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Summary of System-wide Operations</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Operation</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"OperationDefinition-Questionnaire-process-response.html\">$process-response</a></td><td><div><p>Allows submitting a completed form</p>\n</div></td></tr></tbody></table></div></div></div></div><h3 id=\"rest2\">REST Configuration: 2 </h3><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"mode2\" class=\"panel-title\">Mode: <code>client</code></h4></div><div class=\"panel-body\"/></div><h4 id=\"resourcesCap2\">Capabilities by Resource/Profile</h4><h5 id=\"resourcesSummary2\">Summary</h5><p>The summary table lists the resources that are part of this configuration, and for each resource it lists:</p><ul><li>The relevant profiles (if any)</li><li>The interactions supported by each resource (<b><span class=\"bg-info\">R</span></b>ead, <b><span class=\"bg-info\">S</span></b>earch, <b><span class=\"bg-info\">U</span></b>pdate, and <b><span class=\"bg-info\">C</span></b>reate, are always shown, while <b><span class=\"bg-info\">VR</span></b>ead, <b><span class=\"bg-info\">P</span></b>atch, <b><span class=\"bg-info\">D</span></b>elete, <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">I</span></b>nstance, or <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">T</span></b>ype are only present if at least one of the resources has support for them.</li><li><span>The required, recommended, and some optional search parameters (if any). </span></li><li>The linked resources enabled for <code>_include</code></li><li>The other resources enabled for <code>_revinclude</code></li><li>The operations on the resource (if any)</li></ul><div class=\"table-responsive\"><table class=\"table table-condensed table-hover\"><thead><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th class=\"text-center\"><b title=\"GET a resource (read interaction)\">R</b></th><th class=\"text-center\"><b title=\"GET all set of resources of the type (search interaction)\">S</b></th><th class=\"text-center\"><b title=\"PUT a new resource version (update interaction)\">U</b></th><th class=\"text-center\"><b title=\"POST a new resource (create interaction)\">C</b></th><th><b title=\"Required and recommended search parameters\">Searches</b></th><th><code><b>_include</b></code></th><th><code><b>_revinclude</b></code></th><th><b>Operations</b></th></tr></thead><tbody><tr><td><a href=\"#QuestionnaireResponse2-1\">QuestionnaireResponse</a></td><td><a href=\"StructureDefinition-sdc-questionnaireresponse.html\">http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaireresponse</a></td><td class=\"text-center\"/><td class=\"text-center\"/><td class=\"text-center\"/><td class=\"text-center\"/><td/><td/><td/><td><code>$extract</code></td></tr></tbody></table></div><hr/><div class=\"panel panel-default\"><div class=\"panel-heading\"><h5 id=\"QuestionnaireResponse2-1\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: MAY </span>QuestionnaireResponse</h5></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Base System Profile</span><br/><a href=\"StructureDefinition-sdc-questionnaireresponse.html\">SDC Standard Questionnaire Response</a></div><div class=\"col-lg-3\"><span class=\"lead\">Profile Conformance</span><br/><b>SHALL</b></div><div class=\"col-lg-3\"><span class=\"lead\">Reference Policy</span><br/></div></div><p/><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Interaction summary</span><br/><ul/></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>Perform operations based on the received response</p>\n</div></blockquote></div></div><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Extended Operations</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Operation</th><th>Documentation</th></tr></thead><tbody><tr><td><b>MAY</b></td><td><a href=\"OperationDefinition-QuestionnaireResponse-extract.html\">$extract</a></td><td><div><p>Convert completed form to resources</p>\n</div></td></tr></tbody></table></div></div></div></div></div></div>"
},
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "fhir"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 4,
"_valueInteger" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical" : "http://hl7.org/fhir/uv/sdc/ImplementationGuide/hl7.fhir.uv.sdc"
}
]
}
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use",
"_valueCode" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical" : "http://hl7.org/fhir/uv/sdc/ImplementationGuide/hl7.fhir.uv.sdc"
}
]
}
}
],
"url" : "http://hl7.org/fhir/uv/sdc/CapabilityStatement/sdc-form-receiver",
"version" : "4.0.0",
"name" : "SDCFormReceiver",
"title" : "SDC Form Receiver",
"status" : "active",
"date" : "2014-07-06",
"publisher" : "HL7 International / FHIR Infrastructure",
"contact" : [
{
"name" : "HL7 International / FHIR Infrastructure",
"telecom" : [
{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/fiwg"
}
]
},
{
"telecom" : [
{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/fiwg"
}
]
}
],
"description" : "This profile defines the expected capabilities of the *SDC Form Receiver* role when conforming to implementation guide. This role is responsible for accepting and processing completed and partially-completed forms. It only exposes a single operation endpoint - the one needed to 'process' a completed [[[QuestionnaireResponse]]]",
"jurisdiction" : [
{
"coding" : [
{
"system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code" : "001",
"display" : "World"
}
]
}
],
"kind" : "requirements",
"fhirVersion" : "4.0.1",
"format" : [
"xml",
"json"
],
"rest" : [
{
"mode" : "server",
"security" : {
"description" : "Implementations must meet the [general security requirements](security.html) documented in this implementation guide.html."
},
"operation" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "process-response",
"definition" : "http://hl7.org/fhir/uv/sdc/OperationDefinition/Questionnaire-process-response",
"documentation" : "Allows submitting a completed form"
}
]
},
{
"mode" : "client",
"resource" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"type" : "QuestionnaireResponse",
"profile" : "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaireresponse",
"documentation" : "Perform operations based on the received response",
"operation" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "extract",
"definition" : "http://hl7.org/fhir/uv/sdc/OperationDefinition/QuestionnaireResponse-extract",
"documentation" : "Convert completed form to resources"
}
]
}
]
}
]
}
IG © 2022+ HL7 International / FHIR Infrastructure. Package hl7.fhir.uv.sdc#4.0.0 based on FHIR 4.0.1. Generated 2025-09-18
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change