Resource to define constraints on the Expansion of a FHIR ValueSet.

An absolute URI that is used to identify this expansion profile when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this expansion profile is (or will be) published. The URL SHOULD include the major version of the expansion profile. For more information see Technical and Business Versions.

Allows the expansion profile 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.

A formal identifier that is used to identify this expansion profile 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 module.

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

The identifier that is used to identify this version of the expansion profile when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the expansion profile 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.

There may be different expansion profile instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a refrence to a particular business version of the expansion profile with the format [url]|[version].

A natural language name identifying the expansion profile. This name should be usable as an identifier for the module by machine processing applications such as code generation.

Support human navigation and code generation.

The name is not expected to be globally unique. The name should be a simple alpha-numeric type name to ensure that it is computable friendly.

The status of this expansion profile. Enables tracking the life-cycle of the content.

Allows filtering of expansion profiles that are appropriate for use vs. not.
This is labeled as "Is Modifier" because applications should not use a retired expansion profile without due consideration.

A boolean value to indicate that this expansion profile is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.

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

Allows filtering of expansion profile that are appropriate for use vs. not. This is labeled as "Is Modifier" because applications should not use an experimental expansion profile in production.

The date (and optionally time) when the expansion profile was published. The date must change if and 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 expansion profile changes.

Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the expansion profile. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.

The name of the individual or organization that published the expansion profile.

Helps establish the "authority/credibility" of the expansion profile. May also allow for contact.

Usually an organization, but may be an individual. The publisher (or steward) of the expansion profile is the organization or individual primarily responsible for the maintenance and upkeep of the expansion profile. 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 expansion profile. 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.

A free text natural language description of the expansion profile from a consumer's perspective.

This description can be used to capture details such as why the expansion profile was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the expansion profile as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the profile is presumed to be the predominant language in the place the profile was created).

The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate expansion profile instances.

Assist in searching for appropriate content.

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

A legal or geographic region in which the expansion profile is intended to be used.

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

Fix use of a particular code system to a particular version.

The specific system for which to fix the version.

See ''Coding.system'' for further documentation.

The version of the code system from which codes in the expansion should be included.

How to manage the intersection between a fixed version in a value set, and this fixed version of the system in the expansion profile.

Code system, or a particular version of a code system to be excluded from value set expansions.

When a system is excluded, and this makes a material difference to the expansion, the exclusion SHALL be noted in the expansion parameters using a parameter 'excluded'.

An absolute URI which is the code system to be excluded.

See ''Coding.system'' for further documentation.

The version of the code system from which codes in the expansion should be excluded.

This is used to apply version specifc exclusion contraints. If no version is specified, then all codes from the code system present in the expansion (prior to application of the expansion profile) will be excluded.

Controls whether concept designations are to be included or excluded in value set expansions.

ExpansionProfile.designation.include and ExpansionProfile.designation.exclude are only evaluated if includeDesignations is present and set to "true". If includeDesignations is present with a value of "true" and both ExpansionProfile.designation.include and ExpansionProfile.designation.exclude are absent, then all designations are returned in the expansion.

A set of criteria that provide the constraints imposed on the value set expansion by including or excluding designations.

Designations to be included.

A data group for each designation to be included.

At least one of designation.language or designation.use must be provided for each include.designation element.

The language this designation is defined for.

In the absence of a language, all designations are retained which match the designation.use parameter for this include.designation.

Which kinds of designation to include in the expansion.

In the absence of a use, all designations are retained which match the designation.language parameter for this include.designation element.

Designations to be excluded.

A data group for each designation to be excluded.

At least one of designation.language or designation.use must be provided for each exclude.designation element.

The language this designation is defined for.

In the absence of a language, all designations are excluded which match the designation.use parameter for this exclude.designation element.

Which kinds of designation to exclude from the expansion.

In the absence of a use, all designations are retained which match the designation.language parameter for this exclude.designation element.

Controls whether the value set definition is included or excluded in value set expansions.

The ValueSet defintion refers to all fields in the ValueSet definition apart from ValueSet.contains. The definition is only included if includeDefinition is present and has a value of "true".

Controls whether inactive concepts are included or excluded in value set expansions.

Inactive codes are included if activeOnly is present and has a value of "true". Note that if the value set explicitly specifies that inactive codes are included, this property can still remove them from a specific expansion, but this parameter cannot include them if the value set excludes them.

Controls whether or not the value set expansion nests codes or not (i.e. ValueSet.expansion.contains.contains).

Heirahical contains are useful for UI use, but not when validating. Code Generation etc. may depend on context.

Nesting of codes is excluded if excludeNested is present and has a value of "true".

Controls whether or not the value set expansion includes codes which cannot be displayed in user interfaces.

Codes which cannot be used in user interfaces will be excluded if excludeNotForUI is present and has a value of "true".

Controls whether or not the value set expansion includes post coordinated codes.

Post coordinated codes are excluded if excludePostCoordinated is present and has a value of "true".

Specifies the language to be used for description in the expansions i.e. the language to be used for ValueSet.expansion.contains.display.

If the value set being expanded is incomplete (because it is too big to expand), return a limited expansion (a subset) with an indicator that expansion is incomplete, using the extension http://hl7.org/fhir/StructureDefinition/valueset-toocostly.

This field overides the default behaviour (which is to return an error). This does not apply to expansions which are unbounded. Clients SHALL process the extension http://hl7.org/fhir/StructureDefinition/valueset-toocostly correctly if limitedExpansion = true.