STU 3 Ballot

This page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

4.8 Resource ExpansionProfile - Content

Vocabulary Work GroupMaturity Level: 0Compartments: Not linked to any defined compartments

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

4.8.1 Scope and Usage

Todo

4.8.2 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. ExpansionProfile DomainResourceDefines behaviour and contraints on the ValueSet Expansion operation
... url Σ0..1uriGlobally unique logical identifier for expansion profile
... identifier Σ0..1IdentifierAdditional identifier for the expansion profile (e.g. an Object Identifier)
... version Σ0..1stringLogical identifier for this version of the expansion profile
... name Σ0..1stringInformal name for this expansion profile
... status ?!Σ1..1codedraft | active | retired
ConformanceResourceStatus (Required)
... experimental Σ0..1booleanIf for testing purposes, not real usage
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*BackboneElementContact details of the publisher
.... name Σ0..1stringName of an individual to contact
.... telecom Σ0..*ContactPointContact details for individual or publisher
... date Σ0..1dateTimeDate for given status
... description Σ0..1markdownHuman language description of the expansion profile
... codeSystem ΣI0..1BackboneElementWhen the expansion profile imposes code system contraints
SHALL NOT have include and exclude
.... include Σ0..1BackboneElementCode systems to be included
..... codeSystem Σ1..*BackboneElementThe code systems to be included
...... system Σ1..1uriThe specific code system to be included
...... version Σ0..1stringSpecific version of the code system referred to
.... exclude Σ0..1BackboneElementCode systems to be excluded
..... codeSystem Σ1..*BackboneElementThe code systems to be excluded
...... system Σ1..1uriThe specific code system to be excluded
...... version Σ0..1stringSpecific version of the code system referred to
... includeDesignations Σ0..1booleanWhether the expansion should include concept designations
... designation ΣI0..1BackboneElementWhen the expansion profile imposes designation contraints
SHALL NOT have include and exclude
.... include Σ0..1BackboneElementDesignations to be included
..... designation ΣI0..*BackboneElementThe designation to be included
SHALL have at least one of language or use
...... language Σ0..1codeHuman language of the designation to be included
Common Languages (Extensible but limited to All Languages)
...... use Σ0..1CodingDesignation use
Designation Use (Required)
.... exclude Σ0..1BackboneElementDesignations to be excluded
..... designation ΣI0..*BackboneElementThe designation to be excluded
SHALL have at least one of language or use
...... language Σ0..1codeHuman language of the designation to be excluded
Common Languages (Extensible but limited to All Languages)
...... use Σ0..1CodingDesignation use
Designation Use (Required)
... includeDefinition Σ0..1booleanInclude or exclude the value set definition in the expansion
... includeInactive Σ0..1booleanInclude or exclude inactive concepts in the expansion
... excludeNested Σ0..1booleanInclude or exclude nested codes in the value set expansion
... excludeNotForUI Σ0..1booleanInclude or exclude codes which cannot be rendered in user interfaces in the value set expansion
... excludePostCoordinated Σ0..1booleanInclude or exclude codes which are post coordinated expressions in the value set expansion
... displayLanguage Σ0..1codeSpecify the language for the display element of codes in the value set expansion
Common Languages (Extensible but limited to All Languages)
... limitedExpansion Σ0..1booleanControls behaviour of the value set expand operation when value sets are too large to be completely expanded

doco Documentation for this format

UML Diagram (Legend)

ExpansionProfile (DomainResource)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) publishedurl : uri [0..1]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 instanceidentifier : Identifier [0..1]Used to identify this version of the expansion profile when it is referenced in a specification, model, design or instanceversion : string [0..1]A free text natural language name for the expansion profilename : string [0..1]The status of the expansion profile (this element modifies the meaning of other elements)status : code [1..1] « The lifecycle status of a Value Set or Concept Map. (Strength=Required)ConformanceResourceStatus! »This expansion profile was authored for testing purposes (or education/evaluation/marketing), and is not intended for genuine production usageexperimental : boolean [0..1]The name of the individual or organization that published the expansion profilepublisher : string [0..1]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 changesdate : dateTime [0..1]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 profiledescription : markdown [0..1]Controls whether concept designations are to be included or excluded in value set expansionsincludeDesignations : boolean [0..1]Controls whether the value set definition is included or excluded in value set expansionsincludeDefinition : boolean [0..1]Controls whether inactive concepts are included or excluded in value set expansionsincludeInactive : boolean [0..1]Controls whether or not the value set expansion includes nested codes (i.e. ValueSet.expansion.contains.contains)excludeNested : boolean [0..1]Controls whether or not the value set expansion includes codes which cannot be displayed in user interfacesexcludeNotForUI : boolean [0..1]Controls whether or not the value set expansion includes post coordinated codesexcludePostCoordinated : boolean [0..1]Specifies the language to be used for description in the expansions i.e. the language to be used for ValueSet.expansion.contains.displaydisplayLanguage : code [0..1] « A human language. (Strength=Extensible)Common Languages+ »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 incompletelimitedExpansion : boolean [0..1]ContactThe name of an individual to contact regarding the expansion profilename : string [0..1]Contact details for individual (if a name was provided) or the publishertelecom : ContactPoint [0..*]CodeSystemCodeSystemIncludeCodeSystemIncludeCodeSystemAn absolute URI which is the code system to be includedsystem : uri [1..1]The version of the code system from which codes in the expansion should be includedversion : string [0..1]CodeSystemExcludeCodeSystemExcludeCodeSystemAn absolute URI which is the code system to be excludedsystem : uri [1..1]The version of the code system from which codes in the expansion should be excludedversion : string [0..1]DesignationDesignationIncludeDesignationIncludeDesignationThe language this designation is defined forlanguage : code [0..1] « A human language. (Strength=Extensible)Common Languages+ »Designation uses for inclusion in the expansionuse : Coding [0..1] « Details of how a designation would be used. (Strength=Required)Designation Use! »DesignationExcludeDesignationExcludeDesignationThe language this designation is defined forlanguage : code [0..1] « A human language. (Strength=Extensible)Common Languages+ »Designation uses for exclusion in the expansionuse : Coding [0..1] « Details of how a designation would be used. (Strength=Required)Designation Use! »Contacts to assist a user in finding and communicating with the publishercontact[0..*]A data group for each code system to be includedcodeSystem[1..*]Code systems to be included in value set expansionsinclude[0..1]A data group for each code system to be excludedcodeSystem[1..*]Code systems to be excluded from value set expansionsexclude[0..1]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)codeSystem[0..1]A data group for each designation to be includeddesignation[0..*]A data group for each designation to be excludeddesignation[0..*]A set of criteria that provide the constraints imposed on the value set expansion by including or excluding designationsdesignation[0..1]

XML Template

<ExpansionProfile xmlns="http://hl7.org/fhir"> doco
 <!-- 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="[markdown]"/><!-- 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

{doco
  "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" : "<markdown>", // 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
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:ExpansionProfile;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:ExpansionProfile.url [ uri ]; # 0..1 Globally unique logical identifier for  expansion profile
  fhir:ExpansionProfile.identifier [ Identifier ]; # 0..1 Additional identifier for the expansion profile (e.g. an Object Identifier)
  fhir:ExpansionProfile.version [ string ]; # 0..1 Logical identifier for this version of the expansion profile
  fhir:ExpansionProfile.name [ string ]; # 0..1 Informal name for this expansion profile
  fhir:ExpansionProfile.status [ code ]; # 1..1 draft | active | retired
  fhir:ExpansionProfile.experimental [ boolean ]; # 0..1 If for testing purposes, not real usage
  fhir:ExpansionProfile.publisher [ string ]; # 0..1 Name of the publisher (organization or individual)
  fhir:ExpansionProfile.contact [ # 0..* Contact details of the publisher
    fhir:ExpansionProfile.contact.name [ string ]; # 0..1 Name of an individual to contact
    fhir:ExpansionProfile.contact.telecom [ ContactPoint ], ... ; # 0..* Contact details for individual or publisher
  ], ...;
  fhir:ExpansionProfile.date [ dateTime ]; # 0..1 Date for given status
  fhir:ExpansionProfile.description [ markdown ]; # 0..1 Human language description of the expansion profile
  fhir:ExpansionProfile.codeSystem [ # 0..1 When the expansion profile imposes code system contraints
    fhir:ExpansionProfile.codeSystem.include [ # 0..1 Code systems to be included
      fhir:ExpansionProfile.codeSystem.include.codeSystem [ # 1..* The code systems to be included
        fhir:ExpansionProfile.codeSystem.include.codeSystem.system [ uri ]; # 1..1 The specific code system to be included
        fhir:ExpansionProfile.codeSystem.include.codeSystem.version [ string ]; # 0..1 Specific version of the code system referred to
      ], ...;
    ];
    fhir:ExpansionProfile.codeSystem.exclude [ # 0..1 Code systems to be excluded
      fhir:ExpansionProfile.codeSystem.exclude.codeSystem [ # 1..* The code systems to be excluded
        fhir:ExpansionProfile.codeSystem.exclude.codeSystem.system [ uri ]; # 1..1 The specific code system to be excluded
        fhir:ExpansionProfile.codeSystem.exclude.codeSystem.version [ string ]; # 0..1 Specific version of the code system referred to
      ], ...;
    ];
  ];
  fhir:ExpansionProfile.includeDesignations [ boolean ]; # 0..1 Whether the expansion should include concept designations
  fhir:ExpansionProfile.designation [ # 0..1 When the expansion profile imposes designation contraints
    fhir:ExpansionProfile.designation.include [ # 0..1 Designations to be included
      fhir:ExpansionProfile.designation.include.designation [ # 0..* The designation to be included
        fhir:ExpansionProfile.designation.include.designation.language [ code ]; # 0..1 Human language of the designation to be included
        fhir:ExpansionProfile.designation.include.designation.use [ Coding ]; # 0..1 Designation use
      ], ...;
    ];
    fhir:ExpansionProfile.designation.exclude [ # 0..1 Designations to be excluded
      fhir:ExpansionProfile.designation.exclude.designation [ # 0..* The designation to be excluded
        fhir:ExpansionProfile.designation.exclude.designation.language [ code ]; # 0..1 Human language of the designation to be excluded
        fhir:ExpansionProfile.designation.exclude.designation.use [ Coding ]; # 0..1 Designation use
      ], ...;
    ];
  ];
  fhir:ExpansionProfile.includeDefinition [ boolean ]; # 0..1 Include or exclude the value set definition in the expansion
  fhir:ExpansionProfile.includeInactive [ boolean ]; # 0..1 Include or exclude inactive concepts in the expansion
  fhir:ExpansionProfile.excludeNested [ boolean ]; # 0..1 Include or exclude nested codes in the value set expansion
  fhir:ExpansionProfile.excludeNotForUI [ boolean ]; # 0..1 Include or exclude codes which cannot be rendered in user interfaces in the value set expansion
  fhir:ExpansionProfile.excludePostCoordinated [ boolean ]; # 0..1 Include or exclude codes which are post coordinated expressions in the value set expansion
  fhir:ExpansionProfile.displayLanguage [ code ]; # 0..1 Specify the language for the display element of codes in the value set expansion
  fhir:ExpansionProfile.limitedExpansion [ boolean ]; # 0..1 Controls behaviour of the value set expand operation when value sets are too large to be completely expanded
]

Changes since DSTU2

This resource did not exist in Release 2

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. ExpansionProfile DomainResourceDefines behaviour and contraints on the ValueSet Expansion operation
... url Σ0..1uriGlobally unique logical identifier for expansion profile
... identifier Σ0..1IdentifierAdditional identifier for the expansion profile (e.g. an Object Identifier)
... version Σ0..1stringLogical identifier for this version of the expansion profile
... name Σ0..1stringInformal name for this expansion profile
... status ?!Σ1..1codedraft | active | retired
ConformanceResourceStatus (Required)
... experimental Σ0..1booleanIf for testing purposes, not real usage
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*BackboneElementContact details of the publisher
.... name Σ0..1stringName of an individual to contact
.... telecom Σ0..*ContactPointContact details for individual or publisher
... date Σ0..1dateTimeDate for given status
... description Σ0..1markdownHuman language description of the expansion profile
... codeSystem ΣI0..1BackboneElementWhen the expansion profile imposes code system contraints
SHALL NOT have include and exclude
.... include Σ0..1BackboneElementCode systems to be included
..... codeSystem Σ1..*BackboneElementThe code systems to be included
...... system Σ1..1uriThe specific code system to be included
...... version Σ0..1stringSpecific version of the code system referred to
.... exclude Σ0..1BackboneElementCode systems to be excluded
..... codeSystem Σ1..*BackboneElementThe code systems to be excluded
...... system Σ1..1uriThe specific code system to be excluded
...... version Σ0..1stringSpecific version of the code system referred to
... includeDesignations Σ0..1booleanWhether the expansion should include concept designations
... designation ΣI0..1BackboneElementWhen the expansion profile imposes designation contraints
SHALL NOT have include and exclude
.... include Σ0..1BackboneElementDesignations to be included
..... designation ΣI0..*BackboneElementThe designation to be included
SHALL have at least one of language or use
...... language Σ0..1codeHuman language of the designation to be included
Common Languages (Extensible but limited to All Languages)
...... use Σ0..1CodingDesignation use
Designation Use (Required)
.... exclude Σ0..1BackboneElementDesignations to be excluded
..... designation ΣI0..*BackboneElementThe designation to be excluded
SHALL have at least one of language or use
...... language Σ0..1codeHuman language of the designation to be excluded
Common Languages (Extensible but limited to All Languages)
...... use Σ0..1CodingDesignation use
Designation Use (Required)
... includeDefinition Σ0..1booleanInclude or exclude the value set definition in the expansion
... includeInactive Σ0..1booleanInclude or exclude inactive concepts in the expansion
... excludeNested Σ0..1booleanInclude or exclude nested codes in the value set expansion
... excludeNotForUI Σ0..1booleanInclude or exclude codes which cannot be rendered in user interfaces in the value set expansion
... excludePostCoordinated Σ0..1booleanInclude or exclude codes which are post coordinated expressions in the value set expansion
... displayLanguage Σ0..1codeSpecify the language for the display element of codes in the value set expansion
Common Languages (Extensible but limited to All Languages)
... limitedExpansion Σ0..1booleanControls behaviour of the value set expand operation when value sets are too large to be completely expanded

doco Documentation for this format

UML Diagram (Legend)

ExpansionProfile (DomainResource)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) publishedurl : uri [0..1]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 instanceidentifier : Identifier [0..1]Used to identify this version of the expansion profile when it is referenced in a specification, model, design or instanceversion : string [0..1]A free text natural language name for the expansion profilename : string [0..1]The status of the expansion profile (this element modifies the meaning of other elements)status : code [1..1] « The lifecycle status of a Value Set or Concept Map. (Strength=Required)ConformanceResourceStatus! »This expansion profile was authored for testing purposes (or education/evaluation/marketing), and is not intended for genuine production usageexperimental : boolean [0..1]The name of the individual or organization that published the expansion profilepublisher : string [0..1]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 changesdate : dateTime [0..1]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 profiledescription : markdown [0..1]Controls whether concept designations are to be included or excluded in value set expansionsincludeDesignations : boolean [0..1]Controls whether the value set definition is included or excluded in value set expansionsincludeDefinition : boolean [0..1]Controls whether inactive concepts are included or excluded in value set expansionsincludeInactive : boolean [0..1]Controls whether or not the value set expansion includes nested codes (i.e. ValueSet.expansion.contains.contains)excludeNested : boolean [0..1]Controls whether or not the value set expansion includes codes which cannot be displayed in user interfacesexcludeNotForUI : boolean [0..1]Controls whether or not the value set expansion includes post coordinated codesexcludePostCoordinated : boolean [0..1]Specifies the language to be used for description in the expansions i.e. the language to be used for ValueSet.expansion.contains.displaydisplayLanguage : code [0..1] « A human language. (Strength=Extensible)Common Languages+ »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 incompletelimitedExpansion : boolean [0..1]ContactThe name of an individual to contact regarding the expansion profilename : string [0..1]Contact details for individual (if a name was provided) or the publishertelecom : ContactPoint [0..*]CodeSystemCodeSystemIncludeCodeSystemIncludeCodeSystemAn absolute URI which is the code system to be includedsystem : uri [1..1]The version of the code system from which codes in the expansion should be includedversion : string [0..1]CodeSystemExcludeCodeSystemExcludeCodeSystemAn absolute URI which is the code system to be excludedsystem : uri [1..1]The version of the code system from which codes in the expansion should be excludedversion : string [0..1]DesignationDesignationIncludeDesignationIncludeDesignationThe language this designation is defined forlanguage : code [0..1] « A human language. (Strength=Extensible)Common Languages+ »Designation uses for inclusion in the expansionuse : Coding [0..1] « Details of how a designation would be used. (Strength=Required)Designation Use! »DesignationExcludeDesignationExcludeDesignationThe language this designation is defined forlanguage : code [0..1] « A human language. (Strength=Extensible)Common Languages+ »Designation uses for exclusion in the expansionuse : Coding [0..1] « Details of how a designation would be used. (Strength=Required)Designation Use! »Contacts to assist a user in finding and communicating with the publishercontact[0..*]A data group for each code system to be includedcodeSystem[1..*]Code systems to be included in value set expansionsinclude[0..1]A data group for each code system to be excludedcodeSystem[1..*]Code systems to be excluded from value set expansionsexclude[0..1]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)codeSystem[0..1]A data group for each designation to be includeddesignation[0..*]A data group for each designation to be excludeddesignation[0..*]A set of criteria that provide the constraints imposed on the value set expansion by including or excluding designationsdesignation[0..1]

XML Template

<ExpansionProfile xmlns="http://hl7.org/fhir"> doco
 <!-- 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="[markdown]"/><!-- 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

{doco
  "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" : "<markdown>", // 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
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:ExpansionProfile;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:ExpansionProfile.url [ uri ]; # 0..1 Globally unique logical identifier for  expansion profile
  fhir:ExpansionProfile.identifier [ Identifier ]; # 0..1 Additional identifier for the expansion profile (e.g. an Object Identifier)
  fhir:ExpansionProfile.version [ string ]; # 0..1 Logical identifier for this version of the expansion profile
  fhir:ExpansionProfile.name [ string ]; # 0..1 Informal name for this expansion profile
  fhir:ExpansionProfile.status [ code ]; # 1..1 draft | active | retired
  fhir:ExpansionProfile.experimental [ boolean ]; # 0..1 If for testing purposes, not real usage
  fhir:ExpansionProfile.publisher [ string ]; # 0..1 Name of the publisher (organization or individual)
  fhir:ExpansionProfile.contact [ # 0..* Contact details of the publisher
    fhir:ExpansionProfile.contact.name [ string ]; # 0..1 Name of an individual to contact
    fhir:ExpansionProfile.contact.telecom [ ContactPoint ], ... ; # 0..* Contact details for individual or publisher
  ], ...;
  fhir:ExpansionProfile.date [ dateTime ]; # 0..1 Date for given status
  fhir:ExpansionProfile.description [ markdown ]; # 0..1 Human language description of the expansion profile
  fhir:ExpansionProfile.codeSystem [ # 0..1 When the expansion profile imposes code system contraints
    fhir:ExpansionProfile.codeSystem.include [ # 0..1 Code systems to be included
      fhir:ExpansionProfile.codeSystem.include.codeSystem [ # 1..* The code systems to be included
        fhir:ExpansionProfile.codeSystem.include.codeSystem.system [ uri ]; # 1..1 The specific code system to be included
        fhir:ExpansionProfile.codeSystem.include.codeSystem.version [ string ]; # 0..1 Specific version of the code system referred to
      ], ...;
    ];
    fhir:ExpansionProfile.codeSystem.exclude [ # 0..1 Code systems to be excluded
      fhir:ExpansionProfile.codeSystem.exclude.codeSystem [ # 1..* The code systems to be excluded
        fhir:ExpansionProfile.codeSystem.exclude.codeSystem.system [ uri ]; # 1..1 The specific code system to be excluded
        fhir:ExpansionProfile.codeSystem.exclude.codeSystem.version [ string ]; # 0..1 Specific version of the code system referred to
      ], ...;
    ];
  ];
  fhir:ExpansionProfile.includeDesignations [ boolean ]; # 0..1 Whether the expansion should include concept designations
  fhir:ExpansionProfile.designation [ # 0..1 When the expansion profile imposes designation contraints
    fhir:ExpansionProfile.designation.include [ # 0..1 Designations to be included
      fhir:ExpansionProfile.designation.include.designation [ # 0..* The designation to be included
        fhir:ExpansionProfile.designation.include.designation.language [ code ]; # 0..1 Human language of the designation to be included
        fhir:ExpansionProfile.designation.include.designation.use [ Coding ]; # 0..1 Designation use
      ], ...;
    ];
    fhir:ExpansionProfile.designation.exclude [ # 0..1 Designations to be excluded
      fhir:ExpansionProfile.designation.exclude.designation [ # 0..* The designation to be excluded
        fhir:ExpansionProfile.designation.exclude.designation.language [ code ]; # 0..1 Human language of the designation to be excluded
        fhir:ExpansionProfile.designation.exclude.designation.use [ Coding ]; # 0..1 Designation use
      ], ...;
    ];
  ];
  fhir:ExpansionProfile.includeDefinition [ boolean ]; # 0..1 Include or exclude the value set definition in the expansion
  fhir:ExpansionProfile.includeInactive [ boolean ]; # 0..1 Include or exclude inactive concepts in the expansion
  fhir:ExpansionProfile.excludeNested [ boolean ]; # 0..1 Include or exclude nested codes in the value set expansion
  fhir:ExpansionProfile.excludeNotForUI [ boolean ]; # 0..1 Include or exclude codes which cannot be rendered in user interfaces in the value set expansion
  fhir:ExpansionProfile.excludePostCoordinated [ boolean ]; # 0..1 Include or exclude codes which are post coordinated expressions in the value set expansion
  fhir:ExpansionProfile.displayLanguage [ code ]; # 0..1 Specify the language for the display element of codes in the value set expansion
  fhir:ExpansionProfile.limitedExpansion [ boolean ]; # 0..1 Controls behaviour of the value set expand operation when value sets are too large to be completely expanded
]

Changes since DSTU2

This resource did not exist in Release 2

 

Alternate definitions: Master Definition (XML, JSON), XML Schema/Schematron (for ) + JSON Schema, ShEx (for Turtle)

4.8.2.1 Terminology Bindings

PathDefinitionTypeReference
ExpansionProfile.status The lifecycle status of a Value Set or Concept Map.RequiredConformanceResourceStatus
ExpansionProfile.designation.include.designation.language
ExpansionProfile.designation.exclude.designation.language
ExpansionProfile.displayLanguage
A human language.Extensible, but limited to All LanguagesCommon Languages
ExpansionProfile.designation.include.designation.use
ExpansionProfile.designation.exclude.designation.use
Details of how a designation would be used.RequiredDesignation Use

4.8.2.2 Constraints

  • exp-1: On ExpansionProfile.codeSystem: SHALL NOT have include and exclude (expression on ExpansionProfile.codeSystem: include.empty() or exclude.empty())
  • exp-2: On ExpansionProfile.designation: SHALL NOT have include and exclude (expression on ExpansionProfile.designation: include.empty() or exclude.empty())
  • exp-3: On ExpansionProfile.designation.include.designation: SHALL have at least one of language or use (expression on ExpansionProfile.designation.include.designation: language.empty().not() or use.empty().not())
  • exp-4: On ExpansionProfile.designation.exclude.designation: SHALL have at least one of language or use (expression on ExpansionProfile.designation.exclude.designation: language.empty().not() or use.empty().not())

4.8.3 Search Parameters

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionPaths
datedateThe expansion profile publication dateExpansionProfile.date
descriptionstringText search in the description of the expansion profileExpansionProfile.description
identifiertokenThe identifier for the expansion profileExpansionProfile.identifier
namestringThe name of the expansion profileExpansionProfile.name
publisherstringName of the publisher of the expansion profileExpansionProfile.publisher
statustokenThe status of the expansion profileExpansionProfile.status
urluriThe logical URL for the expansion profileExpansionProfile.url
versiontokenThe version identifier of the expansion profileExpansionProfile.version