Skip to main content

HS.FHIR.vSTU3.Model.Resource.Library

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

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
The Library resource is a general-purpose container for knowledge asset definitions. It can be used to describe and expose existing knowledge assets such as logic libraries and information model descriptions, as well as to describe a collection of knowledge assets.
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 = Library;
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 approvalDate as HS.FHIR.vSTU3.Model.Datatype.Date (XMLNAME = "approvalDate", XMLPROJECTION = "ELEMENT");
The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
Property methods: approvalDateGet(), approvalDateGetSwizzled(), approvalDateIsValid(), approvalDateNewObject(), approvalDateSet()
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 content as list of HS.FHIR.vSTU3.Model.Base.Attachment (XMLNAME = "content", XMLPROJECTION = "ELEMENT");
The content of the library as an Attachment. The content may be a reference to a url, or may be directly embedded as a base-64 string. Either way, the contentType of the attachment determines how to interpret the content.
Property methods: contentBuildValueArray(), contentCollectionToDisplay(), contentCollectionToOdbc(), contentDisplayToCollection(), contentGet(), contentGetObject(), contentGetObjectId(), contentGetSwizzled(), contentIsValid(), contentOdbcToCollection(), contentSet(), contentSetObject(), contentSetObjectId()
property contributor as list of HS.FHIR.vSTU3.Model.Base.Contributor (XMLNAME = "contributor", XMLPROJECTION = "ELEMENT");
A contributor to the content of the library, including authors, editors, reviewers, and endorsers.
Property methods: contributorBuildValueArray(), contributorCollectionToDisplay(), contributorCollectionToOdbc(), contributorDisplayToCollection(), contributorGet(), contributorGetObject(), contributorGetObjectId(), contributorGetSwizzled(), contributorIsValid(), contributorOdbcToCollection(), contributorSet(), contributorSetObject(), contributorSetObjectId()
A copyright statement relating to the library and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the library.
Property methods: copyrightGet(), copyrightGetSwizzled(), copyrightIsValid(), copyrightNewObject(), copyrightSet()
property dataRequirement as list of HS.FHIR.vSTU3.Model.Base.DataRequirement (XMLNAME = "dataRequirement", XMLPROJECTION = "ELEMENT");
Describes a set of data that must be provided in order to be able to successfully perform the computations defined by the library.
Property methods: dataRequirementBuildValueArray(), dataRequirementCollectionToDisplay(), dataRequirementCollectionToOdbc(), dataRequirementDisplayToCollection(), dataRequirementGet(), dataRequirementGetObject(), dataRequirementGetObjectId(), dataRequirementGetSwizzled(), dataRequirementIsValid(), dataRequirementOdbcToCollection(), dataRequirementSet(), dataRequirementSetObject(), dataRequirementSetObjectId()
property date as HS.FHIR.vSTU3.Model.Datatype.DateTime (XMLNAME = "date", XMLPROJECTION = "ELEMENT");
The date (and optionally time) when the library 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 library 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 library from a consumer's perspective.
Property methods: descriptionGet(), descriptionGetSwizzled(), descriptionIsValid(), descriptionNewObject(), descriptionSet()
property effectivePeriod as HS.FHIR.vSTU3.Model.Base.Period (XMLNAME = "effectivePeriod", XMLPROJECTION = "ELEMENT");
The period during which the library content was or is planned to be in active use.
Property methods: effectivePeriodGet(), effectivePeriodGetSwizzled(), effectivePeriodIsValid(), effectivePeriodNewObject(), effectivePeriodSet()
property experimental as HS.FHIR.vSTU3.Model.Datatype.Boolean (XMLNAME = "experimental", XMLPROJECTION = "ELEMENT");
A boolean value to indicate that this library 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 identifier as list of HS.FHIR.vSTU3.Model.Base.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
A formal identifier that is used to identify this library when it is represented in other formats, or referenced in a specification, model, design or an instance. e.g. CMS or NQF identifiers for a measure artifact. Note that at least one identifier is required for non-experimental active artifacts.
Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property jurisdiction as list of HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "jurisdiction", XMLPROJECTION = "ELEMENT");
A legal or geographic region in which the library is intended to be used.
Property methods: jurisdictionBuildValueArray(), jurisdictionCollectionToDisplay(), jurisdictionCollectionToOdbc(), jurisdictionDisplayToCollection(), jurisdictionGet(), jurisdictionGetObject(), jurisdictionGetObjectId(), jurisdictionGetSwizzled(), jurisdictionIsValid(), jurisdictionOdbcToCollection(), jurisdictionSet(), jurisdictionSetObject(), jurisdictionSetObjectId()
property lastReviewDate as HS.FHIR.vSTU3.Model.Datatype.Date (XMLNAME = "lastReviewDate", XMLPROJECTION = "ELEMENT");
The date on which the resource content was last reviewed. Review happens periodically after approval, but doesn't change the original approval date.
Property methods: lastReviewDateGet(), lastReviewDateGetSwizzled(), lastReviewDateIsValid(), lastReviewDateNewObject(), lastReviewDateSet()
property name as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "name", XMLPROJECTION = "ELEMENT");
A natural language name identifying the library. 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 parameter as list of HS.FHIR.vSTU3.Model.Base.ParameterDefinition (XMLNAME = "parameter", XMLPROJECTION = "ELEMENT");
The parameter element defines parameters used by the library.
Property methods: parameterBuildValueArray(), parameterCollectionToDisplay(), parameterCollectionToOdbc(), parameterDisplayToCollection(), parameterGet(), parameterGetObject(), parameterGetObjectId(), parameterGetSwizzled(), parameterIsValid(), parameterOdbcToCollection(), parameterSet(), parameterSetObject(), parameterSetObjectId()
property publisher as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "publisher", XMLPROJECTION = "ELEMENT");
The name of the individual or organization that published the library.
Property methods: publisherGet(), publisherGetSwizzled(), publisherIsValid(), publisherNewObject(), publisherSet()
property purpose as HS.FHIR.vSTU3.Model.Datatype.Markdown (XMLNAME = "purpose", XMLPROJECTION = "ELEMENT");
Explaination of why this library is needed and why it has been designed as it has.
Property methods: purposeGet(), purposeGetSwizzled(), purposeIsValid(), purposeNewObject(), purposeSet()
property relatedArtifact as list of HS.FHIR.vSTU3.Model.Base.RelatedArtifact (XMLNAME = "relatedArtifact", XMLPROJECTION = "ELEMENT");
Related artifacts such as additional documentation, justification, or bibliographic references.
Property methods: relatedArtifactBuildValueArray(), relatedArtifactCollectionToDisplay(), relatedArtifactCollectionToOdbc(), relatedArtifactDisplayToCollection(), relatedArtifactGet(), relatedArtifactGetObject(), relatedArtifactGetObjectId(), relatedArtifactGetSwizzled(), relatedArtifactIsValid(), relatedArtifactOdbcToCollection(), relatedArtifactSet(), relatedArtifactSetObject(), relatedArtifactSetObjectId()
property status as HS.FHIR.vSTU3.Model.Base.PublicationStatus (XMLNAME = "status", XMLPROJECTION = "ELEMENT") [ Required ];
The status of this library. Enables tracking the life-cycle of the content.
Property methods: statusGet(), statusGetSwizzled(), statusIsValid(), statusNewObject(), statusSet()
property title as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "title", XMLPROJECTION = "ELEMENT");
A short, descriptive, user-friendly title for the library.
Property methods: titleGet(), titleGetSwizzled(), titleIsValid(), titleNewObject(), titleSet()
property topic as list of HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "topic", XMLPROJECTION = "ELEMENT");
Descriptive topics related to the content of the library. Topics provide a high-level categorization of the library that can be useful for filtering and searching.
Property methods: topicBuildValueArray(), topicCollectionToDisplay(), topicCollectionToOdbc(), topicDisplayToCollection(), topicGet(), topicGetObject(), topicGetObjectId(), topicGetSwizzled(), topicIsValid(), topicOdbcToCollection(), topicSet(), topicSetObject(), topicSetObjectId()
property type as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "type", XMLPROJECTION = "ELEMENT") [ Required ];
Identifies the type of library such as a Logic Library, Model Definition, Asset Collection, or Module Definition.
Property methods: typeGet(), typeGetSwizzled(), typeIsValid(), typeNewObject(), typeSet()
property url as HS.FHIR.vSTU3.Model.Datatype.Uri (XMLNAME = "url", XMLPROJECTION = "ELEMENT");
An absolute URI that is used to identify this library 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 library is (or will be) published. The URL SHOULD include the major version of the library. For more information see [Technical and Business Versions](resource.html#versions).
Property methods: urlGet(), urlGetSwizzled(), urlIsValid(), urlNewObject(), urlSet()
property usage as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "usage", XMLPROJECTION = "ELEMENT");
A detailed description of how the library is used from a clinical perspective.
Property methods: usageGet(), usageGetSwizzled(), usageIsValid(), usageNewObject(), usageSet()
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 library 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 library when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the library 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. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.
Property methods: versionGet(), versionGetSwizzled(), versionIsValid(), versionNewObject(), versionSet()

Methods

deprecated method SetApprovalDate(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 "approvalDate" property.
deprecated method SetContent(pContentType As %String = "", pLanguage As %String = "", pData As %String = "", pUrl As %String = "", pSize As %String = "", pHash As %String = "", pTitle As %String = "", pCreation 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 "content" property.
deprecated method SetCopyright(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 "copyright" 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 SetEffectivePeriod(pStart As %String = "", pEnd As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "effectivePeriod" 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.
Insert method for the "identifier" 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 SetLastReviewDate(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 "lastReviewDate" 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 SetPurpose(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 "purpose" 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 SetTitle(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 "title" property.
deprecated method SetTopic(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 "topic" property.
deprecated method SetType(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.
Set method for the "type" 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 SetUsage(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 "usage" 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