cardea.fhir.CompartmentDefinition

class cardea.fhir.CompartmentDefinition(dict_values=None)

A compartment definition that defines how resources are accessed on a server.

Parameters
  • resourceType – This is a CompartmentDefinition resource

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

  • name – A natural language name identifying the compartment definition. 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 compartment definition.

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

  • experimental – A boolean value to indicate that this compartment definition 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 compartment definition 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 compartment definition changes.

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

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

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

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

  • 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 compartment definition instances.

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

  • code – Which compartment this definition describes.

  • search – Whether the search syntax is supported,.

  • resource – Information about how a resource is related to the compartment.

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