cardea.fhir.ImplementationGuide

class cardea.fhir.ImplementationGuide(dict_values=None)

A set of rules of how FHIR is used to solve a particular problem. This resource is used to gather all the parts of an implementation guide into a logical whole and to publish a computable definition of all the parts.

Parameters
  • resourceType – This is a ImplementationGuide resource

  • url – An absolute URI that is used to identify this implementation guide 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 implementation guide is (or will be) published. The URL SHOULD include the major version of the implementation guide. For more information see [Technical and Business Versions](resource.html#versions).

  • version – The identifier that is used to identify this version of the implementation guide when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the implementation guide 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.

  • name – A natural language name identifying the implementation guide. This name should be usable as an identifier for the module by machine processing applications such as code generation.

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

  • experimental – A boolean value to indicate that this implementation guide is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.

  • date – The date (and optionally time) when the implementation guide 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 implementation guide changes.

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

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

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

  • 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 implementation guide instances.

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

  • copyright – A copyright statement relating to the implementation guide and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the implementation guide.

  • fhirVersion – The version of the FHIR specification on which this ImplementationGuide is based - this is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 3.0.1 for this version.

  • dependency – Another implementation guide that this implementation depends on. Typically, an implementation guide uses value sets, profiles etc.defined in other implementation guides.

  • package – A logical group of resources. Logical groups can be used when building pages.

  • global – A set of profiles that all resources covered by this implementation guide must conform to.

  • binary – A binary file that is included in the implementation guide when it is published.

  • page – A page / section in the implementation guide. The root page is the implementation guide home page.

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