Clinical Practice Guidelines
2.0.0 - STU2 International flag

Clinical Practice Guidelines, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/cqf-recommendations/ and changes regularly. See the Directory of published versions

OperationDefinition: CPG StructureDefinition Questionnaire

Official URL: http://hl7.org/fhir/uv/cpg/OperationDefinition/cpg-structureDefinition-questionnaire Version: 2.0.0
Standards status: Trial-use Maturity Level: 5 Computable Name: CPGStructureDefinitionQuestionnaire
Other Identifiers: OID:2.16.840.1.113883.4.642.40.48.33.5

Generates a Questionnaire instance based on a specified StructureDefinition, creating questions for a minimal set of elements or extension elements found in the Structure Definition.

Language: en

URL: [base]/StructureDefinition/$questionnaire

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

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INidentifier0..1Identifier

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

INresource0..1StructureDefinition

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

INurl0..1canonical (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.

INsupportedOnly0..1boolean

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

INminimalOnly0..1boolean

If true, the questionnaire items are limited to the minimal set of elements from the StructureDefinition.

INartifactEndpointConfiguration0..*

Configuration information to resolve canonical artifacts

Processing Semantics:

Create a canonical-like reference (e.g. {canonical.url}|{canonical.version} or similar extensions for non-canonical artifacts).

  • Given a single artifactEndpointConfiguration
    • When artifactRoute is present
      • And the canonical or artifact reference starts with the artifactRoute (up to and including the entire uri)
      • Then attempt to resolve with endpointUri or endpoint
    • When artifactRoute is not present
      • Then attempt to resolve with endpointUri or endpoint
  • Given multiple artifactEndpointConfigurations
    • Then rank order each configuration (see below)
    • And attempt to resolve with endpointUri or endpoint in order until resolved

Rank each artifactEndpointConfiguration such that:

  • if artifactRoute is present and artifactRoute starts with canonical or artifact reference: rank based on number of matching characters
  • if artifactRoute is not present: include but rank lower

NOTE: For evenly ranked artifactEndpointConfigurations, order as defined in the OperationDefinition.

INartifactEndpointConfiguration.artifactRoute0..1uri

An optional route used to determine whether this endpoint is expected to be able to resolve artifacts that match the route (i.e. start with the route, up to and including the entire url)

INartifactEndpointConfiguration.endpointUri0..1uri

The URI of the endpoint, exclusive with the endpoint parameter

INartifactEndpointConfiguration.endpoint0..1Endpoint

An Endpoint resource describing the endpoint, exclusive with the endpointUri parameter

OUTreturn1..1Questionnaire

The questionnaire form generated based on 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 'minimalOnly' parameter is set to true, only minimal elements from the structure definition will be included. These are defined as:

  1. The element is a part of the differential; or
  2. The element is a part of the snapshot and has a cardinality of at least 1..* (min > 0). Nested child elements with min > 0 should also be included if parent has min > 0; and
  3. The element is not constrained by fixed[x] or pattern[x]

Of note, supportedOnly is not recommended for use with minimalOnly within CPG. See Questionnaire Processing Semantics for further details.