KISIM Medical Report IG
0.1.0 - ci-build
CH
KISIM Medical Report IG - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: http://fhir.kisimdocs.ch/ig/KisimMedicalReport/OperationDefinition/operation-questionnaire-aggregate | Version: 0.1.0 | |||
| Draft as of 2025-04-24 | Computable Name: OperationQuestionnaireAggregate | |||
Returns a bundle of type searchset with the Questionnaire resources belonging to either the questionnaireId or the compoundId
The $aggregate operation allows a client system to receive a set of Questionnaires
either by questionnaireId or by compoundId.
A compound id is a KISIM internal id which represents a set of questionnaires which belong together
and as a set define a medical report. Since this information is not relevant to a client system which only needs
a set of Questionnaires, the $aggregate operation is available
The operation allows to either supply a questionnaireId or a compoundId.
If a questionnaireId is supplied, the server internally simply executes a read operation on
/Questionnaire/{questionnaireId}
and returns the found Questionnaire in a bundle with one entry.
The $aggregate method allows a client system to either supply a questionnaireId **OR** a compoundId. If both are provided, the server responds with "HTTP-Status 400, invalid request exception"
Generated Narrative: OperationDefinition operation-questionnaire-aggregate
URL: [base]/Questionnaire/$aggregate
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | questionnaireId | 0..1 | string (string) | Questionnaire ID to read. Same as a call to /Questionnaire/{questionnaireId} | ||
| IN | compoundId | 0..1 | string (string) | Compound ID to aggregate the Questionnaire resources to. |
[base]/Questionnaire/$aggregate?questionnaireId=123
[base]/Questionnaire/$aggregate?compoundId=123
As a response to the operation the client receives a Bundle with the found Questionnaires.