Common Interface declaration for conformance and knowledge artifact resources.

An absolute URI that is used to identify this {{title}} 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 {{title}} is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the {{title}} is stored on different servers.

Allows the {{title}} to be referenced by a single globally unique identifier.

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

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

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

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

Allows externally provided and/or usable business identifiers to be easily associated with the {{title}}.

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

There may be different {{title}}s that have the same canonical url but different versions. The version can be appended to the url in a reference to allow a reference to a particular business canonical version of the {{title}} with the format [url]|[version]. Note that the canonical version of a resource is not related to a server resource instance version ( Resource.meta.version ). For more information, see Version Matching for Canonical Resources . The version SHOULD NOT contain a '#' - see Business Version .

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

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. For more information, see Choosing the right Canonical Reference .

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

Supports code generation.

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.

A short, descriptive, user-friendly title for the {{title}}.

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

The current state of this {{title}}.

Enables tracking the life-cycle of the content and filtering of {{title}}s that are appropriate for use versus not.

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

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

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

If a server wishes to reflect whether a given canonical resource is 'supported' or 'enabled' on that server, this is NOT done with status. Instead, expose support for the resource using a 'feature' in the server's CapabilityStatement. (Not all supported canonical resources will necessarily be searchable on a server, and availability of a canonical resource in a search result does not imply support of the resource for any particular usage.)

A Boolean value to indicate that this {{title}} is authored for testing purposes (or education/evaluation/marketing) and is not no version of this resource will ever be intended for genuine usage. usage

Enables experimental content to be developed following the same lifecycle that would be used for a production-level {{title}}.

Allows filtering of {{title}}s that are appropriate for use versus not. Experimental resources might include example instances in implementation guides, instances created solely for testing purposes, etc. If experimental is 'true' for any version of a resource, it should be true for all versions of the resource. (If experimental changes, then it is being misused or a resource that was never intended for real-world use has unexpectedly changed its purpose.).

Experimental resources are not expected to be stable and may well have breaking changes without a corresponding change to the 'version' element.

The date (and optionally time) when the {{title}} 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 {{title}} changes.

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 {{title}}. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.

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

The name of the organization or individual responsible for the release and ongoing maintenance of the {{title}}.

Helps establish the "authority/credibility" of the {{title}}. May also allow for contact.

Usually an organization but may be an individual. The publisher (or steward) of the {{title}} is the organization or individual primarily responsible for the maintenance and upkeep of the {{title}}. 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 {{title}}. This item SHOULD be populated unless the information is available from context.

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

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

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

A free text natural language description of the {{title}} from a consumer's perspective.

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 {{title}} as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context.

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 {{title}}s.

Assist in searching for appropriate content.

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

A legal or geographic region in which the {{title}} authority that maintains the resource is intended to be used. operating. In general, the jurisdiction is also found in the useContext. The useContext may reference additional jurisdictions because the defining jurisdiction does not necessarily limit the jurisdictions of use.

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

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

Explanation of why this {{title}} is needed and why it has been designed as it has.

This element does not describe the usage of the {{title}}. 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 {{title}}.

A copyright statement relating to the {{title}} and/or its contents. Copyright statements are generally legal notices of intellectual property ownership and can include restrictions on the use and publishing of the {{title}}.

Consumers must be able to determine any legal restrictions on the use of the {{title}} and/or its content.

The short copyright declaration (e.g. (c) '2015+ xyz organization' organization') should be sent in the copyrightLabel element. element without the copyright prefix (i.e., do not include '(c)' or the symbol).

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

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

The (c) copyright symbol should and the '(c)' textual representation 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.