TerminologyCapabilities | 0..* | TerminologyCapabilities | 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. |
TerminologyCapabilities.id | 0..1 | http://hl7.org/fhirpath/System.String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
TerminologyCapabilities.meta | 0..1 | Meta | 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. |
TerminologyCapabilities.implicitRules | 0..1 | uri | 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. |
TerminologyCapabilities.language | 0..1 | code | The base language in which the resource is written. |
TerminologyCapabilities.text | 0..1 | Narrative | 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. |
TerminologyCapabilities.contained | 0..* | Resource | 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. |
TerminologyCapabilities.extension | 0..* | Extension | May be used to represent additional information that is not part of the basic definition of the resource. 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. |
TerminologyCapabilities.modifierExtension | 0..* | Extension | 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). |
TerminologyCapabilities.url | 0..1 | uri | 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. |
TerminologyCapabilities.version | 0..1 | string | 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. |
TerminologyCapabilities.name | 0..1 | string | 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. |
TerminologyCapabilities.title | 0..1 | string | A short, descriptive, user-friendly title for the terminology capabilities. |
TerminologyCapabilities.status | 1..1 | code | The status of this terminology capabilities. Enables tracking the life-cycle of the content. |
TerminologyCapabilities.experimental | 0..1 | boolean | 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. |
TerminologyCapabilities.date | 1..1 | dateTime | 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. |
TerminologyCapabilities.publisher | 0..1 | string | The name of the organization or individual that published the terminology capabilities. |
TerminologyCapabilities.contact | 0..* | ContactDetail | Contact details to assist a user in finding and communicating with the publisher. |
TerminologyCapabilities.description | 0..1 | markdown | 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. |
TerminologyCapabilities.useContext | 0..* | UsageContext | 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. |
TerminologyCapabilities.jurisdiction | 0..* | CodeableConcept | A legal or geographic region in which the terminology capabilities is intended to be used. |
TerminologyCapabilities.purpose | 0..1 | markdown | Explanation of why this terminology capabilities is needed and why it has been designed as it has. |
TerminologyCapabilities.copyright | 0..1 | markdown | 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. |
TerminologyCapabilities.kind | 1..1 | code | 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). |
TerminologyCapabilities.software | 0..1 | BackboneElement | 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. |
TerminologyCapabilities.software.id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
TerminologyCapabilities.software.extension | 0..* | Extension | 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. |
TerminologyCapabilities.software.modifierExtension | 0..* | Extension | 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). |
TerminologyCapabilities.software.name | 1..1 | string | Name the software is known by. |
TerminologyCapabilities.software.version | 0..1 | string | The version identifier for the software covered by this statement. |
TerminologyCapabilities.implementation | 0..1 | BackboneElement | 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. |
TerminologyCapabilities.implementation.id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
TerminologyCapabilities.implementation.extension | 0..* | Extension | 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. |
TerminologyCapabilities.implementation.modifierExtension | 0..* | Extension | 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). |
TerminologyCapabilities.implementation.description | 1..1 | string | Information about the specific installation that this terminology capability statement relates to. |
TerminologyCapabilities.implementation.url | 0..1 | url | An absolute base URL for the implementation. |
TerminologyCapabilities.lockedDate | 0..1 | boolean | Whether the server supports lockedDate. |
TerminologyCapabilities.codeSystem | 0..* | BackboneElement | 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. |
TerminologyCapabilities.codeSystem.id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
TerminologyCapabilities.codeSystem.extension | 0..* | Extension | 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. |
TerminologyCapabilities.codeSystem.modifierExtension | 0..* | Extension | 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). |
TerminologyCapabilities.codeSystem.uri | 0..1 | canonical | URI for the Code System. |
TerminologyCapabilities.codeSystem.version | 0..* | BackboneElement | For the code system, a list of versions that are supported by the server. |
TerminologyCapabilities.codeSystem.version.id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
TerminologyCapabilities.codeSystem.version.extension | 0..* | Extension | 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. |
TerminologyCapabilities.codeSystem.version.modifierExtension | 0..* | Extension | 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). |
TerminologyCapabilities.codeSystem.version.code | 0..1 | string | For version-less code systems, there should be a single version with no identifier. |
TerminologyCapabilities.codeSystem.version.isDefault | 0..1 | boolean | If this is the default version for this code system. |
TerminologyCapabilities.codeSystem.version.compositional | 0..1 | boolean | If the compositional grammar defined by the code system is supported. |
TerminologyCapabilities.codeSystem.version.language | 0..* | code | Language Displays supported. |
TerminologyCapabilities.codeSystem.version.filter | 0..* | BackboneElement | Filter Properties supported. |
TerminologyCapabilities.codeSystem.version.filter.id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
TerminologyCapabilities.codeSystem.version.filter.extension | 0..* | Extension | 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. |
TerminologyCapabilities.codeSystem.version.filter.modifierExtension | 0..* | Extension | 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). |
TerminologyCapabilities.codeSystem.version.filter.code | 1..1 | code | Code of the property supported. |
TerminologyCapabilities.codeSystem.version.filter.op | 1..* | code | Operations supported for the property. |
TerminologyCapabilities.codeSystem.version.property | 0..* | code | Properties supported for $lookup. |
TerminologyCapabilities.codeSystem.subsumption | 0..1 | boolean | True if subsumption is supported for this version of the code system. |
TerminologyCapabilities.expansion | 0..1 | BackboneElement | Information about the ValueSet/$expand operation. |
TerminologyCapabilities.expansion.id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
TerminologyCapabilities.expansion.extension | 0..* | Extension | 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. |
TerminologyCapabilities.expansion.modifierExtension | 0..* | Extension | 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). |
TerminologyCapabilities.expansion.hierarchical | 0..1 | boolean | Whether the server can return nested value sets. |
TerminologyCapabilities.expansion.paging | 0..1 | boolean | Whether the server supports paging on expansion. |
TerminologyCapabilities.expansion.incomplete | 0..1 | boolean | Allow request for incomplete expansions? |
TerminologyCapabilities.expansion.parameter | 0..* | BackboneElement | Supported expansion parameter. |
TerminologyCapabilities.expansion.parameter.id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
TerminologyCapabilities.expansion.parameter.extension | 0..* | Extension | 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. |
TerminologyCapabilities.expansion.parameter.modifierExtension | 0..* | Extension | 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). |
TerminologyCapabilities.expansion.parameter.name | 1..1 | code | Expansion Parameter name. |
TerminologyCapabilities.expansion.parameter.documentation | 0..1 | string | Description of support for parameter. |
TerminologyCapabilities.expansion.textFilter | 0..1 | markdown | Documentation about text searching works. |
TerminologyCapabilities.codeSearch | 0..1 | code | The degree to which the server supports the code search parameter on ValueSet, if it is supported. |
TerminologyCapabilities.validateCode | 0..1 | BackboneElement | Information about the ValueSet/$validate-code operation. |
TerminologyCapabilities.validateCode.id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
TerminologyCapabilities.validateCode.extension | 0..* | Extension | 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. |
TerminologyCapabilities.validateCode.modifierExtension | 0..* | Extension | 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). |
TerminologyCapabilities.validateCode.translations | 1..1 | boolean | Whether translations are validated. |
TerminologyCapabilities.translation | 0..1 | BackboneElement | Information about the ConceptMap/$translate operation. |
TerminologyCapabilities.translation.id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
TerminologyCapabilities.translation.extension | 0..* | Extension | 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. |
TerminologyCapabilities.translation.modifierExtension | 0..* | Extension | 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). |
TerminologyCapabilities.translation.needsMap | 1..1 | boolean | Whether the client must identify the map. |
TerminologyCapabilities.closure | 0..1 | BackboneElement | Whether the $closure operation is supported. |
TerminologyCapabilities.closure.id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
TerminologyCapabilities.closure.extension | 0..* | Extension | 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. |
TerminologyCapabilities.closure.modifierExtension | 0..* | Extension | 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). |
TerminologyCapabilities.closure.translation | 0..1 | boolean | If cross-system closure is supported. |