Structuredefinition-operation-questionnaire

Release 4B Ballot #1

This page is part of the FHIR Specification v4.1.0: R4B Ballot. About the R4B version of FHIR. The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4

5.3.12.1 Operation $questionnaire on StructureDefinition

FHIR Infrastructure

Work Group

Maturity Level: 5

Trial Use

Compartments: N/A

Generates a Questionnaire instance based on a specified StructureDefinition, creating questions for each core element or extension element found in the StructureDefinition.

If the operation is not called at the instance level, one of the identifier, profile or url 'in' parameters must be provided. If more than one is specified, servers may raise an error or may resolve with the parameter of their choice. If called at the instance level, these parameters will be ignored. The response will contain a Questionnaire instance based on the specified StructureDefinition and/or an OperationOutcome resource with errors or warnings. Nested groups are used to handle complex structures and data types. If the 'supportedOnly' parameter is set to true, only those elements marked as "must support" will be included.

This operation is intended to enable auto-generation of simple interfaces for arbitrary profiles. The 'questionnaire' approach to data entry has limitations that will make it less optimal than custom-defined interfaces. However, this function may be useful for simple applications or for systems that wish to support "non-core" resources with minimal development effort.

The official URL for this operation definition is

 http://hl7.org/fhir/OperationDefinition/StructureDefinition-questionnaire

Formal Definition (as a OperationDefinition).

URL: [base]/StructureDefinition/$questionnaire

URL: [base]/StructureDefinition/[id]/$questionnaire

This is an idempotent operation

In Parameters:

Name

Cardinality

Type

Binding

Profile

Documentation

identifier

0..1

canonical(StructureDefinition)

A logical identifier (i.e. 'StructureDefinition.identifier''). The server must know the StructureDefinition or be able to retrieve it from other known repositories.

profile

0..1

string
(token)

The StructureDefinition is provided directly as part of the request. Servers may choose not to accept profiles in this fashion

url

0..1

canonical(StructureDefinition)

The StructureDefinition's official URL (i.e. 'StructureDefinition.url'). The server must know the StructureDefinition or be able to retrieve it from other known repositories.

supportedOnly

0..1

boolean

If true, the questionnaire will only include those elements marked as "mustSupport='true'" in the StructureDefinition.

Out Parameters:

Name

Cardinality

Type

Binding

Profile

Documentation

return

1..1

Questionnaire

The questionnaire form generated based on the StructureDefinition.

Note: as this is the only out parameter, it is a resource, and it has the name 'return', the result of this operation is returned directly as a resource

Open Issue: Ideally, extensions should be populated in the generated Questionnaire that will support taking QuestionnaireResponse resources generated from the Questionnaire and turning them back into the appropriate resources.

5.3.12.1.1 Examples

Request:

GET /fhir/StructureDefinition/daf-patient/$questionnaire

Response:

HTTP/1.1 200 OK
[other headers]

See DAF Patient Questionnaire

For more information about operations, including how they are invoked, see Operations.