FHIR IG analytics| Package | hl7.fhir.uv.sdc |
| Resource Type | CapabilityStatement |
| Id | CapabilityStatement-sdc-form-archiver.json |
| FHIR Version | R4 |
| Source | https://build.fhir.org/ig/HL7/sdc/CapabilityStatement-sdc-form-archiver.html |
| URL | http://hl7.org/fhir/uv/sdc/CapabilityStatement/sdc-form-archiver |
| Version | 4.0.0 |
| Status | active |
| Date | 2015-09-03 |
| Name | SDCFormArchiver |
| Title | SDC Form Archiver |
| Realm | uv |
| Authority | hl7 |
| Description | This profile defines the expected capabilities of the *SDC Form Archiver* role when conforming to this implementation guide. This role is responsible for persisting (archiving) completed or partially completed forms [[[QuestionnaireResponse]]] resource instances). These instances may be submitted individually or in a bundle together with [[[Provenance]]] information providing details about the completion of the questionnaire response. In some cases [[[Binary]]] or [[[DocumentReference]]] resources might also be submitted to convey source information used in the population of the questionnaire response.
&$xa;The purpose of this role is to capture "work in progress" for archival reasons. There is no expectation that submitted form data is subsequently made available for retrieval (at least not in the same format), though it might be made available through out-of-band mechanisms. |
| Kind | requirements |
No resources found
| StructureDefinition | |
| sdc-questionnaireresponse | SDC Standard Questionnaire Response |
Note: links and images are rebased to the (stated) source
Generated Narrative: CapabilityStatement sdc-form-archiver
xml, jsonNote to Implementers: FHIR Capabilities
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.
clientThe QuestionnaireResponse may be sent as a single instance or as a FHIR Bundle also containing Provenance resources providing details on the sources of information. A Bundle submission might also include Binary and/or DocumentReference instances referring to the data used to populate the form. A Form Archiver must support persisting, searching and retrieving those resources.
Implementations must meet the general security requirements documented in this implementation guide.html.
transactioninteraction described as follows:Allows submission of a QuestionnaireResponse together with Provenance and other supporting resources as a single unit of work.
The summary table lists the resources that are part of this configuration, and for each resource it lists:
_include_revinclude| Resource Type | Profile | R | S | U | C | D | Searches | _include | _revinclude | Operations |
|---|---|---|---|---|---|---|---|---|---|---|
| QuestionnaireResponse | http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaireresponse | Y | Y | y? | ||||||
| Provenance | http://hl7.org/fhir/StructureDefinition/Provenance | Y |
createAllows archiving (storing) a completed or partially-completed form
updateAllows updating a previously archived form. (Systems may place rules on who can update forms and under what circumstances).
deleteAllows removal of an archived form from a repository. Note that the removal may be logical rather than physical. Some systems may have rules for who can remove a submitted response and under what circumstances.
The primary focus of a form archiver is storing QuestionnaireResponses.
createAllows submitting a Provenance record associated with a particular QuestionnaireResponse.
Captures metadata about the creation/changing of QuestionnaireResponses.
{
"resourceType": "CapabilityStatement",
"id": "sdc-form-archiver",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"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-archiver",
"version": "4.0.0",
"name": "SDCFormArchiver",
"title": "SDC Form Archiver",
"status": "active",
"date": "2015-09-03",
"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 Archiver* role when conforming to this implementation guide. This role is responsible for persisting (archiving) completed or partially completed forms [[[QuestionnaireResponse]]] resource instances). These instances may be submitted individually or in a bundle together with [[[Provenance]]] information providing details about the completion of the questionnaire response. In some cases [[[Binary]]] or [[[DocumentReference]]] resources might also be submitted to convey source information used in the population of the questionnaire response.
&$xa;The purpose of this role is to capture \"work in progress\" for archival reasons. There is no expectation that submitted form data is subsequently made available for retrieval (at least not in the same format), though it might be made available through out-of-band mechanisms.",
"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": "client",
"documentation": "The [[[QuestionnaireResponse]]] may be sent as a single instance or as a FHIR [[[Bundle]]] also containing [[[Provenance]]] resources providing details on the sources of information. A Bundle submission might also include [[[Binary]]] and/or [[[DocumentReference]]] instances referring to the data used to populate the form. A Form Archiver must support persisting, searching and retrieving those resources.",
"security": {
"description": "Implementations must meet the [general security requirements](security.html) documented in this implementation guide.html."
},
"resource": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"type": "QuestionnaireResponse",
"profile": "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaireresponse",
"documentation": "The primary focus of a form archiver is storing QuestionnaireResponses.",
"interaction": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"code": "create",
"documentation": "Allows archiving (storing) a completed or partially-completed form"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "update",
"documentation": "Allows updating a previously archived form. (Systems may place rules on who can update forms and under what circumstances)."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "delete",
"documentation": "Allows removal of an archived form from a repository. Note that the removal may be logical rather than physical. Some systems may have rules for who can remove a submitted response and under what circumstances."
}
],
"versioning": "versioned"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"type": "Provenance",
"profile": "http://hl7.org/fhir/StructureDefinition/Provenance",
"documentation": "Captures metadata about the creation/changing of QuestionnaireResponses.",
"interaction": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "create",
"documentation": "Allows submitting a Provenance record associated with a particular QuestionnaireResponse."
}
]
}
],
"interaction": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "transaction",
"documentation": "Allows submission of a [[[QuestionnaireResponse]]] together with [[[Provenance]]] and other supporting resources as a single unit of work."
}
]
}
]
}