This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
Detailed Descriptions for the elements in the ExpansionProfile resource.
ExpansionProfile | |
Definition | Resource to define constraints on the Expansion of a FHIR ValueSet. |
Control | 1..1 |
Alternate Names | ValueSetExpansionProfile |
ExpansionProfile.url | |
Definition | An absolute URL 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. |
Control | 0..1 |
Type | uri |
Summary | true |
ExpansionProfile.identifier | |
Definition | 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. |
Note | This is a business identifer, not a resource identifier (see discussion) |
Control | 0..1 |
Type | Identifier |
Summary | true |
ExpansionProfile.version | |
Definition | Used to identify this version of the expansion profile when it is referenced in a specification, model, design or instance. |
Note | This is a business versionId, not a resource version id (see discussion) |
Control | 0..1 |
Type | string |
Summary | true |
Comments | There may be multiple resource versions of the expansion profile that have the same identifier. |
ExpansionProfile.name | |
Definition | A free text natural language name for the expansion profile. |
Control | 0..1 |
Type | string |
Requirements | Support human navigation. |
Summary | true |
Comments | The name is not expected to be unique. A name should be provided unless the expansion profile is a contained resource (e.g. an anonymous expansion profile in a FHIR profile). Most registries will require a name. |
ExpansionProfile.status | |
Definition | The status of the expansion profile. |
Control | 1..1 |
Binding | ConformanceResourceStatus: The lifecycle status of a Value Set or Concept Map. (Required) |
Type | code |
Is Modifier | true |
Requirements | Identify when/if the expansion profile should be used. |
Summary | true |
Comments | Allows filtering of expansion instances that are appropriate (or not) for use. |
ExpansionProfile.experimental | |
Definition | This expansion profile was authored for testing purposes (or education/evaluation/marketing), and is not intended for genuine production usage. |
Control | 0..1 |
Type | boolean |
Requirements | This expansion profile was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage. |
Summary | true |
Comments | Allows filtering of expansion instances that are appropriate (or not) for use. |
ExpansionProfile.publisher | |
Definition | The name of the individual or organization that published the expansion profile. |
Control | 0..1 |
Type | string |
Requirements | Helps establish the "authority/credibility" of the expansion profile. |
Summary | true |
Comments | Usually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context. |
ExpansionProfile.contact | |
Definition | Contacts to assist a user in finding and communicating with the publisher. |
Control | 0..* |
Summary | true |
Comments | May be a web site, an email address, a telephone number, etc. |
ExpansionProfile.contact.name | |
Definition | The name of an individual to contact regarding the expansion profile. |
Control | 0..1 |
Type | string |
Summary | true |
Comments | If there is no named individual, the telecom is for the organization as a whole. |
ExpansionProfile.contact.telecom | |
Definition | Contact details for individual (if a name was provided) or the publisher. |
Control | 0..* |
Type | ContactPoint |
Summary | true |
ExpansionProfile.date | |
Definition | The date that the expansion profile status was last changed. The date must change when the business version changes, if it does, and it must change if the status code changes. |
Control | 0..1 |
Type | dateTime |
Requirements | Need to know when an expansion profile was first legal for use or became withdrawn or replaced. |
Summary | true |
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. |
ExpansionProfile.description | |
Definition | A free text natural language description of the use of the expansion profile - reason for definition, conditions of use, etc. The description may include a list of expected usages for the expansion profile and can also describe the approach taken to build the expansion profile. |
Control | 0..1 |
Type | string |
Requirements | Human understandability. |
Summary | true |
Comments | The description is not intended to describe the semantics of the expansion profile. The description should capture its intended use, which is needed for ensuring integrity for its use in models across future changes. A description should be provided unless the expansion profile is a contained resource (e.g. an anonymous expansion profile in a FHIR profile). Most registries will require a description. |
ExpansionProfile.codeSystem | |
Definition | A set of criteria that provide the constraints imposed on the value set expansion by including or excluding codes from specific code systems (or versions). |
Control | 0..1 |
Summary | true |
Invariants | Defined on this element exp-1: SHALL NOT have include and exclude (expression: include.empty() or exclude.empty(), xpath: not(exists(f:include)) or not(exists(f:exclude))) |
ExpansionProfile.codeSystem.include | |
Definition | Code systems to be included in value set expansions. |
Control | 0..1 |
Summary | true |
ExpansionProfile.codeSystem.include.codeSystem | |
Definition | A data group for each code system to be included. |
Control | 1..* |
Summary | true |
ExpansionProfile.codeSystem.include.codeSystem.system | |
Definition | An absolute URI which is the code system to be included. |
Control | 1..1 |
Type | uri |
Summary | true |
Comments | See ''Coding.system'' for further documentation. |
ExpansionProfile.codeSystem.include.codeSystem.version | |
Definition | The version of the code system from which codes in the expansion should be included. |
Note | This is a business versionId, not a resource version id (see discussion) |
Control | 0..1 |
Type | string |
Summary | true |
Comments | This is used to apply version specifc inclusion 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 retained. |
ExpansionProfile.codeSystem.exclude | |
Definition | Code systems to be excluded from value set expansions. |
Control | 0..1 |
Summary | true |
ExpansionProfile.codeSystem.exclude.codeSystem | |
Definition | A data group for each code system to be excluded. |
Control | 1..* |
Summary | true |
ExpansionProfile.codeSystem.exclude.codeSystem.system | |
Definition | An absolute URI which is the code system to be excluded. |
Control | 1..1 |
Type | uri |
Summary | true |
Comments | See ''Coding.system'' for further documentation. |
ExpansionProfile.codeSystem.exclude.codeSystem.version | |
Definition | The version of the code system from which codes in the expansion should be excluded. |
Note | This is a business versionId, not a resource version id (see discussion) |
Control | 0..1 |
Type | string |
Summary | true |
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. |
Control | 0..1 |
Type | boolean |
Summary | true |
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. |
Control | 0..1 |
Summary | true |
Invariants | Defined on this element exp-2: SHALL NOT have include and exclude (expression: include.empty() or exclude.empty(), xpath: not(exists(f:include)) or not(exists(f:exclude))) |
ExpansionProfile.designation.include | |
Definition | Designations to be included. |
Control | 0..1 |
Summary | true |
ExpansionProfile.designation.include.designation | |
Definition | A data group for each designation to be included. |
Control | 0..* |
Summary | true |
Comments | At least one of designation.language or designation.use must be provided for each include.designation element. |
Invariants | Defined on this element exp-3: SHALL have at least one of language or use (expression: language.empty().not() or use.empty().not(), xpath: exists(f:language) or exists(f:use)) |
ExpansionProfile.designation.include.designation.language | |
Definition | The language this designation is defined for. |
Control | 0..1 |
Binding | Language : Required: IETF language tag (A human language.) |
Type | code |
Summary | true |
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 | Designation uses for inclusion in the expansion. |
Control | 0..1 |
Binding | Designation Use: Details of how a designation would be used. (Required) |
Type | Coding |
Summary | true |
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. |
Control | 0..1 |
Summary | true |
ExpansionProfile.designation.exclude.designation | |
Definition | A data group for each designation to be excluded. |
Control | 0..* |
Summary | true |
Comments | At least one of designation.language or designation.use must be provided for each exclude.designation element. |
Invariants | Defined on this element exp-4: SHALL have at least one of language or use (expression: language.empty().not() or use.empty().not(), xpath: exists(f:language) or exists(f:use)) |
ExpansionProfile.designation.exclude.designation.language | |
Definition | The language this designation is defined for. |
Control | 0..1 |
Binding | Language : Required: IETF language tag (A human language.) |
Type | code |
Summary | true |
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 | Designation uses for exclusion in the expansion. |
Control | 0..1 |
Binding | Designation Use: Details of how a designation would be used. (Required) |
Type | Coding |
Summary | true |
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. |
Control | 0..1 |
Type | boolean |
Summary | true |
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.includeInactive | |
Definition | Controls whether inactive concepts are included or excluded in value set expansions. |
Control | 0..1 |
Type | boolean |
Summary | true |
Comments | Inactive codes are included if includeInactive is present and has a value of "true". |
ExpansionProfile.excludeNested | |
Definition | Controls whether or not the value set expansion includes nested codes (i.e. ValueSet.expansion.contains.contains). |
Control | 0..1 |
Type | boolean |
Summary | true |
Comments | Nested codes 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. |
Control | 0..1 |
Type | boolean |
Summary | true |
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. |
Control | 0..1 |
Type | boolean |
Summary | true |
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. |
Control | 0..1 |
Binding | Language : Required: IETF language tag (A human language.) |
Type | code |
Summary | true |
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. |
Control | 0..1 |
Type | boolean |
Summary | true |
Comments | This field overides the default behaviour (which is to return an error). This does not apply to expansions which are unbounded. |