HS.FHIRModel.R4.OperationDefinition
class HS.FHIRModel.R4.OperationDefinition extends HS.FHIRModel.FHIRClassSuper
******************************************* OperationDefinition generated class schema
*****************************************
A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).
Property Inventory
- _affectsState
- _code
- _comment
- _date
- _description
- _experimental
- _implicitRules
- _instance
- _kind
- _language
- _name
- _publisher
- _purpose
- _resource
- _status
- _system
- _title
- _type
- _url
- _version
- affectsState
- base
- code
- comment
- contact
- contained
- date
- description
- experimental
- extension
- fhirID
- implicitRules
- inputProfile
- instance
- jurisdiction
- kind
- language
- meta
- modifierExtension
- name
- outputProfile
- overload
- parameter
- publisher
- purpose
- resource
- resourceType
- status
- system
- text
- title
- type
- url
- useContext
- version
Method Inventory
- IncludeContact()
- IncludeContained()
- IncludeExtension()
- IncludeJurisdiction()
- IncludeMeta()
- IncludeModifierExtension()
- IncludeOverload()
- IncludeParameter()
- IncludeResource()
- IncludeText()
- IncludeUseContext()
- _getProperties()
- fromDao()
- toDao()
Parameters
parameter XMLTYPE = R4_OPERATIONDEFINITION;
Inherited description: This parameter provides the default XMLTYPE for the class. If it is
empty then the class name will be used to construct a default XML type.
The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.
Properties
property _affectsState as HS.FHIRModel.R4.Element;
Extensions for affectsState
Property methods: _affectsStateGet(), _affectsStateGetSwizzled(), _affectsStateIsValid(), _affectsStateNewObject(), _affectsStateSet()
property _code as HS.FHIRModel.R4.Element;
Extensions for code
Property methods: _codeGet(), _codeGetSwizzled(), _codeIsValid(), _codeNewObject(), _codeSet()
property _comment as HS.FHIRModel.R4.Element;
Extensions for comment
Property methods: _commentGet(), _commentGetSwizzled(), _commentIsValid(), _commentNewObject(), _commentSet()
property _date as HS.FHIRModel.R4.Element;
Extensions for date
Property methods: _dateGet(), _dateGetSwizzled(), _dateIsValid(), _dateNewObject(), _dateSet()
property _description as HS.FHIRModel.R4.Element;
Extensions for description
Property methods: _descriptionGet(), _descriptionGetSwizzled(), _descriptionIsValid(), _descriptionNewObject(), _descriptionSet()
property _experimental as HS.FHIRModel.R4.Element;
Extensions for experimental
Property methods: _experimentalGet(), _experimentalGetSwizzled(), _experimentalIsValid(), _experimentalNewObject(), _experimentalSet()
property _implicitRules as HS.FHIRModel.R4.Element;
Extensions for implicitRules
Property methods: _implicitRulesGet(), _implicitRulesGetSwizzled(), _implicitRulesIsValid(), _implicitRulesNewObject(), _implicitRulesSet()
property _instance as HS.FHIRModel.R4.Element;
Extensions for instance
Property methods: _instanceGet(), _instanceGetSwizzled(), _instanceIsValid(), _instanceNewObject(), _instanceSet()
property _kind as HS.FHIRModel.R4.Element;
Extensions for kind
Property methods: _kindGet(), _kindGetSwizzled(), _kindIsValid(), _kindNewObject(), _kindSet()
property _language as HS.FHIRModel.R4.Element;
Extensions for language
Property methods: _languageGet(), _languageGetSwizzled(), _languageIsValid(), _languageNewObject(), _languageSet()
property _name as HS.FHIRModel.R4.Element;
Extensions for name
Property methods: _nameGet(), _nameGetSwizzled(), _nameIsValid(), _nameNewObject(), _nameSet()
property _publisher as HS.FHIRModel.R4.Element;
Extensions for publisher
Property methods: _publisherGet(), _publisherGetSwizzled(), _publisherIsValid(), _publisherNewObject(), _publisherSet()
property _purpose as HS.FHIRModel.R4.Element;
Extensions for purpose
Property methods: _purposeGet(), _purposeGetSwizzled(), _purposeIsValid(), _purposeNewObject(), _purposeSet()
property _resource as HS.FHIRModel.R4.SeqOfElement;
Extensions for resource
Property methods: _resourceGet(), _resourceGetSwizzled(), _resourceIsValid(), _resourceNewObject(), _resourceSet()
property _status as HS.FHIRModel.R4.Element;
Extensions for status
Property methods: _statusGet(), _statusGetSwizzled(), _statusIsValid(), _statusNewObject(), _statusSet()
property _system as HS.FHIRModel.R4.Element;
Extensions for system
Property methods: _systemGet(), _systemGetSwizzled(), _systemIsValid(), _systemNewObject(), _systemSet()
property _title as HS.FHIRModel.R4.Element;
Extensions for title
Property methods: _titleGet(), _titleGetSwizzled(), _titleIsValid(), _titleNewObject(), _titleSet()
property _type as HS.FHIRModel.R4.Element;
Extensions for type
Property methods: _typeGet(), _typeGetSwizzled(), _typeIsValid(), _typeNewObject(), _typeSet()
property _url as HS.FHIRModel.R4.Element;
Extensions for url
Property methods: _urlGet(), _urlGetSwizzled(), _urlIsValid(), _urlNewObject(), _urlSet()
property _version as HS.FHIRModel.R4.Element;
Extensions for version
Property methods: _versionGet(), _versionGetSwizzled(), _versionIsValid(), _versionNewObject(), _versionSet()
property affectsState as %Boolean;
Whether the operation affects state. Side effects such as producing
audit trail entries do not count as 'affecting state'.
Property methods: affectsStateDisplayToLogical(), affectsStateGet(), affectsStateIsValid(), affectsStateLogicalToDisplay(), affectsStateLogicalToXSD(), affectsStateNormalize(), affectsStateSet(), affectsStateXSDToLogical()
property base as %String;
Indicates that this operation definition is a constraining profile
on the base.
Property methods: baseDisplayToLogical(), baseGet(), baseIsValid(), baseLogicalToDisplay(), baseLogicalToOdbc(), baseNormalize(), baseSet()
property code as %String;
The name used to invoke the operation.
Property methods: codeDisplayToLogical(), codeGet(), codeIsValid(), codeLogicalToDisplay(), codeLogicalToOdbc(), codeNormalize(), codeSet()
property comment as %String;
Additional information about how to use this operation or named query.
Property methods: commentDisplayToLogical(), commentGet(), commentIsValid(), commentLogicalToDisplay(), commentLogicalToOdbc(), commentNormalize(), commentSet()
property contact as HS.FHIRModel.R4.SeqOfContactDetail;
Contact details to assist a user in finding and communicating with
the publisher.
Property methods: contactGet(), contactGetSwizzled(), contactIsValid(), contactNewObject(), contactSet()
property contained as HS.FHIRModel.R4.SeqOfResourceList;
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.
Property methods: containedGet(), containedGetSwizzled(), containedIsValid(), containedNewObject(), containedSet()
property date as %String;
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.
Property methods: dateDisplayToLogical(), dateGet(), dateIsValid(), dateLogicalToDisplay(), dateLogicalToOdbc(), dateNormalize(), dateSet()
property description as %String;
A free text natural language description of the operation definition
from a consumer's perspective.
Property methods: descriptionDisplayToLogical(), descriptionGet(), descriptionIsValid(), descriptionLogicalToDisplay(), descriptionLogicalToOdbc(), descriptionNormalize(), descriptionSet()
property experimental as %Boolean;
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.
Property methods: experimentalDisplayToLogical(), experimentalGet(), experimentalIsValid(), experimentalLogicalToDisplay(), experimentalLogicalToXSD(), experimentalNormalize(), experimentalSet(), experimentalXSDToLogical()
property extension as HS.FHIRModel.R4.SeqOfExtension;
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.
Property methods: extensionGet(), extensionGetSwizzled(), extensionIsValid(), extensionNewObject(), extensionSet()
property fhirID as %String;
The logical id of the resource, as used in the URL for the resource.
Once assigned, this value never changes.
Property methods: fhirIDDisplayToLogical(), fhirIDGet(), fhirIDIsValid(), fhirIDLogicalToDisplay(), fhirIDLogicalToOdbc(), fhirIDNormalize(), fhirIDSet()
property implicitRules as %String;
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.
Property methods: implicitRulesDisplayToLogical(), implicitRulesGet(), implicitRulesIsValid(), implicitRulesLogicalToDisplay(), implicitRulesLogicalToOdbc(), implicitRulesNormalize(), implicitRulesSet()
property inputProfile as %String;
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.
Property methods: inputProfileDisplayToLogical(), inputProfileGet(), inputProfileIsValid(), inputProfileLogicalToDisplay(), inputProfileLogicalToOdbc(), inputProfileNormalize(), inputProfileSet()
property instance as %Boolean;
Indicates whether this operation can be invoked on a particular instance
of one of the given types.
Property methods: instanceDisplayToLogical(), instanceGet(), instanceIsValid(), instanceLogicalToDisplay(), instanceLogicalToXSD(), instanceNormalize(), instanceSet(), instanceXSDToLogical()
property jurisdiction as HS.FHIRModel.R4.SeqOfCodeableConcept;
A legal or geographic region in which the operation definition is
intended to be used.
Property methods: jurisdictionGet(), jurisdictionGetSwizzled(), jurisdictionIsValid(), jurisdictionNewObject(), jurisdictionSet()
property kind as %String (VALUELIST = ",operation,query");
Whether this is an operation or a named query.
Property methods: kindDisplayToLogical(), kindGet(), kindIsValid(), kindLogicalToDisplay(), kindLogicalToOdbc(), kindNormalize(), kindSet()
property language as %String;
The base language in which the resource is written.
Property methods: languageDisplayToLogical(), languageGet(), languageIsValid(), languageLogicalToDisplay(), languageLogicalToOdbc(), languageNormalize(), languageSet()
property meta as HS.FHIRModel.R4.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.
Property methods: metaGet(), metaGetSwizzled(), metaIsValid(), metaNewObject(), metaSet()
property modifierExtension as HS.FHIRModel.R4.SeqOfExtension;
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).
Property methods: modifierExtensionGet(), modifierExtensionGetSwizzled(), modifierExtensionIsValid(), modifierExtensionNewObject(), modifierExtensionSet()
property name as %String;
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.
Property methods: nameDisplayToLogical(), nameGet(), nameIsValid(), nameLogicalToDisplay(), nameLogicalToOdbc(), nameNormalize(), nameSet()
property outputProfile as %String;
Additional validation information for the out parameters - a single
profile that covers all the parameters. The profile is a constraint
on the parameters resource.
Property methods: outputProfileDisplayToLogical(), outputProfileGet(), outputProfileIsValid(), outputProfileLogicalToDisplay(), outputProfileLogicalToOdbc(), outputProfileNormalize(), outputProfileSet()
property overload as HS.FHIRModel.R4.OperationDefinitionX.SeqOfOperationDefinitionXOverload;
Defines an appropriate combination of parameters to use when invoking
this operation, to help code generators when generating overloaded
parameter sets for this operation.
Property methods: overloadGet(), overloadGetSwizzled(), overloadIsValid(), overloadNewObject(), overloadSet()
property parameter as HS.FHIRModel.R4.OperationDefinitionX.SeqOfOperationDefinitionXParameter;
The parameters for the operation/query.
Property methods: parameterGet(), parameterGetSwizzled(), parameterIsValid(), parameterNewObject(), parameterSet()
property publisher as %String;
The name of the organization or individual that published the operation
definition.
Property methods: publisherDisplayToLogical(), publisherGet(), publisherIsValid(), publisherLogicalToDisplay(), publisherLogicalToOdbc(), publisherNormalize(), publisherSet()
property purpose as %String;
Explanation of why this operation definition is needed and why it
has been designed as it has.
Property methods: purposeDisplayToLogical(), purposeGet(), purposeIsValid(), purposeLogicalToDisplay(), purposeLogicalToOdbc(), purposeNormalize(), purposeSet()
property resource as HS.FHIRModel.R4.SeqOfString;
The types on which this operation can be executed.
Property methods: resourceGet(), resourceGetSwizzled(), resourceIsValid(), resourceNewObject(), resourceSet()
property resourceType as %String [ InitialExpression = "OperationDefinition" , Required ];
This is a OperationDefinition resource
Property methods: resourceTypeDisplayToLogical(), resourceTypeGet(), resourceTypeIsValid(), resourceTypeLogicalToDisplay(), resourceTypeLogicalToOdbc(), resourceTypeNormalize(), resourceTypeSet()
property status as %String (VALUELIST = ",draft,active,retired,unknown");
The status of this operation definition. Enables tracking the life-cycle
of the content.
Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property system as %Boolean;
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).
Property methods: systemDisplayToLogical(), systemGet(), systemIsValid(), systemLogicalToDisplay(), systemLogicalToXSD(), systemNormalize(), systemSet(), systemXSDToLogical()
property text as HS.FHIRModel.R4.Narrative;
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.
Property methods: textGet(), textGetSwizzled(), textIsValid(), textNewObject(), textSet()
property title as %String;
A short, descriptive, user-friendly title for the operation definition.
Property methods: titleDisplayToLogical(), titleGet(), titleIsValid(), titleLogicalToDisplay(), titleLogicalToOdbc(), titleNormalize(), titleSet()
property type as %Boolean;
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).
Property methods: typeDisplayToLogical(), typeGet(), typeIsValid(), typeLogicalToDisplay(), typeLogicalToXSD(), typeNormalize(), typeSet(), typeXSDToLogical()
property url as %String;
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.
Property methods: urlDisplayToLogical(), urlGet(), urlIsValid(), urlLogicalToDisplay(), urlLogicalToOdbc(), urlNormalize(), urlSet()
property useContext as HS.FHIRModel.R4.SeqOfUsageContext;
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.
Property methods: useContextGet(), useContextGetSwizzled(), useContextIsValid(), useContextNewObject(), useContextSet()
property version as %String;
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.
Property methods: versionDisplayToLogical(), versionGet(), versionIsValid(), versionLogicalToDisplay(), versionLogicalToOdbc(), versionNormalize(), versionSet()
Methods
method IncludeContact()
method IncludeContained()
method IncludeExtension()
method IncludeJurisdiction()
method IncludeMeta()
method IncludeModifierExtension()
method IncludeOverload()
method IncludeParameter()
method IncludeResource()
method IncludeText()
method IncludeUseContext()
method _getProperties() as %DynamicArray
Inherited description: Return an array of the defined properties of this class
in the definition order that they were discovered in the
the HL7FHIR JSchema document
classmethod fromDao(dao As %Library.DynamicAbstractObject) as HS.FHIRModel.R4.OperationDefinition
method toDao() as %DynamicAbstractObject
Inherited description: >
The toDao() method casts the set to a DAO.
Inherited Members
Inherited Methods
- %AddToSaveSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %IsModified()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %SerializeObject()
- %SetModified()
- %ValidateObject()
- XMLDTD()
- XMLExport()
- XMLExportToStream()
- XMLExportToString()
- XMLNew()
- XMLSchema()
- XMLSchemaNamespace()
- XMLSchemaType()
- add()
- addAll()
- apply()
- clear()
- contains()
- containsAll()
- get()
- iterator()
- put()
- putAll()
- putAllIfAbsent()
- putIfAbsent()
- remove()
- removeAll()
- removeIf()
- rename()
- replace()
- replaceAll()
- size()
- toString()