{ "resourceType" : "OperationDefinition", "id" : "cpg-planDefinition-questionnaire", "language" : "en", "text" : { "status" : "generated", "div" : "

Generated Narrative: OperationDefinition cpg-planDefinition-questionnaire

URL: [base]/PlanDefinition/$questionnaire

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

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INidentifier0..1Identifier

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

\n
INresource0..1PlanDefinition

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

\n
INurl0..1canonical (PlanDefinition)

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

\n
INsupportedOnly0..1boolean

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

\n
INminimalOnly0..1boolean

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

\n
INartifactEndpointConfiguration0..*

Configuration information to resolve canonical artifacts

\n

Processing Semantics:

\n

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

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

Rank each artifactEndpointConfiguration such that:

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

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

\n
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)

\n
INartifactEndpointConfiguration.endpointUri0..1uri

The URI of the endpoint, exclusive with the endpoint parameter

\n
INartifactEndpointConfiguration.endpoint0..1Endpoint

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

\n
OUTreturn1..1Questionnaire

The questionnaire form generated based on the PlanDefinition action.inputs

\n

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 that conforms to SDC Extractable Questionnaire and SDC Populatable Questionnaire - Expression based on the specified PlanDefinition 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:

\n
    \n
  1. The element is a part of the differential; or
    2. \n
  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. \n
  3. The element is not constrained by fixed[x] or pattern[x]
    4. \n
\n

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

\n
" }, "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", "valueCode" : "cds" }], "url" : "http://hl7.org/fhir/uv/cpg/OperationDefinition/cpg-planDefinition-questionnaire", "version" : "2.0.0", "name" : "CPGPlanDefinitionQuestionnaire", "title" : "CPG PlanDefinition Questionnaire", "status" : "active", "kind" : "operation", "experimental" : false, "date" : "2026-06-10T15:28:01+00:00", "publisher" : "HL7 International / Clinical Decision Support", "contact" : [{ "name" : "HL7 International / Clinical Decision Support", "telecom" : [{ "system" : "url", "value" : "http://www.hl7.org/Special/committees/dss" }] }], "description" : "Generates a Questionnaire instance based on a specified PlanDefinition, creating questionnaire group items for each data requirement (StructureDefinition) referenced by action.input. A child questionnaire item is generated for each of the StructureDefinition elements.", "jurisdiction" : [{ "coding" : [{ "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm", "code" : "001", "display" : "World" }] }], "code" : "questionnaire", "comment" : "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](https://hl7.org/fhir/R4/questionnaire.html) instance that conforms to [SDC Extractable Questionnaire](http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-extr-defn) and [SDC Populatable Questionnaire - Expression](http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-pop-exp) based on the specified [PlanDefinition](https://hl7.org/fhir/R4/plandefinition.html) and/or an [OperationOutcome](https://hl7.org/fhir/R4/operationoutcome.html) 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:\n1. The element is a part of the differential; or\n2. 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\n3. The element is not constrained by fixed[x] or pattern[x]\n\n\nOf note, supportedOnly is not recommended for use with minimalOnly within CPG. See [Questionnaire Processing Semantics](interactive-cds.html#questionnaire-generation-processing-semantics) for further details.", "resource" : ["PlanDefinition"], "system" : false, "type" : true, "instance" : true, "parameter" : [{ "name" : "identifier", "use" : "in", "min" : 0, "max" : "1", "documentation" : "A logical identifier (i.e. 'PlanDefinition.identifier'). The server must know the PlanDefinition or be able to retrieve it from other known repositories.", "type" : "Identifier" }, { "name" : "resource", "use" : "in", "min" : 0, "max" : "1", "documentation" : "The PlanDefinition is provided directly as part of the request. Servers may choose not to accept resources in this fashion", "type" : "PlanDefinition" }, { "name" : "url", "use" : "in", "min" : 0, "max" : "1", "documentation" : "The PlanDefinition's official URL (i.e. 'PlanDefinition.url'). The server must know the PlanDefinition or be able to retrieve it from other known repositories.", "type" : "canonical", "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/PlanDefinition"] }, { "name" : "supportedOnly", "use" : "in", "min" : 0, "max" : "1", "documentation" : "If true, the questionnaire will only include those elements marked as \"mustSupport='true'\" in the StructureDefinition.", "type" : "boolean" }, { "name" : "minimalOnly", "use" : "in", "min" : 0, "max" : "1", "documentation" : "If true, the questionnaire items are limited to the minimal set of elements from the StructureDefinition.", "type" : "boolean" }, { "name" : "artifactEndpointConfiguration", "use" : "in", "min" : 0, "max" : "*", "documentation" : "Configuration information to resolve canonical artifacts\n\nProcessing Semantics:\n\nCreate a canonical-like reference (e.g.\n`{canonical.url}|{canonical.version}` or similar extensions for non-canonical artifacts).\n\n* Given a single `artifactEndpointConfiguration`\n * When `artifactRoute` is present\n * And the canonical or artifact reference starts with the `artifactRoute` (up to and including the entire uri)\n * Then attempt to resolve with `endpointUri` or `endpoint`\n * When `artifactRoute` is not present\n * Then attempt to resolve with `endpointUri` or `endpoint`\n* Given multiple `artifactEndpointConfiguration`s\n * Then rank order each configuration (see below)\n * And attempt to resolve with `endpointUri` or `endpoint` in order until resolved\n\nRank each `artifactEndpointConfiguration` such that:\n* if `artifactRoute` is present *and* `artifactRoute` *starts with* canonical or artifact reference: rank based on number of matching characters\n* if `artifactRoute` is *not* present: include but rank lower\n\nNOTE: For evenly ranked `artifactEndpointConfiguration`s, order as defined in the\nOperationDefinition.", "part" : [{ "name" : "artifactRoute", "use" : "in", "min" : 0, "max" : "1", "documentation" : "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)", "type" : "uri" }, { "name" : "endpointUri", "use" : "in", "min" : 0, "max" : "1", "documentation" : "The URI of the endpoint, exclusive with the `endpoint` parameter", "type" : "uri" }, { "name" : "endpoint", "use" : "in", "min" : 0, "max" : "1", "documentation" : "An Endpoint resource describing the endpoint, exclusive with the `endpointUri` parameter", "type" : "Endpoint" }] }, { "name" : "return", "use" : "out", "min" : 1, "max" : "1", "documentation" : "The questionnaire form generated based on the PlanDefinition action.inputs", "type" : "Questionnaire" }] }