Skip to main content
AskMe (beta)
Loading icon
Responses may be inaccurate. Learn more about AskMe.

HS.FHIR.DTL.vSTU3.Model.Resource.CodeSystem

class HS.FHIR.DTL.vSTU3.Model.Resource.CodeSystem extends HS.FHIR.DTL.vSTU3.Model.Base.DomainResource

A code system resource specifies a set of codes drawn from one or more code systems.

Property Inventory

Parameters

parameter ELEMENTQUALIFIED = 1;
Inherited description: ELEMENTQUALIFIED controls the format of exported XML. The ELEMENTQUALIFIED specification should be based on the elementFormDefault attribute of the schema that defines the type. To maintain compatibility, ELEMENTQUALIFIED will default to 1 (true) for literal format export and will default to 0 (false) for encoded or encoded12 format export. These were the values always previously assumed for the elementFormDefault attribute.

NOTE: Direct use of XMLExport method does not support the ELEMENTQUALIFIED. The export must be done using %XML.Writer or SOAP support.

parameter XMLNAME = CodeSystem;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.
parameter XMLPROJECTION = ELEMENT;
parameter XMLSEQUENCE = 1;
Inherited description: If the XMLSEQUENCE = 1, then the order of the XML elements must match the order of the class properties. This allows us to deal with XML where the same field appears multiple times and is distinguished by the order.
parameter XMLTYPE = 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 %Boolean (XMLNAME = "caseSensitive", XMLPROJECTION = "ATTRIBUTE");
boolean

If code comparison is case sensitive.

Property methods: caseSensitiveDisplayToLogical(), caseSensitiveGet(), caseSensitiveIsValid(), caseSensitiveLogicalToDisplay(), caseSensitiveLogicalToXSD(), caseSensitiveNormalize(), caseSensitiveSet(), caseSensitiveXSDToLogical()
property compositional as %Boolean (XMLNAME = "compositional", XMLPROJECTION = "ATTRIBUTE");
boolean

If code system defines a post-composition grammar.

Property methods: compositionalDisplayToLogical(), compositionalGet(), compositionalIsValid(), compositionalLogicalToDisplay(), compositionalLogicalToXSD(), compositionalNormalize(), compositionalSet(), compositionalXSDToLogical()
property concept as list of HS.FHIR.DTL.vSTU3.Model.Element.CodeSystem.concept (XMLNAME = "concept", XMLPROJECTION = "ELEMENT");
BackboneElement

Concepts in the code system.

Property methods: conceptBuildValueArray(), conceptCollectionToDisplay(), conceptCollectionToOdbc(), conceptDisplayToCollection(), conceptGet(), conceptGetObject(), conceptGetObjectId(), conceptGetSwizzled(), conceptIsValid(), conceptOdbcToCollection(), conceptSet(), conceptSetObject(), conceptSetObjectId()
property contact as list of HS.FHIR.DTL.vSTU3.Model.Datatype.ContactDetail (XMLNAME = "contact", XMLPROJECTION = "ELEMENT");
ContactDetail

Contact details for the publisher.

Property methods: contactBuildValueArray(), contactCollectionToDisplay(), contactCollectionToOdbc(), contactDisplayToCollection(), contactGet(), contactGetObject(), contactGetObjectId(), contactGetSwizzled(), contactIsValid(), contactOdbcToCollection(), contactSet(), contactSetObject(), contactSetObjectId()
property content as %String (MAXLEN = 1000000, XMLNAME = "content", XMLPROJECTION = "ATTRIBUTE") [ Required ];
code

not-present | example | fragment | complete

codesystem-content-mode is the REQUIRED FHIR3 ValueSet for codes; you may NOT extend codesystem-content-mode and you may NOT use codes from other ValueSets.

Property methods: contentDisplayToLogical(), contentGet(), contentIsValid(), contentLogicalToDisplay(), contentLogicalToOdbc(), contentNormalize(), contentSet()
markdown

Use and/or publishing restrictions.

Property methods: copyrightDisplayToLogical(), copyrightGet(), copyrightIsValid(), copyrightLogicalToDisplay(), copyrightLogicalToOdbc(), copyrightNormalize(), copyrightSet()
property count as %Integer (XMLNAME = "count", XMLPROJECTION = "ATTRIBUTE");
unsignedInt

Total concepts in the code system.

Property methods: countDisplayToLogical(), countGet(), countIsValid(), countLogicalToDisplay(), countNormalize(), countSet(), countXSDToLogical()
property date as %String (MAXLEN = 1000000, XMLNAME = "date", XMLPROJECTION = "ATTRIBUTE");
dateTime

Date this was last changed.

Property methods: dateDisplayToLogical(), dateGet(), dateIsValid(), dateLogicalToDisplay(), dateLogicalToOdbc(), dateNormalize(), dateSet()
property description as %String (MAXLEN = 1000000, XMLNAME = "description", XMLPROJECTION = "ATTRIBUTE");
markdown

Natural language description of the code system.

Property methods: descriptionDisplayToLogical(), descriptionGet(), descriptionIsValid(), descriptionLogicalToDisplay(), descriptionLogicalToOdbc(), descriptionNormalize(), descriptionSet()
property experimental as %Boolean (XMLNAME = "experimental", XMLPROJECTION = "ATTRIBUTE");
boolean

For testing purposes, not real usage.

Property methods: experimentalDisplayToLogical(), experimentalGet(), experimentalIsValid(), experimentalLogicalToDisplay(), experimentalLogicalToXSD(), experimentalNormalize(), experimentalSet(), experimentalXSDToLogical()
property filter as list of HS.FHIR.DTL.vSTU3.Model.Element.CodeSystem.filter (XMLNAME = "filter", XMLPROJECTION = "ELEMENT");
BackboneElement

Filter that can be used in a value set.

Property methods: filterBuildValueArray(), filterCollectionToDisplay(), filterCollectionToOdbc(), filterDisplayToCollection(), filterGet(), filterGetObject(), filterGetObjectId(), filterGetSwizzled(), filterIsValid(), filterOdbcToCollection(), filterSet(), filterSetObject(), filterSetObjectId()
property hierarchyMeaning as %String (MAXLEN = 1000000, XMLNAME = "hierarchyMeaning", XMLPROJECTION = "ATTRIBUTE");
code

grouped-by | is-a | part-of | classified-with

codesystem-hierarchy-meaning is the REQUIRED FHIR3 ValueSet for codes; you may NOT extend codesystem-hierarchy-meaning and you may NOT use codes from other ValueSets.

Property methods: hierarchyMeaningDisplayToLogical(), hierarchyMeaningGet(), hierarchyMeaningIsValid(), hierarchyMeaningLogicalToDisplay(), hierarchyMeaningLogicalToOdbc(), hierarchyMeaningNormalize(), hierarchyMeaningSet()
property identifier as HS.FHIR.DTL.vSTU3.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
Identifier

Additional identifier for the code system.

Property methods: identifierGet(), identifierGetSwizzled(), identifierIsValid(), identifierNewObject(), identifierSet()
property jurisdiction as list of HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "jurisdiction", XMLPROJECTION = "ELEMENT");
CodeableConcept

Intended jurisdiction for code system (if applicable)

jurisdiction is the REQUIRED FHIR3 ValueSet for codes, but if you need to express meanings not found in jurisdiction, you may formally EXTEND jurisdiction to add codes to it.

Property methods: jurisdictionBuildValueArray(), jurisdictionCollectionToDisplay(), jurisdictionCollectionToOdbc(), jurisdictionDisplayToCollection(), jurisdictionGet(), jurisdictionGetObject(), jurisdictionGetObjectId(), jurisdictionGetSwizzled(), jurisdictionIsValid(), jurisdictionOdbcToCollection(), jurisdictionSet(), jurisdictionSetObject(), jurisdictionSetObjectId()
property name as %String (MAXLEN = 1000000, XMLNAME = "name", XMLPROJECTION = "ATTRIBUTE");
string

Name for this code system (computer friendly)

Property methods: nameDisplayToLogical(), nameGet(), nameIsValid(), nameLogicalToDisplay(), nameLogicalToOdbc(), nameNormalize(), nameSet()
property property as list of HS.FHIR.DTL.vSTU3.Model.Element.CodeSystem.property (XMLNAME = "property", XMLPROJECTION = "ELEMENT");
BackboneElement

Additional information supplied about each concept.

Property methods: propertyBuildValueArray(), propertyCollectionToDisplay(), propertyCollectionToOdbc(), propertyDisplayToCollection(), propertyGet(), propertyGetObject(), propertyGetObjectId(), propertyGetSwizzled(), propertyIsValid(), propertyOdbcToCollection(), propertySet(), propertySetObject(), propertySetObjectId()
property publisher as %String (MAXLEN = 1000000, XMLNAME = "publisher", XMLPROJECTION = "ATTRIBUTE");
string

Name of the publisher (organization or individual)

Property methods: publisherDisplayToLogical(), publisherGet(), publisherIsValid(), publisherLogicalToDisplay(), publisherLogicalToOdbc(), publisherNormalize(), publisherSet()
property purpose as %String (MAXLEN = 1000000, XMLNAME = "purpose", XMLPROJECTION = "ATTRIBUTE");
markdown

Why this code system is defined.

Property methods: purposeDisplayToLogical(), purposeGet(), purposeIsValid(), purposeLogicalToDisplay(), purposeLogicalToOdbc(), purposeNormalize(), purposeSet()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE") [ Required ];
code

draft | active | retired | unknown

publication-status is the REQUIRED FHIR3 ValueSet for codes; you may NOT extend publication-status and you may NOT use codes from other ValueSets.

Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property title as %String (MAXLEN = 1000000, XMLNAME = "title", XMLPROJECTION = "ATTRIBUTE");
string

Name for this code system (human friendly)

Property methods: titleDisplayToLogical(), titleGet(), titleIsValid(), titleLogicalToDisplay(), titleLogicalToOdbc(), titleNormalize(), titleSet()
property url as %String (MAXLEN = 1000000, XMLNAME = "url", XMLPROJECTION = "ATTRIBUTE");
uri

Logical URI to reference this code system (globally unique) (Coding.system)

Property methods: urlDisplayToLogical(), urlGet(), urlIsValid(), urlLogicalToDisplay(), urlLogicalToOdbc(), urlNormalize(), urlSet()
property useContext as list of HS.FHIR.DTL.vSTU3.Model.Datatype.UsageContext (XMLNAME = "useContext", XMLPROJECTION = "ELEMENT");
UsageContext

Context the content is intended to support.

Property methods: useContextBuildValueArray(), useContextCollectionToDisplay(), useContextCollectionToOdbc(), useContextDisplayToCollection(), useContextGet(), useContextGetObject(), useContextGetObjectId(), useContextGetSwizzled(), useContextIsValid(), useContextOdbcToCollection(), useContextSet(), useContextSetObject(), useContextSetObjectId()
property valueSet as %String (MAXLEN = 1000000, XMLNAME = "valueSet", XMLPROJECTION = "ATTRIBUTE");
uri

Canonical URL for value set with entire code system.

Property methods: valueSetDisplayToLogical(), valueSetGet(), valueSetIsValid(), valueSetLogicalToDisplay(), valueSetLogicalToOdbc(), valueSetNormalize(), valueSetSet()
property version as %String (MAXLEN = 1000000, XMLNAME = "version", XMLPROJECTION = "ATTRIBUTE");
string

Business version of the code system (Coding.version)

Property methods: versionDisplayToLogical(), versionGet(), versionIsValid(), versionLogicalToDisplay(), versionLogicalToOdbc(), versionNormalize(), versionSet()
property versionNeeded as %Boolean (XMLNAME = "versionNeeded", XMLPROJECTION = "ATTRIBUTE");
boolean

If definitions are not stable.

Property methods: versionNeededDisplayToLogical(), versionNeededGet(), versionNeededIsValid(), versionNeededLogicalToDisplay(), versionNeededLogicalToXSD(), versionNeededNormalize(), versionNeededSet(), versionNeededXSDToLogical()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab