Show / Hide Table of Contents

Class FhirValueSet

A fhir value set.

Inheritance
System.Object
FhirValueSet
Namespace: Microsoft.Health.Fhir.CodeGenCommon.Models
Assembly: Microsoft.Health.Fhir.CodeGenCommon.dll
Syntax
public class FhirValueSet : ICloneable

Constructors

| Improve this Doc View Source

FhirValueSet(String, String, String, String, String, String, String, Nullable<Int32>, String, List<FhirValueSetComposition>, List<FhirValueSetComposition>, FhirValueSetExpansion)

Initializes a new instance of the FhirValueSet class.

Declaration
public FhirValueSet(string name, string id, string version, string title, string url, string publicationStatus, string standardStatus, int? fmmLevel, string description, List<FhirValueSetComposition> composeIncludes, List<FhirValueSetComposition> composeExcludes, FhirValueSetExpansion expansion)
Parameters
Type Name Description
System.String name

The name.

System.String id

The identifier.

System.String version

The version.

System.String title

The title.

System.String url

The URL.

System.String publicationStatus

The publication status.

System.String standardStatus

The standard status.

System.Nullable<System.Int32> fmmLevel

The fmm level.

System.String description

The description.

List<FhirValueSetComposition> composeIncludes

The compose includes.

List<FhirValueSetComposition> composeExcludes

The compose excludes.

FhirValueSetExpansion expansion

The expansion.

Properties

| Improve this Doc View Source

ComposeExcludes

Gets the compose excludes.

Declaration
public List<FhirValueSetComposition> ComposeExcludes { get; }
Property Value
Type Description
List<FhirValueSetComposition>

The compose excludes.

| Improve this Doc View Source

ComposeIncludes

Gets the compose includes.

Declaration
public List<FhirValueSetComposition> ComposeIncludes { get; }
Property Value
Type Description
List<FhirValueSetComposition>

The compose includes.

| Improve this Doc View Source

Concepts

Gets the concepts.

Declaration
public List<FhirConcept> Concepts { get; }
Property Value
Type Description
List<FhirConcept>

The concepts.

| Improve this Doc View Source

Description

Gets the description.

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

The description.

| Improve this Doc View Source

Expansion

Gets the expansions.

Declaration
public FhirValueSetExpansion Expansion { get; }
Property Value
Type Description
FhirValueSetExpansion

The expansions.

| Improve this Doc View Source

FhirMaturityLevel

Gets the FHIR maturity level.

Declaration
public int? FhirMaturityLevel { get; }
Property Value
Type Description
System.Nullable<System.Int32>
| Improve this Doc View Source

Id

Gets the identifier.

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

The identifier.

| Improve this Doc View Source

Key

Gets the key.

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

The key.

| Improve this Doc View Source

Name

Gets the name.

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

The name.

| Improve this Doc View Source

PublicationStatus

Gets the publication status.

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

ReferencedByComplexes

Gets the list of resources or complex types that reference this value set.

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

ReferencedByPaths

Gets the list of elements (by Path) that reference this value set.

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

ReferencedCodeSystems

Gets the referenced code systems.

Declaration
public HashSet<string> ReferencedCodeSystems { get; }
Property Value
Type Description
HashSet<System.String>

The referenced code systems.

| Improve this Doc View Source

ReferencingElementsByPath

Gets the full pathname of the referencing elements by file.

Declaration
public Dictionary<string, FhirElement> ReferencingElementsByPath { get; }
Property Value
Type Description
Dictionary<System.String, FhirElement>
| Improve this Doc View Source

ReferencingExternalElementsByUrl

Gets the full pathname of the external referencing elements (e.g., extensions, profiles) by definitional URL.

Declaration
public Dictionary<string, FhirElement> ReferencingExternalElementsByUrl { get; }
Property Value
Type Description
Dictionary<System.String, FhirElement>
| Improve this Doc View Source

StandardStatus

Gets status of this type in the standards process see: http://hl7.org/fhir/valueset-standards-status.html.

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

The standard status.

| Improve this Doc View Source

StrongestBinding

Gets the strongest binding this value set is referenced as (null for unreferenced).

Declaration
public FhirElement.ElementDefinitionBindingStrength? StrongestBinding { get; }
Property Value
Type Description
System.Nullable<FhirElement.ElementDefinitionBindingStrength>
| Improve this Doc View Source

StrongestBindingByType

Gets a Dictionary of strongest bindings by FHIR element type

Declaration
public Dictionary<string, FhirElement.ElementDefinitionBindingStrength> StrongestBindingByType { get; }
Property Value
Type Description
Dictionary<System.String, FhirElement.ElementDefinitionBindingStrength>
| Improve this Doc View Source

StrongestExternalBinding

Gets the strongest external (e.g., profile, extension) binding.

Declaration
public FhirElement.ElementDefinitionBindingStrength? StrongestExternalBinding { get; }
Property Value
Type Description
System.Nullable<FhirElement.ElementDefinitionBindingStrength>
| Improve this Doc View Source

StrongestExternalBindingByType

Gets the type of the strongest external (e.g., profile, extension) binding by type.

Declaration
public Dictionary<string, FhirElement.ElementDefinitionBindingStrength> StrongestExternalBindingByType { get; }
Property Value
Type Description
Dictionary<System.String, FhirElement.ElementDefinitionBindingStrength>
| Improve this Doc View Source

Title

Gets the title.

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

The title.

| Improve this Doc View Source

URL

Gets URL of the document.

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

The URL.

| Improve this Doc View Source

Version

Gets the version.

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

The version.

Methods

| Improve this Doc View Source

Clone()

Deep copy.

Declaration
public object Clone()
Returns
Type Description
System.Object

A FhirValueSet.

| Improve this Doc View Source

Resolve(Dictionary<String, FhirCodeSystem>)

Gets a list of FhirTriplets to cover all values in the value set.

Declaration
public void Resolve(Dictionary<string, FhirCodeSystem> codeSystems)
Parameters
Type Name Description
Dictionary<System.String, FhirCodeSystem> codeSystems

The code systems.

| Improve this Doc View Source

SetReferences(ValueSetReferenceInfo)

Sets the references.

Declaration
public void SetReferences(ValueSetReferenceInfo referenceInfo)
Parameters
Type Name Description
ValueSetReferenceInfo referenceInfo

Reference information for this value set.

  • Improve this Doc
  • View Source
In This Article
  • Constructors
    • FhirValueSet(String, String, String, String, String, String, String, Nullable<Int32>, String, List<FhirValueSetComposition>, List<FhirValueSetComposition>, FhirValueSetExpansion)
  • Properties
    • ComposeExcludes
    • ComposeIncludes
    • Concepts
    • Description
    • Expansion
    • FhirMaturityLevel
    • Id
    • Key
    • Name
    • PublicationStatus
    • ReferencedByComplexes
    • ReferencedByPaths
    • ReferencedCodeSystems
    • ReferencingElementsByPath
    • ReferencingExternalElementsByUrl
    • StandardStatus
    • StrongestBinding
    • StrongestBindingByType
    • StrongestExternalBinding
    • StrongestExternalBindingByType
    • Title
    • URL
    • Version
  • Methods
    • Clone()
    • Resolve(Dictionary<String, FhirCodeSystem>)
    • SetReferences(ValueSetReferenceInfo)
Back to top Generated by DocFX