CodeSystem class
CodeSystem The CodeSystem resource is used to declare the existence of
- Mixed in types
- Annotations
-
- @freezed
Constructors
-
CodeSystem({@Default(R4ResourceType.CodeSystem) @JsonKey(unknownEnumValue: R4ResourceType.CodeSystem) 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, List<Identifier> ? identifier, 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, FhirBoolean? caseSensitive, @JsonKey(name: '_caseSensitive') Element? caseSensitiveElement, FhirCanonical? valueSet, FhirCode? hierarchyMeaning, @JsonKey(name: '_hierarchyMeaning') Element? hierarchyMeaningElement, FhirBoolean? compositional, @JsonKey(name: '_compositional') Element? compositionalElement, FhirBoolean? versionNeeded, @JsonKey(name: '_versionNeeded') Element? versionNeededElement, FhirCode? content, @JsonKey(name: '_content') Element? contentElement, FhirCanonical? supplements, FhirUnsignedInt? count, @JsonKey(name: '_count') Element? countElement, List<CodeSystemFilter> ? filter, List<CodeSystemProperty> ? property, List<CodeSystemConcept> ? concept}) -
CodeSystem The CodeSystem resource is used to declare the existence of
and describe a code system or code system supplement and its key
properties, and optionally define a part or all of its content.
constfactory
-
CodeSystem.fromJson(Map<
String, dynamic> json) -
Factory constructor, accepts Map<String, dynamic> as an argument
factory
- CodeSystem.fromJsonString(String source)
-
Acts like a constructor, returns a CodeSystem, accepts a
String as an argument, mostly because I got tired of typing it out
factory
- CodeSystem.fromYaml(dynamic yaml)
-
Factory constructor that accepts a String in YAML format as an argument
factory
Properties
- caseSensitive → FhirBoolean?
-
caseSensitive If code comparison is case sensitive when codes within
this system are compared to each other.
no setterinherited
- caseSensitiveElement → Element?
-
caseSensitiveElement Extensions for caseSensitive
no setterinherited
- compositional → FhirBoolean?
-
compositional The code system defines a compositional
(post-coordination) grammar.
no setterinherited
- compositionalElement → Element?
-
compositionalElement Extensions for compositional
no setterinherited
-
concept
→ List<
CodeSystemConcept> ? -
concept Concepts that are in the code system. The concept definitions
are inherently hierarchical, but the definitions must be consulted to
determine what the meanings of the hierarchical relationships are.
no setterinherited
-
contact
→ List<
ContactDetail> ? -
contact Contact details to assist a user in finding and communicating
with the publisher.
no setterinherited
-
contained
→ List<
Resource> ? -
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.
no setterinherited
- content → FhirCode?
-
content The extent of the content of the code system (the concepts and
codes it defines) are represented in this resource instance.
no setterinherited
- contentElement → Element?
-
contentElement Extensions for content
no setterinherited
- copyright → FhirMarkdown?
-
copyright A copyright statement relating to the code system and/or its
contents. Copyright statements are generally legal restrictions on the use
and publishing of the code system.
no setterinherited
- copyrightElement → Element?
-
copyrightElement Extensions for copyright
no setterinherited
-
copyWith
→ $CodeSystemCopyWith<
CodeSystem> -
no setterinherited
- count → FhirUnsignedInt?
-
count The total number of concepts defined by the code system. Where
the code system has a compositional grammar, the basis of this count is
defined by the system steward.
no setterinherited
- countElement → Element?
-
countElement Extensions for count
no setterinherited
- date → FhirDateTime?
-
date The date (and optionally time) when the code 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 code system changes.
no setterinherited
- dateElement → Element?
-
dateElement Extensions for date
no setterinherited
- dbId → int?
-
no setterinherited
- description → FhirMarkdown?
-
description A free text natural language description of the code system
from a consumer's perspective.
no setterinherited
- descriptionElement → Element?
-
descriptionElement Extensions for description
no setterinherited
- experimental → FhirBoolean?
-
experimental A Boolean value to indicate that this code system is
authored for testing purposes (or education/evaluation/marketing) and is
not intended to be used for genuine usage.
no setterinherited
- experimentalElement → Element?
-
experimentalElement Extensions for experimental
no setterinherited
-
extension_
→ List<
FhirExtension> ? -
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.
no setterinherited
- fhirId → String?
-
id The logical id of the resource, as used in the URL for the resource.
Once assigned, this value never changes.
no setterinherited
-
filter
→ List<
CodeSystemFilter> ? -
filter A filter that can be used in a value set compose statement when
selecting concepts using a filter.
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- hierarchyMeaning → FhirCode?
-
hierarchyMeaning The meaning of the hierarchy of concepts as
represented in this resource.
no setterinherited
- hierarchyMeaningElement → Element?
-
hierarchyMeaningElement Extensions for hierarchyMeaning
no setterinherited
-
identifier
→ List<
Identifier> ? -
identifier A formal identifier that is used to identify this code
system when it is represented in other formats, or referenced in a
specification, model, design or an instance.
no setterinherited
- implicitRules → FhirUri?
-
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.
no setterinherited
- implicitRulesElement → Element?
-
implicitRulesElement Extensions for implicitRules
no setterinherited
-
jurisdiction
→ List<
CodeableConcept> ? -
jurisdiction A legal or geographic region in which the code system is
intended to be used.
no setterinherited
- language → FhirCode?
-
language The base language in which the resource is written.
no setterinherited
- languageElement → Element?
-
languageElement Extensions for language
no setterinherited
- meta → FhirMeta?
-
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.
no setterinherited
-
modifierExtension
→ List<
FhirExtension> ? -
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).
no setterinherited
- name → String?
-
name A natural language name identifying the code system. This name
should be usable as an identifier for the module by machine processing
applications such as code generation.
no setterinherited
- nameElement → Element?
-
nameElement Extensions for name
no setterinherited
- path → String
-
Local Reference for this Resource, form is "ResourceType/Id"
no setterinherited
-
property
→ List<
CodeSystemProperty> ? -
property A property defines an additional slot through which additional
information can be provided about a concept.
no setterinherited
- publisher → String?
-
publisher The name of the organization or individual that published the
code system.
no setterinherited
- publisherElement → Element?
-
publisherElement Extensions for publisher
no setterinherited
- purpose → FhirMarkdown?
-
purpose Explanation of why this code system is needed and why it has
been designed as it has.
no setterinherited
- purposeElement → Element?
-
purposeElement Extensions for purpose
no setterinherited
- resourceType → R4ResourceType
-
no setterinherited
- resourceTypeString → String?
-
produce a string of the resourceType
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- status → FhirCode?
-
status The date (and optionally time) when the code system resource was
created or revised.
no setterinherited
- statusElement → Element?
-
statusElement Extensions for status
no setterinherited
- supplements → FhirCanonical?
-
supplements The canonical URL of the code system that this code system
supplement is adding designations and properties to.
no setterinherited
- text → Narrative?
-
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.
no setterinherited
- thisReference → Reference
-
Convenience method to return a Reference referring to that Resource
no setterinherited
- title → String?
-
title A short, descriptive, user-friendly title for the code system.
no setterinherited
- titleElement → Element?
-
titleElement Extensions for title
no setterinherited
- url → FhirUri?
-
url An absolute URI that is used to identify this code system 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
code system is (or will be) published. This URL can be the target of a
canonical reference. It SHALL remain the same when the code system is
stored on different servers. This is used in
Coding.system.
no setterinherited
- urlElement → Element?
-
urlElement Extensions for url
no setterinherited
-
useContext
→ List<
UsageContext> ? -
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 code system instances.
no setterinherited
- valueSet → FhirCanonical?
-
valueSet Canonical reference to the value set that contains the entire
code system.
no setterinherited
- version → String?
-
version The identifier that is used to identify this version of the
code system when it is referenced in a specification, model, design or
instance. This is an arbitrary value managed by the code system 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. This is used in Coding.version.
no setterinherited
- versionElement → Element?
-
versionElement Extensions for version
no setterinherited
- versionNeeded → FhirBoolean?
-
versionNeeded This flag is used to signify that the code system does
not commit to concept permanence across versions. If true, a version must
be specified when referencing this code system.
no setterinherited
- versionNeededElement → Element?
-
versionNeededElement Extensions for versionNeeded
no setterinherited
Methods
-
newId(
) → Resource -
returns the same resource with a new ID (even if there is already an ID
present)
inherited
-
newIdIfNoId(
) → Resource -
returns the same resource with a new ID if there is no current ID
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toDbJson(
) → Map< String, dynamic> -
The normal toJson ignores the dbId, and produces the fhirId as the id
However, if you're going to use this as a database entry, you have to
switch those two ids
inherited
-
toJson(
) → Map< String, dynamic> -
inherited
-
toJsonString(
) → String -
Another convenience method because more and more I'm transmitting FHIR
data as a String and not a Map
override
-
toString(
) → String -
A string representation of this object.
inherited
-
toYaml(
) → String -
Produces a Yaml formatted String version of the object
inherited
-
updateVersion(
{FhirMeta? oldMeta}) → Resource -
Updates the meta field of this Resource, updates the meta.lastUpdated
field, adds 1 to the version number
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited