SIMPLIFIER.NET - FHIRPath Playground

FHIRPath

If you Log in or sign up, you can edit this script yourself.

name

{
  "derivation": "specialization",
  "fhirVersion": "4.3.0",
  "name": "ViewDefinition",
  "abstract": false,
  "type": "ViewDefinition",
  "resourceType": "StructureDefinition",
  "status": "active",
  "id": "ViewDefinition",
  "kind": "resource",
  "url": "http://hl7.org/fhir/uv/sql-on-fhir/StructureDefinition/ViewDefinition",
  "version": "0.2601.0",
  "differential": {
    "element": [
      {
        "id": "ViewDefinition",
        "path": "ViewDefinition",
        "min": 0,
        "max": "*"
      },
      {
        "id": "ViewDefinition.url",
        "path": "ViewDefinition.url",
        "short": "Canonical identifier for this view definition, represented as a URI (globally unique)",
        "definition": "Canonical identifier for this view definition, represented as a URI (globally unique)",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "uri"
          }
        ]
      },
      {
        "id": "ViewDefinition.identifier",
        "path": "ViewDefinition.identifier",
        "short": "Additional identifier for the view definition",
        "definition": "Additional identifier for the view definition",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Identifier"
          }
        ]
      },
      {
        "id": "ViewDefinition.name",
        "path": "ViewDefinition.name",
        "short": "Name of view definition (computer and database friendly)",
        "definition": "Name of the view definition, must be in a database-friendly format.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ],
        "constraint": [
          {
            "key": "sql-name",
            "severity": "error",
            "human": "Name must match ^[A-Za-z][A-Za-z0-9_]*$ (letters, numbers, or underscores; cannot start with underscore).",
            "expression": "empty() or matches('^[A-Za-z][A-Za-z0-9_]*$')"
          }
        ]
      },
      {
        "id": "ViewDefinition.title",
        "path": "ViewDefinition.title",
        "short": "Name for this view definition (human friendly)",
        "definition": "A optional human-readable description of the view.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "ViewDefinition.meta",
        "path": "ViewDefinition.meta",
        "short": "Metadata about the view definition",
        "definition": "Metadata about the view definition",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Meta"
          }
        ]
      },
      {
        "id": "ViewDefinition.status",
        "path": "ViewDefinition.status",
        "short": "draft | active | retired | unknown",
        "definition": "draft | active | retired | unknown",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ],
        "binding": {
          "strength": "required",
          "valueSet": "http://hl7.org/fhir/ValueSet/publication-status"
        }
      },
      {
        "id": "ViewDefinition.experimental",
        "path": "ViewDefinition.experimental",
        "short": "For testing purposes, not real usage",
        "definition": "For testing purposes, not real usage",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "boolean"
          }
        ]
      },
      {
        "id": "ViewDefinition.publisher",
        "path": "ViewDefinition.publisher",
        "short": "Name of the publisher/steward (organization or individual)",
        "definition": "Name of the publisher/steward (organization or individual)",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "ViewDefinition.contact",
        "path": "ViewDefinition.contact",
        "short": "Contact details for the publisher",
        "definition": "Contact details for the publisher",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "ContactDetail"
          }
        ]
      },
      {
        "id": "ViewDefinition.description",
        "path": "ViewDefinition.description",
        "short": "Natural language description of the view definition",
        "definition": "Natural language description of the view definition",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "markdown"
          }
        ]
      },
      {
        "id": "ViewDefinition.useContext",
        "path": "ViewDefinition.useContext",
        "short": "The context that the content is intended to support",
        "definition": "The context that the content is intended to support",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "UsageContext"
          }
        ]
      },
      {
        "id": "ViewDefinition.copyright",
        "path": "ViewDefinition.copyright",
        "short": "Use and/or publishing restrictions",
        "definition": "Use and/or publishing restrictions",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "markdown"
          }
        ]
      },
      {
        "id": "ViewDefinition.resource",
        "path": "ViewDefinition.resource",
        "short": "FHIR resource for the ViewDefinition",
        "definition": "The FHIR resource that the view is based upon, e.g. 'Patient' or 'Observation'.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ],
        "binding": {
          "strength": "required",
          "valueSet": "http://hl7.org/fhir/ValueSet/resource-types"
        }
      },
      {
        "id": "ViewDefinition.fhirVersion",
        "path": "ViewDefinition.fhirVersion",
        "short": "FHIR version(s) of the resource for the ViewDefinition",
        "definition": "The FHIR version(s) for the FHIR resource. The value of this element is the\nformal version of the specification, without the revision number, e.g.\n[publication].[major].[minor].",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "code"
          }
        ],
        "binding": {
          "strength": "required",
          "valueSet": "http://hl7.org/fhir/ValueSet/FHIR-version"
        }
      },
      {
        "id": "ViewDefinition.constant",
        "path": "ViewDefinition.constant",
        "short": "Constant that can be used in FHIRPath expressions",
        "definition": "A constant is a value that is injected into a FHIRPath expression through the use of a FHIRPath\nexternal constant with the same name.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "BackboneElement"
          }
        ]
      },
      {
        "id": "ViewDefinition.constant.name",
        "path": "ViewDefinition.constant.name",
        "short": "Name of constant (referred to in FHIRPath as %[name])",
        "definition": "Name of constant (referred to in FHIRPath as %[name])",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ],
        "constraint": [
          {
            "key": "sql-name",
            "severity": "error",
            "human": "Name must match ^[A-Za-z][A-Za-z0-9_]*$ (letters, numbers, or underscores; cannot start with underscore).",
            "expression": "empty() or matches('^[A-Za-z][A-Za-z0-9_]*$')"
          }
        ]
      },
      {
        "id": "ViewDefinition.constant.value[x]",
        "path": "ViewDefinition.constant.value[x]",
        "short": "Value of constant",
        "definition": "The value that will be substituted in place of the constant reference. This\nis done by including `%your_constant_name` in a FHIRPath expression, which effectively converts\nthe FHIR literal defined here to a FHIRPath literal used in the path expression.\n\nSupport for additional types may be added in the future.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "base64Binary"
          },
          {
            "code": "boolean"
          },
          {
            "code": "canonical"
          },
          {
            "code": "code"
          },
          {
            "code": "date"
          },
          {
            "code": "dateTime"
          },
          {
            "code": "decimal"
          },
          {
            "code": "id"
          },
          {
            "code": "instant"
          },
          {
            "code": "integer"
          },
          {
            "code": "oid"
          },
          {
            "code": "positiveInt"
          },
          {
            "code": "string"
          },
          {
            "code": "time"
          },
          {
            "code": "unsignedInt"
          },
          {
            "code": "uri"
          },
          {
            "code": "url"
          },
          {
            "code": "uuid"
          }
        ]
      },
      {
        "id": "ViewDefinition.where",
        "path": "ViewDefinition.where",
        "short": "A series of zero or more FHIRPath constraints to filter resources for the view.",
        "definition": "A series of zero or more FHIRPath constraints to filter resources for the view. Every constraint\nmust evaluate to true for the resource to be included in the view.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "BackboneElement"
          }
        ]
      },
      {
        "id": "ViewDefinition.where.path",
        "path": "ViewDefinition.where.path",
        "short": "A FHIRPath expression defining a filter condition",
        "definition": "A FHIRPath expression that defines a filter that must evaluate to true for a resource to be\nincluded in the output. The input context is the collection of resources of the type specified in\nthe resource element. Constants defined in Reference({constant}) can be referenced as %[name].",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "ViewDefinition.where.description",
        "path": "ViewDefinition.where.description",
        "short": "A human-readable description of the above where constraint.",
        "definition": "A human-readable description of the above where constraint.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "ViewDefinition.select",
        "path": "ViewDefinition.select",
        "short": "A collection of columns and nested selects to include in the view.",
        "definition": "The select structure defines the columns to be used in the resulting view. These are expressed\nin the `column` structure below, or in nested `select`s for nested resources.",
        "min": 1,
        "max": "*",
        "type": [
          {
            "code": "BackboneElement"
          }
        ],
        "constraint": [
          {
            "key": "sql-expressions",
            "severity": "error",
            "human": "Can only have at most one of `forEach`, `forEachOrNull`, or `repeat`.",
            "expression": "select((forEach.exists().toInteger() + forEachOrNull.exists().toInteger() + repeat.exists().toInteger())) <= 1"
          }
        ]
      },
      {
        "id": "ViewDefinition.select.column",
        "path": "ViewDefinition.select.column",
        "short": "A column to be produced in the resulting table.",
        "definition": "A column to be produced in the resulting table. The column is relative to the select structure\nthat contains it.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "BackboneElement"
          }
        ]
      },
      {
        "id": "ViewDefinition.select.column.path",
        "path": "ViewDefinition.select.column.path",
        "short": "FHIRPath expression that creates a column and defines its content",
        "definition": "A FHIRPath expression that evaluates to the value that will be output in the column for each \nresource. The input context is the collection of resources of the type specified in the resource \nelement. Constants defined in Reference({constant}) can be referenced as %[name].",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "ViewDefinition.select.column.name",
        "path": "ViewDefinition.select.column.name",
        "short": "Column name produced in the output",
        "definition": "Name of the column produced in the output, must be in a database-friendly format. The column \nnames in the output must not have any duplicates.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ],
        "constraint": [
          {
            "key": "sql-name",
            "severity": "error",
            "human": "Name must match ^[A-Za-z][A-Za-z0-9_]*$ (letters, numbers, or underscores; cannot start with underscore).",
            "expression": "empty() or matches('^[A-Za-z][A-Za-z0-9_]*$')"
          }
        ]
      },
      {
        "id": "ViewDefinition.select.column.type",
        "path": "ViewDefinition.select.column.type",
        "short": "A FHIR StructureDefinition URI for the column's type.",
        "definition": "A FHIR StructureDefinition URI for the column's type. Relative URIs are implicitly given\nthe 'http://hl7.org/fhir/StructureDefinition/' prefix. The URI may also use FHIR element ID notation to indicate\na backbone element within a structure. For instance, `Observation.referenceRange` may be specified to indicate\nthe returned type is that backbone element.\n\nThis field *must* be provided if a ViewDefinition returns a non-primitive type. Implementations should report an error\nif the returned type does not match the type set here, or if a non-primitive type is returned but this field is unset.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "uri"
          }
        ]
      },
      {
        "id": "ViewDefinition.select.column.collection",
        "path": "ViewDefinition.select.column.collection",
        "short": "Indicates whether the column may have multiple values.",
        "definition": "Indicates whether the column may have multiple values. Defaults to `false` if unset.\n\nViewDefinitions must have this set to `true` if multiple values may be returned. Implementations SHALL\nreport an error if multiple values are produced when that is not the case.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "boolean"
          }
        ]
      },
      {
        "id": "ViewDefinition.select.column.description",
        "path": "ViewDefinition.select.column.description",
        "short": "Description of the column",
        "definition": "A human-readable description of the column.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "markdown"
          }
        ]
      },
      {
        "id": "ViewDefinition.select.column.tag",
        "path": "ViewDefinition.select.column.tag",
        "short": "Additional metadata describing the column",
        "definition": "Tags can be used to attach additional metadata to columns, such as implementation-specific \ndirectives or database-specific type hints.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "BackboneElement"
          }
        ]
      },
      {
        "id": "ViewDefinition.select.column.tag.name",
        "path": "ViewDefinition.select.column.tag.name",
        "short": "Name of tag",
        "definition": "A name that identifies the meaning of the tag. A namespace should be used to scope the tag to \na particular context. For example, 'ansi/type' could be used to indicate the type that should \nbe used to represent the value within an ANSI SQL database.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "ViewDefinition.select.column.tag.value",
        "path": "ViewDefinition.select.column.tag.value",
        "short": "Value of tag",
        "definition": "Value of tag",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "ViewDefinition.select.select",
        "path": "ViewDefinition.select.select",
        "short": "Nested select relative to a parent expression.",
        "definition": "Nested select relative to a parent expression. If the parent `select` has a `forEach` or `forEachOrNull`, this child select will apply for each item in that expression. ",
        "min": 0,
        "max": "*",
        "contentReference": "#ViewDefinition.select"
      },
      {
        "id": "ViewDefinition.select.forEach",
        "path": "ViewDefinition.select.forEach",
        "short": "A FHIRPath expression to retrieve the parent element(s) used in the containing select. The default is effectively `$this`.",
        "definition": "A FHIRPath expression to retrieve the parent element(s) used in the containing select, relative to the root resource or parent `select`,\nif applicable. `forEach` will produce a row for each element selected in the expression. For example, using forEach on `address` in Patient will\ngenerate a new row for each address, with columns defined in the corresponding `column` structure.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "ViewDefinition.select.forEachOrNull",
        "path": "ViewDefinition.select.forEachOrNull",
        "short": "Same as forEach, but will produce a row with null values if the collection is empty.",
        "definition": "Same as forEach, but produces a single row with null values in the nested expression if the collection is empty. For example,\nwith a Patient resource, a `forEachOrNull` on address will produce a row for each patient even if there are no addresses; it will\nsimply set the address columns to `null`.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "ViewDefinition.select.unionAll",
        "path": "ViewDefinition.select.unionAll",
        "short": "Creates a union of all rows in the given selection structures.",
        "definition": "A `unionAll` combines the results of multiple selection structures. Each structure under the `unionAll` must produce the same column names\nand types. The results from each nested selection will then have their own row.",
        "min": 0,
        "max": "*",
        "contentReference": "#ViewDefinition.select"
      },
      {
        "id": "ViewDefinition.select.repeat",
        "path": "ViewDefinition.select.repeat",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "string"
          }
        ]
      }
    ]
  },
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource"
}

name : ViewDefinition

{

}