cardea.fhir.StructureMap

class cardea.fhir.StructureMap(dict_values=None)

A Map of relationships between 2 structures that can be used to transform data.

Parameters

• resourceType – This is a StructureMap resource

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

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

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

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

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

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

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

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

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

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

• structure – A structure definition used by this map. The structure definition may describe instances that are converted, or the instances that are produced.

• import – Other maps used by this map (canonical URLs).

• group – Organizes the mapping into managable chunks for human review/ease of maintenance.

__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.StructureDefinition cardea.fhir.Subscription