cardea.fhir.StructureDefinition

class cardea.fhir.StructureDefinition(dict_values=None)

A definition of a FHIR structure. This resource is used to describe the underlying resources, data types defined in FHIR, and also for describing extensions and constraints on resources and data types.

Parameters

  • resourceType – This is a StructureDefinition resource

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

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

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

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

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

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

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

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

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

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

  • keyword – A set of key words or terms from external terminologies that may be used to assist with indexing and searching of templates.

  • fhirVersion – The version of the FHIR specification on which this StructureDefinition 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.

  • mapping – An external specification that the content is mapped to.

  • kind – Defines the kind of structure that this definition is describing.

  • abstract – Whether structure this definition describes is abstract or not - that is, whether the structure is not intended to be instantiated. For Resources and Data types, abstract types will never be exchanged between systems.

  • contextType – If this is an extension, Identifies the context within FHIR resources where the extension can be used.

  • context – Identifies the types of resource or data type elements to which the extension can be applied.

  • contextInvariant – A set of rules as Fluent Invariants about when the extension can be used (e.g. co-occurrence variants for the extension).

  • type – The type this structure describes. If the derivation kind is ‘specialization’ then this is the master definition for a type, and there is always one of these (a data type, an extension, a resource, including abstract ones). Otherwise the structure definition is a constraint on the stated type (and in this case, the type cannot be an abstract type).

  • baseDefinition – An absolute URI that is the base structure from which this type is derived, either by specialization or constraint.

  • derivation – How the type relates to the baseDefinition.

  • snapshot – A snapshot view is expressed in a stand alone form that can be used and interpreted without considering the base StructureDefinition.

  • differential – A differential view is expressed relative to the base StructureDefinition - a statement of differences that it applies.

__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.Specimen cardea.fhir.StructureMap