cardea.fhir.Composition

class cardea.fhir.Composition(dict_values=None)

A set of healthcare-related information that is assembled together into a single logical document that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. While a Composition defines the structure, it does not actually contain the content: rather the full content of a document is contained in a Bundle, of which the Composition is the first resource contained.

Parameters
  • resourceType – This is a Composition resource

  • identifier – Logical identifier for the composition, assigned when created. This identifier stays constant as the composition is changed over time.

  • status – The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document.

  • type – Specifies the particular kind of composition (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the composition.

  • class – A categorization for the type of the composition - helps for indexing and searching. This may be implied by or derived from the code specified in the Composition Type.

  • subject – Who or what the composition is about. The composition can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of livestock, or a set of patients that share a common exposure).

  • encounter – Describes the clinical encounter or type of care this documentation is associated with.

  • date – The composition editing time, when the composition was last logically changed by the author.

  • author – Identifies who is responsible for the information in the composition, not necessarily who typed it in.

  • title – Official human-readable label for the composition.

  • confidentiality – The code specifying the level of confidentiality of the Composition.

  • attester – A participant who has attested to the accuracy of the composition/document.

  • custodian – Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information.

  • relatesTo – Relationships that this composition has with other compositions or documents that already exist.

  • event – The clinical service, such as a colonoscopy or an appendectomy, being documented.

  • section – The root of the sections that make up the composition.

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