{
"description": "This profile defines the expected capabilities of the ''SDC Form Filler'' role when conforming to the S&I Framework's [[index.html|Structured Data Capture FHIR implementation guide]]. This role is responsible for retrieving pre-defined forms, requesting pre-population of forms and/or auto-populating forms, guiding the user through verifying populated data and submitting completed or partially-completed forms.
Note that Form Fillers may also take on the role of [[CapabilityStatement-sdc-form-archiver.html|Form Archiver]] if they have a requirement to retain the completed version of a form (and potentially the source data that was used to complete it).",
"_filename": "CapabilityStatement-sdc-form-filler.json",
"package_name": "hl7.fhir.uv.sdc.r4",
"format": [ "xml", "json" ],
"date": "2014-07-06",
"publisher": "HL7 International - FHIR Infrastructure Work Group",
"fhirVersion": "1.0.0",
"jurisdiction": [ {
"coding": [ {
"code": "001",
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm"
} ]
} ],
"name": "SDCFormFiller",
"type": null,
"experimental": null,
"resourceType": "CapabilityStatement",
"title": "SDC Form Filler",
"package_version": "3.0.0",
"status": "draft",
"id": "84105d38-19c8-4072-80d0-6ac7340b07a9",
"kind": "requirements",
"url": "http://hl7.org/fhir/uv/sdc/CapabilityStatement/sdc-form-filler",
"version": "3.0.0",
"contact": [ {
"telecom": [ {
"value": "http://hl7.org/Special/committees/fiwg",
"system": "url"
} ]
} ],
"rest": [ {
"mode": "client",
"resource": [ {
"type": "Questionnaire",
"profile": "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire",
"interaction": [ {
"code": "search-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"documentation": "Allows discovery of existing questionnaires to be completed"
}, {
"code": "read",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"documentation": "Allows retrieval of a specific questionnaire by id. Allows systems to maintain a 'favorites' list of forms and retrieve them by id."
}, {
"code": "history-instance",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ],
"documentation": "Allows review of changes made to a questionnaire over time. Of interest to some systems, but probably not most."
}, {
"code": "vread",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ],
"documentation": "Allows retrieval of a historical version of a questionnaire. Most systems will make use of the current version only."
} ]
}, {
"type": "ValueSet",
"profile": "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-valueset",
"interaction": [ {
"code": "read",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"documentation": "Allows retrieval of a specific value set by id (as referenced in a Questionnaire)"
}, {
"code": "vread",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"documentation": "Allows retrieval of a specific version of a value set (as referenced in a Questionnaire)"
}, {
"code": "history-instance",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ],
"documentation": "Allows review of changes to a value set over time. Of interest to some systems, but probably not most."
} ]
}, {
"type": "CodeSystem",
"profile": "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-codesystem",
"interaction": [ {
"code": "read",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"documentation": "Allows retrieval of a specific code system by id (as referenced by a ValueSet used in a Questionnaire)"
}, {
"code": "vread",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"documentation": "Allows retrieval of a specific version of a code system (as referenced by a ValueSet used in a Questionnaire)"
}, {
"code": "history-instance",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ],
"documentation": "Allows review of changes to a code system over time. Of interest to some systems, but probably not most."
} ]
}, {
"type": "QuestionnaireResponse",
"profile": "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaireresponse",
"interaction": [ {
"code": "search-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"documentation": "Allows a user to search for existing completed or partially-completed forms. Generally used to find partially-completed forms for update."
}, {
"code": "read",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"documentation": "Allows retrieval of a specific QuestionnaireResponse by id."
}, {
"code": "create",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"documentation": "Allows recording a completed or partially-completed form"
}, {
"code": "update",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"documentation": "Allows updating an existing completed or partially-completed form. (Systems may place rules on who can update forms and under what circumstances.)"
}, {
"code": "delete",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"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."
}, {
"code": "history-instance",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"documentation": "Allows review of prior versions of an answer set - allows reversion to previously recorded versions"
} ]
}, {
"type": "DocumentReference",
"interaction": [ {
"code": "search-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"documentation": "Allows discovery of existing documents that may be included in a form pre-population request"
} ]
}, {
"type": "Binary",
"interaction": [ {
"code": "read",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"documentation": "Allows retrieval of a specific binary (as pointed to by a DocumentReference)"
}, {
"code": "vread",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ],
"documentation": "Allows retrieval of a historical version of a binary. In general, the most recent version would be appropriate, but some may prefer to use the specific version referenced by a DocumentReference."
} ]
} ],
"security": {
"description": "Implementations must meet the general security requirements documented in the [[security.html|SDC implementation guide]]."
},
"operation": [ {
"name": "expand",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/OperationDefinition/ValueSet-expand"
}, {
"name": "validate code",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/OperationDefinition/ValueSet-validate-code"
}, {
"name": "populate",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ],
"definition": "http://hl7.org/fhir/uv/sdc/OperationDefinition/Questionnaire-populate"
}, {
"name": "populatehtml",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ],
"definition": "http://hl7.org/fhir/uv/sdc/OperationDefinition/Questionnaire-populatehtml"
}, {
"name": "populatelink",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ],
"definition": "http://hl7.org/fhir/uv/sdc/OperationDefinition/Questionnaire-populatelink"
} ],
"documentation": "The [[Questionnaire]], [[ValueSet]] and [[CodeSystem]] resources are retrieved to allow the system to guide the user through the entry process. The [[Binary]] and [[DocumentReference]] resources allow the system to find existing clinical documents that can be within the pre-population process. (Support for retrieval operations on these resources is optional as the relevant CDA or FHIR structures may also be directly generated by the ''Form Filler'' itself.) Finally, the [[QuestionnaireResponse]] resource is used to record the populated form.
Note: Form Fillers that support the 'populate' operation will need to be capable of consuming and rendering a partially completed QuestionnaireResponse in the same manner as if they had retrieved such a QuestionnaireResponse from a ''Form Response Manager''"
} ]
}