Generated Narrative: CapabilityStatement sdc-form-manager SDC Form Manager Implementation Guide Version: 4.0.0 FHIR Version: 4.0.1 Supported Formats: xml, json Published on: 2014-07-06 Published by: HL7 International / FHIR Infrastructure Note 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. This CapabilityStatement imports the CapabilityStatement SDC Form Fill Manager FHIR RESTful Capabilities Mode: server The primary focus is being able to create and update Questionnaires. However, creation and maintenance of ValueSets, CodeSystems, Librarys, and other associated resources is also potentially relevant, though in some cases these might be maintained on separate servers. Security Implementations must meet the general security requirements documented in this implementation guide.html. Capabilities by Resource/Profile Summary The summary table lists the resources that are part of this configuration, and for each resource it lists: The relevant profiles (if any) The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them. The required, recommended, and some optional search parameters (if any). The linked resources enabled for _include The other resources enabled for _revinclude The operations on the resource (if any) Resource Type Profile R S U C D Searches _include _revinclude Operations Questionnaire http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire Y Y Y Y definition, code, combo-code, assembled-from $assemble ValueSet http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-valueset Y Y Y Y status, reference, experimental, date, context-type-quantity, context-type-value, identifier, title, description, jurisdiction, publisher CodeSystem http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-codesystem Y Y Y Y status, content-mode, experimental, date, publisher, context-type-quantity, context-type-value, identifier, supplements, title, description, jurisdiction, language Library http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-library Y Y Y Y experimental, status, description, content-type, type, date, publisher, context-type-quantity, context-type-value, effective, title, jurisdiction StructureMap http://hl7.org/fhir/StructureDefinition/StructureMap Y Y Y Y experimental, status, source, target, date, publisher, context-type-quantity, context-type-value, title, description, jurisdiction StructureDefinition http://hl7.org/fhir/StructureDefinition/StructureDefinition Y Y Y Y experimental, status, type, derivation, kind, date, publisher, context-type-quantity, context-type-value, title, description, jurisdiction ConceptMap http://hl7.org/fhir/StructureDefinition/ConceptMap Y Y Y Y experimental, status, source-system, target-system, date, publisher, context-type-quantity, context-type-value, title, source-uri, target-uri, description, jurisdiction Resource Conformance: SHALL Questionnaire Base System Profile SDC Base Questionnaire Profile Conformance SHALL Reference Policy Interaction summary SHALL support read Allows retrieval of a resource before or after performing a create or update. create Allows defining a new form. Repositories requiring curation of submitted forms may require all new data elements to have a status of 'draft'. update 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. SHOULD support delete 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. Documentation Form mamagers are responsible for creating and updating forms. Search Parameters Conformance Parameter Type Documentation SHOULD definition uri SHOULD code token SHOULD combo-code token MAY assembled-from reference Extended Operations Conformance Operation Documentation MAY $assemble Needed as part of the authoring process if modular questionnaires are used and assembly isn't done locally Resource Conformance: SHALL ValueSet Base System Profile SDC Value Set Profile Conformance SHALL Reference Policy Interaction summary SHALL support read Allows retrieval of a resource before or after performing a create or update. create Allows definition of a new value set used by one or more questionnaires update Allows existing value sets referenced by one or more questionnaires to be maintained SHOULD support delete 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. Documentation Needed if Questionnaire valuesets will be stored on the form server as opposed to a separate terminology service. Search Parameters Conformance Parameter Type Documentation SHALL status token SHALL reference uri SHALL experimental token SHOULD date date SHOULD context-type-quantity composite SHOULD context-type-value composite SHOULD identifier token SHOULD title string MAY description string MAY jurisdiction token MAY publisher string Resource Conformance: SHOULD CodeSystem Base System Profile SDC Code System Profile Conformance SHALL Reference Policy Interaction summary SHALL support read Allows retrieval of a resource before or after performing a create or update. create Allows definition of a new code system used by one or more questionnaires update Allows existing code systems referenced by one or more questionnaires to be maintained SHOULD support delete Not all servers will support deletion of code systems. Status change to 'retired' will be more typical, though deletion of draft code systems may keep repositories cleaner. Documentation Needed if Questionnaire codes will be stored on the form server as opposed to a separate terminology service. Search Parameters Conformance Parameter Type Documentation SHALL status token SHALL content-mode token SHALL experimental token SHOULD date date SHOULD publisher string SHOULD context-type-quantity composite SHOULD context-type-value composite SHOULD identifier token SHOULD supplements reference SHOULD title string MAY description string MAY jurisdiction token MAY language token Resource Conformance: SHOULD Library Base System Profile SDC Library Profile Conformance SHALL Reference Policy Interaction summary SHALL support read Allows retrieval of details if search does not or after a create or update if the server makes changes create Allows definition of a new library used by one or more questions update Allows existing libraries referenced by a form to be maintained. Note that certain types of updates may necessitate retiring the existing library and defining a new one. SHOULD support delete Not all servers will support deletion of libraries. Status change to 'retired' will be more typical, though deletion of draft libraries may keep repositories cleaner. Documentation Allows managing libraries relevant to population, extraction, or other logic Search Parameters Conformance Parameter Type Documentation SHALL experimental token SHALL status token SHALL description string SHALL content-type token SHALL type token SHOULD date date SHOULD publisher string SHOULD context-type-quantity composite SHOULD context-type-value composite SHOULD effective date SHOULD title string MAY jurisdiction token Resource Conformance: MAY StructureMap Base System Profile StructureMap Profile Conformance SHALL Reference Policy Interaction summary SHALL support read Allows retrieval of details if search does not or after a create or update if the server makes changes create Allows definition of a new map for a form update Allows existing maps referenced by a form to be maintained. Note that certain types of updates may necessitate retiring the existing map and defining a new one. SHOULD support delete Not all servers will support deletion of maps. Status change to 'retired' will be more typical, though deletion of draft maps may keep repositories cleaner. Documentation Allows managing maps relevant to population or extraction Search Parameters Conformance Parameter Type Documentation SHALL experimental token SHALL status token SHALL source reference SHALL target reference SHOULD date date SHOULD publisher string SHOULD context-type-quantity composite SHOULD context-type-value composite SHOULD title string MAY description string MAY jurisdiction token Resource Conformance: MAY StructureDefinition Base System Profile StructureDefinition Profile Conformance SHALL Reference Policy Interaction summary SHALL support read Allows retrieval of details if search does not or after a create or update if the server makes changes create Allows definition of new structures for use with forms update Allows existing structures to be maintained. Note that certain types of updates may necessitate retiring the existing structure and defining a new one. SHOULD support delete Not all servers will support deletion of structures. Status change to 'retired' will be more typical, though deletion of draft structures may keep repositories cleaner. Documentation Allows managing structures relevant to map-based population and/or map-based or definition-based extraction Search Parameters Conformance Parameter Type Documentation SHALL experimental token SHALL status token SHALL type uri SHALL derivation token SHALL kind token SHOULD date date SHOULD publisher string SHOULD context-type-quantity composite SHOULD context-type-value composite SHOULD title string MAY description string MAY jurisdiction token Resource Conformance: MAY ConceptMap Base System Profile ConceptMap Profile Conformance SHALL Reference Policy Interaction summary SHALL support read Allows retrieval of details if search does not or after a create or update if the server makes changes create Allows definition of a new map for codes in a form update Allows existing maps used by forms to be maintained. Note that certain types of updates may necessitate retiring the existing map and defining a new one. SHOULD support delete Not all servers will support deletion of maps. Status change to 'retired' will be more typical, though deletion of draft maps may keep repositories cleaner. Documentation Allows managing code maps relevant to population or extraction Search Parameters Conformance Parameter Type Documentation SHALL experimental token SHALL status token SHALL source-system uri SHALL target-system uri SHALL source-uri reference SHALL target-uri reference SHOULD date date SHOULD publisher string SHOULD context-type-quantity composite SHOULD context-type-value composite SHOULD title string MAY description string MAY jurisdiction token
This profile defines the expected capabilities of the *SDC Form Manager* role when conforming to this implementation guide. This role builds on the [SDC Form Fill Manager](CapabilityStatement-sdc-form-fill-manager.html) by adding the ability to create and maintain Questionnaires and their associated resources.
The primary focus is being able to create and update [Questionnaire]s. However, creation and maintenance of [ValueSet]s, [CodeSystem]s, [Library]s, and other associated resources is also potentially relevant, though in some cases these might be maintained on separate servers.
Implementations must meet the [general security requirements](security.html) documented in this implementation guide.html.
Form mamagers are responsible for creating and updating forms.
Allows retrieval of a resource before or after performing a create or update.
Allows defining a new form. Repositories requiring curation of submitted forms may require all new data elements to have a status of 'draft'.
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.
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.
Needed as part of the authoring process if modular questionnaires are used and assembly isn't done locally
Needed if Questionnaire valuesets will be stored on the form server as opposed to a separate terminology service.
Allows definition of a new value set used by one or more questionnaires
Allows existing value sets referenced by one or more questionnaires to be maintained
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.
Needed if Questionnaire codes will be stored on the form server as opposed to a separate terminology service.
Allows definition of a new code system used by one or more questionnaires
Allows existing code systems referenced by one or more questionnaires to be maintained
Not all servers will support deletion of code systems. Status change to 'retired' will be more typical, though deletion of draft code systems may keep repositories cleaner.
Allows managing libraries relevant to population, extraction, or other logic
Allows retrieval of details if search does not or after a create or update if the server makes changes
Allows definition of a new library used by one or more questions
Allows existing libraries referenced by a form to be maintained. Note that certain types of updates may necessitate retiring the existing library and defining a new one.
Not all servers will support deletion of libraries. Status change to 'retired' will be more typical, though deletion of draft libraries may keep repositories cleaner.
Allows managing maps relevant to population or extraction
Allows definition of a new map for a form
Allows existing maps referenced by a form to be maintained. Note that certain types of updates may necessitate retiring the existing map and defining a new one.
Not all servers will support deletion of maps. Status change to 'retired' will be more typical, though deletion of draft maps may keep repositories cleaner.
Allows managing structures relevant to map-based population and/or map-based or definition-based extraction
Allows definition of new structures for use with forms
Allows existing structures to be maintained. Note that certain types of updates may necessitate retiring the existing structure and defining a new one.
Not all servers will support deletion of structures. Status change to 'retired' will be more typical, though deletion of draft structures may keep repositories cleaner.
Allows managing code maps relevant to population or extraction
Allows definition of a new map for codes in a form
Allows existing maps used by forms to be maintained. Note that certain types of updates may necessitate retiring the existing map and defining a new one.