Skip to main content


persistent class HS.FHIRMeta.Storage.Package extends %Library.Persistent, %JSON.Adaptor

SQL Table Name: HS_FHIRMeta_Storage.Package

This class describes an npm-like package of FHIR Metadata. The form of the Package is described hereOpens in a new tab

Property Inventory

Method Inventory


property canonical as %String (COLLATION = "EXACT", MAXLEN = 256);
URL where the human readable representation (e.g. IG) that represents this version of this package is published on the web (if applicable).
Property methods: canonicalDisplayToLogical(), canonicalGet(), canonicalGetStored(), canonicalIsValid(), canonicalLogicalToDisplay(), canonicalLogicalToOdbc(), canonicalNormalize(), canonicalSet()
property coreVersion as %String (%JSONFIELDNAME = "core_version", COLLATION = "EXACT", MAXLEN = 64);
FHIR core version. Examples: 3.0.2, 4.0.1, etc.
Property methods: coreVersionDisplayToLogical(), coreVersionGet(), coreVersionGetStored(), coreVersionIsValid(), coreVersionLogicalToDisplay(), coreVersionLogicalToOdbc(), coreVersionNormalize(), coreVersionSet()
property dependencies as list of %String (COLLATION = "EXACT", MAXLEN = 128);
List of strings, each of which is a concatenation of the package name@version of a dependency.
Property methods: dependenciesBuildValueArray(), dependenciesCollectionToDisplay(), dependenciesCollectionToOdbc(), dependenciesDisplayToCollection(), dependenciesDisplayToLogical(), dependenciesGet(), dependenciesGetObject(), dependenciesGetObjectId(), dependenciesGetStored(), dependenciesGetSwizzled(), dependenciesIsValid(), dependenciesLogicalToDisplay(), dependenciesLogicalToOdbc(), dependenciesNormalize(), dependenciesOdbcToCollection(), dependenciesSet(), dependenciesSetObject(), dependenciesSetObjectId()
property description as %String (COLLATION = "EXACT");
Potentially very detailed description of the package.
Property methods: descriptionDisplayToLogical(), descriptionGet(), descriptionGetStored(), descriptionIsValid(), descriptionLogicalToDisplay(), descriptionLogicalToOdbc(), descriptionNormalize(), descriptionSet()
property id as %String (COLLATION = "EXACT", MAXLEN = 128) [ Required ];
id is a concatenation of package name@version, formulated for use as internal unique id.
Property methods: idDisplayToLogical(), idGet(), idGetStored(), idIsValid(), idLogicalToDisplay(), idLogicalToOdbc(), idNormalize(), idSet()
property loadedFrom as %String (%JSONFIELDNAME = "loaded_from", COLLATION = "EXACT");
Name of original file source for the package content as loaded into IRIS.
Property methods: loadedFromDisplayToLogical(), loadedFromGet(), loadedFromGetStored(), loadedFromIsValid(), loadedFromLogicalToDisplay(), loadedFromLogicalToOdbc(), loadedFromNormalize(), loadedFromSet()
property name as %String (COLLATION = "EXACT", MAXLEN = 64) [ Required ];
name maps to the packageId property of the FHIR ImplementationGuide resource type. packageId in ImplementationGuide is typed as the FHIR id data type, which has a length limit of 64.
Property methods: nameDisplayToLogical(), nameGet(), nameGetStored(), nameIsValid(), nameLogicalToDisplay(), nameLogicalToOdbc(), nameNormalize(), nameSet()
property title as %String (COLLATION = "EXACT", MAXLEN = 256);
Short description of the package.
Property methods: titleDisplayToLogical(), titleGet(), titleGetStored(), titleIsValid(), titleLogicalToDisplay(), titleLogicalToOdbc(), titleNormalize(), titleSet()
property type as %String (COLLATION = "EXACT", MAXLEN = 64);
Package type. Examples: "fhir.core", "fhir.ig", "fhir.tool", etc.
Property methods: typeDisplayToLogical(), typeGet(), typeGetStored(), typeIsValid(), typeLogicalToDisplay(), typeLogicalToOdbc(), typeNormalize(), typeSet()
property version as %String (COLLATION = "EXACT", MAXLEN = 64) [ Required ];
Package version. Should use semantic versioning.
Property methods: versionDisplayToLogical(), versionGet(), versionGetStored(), versionIsValid(), versionLogicalToDisplay(), versionLogicalToOdbc(), versionNormalize(), versionSet()


classmethod FindById(id As %String) as Package
classmethod GetAllPackages() as %ListOfObjects
classmethod GetAllPackagesJSON() as %DynamicArray
classmethod GetById(id As %String) as Package
classmethod GetCorePackages() as %ListOfObjects
classmethod GetCorePackagesJSON() as %DynamicArray
classmethod GetCustomPackages(packageOrId) as %ListOfObjects
classmethod GetCustomPackagesJSON(packageOrId) as %DynamicArray
classmethod ResolvePackageList(idList As %List) as %List
classmethod dump()


index (KeyIndex on id) [IdKey, Type = key, Unique];
Index methods: KeyIndexCheck(), KeyIndexDelete(), KeyIndexExists(), KeyIndexOpen(), KeyIndexSQLCheckUnique(), KeyIndexSQLExists(), KeyIndexSQLFindPKeyByConstraint(), KeyIndexSQLFindRowIDByConstraint()

Inherited Members

Inherited Methods


Storage Model: Storage (HS.FHIRMeta.Storage.Package)

FeedbackOpens in a new tab