TerminologyCapabilities constructor

const TerminologyCapabilities({ @Default(R4ResourceType.TerminologyCapabilities) @JsonKey(unknownEnumValue: R4ResourceType.TerminologyCapabilities) R4ResourceType resourceType, @JsonKey(includeFromJson: true, includeToJson: false) int? dbId, @JsonKey(name: 'id') String? fhirId, FhirMeta? meta, FhirUri? implicitRules, @JsonKey(name: '_implicitRules') Element? implicitRulesElement, FhirCode? language, @JsonKey(name: '_language') Element? languageElement, Narrative? text, List<Resource>? contained, @JsonKey(name: 'extension') List<FhirExtension>? extension_, List<FhirExtension>? modifierExtension, FhirUri? url, @JsonKey(name: '_url') Element? urlElement, String? version, @JsonKey(name: '_version') Element? versionElement, String? name, @JsonKey(name: '_name') Element? nameElement, String? title, @JsonKey(name: '_title') Element? titleElement, FhirCode? status, @JsonKey(name: '_status') Element? statusElement, FhirBoolean? experimental, @JsonKey(name: '_experimental') Element? experimentalElement, FhirDateTime? date, @JsonKey(name: '_date') Element? dateElement, String? publisher, @JsonKey(name: '_publisher') Element? publisherElement, List<ContactDetail>? contact, FhirMarkdown? description, @JsonKey(name: '_description') Element? descriptionElement, List<UsageContext>? useContext, List<CodeableConcept>? jurisdiction, FhirMarkdown? purpose, @JsonKey(name: '_purpose') Element? purposeElement, FhirMarkdown? copyright, @JsonKey(name: '_copyright') Element? copyrightElement, FhirCode? kind, @JsonKey(name: '_kind') Element? kindElement, TerminologyCapabilitiesSoftware? software, TerminologyCapabilitiesImplementation? implementation, FhirBoolean? lockedDate, @JsonKey(name: '_lockedDate') Element? lockedDateElement, List<TerminologyCapabilitiesCodeSystem>? codeSystem, TerminologyCapabilitiesExpansion? expansion, FhirCode? codeSearch, @JsonKey(name: '_codeSearch') Element? codeSearchElement, TerminologyCapabilitiesValidateCode? validateCode, TerminologyCapabilitiesTranslation? translation, TerminologyCapabilitiesClosure? closure, })

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.

resourceType This is a TerminologyCapabilities resource

id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

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.

implicitRules 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.

implicitRulesElement Extensions for implicitRules

language The base language in which the resource is written.

languageElement Extensions for language

text 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 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.

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.

modifierExtension 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).

url 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.

urlElement Extensions for url

version 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.

versionElement Extensions for version

name 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.

nameElement Extensions for name

title A short, descriptive, user-friendly title for the terminology capabilities.

titleElement Extensions for title

status The status of this terminology capabilities. Enables tracking the life-cycle of the content.

statusElement Extensions for status

experimental 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.

experimentalElement Extensions for experimental

date 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.

dateElement Extensions for date

publisher The name of the organization or individual that published the terminology capabilities.

publisherElement Extensions for publisher

contact Contact details to assist a user in finding and communicating with the publisher.

description 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.

descriptionElement Extensions for description

useContext 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.

jurisdiction A legal or geographic region in which the terminology capabilities is intended to be used.

purpose Explanation of why this terminology capabilities is needed and why it has been designed as it has.

purposeElement Extensions for purpose

copyright 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.

copyrightElement Extensions for copyright

kind 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).

kindElement Extensions for kind

software 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.

implementation 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.

lockedDate Whether the server supports lockedDate.

lockedDateElement Extensions for lockedDate

codeSystem 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.

expansion Information about the ValueSet/$expand operation.

codeSearch The degree to which the server supports the code search parameter on ValueSet, if it is supported.

codeSearchElement Extensions for codeSearch

validateCode Information about the

Implementation

const factory TerminologyCapabilities({
  @Default(R4ResourceType.TerminologyCapabilities)
  @JsonKey(unknownEnumValue: R4ResourceType.TerminologyCapabilities)

  /// [resourceType] This is a TerminologyCapabilities resource
  R4ResourceType resourceType,
  @JsonKey(includeFromJson: true, includeToJson: false) int? dbId,

  /// [id] The logical id of the resource, as used in the URL for the resource.
  ///  Once assigned, this value never changes.
  @JsonKey(name: 'id') String? fhirId,

  /// [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.
  FhirMeta? meta,

  /// [implicitRules] 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.
  FhirUri? implicitRules,

  /// [implicitRulesElement] Extensions for implicitRules
  @JsonKey(name: '_implicitRules') Element? implicitRulesElement,

  /// [language] The base language in which the resource is written.
  FhirCode? language,

  /// [languageElement] Extensions for language
  @JsonKey(name: '_language') Element? languageElement,

  /// [text] 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.
  Narrative? text,

  /// [contained] 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.
  List<Resource>? contained,

  /// [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.
  @JsonKey(name: 'extension') List<FhirExtension>? extension_,

  /// [modifierExtension] 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).
  List<FhirExtension>? modifierExtension,

  /// [url] 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.
  FhirUri? url,

  /// [urlElement] Extensions for url
  @JsonKey(name: '_url') Element? urlElement,

  /// [version] 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.
  String? version,

  /// [versionElement] Extensions for version
  @JsonKey(name: '_version') Element? versionElement,

  /// [name] 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.
  String? name,

  /// [nameElement] Extensions for name
  @JsonKey(name: '_name') Element? nameElement,

  /// [title] A short, descriptive, user-friendly title for the terminology
  ///  capabilities.
  String? title,

  /// [titleElement] Extensions for title
  @JsonKey(name: '_title') Element? titleElement,

  /// [status] The status of this terminology capabilities. Enables tracking
  ///  the life-cycle of the content.
  FhirCode? status,

  /// [statusElement] Extensions for status
  @JsonKey(name: '_status') Element? statusElement,

  /// [experimental] 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.
  FhirBoolean? experimental,

  /// [experimentalElement] Extensions for experimental
  @JsonKey(name: '_experimental') Element? experimentalElement,

  /// [date] 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.
  FhirDateTime? date,

  /// [dateElement] Extensions for date
  @JsonKey(name: '_date') Element? dateElement,

  /// [publisher] The name of the organization or individual that published the
  ///  terminology capabilities.
  String? publisher,

  /// [publisherElement] Extensions for publisher
  @JsonKey(name: '_publisher') Element? publisherElement,

  /// [contact] Contact details to assist a user in finding and communicating
  ///  with the publisher.
  List<ContactDetail>? contact,

  /// [description] 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.
  FhirMarkdown? description,

  /// [descriptionElement] Extensions for description
  @JsonKey(name: '_description') Element? descriptionElement,

  /// [useContext] 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.
  List<UsageContext>? useContext,

  /// [jurisdiction] A legal or geographic region in which the terminology
  ///  capabilities is intended to be used.
  List<CodeableConcept>? jurisdiction,

  /// [purpose] Explanation of why this terminology capabilities is needed and
  ///  why it has been designed as it has.
  FhirMarkdown? purpose,

  /// [purposeElement] Extensions for purpose
  @JsonKey(name: '_purpose') Element? purposeElement,

  /// [copyright] 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.
  FhirMarkdown? copyright,

  /// [copyrightElement] Extensions for copyright
  @JsonKey(name: '_copyright') Element? copyrightElement,

  /// [kind] 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).
  FhirCode? kind,

  /// [kindElement] Extensions for kind
  @JsonKey(name: '_kind') Element? kindElement,

  /// [software] 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.
  TerminologyCapabilitiesSoftware? software,

  /// [implementation] 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.
  TerminologyCapabilitiesImplementation? implementation,

  /// [lockedDate] Whether the server supports lockedDate.
  FhirBoolean? lockedDate,

  /// [lockedDateElement] Extensions for lockedDate
  @JsonKey(name: '_lockedDate') Element? lockedDateElement,

  /// [codeSystem] 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.
  List<TerminologyCapabilitiesCodeSystem>? codeSystem,

  /// [expansion] Information about the
  ///  [ValueSet/$expand](valueset-operation-expand.html) operation.
  TerminologyCapabilitiesExpansion? expansion,

  /// [codeSearch] The degree to which the server supports the code search
  ///  parameter on ValueSet, if it is supported.
  FhirCode? codeSearch,

  /// [codeSearchElement] Extensions for codeSearch
  @JsonKey(name: '_codeSearch') Element? codeSearchElement,

  /// [validateCode] Information about the
  TerminologyCapabilitiesValidateCode? validateCode,
  TerminologyCapabilitiesTranslation? translation,
  TerminologyCapabilitiesClosure? closure,
}) = _TerminologyCapabilities;