CodeSystem class

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.

Mixed in types

• Resource

Annotations

• @freezed

Constructors

CodeSystem({@Default(R5ResourceType.CodeSystem) @JsonKey(unknownEnumValue: R5ResourceType.CodeSystem) R5ResourceType resourceType, @JsonKey(includeFromJson: true, includeToJson: false) int? dbId, @JsonKey(name: 'id') FhirId? 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? versionAlgorithmString, @JsonKey(name: '_versionAlgorithmString') Element? versionAlgorithmStringElement, Coding? versionAlgorithmCoding, 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, String? copyrightLabel, @JsonKey(name: '_copyrightLabel') Element? copyrightLabelElement, FhirDate? approvalDate, @JsonKey(name: '_approvalDate') Element? approvalDateElement, FhirDate? lastReviewDate, @JsonKey(name: '_lastReviewDate') Element? lastReviewDateElement, Period? effectivePeriod, List<CodeableConcept>? topic, List<ContactDetail>? author, List<ContactDetail>? editor, List<ContactDetail>? reviewer, List<ContactDetail>? endorser, List<RelatedArtifact>? relatedArtifact, 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, @JsonKey(name: 'count') FhirUnsignedInt? codeSystemCount, @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.

const

factory

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

approvalDate → FhirDate?

approvalDate The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

no setter, inherited

approvalDateElement → Element?

approvalDateElement ("_approvalDate") Extensions for approvalDate

no setter, inherited

author → List<ContactDetail>?

author An individiual or organization primarily involved in the creation and maintenance of the CodeSystem.

no setter, inherited

caseSensitive → FhirBoolean?

caseSensitive If code comparison is case sensitive when codes within this system are compared to each other.

no setter, inherited

caseSensitiveElement → Element?

caseSensitiveElement ("_caseSensitive") Extensions for caseSensitive

no setter, inherited

codeSystemCount → 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 setter, inherited

compositional → FhirBoolean?

compositional The code system defines a compositional (post-coordination) grammar.

no setter, inherited

compositionalElement → Element?

compositionalElement ("_compositional") Extensions for compositional

no setter, inherited

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 setter, inherited

contact → List<ContactDetail>?

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

no setter, inherited

contained → List<Resource>?

contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

no setter, inherited

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 setter, inherited

contentElement → Element?

contentElement ("_content") Extensions for content

no setter, inherited

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 setter, inherited

copyrightElement → Element?

copyrightElement ("_copyright") Extensions for copyright

no setter, inherited

copyrightLabel → String?

copyrightLabel A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').

no setter, inherited

copyrightLabelElement → Element?

copyrightLabelElement ("_copyrightLabel") Extensions for copyrightLabel

no setter, inherited

copyWith → $CodeSystemCopyWith<CodeSystem>

no setter, inherited

countElement → Element?

countElement ("_count") Extensions for count

no setter, inherited

date → FhirDateTime?

date The date (and optionally time) when the code system was last significantly changed. 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 setter, inherited

dateElement → Element?

dateElement ("_date") Extensions for date

no setter, inherited

dbId → int?

no setter, inherited

description → FhirMarkdown?

description A free text natural language description of the code system from a consumer's perspective.

no setter, inherited

descriptionElement → Element?

descriptionElement ("_description") Extensions for description

no setter, inherited

editor → List<ContactDetail>?

editor An individual or organization primarily responsible for internal coherence of the CodeSystem.

no setter, inherited

effectivePeriod → Period?

effectivePeriod The period during which the CodeSystem content was or is planned to be in active use.

no setter, inherited

endorser → List<ContactDetail>?

endorser An individual or organization asserted by the publisher to be responsible for officially endorsing the CodeSystem for use in some setting.

no setter, inherited

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 setter, inherited

experimentalElement → Element?

experimentalElement ("_experimental") Extensions for experimental

no setter, inherited

extension_ → List<FhirExtension>?

extension_ ("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 managable, 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 setter, inherited

fhirId → FhirId?

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

no setter, inherited

filter → List<CodeSystemFilter>?

filter A filter that can be used in a value set compose statement when selecting concepts using a filter.

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

hierarchyMeaning → FhirCode?

hierarchyMeaning The meaning of the hierarchy of concepts as represented in this resource.

no setter, inherited

hierarchyMeaningElement → Element?

hierarchyMeaningElement ("_hierarchyMeaning") Extensions for hierarchyMeaning

no setter, inherited

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 setter, inherited

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 setter, inherited

implicitRulesElement → Element?

implicitRulesElement ("_implicitRules") Extensions for implicitRules

no setter, inherited

jurisdiction → List<CodeableConcept>?

jurisdiction A legal or geographic region in which the code system is intended to be used.

no setter, inherited

language → FhirCode?

language The base language in which the resource is written.

no setter, inherited

languageElement → Element?

languageElement ("_language") Extensions for language

no setter, inherited

lastReviewDate → FhirDate?

lastReviewDate The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

no setter, inherited

lastReviewDateElement → Element?

lastReviewDateElement ("_lastReviewDate") Extensions for lastReviewDate

no setter, inherited

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 setter, inherited

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 managable, 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 setter, inherited

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 setter, inherited

nameElement → Element?

nameElement ("_name") Extensions for name

no setter, inherited

path → String

Local Reference for this Resource, form is "ResourceType/Id"

no setter, inherited

property → List<CodeSystemProperty>?

property A property defines an additional slot through which additional information can be provided about a concept.

no setter, inherited

publisher → String?

publisher The name of the organization or individual responsible for the release and ongoing maintenance of the code system.

no setter, inherited

publisherElement → Element?

publisherElement ("_publisher") Extensions for publisher

no setter, inherited

purpose → FhirMarkdown?

purpose Explanation of why this code system is needed and why it has been designed as it has.

no setter, inherited

purposeElement → Element?

purposeElement ("_purpose") Extensions for purpose

no setter, inherited

relatedArtifact → List<RelatedArtifact>?

relatedArtifact Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts.

no setter, inherited

resourceType → R5ResourceType

resourceType This is a CodeSystem resource

no setter, inherited

resourceTypeString → String?

produce a string of the resourceType

no setter, inherited

reviewer → List<ContactDetail>?

reviewer An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the CodeSystem.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

status → FhirCode?

status The status of this code system. Enables tracking the life-cycle of the content.

no setter, inherited

statusElement → Element?

statusElement ("_status") Extensions for status

no setter, inherited

supplements → FhirCanonical?

supplements The canonical URL of the code system that this code system supplement is adding designations and properties to.

no setter, inherited

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 setter, inherited

thisReference → Reference

Convenience method to return a Reference referring to that Resource

no setter, inherited

title → String?

title A short, descriptive, user-friendly title for the code system.

no setter, inherited

titleElement → Element?

titleElement ("_title") Extensions for title

no setter, inherited

topic → List<CodeableConcept>?

topic Descriptions related to the content of the CodeSystem. Topics provide a high-level categorization as well as keywords for the CodeSystem that can be useful for filtering and searching.

no setter, inherited

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 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 setter, inherited

urlElement → Element?

urlElement ("_url") Extensions for url

no setter, inherited

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 setter, inherited

valueSet → FhirCanonical?

valueSet Canonical reference to the value set that contains all codes in the code system independent of code status.

no setter, inherited

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 setter, inherited

versionAlgorithmCoding → Coding?

versionAlgorithmCoding Indicates the mechanism used to compare versions to determine which CodeSystem is more current.

no setter, inherited

versionAlgorithmString → String?

versionAlgorithmString Indicates the mechanism used to compare versions to determine which CodeSystem is more current.

no setter, inherited

versionAlgorithmStringElement → Element?

versionAlgorithmStringElement ("_versionAlgorithmString") Extensions for versionAlgorithmString

no setter, inherited

versionElement → Element?

versionElement ("_version") Extensions for version

no setter, inherited

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 setter, inherited

versionNeededElement → Element?

versionNeededElement ("_versionNeeded") Extensions for versionNeeded

no setter, inherited

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

override

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