SQL on FHIR
3.0.0-ballot - STU 3 Ballot International flag

SQL on FHIR, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 3.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/sql-on-fhir/ and changes regularly. See the Directory of published versions

Resource Profile: Shareable View Definition - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 2

Definitions for the ShareableViewDefinition resource profile

Guidance on how to interpret the contents of this table can be foundhere

0. ViewDefinition
Definition

A ViewDefinition represents a tabular projection of a FHIR resource, where the columns and inclusion criteria are defined by FHIRPath expressions.


A resource that includes narrative, extensions, and contained resources.

ShortView DefinitionA resource with narrative, extensions, and contained resources
Control0..*
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. ViewDefinition.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. For DomainResources, if more than one implicitRules policy applies, additional policies may be conveyed using the additionalImplicitRules extension.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. ViewDefinition.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

ShortContained, inline Resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels. Contained resources may be a resource type defined in the FHIR specification, or an additional resource.

Control0..*
This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
TypeResource
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
6. ViewDefinition.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Must Supportfalse
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on ViewDefinition.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 8. ViewDefinition.url
    Definition

    An absolute URI that is used to identify this view definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this view definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the view definition is stored on different servers.

    ShortCanonical identifier for this view definition, represented as an absolute URI (globally unique)
    Comments

    Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.

    The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions.

    In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found.

    Control10..1
    Typeuri
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

    Allows the view definition to be referenced by a single globally unique identifier.

    Invariantscnl-1: URL should not contain | or # - these characters make processing canonical references problematic (exists() implies matches('^[^|# ]+$'))
    10. ViewDefinition.name
    Definition

    A natural language name identifying the view definition. This name should be usable as an identifier for the resource by machine processing applications such as code generation.

    ShortName for this view definition (computer friendly)
    Comments

    The name is not expected to be globally unique. The name should be a simple alphanumeric type no-whitespace name to ensure that it is machine-processing friendly.

    Control10..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

    Supports code generation.

    Invariantssql-name: Name is limited to letters, numbers, or underscores and cannot start with an underscore -- i.e. with a regular expression of: ^[A-Za-z][A-Za-z0-9_]*$ This makes it usable as table names in a wide variety of databases. (empty() or matches('^[A-Za-z][A-Za-z0-9_]*$'))
    12. ViewDefinition.status
    Definition

    The current state of this view definition.

    Shortdraft | active | retired | unknown
    Comments

    A nominal state-transition diagram can be found in the Definition pattern documentation.

    Unknown does not represent 'other' - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is.

    See guidance around (not) making local changes to elements here.

    Control1..1
    BindingThe codes SHALL be taken from PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status
    (required to http://hl7.org/fhir/ValueSet/publication-status)

    The lifecycle status of an artifact.

    Typecode
    Is Modifiertrue because This is labeled as "Is Modifier" because applications should not use a retired view definition without due consideration
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

    Enables tracking the life-cycle of the content and filtering of view definitions that are appropriate for use versus not.

    14. ViewDefinition.resource
    Definition

    The FHIR resource that the view is based upon, e.g. 'Patient' or 'Observation'.

    ShortFHIR resource for the ViewDefinition
    Control1..1
    BindingThe codes SHALL be taken from ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types
    (required to http://hl7.org/fhir/ValueSet/resource-types)
    Typecode
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    16. ViewDefinition.fhirVersion
    Definition

    The FHIR version(s) for the FHIR resource. The value of this element is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor].

    ShortFHIR version(s) of the resource for the ViewDefinition
    Control10..*
    BindingThe codes SHALL be taken from FHIRVersionhttp://hl7.org/fhir/ValueSet/FHIR-version
    (required to http://hl7.org/fhir/ValueSet/FHIR-version)
    Typecode
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    18. ViewDefinition.select
    Definition

    The select structure defines the columns to be used in the resulting view. These are expressed in the column structure below, or in nested selects for nested resources.

    ShortA collection of columns and nested selects to include in the view.
    Control1..*
    TypeBackboneElement
    Invariantssql-expressions: Can only have at most one of `forEach`, `forEachOrNull`, or `repeat`. ((forEach.exists().toInteger() + forEachOrNull.exists().toInteger() + repeat.exists().toInteger()) <= 1)
    ele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
    20. ViewDefinition.select.modifierExtension
    Definition

    May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

    ShortExtensions that cannot be ignored even if unrecognized
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
    Summarytrue
    Requirements

    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

    Alternate Namesextensions, user content, modifiers
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    SlicingThis element introduces a set of slices on ViewDefinition.select.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • Guidance on how to interpret the contents of this table can be foundhere

      0. ViewDefinition
      2. ViewDefinition.url
      Control1..?
      4. ViewDefinition.name
      Control1..?
      6. ViewDefinition.fhirVersion
      Control1..?
      8. ViewDefinition.select
      10. ViewDefinition.select.column
      12. ViewDefinition.select.column.type
      Control1..?

      Guidance on how to interpret the contents of this table can be foundhere

      0. ViewDefinition
      Definition

      A ViewDefinition represents a tabular projection of a FHIR resource, where the columns and inclusion criteria are defined by FHIRPath expressions.

      ShortView Definition
      Control0..*
      Is Modifierfalse
      Must Supportfalse
      Summaryfalse
      Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
      dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').exists()).not()).trace('unmatched', id).empty())
      dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
      dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
      dom-6: A resource should have narrative for robust management (text.`div`.exists())
      2. ViewDefinition.id
      Definition

      The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

      ShortLogical id of this artifact
      Comments

      Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resource id depends on the given use case.

      Control0..1
      Typeid
      Is Modifierfalse
      Must Supportfalse
      Summarytrue
      4. ViewDefinition.meta
      Definition

      The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

      ShortMetadata about the resource
      Control0..1
      TypeMeta
      Is Modifierfalse
      Must Supportfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      6. ViewDefinition.implicitRules
      Definition

      A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. For DomainResources, if more than one implicitRules policy applies, additional policies may be conveyed using the additionalImplicitRules extension.

      ShortA set of rules under which this content was created
      Comments

      Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

      Control0..1
      Typeuri
      Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supportfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      8. ViewDefinition.language
      Definition

      The base language in which the resource is written.

      ShortLanguage of the resource content
      Comments

      Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

      Control0..1
      BindingThe codes SHALL be taken from AllLanguages
      (required to http://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot5)

      IETF language tag for a human language

      Typecode
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supportfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      10. ViewDefinition.text
      Definition

      A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

      ShortText summary of the resource, for human interpretation
      Comments

      Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

      Control0..1
      This element is affected by the following invariants: dom-6
      TypeNarrative
      Is Modifierfalse
      Must Supportfalse
      Summaryfalse
      Alternate Namesnarrative, html, xhtml, display
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      12. ViewDefinition.contained
      Definition

      These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

      ShortContained, inline Resources
      Comments

      This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels. Contained resources may be a resource type defined in the FHIR specification, or an additional resource.

      Control0..*
      This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
      TypeResource
      Is Modifierfalse
      Must Supportfalse
      Summaryfalse
      Alternate Namesinline resources, anonymous resources, contained resources
      14. ViewDefinition.extension
      Definition

      May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

      ShortAdditional content defined by implementations
      Comments

      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

      Control0..*
      TypeExtension
      Is Modifierfalse
      Must Supportfalse
      Summaryfalse
      Alternate Namesextensions, user content
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      SlicingThis element introduces a set of slices on ViewDefinition.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 16. ViewDefinition.modifierExtension
        Definition

        May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

        ShortExtensions that cannot be ignored
        Comments

        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

        Control0..*
        TypeExtension
        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
        Must Supportfalse
        Summarytrue
        Requirements

        Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

        Alternate Namesextensions, user content
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        SlicingThis element introduces a set of slices on ViewDefinition.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 18. ViewDefinition.url
          Definition

          An absolute URI that is used to identify this view definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this view definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the view definition is stored on different servers.

          ShortCanonical identifier for this view definition, represented as an absolute URI (globally unique)
          Comments

          Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.

          The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions.

          In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found.

          Control1..1
          Typeuri
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Requirements

          Allows the view definition to be referenced by a single globally unique identifier.

          Invariantscnl-1: URL should not contain | or # - these characters make processing canonical references problematic (exists() implies matches('^[^|# ]+$'))
          20. ViewDefinition.identifier
          Definition

          A formal identifier that is used to identify this view definition when it is represented in other formats, or referenced in a specification, model, design or an instance.

          ShortAdditional identifier for the view definition
          Comments

          Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this view definition outside of FHIR, where it is not possible to use the logical URI.

          NoteThis is a business identifier, not a resource identifier (see discussion)
          Control0..*
          TypeIdentifier
          Summarytrue
          Requirements

          Allows externally provided and/or usable business identifiers to be easily associated with the view definition.

          22. ViewDefinition.version
          Definition

          The identifier that is used to identify this version of the view definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the view definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence without additional knowledge. (See the versionAlgorithm element.)

          ShortBusiness version of the view definition
          Comments

          There may be different view definitions that have the same url but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the view definition with the format [url]|[version]. The version SHOULD NOT contain a '#' - see Business Version.

          NoteThis is a business version Id, not a resource version Id (see discussion)
          Control0..1
          Typestring
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          24. ViewDefinition.versionAlgorithm[x]
          Definition

          Indicates the mechanism used to compare versions to determine which is more current.

          ShortHow to compare versions
          Comments

          If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.

          Control0..1
          BindingUnless not suitable, these codes SHALL be taken from VersionAlgorithm
          (extensible to http://hl7.org/fhir/ValueSet/version-algorithm)
          TypeChoice of: string, Coding
          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          26. ViewDefinition.name
          Definition

          A natural language name identifying the view definition. This name should be usable as an identifier for the resource by machine processing applications such as code generation.

          ShortName for this view definition (computer friendly)
          Comments

          The name is not expected to be globally unique. The name should be a simple alphanumeric type no-whitespace name to ensure that it is machine-processing friendly.

          Control1..1
          Typestring
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Requirements

          Supports code generation.

          Invariantssql-name: Name is limited to letters, numbers, or underscores and cannot start with an underscore -- i.e. with a regular expression of: ^[A-Za-z][A-Za-z0-9_]*$ This makes it usable as table names in a wide variety of databases. (empty() or matches('^[A-Za-z][A-Za-z0-9_]*$'))
          28. ViewDefinition.title
          Definition

          A short, descriptive, user-friendly title for the view definition.

          ShortName for this view definition (human friendly)
          Comments

          This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

          Control0..1
          Typestring
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          30. ViewDefinition.status
          Definition

          The current state of this view definition.

          Shortdraft | active | retired | unknown
          Comments

          A nominal state-transition diagram can be found in the Definition pattern documentation.

          Unknown does not represent 'other' - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is.

          See guidance around (not) making local changes to elements here.

          Control1..1
          BindingThe codes SHALL be taken from PublicationStatus
          (required to http://hl7.org/fhir/ValueSet/publication-status)

          The lifecycle status of an artifact.

          Typecode
          Is Modifiertrue because This is labeled as "Is Modifier" because applications should not use a retired view definition without due consideration
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Requirements

          Enables tracking the life-cycle of the content and filtering of view definitions that are appropriate for use versus not.

          32. ViewDefinition.experimental
          Definition

          A Boolean value to indicate that this view definition is authored for testing purposes (or education/evaluation/marketing) and is not intended for genuine usage.

          ShortFor testing purposes, not real usage
          Comments

          Allows filtering of view definitions that are appropriate for use versus not.

          Control0..1
          Typeboolean
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Requirements

          Enables experimental content to be developed following the same lifecycle that would be used for a production-level view definition.

          Meaning if MissingIf absent, this resource is treated as though it is not experimental.
          34. ViewDefinition.date
          Definition

          The date (and optionally time) when the view definition was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the view definition changes.

          ShortDate last changed
          Comments

          The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the view definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.

          See guidance around (not) making local changes to elements here.

          Control0..1
          TypedateTime
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Alternate NamesRevision Date
          36. ViewDefinition.publisher
          Definition

          The name of the organization or individual responsible for the release and ongoing maintenance of the view definition.

          ShortName of the publisher/steward (organization or individual)
          Comments

          Usually an organization but may be an individual. The publisher (or steward) of the view definition is the organization or individual primarily responsible for the maintenance and upkeep of the view definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the view definition. This item SHOULD be populated unless the information is available from context.

          Control0..1
          Typestring
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Requirements

          Helps establish the "authority/credibility" of the view definition. May also allow for contact.

          38. ViewDefinition.contact
          Definition

          Contact details to assist a user in finding and communicating with the publisher.

          ShortContact details for the publisher
          Comments

          May be a web site, an email address, a telephone number, etc.

          See guidance around (not) making local changes to elements here.

          Control0..*
          TypeContactDetail
          Summarytrue
          40. ViewDefinition.description
          Definition

          A free text natural language description of the view definition from a consumer's perspective.

          ShortNatural language description of the view definition
          Comments

          This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the view definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context.

          Control0..1
          Typemarkdown
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          42. ViewDefinition.useContext
          Definition

          The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate view definitions.

          ShortThe context that the content is intended to support
          Comments

          When multiple useContexts are specified, there is no expectation that all or even any of the contexts apply.

          Control0..*
          TypeUsageContext
          Summarytrue
          Requirements

          Assist in searching for appropriate content.

          44. ViewDefinition.jurisdiction
          Definition

          A legal or geographic region in which the view definition is intended to be used.

          ShortIntended jurisdiction for view definition (if applicable)
          Comments

          It may be possible for the view definition to be used in jurisdictions other than those for which it was originally designed or intended.

          DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.)

          Control0..*
          BindingUnless not suitable, these codes SHALL be taken from JurisdictionValueSet .
          (extensible to http://hl7.org/fhir/ValueSet/jurisdiction)

          Countries and regions within which this artifact is targeted for use.

          TypeCodeableConcept
          Summarytrue
          46. ViewDefinition.purpose
          Definition

          Explanation of why this view definition is needed and why it has been designed as it has.

          ShortWhy this view definition is defined
          Comments

          This element does not describe the usage of the view definition. Instead, it provides traceability of "why" the resource is either needed or "why" it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this view definition.

          Control0..1
          Typemarkdown
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          48. ViewDefinition.copyright
          Definition

          A copyright statement relating to the view definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the view definition.

          ShortUse and/or publishing restrictions
          Comments

          The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element.

          Control0..1
          Typemarkdown
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Requirements

          Consumers must be able to determine any legal restrictions on the use of the view definition and/or its content.

          Alternate NamesLicense, Restrictions
          50. ViewDefinition.copyrightLabel
          Definition

          A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are restricted. (e.g. 'All rights reserved', 'Some rights reserved').

          ShortCopyright holder and year(s)
          Comments

          The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.

          Control0..1
          Typestring
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Requirements

          Defines the content expected to be rendered in all representations of the artifact.

          52. ViewDefinition.approvalDate
          Definition

          The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

          ShortWhen the view definition was approved by publisher
          Comments

          The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.

          See guidance around (not) making local changes to elements here.

          Control0..1
          Typedate
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          54. ViewDefinition.lastReviewDate
          Definition

          The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

          ShortWhen the view definition was last reviewed by the publisher
          Comments

          If specified, this date follows the original approval date.

          Control0..1
          Typedate
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Requirements

          Gives a sense of how "current" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.

          See guidance around (not) making local changes to elements here.

          56. ViewDefinition.effectivePeriod
          Definition

          The period during which the view definition content was or is planned to be in active use.

          ShortWhen the view definition is expected to be used
          Comments

          The effective period for a view definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015.

          See guidance around (not) making local changes to elements here.

          Control0..1
          TypePeriod
          Summarytrue
          Requirements

          Allows establishing a transition before a resource comes into effect and also allows for a sun-setting process when new versions of the view definition are or are expected to be used instead.

          58. ViewDefinition.topic
          Definition

          Descriptive topics related to the content of the view definition. Topics provide a high-level categorization as well as keywords for the view definition that can be useful for filtering and searching.

          ShortE.g. Education, Treatment, Assessment, etc
          Comments

          This element provides topical categorization and keywords for the view definition, as opposed to the more structured context-of-use information provided in the useContext element.

          DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'topic' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#topic and useContext.valueCodeableConcept indicating the topic)

          Control0..*
          BindingFor example codes, see DefinitionTopic
          (example to http://hl7.org/fhir/ValueSet/definition-topic)
          TypeCodeableConcept
          Requirements

          Repositories must be able to determine how to categorize the view definition so that it can be found by topical and keyword searches.

          60. ViewDefinition.author
          Definition

          An individual or organization primarily involved in the creation and maintenance of the view definition.

          ShortWho authored the view definition
          Control0..*
          TypeContactDetail
          62. ViewDefinition.editor
          Definition

          An individual or organization primarily responsible for internal coherence of the view definition.

          ShortWho edited the view definition
          Control0..*
          TypeContactDetail
          64. ViewDefinition.reviewer
          Definition

          An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the view definition.

          ShortWho reviewed the view definition
          Comments

          See guidance around (not) making local changes to elements here.

          Control0..*
          TypeContactDetail
          66. ViewDefinition.endorser
          Definition

          An individual or organization asserted by the publisher to be responsible for officially endorsing the view definition for use in some setting.

          ShortWho endorsed the view definition
          Comments

          See guidance around (not) making local changes to elements here.

          Control0..*
          TypeContactDetail
          68. ViewDefinition.relatedArtifact
          Definition

          Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts.

          ShortAdditional documentation, citations, etc
          Comments

          Each related artifact is either an attachment, or a reference to another resource, but not both.

          Control0..*
          TypeRelatedArtifact
          Requirements

          A view definition must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.

          70. ViewDefinition.resource
          Definition

          The FHIR resource that the view is based upon, e.g. 'Patient' or 'Observation'.

          ShortFHIR resource for the ViewDefinition
          Control1..1
          BindingThe codes SHALL be taken from ResourceType
          (required to http://hl7.org/fhir/ValueSet/resource-types)
          Typecode
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          72. ViewDefinition.profile
          Definition

          Indicates that this definition was intended to create a view over a set of resources conforming to the specified FHIR profiles. Each of these profiles SHALL be based upon the resource type specified in resource.

          ShortFHIR profiles that this view definition was intended to be executed against
          Control0..*
          Typecanonical(StructureDefinition)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          74. ViewDefinition.fhirVersion
          Definition

          The FHIR version(s) for the FHIR resource. The value of this element is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor].

          ShortFHIR version(s) of the resource for the ViewDefinition
          Control1..*
          BindingThe codes SHALL be taken from FHIRVersion
          (required to http://hl7.org/fhir/ValueSet/FHIR-version)
          Typecode
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          76. ViewDefinition.constant
          Definition

          A constant is a value that is injected into a FHIRPath expression through the use of a FHIRPath external constant with the same name.

          ShortConstant that can be used in FHIRPath expressions
          Control0..*
          TypeBackboneElement
          Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
          78. ViewDefinition.constant.id
          Definition

          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

          ShortUnique id for inter-element referencing
          Control0..1
          This element is affected by the following invariants: ele-1
          Typestring
          Is Modifierfalse
          XML FormatIn the XML format, this property is represented as an attribute.
          Summaryfalse
          80. ViewDefinition.constant.extension
          Definition

          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

          ShortAdditional content defined by implementations
          Comments

          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

          Control0..*
          TypeExtension
          Is Modifierfalse
          Summaryfalse
          Alternate Namesextensions, user content
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          SlicingThis element introduces a set of slices on ViewDefinition.constant.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 82. ViewDefinition.constant.modifierExtension
            Definition

            May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

            Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

            ShortExtensions that cannot be ignored even if unrecognized
            Comments

            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

            Control0..*
            TypeExtension
            Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
            Summarytrue
            Requirements

            Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

            Alternate Namesextensions, user content, modifiers
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            SlicingThis element introduces a set of slices on ViewDefinition.constant.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 84. ViewDefinition.constant.name
              Definition

              Name of constant (referred to in FHIRPath as %[name])

              ShortName of constant (referred to in FHIRPath as %[name])
              Control1..1
              Typestring
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Invariantssql-name: Name is limited to letters, numbers, or underscores and cannot start with an underscore -- i.e. with a regular expression of: ^[A-Za-z][A-Za-z0-9_]*$ This makes it usable as table names in a wide variety of databases. (empty() or matches('^[A-Za-z][A-Za-z0-9_]*$'))
              86. ViewDefinition.constant.value[x]
              Definition

              The value that will be substituted in place of the constant reference. This is done by including %your_constant_name in a FHIRPath expression, which effectively converts the FHIR literal defined here to a FHIRPath literal used in the path expression.

              Support for additional types may be added in the future.

              ShortValue of constant
              Control1..1
              TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, integer64, oid, string, positiveInt, time, unsignedInt, uri, url, uuid
              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              88. ViewDefinition.select
              Definition

              The select structure defines the columns to be used in the resulting view. These are expressed in the column structure below, or in nested selects for nested resources.

              ShortA collection of columns and nested selects to include in the view.
              Control1..*
              TypeBackboneElement
              Invariantssql-expressions: Can only have at most one of `forEach`, `forEachOrNull`, or `repeat`. ((forEach.exists().toInteger() + forEachOrNull.exists().toInteger() + repeat.exists().toInteger()) <= 1)
              ele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
              90. ViewDefinition.select.id
              Definition

              Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

              ShortUnique id for inter-element referencing
              Control0..1
              This element is affected by the following invariants: ele-1
              Typestring
              Is Modifierfalse
              XML FormatIn the XML format, this property is represented as an attribute.
              Summaryfalse
              92. ViewDefinition.select.extension
              Definition

              May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

              ShortAdditional content defined by implementations
              Comments

              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

              Control0..*
              TypeExtension
              Is Modifierfalse
              Summaryfalse
              Alternate Namesextensions, user content
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              SlicingThis element introduces a set of slices on ViewDefinition.select.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 94. ViewDefinition.select.modifierExtension
                Definition

                May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                ShortExtensions that cannot be ignored even if unrecognized
                Comments

                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                Control0..*
                TypeExtension
                Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                Summarytrue
                Requirements

                Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                Alternate Namesextensions, user content, modifiers
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                SlicingThis element introduces a set of slices on ViewDefinition.select.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 96. ViewDefinition.select.column
                  Definition

                  A column to be produced in the resulting table. The column is relative to the select structure that contains it.

                  ShortA column to be produced in the resulting table.
                  Control0..*
                  TypeBackboneElement
                  Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
                  98. ViewDefinition.select.column.id
                  Definition

                  Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                  ShortUnique id for inter-element referencing
                  Control0..1
                  This element is affected by the following invariants: ele-1
                  Typestring
                  Is Modifierfalse
                  XML FormatIn the XML format, this property is represented as an attribute.
                  Summaryfalse
                  100. ViewDefinition.select.column.extension
                  Definition

                  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                  ShortAdditional content defined by implementations
                  Comments

                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                  Control0..*
                  TypeExtension
                  Is Modifierfalse
                  Summaryfalse
                  Alternate Namesextensions, user content
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  SlicingThis element introduces a set of slices on ViewDefinition.select.column.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 102. ViewDefinition.select.column.modifierExtension
                    Definition

                    May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                    ShortExtensions that cannot be ignored even if unrecognized
                    Comments

                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                    Control0..*
                    TypeExtension
                    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                    Summarytrue
                    Requirements

                    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                    Alternate Namesextensions, user content, modifiers
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    SlicingThis element introduces a set of slices on ViewDefinition.select.column.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • value @ url
                    • 104. ViewDefinition.select.column.path
                      Definition

                      A FHIRPath expression that evaluates to the value that will be output in the column for each resource. The input context is the collection of resources of the type specified in the resource element. Constants defined in Reference({constant}) can be referenced as %[name].

                      ShortFHIRPath expression that creates a column and defines its content
                      Control1..1
                      Typestring
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      106. ViewDefinition.select.column.name
                      Definition

                      Name of the column produced in the output, must be in a database-friendly format. The column names in the output must not have any duplicates.

                      ShortColumn name produced in the output
                      Control1..1
                      Typestring
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Invariantssql-name: Name is limited to letters, numbers, or underscores and cannot start with an underscore -- i.e. with a regular expression of: ^[A-Za-z][A-Za-z0-9_]*$ This makes it usable as table names in a wide variety of databases. (empty() or matches('^[A-Za-z][A-Za-z0-9_]*$'))
                      108. ViewDefinition.select.column.description
                      Definition

                      A human-readable description of the column.

                      ShortDescription of the column
                      Control0..1
                      Typemarkdown
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      110. ViewDefinition.select.column.collection
                      Definition

                      Indicates whether the column may have multiple values. Defaults to false if unset.

                      ViewDefinitions must have this set to true if multiple values may be returned. Implementations SHALL report an error if multiple values are produced when that is not the case.

                      ShortIndicates whether the column may have multiple values.
                      Control0..1
                      Typeboolean
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      112. ViewDefinition.select.column.type
                      Definition

                      A FHIR StructureDefinition URI for the column's type. Relative URIs are implicitly given the 'http://hl7.org/fhir/StructureDefinition/' prefix. The URI may also use FHIR element ID notation to indicate a backbone element within a structure. For instance, Observation.referenceRange may be specified to indicate the returned type is that backbone element.

                      This field must be provided if a ViewDefinition returns a non-primitive type. Implementations should report an error if the returned type does not match the type set here, or if a non-primitive type is returned but this field is unset.

                      ShortA FHIR StructureDefinition URI for the column's type.
                      Control1..1
                      Typeuri
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      114. ViewDefinition.select.column.tag
                      Definition

                      Tags can be used to attach additional metadata to columns, such as implementation-specific directives or database-specific type hints.

                      ShortAdditional metadata describing the column
                      Control0..*
                      TypeBackboneElement
                      Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
                      116. ViewDefinition.select.column.tag.id
                      Definition

                      Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                      ShortUnique id for inter-element referencing
                      Control0..1
                      This element is affected by the following invariants: ele-1
                      Typestring
                      Is Modifierfalse
                      XML FormatIn the XML format, this property is represented as an attribute.
                      Summaryfalse
                      118. ViewDefinition.select.column.tag.extension
                      Definition

                      May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                      ShortAdditional content defined by implementations
                      Comments

                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                      Control0..*
                      TypeExtension
                      Is Modifierfalse
                      Summaryfalse
                      Alternate Namesextensions, user content
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      SlicingThis element introduces a set of slices on ViewDefinition.select.column.tag.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                      • value @ url
                      • 120. ViewDefinition.select.column.tag.modifierExtension
                        Definition

                        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                        ShortExtensions that cannot be ignored even if unrecognized
                        Comments

                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                        Control0..*
                        TypeExtension
                        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                        Summarytrue
                        Requirements

                        Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                        Alternate Namesextensions, user content, modifiers
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        SlicingThis element introduces a set of slices on ViewDefinition.select.column.tag.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                        • value @ url
                        • 122. ViewDefinition.select.column.tag.name
                          Definition

                          A name that identifies the meaning of the tag. A namespace should be used to scope the tag to a particular context. For example, 'ansi/type' could be used to indicate the type that should be used to represent the value within an ANSI SQL database.

                          ShortName of tag
                          Control1..1
                          Typestring
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          124. ViewDefinition.select.column.tag.value
                          Definition

                          Value of tag

                          ShortValue of tag
                          Control1..1
                          Typestring
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          126. ViewDefinition.select.select
                          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.

                          ShortNested select relative to a parent expression.
                          Control0..*
                          TypeSeettp://hl7.org/fhir/StructureDefinition/ViewDefinition#ViewDefinition.select
                          128. ViewDefinition.select.forEach
                          Definition

                          A FHIRPath expression to retrieve the parent element(s) used in the containing select, relative to the root resource or parent select, if applicable. forEach will produce a row for each element selected in the expression. For example, using forEach on address in Patient will generate a new row for each address, with columns defined in the corresponding column structure.

                          ShortA FHIRPath expression to retrieve the parent element(s) used in the containing select. The default is effectively `$this`.
                          Control0..1
                          Typestring
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          130. ViewDefinition.select.forEachOrNull
                          Definition

                          Same as forEach, but produces a single row with null values in the nested expression if the collection is empty. For example, with a Patient resource, a forEachOrNull on address will produce a row for each patient even if there are no addresses; it will simply set the address columns to null.

                          ShortSame as forEach, but will produce a row with null values if the collection is empty.
                          Control0..1
                          Typestring
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          132. ViewDefinition.select.repeat
                          Definition

                          A list of FHIRPath expressions that define paths to recursively traverse. The view runner will recursively follow each path to any depth, collecting results from all levels. All results are combined using a union operation.

                          ShortFHIRPath expressions to recursively select from.
                          Control0..*
                          Typestring
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          134. ViewDefinition.select.unionAll
                          Definition

                          A unionAll combines the results of multiple selection structures. Each structure under the unionAll must produce the same column names and types. The results from each nested selection will then have their own row.

                          ShortCreates a union of all rows in the given selection structures.
                          Control0..*
                          TypeSeettp://hl7.org/fhir/StructureDefinition/ViewDefinition#ViewDefinition.select
                          136. ViewDefinition.where
                          Definition

                          A series of zero or more FHIRPath constraints to filter resources for the view. Every constraint must evaluate to true for the resource to be included in the view.

                          ShortA series of zero or more FHIRPath constraints to filter resources for the view.
                          Control0..*
                          TypeBackboneElement
                          Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
                          138. ViewDefinition.where.id
                          Definition

                          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                          ShortUnique id for inter-element referencing
                          Control0..1
                          This element is affected by the following invariants: ele-1
                          Typestring
                          Is Modifierfalse
                          XML FormatIn the XML format, this property is represented as an attribute.
                          Summaryfalse
                          140. ViewDefinition.where.extension
                          Definition

                          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                          ShortAdditional content defined by implementations
                          Comments

                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                          Control0..*
                          TypeExtension
                          Is Modifierfalse
                          Summaryfalse
                          Alternate Namesextensions, user content
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          SlicingThis element introduces a set of slices on ViewDefinition.where.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                          • value @ url
                          • 142. ViewDefinition.where.modifierExtension
                            Definition

                            May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                            Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                            ShortExtensions that cannot be ignored even if unrecognized
                            Comments

                            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                            Control0..*
                            TypeExtension
                            Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                            Summarytrue
                            Requirements

                            Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                            Alternate Namesextensions, user content, modifiers
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            SlicingThis element introduces a set of slices on ViewDefinition.where.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                            • value @ url
                            • 144. ViewDefinition.where.path
                              Definition

                              A FHIRPath expression that defines a filter that must evaluate to true for a resource to be included in the output. The input context is the collection of resources of the type specified in the resource element. Constants defined in Reference({constant}) can be referenced as %[name].

                              ShortA FHIRPath expression defining a filter condition
                              Control1..1
                              Typestring
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              146. ViewDefinition.where.description
                              Definition

                              A human-readable description of the above where constraint.

                              ShortA human-readable description of the above where constraint.
                              Control0..1
                              Typestring
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension