Skip to main content

HS.FHIR.vSTU3.Model.Resource.ExpansionProfile

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

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Resource to define constraints on the Expansion of a FHIR ValueSet.
If the element is present, it must have either a @value, an @id, or extensions

Property Inventory

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

Properties

property activeOnly as HS.FHIR.vSTU3.Model.Datatype.Boolean (XMLNAME = "activeOnly", XMLPROJECTION = "ELEMENT");
Controls whether inactive concepts are included or excluded in value set expansions.
Property methods: activeOnlyGet(), activeOnlyGetSwizzled(), activeOnlyIsValid(), activeOnlyNewObject(), activeOnlySet()
property contact as list of HS.FHIR.vSTU3.Model.Base.ContactDetail (XMLNAME = "contact", XMLPROJECTION = "ELEMENT");
Contact details to assist a user in finding and communicating with the publisher.
Property methods: contactBuildValueArray(), contactCollectionToDisplay(), contactCollectionToOdbc(), contactDisplayToCollection(), contactGet(), contactGetObject(), contactGetObjectId(), contactGetSwizzled(), contactIsValid(), contactOdbcToCollection(), contactSet(), contactSetObject(), contactSetObjectId()
property date as HS.FHIR.vSTU3.Model.Datatype.DateTime (XMLNAME = "date", XMLPROJECTION = "ELEMENT");
The date (and optionally time) when the expansion profile was published. The date must change if and 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 expansion profile changes.
Property methods: dateGet(), dateGetSwizzled(), dateIsValid(), dateNewObject(), dateSet()
property description as HS.FHIR.vSTU3.Model.Datatype.Markdown (XMLNAME = "description", XMLPROJECTION = "ELEMENT");
A free text natural language description of the expansion profile from a consumer's perspective.
Property methods: descriptionGet(), descriptionGetSwizzled(), descriptionIsValid(), descriptionNewObject(), descriptionSet()
property designation as HS.FHIR.vSTU3.Model.Resource.ExpansionProfile.Designation (XMLNAME = "designation", XMLPROJECTION = "ELEMENT");
A set of criteria that provide the constraints imposed on the value set expansion by including or excluding designations.
Property methods: designationGet(), designationGetSwizzled(), designationIsValid(), designationNewObject(), designationSet()
property displayLanguage as HS.FHIR.vSTU3.Model.Datatype.Code (XMLNAME = "displayLanguage", XMLPROJECTION = "ELEMENT");
Specifies the language to be used for description in the expansions i.e. the language to be used for ValueSet.expansion.contains.display.
Property methods: displayLanguageGet(), displayLanguageGetSwizzled(), displayLanguageIsValid(), displayLanguageNewObject(), displayLanguageSet()
property excludeNested as HS.FHIR.vSTU3.Model.Datatype.Boolean (XMLNAME = "excludeNested", XMLPROJECTION = "ELEMENT");
Controls whether or not the value set expansion nests codes or not (i.e. ValueSet.expansion.contains.contains).
Property methods: excludeNestedGet(), excludeNestedGetSwizzled(), excludeNestedIsValid(), excludeNestedNewObject(), excludeNestedSet()
property excludeNotForUI as HS.FHIR.vSTU3.Model.Datatype.Boolean (XMLNAME = "excludeNotForUI", XMLPROJECTION = "ELEMENT");
Controls whether or not the value set expansion includes codes which cannot be displayed in user interfaces.
Property methods: excludeNotForUIGet(), excludeNotForUIGetSwizzled(), excludeNotForUIIsValid(), excludeNotForUINewObject(), excludeNotForUISet()
property excludePostCoordinated as HS.FHIR.vSTU3.Model.Datatype.Boolean (XMLNAME = "excludePostCoordinated", XMLPROJECTION = "ELEMENT");
Controls whether or not the value set expansion includes post coordinated codes.
Property methods: excludePostCoordinatedGet(), excludePostCoordinatedGetSwizzled(), excludePostCoordinatedIsValid(), excludePostCoordinatedNewObject(), excludePostCoordinatedSet()
property excludedSystem as HS.FHIR.vSTU3.Model.Resource.ExpansionProfile.ExcludedSystem (XMLNAME = "excludedSystem", XMLPROJECTION = "ELEMENT");
Code system, or a particular version of a code system to be excluded from value set expansions.
Property methods: excludedSystemGet(), excludedSystemGetSwizzled(), excludedSystemIsValid(), excludedSystemNewObject(), excludedSystemSet()
property experimental as HS.FHIR.vSTU3.Model.Datatype.Boolean (XMLNAME = "experimental", XMLPROJECTION = "ELEMENT");
A boolean value to indicate that this expansion profile is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
Property methods: experimentalGet(), experimentalGetSwizzled(), experimentalIsValid(), experimentalNewObject(), experimentalSet()
property fixedVersion as list of HS.FHIR.vSTU3.Model.Resource.ExpansionProfile.FixedVersion (XMLNAME = "fixedVersion", XMLPROJECTION = "ELEMENT");
Fix use of a particular 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.vSTU3.Model.Base.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
A formal identifier that is used to identify this expansion profile 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 includeDefinition as HS.FHIR.vSTU3.Model.Datatype.Boolean (XMLNAME = "includeDefinition", XMLPROJECTION = "ELEMENT");
Controls whether the value set definition is included or excluded in value set expansions.
Property methods: includeDefinitionGet(), includeDefinitionGetSwizzled(), includeDefinitionIsValid(), includeDefinitionNewObject(), includeDefinitionSet()
property includeDesignations as HS.FHIR.vSTU3.Model.Datatype.Boolean (XMLNAME = "includeDesignations", XMLPROJECTION = "ELEMENT");
Controls whether concept designations are to be included or excluded in value set expansions.
Property methods: includeDesignationsGet(), includeDesignationsGetSwizzled(), includeDesignationsIsValid(), includeDesignationsNewObject(), includeDesignationsSet()
property jurisdiction as list of HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "jurisdiction", XMLPROJECTION = "ELEMENT");
A legal or geographic region in which the expansion profile is intended to be used.
Property methods: jurisdictionBuildValueArray(), jurisdictionCollectionToDisplay(), jurisdictionCollectionToOdbc(), jurisdictionDisplayToCollection(), jurisdictionGet(), jurisdictionGetObject(), jurisdictionGetObjectId(), jurisdictionGetSwizzled(), jurisdictionIsValid(), jurisdictionOdbcToCollection(), jurisdictionSet(), jurisdictionSetObject(), jurisdictionSetObjectId()
property limitedExpansion as HS.FHIR.vSTU3.Model.Datatype.Boolean (XMLNAME = "limitedExpansion", XMLPROJECTION = "ELEMENT");
If the value set being expanded is incomplete (because it is too big to expand), return a limited expansion (a subset) with an indicator that expansion is incomplete, using the extension [http://hl7.org/fhir/StructureDefinition/valueset-toocostly](extension-valueset-toocostly.html).
Property methods: limitedExpansionGet(), limitedExpansionGetSwizzled(), limitedExpansionIsValid(), limitedExpansionNewObject(), limitedExpansionSet()
property name as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "name", XMLPROJECTION = "ELEMENT");
A natural language name identifying the expansion profile. This name should be usable as an identifier for the module by machine processing applications such as code generation.
Property methods: nameGet(), nameGetSwizzled(), nameIsValid(), nameNewObject(), nameSet()
property publisher as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "publisher", XMLPROJECTION = "ELEMENT");
The name of the individual or organization that published the expansion profile.
Property methods: publisherGet(), publisherGetSwizzled(), publisherIsValid(), publisherNewObject(), publisherSet()
property status as HS.FHIR.vSTU3.Model.Base.PublicationStatus (XMLNAME = "status", XMLPROJECTION = "ELEMENT") [ Required ];
The status of this expansion profile. Enables tracking the life-cycle of the content.
Property methods: statusGet(), statusGetSwizzled(), statusIsValid(), statusNewObject(), statusSet()
property url as HS.FHIR.vSTU3.Model.Datatype.Uri (XMLNAME = "url", XMLPROJECTION = "ELEMENT");
An absolute URI that is used to identify this expansion profile when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this expansion profile is (or will be) published. The URL SHOULD include the major version of the expansion profile. For more information see [Technical and Business Versions](resource.html#versions).
Property methods: urlGet(), urlGetSwizzled(), urlIsValid(), urlNewObject(), urlSet()
property useContext as list of HS.FHIR.vSTU3.Model.Base.UsageContext (XMLNAME = "useContext", XMLPROJECTION = "ELEMENT");
The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate expansion profile instances.
Property methods: useContextBuildValueArray(), useContextCollectionToDisplay(), useContextCollectionToOdbc(), useContextDisplayToCollection(), useContextGet(), useContextGetObject(), useContextGetObjectId(), useContextGetSwizzled(), useContextIsValid(), useContextOdbcToCollection(), useContextSet(), useContextSetObject(), useContextSetObjectId()
property version as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "version", XMLPROJECTION = "ELEMENT");
The identifier that is used to identify this version of the expansion profile when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the expansion profile 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.
Property methods: versionGet(), versionGetSwizzled(), versionIsValid(), versionNewObject(), versionSet()

Methods

deprecated method SetActiveOnly(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "activeOnly" property.
deprecated method SetDate(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "date" property.
deprecated method SetDescription(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "description" property.
deprecated method SetDisplayLanguage(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "displayLanguage" property.
deprecated method SetExcludeNested(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "excludeNested" property.
deprecated method SetExcludeNotForUI(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "excludeNotForUI" property.
deprecated method SetExcludePostCoordinated(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "excludePostCoordinated" property.
deprecated method SetExperimental(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "experimental" property.
deprecated method SetIdentifier(pValue As %String = "", pSystem As %String = "", pUse As %String = "", pTypeCode As %String = "", pTypeSystem As %String = "", pTypeDisplay As %String = "", pTypeText As %String = "", pId As %String = "", pStart As %String = "", pEnd As %String = "", pAssignerReference As %String = "", pAssignerDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "identifier" property.
deprecated method SetIncludeDefinition(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "includeDefinition" property.
deprecated method SetIncludeDesignations(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "includeDesignations" property.
deprecated method SetJurisdiction(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "jurisdiction" property.
deprecated method SetLimitedExpansion(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "limitedExpansion" property.
deprecated method SetName(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "name" property.
deprecated method SetPublisher(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "publisher" property.
deprecated method SetStatus(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "status" property.
deprecated method SetUrl(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "url" property.
deprecated method SetVersion(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "version" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab