This page is part of the FHIR Specification (v1.2.0: STU 3 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
Vocabulary Work Group | Maturity Level: 0 | Compartments: Not linked to any defined compartments |
Resource to define constraints on the Expansion of a FHIR ValueSet.
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ExpansionProfile | DomainResource | Defines behaviour and contraints on the ValueSet Expansion operation | ||
url | Σ | 0..1 | uri | Globally unique logical identifier for expansion profile |
identifier | Σ | 0..1 | Identifier | Additional identifier for the expansion profile (e.g. an Object Identifier) |
version | Σ | 0..1 | string | Logical identifier for this version of the expansion profile |
name | Σ | 0..1 | string | Informal name for this expansion profile |
status | ?! Σ | 1..1 | code | draft | active | retired ConformanceResourceStatus (Required) |
experimental | Σ | 0..1 | boolean | If for testing purposes, not real usage |
publisher | Σ | 0..1 | string | Name of the publisher (organization or individual) |
contact | Σ | 0..* | BackboneElement | Contact details of the publisher |
name | Σ | 0..1 | string | Name of an individual to contact |
telecom | Σ | 0..* | ContactPoint | Contact details for individual or publisher |
date | Σ | 0..1 | dateTime | Date for given status |
description | Σ | 0..1 | string | Human language description of the expansion profile |
codeSystem | Σ I | 0..1 | BackboneElement | When the expansion profile imposes code system contraints SHALL NOT have include and exclude |
include | Σ | 0..1 | BackboneElement | Code systems to be included |
codeSystem | Σ | 1..* | BackboneElement | The code systems to be included |
system | Σ | 1..1 | uri | The specific code system to be included |
version | Σ | 0..1 | string | Specific version of the code system referred to |
exclude | Σ | 0..1 | BackboneElement | Code systems to be excluded |
codeSystem | Σ | 1..* | BackboneElement | The code systems to be excluded |
system | Σ | 1..1 | uri | The specific code system to be excluded |
version | Σ | 0..1 | string | Specific version of the code system referred to |
includeDesignations | Σ | 0..1 | boolean | Whether the expansion should include concept designations |
designation | Σ I | 0..1 | BackboneElement | When the expansion profile imposes designation contraints SHALL NOT have include and exclude |
include | Σ | 0..1 | BackboneElement | Designations to be included |
designation | Σ I | 0..* | BackboneElement | The designation to be included SHALL have at least one of language or use |
language | Σ | 0..1 | code | Human language of the designation to be included Language (Required) |
use | Σ | 0..1 | Coding | Designation use Designation Use (Required) |
exclude | Σ | 0..1 | BackboneElement | Designations to be excluded |
designation | Σ I | 0..* | BackboneElement | The designation to be excluded SHALL have at least one of language or use |
language | Σ | 0..1 | code | Human language of the designation to be excluded Language (Required) |
use | Σ | 0..1 | Coding | Designation use Designation Use (Required) |
includeDefinition | Σ | 0..1 | boolean | Include or exclude the value set definition in the expansion |
includeInactive | Σ | 0..1 | boolean | Include or exclude inactive concepts in the expansion |
excludeNested | Σ | 0..1 | boolean | Include or exclude nested codes in the value set expansion |
excludeNotForUI | Σ | 0..1 | boolean | Include or exclude codes which cannot be rendered in user interfaces in the value set expansion |
excludePostCoordinated | Σ | 0..1 | boolean | Include or exclude codes which are post coordinated expressions in the value set expansion |
displayLanguage | Σ | 0..1 | code | Specify the language for the display element of codes in the value set expansion Language (Required) |
limitedExpansion | Σ | 0..1 | boolean | Controls behaviour of the value set expand operation when value sets are too large to be completely expanded |
Documentation for this format |
UML Diagram
XML Template
<ExpansionProfile xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <url value="[uri]"/><!-- 0..1 Globally unique logical identifier for expansion profile --> <identifier><!-- 0..1 Identifier Additional identifier for the expansion profile (e.g. an Object Identifier) --></identifier> <version value="[string]"/><!-- 0..1 Logical identifier for this version of the expansion profile --> <name value="[string]"/><!-- 0..1 Informal name for this expansion profile --> <status value="[code]"/><!-- 1..1 draft | active | retired --> <experimental value="[boolean]"/><!-- 0..1 If for testing purposes, not real usage --> <publisher value="[string]"/><!-- 0..1 Name of the publisher (organization or individual) --> <contact> <!-- 0..* Contact details of the publisher --> <name value="[string]"/><!-- 0..1 Name of an individual to contact --> <telecom><!-- 0..* ContactPoint Contact details for individual or publisher --></telecom> </contact> <date value="[dateTime]"/><!-- 0..1 Date for given status --> <description value="[string]"/><!-- 0..1 Human language description of the expansion profile --> <codeSystem> <!-- 0..1 When the expansion profile imposes code system contraints --> <include> <!-- 0..1 Code systems to be included --> <codeSystem> <!-- 1..* The code systems to be included --> <system value="[uri]"/><!-- 1..1 The specific code system to be included --> <version value="[string]"/><!-- 0..1 Specific version of the code system referred to --> </codeSystem> </include> <exclude> <!-- 0..1 Code systems to be excluded --> <codeSystem> <!-- 1..* The code systems to be excluded --> <system value="[uri]"/><!-- 1..1 The specific code system to be excluded --> <version value="[string]"/><!-- 0..1 Specific version of the code system referred to --> </codeSystem> </exclude> </codeSystem> <includeDesignations value="[boolean]"/><!-- 0..1 Whether the expansion should include concept designations --> <designation> <!-- 0..1 When the expansion profile imposes designation contraints --> <include> <!-- 0..1 Designations to be included --> <designation> <!-- 0..* The designation to be included --> <language value="[code]"/><!-- 0..1 Human language of the designation to be included --> <use><!-- 0..1 Coding Designation use --></use> </designation> </include> <exclude> <!-- 0..1 Designations to be excluded --> <designation> <!-- 0..* The designation to be excluded --> <language value="[code]"/><!-- 0..1 Human language of the designation to be excluded --> <use><!-- 0..1 Coding Designation use --></use> </designation> </exclude> </designation> <includeDefinition value="[boolean]"/><!-- 0..1 Include or exclude the value set definition in the expansion --> <includeInactive value="[boolean]"/><!-- 0..1 Include or exclude inactive concepts in the expansion --> <excludeNested value="[boolean]"/><!-- 0..1 Include or exclude nested codes in the value set expansion --> <excludeNotForUI value="[boolean]"/><!-- 0..1 Include or exclude codes which cannot be rendered in user interfaces in the value set expansion --> <excludePostCoordinated value="[boolean]"/><!-- 0..1 Include or exclude codes which are post coordinated expressions in the value set expansion --> <displayLanguage value="[code]"/><!-- 0..1 Specify the language for the display element of codes in the value set expansion --> <limitedExpansion value="[boolean]"/><!-- 0..1 Controls behaviour of the value set expand operation when value sets are too large to be completely expanded --> </ExpansionProfile>
JSON Template
{ "resourceType" : "ExpansionProfile", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "url" : "<uri>", // Globally unique logical identifier for expansion profile "identifier" : { Identifier }, // Additional identifier for the expansion profile (e.g. an Object Identifier) "version" : "<string>", // Logical identifier for this version of the expansion profile "name" : "<string>", // Informal name for this expansion profile "status" : "<code>", // R! draft | active | retired "experimental" : <boolean>, // If for testing purposes, not real usage "publisher" : "<string>", // Name of the publisher (organization or individual) "contact" : [{ // Contact details of the publisher "name" : "<string>", // Name of an individual to contact "telecom" : [{ ContactPoint }] // Contact details for individual or publisher }], "date" : "<dateTime>", // Date for given status "description" : "<string>", // Human language description of the expansion profile "codeSystem" : { // When the expansion profile imposes code system contraints "include" : { // Code systems to be included "codeSystem" : [{ // R! The code systems to be included "system" : "<uri>", // R! The specific code system to be included "version" : "<string>" // Specific version of the code system referred to }] }, "exclude" : { // Code systems to be excluded "codeSystem" : [{ // R! The code systems to be excluded "system" : "<uri>", // R! The specific code system to be excluded "version" : "<string>" // Specific version of the code system referred to }] } }, "includeDesignations" : <boolean>, // Whether the expansion should include concept designations "designation" : { // When the expansion profile imposes designation contraints "include" : { // Designations to be included "designation" : [{ // The designation to be included "language" : "<code>", // Human language of the designation to be included "use" : { Coding } // Designation use }] }, "exclude" : { // Designations to be excluded "designation" : [{ // The designation to be excluded "language" : "<code>", // Human language of the designation to be excluded "use" : { Coding } // Designation use }] } }, "includeDefinition" : <boolean>, // Include or exclude the value set definition in the expansion "includeInactive" : <boolean>, // Include or exclude inactive concepts in the expansion "excludeNested" : <boolean>, // Include or exclude nested codes in the value set expansion "excludeNotForUI" : <boolean>, // Include or exclude codes which cannot be rendered in user interfaces in the value set expansion "excludePostCoordinated" : <boolean>, // Include or exclude codes which are post coordinated expressions in the value set expansion "displayLanguage" : "<code>", // Specify the language for the display element of codes in the value set expansion "limitedExpansion" : <boolean> // Controls behaviour of the value set expand operation when value sets are too large to be completely expanded }
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ExpansionProfile | DomainResource | Defines behaviour and contraints on the ValueSet Expansion operation | ||
url | Σ | 0..1 | uri | Globally unique logical identifier for expansion profile |
identifier | Σ | 0..1 | Identifier | Additional identifier for the expansion profile (e.g. an Object Identifier) |
version | Σ | 0..1 | string | Logical identifier for this version of the expansion profile |
name | Σ | 0..1 | string | Informal name for this expansion profile |
status | ?! Σ | 1..1 | code | draft | active | retired ConformanceResourceStatus (Required) |
experimental | Σ | 0..1 | boolean | If for testing purposes, not real usage |
publisher | Σ | 0..1 | string | Name of the publisher (organization or individual) |
contact | Σ | 0..* | BackboneElement | Contact details of the publisher |
name | Σ | 0..1 | string | Name of an individual to contact |
telecom | Σ | 0..* | ContactPoint | Contact details for individual or publisher |
date | Σ | 0..1 | dateTime | Date for given status |
description | Σ | 0..1 | string | Human language description of the expansion profile |
codeSystem | Σ I | 0..1 | BackboneElement | When the expansion profile imposes code system contraints SHALL NOT have include and exclude |
include | Σ | 0..1 | BackboneElement | Code systems to be included |
codeSystem | Σ | 1..* | BackboneElement | The code systems to be included |
system | Σ | 1..1 | uri | The specific code system to be included |
version | Σ | 0..1 | string | Specific version of the code system referred to |
exclude | Σ | 0..1 | BackboneElement | Code systems to be excluded |
codeSystem | Σ | 1..* | BackboneElement | The code systems to be excluded |
system | Σ | 1..1 | uri | The specific code system to be excluded |
version | Σ | 0..1 | string | Specific version of the code system referred to |
includeDesignations | Σ | 0..1 | boolean | Whether the expansion should include concept designations |
designation | Σ I | 0..1 | BackboneElement | When the expansion profile imposes designation contraints SHALL NOT have include and exclude |
include | Σ | 0..1 | BackboneElement | Designations to be included |
designation | Σ I | 0..* | BackboneElement | The designation to be included SHALL have at least one of language or use |
language | Σ | 0..1 | code | Human language of the designation to be included Language (Required) |
use | Σ | 0..1 | Coding | Designation use Designation Use (Required) |
exclude | Σ | 0..1 | BackboneElement | Designations to be excluded |
designation | Σ I | 0..* | BackboneElement | The designation to be excluded SHALL have at least one of language or use |
language | Σ | 0..1 | code | Human language of the designation to be excluded Language (Required) |
use | Σ | 0..1 | Coding | Designation use Designation Use (Required) |
includeDefinition | Σ | 0..1 | boolean | Include or exclude the value set definition in the expansion |
includeInactive | Σ | 0..1 | boolean | Include or exclude inactive concepts in the expansion |
excludeNested | Σ | 0..1 | boolean | Include or exclude nested codes in the value set expansion |
excludeNotForUI | Σ | 0..1 | boolean | Include or exclude codes which cannot be rendered in user interfaces in the value set expansion |
excludePostCoordinated | Σ | 0..1 | boolean | Include or exclude codes which are post coordinated expressions in the value set expansion |
displayLanguage | Σ | 0..1 | code | Specify the language for the display element of codes in the value set expansion Language (Required) |
limitedExpansion | Σ | 0..1 | boolean | Controls behaviour of the value set expand operation when value sets are too large to be completely expanded |
Documentation for this format |
XML Template
<ExpansionProfile xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <url value="[uri]"/><!-- 0..1 Globally unique logical identifier for expansion profile --> <identifier><!-- 0..1 Identifier Additional identifier for the expansion profile (e.g. an Object Identifier) --></identifier> <version value="[string]"/><!-- 0..1 Logical identifier for this version of the expansion profile --> <name value="[string]"/><!-- 0..1 Informal name for this expansion profile --> <status value="[code]"/><!-- 1..1 draft | active | retired --> <experimental value="[boolean]"/><!-- 0..1 If for testing purposes, not real usage --> <publisher value="[string]"/><!-- 0..1 Name of the publisher (organization or individual) --> <contact> <!-- 0..* Contact details of the publisher --> <name value="[string]"/><!-- 0..1 Name of an individual to contact --> <telecom><!-- 0..* ContactPoint Contact details for individual or publisher --></telecom> </contact> <date value="[dateTime]"/><!-- 0..1 Date for given status --> <description value="[string]"/><!-- 0..1 Human language description of the expansion profile --> <codeSystem> <!-- 0..1 When the expansion profile imposes code system contraints --> <include> <!-- 0..1 Code systems to be included --> <codeSystem> <!-- 1..* The code systems to be included --> <system value="[uri]"/><!-- 1..1 The specific code system to be included --> <version value="[string]"/><!-- 0..1 Specific version of the code system referred to --> </codeSystem> </include> <exclude> <!-- 0..1 Code systems to be excluded --> <codeSystem> <!-- 1..* The code systems to be excluded --> <system value="[uri]"/><!-- 1..1 The specific code system to be excluded --> <version value="[string]"/><!-- 0..1 Specific version of the code system referred to --> </codeSystem> </exclude> </codeSystem> <includeDesignations value="[boolean]"/><!-- 0..1 Whether the expansion should include concept designations --> <designation> <!-- 0..1 When the expansion profile imposes designation contraints --> <include> <!-- 0..1 Designations to be included --> <designation> <!-- 0..* The designation to be included --> <language value="[code]"/><!-- 0..1 Human language of the designation to be included --> <use><!-- 0..1 Coding Designation use --></use> </designation> </include> <exclude> <!-- 0..1 Designations to be excluded --> <designation> <!-- 0..* The designation to be excluded --> <language value="[code]"/><!-- 0..1 Human language of the designation to be excluded --> <use><!-- 0..1 Coding Designation use --></use> </designation> </exclude> </designation> <includeDefinition value="[boolean]"/><!-- 0..1 Include or exclude the value set definition in the expansion --> <includeInactive value="[boolean]"/><!-- 0..1 Include or exclude inactive concepts in the expansion --> <excludeNested value="[boolean]"/><!-- 0..1 Include or exclude nested codes in the value set expansion --> <excludeNotForUI value="[boolean]"/><!-- 0..1 Include or exclude codes which cannot be rendered in user interfaces in the value set expansion --> <excludePostCoordinated value="[boolean]"/><!-- 0..1 Include or exclude codes which are post coordinated expressions in the value set expansion --> <displayLanguage value="[code]"/><!-- 0..1 Specify the language for the display element of codes in the value set expansion --> <limitedExpansion value="[boolean]"/><!-- 0..1 Controls behaviour of the value set expand operation when value sets are too large to be completely expanded --> </ExpansionProfile>
JSON Template
{ "resourceType" : "ExpansionProfile", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "url" : "<uri>", // Globally unique logical identifier for expansion profile "identifier" : { Identifier }, // Additional identifier for the expansion profile (e.g. an Object Identifier) "version" : "<string>", // Logical identifier for this version of the expansion profile "name" : "<string>", // Informal name for this expansion profile "status" : "<code>", // R! draft | active | retired "experimental" : <boolean>, // If for testing purposes, not real usage "publisher" : "<string>", // Name of the publisher (organization or individual) "contact" : [{ // Contact details of the publisher "name" : "<string>", // Name of an individual to contact "telecom" : [{ ContactPoint }] // Contact details for individual or publisher }], "date" : "<dateTime>", // Date for given status "description" : "<string>", // Human language description of the expansion profile "codeSystem" : { // When the expansion profile imposes code system contraints "include" : { // Code systems to be included "codeSystem" : [{ // R! The code systems to be included "system" : "<uri>", // R! The specific code system to be included "version" : "<string>" // Specific version of the code system referred to }] }, "exclude" : { // Code systems to be excluded "codeSystem" : [{ // R! The code systems to be excluded "system" : "<uri>", // R! The specific code system to be excluded "version" : "<string>" // Specific version of the code system referred to }] } }, "includeDesignations" : <boolean>, // Whether the expansion should include concept designations "designation" : { // When the expansion profile imposes designation contraints "include" : { // Designations to be included "designation" : [{ // The designation to be included "language" : "<code>", // Human language of the designation to be included "use" : { Coding } // Designation use }] }, "exclude" : { // Designations to be excluded "designation" : [{ // The designation to be excluded "language" : "<code>", // Human language of the designation to be excluded "use" : { Coding } // Designation use }] } }, "includeDefinition" : <boolean>, // Include or exclude the value set definition in the expansion "includeInactive" : <boolean>, // Include or exclude inactive concepts in the expansion "excludeNested" : <boolean>, // Include or exclude nested codes in the value set expansion "excludeNotForUI" : <boolean>, // Include or exclude codes which cannot be rendered in user interfaces in the value set expansion "excludePostCoordinated" : <boolean>, // Include or exclude codes which are post coordinated expressions in the value set expansion "displayLanguage" : "<code>", // Specify the language for the display element of codes in the value set expansion "limitedExpansion" : <boolean> // Controls behaviour of the value set expand operation when value sets are too large to be completely expanded }
Alternate definitions: Schema/Schematron, Resource Profile (XML, JSON), Questionnaire
Path | Definition | Type | Reference |
---|---|---|---|
ExpansionProfile.status | The lifecycle status of a Value Set or Concept Map. | Required | ConformanceResourceStatus |
ExpansionProfile.designation.include.designation.language ExpansionProfile.designation.exclude.designation.language ExpansionProfile.displayLanguage | A human language. | Required | IETF language tag |
ExpansionProfile.designation.include.designation.use ExpansionProfile.designation.exclude.designation.use | Details of how a designation would be used. | Required | Designation Use |
Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.
Name | Type | Description | Paths |
date | date | The expansion profile publication date | ExpansionProfile.date |
description | string | Text search in the description of the expansion profile | ExpansionProfile.description |
identifier | token | The identifier for the expansion profile | ExpansionProfile.identifier |
name | string | The name of the expansion profile | ExpansionProfile.name |
publisher | string | Name of the publisher of the expansion profile | ExpansionProfile.publisher |
status | token | The status of the expansion profile | ExpansionProfile.status |
url | uri | The logical URL for the expansion profile | ExpansionProfile.url |
version | token | The version identifier of the expansion profile | ExpansionProfile.version |