Skip to main content

HS.FHIRModel.R4.CodeSystem

class HS.FHIRModel.R4.CodeSystem extends HS.FHIRModel.FHIRClassSuper

*****************************************
** CodeSystem generated class schema
*****************************************
The CodeSystem resource is used to declare the existence of and describe a code system or code system supplement and its key properties, and optionally define a part or all of its content.

Property Inventory

Method Inventory

Parameters

parameter XMLTYPE = R4_CODESYSTEM;
Inherited description: This parameter provides the default XMLTYPE for the class. If it is empty then the class name will be used to construct a default XML type.

The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.

Properties

property _caseSensitive as HS.FHIRModel.R4.Element;
Extensions for caseSensitive
Property methods: _caseSensitiveGet(), _caseSensitiveGetSwizzled(), _caseSensitiveIsValid(), _caseSensitiveNewObject(), _caseSensitiveSet()
property _compositional as HS.FHIRModel.R4.Element;
Extensions for compositional
Property methods: _compositionalGet(), _compositionalGetSwizzled(), _compositionalIsValid(), _compositionalNewObject(), _compositionalSet()
property _content as HS.FHIRModel.R4.Element;
Extensions for content
Property methods: _contentGet(), _contentGetSwizzled(), _contentIsValid(), _contentNewObject(), _contentSet()
property _copyright as HS.FHIRModel.R4.Element;
Extensions for copyright
Property methods: _copyrightGet(), _copyrightGetSwizzled(), _copyrightIsValid(), _copyrightNewObject(), _copyrightSet()
property _count as HS.FHIRModel.R4.Element;
Extensions for count
Property methods: _countGet(), _countGetSwizzled(), _countIsValid(), _countNewObject(), _countSet()
property _date as HS.FHIRModel.R4.Element;
Extensions for date
Property methods: _dateGet(), _dateGetSwizzled(), _dateIsValid(), _dateNewObject(), _dateSet()
property _description as HS.FHIRModel.R4.Element;
Extensions for description
Property methods: _descriptionGet(), _descriptionGetSwizzled(), _descriptionIsValid(), _descriptionNewObject(), _descriptionSet()
property _experimental as HS.FHIRModel.R4.Element;
Extensions for experimental
Property methods: _experimentalGet(), _experimentalGetSwizzled(), _experimentalIsValid(), _experimentalNewObject(), _experimentalSet()
property _hierarchyMeaning as HS.FHIRModel.R4.Element;
Extensions for hierarchyMeaning
Property methods: _hierarchyMeaningGet(), _hierarchyMeaningGetSwizzled(), _hierarchyMeaningIsValid(), _hierarchyMeaningNewObject(), _hierarchyMeaningSet()
property _implicitRules as HS.FHIRModel.R4.Element;
Extensions for implicitRules
Property methods: _implicitRulesGet(), _implicitRulesGetSwizzled(), _implicitRulesIsValid(), _implicitRulesNewObject(), _implicitRulesSet()
property _language as HS.FHIRModel.R4.Element;
Extensions for language
Property methods: _languageGet(), _languageGetSwizzled(), _languageIsValid(), _languageNewObject(), _languageSet()
property _name as HS.FHIRModel.R4.Element;
Extensions for name
Property methods: _nameGet(), _nameGetSwizzled(), _nameIsValid(), _nameNewObject(), _nameSet()
property _publisher as HS.FHIRModel.R4.Element;
Extensions for publisher
Property methods: _publisherGet(), _publisherGetSwizzled(), _publisherIsValid(), _publisherNewObject(), _publisherSet()
property _purpose as HS.FHIRModel.R4.Element;
Extensions for purpose
Property methods: _purposeGet(), _purposeGetSwizzled(), _purposeIsValid(), _purposeNewObject(), _purposeSet()
property _status as HS.FHIRModel.R4.Element;
Extensions for status
Property methods: _statusGet(), _statusGetSwizzled(), _statusIsValid(), _statusNewObject(), _statusSet()
property _title as HS.FHIRModel.R4.Element;
Extensions for title
Property methods: _titleGet(), _titleGetSwizzled(), _titleIsValid(), _titleNewObject(), _titleSet()
property _url as HS.FHIRModel.R4.Element;
Extensions for url
Property methods: _urlGet(), _urlGetSwizzled(), _urlIsValid(), _urlNewObject(), _urlSet()
property _version as HS.FHIRModel.R4.Element;
Extensions for version
Property methods: _versionGet(), _versionGetSwizzled(), _versionIsValid(), _versionNewObject(), _versionSet()
property _versionNeeded as HS.FHIRModel.R4.Element;
Extensions for versionNeeded
Property methods: _versionNeededGet(), _versionNeededGetSwizzled(), _versionNeededIsValid(), _versionNeededNewObject(), _versionNeededSet()
property caseSensitive as %Boolean;
If code comparison is case sensitive when codes within this system are compared to each other.
Property methods: caseSensitiveDisplayToLogical(), caseSensitiveGet(), caseSensitiveIsValid(), caseSensitiveLogicalToDisplay(), caseSensitiveLogicalToXSD(), caseSensitiveNormalize(), caseSensitiveSet(), caseSensitiveXSDToLogical()
property compositional as %Boolean;
The code system defines a compositional (post-coordination) grammar.
Property methods: compositionalDisplayToLogical(), compositionalGet(), compositionalIsValid(), compositionalLogicalToDisplay(), compositionalLogicalToXSD(), compositionalNormalize(), compositionalSet(), compositionalXSDToLogical()
Concepts that are in the code system. The concept definitions are inherently hierarchical, but the definitions must be consulted to determine what the meanings of the hierarchical relationships are.
Property methods: conceptGet(), conceptGetSwizzled(), conceptIsValid(), conceptNewObject(), conceptSet()
property contact as HS.FHIRModel.R4.SeqOfContactDetail;
Contact details to assist a user in finding and communicating with the publisher.
Property methods: contactGet(), contactGetSwizzled(), contactIsValid(), contactNewObject(), contactSet()
property contained as HS.FHIRModel.R4.SeqOfResourceList;
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Property methods: containedGet(), containedGetSwizzled(), containedIsValid(), containedNewObject(), containedSet()
property content as %String (VALUELIST = ",not-present,example,fragment,complete,supplement");
The extent of the content of the code system (the concepts and codes it defines) are represented in this resource instance.
Property methods: contentDisplayToLogical(), contentGet(), contentIsValid(), contentLogicalToDisplay(), contentLogicalToOdbc(), contentNormalize(), contentSet()
A copyright statement relating to the code system and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the code system.
Property methods: copyrightDisplayToLogical(), copyrightGet(), copyrightIsValid(), copyrightLogicalToDisplay(), copyrightLogicalToOdbc(), copyrightNormalize(), copyrightSet()
property count as %Integer;
The total number of concepts defined by the code system. Where the code system has a compositional grammar, the basis of this count is defined by the system steward.
Property methods: countDisplayToLogical(), countGet(), countIsValid(), countLogicalToDisplay(), countNormalize(), countSet(), countXSDToLogical()
property date as %String;
The date (and optionally time) when the code system was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the code system changes.
Property methods: dateDisplayToLogical(), dateGet(), dateIsValid(), dateLogicalToDisplay(), dateLogicalToOdbc(), dateNormalize(), dateSet()
property description as %String;
A free text natural language description of the code system from a consumer's perspective.
Property methods: descriptionDisplayToLogical(), descriptionGet(), descriptionIsValid(), descriptionLogicalToDisplay(), descriptionLogicalToOdbc(), descriptionNormalize(), descriptionSet()
property experimental as %Boolean;
A Boolean value to indicate that this code system is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
Property methods: experimentalDisplayToLogical(), experimentalGet(), experimentalIsValid(), experimentalLogicalToDisplay(), experimentalLogicalToXSD(), experimentalNormalize(), experimentalSet(), experimentalXSDToLogical()
property extension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Property methods: extensionGet(), extensionGetSwizzled(), extensionIsValid(), extensionNewObject(), extensionSet()
property fhirID as %String;
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Property methods: fhirIDDisplayToLogical(), fhirIDGet(), fhirIDIsValid(), fhirIDLogicalToDisplay(), fhirIDLogicalToOdbc(), fhirIDNormalize(), fhirIDSet()
A filter that can be used in a value set compose statement when selecting concepts using a filter.
Property methods: filterGet(), filterGetSwizzled(), filterIsValid(), filterNewObject(), filterSet()
property hierarchyMeaning as %String (VALUELIST = ",grouped-by,is-a,part-of,classified-with");
The meaning of the hierarchy of concepts as represented in this resource.
Property methods: hierarchyMeaningDisplayToLogical(), hierarchyMeaningGet(), hierarchyMeaningIsValid(), hierarchyMeaningLogicalToDisplay(), hierarchyMeaningLogicalToOdbc(), hierarchyMeaningNormalize(), hierarchyMeaningSet()
property identifier as HS.FHIRModel.R4.SeqOfIdentifier;
A formal identifier that is used to identify this code system when it is represented in other formats, or referenced in a specification, model, design or an instance.
Property methods: identifierGet(), identifierGetSwizzled(), identifierIsValid(), identifierNewObject(), identifierSet()
property implicitRules as %String;
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Property methods: implicitRulesDisplayToLogical(), implicitRulesGet(), implicitRulesIsValid(), implicitRulesLogicalToDisplay(), implicitRulesLogicalToOdbc(), implicitRulesNormalize(), implicitRulesSet()
property jurisdiction as HS.FHIRModel.R4.SeqOfCodeableConcept;
A legal or geographic region in which the code system is intended to be used.
Property methods: jurisdictionGet(), jurisdictionGetSwizzled(), jurisdictionIsValid(), jurisdictionNewObject(), jurisdictionSet()
property language as %String;
The base language in which the resource is written.
Property methods: languageDisplayToLogical(), languageGet(), languageIsValid(), languageLogicalToDisplay(), languageLogicalToOdbc(), languageNormalize(), languageSet()
property meta as HS.FHIRModel.R4.Meta;
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Property methods: metaGet(), metaGetSwizzled(), metaIsValid(), metaNewObject(), metaSet()
property modifierExtension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Property methods: modifierExtensionGet(), modifierExtensionGetSwizzled(), modifierExtensionIsValid(), modifierExtensionNewObject(), modifierExtensionSet()
property name as %String;
A natural language name identifying the code system. This name should be usable as an identifier for the module by machine processing applications such as code generation.
Property methods: nameDisplayToLogical(), nameGet(), nameIsValid(), nameLogicalToDisplay(), nameLogicalToOdbc(), nameNormalize(), nameSet()
A property defines an additional slot through which additional information can be provided about a concept.
Property methods: propertyGet(), propertyGetSwizzled(), propertyIsValid(), propertyNewObject(), propertySet()
property publisher as %String;
The name of the organization or individual that published the code system.
Property methods: publisherDisplayToLogical(), publisherGet(), publisherIsValid(), publisherLogicalToDisplay(), publisherLogicalToOdbc(), publisherNormalize(), publisherSet()
property purpose as %String;
Explanation of why this code system is needed and why it has been designed as it has.
Property methods: purposeDisplayToLogical(), purposeGet(), purposeIsValid(), purposeLogicalToDisplay(), purposeLogicalToOdbc(), purposeNormalize(), purposeSet()
property resourceType as %String [ InitialExpression = "CodeSystem" , Required ];
This is a CodeSystem resource
Property methods: resourceTypeDisplayToLogical(), resourceTypeGet(), resourceTypeIsValid(), resourceTypeLogicalToDisplay(), resourceTypeLogicalToOdbc(), resourceTypeNormalize(), resourceTypeSet()
property status as %String (VALUELIST = ",draft,active,retired,unknown");
The date (and optionally time) when the code system resource was created or revised.
Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property supplements as %String;
The canonical URL of the code system that this code system supplement is adding designations and properties to.
Property methods: supplementsDisplayToLogical(), supplementsGet(), supplementsIsValid(), supplementsLogicalToDisplay(), supplementsLogicalToOdbc(), supplementsNormalize(), supplementsSet()
property text as HS.FHIRModel.R4.Narrative;
A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Property methods: textGet(), textGetSwizzled(), textIsValid(), textNewObject(), textSet()
property title as %String;
A short, descriptive, user-friendly title for the code system.
Property methods: titleDisplayToLogical(), titleGet(), titleIsValid(), titleLogicalToDisplay(), titleLogicalToOdbc(), titleNormalize(), titleSet()
property url as %String;
An absolute URI that is used to identify this code system when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this code system is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the code system is stored on different servers. This is used in [Coding](datatypes.html#Coding).system.
Property methods: urlDisplayToLogical(), urlGet(), urlIsValid(), urlLogicalToDisplay(), urlLogicalToOdbc(), urlNormalize(), urlSet()
property useContext as HS.FHIRModel.R4.SeqOfUsageContext;
The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate code system instances.
Property methods: useContextGet(), useContextGetSwizzled(), useContextIsValid(), useContextNewObject(), useContextSet()
property valueSet as %String;
Canonical reference to the value set that contains the entire code system.
Property methods: valueSetDisplayToLogical(), valueSetGet(), valueSetIsValid(), valueSetLogicalToDisplay(), valueSetLogicalToOdbc(), valueSetNormalize(), valueSetSet()
property version as %String;
The identifier that is used to identify this version of the code system when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the code system author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. This is used in [Coding](datatypes.html#Coding).version.
Property methods: versionDisplayToLogical(), versionGet(), versionIsValid(), versionLogicalToDisplay(), versionLogicalToOdbc(), versionNormalize(), versionSet()
property versionNeeded as %Boolean;
This flag is used to signify that the code system does not commit to concept permanence across versions. If true, a version must be specified when referencing this code system.
Property methods: versionNeededDisplayToLogical(), versionNeededGet(), versionNeededIsValid(), versionNeededLogicalToDisplay(), versionNeededLogicalToXSD(), versionNeededNormalize(), versionNeededSet(), versionNeededXSDToLogical()

Methods

method IncludeConcept()
method IncludeContact()
method IncludeContained()
method IncludeExtension()
method IncludeFilter()
method IncludeIdentifier()
method IncludeJurisdiction()
method IncludeMeta()
method IncludeModifierExtension()
method IncludeProperty()
method IncludeText()
method IncludeUseContext()
method _getProperties() as %DynamicArray
Inherited description: Return an array of the defined properties of this class in the definition order that they were discovered in the the HL7FHIR JSchema document
method toDao() as %DynamicAbstractObject
Inherited description: >

The toDao() method casts the set to a DAO.

Inherited Members

Inherited Methods

FeedbackOpens in a new tab