Skip to main content

HS.FHIRMeta.Impl.Base

class HS.FHIRMeta.Impl.Base extends HS.FHIRMeta.API

Property Inventory

Method Inventory

Parameters

parameter DefaultGlobalRoot = ^HS.FHIRServer.Meta;

Properties

deprecated property FHIRMetadataSetKey as %String [ Calculated ];
The MetadataSet Key for this metadata collection. DEPRECATED in favor of PackageList.
Property methods: FHIRMetadataSetKeyDisplayToLogical(), FHIRMetadataSetKeyIsValid(), FHIRMetadataSetKeyLogicalToDisplay(), FHIRMetadataSetKeyLogicalToOdbc(), FHIRMetadataSetKeyNormalize()
property FHIRVersion as %String [ Calculated ];
The FHIR Version supported by this metadata collection
Property methods: FHIRVersionDisplayToLogical(), FHIRVersionIsValid(), FHIRVersionLogicalToDisplay(), FHIRVersionLogicalToOdbc(), FHIRVersionNormalize()
property GlobalRoot as %String;
Property methods: GlobalRootDisplayToLogical(), GlobalRootGet(), GlobalRootIsValid(), GlobalRootLogicalToDisplay(), GlobalRootLogicalToOdbc(), GlobalRootNormalize(), GlobalRootSet()
property PackageList as %List [ Calculated ];
The external representation of the MetadataSet Key for this metadata collection (e.g., $lb("hl7.fhir.r4.core@4.0.1","hl7.fhir.us.core@3.1.0"))
Property methods: PackageListIsValid(), PackageListLogicalToOdbc(), PackageListOdbcToLogical()
property PackageListInternal as %String (MAXLEN = 128) [ Calculated ];
The internal representation of the MetadataSet Key for this metadata collection (e.g., "+D0FBGNvQVbMXtLe0BzBW4rE1Yk=")
Property methods: PackageListInternalDisplayToLogical(), PackageListInternalIsValid(), PackageListInternalLogicalToDisplay(), PackageListInternalLogicalToOdbc(), PackageListInternalNormalize()

Methods

classmethod ExternalPkgListToInternalId(pPackageList As %List) as %String
Return an internal string representation of the package list. Duplicate of method of the same name from HS.FHIRMeta.Utils.
method FHIRMetadataSetKeyGet() as %String
Deprecated: renamed to PackageList.
Getter for %List of FHIR Packages in this metadata collection
method FHIRVersionGet() as %String
Getter for the FHIRVersion property
method GetPropertyFHIRType(fhirType As %String, propName As %String) as %String
Inherited description: API
Returns the FHIR type of the specified property
method GetPropertyJSONType(fhirType As %String, propName As %String) as %String
Inherited description: API
Returns an indicator of how to represent this property in Json.
  • "o" -> A child object
  • "s" -> A string
  • "n" -> A numeric value
  • "b" -> A boolean value
  • "c" -> A Variant root field name
  • "x" -> XHTML formatted string
  • "alias" -> An embedded resource

For variant fields, the base property name is labeled as "c", and the supported specific typed properties are accessed using their type-inclusive names (names that actually appear in a resource). For example in the Patient resource, 'multipleBirth' will return "c", while 'multipleBirthInteger' will return "n", and multipleBirthBoolean will return "b".
method GetPropertyNames(fhirType As %String) as %List
Inherited description: API
Returns a %List of property names for the specified FHIR type.
method GetPropertyOrdinal(fhirType As %String, propName As %String) as %Integer
Inherited description: API
Returns an integer value that reflects the order of the property in the XML form of the resource. Note that the ordinals within a FHIR type may not be sequential. For variant properties, all variations will have the same ordinal. For example in Patient, both multipleBirthBoolean and multipleBirthInteger have the same ordinal value (as does multipleBirth).
method GetPropertyValueList(fhirType As %String, propName As %String) as %List
Inherited description: API
Return a %List of allowed values for the value set associated with the specified property. NOTE: This will return an empty list unless the strength is "required".
method GetPropertyValueSetStrength(fhirType As %String, propName As %String) as %String
Inherited description: API
Returns the strength of the binding of the specified property to the value set ("required", "extensible", "preferred", or "example")
method GetPropertyValueSetURL(fhirType As %String, propName As %String) as %String
Inherited description: API
Returns the URL of the value set associated with the specified property. Properties with FHIR type of code, Coding, and CodeableConcept have associated value sets.
method GetRequiredProperties(fhirType As %String) as %List
Inherited description: API
Returns a %List of the properties that are required by the FHIR schema for the specified resource type.
method GetSuperType(fhirType As %String) as %String
Inherited description:
Returns the FHIR type of the superclass for the specified FHIR type.
method GetVariantTypes(fhirType As %String, propName As %String) as %List
Inherited description: API
Returns a list of the allowable FHIR types for a variant property. For example, GetVariantTypes("Patient", "multipleBirth") will return $LB("boolean", "integer")
method HasPropertyName(fhirType As %String, propName As %String) as %String
Inherited description: API
Returns true if the specified fhirType has a property with the specified name
method InternalIdToExternalPkgList(pInternalId As %String) as %List
method IsFHIRType(fhirType As %String) as %Boolean
Inherited description: API
Returns true (1) if the specified type is a valid FHIR type, otherwise false (0)
classmethod IsLoaded(packageList As %String) as %Boolean
method IsPropertyArray(fhirType As %String, propName As %String) as %Boolean
API
Returns true if the specified property is represented as an Array in JSON.
method IsPropertyRequired(fhirType As %String, propName As %String) as %Boolean
Inherited description: API
Returns true if the specified property is required by the FHIR schema
method Load()
method PackageListGet() as %String
Getter for %List of FHIR Packages in this metadata collection
method PackageListInternalGet() as %String
Getter for %List of FHIR Packages in this metadata collection
method Unload() as %Boolean
classmethod bootstrap(force As %Boolean = 0)

Inherited Members

Inherited Properties

Inherited Methods

Subclasses

FeedbackOpens in a new tab