Generated Narrative: StructureDefinition profile-ExpansionProfile-for-Parameters Name Flags Card. Type Description & Constraints Parameters 0..* Parameters(4.3.0) Operation Request or Response #xD; Slices for extension 0..* Slice: Unordered, Open by value:url #xD; extension:text 0..1 (Complex) STU3: Text summary of the resource, for human interpretation (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ExpansionProfile.text #xD; extension:contained 0..* (Complex) STU3: Contained, inline Resources (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ExpansionProfile.contained #xD; extension:url 0..1 uri STU3: Logical URI to reference this expansion profile (globally unique) (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ExpansionProfile.url #xD; extension:identifier 0..1 Identifier STU3: Additional identifier for the expansion profile (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ExpansionProfile.identifier #xD; extension:version 0..1 string STU3: Business version of the expansion profile (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ExpansionProfile.version #xD; extension:name 0..1 string STU3: Name for this expansion profile (computer friendly) (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ExpansionProfile.name #xD; extension:date 0..1 dateTime STU3: Date this was last changed (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ExpansionProfile.date #xD; extension:publisher 0..1 string STU3: Name of the publisher (organization or individual) (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ExpansionProfile.publisher #xD; extension:contact 0..* ContactDetail STU3: Contact details for the publisher (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ExpansionProfile.contact #xD; extension:description 0..1 markdown STU3: Natural language description of the expansion profile (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ExpansionProfile.description #xD; extension:useContext 0..* UsageContext STU3: Context the content is intended to support (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ExpansionProfile.useContext #xD; extension:jurisdiction 0..* CodeableConcept STU3: Intended jurisdiction for expansion profile (if applicable) (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ExpansionProfile.jurisdiction #xD; extension:fixedVersion 0..* (Complex) STU3: Fix use of a code system to a particular version (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ExpansionProfile.fixedVersion #xD; extension:excludedSystem 0..1 (Complex) STU3: Systems/Versions to be exclude (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ExpansionProfile.excludedSystem #xD; extension:includeDesignations 0..1 boolean STU3: Whether the expansion should include concept designations (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ExpansionProfile.includeDesignations #xD; extension:designation 0..1 (Complex) STU3: When the expansion profile imposes designation contraints (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ExpansionProfile.designation #xD; extension:includeDefinition 0..1 boolean STU3: Include or exclude the value set definition in the expansion (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ExpansionProfile.includeDefinition #xD; extension:activeOnly 0..1 boolean STU3: Include or exclude inactive concepts in the expansion (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ExpansionProfile.activeOnly #xD; extension:excludeNested 0..1 boolean STU3: Nested codes in the expansion or not (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ExpansionProfile.excludeNested #xD; extension:excludeNotForUI 0..1 boolean STU3: Include or exclude codes which cannot be rendered in user interfaces in the value set expansion (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ExpansionProfile.excludeNotForUI #xD; extension:excludePostCoordinated 0..1 boolean STU3: Include or exclude codes which are post coordinated expressions in the value set expansion (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ExpansionProfile.excludePostCoordinated #xD; extension:displayLanguage 0..1 code STU3: Specify the language for the display element of codes in the value set expansion (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ExpansionProfile.displayLanguage #xD; extension:limitedExpansion 0..1 boolean STU3: Controls behaviour of the value set expand operation when value sets are too large to be completely expanded (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ExpansionProfile.limitedExpansion #xD; Slices for modifierExtension 0..* Slice: Unordered, Open by value:url #xD; modifierExtension:status 1..1 code STU3: draft | active | retired | unknown (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ExpansionProfile.status Binding: PublicationStatus (required): The lifecycle status of a Value Set or Concept Map. #xD; modifierExtension:experimental 0..1 boolean STU3: For testing purposes, not real usage (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ExpansionProfile.experimental #xD; meta #xD; Slices for extension 0..* Slice: Unordered, Open by value:url #xD; extension:meta 0..1 (Complex) STU3: meta additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ExpansionProfile.meta #xD; Documentation for this format
Cross-version Profile for STU3.ExpansionProfile for use in FHIR R4B
This cross-version profile allows STU3 ExpansionProfile content to be represented via FHIR R4B Parameters resources.
This resource is a non-persisted resource used to pass information into and back from an [operation](http://hl7.org/fhir/R4B/operations.html). It has no other use, and there is no RESTful endpoint associated with it.
The parameters that may be used are defined by the OperationDefinition resource.
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
A set of rules under which this content was created
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
The base language in which the resource is written.
Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
A parameter passed to or received from the operation.
All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
A parameter must have one and only one of (value, resource, part)
(part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))
(exists(f:part) and not(exists(f:*[starts-with(local-name(.), 'value')])) and not(exists(f:resource))) or (not(exists(f:part)) and (exists(f:*[starts-with(local-name(.),'value')]) != exists(f:resource)))
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Additional content defined by implementations
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Must have either extensions or value[x], not both
exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
Extensions that cannot be ignored even if unrecognized
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4B/extensibility.html#modifierExtension).
Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
The name of the parameter (reference to the operation definition).
Conveys the content if the parameter is a data type.
When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods.
Only one level of nested parameters is allowed.
STU3: Text summary of the resource, for human interpretation (new)
STU3: `ExpansionProfile.text` (new:Narrative)
Element `ExpansionProfile.text` has a context of Parameters based on following the parent source element upwards and mapping to `Parameters`. Element `ExpansionProfile.text` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.
STU3: `ExpansionProfile.contained` (new:Resource)
Element `ExpansionProfile.contained` has a context of Parameters based on following the parent source element upwards and mapping to `Parameters`. Element `ExpansionProfile.contained` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.
STU3: Logical URI to reference this expansion profile (globally unique) (new)
Element `ExpansionProfile.url` has a context of Parameters based on following the parent source element upwards and mapping to `Parameters`. Element `ExpansionProfile.url` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). 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.
STU3: Additional identifier for the expansion profile (new)
STU3: `ExpansionProfile.identifier` (new:Identifier)
Element `ExpansionProfile.identifier` has a context of Parameters based on following the parent source element upwards and mapping to `Parameters`. Element `ExpansionProfile.identifier` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). 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.
STU3: Business version of the expansion profile (new)
STU3: `ExpansionProfile.version` (new:string)
Element `ExpansionProfile.version` has a context of Parameters based on following the parent source element upwards and mapping to `Parameters`. Element `ExpansionProfile.version` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). There may be different expansion profile instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a refrence to a particular business version of the expansion profile with the format [url]|[version].
STU3: Name for this expansion profile (computer friendly) (new)
STU3: `ExpansionProfile.name` (new:string)
Element `ExpansionProfile.name` has a context of Parameters based on following the parent source element upwards and mapping to `Parameters`. Element `ExpansionProfile.name` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). 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.
STU3: `ExpansionProfile.date` (new:dateTime)
Element `ExpansionProfile.date` has a context of Parameters based on following the parent source element upwards and mapping to `Parameters`. Element `ExpansionProfile.date` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). 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.
STU3: Name of the publisher (organization or individual) (new)
STU3: `ExpansionProfile.publisher` (new:string)
Element `ExpansionProfile.publisher` has a context of Parameters based on following the parent source element upwards and mapping to `Parameters`. Element `ExpansionProfile.publisher` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). 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.
STU3: Contact details for the publisher (new)
STU3: `ExpansionProfile.contact` (new:ContactDetail)
Element `ExpansionProfile.contact` has a context of Parameters based on following the parent source element upwards and mapping to `Parameters`. Element `ExpansionProfile.contact` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). May be a web site, an email address, a telephone number, etc.
STU3: Natural language description of the expansion profile (new)
STU3: `ExpansionProfile.description` (new:markdown)
Element `ExpansionProfile.description` has a context of Parameters based on following the parent source element upwards and mapping to `Parameters`. Element `ExpansionProfile.description` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). 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).
STU3: Context the content is intended to support (new)
STU3: `ExpansionProfile.useContext` (new:UsageContext)
Element `ExpansionProfile.useContext` has a context of Parameters based on following the parent source element upwards and mapping to `Parameters`. Element `ExpansionProfile.useContext` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). When multiple useContexts are specified, there is no expectation whether all or any of the contexts apply.
STU3: Intended jurisdiction for expansion profile (if applicable) (new)
STU3: `ExpansionProfile.jurisdiction` (new:CodeableConcept)
Element `ExpansionProfile.jurisdiction` has a context of Parameters based on following the parent source element upwards and mapping to `Parameters`. Element `ExpansionProfile.jurisdiction` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). It may be possible for the expansion profile to be used in jurisdictions other than those for which it was originally designed or intended.
STU3: Fix use of a code system to a particular version (new)
STU3: `ExpansionProfile.fixedVersion` (new:BackboneElement)
Element `ExpansionProfile.fixedVersion` has a context of Parameters based on following the parent source element upwards and mapping to `Parameters`. Element `ExpansionProfile.fixedVersion` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).
STU3: Systems/Versions to be exclude (new)
STU3: `ExpansionProfile.excludedSystem` (new:BackboneElement)
Element `ExpansionProfile.excludedSystem` has a context of Parameters based on following the parent source element upwards and mapping to `Parameters`. Element `ExpansionProfile.excludedSystem` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). 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'.
STU3: Whether the expansion should include concept designations (new)
STU3: `ExpansionProfile.includeDesignations` (new:boolean)
Element `ExpansionProfile.includeDesignations` has a context of Parameters based on following the parent source element upwards and mapping to `Parameters`. Element `ExpansionProfile.includeDesignations` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). 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.
STU3: When the expansion profile imposes designation contraints (new)
STU3: `ExpansionProfile.designation` (new:BackboneElement)
Element `ExpansionProfile.designation` has a context of Parameters based on following the parent source element upwards and mapping to `Parameters`. Element `ExpansionProfile.designation` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).
STU3: Include or exclude the value set definition in the expansion (new)
STU3: `ExpansionProfile.includeDefinition` (new:boolean)
Element `ExpansionProfile.includeDefinition` has a context of Parameters based on following the parent source element upwards and mapping to `Parameters`. Element `ExpansionProfile.includeDefinition` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). 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".
STU3: Include or exclude inactive concepts in the expansion (new)
STU3: `ExpansionProfile.activeOnly` (new:boolean)
Element `ExpansionProfile.activeOnly` has a context of Parameters based on following the parent source element upwards and mapping to `Parameters`. Element `ExpansionProfile.activeOnly` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). 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.
STU3: Nested codes in the expansion or not (new)
STU3: `ExpansionProfile.excludeNested` (new:boolean)
Element `ExpansionProfile.excludeNested` has a context of Parameters based on following the parent source element upwards and mapping to `Parameters`. Element `ExpansionProfile.excludeNested` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). Nesting of codes is excluded if excludeNested is present and has a value of "true".
STU3: Include or exclude codes which cannot be rendered in user interfaces in the value set expansion (new)
STU3: `ExpansionProfile.excludeNotForUI` (new:boolean)
Element `ExpansionProfile.excludeNotForUI` has a context of Parameters based on following the parent source element upwards and mapping to `Parameters`. Element `ExpansionProfile.excludeNotForUI` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). Codes which cannot be used in user interfaces will be excluded if excludeNotForUI is present and has a value of "true".
STU3: Include or exclude codes which are post coordinated expressions in the value set expansion (new)
STU3: `ExpansionProfile.excludePostCoordinated` (new:boolean)
Element `ExpansionProfile.excludePostCoordinated` has a context of Parameters based on following the parent source element upwards and mapping to `Parameters`. Element `ExpansionProfile.excludePostCoordinated` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). Post coordinated codes are excluded if excludePostCoordinated is present and has a value of "true".
STU3: Specify the language for the display element of codes in the value set expansion (new)
STU3: `ExpansionProfile.displayLanguage` (new:code)
Element `ExpansionProfile.displayLanguage` has a context of Parameters based on following the parent source element upwards and mapping to `Parameters`. Element `ExpansionProfile.displayLanguage` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).
STU3: Controls behaviour of the value set expand operation when value sets are too large to be completely expanded (new)
STU3: `ExpansionProfile.limitedExpansion` (new:boolean)
Element `ExpansionProfile.limitedExpansion` has a context of Parameters based on following the parent source element upwards and mapping to `Parameters`. Element `ExpansionProfile.limitedExpansion` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). 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](https://hl7.org/fhir/extension-valueset-toocostly.html) correctly if limitedExpansion = true.
STU3: draft | active | retired | unknown (new)
STU3: `ExpansionProfile.status` (new:code)
Element `ExpansionProfile.status` has a context of Parameters based on following the parent source element upwards and mapping to `Parameters`. Element `ExpansionProfile.status` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). Allows filtering of expansion profiles that are appropriate for use vs. not. This is labeled as "Is Modifier" because applications should not use a retired expansion profile without due consideration.
STU3: For testing purposes, not real usage (new)
STU3: `ExpansionProfile.experimental` (new:boolean)
Element `ExpansionProfile.experimental` has a context of Parameters based on following the parent source element upwards and mapping to `Parameters`. Element `ExpansionProfile.experimental` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). Allows filtering of expansion profile that are appropriate for use vs. not. This is labeled as "Is Modifier" because applications should not use an experimental expansion profile in production.
STU3: `ExpansionProfile.meta` additional types (Meta) additional types from child elements (lastUpdated, profile, security, tag, versionId)
Element `ExpansionProfile.meta` is mapped to FHIR R4B element `Parameters.meta` as `SourceIsBroaderThanTarget`. The mappings for `ExpansionProfile.meta` do not cover the following types: Meta. The mappings for `ExpansionProfile.meta` do not cover the following types based on type expansion: lastUpdated, profile, security, tag, versionId.