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

OperationDefinition: Search Document Resources

Official URL: http://fhir.kisimdocs.ch/ig/KisimMedicalReport/OperationDefinition/operation-medical-report Version: 0.1.0
Draft as of 2025-04-24 Computable Name: OperationMedicalReport

Returns a bundle of type collection containing all the resources needed to create a medical report document

Overview

The $medical-report operation allows a client system to receive a set of resources which can be used to build the required document Bundle for submitting structured data.

What is a compound ID?

See here

Parameters

The following parameters can be submitted. The client system should have received them when it was invoked.

  • encounterId
  • questionnaireId
  • compoundId
  • reportId

The $medical-report 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"

The $medical-report method allows a client to provide a compositionId. If a compositionId is provided, a reportId **MUST** be provided.

Generated Narrative: OperationDefinition operation-medical-report

URL: [base]/Bundle/$medical-report

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INquestionnaireId0..1string
(string)

Questionnaire ID to add to the bundle. Same as a call to /Questionnaire/{questionnaireId}

INcompoundId0..1string
(string)

Compound ID which represents a set of Questionnaires. The Questionnaires are added to the Bundle

INencounterId1..1string
(string)

Encounter ID which is mandatory and produces an Encounter resource added to the bundle

INreportId0..1string
(string)

Report ID, which if set, adds a specific identifier to the bundle. This identifier needs to be returned with the document bundle

Notes:

Example calls

With Questionnaire id:

/Bundle/$medical-report?questionnaireId={questionnaireId}&encounterId={encounterId}

With compoundId and reportId:

/Bundle/$medical-report?compoundId={compoundId}&reportId={reportId}&encounterId={encounterId}

Response

As a response the client receives a Bundle of type collection, containg an identifier and a set of resources. The response Bundle is built in this way to make it easy for a client to transform it into a valid document Bundle.

Resources inside the response

The following resources will be created

Composition

A Composition resource which can be used inside the document bundle. It contains all the mandatory fields needed to correctly validate against a FHIR-Server.

Practitioner

The Composition resource, when used in a Document-Bundle, needs to contain an author. The author of the Document usually is a Practitioner or an Organization. In case of this IG we use the User who called the $medical-report operation.

Encounter

The Encounter resource which is identified by the encounterId. If no encounter is found under this ID, the $medical-report operation will return an error.

Questionnaire(s)

All the Questionnaires belonging either to questionnaireId or compoundId. The $medical-report operation aggregates those Questionnaires with the $aggregate operation internally.

Identifier of the Bundle

The created bundle will contain a single identifier. This identifier must be used inside the document bundle again.

The identifier contains the reportId when it was provided.