Class Conformance

A conformance statement is a set of capabilities of a FHIR Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.

Inheritance

System.Object

Resource

DomainResource

Conformance

Implements

IFhirJsonSerializable

Inherited Members

DomainResource.Contained

DomainResource.Extension

DomainResource.ModifierExtension

DomainResource.Text

Resource.Id

Resource._Id

Resource.ImplicitRules

Resource._ImplicitRules

Resource.Language

Resource._Language

Resource.Meta

Namespace: fhirCsR2.Models

Assembly: fhirCsR2.dll

Syntax

public class Conformance : DomainResource, IFhirJsonSerializable

Properties

_AcceptUnknown

Extension container element for AcceptUnknown

Declaration

public Element _AcceptUnknown { get; set; }

Property Value

Type	Description
Element

_Copyright

Extension container element for Copyright

Declaration

public Element _Copyright { get; set; }

Property Value

Type	Description
Element

_Date

Extension container element for Date

Declaration

public Element _Date { get; set; }

Property Value

Type	Description
Element

_Description

Extension container element for Description

Declaration

public Element _Description { get; set; }

Property Value

Type	Description
Element

_Experimental

Extension container element for Experimental

Declaration

public Element _Experimental { get; set; }

Property Value

Type	Description
Element

_FhirVersion

Extension container element for FhirVersion

Declaration

public Element _FhirVersion { get; set; }

Property Value

Type	Description
Element

_Format

Extension container element for Format

Declaration

public List<Element> _Format { get; set; }

Property Value

Type	Description
fhirCsR2.Models.List<Element>

_Kind

Extension container element for Kind

Declaration

public Element _Kind { get; set; }

Property Value

Type	Description
Element

_Name

Extension container element for Name

Declaration

public Element _Name { get; set; }

Property Value

Type	Description
Element

_Publisher

Extension container element for Publisher

Declaration

public Element _Publisher { get; set; }

Property Value

Type	Description
Element

_Requirements

Extension container element for Requirements

Declaration

public Element _Requirements { get; set; }

Property Value

Type	Description
Element

_Status

Extension container element for Status

Declaration

public Element _Status { get; set; }

Property Value

Type	Description
Element

_Url

Extension container element for Url

Declaration

public Element _Url { get; set; }

Property Value

Type	Description
Element

_Version

Extension container element for Version

Declaration

public Element _Version { get; set; }

Property Value

Type	Description
Element

AcceptUnknown

A code that indicates whether the application accepts unknown elements or extensions when reading resources.

Declaration

public string AcceptUnknown { get; set; }

Property Value

Type	Description
System.String

Contact

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

Declaration

public List<ConformanceContact> Contact { get; set; }

Property Value

Type	Description
fhirCsR2.Models.List<ConformanceContact>

Copyright

A copyright statement relating to the conformance statement and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the details of the system described by the conformance statement.

Declaration

public string Copyright { get; set; }

Property Value

Type	Description
System.String

Date

The date (and optionally time) when the conformance statement was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the conformance statement changes.

Declaration

public string Date { get; set; }

Property Value

Type	Description
System.String

Description

A free text natural language description of the conformance statement and its use. Typically, this is used when the conformance statement describes a desired rather than an actual solution, for example as a formal expression of requirements as part of an RFP.

Declaration

public string Description { get; set; }

Property Value

Type	Description
System.String

Document

A document definition.

Declaration

public List<ConformanceDocument> Document { get; set; }

Property Value

Type	Description
fhirCsR2.Models.List<ConformanceDocument>

Experimental

A flag to indicate that this conformance statement is 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>

FhirVersion

The version of the FHIR specification on which this conformance statement is based.

Declaration

public string FhirVersion { get; set; }

Property Value

Type	Description
System.String

Format

A list of the formats supported by this implementation using their content types.

Declaration

public List<string> Format { get; set; }

Property Value

Type	Description
fhirCsR2.Models.List<System.String>

Implementation

Identifies a specific implementation instance that is described by the conformance statement - i.e. a particular installation, rather than the capabilities of a software program.

Declaration

public ConformanceImplementation Implementation { get; set; }

Property Value

Type	Description
ConformanceImplementation

Kind

Allow searching the 3 modes.

Declaration

public string Kind { get; set; }

Property Value

Type	Description
System.String

Messaging

A description of the messaging capabilities of the solution.

Declaration

public List<ConformanceMessaging> Messaging { get; set; }

Property Value

Type	Description
fhirCsR2.Models.List<ConformanceMessaging>

Name

A free text natural language name identifying the conformance statement.

Declaration

public string Name { get; set; }

Property Value

Type	Description
System.String

Profile

A list of profiles that represent different use cases supported by the system. For a server, "supported by the system" means the system hosts/produces a set of resources that are conformant to a particular profile, and allows clients that use its services to search using this profile and to find appropriate data. For a client, it means the system will search by this profile and process data according to the guidance implicit in the profile. See further discussion in [Using Profiles]{profiling.html#profile-uses}.

Declaration

public List<Reference> Profile { get; set; }

Property Value

Type	Description
fhirCsR2.Models.List<Reference>

Publisher

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

Declaration

public string Publisher { get; set; }

Property Value

Type	Description
System.String

Requirements

Explains why this conformance statement is needed and why it's been constrained as it has.

Declaration

public string Requirements { get; set; }

Property Value

Type	Description
System.String

ResourceType

Resource Type Name

Declaration

public override string ResourceType { get; }

Property Value

Type	Description
System.String

Overrides

Resource.ResourceType

Rest

A definition of the restful capabilities of the solution, if any.

Declaration

public List<ConformanceRest> Rest { get; set; }

Property Value

Type	Description
fhirCsR2.Models.List<ConformanceRest>

Software

Software that is covered by this conformance statement. It is used when the conformance statement describes the capabilities of a particular software version, independent of an installation.

Declaration

public ConformanceSoftware Software { get; set; }

Property Value

Type	Description
ConformanceSoftware

Status

The status of this conformance statement.

Declaration

public string Status { get; set; }

Property Value

Type	Description
System.String

Url

An absolute URL that is used to identify this conformance statement 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 conformance statement is (or will be) published.

Declaration

public string Url { get; set; }

Property Value

Type	Description
System.String

Version

The identifier that is used to identify this version of the conformance statement 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

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

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

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

IFhirJsonSerializable