Generated Narrative: StructureDefinition profile-TerminologyCapabilities Name Flags Card. Type Description & Constraints TerminologyCapabilities 0..* TerminologyCapabilities(4.0.1) A statement of system capabilities #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:identifier 0..* Identifier R5: Additional identifier for the terminology capabilities (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier #xD; extension:versionAlgorithm 0..1 Coding R5: How to compare versions (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: version-algorithm (??) (extensible) #xD; extension:copyrightLabel 0..1 string R5: Copyright holder and year(s) (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel #xD; codeSystem #xD; Slices for extension 1..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:content 1..1 code R5: not-present | example | fragment | complete | supplement (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-TerminologyCapabilities.codeSystem.content Binding: CodeSystemContentMode (required): The extent of the content of the code system (the concepts and codes it defines) are represented in a code system resource. #xD; version #xD; language #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:language 0..* code R5: language URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-TerminologyCapabilities.codeSystem.version.language Binding: R5LanguagesForR4 (0.1.0) (required): IETF language tag #xD; codeSearch #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:codeSearch 0..1 code R5: in-compose | in-expansion | in-compose-or-expansion URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-TerminologyCapabilities.codeSearch Binding: R5CodeSearchSupportForR4 (0.1.0) (required): The degree to which the server supports the code search parameter on ValueSet, if it is supported. #xD; Documentation for this format
Cross-version Profile for R5.TerminologyCapabilities for use in FHIR R4
This cross-version profile allows R5 TerminologyCapabilities content to be represented via FHIR R4 TerminologyCapabilities resources.
A TerminologyCapabilities resource documents a set of capabilities (behaviors) of a FHIR Terminology Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.
If the resource is contained in another resource, it SHALL NOT contain nested Resources
not(parent::f:contained and f:contained)
If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))
If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
If a resource is contained in another resource, it SHALL NOT have a security label
When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time.
A resource should have narrative for robust management
Name should be usable as an identifier for the module by machine processing applications such as code generation
not(exists(f:name/@value)) or matches(f:name/@value, '[A-Z]([A-Za-z0-9_]){0,254}')
A Capability Statement SHALL have at least one of description, software, or implementation element.
(description.count() + software.count() + implementation.count()) > 0
count(f:software | f:implementation | f:description) > 0
If kind = instance, implementation must be present and software may be present
(kind != 'instance') or implementation.exists()
not(f:kind/@value='instance') or exists(f:implementation)
If kind = capability, implementation must be absent, software must be present
(kind != 'capability') or (implementation.exists().not() and software.exists())
not(f:kind/@value='instance') or (not(exists(f:implementation)) and exists(f:software))
If kind = requirements, implementation and software must be absent
(kind!='requirements') or (implementation.exists().not() and software.exists().not())
not(f:kind/@value='instance') or (not(exists(f:implementation)) and not(exists(f:software)))
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).
Text summary of the resource, for human interpretation
A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
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 information is added later.
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
Must have either extensions or value[x], not both
exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
R5: Additional identifier for the terminology capabilities (new)
R5: `TerminologyCapabilities.identifier` (new:Identifier)
Element `TerminologyCapabilities.identifier` has a context of TerminologyCapabilities based on following the parent source element upwards and mapping to `TerminologyCapabilities`. Element `TerminologyCapabilities.identifier` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element `TerminologyCapabilities.identifier`: `http://hl7.org/fhir/StructureDefinition/artifact-identifier`. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this terminology capabilities outside of FHIR, where it is not possible to use the logical URI.
R5: `TerminologyCapabilities.versionAlgorithm[x]` (new:Coding, string)
Element `TerminologyCapabilities.versionAlgorithm[x]` has a context of TerminologyCapabilities based on following the parent source element upwards and mapping to `TerminologyCapabilities`. Element `TerminologyCapabilities.versionAlgorithm[x]` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element `TerminologyCapabilities.versionAlgorithm[x]`: `http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm`. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.
R5: `TerminologyCapabilities.copyrightLabel` (new:string)
Element `TerminologyCapabilities.copyrightLabel` has a context of TerminologyCapabilities based on following the parent source element upwards and mapping to `TerminologyCapabilities`. Element `TerminologyCapabilities.copyrightLabel` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element `TerminologyCapabilities.copyrightLabel`: `http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel`. The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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 is allowed to 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).
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.
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/R4/extensibility.html#modifierExtension).
Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Canonical identifier for this terminology capabilities, represented as a URI (globally unique)
An absolute URI that is used to identify this terminology capabilities when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this terminology capabilities is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the terminology capabilities is stored on different servers.
Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](http://hl7.org/fhir/R4/resource.html#versions). In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](http://hl7.org/fhir/R4/resource.html#meta) element to indicate where the current master source of the resource can be found.
Allows the terminology capabilities to be referenced by a single globally unique identifier.
Business version of the terminology capabilities
The identifier that is used to identify this version of the terminology capabilities when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the terminology capabilities author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
There may be different terminology capabilities instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the terminology capabilities with the format [url]|[version].
Name for this terminology capabilities (computer friendly)
A natural language name identifying the terminology capabilities. This name should be usable as an identifier for the module by machine processing applications such as code generation.
The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.
Support human navigation and code generation.
Name for this terminology capabilities (human friendly)
A short, descriptive, user-friendly title for the terminology capabilities.
This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
The status of this terminology capabilities. Enables tracking the life-cycle of the content.
Allows filtering of terminology capabilitiess that are appropriate for use versus not.This is not intended for use with actual capability statements, but where capability statements are used to describe possible or desired systems.
This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
A Boolean value to indicate that this terminology capabilities is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
Allows filtering of terminology capabilitiess that are appropriate for use versus not.
Enables experimental content to be developed following the same lifecycle that would be used for a production-level terminology capabilities.
The date (and optionally time) when the terminology capabilities was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the terminology capabilities changes.
Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the terminology capabilities. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
Name of the publisher (organization or individual)
The name of the organization or individual that published the terminology capabilities.
Usually an organization but may be an individual. The publisher (or steward) of the terminology capabilities is the organization or individual primarily responsible for the maintenance and upkeep of the terminology capabilities. 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 terminology capabilities. This item SHOULD be populated unless the information is available from context.
Helps establish the "authority/credibility" of the terminology capabilities. May also allow for contact.
Contact details to assist a user in finding and communicating with the publisher.
May be a web site, an email address, a telephone number, etc.
Natural language description of the terminology capabilities
A free text natural language description of the terminology capabilities from a consumer's perspective. Typically, this is used when the capability statement describes a desired rather than an actual solution, for example as a formal expression of requirements as part of an RFP.
This description can be used to capture details such as why the terminology capabilities 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 terminology capabilities 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 terminology capabilities is presumed to be the predominant language in the place the terminology capabilities was created).This does not need to be populated if the description is adequately implied by the software or implementation details.
The context that the content is intended to support
The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate terminology capabilities instances.
When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
Assist in searching for appropriate content.
Intended jurisdiction for terminology capabilities (if applicable)
A legal or geographic region in which the terminology capabilities is intended to be used.
It may be possible for the terminology capabilities to be used in jurisdictions other than those for which it was originally designed or intended.
Countries and regions within which this artifact is targeted for use.
Why this terminology capabilities is defined
Explanation of why this terminology capabilities is needed and why it has been designed as it has.
This element does not describe the usage of the terminology capabilities. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this terminology capabilities.
A copyright statement relating to the terminology capabilities and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the terminology capabilities.
Consumers must be able to determine any legal restrictions on the use of the terminology capabilities and/or its content.
The way that this statement is intended to be used, to describe an actual running instance of software, a particular product (kind, not instance of software) or a class of implementation (e.g. a desired purchase).
How a capability statement is intended to be used.
Software that is covered by this terminology capability statement
Software that is covered by this terminology capability statement. It is used when the statement describes the capabilities of a particular software version, independent of an installation.
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.
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 are expected to modify the meaning or interpretation of the element that contains them
The version identifier for the software covered by this statement.
If possible, a version should be specified, as statements are likely to be different for different versions of software.
Identifies a specific implementation instance that is described by the terminology capability statement - i.e. a particular installation, rather than the capabilities of a software program.
Information about the specific installation that this terminology capability statement relates to.
An absolute base URL for the implementation.
Identifies a code system that is supported by the server. If there is a no code system URL, then this declares the general assumptions a client can make about support for any CodeSystem resource.
The code system - identified by its system URL - may also be declared explicitly as a Code System Resource at /CodeSystem, but it might not be.
If there is more than one version, a version code must be defined
version.count() > 1 implies version.all(code.exists())
(count(f:version) <= 1) or not(exists(f:version[not(f:code)]))
R5: not-present | example | fragment | complete | supplement (new)
R5: `TerminologyCapabilities.codeSystem.content` (new:code)
Element `TerminologyCapabilities.codeSystem.content` has a context of TerminologyCapabilities.codeSystem based on following the parent source element upwards and mapping to `TerminologyCapabilities`. Element `TerminologyCapabilities.codeSystem.content` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).
exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
For the code system, a list of versions that are supported by the server.
Language translations might not be available for all codes.
For version-less code systems, there should be a single version with no identifier.
If this is the default version for this code system
If this is the default version for this code system.
If the compositional grammar defined by the code system is supported.
unique id for the element within a resource (for internal references)
R5: `TerminologyCapabilities.codeSystem.version.language`
Element `TerminologyCapabilities.codeSystem.version.language` is mapped to FHIR R4 element `TerminologyCapabilities.codeSystem.version.language` as `Equivalent`.
True if subsumption is supported for this version of the code system.
Information about the [ValueSet/$expand](valueset-operation-expand.html) operation
Information about the [ValueSet/$expand](http://hl7.org/fhir/R4/valueset-operation-expand.html) operation.
Whether the server can return nested value sets
Whether the server can return nested value sets.
Whether the server supports paging on expansion
Whether the server supports paging on expansion.
Allow request for incomplete expansions?
Documentation about text searching works
Documentation about text searching works.
This documentation should cover things like case sensitivity, use of punctuation if not ignored, what wild cards are supported (if any), whether text is starts with or contains, and whether word order matters.
The degree to which the server supports the code search parameter on ValueSet, if it is supported.
See notes on the [ValueSet](http://hl7.org/fhir/R4/valueset.html#) resource.
R5: in-compose | in-expansion | in-compose-or-expansion
R5: `TerminologyCapabilities.codeSearch`
Element `TerminologyCapabilities.codeSearch` is mapped to FHIR R4 element `TerminologyCapabilities.codeSearch` as `SourceIsBroaderThanTarget`. See notes on the [ValueSet](https://hl7.org/fhir/v.html#) resource.
Information about the [ValueSet/$validate-code](valueset-operation-validate-code.html) operation
Information about the [ValueSet/$validate-code](http://hl7.org/fhir/R4/valueset-operation-validate-code.html) operation.
Information about the [ConceptMap/$translate](conceptmap-operation-translate.html) operation
Information about the [ConceptMap/$translate](http://hl7.org/fhir/R4/conceptmap-operation-translate.html) operation.
Whether the client must identify the map
Whether the client must identify the map.
Information about the [ConceptMap/$closure](conceptmap-operation-closure.html) operation
Whether the $closure operation is supported.