{
"description": "A ViewDefinition represents a tabular projection of a FHIR resource, where the columns and inclusion \\ncriteria are defined by FHIRPath expressions. ",
"_filename": "StructureDefinition-ViewDefinition.json",
"package_name": "hl7.fhir.uv.sql-on-fhir",
"date": "2026-08-14T02:49:31+10:00",
"derivation": "specialization",
"publisher": "HL7 International / FHIR Infrastructure",
"fhirVersion": "6.0.0-ballot5",
"jurisdiction": [ {
"coding": [ {
"code": "001",
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"display": "World"
} ]
} ],
"name": "ViewDefinition",
"mapping": [ {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
} ],
"abstract": false,
"type": "ViewDefinition",
"experimental": null,
"resourceType": "StructureDefinition",
"title": "View Definition",
"package_version": "3.0.0-ballot",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/additional-resource",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode": "anonymous"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "draft"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "fhir"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-implements",
"valueUri": "http://hl7.org/fhir/StructureDefinition/MetadataResource"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 2,
"_valueInteger": {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical": "http://hl7.org/fhir/uv/sql-on-fhir/ImplementationGuide/hl7.fhir.uv.sql-on-fhir"
} ]
}
} ],
"snapshot": {
"element": [ {
"constraint": [ {
"key": "dom-2",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.contained.empty()"
}, {
"key": "dom-3",
"human": "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",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.where((('#'+id.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').exists()).not()).trace('unmatched', id).empty()"
}, {
"key": "dom-4",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"
}, {
"key": "dom-5",
"human": "If a resource is contained in another resource, it SHALL NOT have a security label",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.meta.security.empty()"
}, {
"key": "dom-6",
"human": "A resource should have narrative for robust management",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "warning",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown": "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
} ],
"expression": "text.`div`.exists()"
} ],
"path": "ViewDefinition",
"min": 0,
"definition": "A ViewDefinition represents a tabular projection of a FHIR resource, where the columns and inclusion \ncriteria are defined by FHIRPath expressions. ",
"isModifier": false,
"short": "View Definition",
"mapping": [ {
"map": "Entity. Role, or Act,Entity, Role, or Act",
"identity": "rim"
} ],
"mustSupport": false,
"max": "*",
"id": "ViewDefinition",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource"
},
"isSummary": false
}, {
"path": "ViewDefinition.id",
"min": 0,
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"isModifier": false,
"short": "Logical id of this artifact",
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
} ]
} ],
"mustSupport": false,
"max": "1",
"id": "ViewDefinition.id",
"comment": "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.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.id"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ViewDefinition.meta",
"min": 0,
"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.",
"isModifier": false,
"short": "Metadata about the resource",
"type": [ {
"code": "Meta"
} ],
"mustSupport": false,
"max": "1",
"id": "ViewDefinition.meta",
"base": {
"max": "1",
"min": 0,
"path": "Resource.meta"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ViewDefinition.implicitRules",
"min": 0,
"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](https://build.fhir.org/ig/HL7/fhir-extensions/StructureDefinition-additionalImplicitRules.html) extension.",
"isModifier": true,
"short": "A set of rules under which this content was created",
"type": [ {
"code": "uri"
} ],
"mustSupport": false,
"max": "1",
"id": "ViewDefinition.implicitRules",
"comment": "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.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.implicitRules"
},
"isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ViewDefinition.language",
"min": 0,
"definition": "The base language in which the resource is written.",
"isModifier": false,
"short": "Language of the resource content",
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot5",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
} ],
"additional": [ {
"purpose": "starter",
"valueSet": "http://hl7.org/fhir/ValueSet/languages|6.0.0-ballot5"
} ],
"description": "IETF language tag for a human language"
},
"max": "1",
"id": "ViewDefinition.language",
"comment": "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).",
"base": {
"max": "1",
"min": 0,
"path": "Resource.language"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ViewDefinition.text",
"min": 0,
"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.",
"isModifier": false,
"short": "Text summary of the resource, for human interpretation",
"mapping": [ {
"map": "Act.text?",
"identity": "rim"
} ],
"type": [ {
"code": "Narrative"
} ],
"mustSupport": false,
"alias": [ "narrative", "html", "xhtml", "display" ],
"max": "1",
"id": "ViewDefinition.text",
"condition": [ "dom-6" ],
"comment": "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.",
"base": {
"max": "1",
"min": 0,
"path": "DomainResource.text"
},
"isSummary": false
}, {
"path": "ViewDefinition.contained",
"min": 0,
"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.",
"isModifier": false,
"short": "Contained, inline Resources",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Resource"
} ],
"mustSupport": false,
"alias": [ "inline resources", "anonymous resources", "contained resources" ],
"max": "*",
"id": "ViewDefinition.contained",
"condition": [ "dom-2", "dom-4", "dom-3", "dom-5" ],
"comment": "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](http://build.fhir.org/resource.html#additional).",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.contained"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ViewDefinition.extension",
"min": 0,
"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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"mustSupport": false,
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "ViewDefinition.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ViewDefinition.modifierExtension",
"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](http://build.fhir.org/extensibility.html#modifierExtension).",
"min": 0,
"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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"mustSupport": false,
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "ViewDefinition.modifierExtension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "cnl-1",
"human": "URL should not contain | or # - these characters make processing canonical references problematic",
"source": "http://hl7.org/fhir/StructureDefinition/MetadataResource",
"severity": "warning",
"expression": "exists() implies matches('^[^|# ]+$')"
} ],
"path": "ViewDefinition.url",
"requirements": "Allows the view definition to be referenced by a single globally unique identifier.",
"min": 0,
"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.",
"short": "Canonical identifier for this view definition, represented as an absolute URI (globally unique)",
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "ViewDefinition.url",
"comment": "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.\n\nThe 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](http://build.fhir.org/resource.html#versions).\n\nIn 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](http://build.fhir.org/resource.html#meta) element to indicate where the current master source of the resource can be found.",
"base": {
"max": "1",
"min": 0,
"path": "ViewDefinition.url"
},
"isSummary": true
}, {
"path": "ViewDefinition.identifier",
"requirements": "Allows externally provided and/or usable business identifiers to be easily associated with the view definition.",
"min": 0,
"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.",
"short": "Additional identifier for the view definition",
"type": [ {
"code": "Identifier"
} ],
"max": "*",
"id": "ViewDefinition.identifier",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "ViewDefinition.identifier"
},
"isSummary": true
}, {
"path": "ViewDefinition.version",
"min": 0,
"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.)",
"short": "Business version of the view definition",
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "ViewDefinition.version",
"comment": "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](http://build.fhir.org/resource.html#bv-format).",
"base": {
"max": "1",
"min": 0,
"path": "ViewDefinition.version"
},
"isSummary": true
}, {
"path": "ViewDefinition.versionAlgorithm[x]",
"min": 0,
"definition": "Indicates the mechanism used to compare versions to determine which is more current.",
"short": "How to compare versions",
"type": [ {
"code": "string"
}, {
"code": "Coding"
} ],
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/version-algorithm"
},
"max": "1",
"id": "ViewDefinition.versionAlgorithm[x]",
"comment": "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.",
"base": {
"max": "1",
"min": 0,
"path": "ViewDefinition.versionAlgorithm[x]"
},
"isSummary": true
}, {
"constraint": [ {
"key": "sql-name",
"human": "Name is limited to letters, numbers, or underscores and cannot start with an\nunderscore -- i.e. with a regular expression of: ^[A-Za-z][A-Za-z0-9_]*$ \n\n\nThis makes it usable as table names in a wide variety of databases.",
"source": "http://hl7.org/fhir/StructureDefinition/ViewDefinition",
"severity": "error",
"expression": "empty() or matches('^[A-Za-z][A-Za-z0-9_]*$')"
} ],
"path": "ViewDefinition.name",
"requirements": "Supports code generation.",
"min": 0,
"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.",
"short": "Name for this view definition (computer friendly)",
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "ViewDefinition.name",
"comment": "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.",
"base": {
"max": "1",
"min": 0,
"path": "ViewDefinition.name"
},
"isSummary": true
}, {
"path": "ViewDefinition.title",
"min": 0,
"definition": "A short, descriptive, user-friendly title for the view definition.",
"short": "Name for this view definition (human friendly)",
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "ViewDefinition.title",
"comment": "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.",
"base": {
"max": "1",
"min": 0,
"path": "ViewDefinition.title"
},
"isSummary": true
}, {
"path": "ViewDefinition.status",
"requirements": "Enables tracking the life-cycle of the content and filtering of view definitions that are appropriate for use versus not.",
"min": 1,
"definition": "The current state of this view definition.",
"isModifier": true,
"short": "draft | active | retired | unknown",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/publication-status",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PublicationStatus"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "The lifecycle status of an artifact."
},
"max": "1",
"id": "ViewDefinition.status",
"comment": "A nominal state-transition diagram can be found in the [Definition pattern](http://hl7.org/fhir/6.0.0-ballot5/definition.html#statemachine) documentation.\n\nUnknown 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.\n\nSee guidance around (not) making local changes to elements [here](http://build.fhir.org/canonicalresource.html#localization).",
"base": {
"max": "1",
"min": 1,
"path": "ViewDefinition.status"
},
"isModifierReason": "This is labeled as \"Is Modifier\" because applications should not use a retired view definition without due consideration",
"isSummary": true
}, {
"path": "ViewDefinition.experimental",
"requirements": "Enables experimental content to be developed following the same lifecycle that would be used for a production-level view definition.",
"min": 0,
"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.",
"short": "For testing purposes, not real usage",
"type": [ {
"code": "boolean"
} ],
"meaningWhenMissing": "If absent, this resource is treated as though it is not experimental.",
"max": "1",
"id": "ViewDefinition.experimental",
"comment": "Allows filtering of view definitions that are appropriate for use versus not.",
"base": {
"max": "1",
"min": 0,
"path": "ViewDefinition.experimental"
},
"isSummary": true
}, {
"path": "ViewDefinition.date",
"min": 0,
"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.",
"short": "Date last changed",
"type": [ {
"code": "dateTime"
} ],
"alias": [ "Revision Date" ],
"max": "1",
"id": "ViewDefinition.date",
"comment": "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.\n\nSee guidance around (not) making local changes to elements [here](http://build.fhir.org/canonicalresource.html#localization).",
"base": {
"max": "1",
"min": 0,
"path": "ViewDefinition.date"
},
"isSummary": true
}, {
"path": "ViewDefinition.publisher",
"requirements": "Helps establish the \"authority/credibility\" of the view definition. May also allow for contact.",
"min": 0,
"definition": "The name of the organization or individual responsible for the release and ongoing maintenance of the view definition.",
"short": "Name of the publisher/steward (organization or individual)",
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "ViewDefinition.publisher",
"comment": "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.",
"base": {
"max": "1",
"min": 0,
"path": "ViewDefinition.publisher"
},
"isSummary": true
}, {
"path": "ViewDefinition.contact",
"min": 0,
"definition": "Contact details to assist a user in finding and communicating with the publisher.",
"short": "Contact details for the publisher",
"type": [ {
"code": "ContactDetail"
} ],
"max": "*",
"id": "ViewDefinition.contact",
"comment": "May be a web site, an email address, a telephone number, etc.\n\nSee guidance around (not) making local changes to elements [here](http://build.fhir.org/canonicalresource.html#localization).",
"base": {
"max": "*",
"min": 0,
"path": "ViewDefinition.contact"
},
"isSummary": true
}, {
"path": "ViewDefinition.description",
"min": 0,
"definition": "A free text natural language description of the view definition from a consumer's perspective.",
"short": "Natural language description of the view definition",
"type": [ {
"code": "markdown"
} ],
"max": "1",
"id": "ViewDefinition.description",
"comment": "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.",
"base": {
"max": "1",
"min": 0,
"path": "ViewDefinition.description"
}
}, {
"path": "ViewDefinition.useContext",
"requirements": "Assist in searching for appropriate content.",
"min": 0,
"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.",
"short": "The context that the content is intended to support",
"type": [ {
"code": "UsageContext"
} ],
"max": "*",
"id": "ViewDefinition.useContext",
"comment": "When multiple useContexts are specified, there is no expectation that all or even any of the contexts apply.",
"base": {
"max": "*",
"min": 0,
"path": "ViewDefinition.useContext"
},
"isSummary": true
}, {
"path": "ViewDefinition.jurisdiction",
"min": 0,
"definition": "A legal or geographic region in which the view definition is intended to be used.",
"short": "Intended jurisdiction for view definition (if applicable)",
"type": [ {
"code": "CodeableConcept"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "deprecated"
} ],
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/jurisdiction",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Jurisdiction"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "Countries and regions within which this artifact is targeted for use."
},
"max": "*",
"id": "ViewDefinition.jurisdiction",
"comment": "It may be possible for the view definition to be used in jurisdictions other than those for which it was originally designed or intended.\n\nDEPRECATION 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.)",
"base": {
"max": "*",
"min": 0,
"path": "ViewDefinition.jurisdiction"
},
"isSummary": true
}, {
"path": "ViewDefinition.purpose",
"min": 0,
"definition": "Explanation of why this view definition is needed and why it has been designed as it has.",
"short": "Why this view definition is defined",
"type": [ {
"code": "markdown"
} ],
"max": "1",
"id": "ViewDefinition.purpose",
"comment": "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.",
"base": {
"max": "1",
"min": 0,
"path": "ViewDefinition.purpose"
}
}, {
"path": "ViewDefinition.copyright",
"requirements": "Consumers must be able to determine any legal restrictions on the use of the view definition and/or its content.",
"min": 0,
"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.",
"short": "Use and/or publishing restrictions",
"type": [ {
"code": "markdown"
} ],
"alias": [ "License", "Restrictions" ],
"max": "1",
"id": "ViewDefinition.copyright",
"comment": "The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element.",
"base": {
"max": "1",
"min": 0,
"path": "ViewDefinition.copyright"
}
}, {
"path": "ViewDefinition.copyrightLabel",
"requirements": "Defines the content expected to be rendered in all representations of the artifact.",
"min": 0,
"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').",
"short": "Copyright holder and year(s)",
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "ViewDefinition.copyrightLabel",
"comment": "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.",
"base": {
"max": "1",
"min": 0,
"path": "ViewDefinition.copyrightLabel"
}
}, {
"path": "ViewDefinition.approvalDate",
"min": 0,
"definition": "The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.",
"short": "When the view definition was approved by publisher",
"type": [ {
"code": "date"
} ],
"max": "1",
"id": "ViewDefinition.approvalDate",
"comment": "The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.\n\nSee guidance around (not) making local changes to elements [here](http://build.fhir.org/canonicalresource.html#localization).",
"base": {
"max": "1",
"min": 0,
"path": "ViewDefinition.approvalDate"
}
}, {
"path": "ViewDefinition.lastReviewDate",
"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.\n\nSee guidance around (not) making local changes to elements [here](http://build.fhir.org/canonicalresource.html#localization).",
"min": 0,
"definition": "The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.",
"short": "When the view definition was last reviewed by the publisher",
"type": [ {
"code": "date"
} ],
"max": "1",
"id": "ViewDefinition.lastReviewDate",
"comment": "If specified, this date follows the original approval date.",
"base": {
"max": "1",
"min": 0,
"path": "ViewDefinition.lastReviewDate"
}
}, {
"path": "ViewDefinition.effectivePeriod",
"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.",
"min": 0,
"definition": "The period during which the view definition content was or is planned to be in active use.",
"short": "When the view definition is expected to be used",
"type": [ {
"code": "Period"
} ],
"max": "1",
"id": "ViewDefinition.effectivePeriod",
"comment": "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.\n\nSee guidance around (not) making local changes to elements [here](http://build.fhir.org/canonicalresource.html#localization).",
"base": {
"max": "1",
"min": 0,
"path": "ViewDefinition.effectivePeriod"
},
"isSummary": true
}, {
"path": "ViewDefinition.topic",
"requirements": "Repositories must be able to determine how to categorize the view definition so that it can be found by topical and keyword searches.",
"min": 0,
"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.",
"short": "E.g. Education, Treatment, Assessment, etc",
"type": [ {
"code": "CodeableConcept"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "deprecated"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/definition-topic",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DefinitionTopic"
} ]
},
"max": "*",
"id": "ViewDefinition.topic",
"comment": "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.\n\nDEPRECATION 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)",
"base": {
"max": "*",
"min": 0,
"path": "ViewDefinition.topic"
}
}, {
"id": "ViewDefinition.author",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "ViewDefinition.author"
},
"path": "ViewDefinition.author",
"type": [ {
"code": "ContactDetail"
} ],
"short": "Who authored the view definition",
"definition": "An individual or organization primarily involved in the creation and maintenance of the view definition."
}, {
"id": "ViewDefinition.editor",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "ViewDefinition.editor"
},
"path": "ViewDefinition.editor",
"type": [ {
"code": "ContactDetail"
} ],
"short": "Who edited the view definition",
"definition": "An individual or organization primarily responsible for internal coherence of the view definition."
}, {
"path": "ViewDefinition.reviewer",
"min": 0,
"definition": "An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the view definition.",
"short": "Who reviewed the view definition",
"type": [ {
"code": "ContactDetail"
} ],
"max": "*",
"id": "ViewDefinition.reviewer",
"comment": "See guidance around (not) making local changes to elements [here](http://build.fhir.org/canonicalresource.html#localization).",
"base": {
"max": "*",
"min": 0,
"path": "ViewDefinition.reviewer"
}
}, {
"path": "ViewDefinition.endorser",
"min": 0,
"definition": "An individual or organization asserted by the publisher to be responsible for officially endorsing the view definition for use in some setting.",
"short": "Who endorsed the view definition",
"type": [ {
"code": "ContactDetail"
} ],
"max": "*",
"id": "ViewDefinition.endorser",
"comment": "See guidance around (not) making local changes to elements [here](http://build.fhir.org/canonicalresource.html#localization).",
"base": {
"max": "*",
"min": 0,
"path": "ViewDefinition.endorser"
}
}, {
"path": "ViewDefinition.relatedArtifact",
"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.",
"min": 0,
"definition": "Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts.",
"short": "Additional documentation, citations, etc",
"type": [ {
"code": "RelatedArtifact"
} ],
"max": "*",
"id": "ViewDefinition.relatedArtifact",
"comment": "Each related artifact is either an attachment, or a reference to another resource, but not both.",
"base": {
"max": "*",
"min": 0,
"path": "ViewDefinition.relatedArtifact"
}
}, {
"path": "ViewDefinition.resource",
"min": 1,
"definition": "The FHIR resource that the view is based upon, e.g. 'Patient' or 'Observation'.",
"short": "FHIR resource for the ViewDefinition",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/resource-types"
},
"max": "1",
"id": "ViewDefinition.resource",
"base": {
"max": "1",
"min": 1,
"path": "ViewDefinition.resource"
}
}, {
"id": "ViewDefinition.profile",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "ViewDefinition.profile"
},
"path": "ViewDefinition.profile",
"type": [ {
"code": "canonical",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/StructureDefinition" ]
} ],
"short": "FHIR profiles that this view definition was intended to be executed against",
"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`."
}, {
"path": "ViewDefinition.fhirVersion",
"min": 0,
"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].",
"short": "FHIR version(s) of the resource for the ViewDefinition",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/FHIR-version"
},
"max": "*",
"id": "ViewDefinition.fhirVersion",
"base": {
"max": "*",
"min": 0,
"path": "ViewDefinition.fhirVersion"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children or both",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ViewDefinition.constant",
"min": 0,
"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.",
"short": "Constant that can be used in FHIRPath expressions",
"type": [ {
"code": "BackboneElement"
} ],
"max": "*",
"id": "ViewDefinition.constant",
"base": {
"max": "*",
"min": 0,
"path": "ViewDefinition.constant"
}
}, {
"path": "ViewDefinition.constant.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ViewDefinition.constant.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ViewDefinition.constant.extension",
"min": 0,
"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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "ViewDefinition.constant.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ViewDefinition.constant.modifierExtension",
"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](http://build.fhir.org/extensibility.html#modifierExtension).",
"min": 0,
"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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "ViewDefinition.constant.modifierExtension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "sql-name",
"human": "Name is limited to letters, numbers, or underscores and cannot start with an\nunderscore -- i.e. with a regular expression of: ^[A-Za-z][A-Za-z0-9_]*$ \n\n\nThis makes it usable as table names in a wide variety of databases.",
"source": "http://hl7.org/fhir/StructureDefinition/ViewDefinition",
"severity": "error",
"expression": "empty() or matches('^[A-Za-z][A-Za-z0-9_]*$')"
} ],
"path": "ViewDefinition.constant.name",
"min": 1,
"definition": "Name of constant (referred to in FHIRPath as %[name])",
"short": "Name of constant (referred to in FHIRPath as %[name])",
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "ViewDefinition.constant.name",
"base": {
"max": "1",
"min": 1,
"path": "ViewDefinition.constant.name"
}
}, {
"id": "ViewDefinition.constant.value[x]",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "ViewDefinition.constant.value[x]"
},
"path": "ViewDefinition.constant.value[x]",
"type": [ {
"code": "base64Binary"
}, {
"code": "boolean"
}, {
"code": "canonical"
}, {
"code": "code"
}, {
"code": "date"
}, {
"code": "dateTime"
}, {
"code": "decimal"
}, {
"code": "id"
}, {
"code": "instant"
}, {
"code": "integer"
}, {
"code": "integer64"
}, {
"code": "oid"
}, {
"code": "string"
}, {
"code": "positiveInt"
}, {
"code": "time"
}, {
"code": "unsignedInt"
}, {
"code": "uri"
}, {
"code": "url"
}, {
"code": "uuid"
} ],
"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."
}, {
"constraint": [ {
"key": "sql-expressions",
"human": "Can only have at most one of `forEach`, `forEachOrNull`, or `repeat`.",
"source": "http://hl7.org/fhir/StructureDefinition/ViewDefinition",
"severity": "error",
"expression": "(forEach.exists().toInteger() + forEachOrNull.exists().toInteger() + repeat.exists().toInteger()) <= 1"
}, {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children or both",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ViewDefinition.select",
"min": 1,
"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.",
"short": "A collection of columns and nested selects to include in the view.",
"type": [ {
"code": "BackboneElement"
} ],
"max": "*",
"id": "ViewDefinition.select",
"base": {
"max": "*",
"min": 1,
"path": "ViewDefinition.select"
}
}, {
"path": "ViewDefinition.select.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ViewDefinition.select.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ViewDefinition.select.extension",
"min": 0,
"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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "ViewDefinition.select.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ViewDefinition.select.modifierExtension",
"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](http://build.fhir.org/extensibility.html#modifierExtension).",
"min": 0,
"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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "ViewDefinition.select.modifierExtension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children or both",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ViewDefinition.select.column",
"min": 0,
"definition": "A column to be produced in the resulting table. The column is relative to the select structure\nthat contains it.",
"short": "A column to be produced in the resulting table.",
"type": [ {
"code": "BackboneElement"
} ],
"max": "*",
"id": "ViewDefinition.select.column",
"base": {
"max": "*",
"min": 0,
"path": "ViewDefinition.select.column"
}
}, {
"path": "ViewDefinition.select.column.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ViewDefinition.select.column.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ViewDefinition.select.column.extension",
"min": 0,
"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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "ViewDefinition.select.column.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ViewDefinition.select.column.modifierExtension",
"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](http://build.fhir.org/extensibility.html#modifierExtension).",
"min": 0,
"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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "ViewDefinition.select.column.modifierExtension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"id": "ViewDefinition.select.column.path",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "ViewDefinition.select.column.path"
},
"path": "ViewDefinition.select.column.path",
"type": [ {
"code": "string"
} ],
"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]."
}, {
"constraint": [ {
"key": "sql-name",
"human": "Name is limited to letters, numbers, or underscores and cannot start with an\nunderscore -- i.e. with a regular expression of: ^[A-Za-z][A-Za-z0-9_]*$ \n\n\nThis makes it usable as table names in a wide variety of databases.",
"source": "http://hl7.org/fhir/StructureDefinition/ViewDefinition",
"severity": "error",
"expression": "empty() or matches('^[A-Za-z][A-Za-z0-9_]*$')"
} ],
"path": "ViewDefinition.select.column.name",
"min": 1,
"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.",
"short": "Column name produced in the output",
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "ViewDefinition.select.column.name",
"base": {
"max": "1",
"min": 1,
"path": "ViewDefinition.select.column.name"
}
}, {
"id": "ViewDefinition.select.column.description",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "ViewDefinition.select.column.description"
},
"path": "ViewDefinition.select.column.description",
"type": [ {
"code": "markdown"
} ],
"short": "Description of the column",
"definition": "A human-readable description of the column."
}, {
"id": "ViewDefinition.select.column.collection",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "ViewDefinition.select.column.collection"
},
"path": "ViewDefinition.select.column.collection",
"type": [ {
"code": "boolean"
} ],
"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."
}, {
"id": "ViewDefinition.select.column.type",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "ViewDefinition.select.column.type"
},
"path": "ViewDefinition.select.column.type",
"type": [ {
"code": "uri"
} ],
"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."
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children or both",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ViewDefinition.select.column.tag",
"min": 0,
"definition": "Tags can be used to attach additional metadata to columns, such as implementation-specific \ndirectives or database-specific type hints.",
"short": "Additional metadata describing the column",
"type": [ {
"code": "BackboneElement"
} ],
"max": "*",
"id": "ViewDefinition.select.column.tag",
"base": {
"max": "*",
"min": 0,
"path": "ViewDefinition.select.column.tag"
}
}, {
"path": "ViewDefinition.select.column.tag.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ViewDefinition.select.column.tag.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ViewDefinition.select.column.tag.extension",
"min": 0,
"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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "ViewDefinition.select.column.tag.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ViewDefinition.select.column.tag.modifierExtension",
"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](http://build.fhir.org/extensibility.html#modifierExtension).",
"min": 0,
"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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "ViewDefinition.select.column.tag.modifierExtension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"id": "ViewDefinition.select.column.tag.name",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "ViewDefinition.select.column.tag.name"
},
"path": "ViewDefinition.select.column.tag.name",
"type": [ {
"code": "string"
} ],
"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."
}, {
"id": "ViewDefinition.select.column.tag.value",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "ViewDefinition.select.column.tag.value"
},
"path": "ViewDefinition.select.column.tag.value",
"type": [ {
"code": "string"
} ],
"short": "Value of tag",
"definition": "Value of tag"
}, {
"id": "ViewDefinition.select.select",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "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.",
"contentReference": "http://hl7.org/fhir/StructureDefinition/ViewDefinition#ViewDefinition.select"
}, {
"id": "ViewDefinition.select.forEach",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "ViewDefinition.select.forEach"
},
"path": "ViewDefinition.select.forEach",
"type": [ {
"code": "string"
} ],
"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."
}, {
"id": "ViewDefinition.select.forEachOrNull",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "ViewDefinition.select.forEachOrNull"
},
"path": "ViewDefinition.select.forEachOrNull",
"type": [ {
"code": "string"
} ],
"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`."
}, {
"id": "ViewDefinition.select.repeat",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "ViewDefinition.select.repeat"
},
"path": "ViewDefinition.select.repeat",
"type": [ {
"code": "string"
} ],
"short": "FHIRPath expressions to recursively select from.",
"definition": "A list of FHIRPath expressions that define paths to recursively traverse. The view runner will recursively\nfollow each path to any depth, collecting results from all levels. All results are combined using a union\noperation."
}, {
"id": "ViewDefinition.select.unionAll",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "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.",
"contentReference": "http://hl7.org/fhir/StructureDefinition/ViewDefinition#ViewDefinition.select"
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children or both",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ViewDefinition.where",
"min": 0,
"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.",
"short": "A series of zero or more FHIRPath constraints to filter resources for the view.",
"type": [ {
"code": "BackboneElement"
} ],
"max": "*",
"id": "ViewDefinition.where",
"base": {
"max": "*",
"min": 0,
"path": "ViewDefinition.where"
}
}, {
"path": "ViewDefinition.where.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ViewDefinition.where.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ViewDefinition.where.extension",
"min": 0,
"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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "ViewDefinition.where.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ViewDefinition.where.modifierExtension",
"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](http://build.fhir.org/extensibility.html#modifierExtension).",
"min": 0,
"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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "ViewDefinition.where.modifierExtension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"id": "ViewDefinition.where.path",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "ViewDefinition.where.path"
},
"path": "ViewDefinition.where.path",
"type": [ {
"code": "string"
} ],
"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]."
}, {
"id": "ViewDefinition.where.description",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "ViewDefinition.where.description"
},
"path": "ViewDefinition.where.description",
"type": [ {
"code": "string"
} ],
"short": "A human-readable description of the above where constraint.",
"definition": "A human-readable description of the above where constraint."
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "6.0.0-ballot5"
} ]
},
"status": "draft",
"id": "d634a16e-8865-41c0-84c5-e03f1d419868",
"kind": "resource",
"url": "http://hl7.org/fhir/StructureDefinition/ViewDefinition",
"identifier": [ {
"value": "urn:oid:2.16.840.1.113883.4.642.40.77.42.5",
"system": "urn:ietf:rfc:3986"
} ],
"version": "3.0.0-ballot",
"differential": {
"element": [ {
"id": "ViewDefinition",
"max": "*",
"min": 0,
"path": "ViewDefinition",
"short": "View Definition",
"definition": "A ViewDefinition represents a tabular projection of a FHIR resource, where the columns and inclusion \ncriteria are defined by FHIRPath expressions. "
}, {
"constraint": [ {
"key": "cnl-1",
"human": "URL should not contain | or # - these characters make processing canonical references problematic",
"source": "http://hl7.org/fhir/StructureDefinition/MetadataResource",
"severity": "warning",
"expression": "exists() implies matches('^[^|# ]+$')"
} ],
"path": "ViewDefinition.url",
"requirements": "Allows the view definition to be referenced by a single globally unique identifier.",
"min": 0,
"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.",
"short": "Canonical identifier for this view definition, represented as an absolute URI (globally unique)",
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "ViewDefinition.url",
"comment": "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.\n\nThe 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](resource.html#versions).\n\nIn 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](resource.html#meta) element to indicate where the current master source of the resource can be found.",
"isSummary": true
}, {
"path": "ViewDefinition.identifier",
"requirements": "Allows externally provided and/or usable business identifiers to be easily associated with the view definition.",
"min": 0,
"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.",
"short": "Additional identifier for the view definition",
"type": [ {
"code": "Identifier"
} ],
"max": "*",
"id": "ViewDefinition.identifier",
"comment": "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.",
"isSummary": true
}, {
"path": "ViewDefinition.version",
"min": 0,
"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.)",
"short": "Business version of the view definition",
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "ViewDefinition.version",
"comment": "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](resource.html#bv-format).",
"isSummary": true
}, {
"path": "ViewDefinition.versionAlgorithm[x]",
"min": 0,
"definition": "Indicates the mechanism used to compare versions to determine which is more current.",
"short": "How to compare versions",
"type": [ {
"code": "string"
}, {
"code": "Coding"
} ],
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/version-algorithm"
},
"max": "1",
"id": "ViewDefinition.versionAlgorithm[x]",
"comment": "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.",
"isSummary": true
}, {
"constraint": [ {
"key": "sql-name",
"human": "Name is limited to letters, numbers, or underscores and cannot start with an\nunderscore -- i.e. with a regular expression of: ^[A-Za-z][A-Za-z0-9_]*$ \n\n\nThis makes it usable as table names in a wide variety of databases.",
"source": "http://hl7.org/fhir/StructureDefinition/ViewDefinition",
"severity": "error",
"expression": "empty() or matches('^[A-Za-z][A-Za-z0-9_]*$')"
} ],
"path": "ViewDefinition.name",
"requirements": "Supports code generation.",
"min": 0,
"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.",
"short": "Name for this view definition (computer friendly)",
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "ViewDefinition.name",
"comment": "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.",
"isSummary": true
}, {
"path": "ViewDefinition.title",
"min": 0,
"definition": "A short, descriptive, user-friendly title for the view definition.",
"short": "Name for this view definition (human friendly)",
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "ViewDefinition.title",
"comment": "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.",
"isSummary": true
}, {
"path": "ViewDefinition.status",
"requirements": "Enables tracking the life-cycle of the content and filtering of view definitions that are appropriate for use versus not.",
"min": 1,
"definition": "The current state of this view definition. ",
"isModifier": true,
"short": "draft | active | retired | unknown",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/publication-status",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PublicationStatus"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "The lifecycle status of an artifact."
},
"max": "1",
"id": "ViewDefinition.status",
"comment": "A nominal state-transition diagram can be found in the [Definition pattern](definition.html#statemachine) documentation.\n\nUnknown 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.\n\nSee guidance around (not) making local changes to elements [here](canonicalresource.html#localization).",
"isModifierReason": "This is labeled as \"Is Modifier\" because applications should not use a retired view definition without due consideration",
"isSummary": true
}, {
"path": "ViewDefinition.experimental",
"requirements": "Enables experimental content to be developed following the same lifecycle that would be used for a production-level view definition.",
"min": 0,
"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.",
"short": "For testing purposes, not real usage",
"type": [ {
"code": "boolean"
} ],
"meaningWhenMissing": "If absent, this resource is treated as though it is not experimental.",
"max": "1",
"id": "ViewDefinition.experimental",
"comment": "Allows filtering of view definitions that are appropriate for use versus not.",
"isSummary": true
}, {
"path": "ViewDefinition.date",
"min": 0,
"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.",
"short": "Date last changed",
"type": [ {
"code": "dateTime"
} ],
"alias": [ "Revision Date" ],
"max": "1",
"id": "ViewDefinition.date",
"comment": "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.\n\nSee guidance around (not) making local changes to elements [here](canonicalresource.html#localization).",
"isSummary": true
}, {
"path": "ViewDefinition.publisher",
"requirements": "Helps establish the \"authority/credibility\" of the view definition. May also allow for contact.",
"min": 0,
"definition": "The name of the organization or individual responsible for the release and ongoing maintenance of the view definition.",
"short": "Name of the publisher/steward (organization or individual)",
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "ViewDefinition.publisher",
"comment": "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.",
"isSummary": true
}, {
"path": "ViewDefinition.contact",
"min": 0,
"definition": "Contact details to assist a user in finding and communicating with the publisher.",
"short": "Contact details for the publisher",
"type": [ {
"code": "ContactDetail"
} ],
"max": "*",
"id": "ViewDefinition.contact",
"comment": "May be a web site, an email address, a telephone number, etc.\n\nSee guidance around (not) making local changes to elements [here](canonicalresource.html#localization).",
"isSummary": true
}, {
"id": "ViewDefinition.description",
"max": "1",
"min": 0,
"path": "ViewDefinition.description",
"type": [ {
"code": "markdown"
} ],
"short": "Natural language description of the view definition",
"comment": "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.",
"definition": "A free text natural language description of the view definition from a consumer's perspective."
}, {
"path": "ViewDefinition.useContext",
"requirements": "Assist in searching for appropriate content.",
"min": 0,
"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.",
"short": "The context that the content is intended to support",
"type": [ {
"code": "UsageContext"
} ],
"max": "*",
"id": "ViewDefinition.useContext",
"comment": "When multiple useContexts are specified, there is no expectation that all or even any of the contexts apply.",
"isSummary": true
}, {
"path": "ViewDefinition.jurisdiction",
"min": 0,
"definition": "A legal or geographic region in which the view definition is intended to be used.",
"short": "Intended jurisdiction for view definition (if applicable)",
"type": [ {
"code": "CodeableConcept"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "deprecated"
} ],
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/jurisdiction",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Jurisdiction"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "Countries and regions within which this artifact is targeted for use."
},
"max": "*",
"id": "ViewDefinition.jurisdiction",
"comment": "It may be possible for the view definition to be used in jurisdictions other than those for which it was originally designed or intended.\n\nDEPRECATION 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.)",
"isSummary": true
}, {
"id": "ViewDefinition.purpose",
"max": "1",
"min": 0,
"path": "ViewDefinition.purpose",
"type": [ {
"code": "markdown"
} ],
"short": "Why this view definition is defined",
"comment": "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.",
"definition": "Explanation of why this view definition is needed and why it has been designed as it has."
}, {
"path": "ViewDefinition.copyright",
"requirements": "Consumers must be able to determine any legal restrictions on the use of the view definition and/or its content.",
"min": 0,
"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.",
"short": "Use and/or publishing restrictions",
"type": [ {
"code": "markdown"
} ],
"alias": [ "License", "Restrictions" ],
"max": "1",
"id": "ViewDefinition.copyright",
"comment": "The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element."
}, {
"path": "ViewDefinition.copyrightLabel",
"requirements": "Defines the content expected to be rendered in all representations of the artifact.",
"min": 0,
"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').",
"short": "Copyright holder and year(s)",
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "ViewDefinition.copyrightLabel",
"comment": "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."
}, {
"id": "ViewDefinition.approvalDate",
"max": "1",
"min": 0,
"path": "ViewDefinition.approvalDate",
"type": [ {
"code": "date"
} ],
"short": "When the view definition was approved by publisher",
"comment": "The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.\n\nSee guidance around (not) making local changes to elements [here](canonicalresource.html#localization).",
"definition": "The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage."
}, {
"path": "ViewDefinition.lastReviewDate",
"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.\n\nSee guidance around (not) making local changes to elements [here](canonicalresource.html#localization).",
"min": 0,
"definition": "The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.",
"short": "When the view definition was last reviewed by the publisher",
"type": [ {
"code": "date"
} ],
"max": "1",
"id": "ViewDefinition.lastReviewDate",
"comment": "If specified, this date follows the original approval date."
}, {
"path": "ViewDefinition.effectivePeriod",
"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.",
"min": 0,
"definition": "The period during which the view definition content was or is planned to be in active use.",
"short": "When the view definition is expected to be used",
"type": [ {
"code": "Period"
} ],
"max": "1",
"id": "ViewDefinition.effectivePeriod",
"comment": "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.\n\nSee guidance around (not) making local changes to elements [here](canonicalresource.html#localization).",
"isSummary": true
}, {
"path": "ViewDefinition.topic",
"requirements": "Repositories must be able to determine how to categorize the view definition so that it can be found by topical and keyword searches.",
"min": 0,
"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.",
"short": "E.g. Education, Treatment, Assessment, etc",
"type": [ {
"code": "CodeableConcept"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "deprecated"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/definition-topic",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DefinitionTopic"
} ]
},
"max": "*",
"id": "ViewDefinition.topic",
"comment": "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.\n\nDEPRECATION 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)"
}, {
"id": "ViewDefinition.author",
"max": "*",
"min": 0,
"path": "ViewDefinition.author",
"type": [ {
"code": "ContactDetail"
} ],
"short": "Who authored the view definition",
"definition": "An individual or organization primarily involved in the creation and maintenance of the view definition."
}, {
"id": "ViewDefinition.editor",
"max": "*",
"min": 0,
"path": "ViewDefinition.editor",
"type": [ {
"code": "ContactDetail"
} ],
"short": "Who edited the view definition",
"definition": "An individual or organization primarily responsible for internal coherence of the view definition."
}, {
"id": "ViewDefinition.reviewer",
"max": "*",
"min": 0,
"path": "ViewDefinition.reviewer",
"type": [ {
"code": "ContactDetail"
} ],
"short": "Who reviewed the view definition",
"comment": "See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).",
"definition": "An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the view definition."
}, {
"id": "ViewDefinition.endorser",
"max": "*",
"min": 0,
"path": "ViewDefinition.endorser",
"type": [ {
"code": "ContactDetail"
} ],
"short": "Who endorsed the view definition",
"comment": "See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).",
"definition": "An individual or organization asserted by the publisher to be responsible for officially endorsing the view definition for use in some setting."
}, {
"path": "ViewDefinition.relatedArtifact",
"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.",
"min": 0,
"definition": "Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts.",
"short": "Additional documentation, citations, etc",
"type": [ {
"code": "RelatedArtifact"
} ],
"max": "*",
"id": "ViewDefinition.relatedArtifact",
"comment": "Each related artifact is either an attachment, or a reference to another resource, but not both."
}, {
"id": "ViewDefinition.resource",
"max": "1",
"min": 1,
"path": "ViewDefinition.resource",
"type": [ {
"code": "code"
} ],
"short": "FHIR resource for the ViewDefinition",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/resource-types"
},
"definition": "The FHIR resource that the view is based upon, e.g. 'Patient' or 'Observation'."
}, {
"id": "ViewDefinition.profile",
"max": "*",
"min": 0,
"path": "ViewDefinition.profile",
"type": [ {
"code": "canonical",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/StructureDefinition" ]
} ],
"short": "FHIR profiles that this view definition was intended to be executed against",
"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`."
}, {
"id": "ViewDefinition.fhirVersion",
"max": "*",
"min": 0,
"path": "ViewDefinition.fhirVersion",
"type": [ {
"code": "code"
} ],
"short": "FHIR version(s) of the resource for the ViewDefinition",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/FHIR-version"
},
"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]."
}, {
"id": "ViewDefinition.constant",
"max": "*",
"min": 0,
"path": "ViewDefinition.constant",
"type": [ {
"code": "BackboneElement"
} ],
"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."
}, {
"id": "ViewDefinition.constant.name",
"max": "1",
"min": 1,
"path": "ViewDefinition.constant.name",
"type": [ {
"code": "string"
} ],
"short": "Name of constant (referred to in FHIRPath as %[name])",
"constraint": [ {
"key": "sql-name",
"human": "Name is limited to letters, numbers, or underscores and cannot start with an\nunderscore -- i.e. with a regular expression of: ^[A-Za-z][A-Za-z0-9_]*$ \n\n\nThis makes it usable as table names in a wide variety of databases.",
"source": "http://hl7.org/fhir/StructureDefinition/ViewDefinition",
"severity": "error",
"expression": "empty() or matches('^[A-Za-z][A-Za-z0-9_]*$')"
} ],
"definition": "Name of constant (referred to in FHIRPath as %[name])"
}, {
"id": "ViewDefinition.constant.value[x]",
"max": "1",
"min": 1,
"path": "ViewDefinition.constant.value[x]",
"type": [ {
"code": "base64Binary"
}, {
"code": "boolean"
}, {
"code": "canonical"
}, {
"code": "code"
}, {
"code": "date"
}, {
"code": "dateTime"
}, {
"code": "decimal"
}, {
"code": "id"
}, {
"code": "instant"
}, {
"code": "integer"
}, {
"code": "integer64"
}, {
"code": "oid"
}, {
"code": "string"
}, {
"code": "positiveInt"
}, {
"code": "time"
}, {
"code": "unsignedInt"
}, {
"code": "uri"
}, {
"code": "url"
}, {
"code": "uuid"
} ],
"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."
}, {
"id": "ViewDefinition.select",
"max": "*",
"min": 1,
"path": "ViewDefinition.select",
"type": [ {
"code": "BackboneElement"
} ],
"short": "A collection of columns and nested selects to include in the view.",
"constraint": [ {
"key": "sql-expressions",
"human": "Can only have at most one of `forEach`, `forEachOrNull`, or `repeat`.",
"source": "http://hl7.org/fhir/StructureDefinition/ViewDefinition",
"severity": "error",
"expression": "(forEach.exists().toInteger() + forEachOrNull.exists().toInteger() + repeat.exists().toInteger()) <= 1"
} ],
"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."
}, {
"id": "ViewDefinition.select.column",
"max": "*",
"min": 0,
"path": "ViewDefinition.select.column",
"type": [ {
"code": "BackboneElement"
} ],
"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."
}, {
"id": "ViewDefinition.select.column.path",
"max": "1",
"min": 1,
"path": "ViewDefinition.select.column.path",
"type": [ {
"code": "string"
} ],
"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]."
}, {
"id": "ViewDefinition.select.column.name",
"max": "1",
"min": 1,
"path": "ViewDefinition.select.column.name",
"type": [ {
"code": "string"
} ],
"short": "Column name produced in the output",
"constraint": [ {
"key": "sql-name",
"human": "Name is limited to letters, numbers, or underscores and cannot start with an\nunderscore -- i.e. with a regular expression of: ^[A-Za-z][A-Za-z0-9_]*$ \n\n\nThis makes it usable as table names in a wide variety of databases.",
"source": "http://hl7.org/fhir/StructureDefinition/ViewDefinition",
"severity": "error",
"expression": "empty() or matches('^[A-Za-z][A-Za-z0-9_]*$')"
} ],
"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."
}, {
"id": "ViewDefinition.select.column.description",
"max": "1",
"min": 0,
"path": "ViewDefinition.select.column.description",
"type": [ {
"code": "markdown"
} ],
"short": "Description of the column",
"definition": "A human-readable description of the column."
}, {
"id": "ViewDefinition.select.column.collection",
"max": "1",
"min": 0,
"path": "ViewDefinition.select.column.collection",
"type": [ {
"code": "boolean"
} ],
"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."
}, {
"id": "ViewDefinition.select.column.type",
"max": "1",
"min": 0,
"path": "ViewDefinition.select.column.type",
"type": [ {
"code": "uri"
} ],
"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."
}, {
"id": "ViewDefinition.select.column.tag",
"max": "*",
"min": 0,
"path": "ViewDefinition.select.column.tag",
"type": [ {
"code": "BackboneElement"
} ],
"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."
}, {
"id": "ViewDefinition.select.column.tag.name",
"max": "1",
"min": 1,
"path": "ViewDefinition.select.column.tag.name",
"type": [ {
"code": "string"
} ],
"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."
}, {
"id": "ViewDefinition.select.column.tag.value",
"max": "1",
"min": 1,
"path": "ViewDefinition.select.column.tag.value",
"type": [ {
"code": "string"
} ],
"short": "Value of tag",
"definition": "Value of tag"
}, {
"id": "ViewDefinition.select.select",
"max": "*",
"min": 0,
"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. ",
"contentReference": "http://hl7.org/fhir/StructureDefinition/ViewDefinition#ViewDefinition.select"
}, {
"id": "ViewDefinition.select.forEach",
"max": "1",
"min": 0,
"path": "ViewDefinition.select.forEach",
"type": [ {
"code": "string"
} ],
"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."
}, {
"id": "ViewDefinition.select.forEachOrNull",
"max": "1",
"min": 0,
"path": "ViewDefinition.select.forEachOrNull",
"type": [ {
"code": "string"
} ],
"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`."
}, {
"id": "ViewDefinition.select.repeat",
"max": "*",
"min": 0,
"path": "ViewDefinition.select.repeat",
"type": [ {
"code": "string"
} ],
"short": "FHIRPath expressions to recursively select from.",
"definition": "A list of FHIRPath expressions that define paths to recursively traverse. The view runner will recursively\nfollow each path to any depth, collecting results from all levels. All results are combined using a union\noperation."
}, {
"id": "ViewDefinition.select.unionAll",
"max": "*",
"min": 0,
"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.",
"contentReference": "http://hl7.org/fhir/StructureDefinition/ViewDefinition#ViewDefinition.select"
}, {
"id": "ViewDefinition.where",
"max": "*",
"min": 0,
"path": "ViewDefinition.where",
"type": [ {
"code": "BackboneElement"
} ],
"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."
}, {
"id": "ViewDefinition.where.path",
"max": "1",
"min": 1,
"path": "ViewDefinition.where.path",
"type": [ {
"code": "string"
} ],
"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]."
}, {
"id": "ViewDefinition.where.description",
"max": "1",
"min": 0,
"path": "ViewDefinition.where.description",
"type": [ {
"code": "string"
} ],
"short": "A human-readable description of the above where constraint.",
"definition": "A human-readable description of the above where constraint."
} ]
},
"contact": [ {
"name": "HL7 International / FHIR Infrastructure",
"telecom": [ {
"value": "http://www.hl7.org/Special/committees/fiwg",
"system": "url"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource"
}