spark_auto_mapper_fhir.resources.operation_definition

Module Contents

Classes

OperationDefinition

OperationDefinition
class spark_auto_mapper_fhir.resources.operation_definition.OperationDefinition(*, id_=None, meta=None, implicitRules=None, language=None, text=None, contained=None, extension=None, modifierExtension=None, url=None, version=None, name, title=None, status, kind, experimental=None, date=None, publisher=None, contact=None, description=None, useContext=None, jurisdiction=None, purpose=None, affectsState=None, code, comment=None, base=None, resource=None, system, type_, instance, inputProfile=None, outputProfile=None, parameter=None, overload=None)

Bases: spark_auto_mapper_fhir.base_types.fhir_resource_base.FhirResourceBase

OperationDefinition operationdefinition.xsd

A formal computable definition of an operation (on the RESTful interface) or a

named query (using the search interaction).

If the element is present, it must have either a @value, an @id, or extensions

A formal computable definition of an operation (on the RESTful interface) or a

named query (using the search interaction).

If the element is present, it must have either a @value, an @id, or extensions

param id_

The logical id of the resource, as used in the URL for the resource. Once

assigned, this value never changes.
param meta

The metadata about the resource. This is content that is maintained by the

infrastructure. Changes to the content might not always be associated with version changes to the resource.

param implicitRules

A reference to a set of rules that were followed when the resource was

constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

param language

The base language in which the resource is written.

param text

A human-readable narrative that contains a summary of the resource and can be

used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it “clinically safe” for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

param contained

These resources do not have an independent existence apart from the resource

that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

param extension

May be used to represent additional information that is not part of the basic

definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

param modifierExtension

May be used to represent additional information that is not part of the basic

definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element’s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

param url

An absolute URI that is used to identify this operation definition when it is

referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this operation definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the operation definition is stored on different servers.

param version

The identifier that is used to identify this version of the operation

definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the operation 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.

param name

A natural language name identifying the operation definition. This name should

be usable as an identifier for the module by machine processing applications such as code generation.

param title

A short, descriptive, user-friendly title for the operation definition.

param status

The status of this operation definition. Enables tracking the life-cycle of

the content.
param kind

Whether this is an operation or a named query.

param experimental

A Boolean value to indicate that this operation definition is authored for

testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

param date

The date (and optionally time) when the operation definition was published.

The date must change 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 operation definition changes.

param publisher

The name of the organization or individual that published the operation

definition.
param contact

Contact details to assist a user in finding and communicating with the

publisher.
param description

A free text natural language description of the operation definition from a

consumer’s perspective.
param useContext

The content was developed with a focus and intent of supporting the contexts

that are listed. These contexts may be general categories (gender, age, …) or may be references to specific programs (insurance plans, studies, …) and may be used to assist with indexing and searching for appropriate operation definition instances.

param jurisdiction

A legal or geographic region in which the operation definition is intended to

be used.
param purpose

Explanation of why this operation definition is needed and why it has been

designed as it has.
param affectsState

Whether the operation affects state. Side effects such as producing audit

trail entries do not count as ‘affecting state’.
param code

The name used to invoke the operation.

param comment

Additional information about how to use this operation or named query.

param base

Indicates that this operation definition is a constraining profile on the

base.
param resource

The types on which this operation can be executed.

param system

Indicates whether this operation or named query can be invoked at the system

level (e.g. without needing to choose a resource type for the context).
param type_

Indicates whether this operation or named query can be invoked at the resource

type level for any given resource type level (e.g. without needing to choose a specific resource id for the context).

param instance

Indicates whether this operation can be invoked on a particular instance of

one of the given types.
param inputProfile

Additional validation information for the in parameters - a single profile

that covers all the parameters. The profile is a constraint on the parameters resource as a whole.

param outputProfile

Additional validation information for the out parameters - a single profile

that covers all the parameters. The profile is a constraint on the parameters resource.

param parameter

The parameters for the operation/query.

param overload

Defines an appropriate combination of parameters to use when invoking this

operation, to help code generators when generating overloaded parameter sets for this operation.

Parameters
get_schema(self, include_extension)
Parameters

include_extension (bool) –

Return type

Optional[Union[pyspark.sql.types.StructType, pyspark.sql.types.DataType]]