Class ImplementationGuide
A set of rules or how FHIR is used to solve a particular problem. This resource is used to gather all the parts of an implementation guide into a logical whole, and to publish a computable definition of all the parts.
Implements
Inherited Members
Namespace: fhirCsR2.Models
Assembly: fhirCsR2.dll
Syntax
public class ImplementationGuide : DomainResource, IFhirJsonSerializable
Properties
| Improve this Doc View Source_Binary
Extension container element for Binary
Declaration
public List<Element> _Binary { get; set; }
Property Value
Type | Description |
---|---|
fhir |
_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 |
_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 |
_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 |
Binary
A binary file that is included in the implementation guide when it is published.
Declaration
public List<string> Binary { get; set; }
Property Value
Type | Description |
---|---|
fhir |
Contact
Contacts to assist a user in finding and communicating with the publisher.
Declaration
public List<ImplementationGuideContact> Contact { get; set; }
Property Value
Type | Description |
---|---|
fhir |
Copyright
A copyright statement relating to the implementation guide and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the details of the constraints and mappings.
Declaration
public string Copyright { get; set; }
Property Value
Type | Description |
---|---|
System. |
Date
The date this version of the implementation guide 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 implementation guide changes.
Declaration
public string Date { get; set; }
Property Value
Type | Description |
---|---|
System. |
Dependency
Another implementation guide that this implementation depends on. Typically, an implementation guide uses value sets, profiles etc.defined in other implementation guides.
Declaration
public List<ImplementationGuideDependency> Dependency { get; set; }
Property Value
Type | Description |
---|---|
fhir |
Description
A free text natural language description of the Implementation Guide and its use.
Declaration
public string Description { get; set; }
Property Value
Type | Description |
---|---|
System. |
Experimental
Allows filtering of Implementation Guides that are appropriate for use vs. not.
Declaration
public bool? Experimental { get; set; }
Property Value
Type | Description |
---|---|
System. |
FhirVersion
The version of the FHIR specification on which this ImplementationGuide is based - this is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 1.0.2 for this version.
Declaration
public string FhirVersion { get; set; }
Property Value
Type | Description |
---|---|
System. |
Global
A set of profiles that all resources covered by this implementation guide must conform to.
Declaration
public List<ImplementationGuideGlobal> Global { get; set; }
Property Value
Type | Description |
---|---|
fhir |
Name
A free text natural language name identifying the Implementation Guide.
Declaration
public string Name { get; set; }
Property Value
Type | Description |
---|---|
System. |
Package
A logical group of resources. Logical groups can be used when building pages.
Declaration
public List<ImplementationGuidePackage> Package { get; set; }
Property Value
Type | Description |
---|---|
fhir |
Page
A page / section in the implementation guide. The root page is the implementation guide home page.
Declaration
public ImplementationGuidePage Page { get; set; }
Property Value
Type | Description |
---|---|
Implementation |
Publisher
Helps establish the "authority/credibility" of the implementation guide. May also allow for contact.
Declaration
public string Publisher { get; set; }
Property Value
Type | Description |
---|---|
System. |
ResourceType
Resource Type Name
Declaration
public override string ResourceType { get; }
Property Value
Type | Description |
---|---|
System. |
Overrides
| Improve this Doc View SourceStatus
Allows filtering of Implementation Guides that are appropriate for use vs. not.
Declaration
public string Status { get; set; }
Property Value
Type | Description |
---|---|
System. |
Url
This is required to allow hosting Implementation Guides on multiple different servers, and to allow for the editorial process.
Declaration
public string Url { get; set; }
Property Value
Type | Description |
---|---|
System. |
UseContext
Assist in searching for appropriate implementation guide.
Declaration
public List<CodeableConcept> UseContext { get; set; }
Property Value
Type | Description |
---|---|
fhir |
Version
There may be multiple resource versions of the Implementation Guide that have this same identifier. The resource version id will change for technical reasons, whereas the stated version number needs to be under the author's control.
Declaration
public string Version { get; set; }
Property Value
Type | Description |
---|---|
System. |
Methods
| Improve this Doc View SourceDeserializeJson(ref Utf8JsonReader, JsonSerializerOptions)
Deserialize a JSON object
Declaration
public void DeserializeJson(ref Utf8JsonReader reader, JsonSerializerOptions options)
Parameters
Type | Name | Description |
---|---|---|
Utf8Json |
reader | |
Json |
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 |
---|---|---|
Utf8Json |
reader | |
Json |
options | |
System. |
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 |
---|---|---|
Utf8Json |
writer | |
Json |
options | |
System. |
includeStartObject |