Current Build
Vocabulary Work GroupMaturity Level: 2 Trial Use Compartments: Not linked to any defined compartments

Detailed Descriptions for the elements in the ExpansionProfile resource.

ExpansionProfile
Definition

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

Control1..1
Alternate NamesValueSetExpansionProfile
ExpansionProfile.url
Definition

An absolute URI that is used to identify this expansion profile when it is referenced in a specification, model, design or an instance. This SHOULD be globally unique, and SHOULD be a literal address at which this expansion profile is (or will be) published.

Control0..1
Typeuri
Requirements

Allows the expansion profile to be referenced by a single globally unique identifier.

Summarytrue
Comments

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

The URL SHOULD include the major version of the expansion profile. For more information see Technical and Business Versions.

ExpansionProfile.identifier
Definition

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.

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

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

Summarytrue
Comments

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.

ExpansionProfile.version
Definition

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.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
Summarytrue
Comments

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 reference to a particular business version of the expansion profile with the format [url]|[version].

ExpansionProfile.name
Definition

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.

Control0..1
Typestring
Requirements

Support human navigation and code generation.

Summarytrue
Comments

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.

ExpansionProfile.status
Definition

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

Control1..1
Terminology BindingPublicationStatus (Required)
Typecode
Is Modifiertrue (Reason: null)
Summarytrue
Comments

Allows filtering of expansion profiles that are appropriate for use vs. not.

ExpansionProfile.experimental
Definition

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.

Control0..1
Typeboolean
Is Modifiertrue (Reason: null)
Requirements

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

Summarytrue
Comments

Allows filtering of expansion profile that are appropriate for use vs. not.

ExpansionProfile.date
Definition

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.

Control0..1
TypedateTime
Alternate NamesRevision Date
Summarytrue
Comments

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.

ExpansionProfile.publisher
Definition

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

Control0..1
Typestring
Requirements

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

Summarytrue
Comments

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.

ExpansionProfile.contact
Definition

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

Control0..*
TypeContactDetail
Summarytrue
Comments

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

ExpansionProfile.description
Definition

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

Control0..1
Typemarkdown
Comments

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).

ExpansionProfile.useContext
Definition

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.

Control0..*
TypeUsageContext
Requirements

Assist in searching for appropriate content.

Summarytrue
Comments

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

ExpansionProfile.jurisdiction
Definition

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

Control0..*
Terminology BindingJurisdiction ValueSet (Extensible)
TypeCodeableConcept
Summarytrue
Comments

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

ExpansionProfile.fixedVersion
Definition

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

Control0..*
Summarytrue
ExpansionProfile.fixedVersion.system
Definition

The specific system for which to fix the version.

Control1..1
Typeuri
Summarytrue
Comments

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

ExpansionProfile.fixedVersion.version
Definition

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

NoteThis is a business versionId, not a resource version id (see discussion)
Control1..1
Typestring
Summarytrue
ExpansionProfile.fixedVersion.mode
Definition

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

Control1..1
Terminology BindingSystemVersionProcessingMode (Required)
Typecode
Summarytrue
ExpansionProfile.excludedSystem
Definition

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

Control0..1
Summarytrue
Comments

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'.

ExpansionProfile.excludedSystem.system
Definition

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

Control1..1
Typeuri
Summarytrue
Comments

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

ExpansionProfile.excludedSystem.version
Definition

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

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
Meaning if MissingExclusion is not version specific
Summarytrue
Comments

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.

ExpansionProfile.includeDesignations
Definition

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

Control0..1
Typeboolean
Summarytrue
Comments

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.

ExpansionProfile.designation
Definition

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

Control0..1
Summarytrue
ExpansionProfile.designation.include
Definition

Designations to be included.

Control0..1
Summarytrue
ExpansionProfile.designation.include.designation
Definition

A data group for each designation to be included.

Control0..*
Summarytrue
Comments

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

InvariantsDefined on this element
exp-3: SHALL have at least one of language or use (expression : language.exists() or use.exists(), xpath: exists(f:language) or exists(f:use))
ExpansionProfile.designation.include.designation.language
Definition

The language this designation is defined for.

Control0..1
Terminology BindingCommon Languages (Extensible but limited to ??)
Typecode
Summarytrue
Comments

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

ExpansionProfile.designation.include.designation.use
Definition

Which kinds of designation to include in the expansion.

Control0..1
Terminology BindingDesignation Use (Required)
TypeCoding
Summarytrue
Comments

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

ExpansionProfile.designation.exclude
Definition

Designations to be excluded.

Control0..1
Summarytrue
ExpansionProfile.designation.exclude.designation
Definition

A data group for each designation to be excluded.

Control0..*
Summarytrue
Comments

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

InvariantsDefined on this element
exp-4: SHALL have at least one of language or use (expression : language.exists() or use.exists(), xpath: exists(f:language) or exists(f:use))
ExpansionProfile.designation.exclude.designation.language
Definition

The language this designation is defined for.

Control0..1
Terminology BindingCommon Languages (Extensible but limited to ??)
Typecode
Summarytrue
Comments

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

ExpansionProfile.designation.exclude.designation.use
Definition

Which kinds of designation to exclude from the expansion.

Control0..1
Terminology BindingDesignation Use (Required)
TypeCoding
Summarytrue
Comments

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

ExpansionProfile.includeDefinition
Definition

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

Control0..1
Typeboolean
Default Valuefalse
Summarytrue
Comments

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".

ExpansionProfile.activeOnly
Definition

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

Control0..1
Typeboolean
Default Valuefalse
Summarytrue
Comments

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.

ExpansionProfile.excludeNested
Definition

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

Control0..1
Typeboolean
Requirements

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

Summarytrue
Comments

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

ExpansionProfile.excludeNotForUI
Definition

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

Control0..1
Typeboolean
Summarytrue
Comments

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

ExpansionProfile.excludePostCoordinated
Definition

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

Control0..1
Typeboolean
Summarytrue
Comments

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

ExpansionProfile.displayLanguage
Definition

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

Control0..1
Terminology BindingCommon Languages (Extensible but limited to ??)
Typecode
Summarytrue
ExpansionProfile.limitedExpansion
Definition

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.

Control0..1
Typeboolean
Summarytrue
Comments

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.