Class ValueSet

A value set specifies a set of codes drawn from one or more code systems.

Inheritance
System.Object
Resource
DomainResource
ValueSet
Implements
Inherited Members
Namespace: fhirCsR2.Models
Assembly: fhirCsR2.dll
Syntax
public class ValueSet : DomainResource, IFhirJsonSerializable

Properties

| Improve this Doc View Source

_Copyright

Extension container element for Copyright

Declaration
public Element _Copyright { get; set; }
Property Value
Type Description
Element
| Improve this Doc View Source

_Date

Extension container element for Date

Declaration
public Element _Date { get; set; }
Property Value
Type Description
Element
| Improve this Doc View Source

_Description

Extension container element for Description

Declaration
public Element _Description { get; set; }
Property Value
Type Description
Element
| Improve this Doc View Source

_Experimental

Extension container element for Experimental

Declaration
public Element _Experimental { get; set; }
Property Value
Type Description
Element
| Improve this Doc View Source

_Extensible

Extension container element for Extensible

Declaration
public Element _Extensible { get; set; }
Property Value
Type Description
Element
| Improve this Doc View Source

_Immutable

Extension container element for Immutable

Declaration
public Element _Immutable { get; set; }
Property Value
Type Description
Element
| Improve this Doc View Source

_LockedDate

Extension container element for LockedDate

Declaration
public Element _LockedDate { get; set; }
Property Value
Type Description
Element
| Improve this Doc View Source

_Name

Extension container element for Name

Declaration
public Element _Name { get; set; }
Property Value
Type Description
Element
| Improve this Doc View Source

_Publisher

Extension container element for Publisher

Declaration
public Element _Publisher { get; set; }
Property Value
Type Description
Element
| Improve this Doc View Source

_Requirements

Extension container element for Requirements

Declaration
public Element _Requirements { get; set; }
Property Value
Type Description
Element
| Improve this Doc View Source

_Status

Extension container element for Status

Declaration
public Element _Status { get; set; }
Property Value
Type Description
Element
| Improve this Doc View Source

_Url

Extension container element for Url

Declaration
public Element _Url { get; set; }
Property Value
Type Description
Element
| Improve this Doc View Source

_Version

Extension container element for Version

Declaration
public Element _Version { get; set; }
Property Value
Type Description
Element
| Improve this Doc View Source

CodeSystem

A definition of a code system, inlined into the value set (as a packaging convenience). Note that the inline code system may be used from other value sets by referring to its (codeSystem.system) directly.

Declaration
public ValueSetCodeSystem CodeSystem { get; set; }
Property Value
Type Description
ValueSetCodeSystem
| Improve this Doc View Source

Compose

A set of criteria that provide the content logical definition of the value set by including or excluding codes from outside this value set.

Declaration
public ValueSetCompose Compose { get; set; }
Property Value
Type Description
ValueSetCompose
| Improve this Doc View Source

Contact

Contacts to assist a user in finding and communicating with the publisher.

Declaration
public List<ValueSetContact> Contact { get; set; }
Property Value
Type Description
fhirCsR2.Models.List<ValueSetContact>
| Improve this Doc View Source

A copyright statement relating to the value set and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the value set.

Declaration
public string Copyright { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Date

Need to know when a value set was first legal for use or became withdrawn or replaced.

Declaration
public string Date { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Description

Human understandability.

Declaration
public string Description { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Expansion

A value set can also be "expanded", where the value set is turned into a simple collection of enumerated codes. This element holds the expansion, if it has been performed.

Declaration
public ValueSetExpansion Expansion { get; set; }
Property Value
Type Description
ValueSetExpansion
| Improve this Doc View Source

Experimental

This valueset was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.

Declaration
public bool? Experimental { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>
| Improve this Doc View Source

Extensible

It is not required to say whether this intent applies.

Declaration
public bool? Extensible { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>
| Improve this Doc View Source

Identifier

Formal identifier that is used to identify this value set when it is represented in other formats, or referenced in a specification, model, design or an instance.

Declaration
public Identifier Identifier { get; set; }
Property Value
Type Description
Identifier
| Improve this Doc View Source

Immutable

If this is set to 'true', then no new versions of the content logical definition can be created. Note: Other metadata might still change.

Declaration
public bool? Immutable { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>
| Improve this Doc View Source

LockedDate

If a locked date is defined, then the Content Logical Definition must be evaluated using the current version of all referenced code system(s) and value set instances as of the locked date.

Declaration
public string LockedDate { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Name

Support human navigation.

Declaration
public string Name { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Publisher

Helps establish the "authority/credibility" of the value set. May also allow for contact.

Declaration
public string Publisher { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Requirements

Explains why this value set is needed and why it has been constrained as it has.

Declaration
public string Requirements { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

ResourceType

Resource Type Name

Declaration
public override string ResourceType { get; }
Property Value
Type Description
System.String
Overrides
| Improve this Doc View Source

Status

Identify when/if the value set should be used.

Declaration
public string Status { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Url

An absolute URL that is used to identify this value set when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this value set is (or will be) published.

Declaration
public string Url { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

UseContext

Assist in searching for appropriate content.

Declaration
public List<CodeableConcept> UseContext { get; set; }
Property Value
Type Description
fhirCsR2.Models.List<CodeableConcept>
| Improve this Doc View Source

Version

Used to identify this version of the value set when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the profile author manually and the value should be a timestamp.

Declaration
public string Version { get; set; }
Property Value
Type Description
System.String

Methods

| Improve this Doc View Source

DeserializeJson(ref Utf8JsonReader, JsonSerializerOptions)

Deserialize a JSON object

Declaration
public void DeserializeJson(ref Utf8JsonReader reader, JsonSerializerOptions options)
Parameters
Type Name Description
Utf8JsonReader reader
JsonSerializerOptions options
| Improve this Doc View Source

DeserializeJsonProperty(ref Utf8JsonReader, JsonSerializerOptions, String)

Deserialize a JSON property

Declaration
public void DeserializeJsonProperty(ref Utf8JsonReader reader, JsonSerializerOptions options, string propertyName)
Parameters
Type Name Description
Utf8JsonReader reader
JsonSerializerOptions options
System.String propertyName
| Improve this Doc View Source

SerializeJson(Utf8JsonWriter, JsonSerializerOptions, Boolean)

Serialize to a JSON object

Declaration
public void SerializeJson(Utf8JsonWriter writer, JsonSerializerOptions options, bool includeStartObject = true)
Parameters
Type Name Description
Utf8JsonWriter writer
JsonSerializerOptions options
System.Boolean includeStartObject

Implements