DSTU2 STU 3 Candidate
This page is part of the FHIR Specification (v1.0.2: DSTU 2). The current version which supercedes this version is

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see the Directory of published versions . For a full list of available versions, see the Directory of published versions . Page versions: . Page versions: R5 R4B R4 R3 R2

6.17.13 6.18.13 Resource StructureDefinition - Operations Resource StructureDefinition - Operations This resource has 1 operation associated with it:

This resource has 1 operation associated with it:

For more information about operations, including how they are invoked, see
$questionnaire Build Questionnaire Build Questionnaire

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

6.17.13.1 6.18.13.1 Build Questionnaire Build Questionnaire Generates a

Generates a Questionnaire instance based on a specified instance based on a specified StructureDefinition , creating questions for each core element or extension element found in the , 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 . If the operation is not called at the instance level, one of the identifier , , profile or 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 '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 instance based on the specified StructureDefinition and/or an 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. 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.

Formal Definition (as a Formal Definition (as a OperationDefinition ). URL: [base]/StructureDefinition/$questionnaire URL: [base]/StructureDefinition/[id]/$questionnaire

URL: [base]/StructureDefinition/$questionnaire

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

In Parameters: In Parameters:
Name Cardinality Type Binding Profile Documentation
identifier 0..1 ( uri

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

profile 0..1 ( string token )

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

url 0..1 ( uri

The profile's official URL (i.e. 'StructureDefinition.url'). The server must know the profile or be able to retrieve it from other known repositories. The profile's official URL (i.e. 'StructureDefinition.url'). The server must know the profile 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. If true, the questionnaire will only include those elements marked as "mustSupport='true'" in the StructureDefinition.

Out Parameters: Out Parameters:
Name Cardinality Type Binding Profile Documentation
return 1..1 Questionnaire

The questionnaire form generated based on the StructureDefinition. Note: as this 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 The questionnaire form generated based on the StructureDefinition.

Note: as this 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 Open Issue : Ideally, extensions should be populated in the generated Questionnaire that will support taking that will support taking QuestionnaireResponse resources generated from the Questionnaire and turning them back into the appropriate resources. resources generated from the Questionnaire and turning them back into the appropriate resources.

6.17.13.1.1 6.18.13.1.1 Examples Examples

Request: 

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

Response: 

HTTP/1.1 200 OK
[other headers]

See DAF Patient Questionnaire

  © HL7.org 2011+. FHIR DSTU2 (v1.0.2-7202) generated on Sat, Oct 24, 2015 07:44+1100. Links: Search