Skip to main content

CodeSystem

Struct CodeSystem 

Source
pub struct CodeSystem {
Show 34 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 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 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.

§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, and nor can they have their own independent transaction scope.

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

§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 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: 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 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.

§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: Code

draft | active | retired | unknown

The date (and optionally time) when the code system resource was created or revised.

§experimental: Option<Boolean>

For testing purposes, not real usage

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.

§date: Option<DateTime>

Date last changed

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.

§publisher: Option<String>

Name of the publisher (organization or individual)

The name of the organization or individual that published 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>

Intended jurisdiction for code system (if applicable)

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

§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>

Use and/or publishing restrictions

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.

§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 the entire code system.

§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: Code

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

Trait Implementations§

Source§

impl Clone for CodeSystem

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for CodeSystem

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for CodeSystem

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for CodeSystem

Source§

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for CodeSystem

Source§

impl Json for CodeSystem

Source§

fn to_json(&self) -> Result<Object, EncodeError>

The JSON object. Read more
Source§

fn from_json(object: &Object, path: &mut Path) -> Result<Self, DecodeError>

Decodes object, refusing unknown properties. Read more
Source§

impl PartialEq for CodeSystem

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for CodeSystem

Source§

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for CodeSystem

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.