pub struct CodeSystem {Show 45 fields
pub id: Option<String>,
pub meta: Option<Meta>,
pub implicit_rules: Option<Uri>,
pub language: Option<Code>,
pub text: Option<Narrative>,
pub contained: Vec<Resource>,
pub extension: Vec<Extension>,
pub modifier_extension: Vec<Extension>,
pub url: Option<Uri>,
pub identifier: Vec<Identifier>,
pub version: Option<String>,
pub version_algorithm: Option<CodeSystemVersionAlgorithm>,
pub name: Option<String>,
pub title: Option<String>,
pub status: Code,
pub experimental: Option<Boolean>,
pub date: Option<DateTime>,
pub publisher: Option<String>,
pub contact: Vec<ContactDetail>,
pub description: Option<Markdown>,
pub use_context: Vec<UsageContext>,
pub jurisdiction: Vec<CodeableConcept>,
pub purpose: Option<Markdown>,
pub copyright: Option<Markdown>,
pub copyright_label: Option<String>,
pub approval_date: Option<Date>,
pub last_review_date: Option<Date>,
pub effective_period: Option<Period>,
pub topic: Vec<CodeableConcept>,
pub author: Vec<ContactDetail>,
pub editor: Vec<ContactDetail>,
pub reviewer: Vec<ContactDetail>,
pub endorser: Vec<ContactDetail>,
pub related_artifact: Vec<RelatedArtifact>,
pub case_sensitive: Option<Boolean>,
pub value_set: Option<Canonical>,
pub hierarchy_meaning: Option<Code>,
pub compositional: Option<Boolean>,
pub version_needed: Option<Boolean>,
pub content: Code,
pub supplements: Option<Canonical>,
pub count: Option<UnsignedInt>,
pub filter: Vec<CodeSystemFilter>,
pub property: Vec<CodeSystemProperty>,
pub concept: Vec<CodeSystemConcept>,
}Expand description
Declares the existence of and describes a code system or code system supplement
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.
Fields§
§id: Option<String>Logical id of this artifact
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta: Option<Meta>Metadata about the resource
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.
implicit_rules: Option<Uri>A set of rules under which this content was created
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. For DomainResources, if more than one implicitRules policy applies, additional policies may be conveyed using the [additionalImplicitRules](https://build.fhir.org/ig/HL7/fhir-extensions/StructureDefinition-additionalImplicitRules.html) extension.
language: Option<Code>Language of the resource content
The base language in which the resource is written.
text: Option<Narrative>Text summary of the resource, for human interpretation
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: Vec<Resource>Contained, inline Resources
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.
extension: Vec<Extension>Additional content defined by implementations
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.
modifier_extension: Vec<Extension>Extensions that cannot be ignored
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).
url: Option<Uri>Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system)
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](datatypes.html#Coding).system.
identifier: Vec<Identifier>Additional identifier for the code system (business 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.
version: Option<String>Business version of the code system (Coding.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](datatypes.html#Coding).version.
version_algorithm: Option<CodeSystemVersionAlgorithm>How to compare versions
Indicates the mechanism used to compare versions to determine which CodeSystem is more current.
name: Option<String>Name for this code system (computer friendly)
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.
title: Option<String>Name for this code system (human friendly)
A short, descriptive, user-friendly title for the code system.
status: Codedraft | active | retired | unknown
The status of this code system. Enables tracking the life-cycle of the content.
experimental: Option<Boolean>For testing only - never for real usage
A Boolean value to indicate that this code system is authored for testing purposes (or education/evaluation/marketing) and no version of this resource will ever be intended for genuine usage.
date: Option<DateTime>Date last changed
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.
publisher: Option<String>Name of the publisher/steward (organization or individual)
The name of the organization or individual responsible for the release and ongoing maintenance of the code system.
contact: Vec<ContactDetail>Contact details for the publisher
Contact details to assist a user in finding and communicating with the publisher.
description: Option<Markdown>Natural language description of the code system
A free text natural language description of the code system from a consumer’s perspective.
use_context: Vec<UsageContext>The context that the content is intended to support
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.
jurisdiction: Vec<CodeableConcept>Jurisdiction of the authority that maintains the code system (if applicable)
A legal or geographic region in which the authority that maintains the resource is operating. In general, the jurisdiction is also found in the useContext. The useContext may reference additional jurisdictions because the defining jurisdiction does not necessarily limit the jurisdictions of use.
purpose: Option<Markdown>Why this code system is defined
Explanation of why this code system is needed and why it has been designed as it has.
copyright: Option<Markdown>Notice about intellectual property ownership, can include restrictions on use
A copyright statement relating to the code system and/or its contents. Copyright statements are notices of intellectual property ownership and can include restrictions on the use and publishing of the code system.
copyright_label: Option<String>Copyright holder and year(s)
A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are restricted. (e.g. ‘All rights reserved’, ‘Some rights reserved’).
approval_date: Option<Date>When the CodeSystem was approved by publisher
The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
last_review_date: Option<Date>When the CodeSystem was last reviewed by the publisher
The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
effective_period: Option<Period>When the CodeSystem is expected to be used
The period during which the CodeSystem content was or is planned to be in active use.
topic: Vec<CodeableConcept>E.g. Education, Treatment, Assessment, etc
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.
Who authored the CodeSystem
An individual or organization primarily involved in the creation and maintenance of the CodeSystem.
editor: Vec<ContactDetail>Who edited the CodeSystem
An individual or organization primarily responsible for internal coherence of the CodeSystem.
reviewer: Vec<ContactDetail>Who reviewed the CodeSystem
An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the CodeSystem.
endorser: Vec<ContactDetail>Who endorsed the CodeSystem
An individual or organization asserted by the publisher to be responsible for officially endorsing the CodeSystem for use in some setting.
Additional documentation, citations, etc
Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts. If the type is `successor` or `predecessor`, the related resource must be a CodeSystem.
case_sensitive: Option<Boolean>If code comparison is case sensitive
If code comparison is case sensitive when codes within this system are compared to each other.
value_set: Option<Canonical>Canonical reference to the value set with entire code system
Canonical reference to the value set that contains all codes in the code system independent of code status.
hierarchy_meaning: Option<Code>grouped-by | is-a | part-of | classified-with
The meaning of the hierarchy of concepts as represented in this resource.
compositional: Option<Boolean>If code system defines a compositional grammar
The code system defines a compositional (post-coordination) grammar.
version_needed: Option<Boolean>If definitions are not stable
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.
content: Codenot-present | example | fragment | complete | supplement
The extent of the content of the code system (the concepts and codes it defines) are represented in this resource instance.
supplements: Option<Canonical>Canonical URL of Code System this adds designations and properties to
The canonical URL of the code system that this code system supplement is adding designations and properties to.
count: Option<UnsignedInt>Total concepts in the code system
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.
filter: Vec<CodeSystemFilter>Filter that can be used in a value set
A filter that can be used in a value set compose statement when selecting concepts using a filter.
property: Vec<CodeSystemProperty>Additional information supplied about each concept
A property defines an additional slot through which additional information can be provided about a concept.
concept: Vec<CodeSystemConcept>Concepts in the code system
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.