cardea.fhir.MessageDefinition

class cardea.fhir.MessageDefinition(dict_values=None)

Defines the characteristics of a message that can be shared between systems, including the type of event that initiates the message, the content to be transmitted and what response(s), if any, are permitted.

Parameters

  • resourceType – This is a MessageDefinition resource

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

  • identifier – A formal identifier that is used to identify this message definition when it is represented in other formats, or referenced in a specification, model, design or an instance.

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

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

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

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

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

  • description – A free text natural language description of the message definition 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 message definition instances.

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

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

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

  • base – The MessageDefinition that is the basis for the contents of this resource.

  • parent – Identifies a protocol or workflow that this MessageDefinition represents a step in.

  • replaces – A MessageDefinition that is superseded by this definition.

  • event – A coded identifier of a supported messaging event.

  • category – The impact of the content of the message.

  • focus – Identifies the resource (or resources) that are being addressed by the event. For example, the Encounter for an admit message or two Account records for a merge.

  • responseRequired – Indicates whether a response is required for this message.

  • allowedResponse – Indicates what types of messages may be sent as an application-level response to this message.

__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.MedicationStatement cardea.fhir.MessageHeader