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

HS.FHIR.DTL.vSTU3.Model.Resource.ExpansionProfile

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

Resource to define constraints on the Expansion of a FHIR ValueSet.

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 = ExpansionProfile;
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 = ExpansionProfile;
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 activeOnly as %Boolean (XMLNAME = "activeOnly", XMLPROJECTION = "ATTRIBUTE");
boolean

Include or exclude inactive concepts in the expansion.

Property methods: activeOnlyDisplayToLogical(), activeOnlyGet(), activeOnlyIsValid(), activeOnlyLogicalToDisplay(), activeOnlyLogicalToXSD(), activeOnlyNormalize(), activeOnlySet(), activeOnlyXSDToLogical()
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 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 expansion profile.

Property methods: descriptionDisplayToLogical(), descriptionGet(), descriptionIsValid(), descriptionLogicalToDisplay(), descriptionLogicalToOdbc(), descriptionNormalize(), descriptionSet()
property designation as HS.FHIR.DTL.vSTU3.Model.Element.ExpansionProfile.designation (XMLNAME = "designation", XMLPROJECTION = "ELEMENT");
BackboneElement

When the expansion profile imposes designation contraints.

Property methods: designationGet(), designationGetSwizzled(), designationIsValid(), designationNewObject(), designationSet()
property displayLanguage as %String (MAXLEN = 1000000, XMLNAME = "displayLanguage", XMLPROJECTION = "ATTRIBUTE");
code

Specify the language for the display element of codes in the value set expansion.

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

Property methods: displayLanguageDisplayToLogical(), displayLanguageGet(), displayLanguageIsValid(), displayLanguageLogicalToDisplay(), displayLanguageLogicalToOdbc(), displayLanguageNormalize(), displayLanguageSet()
property excludeNested as %Boolean (XMLNAME = "excludeNested", XMLPROJECTION = "ATTRIBUTE");
boolean

Nested codes in the expansion or not.

Property methods: excludeNestedDisplayToLogical(), excludeNestedGet(), excludeNestedIsValid(), excludeNestedLogicalToDisplay(), excludeNestedLogicalToXSD(), excludeNestedNormalize(), excludeNestedSet(), excludeNestedXSDToLogical()
property excludeNotForUI as %Boolean (XMLNAME = "excludeNotForUI", XMLPROJECTION = "ATTRIBUTE");
boolean

Include or exclude codes which cannot be rendered in user interfaces in the value set expansion.

Property methods: excludeNotForUIDisplayToLogical(), excludeNotForUIGet(), excludeNotForUIIsValid(), excludeNotForUILogicalToDisplay(), excludeNotForUILogicalToXSD(), excludeNotForUINormalize(), excludeNotForUISet(), excludeNotForUIXSDToLogical()
property excludePostCoordinated as %Boolean (XMLNAME = "excludePostCoordinated", XMLPROJECTION = "ATTRIBUTE");
boolean

Include or exclude codes which are post coordinated expressions in the value set expansion.

Property methods: excludePostCoordinatedDisplayToLogical(), excludePostCoordinatedGet(), excludePostCoordinatedIsValid(), excludePostCoordinatedLogicalToDisplay(), excludePostCoordinatedLogicalToXSD(), excludePostCoordinatedNormalize(), excludePostCoordinatedSet(), excludePostCoordinatedXSDToLogical()
property excludedSystem as HS.FHIR.DTL.vSTU3.Model.Element.ExpansionProfile.excludedSystem (XMLNAME = "excludedSystem", XMLPROJECTION = "ELEMENT");
BackboneElement

Systems/Versions to be exclude.

Property methods: excludedSystemGet(), excludedSystemGetSwizzled(), excludedSystemIsValid(), excludedSystemNewObject(), excludedSystemSet()
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 fixedVersion as list of HS.FHIR.DTL.vSTU3.Model.Element.ExpansionProfile.fixedVersion (XMLNAME = "fixedVersion", XMLPROJECTION = "ELEMENT");
BackboneElement

Fix use of a code system to a particular version.

Property methods: fixedVersionBuildValueArray(), fixedVersionCollectionToDisplay(), fixedVersionCollectionToOdbc(), fixedVersionDisplayToCollection(), fixedVersionGet(), fixedVersionGetObject(), fixedVersionGetObjectId(), fixedVersionGetSwizzled(), fixedVersionIsValid(), fixedVersionOdbcToCollection(), fixedVersionSet(), fixedVersionSetObject(), fixedVersionSetObjectId()
property identifier as HS.FHIR.DTL.vSTU3.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
Identifier

Additional identifier for the expansion profile.

Property methods: identifierGet(), identifierGetSwizzled(), identifierIsValid(), identifierNewObject(), identifierSet()
property includeDefinition as %Boolean (XMLNAME = "includeDefinition", XMLPROJECTION = "ATTRIBUTE");
boolean

Include or exclude the value set definition in the expansion.

Property methods: includeDefinitionDisplayToLogical(), includeDefinitionGet(), includeDefinitionIsValid(), includeDefinitionLogicalToDisplay(), includeDefinitionLogicalToXSD(), includeDefinitionNormalize(), includeDefinitionSet(), includeDefinitionXSDToLogical()
property includeDesignations as %Boolean (XMLNAME = "includeDesignations", XMLPROJECTION = "ATTRIBUTE");
boolean

Whether the expansion should include concept designations.

Property methods: includeDesignationsDisplayToLogical(), includeDesignationsGet(), includeDesignationsIsValid(), includeDesignationsLogicalToDisplay(), includeDesignationsLogicalToXSD(), includeDesignationsNormalize(), includeDesignationsSet(), includeDesignationsXSDToLogical()
property jurisdiction as list of HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "jurisdiction", XMLPROJECTION = "ELEMENT");
CodeableConcept

Intended jurisdiction for expansion profile (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 limitedExpansion as %Boolean (XMLNAME = "limitedExpansion", XMLPROJECTION = "ATTRIBUTE");
boolean

Controls behaviour of the value set expand operation when value sets are too large to be completely expanded.

Property methods: limitedExpansionDisplayToLogical(), limitedExpansionGet(), limitedExpansionIsValid(), limitedExpansionLogicalToDisplay(), limitedExpansionLogicalToXSD(), limitedExpansionNormalize(), limitedExpansionSet(), limitedExpansionXSDToLogical()
property name as %String (MAXLEN = 1000000, XMLNAME = "name", XMLPROJECTION = "ATTRIBUTE");
string

Name for this expansion profile (computer friendly)

Property methods: nameDisplayToLogical(), nameGet(), nameIsValid(), nameLogicalToDisplay(), nameLogicalToOdbc(), nameNormalize(), nameSet()
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 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 url as %String (MAXLEN = 1000000, XMLNAME = "url", XMLPROJECTION = "ATTRIBUTE");
uri

Logical URI to reference this expansion profile (globally unique)

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 version as %String (MAXLEN = 1000000, XMLNAME = "version", XMLPROJECTION = "ATTRIBUTE");
string

Business version of the expansion profile.

Property methods: versionDisplayToLogical(), versionGet(), versionIsValid(), versionLogicalToDisplay(), versionLogicalToOdbc(), versionNormalize(), versionSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab