cardea.fhir.Library

class cardea.fhir.Library(dict_values=None)

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.

Parameters

  • resourceType – This is a Library resource

  • url – 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).

  • identifier – 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.

  • version – 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.

  • name – 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.

  • title – A short, descriptive, user-friendly title for the library.

  • status – The status of this library. Enables tracking the life-cycle of the content.

  • experimental – 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.

  • type – Identifies the type of library such as a Logic Library, Model Definition, Asset Collection, or Module Definition.

  • date – 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.

  • publisher – The name of the individual or organization that published the library.

  • description – A free text natural language description of the library from a consumer’s perspective.

  • purpose – Explaination of why this library is needed and why it has been designed as it has.

  • usage – A detailed description of how the library is used from a clinical perspective.

  • approvalDate – The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

  • lastReviewDate – The date on which the resource content was last reviewed. Review happens periodically after approval, but doesn’t change the original approval date.

  • effectivePeriod – The period during which the library content was or is planned to be in active use.

  • useContext – 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.

  • jurisdiction – A legal or geographic region in which the library is intended to be used.

  • topic – 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.

  • contributor – A contributor to the content of the library, including authors, editors, reviewers, and endorsers.

  • contact – Contact details to assist a user in finding and communicating with the publisher.

  • copyright – 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.

  • relatedArtifact – Related artifacts such as additional documentation, justification, or bibliographic references.

  • parameter – The parameter element defines parameters used by the library.

  • dataRequirement – Describes a set of data that must be provided in order to be able to successfully perform the computations defined by the library.

  • content – 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.

__init__(dict_values=None)

Initialize self. See help(type(self)) for accurate signature.

Methods

__init__([dict_values])

Initialize self.

assert_type()

Checks class values follow set possible enumerations.

get_dataframe()

Returns dataframe from class attribute values.

get_eligible_relationships()

Returns class relationships for attributes that are used.

get_id()

Returns fhir class identifier.

get_relationships()

Returns class relationships.

set_attributes(dict_values)

Sets values to class attributes.
cardea.fhir.ImplementationGuide cardea.fhir.Linkage