QI-Core Implementation Guide
7.0.2 - STU 7

QI-Core Implementation Guide, published by HL7 International / Clinical Quality Information. This guide is not an authorized publication; it is the continuous build for version 7.0.2 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-qi-core/ and changes regularly. See the Directory of published versions

## Extension: CodeOptions - JSON Profile

Page standards status: Trial-use | Maturity Level: 1

JSON representation of the codeOptions extension.

Raw json | Download

    {
      "resourceType" : "StructureDefinition",
      "id" : "codeOptions",
      "text" : {
        "status" : "extensions",
        "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: StructureDefinition codeOptions</b></p><a name=\"codeOptions\"> </a><a name=\"hccodeOptions\"> </a><table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"border: 0px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;\"><tr style=\"border: 1px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top\"><th style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"The logical name of the element\">Name</a></th><th style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Information about the use of the element\">Flags</a></th><th style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Minimum and Maximum # of times the element can appear in the instance\">Card.</a></th><th style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px; width: 100px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Reference to the type of the element\">Type</a></th><th style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Additional information about the element\">Description &amp; Constraints</a><span style=\"float: right\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Legend for this format\"><img src=\"data:image/png;base64, \" alt=\"doco\" style=\"background-color: inherit\"/></a></span></th></tr><tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck1.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_element.gif\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-codeOptions-definitions.html#Extension\" title=\"A logical reference (i.e. a reference to ValueSet.url) to a value set/version that identifies a set of possible coded values used to convey a higher level concept that encompasses a list of candidate specializations when there is no formal code defined for that purpose. For example, the concept of COVID preventative medications can be expressed as a value set because there is no specific code representing that concept.\">Extension</a><a name=\"Extension\"> </a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..1</td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/extensibility.html#Extension\">Extension</a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">Url of a value set of activities</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_extension_simple.png\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Simple Extension\" class=\"hierarchy\"/> <a style=\"text-decoration:line-through; text-decoration:line-through\" href=\"StructureDefinition-codeOptions-definitions.html#Extension.extension\">extension</a><a name=\"Extension.extension\"> </a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"text-decoration:line-through\"/><span style=\"text-decoration:line-through\">0</span><span style=\"text-decoration:line-through\">..</span><span style=\"text-decoration:line-through\">0</span></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"font-style: italic\">Extension</span></td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_element.gif\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-codeOptions-definitions.html#Extension.url\">url</a><a name=\"Extension.url\"> </a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"opacity: 0.5\">1</span><span style=\"opacity: 0.5\">..</span><span style=\"opacity: 0.5\">1</span></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a style=\"opacity: 0.5; opacity: 0.5\" href=\"http://hl7.org/fhir/R4/datatypes.html#uri\">uri</a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"color: darkgreen\">&quot;http://hl7.org/fhir/StructureDefinition/codeOptions&quot;</span></td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck00.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_end.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-codeOptions-definitions.html#Extension.value[x]\">value[x]</a><a name=\"Extension.value_x_\"> </a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..<span style=\"opacity: 0.5\">1</span></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/references.html\">canonical</a>(<a href=\"http://hl7.org/fhir/R4/valueset.html\">ValueSet</a>)</td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"opacity: 0.5\">Value of extension</span></td></tr>\r\n<tr><td colspan=\"5\" class=\"hierarchy\"><br/><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Legend for this format\"><img src=\"data:image/png;base64, \" alt=\"doco\" style=\"background-color: inherit\"/> Documentation for this format</a></td></tr></table></div>"
      },
      "extension" : [
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
          "valueInteger" : 1
        },
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
          "valueCode" : "cqi"
        },
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
          "valueCode" : "trial-use"
        },
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
          "valueCode" : "can-bind"
        }
      ],
      "url" : "http://hl7.org/fhir/StructureDefinition/codeOptions",
      "version" : "7.0.2",
      "name" : "CodeOptions",
      "title" : "Code Options",
      "status" : "active",
      "experimental" : false,
      "date" : "2019-11-01T09:29:23+11:00",
      "publisher" : "HL7 International / Clinical Quality Information",
      "contact" : [
        {
          "name" : "Clinical Quality Information WG",
          "telecom" : [
            {
              "system" : "url",
              "value" : "http://www.hl7.org/Special/committees/cqi"
            }
          ]
        }
      ],
      "description" : "A logical reference (i.e. a reference to ValueSet.url) to a value set/version that identifies a set of possible coded values used to convey a higher level concept that encompasses a list of candidate specializations when there is no formal code defined for that purpose. For example, the concept of COVID preventative medications can be expressed as a value set because there is no specific code representing that concept.",
      "jurisdiction" : [
        {
          "coding" : [
            {
              "system" : "urn:iso:std:iso:3166",
              "code" : "US"
            }
          ]
        }
      ],
      "purpose" : "This extension supports specifying the focus of an activity as a set of possible codes when there is no specific code available that captures the candidate activities.",
      "fhirVersion" : "4.0.1",
      "mapping" : [
        {
          "identity" : "v2",
          "uri" : "http://hl7.org/v2",
          "name" : "HL7 v2 Mapping"
        },
        {
          "identity" : "rim",
          "uri" : "http://hl7.org/v3",
          "name" : "RIM Mapping"
        }
      ],
      "kind" : "complex-type",
      "abstract" : false,
      "context" : [
        {
          "type" : "element",
          "expression" : "CodeableConcept"
        }
      ],
      "type" : "Extension",
      "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Extension",
      "derivation" : "constraint",
      "snapshot" : {
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
            "valueString" : "4.0.1"
          }
        ],
        "element" : [
          {
            "id" : "Extension",
            "path" : "Extension",
            "short" : "Url of a value set of activities",
            "definition" : "A logical reference (i.e. a reference to ValueSet.url) to a value set/version that identifies a set of possible coded values used to convey a higher level concept that encompasses a list of candidate specializations when there is no formal code defined for that purpose. For example, the concept of COVID preventative medications can be expressed as a value set because there is no specific code representing that concept.",
            "comment" : "This extension SHALL NOT be used when an appropriate higher level concept code exists. When this extension is used on an element with a required binding, the set of possible coded values in the referenced value set SHALL be present in the bound value set. When used with an extensible binding, the set of possible coded values in the referenced value set SHALL be present in the bound value set unless none of the codes in the bound value set apply to the concept being communicated (based on human review). When this extension appears on a CodeableConcept, the CodeableConcept SHALL have no codings, and the text of the CodeableConcept SHALL include the title of the referenced value set.",
            "min" : 0,
            "max" : "1",
            "base" : {
              "path" : "Extension",
              "min" : 0,
              "max" : "*"
            },
            "condition" : [
              "ele-1"
            ],
            "constraint" : [
              {
                "key" : "ele-1",
                "severity" : "error",
                "human" : "All FHIR elements must have a @value or children",
                "expression" : "hasValue() or (children().count() > id.count())",
                "xpath" : "@value|f:*|h:div",
                "source" : "http://hl7.org/fhir/StructureDefinition/Element"
              },
              {
                "key" : "ext-1",
                "severity" : "error",
                "human" : "Must have either extensions or value[x], not both",
                "expression" : "extension.exists() != value.exists()",
                "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
                "source" : "http://hl7.org/fhir/StructureDefinition/Extension"
              }
            ],
            "isModifier" : false,
            "mapping" : [
              {
                "identity" : "v2",
                "map" : "CWE."
              },
              {
                "identity" : "rim",
                "map" : "CD.valueSet/CD.valueSetVersion"
              }
            ]
          },
          {
            "id" : "Extension.id",
            "path" : "Extension.id",
            "representation" : [
              "xmlAttr"
            ],
            "short" : "Unique id for inter-element referencing",
            "definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
            "min" : 0,
            "max" : "1",
            "base" : {
              "path" : "Element.id",
              "min" : 0,
              "max" : "1"
            },
            "type" : [
              {
                "extension" : [
                  {
                    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
                    "valueUrl" : "string"
                  }
                ],
                "code" : "http://hl7.org/fhirpath/System.String"
              }
            ],
            "isModifier" : false,
            "isSummary" : false,
            "mapping" : [
              {
                "identity" : "rim",
                "map" : "n/a"
              }
            ]
          },
          {
            "id" : "Extension.extension",
            "path" : "Extension.extension",
            "slicing" : {
              "discriminator" : [
                {
                  "type" : "value",
                  "path" : "url"
                }
              ],
              "description" : "Extensions are always sliced by (at least) url",
              "rules" : "open"
            },
            "short" : "Extension",
            "definition" : "An Extension",
            "min" : 0,
            "max" : "0",
            "base" : {
              "path" : "Element.extension",
              "min" : 0,
              "max" : "*"
            },
            "type" : [
              {
                "code" : "Extension"
              }
            ],
            "constraint" : [
              {
                "key" : "ele-1",
                "severity" : "error",
                "human" : "All FHIR elements must have a @value or children",
                "expression" : "hasValue() or (children().count() > id.count())",
                "xpath" : "@value|f:*|h:div",
                "source" : "http://hl7.org/fhir/StructureDefinition/Element"
              },
              {
                "key" : "ext-1",
                "severity" : "error",
                "human" : "Must have either extensions or value[x], not both",
                "expression" : "extension.exists() != value.exists()",
                "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
                "source" : "http://hl7.org/fhir/StructureDefinition/Extension"
              }
            ],
            "isModifier" : false,
            "isSummary" : false
          },
          {
            "id" : "Extension.url",
            "path" : "Extension.url",
            "representation" : [
              "xmlAttr"
            ],
            "short" : "identifies the meaning of the extension",
            "definition" : "Source of the definition for the extension code - a logical name or a URL.",
            "comment" : "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
            "min" : 1,
            "max" : "1",
            "base" : {
              "path" : "Extension.url",
              "min" : 1,
              "max" : "1"
            },
            "type" : [
              {
                "extension" : [
                  {
                    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
                    "valueUrl" : "uri"
                  }
                ],
                "code" : "http://hl7.org/fhirpath/System.String"
              }
            ],
            "fixedUri" : "http://hl7.org/fhir/StructureDefinition/codeOptions",
            "isModifier" : false,
            "isSummary" : false,
            "mapping" : [
              {
                "identity" : "rim",
                "map" : "N/A"
              }
            ]
          },
          {
            "id" : "Extension.value[x]",
            "path" : "Extension.value[x]",
            "label" : "value set",
            "short" : "Value of extension",
            "definition" : "Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R4/extensibility.html) for a list).",
            "min" : 1,
            "max" : "1",
            "base" : {
              "path" : "Extension.value[x]",
              "min" : 0,
              "max" : "1"
            },
            "type" : [
              {
                "code" : "canonical",
                "targetProfile" : [
                  🔗 "http://hl7.org/fhir/StructureDefinition/ValueSet"
                ]
              }
            ],
            "constraint" : [
              {
                "key" : "ele-1",
                "severity" : "error",
                "human" : "All FHIR elements must have a @value or children",
                "expression" : "hasValue() or (children().count() > id.count())",
                "xpath" : "@value|f:*|h:div",
                "source" : "http://hl7.org/fhir/StructureDefinition/Element"
              }
            ],
            "isModifier" : false,
            "isSummary" : false,
            "mapping" : [
              {
                "identity" : "rim",
                "map" : "N/A"
              }
            ]
          }
        ]
      },
      "differential" : {
        "element" : [
          {
            "id" : "Extension",
            "path" : "Extension",
            "short" : "Url of a value set of activities",
            "definition" : "A logical reference (i.e. a reference to ValueSet.url) to a value set/version that identifies a set of possible coded values used to convey a higher level concept that encompasses a list of candidate specializations when there is no formal code defined for that purpose. For example, the concept of COVID preventative medications can be expressed as a value set because there is no specific code representing that concept.",
            "comment" : "This extension SHALL NOT be used when an appropriate higher level concept code exists. When this extension is used on an element with a required binding, the set of possible coded values in the referenced value set SHALL be present in the bound value set. When used with an extensible binding, the set of possible coded values in the referenced value set SHALL be present in the bound value set unless none of the codes in the bound value set apply to the concept being communicated (based on human review). When this extension appears on a CodeableConcept, the CodeableConcept SHALL have no codings, and the text of the CodeableConcept SHALL include the title of the referenced value set.",
            "min" : 0,
            "max" : "1",
            "isModifier" : false,
            "mapping" : [
              {
                "identity" : "v2",
                "map" : "CWE."
              },
              {
                "identity" : "rim",
                "map" : "CD.valueSet/CD.valueSetVersion"
              }
            ]
          },
          {
            "id" : "Extension.extension",
            "path" : "Extension.extension",
            "max" : "0"
          },
          {
            "id" : "Extension.url",
            "path" : "Extension.url",
            "fixedUri" : "http://hl7.org/fhir/StructureDefinition/codeOptions"
          },
          {
            "id" : "Extension.value[x]",
            "path" : "Extension.value[x]",
            "label" : "value set",
            "min" : 1,
            "type" : [
              {
                "code" : "canonical",
                "targetProfile" : [
                  🔗 "http://hl7.org/fhir/StructureDefinition/ValueSet"
                ]
              }
            ]
          }
        ]
      }
    }