questionnaires
Create Questionnaire
post
/organizations/{organizationId}/fhir/3/Questionnaire
A structured set of questions intended to guide the collection of answers from end-users. Questionnaires provide detailed control over order, presentation, phraseology and grouping to allow coherent, consistent data collection.
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug |
Body
| resourceType* | string | Questionnaire | This is a Questionnaire resource |
| url | string | An absolute URI that is used to identify this questionnaire when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this questionnaire is (or will be) published. The URL SHOULD include the major version of the questionnaire. For more information see [Technical and Business Versions](resource.html#versions). | |
| identifier | array(Identifier) | A formal identifier that is used to identify this questionnaire when it is represented in other formats, or referenced in a specification, model, design or an instance. | |
| version | string | The identifier that is used to identify this version of the questionnaire when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the questionnaire author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. | |
| name | string | A natural language name identifying the questionnaire. This name should be usable as an identifier for the module by machine processing applications such as code generation. | |
| title | string | A short, descriptive, user-friendly title for the questionnaire. | |
| status | string | draft|active|retired|unknown | The status of this questionnaire. Enables tracking the life-cycle of the content. |
| experimental | boolean | A boolean value to indicate that this questionnaire is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage. | |
| date | string | The date (and optionally time) when the questionnaire was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the questionnaire changes. | |
| publisher | string | The name of the individual or organization that published the questionnaire. | |
| description | string | A free text natural language description of the questionnaire from a consumer's perspective. | |
| purpose | string | Explaination of why this questionnaire is needed and why it has been designed as it has. | |
| approvalDate | string | The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. | |
| lastReviewDate | string | The date on which the resource content was last reviewed. Review happens periodically after approval, but doesn't change the original approval date. | |
| effectivePeriod | Period | The period during which the questionnaire content was or is planned to be in active use. | |
| useContext | array(UsageContext) | The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate questionnaire instances. | |
| jurisdiction | array(CodeableConcept) | A legal or geographic region in which the questionnaire is intended to be used. | |
| contact | array(ContactDetail) | Contact details to assist a user in finding and communicating with the publisher. | |
| copyright | string | A copyright statement relating to the questionnaire and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the questionnaire. | |
| code | array(Coding) | An identifier for this question or group of questions in a particular terminology such as LOINC. | |
| subjectType | array() | The types of subjects that can be the subject of responses created for the questionnaire. | |
| item | array(Questionnaire_Item) | A particular question, question grouping or display text that is part of the questionnaire. |
Response
keyboard_arrow_down
Patch Questionnaire
patch
/organizations/{organizationId}/fhir/3/Questionnaire/{resourceId}
A structured set of questions intended to guide the collection of answers from end-users. Questionnaires provide detailed control over order, presentation, phraseology and grouping to allow coherent, consistent data collection.
Request
Headers
| content-type* | string | application/json-patch+json | application/json-patch+json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Body
| resourceType* | string | Questionnaire | This is a Questionnaire resource |
| url | string | An absolute URI that is used to identify this questionnaire when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this questionnaire is (or will be) published. The URL SHOULD include the major version of the questionnaire. For more information see [Technical and Business Versions](resource.html#versions). | |
| identifier | array(Identifier) | A formal identifier that is used to identify this questionnaire when it is represented in other formats, or referenced in a specification, model, design or an instance. | |
| version | string | The identifier that is used to identify this version of the questionnaire when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the questionnaire author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. | |
| name | string | A natural language name identifying the questionnaire. This name should be usable as an identifier for the module by machine processing applications such as code generation. | |
| title | string | A short, descriptive, user-friendly title for the questionnaire. | |
| status | string | draft|active|retired|unknown | The status of this questionnaire. Enables tracking the life-cycle of the content. |
| experimental | boolean | A boolean value to indicate that this questionnaire is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage. | |
| date | string | The date (and optionally time) when the questionnaire was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the questionnaire changes. | |
| publisher | string | The name of the individual or organization that published the questionnaire. | |
| description | string | A free text natural language description of the questionnaire from a consumer's perspective. | |
| purpose | string | Explaination of why this questionnaire is needed and why it has been designed as it has. | |
| approvalDate | string | The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. | |
| lastReviewDate | string | The date on which the resource content was last reviewed. Review happens periodically after approval, but doesn't change the original approval date. | |
| effectivePeriod | Period | The period during which the questionnaire content was or is planned to be in active use. | |
| useContext | array(UsageContext) | The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate questionnaire instances. | |
| jurisdiction | array(CodeableConcept) | A legal or geographic region in which the questionnaire is intended to be used. | |
| contact | array(ContactDetail) | Contact details to assist a user in finding and communicating with the publisher. | |
| copyright | string | A copyright statement relating to the questionnaire and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the questionnaire. | |
| code | array(Coding) | An identifier for this question or group of questions in a particular terminology such as LOINC. | |
| subjectType | array() | The types of subjects that can be the subject of responses created for the questionnaire. | |
| item | array(Questionnaire_Item) | A particular question, question grouping or display text that is part of the questionnaire. |
Response
keyboard_arrow_down
Read Questionnaire
get
/organizations/{organizationId}/fhir/3/Questionnaire/{resourceId}
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Response
keyboard_arrow_down
Read History Questionnaire
get
/organizations/{organizationId}/fhir/3/Questionnaire/{resourceId}/_history
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
| _count | string | ||
| _since | string |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Response
keyboard_arrow_down
Read Version Questionnaire
get
/organizations/{organizationId}/fhir/3/Questionnaire/{resourceId}/_history/{versionId}
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* | |||
| versionId* |
Response
keyboard_arrow_down
Remove Questionnaire
delete
/organizations/{organizationId}/fhir/3/Questionnaire/{resourceId}
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Response
keyboard_arrow_down
Search Get Questionnaire
get
/organizations/{organizationId}/fhir/3/Questionnaire
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
| _id | string | ||
| _language | string | ||
| code | string | ||
| date | string | ||
| description | string | ||
| effective | string | ||
| identifier | string | ||
| jurisdiction | string | ||
| name | string | ||
| publisher | string | ||
| status | string | ||
| title | string | ||
| url | string | ||
| version | string |
Params
| organizationId* | string|string | id|slug |
Response
keyboard_arrow_down
Search History Questionnaire
get
/organizations/{organizationId}/fhir/3/Questionnaire/_history
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
| _count | string | ||
| _since | string |
Params
| organizationId* | string|string | id|slug |
Response
keyboard_arrow_down
Search Post Questionnaire
post
/organizations/{organizationId}/fhir/3/Questionnaire/_search
A structured set of questions intended to guide the collection of answers from end-users. Questionnaires provide detailed control over order, presentation, phraseology and grouping to allow coherent, consistent data collection.
Request
Headers
| content-type* | string | application/json|application/x-www-form-urlencoded | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
| _id | string | ||
| _language | string | ||
| code | string | ||
| date | string | ||
| description | string | ||
| effective | string | ||
| identifier | string | ||
| jurisdiction | string | ||
| name | string | ||
| publisher | string | ||
| status | string | ||
| title | string | ||
| url | string | ||
| version | string |
Params
| organizationId* | string|string | id|slug |
Body
| resourceType* | string | Questionnaire | This is a Questionnaire resource |
| url | string | An absolute URI that is used to identify this questionnaire when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this questionnaire is (or will be) published. The URL SHOULD include the major version of the questionnaire. For more information see [Technical and Business Versions](resource.html#versions). | |
| identifier | array(Identifier) | A formal identifier that is used to identify this questionnaire when it is represented in other formats, or referenced in a specification, model, design or an instance. | |
| version | string | The identifier that is used to identify this version of the questionnaire when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the questionnaire author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. | |
| name | string | A natural language name identifying the questionnaire. This name should be usable as an identifier for the module by machine processing applications such as code generation. | |
| title | string | A short, descriptive, user-friendly title for the questionnaire. | |
| status | string | draft|active|retired|unknown | The status of this questionnaire. Enables tracking the life-cycle of the content. |
| experimental | boolean | A boolean value to indicate that this questionnaire is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage. | |
| date | string | The date (and optionally time) when the questionnaire was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the questionnaire changes. | |
| publisher | string | The name of the individual or organization that published the questionnaire. | |
| description | string | A free text natural language description of the questionnaire from a consumer's perspective. | |
| purpose | string | Explaination of why this questionnaire is needed and why it has been designed as it has. | |
| approvalDate | string | The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. | |
| lastReviewDate | string | The date on which the resource content was last reviewed. Review happens periodically after approval, but doesn't change the original approval date. | |
| effectivePeriod | Period | The period during which the questionnaire content was or is planned to be in active use. | |
| useContext | array(UsageContext) | The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate questionnaire instances. | |
| jurisdiction | array(CodeableConcept) | A legal or geographic region in which the questionnaire is intended to be used. | |
| contact | array(ContactDetail) | Contact details to assist a user in finding and communicating with the publisher. | |
| copyright | string | A copyright statement relating to the questionnaire and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the questionnaire. | |
| code | array(Coding) | An identifier for this question or group of questions in a particular terminology such as LOINC. | |
| subjectType | array() | The types of subjects that can be the subject of responses created for the questionnaire. | |
| item | array(Questionnaire_Item) | A particular question, question grouping or display text that is part of the questionnaire. |
Response
keyboard_arrow_down
Update Questionnaire
put
/organizations/{organizationId}/fhir/3/Questionnaire/{resourceId}
A structured set of questions intended to guide the collection of answers from end-users. Questionnaires provide detailed control over order, presentation, phraseology and grouping to allow coherent, consistent data collection.
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Body
| resourceType* | string | Questionnaire | This is a Questionnaire resource |
| url | string | An absolute URI that is used to identify this questionnaire when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this questionnaire is (or will be) published. The URL SHOULD include the major version of the questionnaire. For more information see [Technical and Business Versions](resource.html#versions). | |
| identifier | array(Identifier) | A formal identifier that is used to identify this questionnaire when it is represented in other formats, or referenced in a specification, model, design or an instance. | |
| version | string | The identifier that is used to identify this version of the questionnaire when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the questionnaire author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. | |
| name | string | A natural language name identifying the questionnaire. This name should be usable as an identifier for the module by machine processing applications such as code generation. | |
| title | string | A short, descriptive, user-friendly title for the questionnaire. | |
| status | string | draft|active|retired|unknown | The status of this questionnaire. Enables tracking the life-cycle of the content. |
| experimental | boolean | A boolean value to indicate that this questionnaire is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage. | |
| date | string | The date (and optionally time) when the questionnaire was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the questionnaire changes. | |
| publisher | string | The name of the individual or organization that published the questionnaire. | |
| description | string | A free text natural language description of the questionnaire from a consumer's perspective. | |
| purpose | string | Explaination of why this questionnaire is needed and why it has been designed as it has. | |
| approvalDate | string | The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. | |
| lastReviewDate | string | The date on which the resource content was last reviewed. Review happens periodically after approval, but doesn't change the original approval date. | |
| effectivePeriod | Period | The period during which the questionnaire content was or is planned to be in active use. | |
| useContext | array(UsageContext) | The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate questionnaire instances. | |
| jurisdiction | array(CodeableConcept) | A legal or geographic region in which the questionnaire is intended to be used. | |
| contact | array(ContactDetail) | Contact details to assist a user in finding and communicating with the publisher. | |
| copyright | string | A copyright statement relating to the questionnaire and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the questionnaire. | |
| code | array(Coding) | An identifier for this question or group of questions in a particular terminology such as LOINC. | |
| subjectType | array() | The types of subjects that can be the subject of responses created for the questionnaire. | |
| item | array(Questionnaire_Item) | A particular question, question grouping or display text that is part of the questionnaire. |
Response
keyboard_arrow_down