NamingSystem constructor
- @Default(R4ResourceType.NamingSystem) @JsonKey(unknownEnumValue: R4ResourceType.NamingSystem) 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, - String? name,
- @JsonKey(name: '_name') Element? nameElement,
- FhirCode? status,
- @JsonKey(name: '_status') Element? statusElement,
- FhirCode? kind,
- @JsonKey(name: '_kind') Element? kindElement,
- FhirDateTime? date,
- @JsonKey(name: '_date') Element? dateElement,
- String? publisher,
- @JsonKey(name: '_publisher') Element? publisherElement,
- List<
ContactDetail> ? contact, - String? responsible,
- @JsonKey(name: '_responsible') Element? responsibleElement,
- CodeableConcept? type,
- FhirMarkdown? description,
- @JsonKey(name: '_description') Element? descriptionElement,
- List<
UsageContext> ? useContext, - List<
CodeableConcept> ? jurisdiction, - String? usage,
- @JsonKey(name: '_usage') Element? usageElement,
- required List<
NamingSystemUniqueId> uniqueId,
NamingSystem A curated namespace that issues unique symbols within that namespace for the identification of concepts, people, devices, etc. Represents a "System" used within the Identifier and Coding data types.
resourceType
This is a NamingSystem 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).
name
A natural language name identifying the naming system. This name
should be usable as an identifier for the module by machine processing
applications such as code generation.
nameElement
Extensions for name
status
The status of this naming system. Enables tracking the
life-cycle of the content.
statusElement
Extensions for status
kind
Indicates the purpose for the naming system - what kinds of things
does it make unique?
kindElement
Extensions for kind
date
The date (and optionally time) when the naming system 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 naming system changes.
dateElement
Extensions for date
publisher
The name of the organization or individual that published the
naming system.
publisherElement
Extensions for publisher
contact
Contact details to assist a user in finding and communicating
with the publisher.
responsible
The name of the organization that is responsible for
issuing identifiers or codes for this namespace and ensuring their
non-collision.
responsibleElement
Extensions for responsible
type
Categorizes a naming system for easier search by grouping related
naming systems.
description
A free text natural language description of the naming
system from a consumer's perspective. Details about what the namespace
identifies including scope, granularity, version labeling, etc.
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 naming system instances.
jurisdiction
A legal or geographic region in which the naming system is
intended to be used.
usage
Provides guidance on the use of the namespace, including the
handling of formatting characters, use of upper vs. lower case, etc.
usageElement
Extensions for usage
uniqueId
Indicates how the system may be identified when referenced in
electronic exchange.
Implementation
const factory NamingSystem({
@Default(R4ResourceType.NamingSystem)
@JsonKey(unknownEnumValue: R4ResourceType.NamingSystem)
/// [resourceType] This is a NamingSystem 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,
/// [name] A natural language name identifying the naming system. 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,
/// [status] The status of this naming system. Enables tracking the
/// life-cycle of the content.
FhirCode? status,
/// [statusElement] Extensions for status
@JsonKey(name: '_status') Element? statusElement,
/// [kind] Indicates the purpose for the naming system - what kinds of things
/// does it make unique?
FhirCode? kind,
/// [kindElement] Extensions for kind
@JsonKey(name: '_kind') Element? kindElement,
/// [date] The date (and optionally time) when the naming system 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 naming system changes.
FhirDateTime? date,
/// [dateElement] Extensions for date
@JsonKey(name: '_date') Element? dateElement,
/// [publisher] The name of the organization or individual that published the
/// naming system.
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,
/// [responsible] The name of the organization that is responsible for
/// issuing identifiers or codes for this namespace and ensuring their
/// non-collision.
String? responsible,
/// [responsibleElement] Extensions for responsible
@JsonKey(name: '_responsible') Element? responsibleElement,
/// [type] Categorizes a naming system for easier search by grouping related
/// naming systems.
CodeableConcept? type,
/// [description] A free text natural language description of the naming
/// system from a consumer's perspective. Details about what the namespace
/// identifies including scope, granularity, version labeling, etc.
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 naming system instances.
List<UsageContext>? useContext,
/// [jurisdiction] A legal or geographic region in which the naming system is
/// intended to be used.
List<CodeableConcept>? jurisdiction,
/// [usage] Provides guidance on the use of the namespace, including the
/// handling of formatting characters, use of upper vs. lower case, etc.
String? usage,
/// [usageElement] Extensions for usage
@JsonKey(name: '_usage') Element? usageElement,
/// [uniqueId] Indicates how the system may be identified when referenced in
/// electronic exchange.
required List<NamingSystemUniqueId> uniqueId,
}) = _NamingSystem;