Skip to main content


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

Declares the existence of and describes a code system or code system supplement.

Property Inventory


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 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.


property caseSensitive as %Boolean (XMLNAME = "caseSensitive", XMLPROJECTION = "ATTRIBUTE");

If code comparison is case sensitive.

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

If code system defines a compositional grammar.

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

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.vR4.Model.Datatype.ContactDetail (XMLNAME = "contact", XMLPROJECTION = "ELEMENT");

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 ];

not-present | example | fragment | complete | supplement

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

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

Use and/or publishing restrictions.

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

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");

Date last changed.

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

Natural language description of the code system.

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

For testing purposes, not real usage.

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

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");

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

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

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

Additional identifier for the code system (business identifier)

Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property jurisdiction as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "jurisdiction", XMLPROJECTION = "ELEMENT");

Intended jurisdiction for code system (if applicable)

jurisdiction is the REQUIRED FHIR4 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");

Name for this code system (computer friendly)

Property methods: nameDisplayToLogical(), nameGet(), nameIsValid(), nameLogicalToDisplay(), nameLogicalToOdbc(), nameNormalize(), nameSet()
property property as list of (XMLNAME = "property", XMLPROJECTION = "ELEMENT");

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");

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");

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 ];

draft | active | retired | unknown

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

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

Canonical URL of Code System this adds designations and properties to.

TO DO: Unrecognized value type for the FHIR4 model

Property methods: supplementsDisplayToLogical(), supplementsGet(), supplementsIsValid(), supplementsLogicalToDisplay(), supplementsLogicalToOdbc(), supplementsNormalize(), supplementsSet()
property title as %String (MAXLEN = 1000000, XMLNAME = "title", XMLPROJECTION = "ATTRIBUTE");

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");

Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system)

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

The context that 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");

Canonical reference to the value set with entire code system.

TO DO: Unrecognized value type for the FHIR4 model

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

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");

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