ADO.NET Provider for FHIR

Build 24.0.9029

Columns

To access metadata for the columns available in the database, retrieve the Columns schema collection. You can also access the column metadata for views by retrieving the ViewColumns schema collection.

Alternatively, retrieve metadata from Result Sets. The same columns are returned for result set metadata as the Columns and ViewColumns schema collections; see below.

Retrieving Column Metadata

Call the GetSchema method of the FHIRConnection class to retrieve the Columns or ViewColumns schema collections. You can restrict results by table name, as shown in the example below.

C#

string connectionString = "URL=http://test.fhir.org/r4b/;ConnectionType=Generic;ContentType=JSON;AuthScheme=None;";

using (FHIRConnection conn = new FHIRConnection(connectionString)) {
  conn.Open();
  DataTable databaseSchema = conn.GetSchema("Columns", new string[] {"Patient"});
  foreach (DataRow column in databaseSchema.Rows) {
    Console.WriteLine(column["COLUMN_NAME"]);
    Console.WriteLine(column["IS_KEY"]);
    Console.WriteLine(column["DATA_TYPE"]);
  }
}

VB.NET

Dim connectionString As String = "URL=http://test.fhir.org/r4b/;ConnectionType=Generic;ContentType=JSON;AuthScheme=None;"

Using conn As New FHIRConnection(connectionString)
  conn.Open()
  Dim databaseSchema As DataTable = conn.GetSchema("Columns", New String() {"Patient"})
  For Each column As DataRow In databaseSchema.Rows
    Console.WriteLine(column("COLUMN_NAME"))
    Console.WriteLine(column("IS_KEY"))
    Console.WriteLine(column("DATA_TYPE"))
  Next
End Using

Columns Returned

The Columns and ViewColumns schema collections and DataTables returned from the query contain the following columns.

Column NameData TypeDescription
TABLE_CATALOGSystem.StringThe database containing the table.
TABLE_SCHEMASystem.StringThe schema containing the table.
TABLE_NAMESystem.StringThe table containing the column.
COLUMN_NAMESystem.StringThe column name.
ORDINAL_POSITIONSystem.Int32The sequence number of the column.
COLUMN_DEFAULTSystem.StringThe default value of the column.
IS_NULLABLESystem.StringWhether the column allows null values. This value is YES or NO.
DATA_TYPESystem.StringThe column data type.
CHARACTER_MAXIMUM_LENGTHSystem.Int32The maximum length in characters of a column with character data.
NUMERIC_PRECISIONSystem.Int32The maximum number of digits allowed for numeric data.
NUMERIC_SCALESystem.Int32The maximum column scale or the number of digits to the right of the decimal point in numeric data.
DATETIME_PRECISIONSystem.Int32Returns the precision in fractional seconds if the parameter type is datetime or smalldatetime. Otherwise, returns NULL.
CHARACTER_SET_NAMESystem.StringThe name of the character set for a column with character data.
COLUMN_COMMENTSystem.StringA brief description of the column.
PROVIDER_TYPESystem.TypeIndicates the appropriate data type dependent on the language you are executing in.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9029