This section outlines conformance requirements for the Argonaut Questionnaire Assessment-Bank Server. It is responsible for storing Questionnaires and providing responses to the requests submitted by the Form Author/Editor and Provider EHRs. The Argonaut Questionnaire Profile and the various interactions outlined in this guide are the RESTful artifacts and interactions that it supports. Note that the Argonaut Profiles identify the structural constraints, terminology bindings and invariants and the individual Argonaut SearchParameter resources define the definitions, comparators, modifiers and usage constraints.
The Argonaut questionnaire Assessment-Bank SHALL:
The Argonaut questionnaire Assessment-Bank SHOULD:
Security:
For general security consideration refer to the Security and Privacy Considerations.
Summary of Search Criteria
Resource Type | Supported Profiles | Supported Searches | Supported Includes |
---|---|---|---|
Questionnaire | _id, url, status, title, publisher, version, context-type-value, context-type-value+publisher, context-type-value+publisher+status, context-type-value+status, publisher+status, publisher+status+version, publisher+version, status+title, status+title+version, status+version, title+version |
Supported Profiles:
Argonaut Questionnaire Profile
Reference Policy: resolves
Versioning Policy: versioned
Profile Interaction Summary:
create
,
search-type
,
read
,
vread
,
update
,
delete
,
history-instance
.patch
,
history-type
.Fetch and Search Criteria:
GET [base]/Questionnaire/[id]
Search Parameter Summary:
Conformance | Parameter | Type | Example |
---|---|---|---|
SHALL | _id | token | GET [base]/Questionnaire?_id=[id] |
SHALL | url | uri | GET [base]/Questionnaire?url=[uri] |
SHALL | status | token | GET [base]/Questionnaire?status=[status] |
SHALL | title | string | GET [base]/Questionnaire?title=[title] |
SHALL | publisher | string | GET [base]/Questionnaire?publisher=[publisher] |
SHOULD | version | token | GET [base]/Questionnaire?version=[system]|[code] |
SHOULD | context-type-value | composite | GET [base]/Questionnaire?context-type-value=[code]&[value] |
Search Parameter Combination Summary:
Conformance | Parameter Combination | Example |
---|---|---|
SHOULD | context-type-value+publisher | GET [base]/Questionnaire?context-type-value=[code]&[value]&publisher=[publisher] |
SHOULD | context-type-value+publisher+status | GET [base]/Questionnaire?context-type-value=[code]&[value]&publisher=[publisher]&status=[status] |
SHOULD | context-type-value+status | GET [base]/Questionnaire?context-type-value=[code]&[value]&status=[status] |
SHALL | publisher+status | GET [base]/Questionnaire?publisher=[publisher]&status=[status] |
SHOULD | publisher+status+version | GET [base]/Questionnaire?publisher=[publisher]&status=[status]&version=[system]|[code] |
SHOULD | publisher+version | GET [base]/Questionnaire?publisher=[publisher]&version=[system]|[code] |
SHALL | status+title | GET [base]/Questionnaire?status=[status]&title=[title] |
SHOULD | status+title+version | GET [base]/Questionnaire?status=[status]&title=[title]&version=[system]|[code] |
SHOULD | status+version | GET [base]/Questionnaire?status=[status]&version=[system]|[code] |
SHOULD | title+version | GET [base]/Questionnaire?title=[title]&version=[system]|[code] |