Skip to main content

HS.FHIR.DTL.vR4.Model.Resource.OperationDefinition

class HS.FHIR.DTL.vR4.Model.Resource.OperationDefinition extends HS.FHIR.DTL.vR4.Model.Base.DomainResource

Definition of an operation or a named query.

Property Inventory

Parameters

parameter ELEMENTQUALIFIED = 1;
Inherited description: ELEMENTQUALIFIED controls the format of exported XML. The ELEMENTQUALIFIED specification should be based on the elementFormDefault attribute of the schema that defines the type. To maintain compatibility, ELEMENTQUALIFIED will default to 1 (true) for literal format export and will default to 0 (false) for encoded or encoded12 format export. These were the values always previously assumed for the elementFormDefault attribute. NOTE: Direct use of XMLExport method does not support the ELEMENTQUALIFIED. The export must be done using %XML.Writer or SOAP support.
parameter XMLNAME = OperationDefinition;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.
parameter XMLPROJECTION = ELEMENT;
parameter XMLSEQUENCE = 1;
Inherited description: If the XMLSEQUENCE = 1, then the order of the XML elements must match the order of the class properties. This allows us to deal with XML where the same field appears multiple times and is distinguished by the order.
parameter XMLTYPE = 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 %Boolean (XMLNAME = "affectsState", XMLPROJECTION = "ATTRIBUTE");
boolean

Whether content is changed by the operation.

Property methods: affectsStateDisplayToLogical(), affectsStateGet(), affectsStateIsValid(), affectsStateLogicalToDisplay(), affectsStateLogicalToXSD(), affectsStateNormalize(), affectsStateSet(), affectsStateXSDToLogical()
property base as %String (MAXLEN = 1000000, XMLNAME = "base", XMLPROJECTION = "ATTRIBUTE");
canonical

Marks this as a profile of the base.

TO DO: Unrecognized value type for the FHIR4 model

Property methods: baseDisplayToLogical(), baseGet(), baseIsValid(), baseLogicalToDisplay(), baseLogicalToOdbc(), baseNormalize(), baseSet()
property code as %String (MAXLEN = 1000000, XMLNAME = "code", XMLPROJECTION = "ATTRIBUTE") [ Required ];
code

Name used to invoke the operation.

any FHIR4 code from any ValueSet may be used.

Property methods: codeDisplayToLogical(), codeGet(), codeIsValid(), codeLogicalToDisplay(), codeLogicalToOdbc(), codeNormalize(), codeSet()
property comment as %String (MAXLEN = 1000000, XMLNAME = "comment", XMLPROJECTION = "ATTRIBUTE");
markdown

Additional information about use.

Property methods: commentDisplayToLogical(), commentGet(), commentIsValid(), commentLogicalToDisplay(), commentLogicalToOdbc(), commentNormalize(), commentSet()
property contact as list of HS.FHIR.DTL.vR4.Model.Datatype.ContactDetail (XMLNAME = "contact", XMLPROJECTION = "ELEMENT");
ContactDetail

Contact details for the publisher.

Property methods: contactBuildValueArray(), contactCollectionToDisplay(), contactCollectionToOdbc(), contactDisplayToCollection(), contactGet(), contactGetObject(), contactGetObjectId(), contactGetSwizzled(), contactIsValid(), contactOdbcToCollection(), contactSet(), contactSetObject(), contactSetObjectId()
property date as %String (MAXLEN = 1000000, XMLNAME = "date", XMLPROJECTION = "ATTRIBUTE");
dateTime

Date last changed.

Property methods: dateDisplayToLogical(), dateGet(), dateIsValid(), dateLogicalToDisplay(), dateLogicalToOdbc(), dateNormalize(), dateSet()
property description as %String (MAXLEN = 1000000, XMLNAME = "description", XMLPROJECTION = "ATTRIBUTE");
markdown

Natural language description of the operation definition.

Property methods: descriptionDisplayToLogical(), descriptionGet(), descriptionIsValid(), descriptionLogicalToDisplay(), descriptionLogicalToOdbc(), descriptionNormalize(), descriptionSet()
property experimental as %Boolean (XMLNAME = "experimental", XMLPROJECTION = "ATTRIBUTE");
boolean

For testing purposes, not real usage.

Property methods: experimentalDisplayToLogical(), experimentalGet(), experimentalIsValid(), experimentalLogicalToDisplay(), experimentalLogicalToXSD(), experimentalNormalize(), experimentalSet(), experimentalXSDToLogical()
property inputProfile as %String (MAXLEN = 1000000, XMLNAME = "inputProfile", XMLPROJECTION = "ATTRIBUTE");
canonical

Validation information for in parameters.

TO DO: Unrecognized value type for the FHIR4 model

Property methods: inputProfileDisplayToLogical(), inputProfileGet(), inputProfileIsValid(), inputProfileLogicalToDisplay(), inputProfileLogicalToOdbc(), inputProfileNormalize(), inputProfileSet()
property instance as %Boolean (XMLNAME = "instance", XMLPROJECTION = "ATTRIBUTE") [ Required ];
boolean

Invoke on an instance?

Property methods: instanceDisplayToLogical(), instanceGet(), instanceIsValid(), instanceLogicalToDisplay(), instanceLogicalToXSD(), instanceNormalize(), instanceSet(), instanceXSDToLogical()
property jurisdiction as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "jurisdiction", XMLPROJECTION = "ELEMENT");
CodeableConcept

Intended jurisdiction for operation definition (if applicable)

jurisdiction is the REQUIRED FHIR4 ValueSet for codes, but if you need to express meanings not found in jurisdiction, you may formally EXTEND jurisdiction to add codes to it.

Property methods: jurisdictionBuildValueArray(), jurisdictionCollectionToDisplay(), jurisdictionCollectionToOdbc(), jurisdictionDisplayToCollection(), jurisdictionGet(), jurisdictionGetObject(), jurisdictionGetObjectId(), jurisdictionGetSwizzled(), jurisdictionIsValid(), jurisdictionOdbcToCollection(), jurisdictionSet(), jurisdictionSetObject(), jurisdictionSetObjectId()
property kind as %String (MAXLEN = 1000000, XMLNAME = "kind", XMLPROJECTION = "ATTRIBUTE") [ Required ];
code

operation | query

operation-kind|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend operation-kind|4.0.1 and you may NOT use codes from other ValueSets.

Property methods: kindDisplayToLogical(), kindGet(), kindIsValid(), kindLogicalToDisplay(), kindLogicalToOdbc(), kindNormalize(), kindSet()
property name as %String (MAXLEN = 1000000, XMLNAME = "name", XMLPROJECTION = "ATTRIBUTE") [ Required ];
string

Name for this operation definition (computer friendly)

Property methods: nameDisplayToLogical(), nameGet(), nameIsValid(), nameLogicalToDisplay(), nameLogicalToOdbc(), nameNormalize(), nameSet()
property outputProfile as %String (MAXLEN = 1000000, XMLNAME = "outputProfile", XMLPROJECTION = "ATTRIBUTE");
canonical

Validation information for out parameters.

TO DO: Unrecognized value type for the FHIR4 model

Property methods: outputProfileDisplayToLogical(), outputProfileGet(), outputProfileIsValid(), outputProfileLogicalToDisplay(), outputProfileLogicalToOdbc(), outputProfileNormalize(), outputProfileSet()
property overload as list of HS.FHIR.DTL.vR4.Model.Element.OperationDefinition.overload (XMLNAME = "overload", XMLPROJECTION = "ELEMENT");
BackboneElement

Define overloaded variants for when generating code.

Property methods: overloadBuildValueArray(), overloadCollectionToDisplay(), overloadCollectionToOdbc(), overloadDisplayToCollection(), overloadGet(), overloadGetObject(), overloadGetObjectId(), overloadGetSwizzled(), overloadIsValid(), overloadOdbcToCollection(), overloadSet(), overloadSetObject(), overloadSetObjectId()
property parameter as list of HS.FHIR.DTL.vR4.Model.Element.OperationDefinition.parameter (XMLNAME = "parameter", XMLPROJECTION = "ELEMENT");
BackboneElement

Parameters for the operation/query.

Property methods: parameterBuildValueArray(), parameterCollectionToDisplay(), parameterCollectionToOdbc(), parameterDisplayToCollection(), parameterGet(), parameterGetObject(), parameterGetObjectId(), parameterGetSwizzled(), parameterIsValid(), parameterOdbcToCollection(), parameterSet(), parameterSetObject(), parameterSetObjectId()
property publisher as %String (MAXLEN = 1000000, XMLNAME = "publisher", XMLPROJECTION = "ATTRIBUTE");
string

Name of the publisher (organization or individual)

Property methods: publisherDisplayToLogical(), publisherGet(), publisherIsValid(), publisherLogicalToDisplay(), publisherLogicalToOdbc(), publisherNormalize(), publisherSet()
property purpose as %String (MAXLEN = 1000000, XMLNAME = "purpose", XMLPROJECTION = "ATTRIBUTE");
markdown

Why this operation definition is defined.

Property methods: purposeDisplayToLogical(), purposeGet(), purposeIsValid(), purposeLogicalToDisplay(), purposeLogicalToOdbc(), purposeNormalize(), purposeSet()
property resource as list of %String (MAXLEN = 1000000, XMLNAME = "resource", XMLPROJECTION = "ELEMENT");
code

Types this operation applies to.

resource-types|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend resource-types|4.0.1 and you may NOT use codes from other ValueSets.

Property methods: resourceBuildValueArray(), resourceCollectionToDisplay(), resourceCollectionToOdbc(), resourceDisplayToCollection(), resourceDisplayToLogical(), resourceGet(), resourceGetObject(), resourceGetObjectId(), resourceGetSwizzled(), resourceIsValid(), resourceLogicalToDisplay(), resourceLogicalToOdbc(), resourceNormalize(), resourceOdbcToCollection(), resourceSet(), resourceSetObject(), resourceSetObjectId(), resourceTypeDisplayToLogical(), resourceTypeGet(), resourceTypeIsValid(), resourceTypeLogicalToDisplay(), resourceTypeLogicalToOdbc(), resourceTypeNormalize()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE") [ Required ];
code

draft | active | retired | unknown

publication-status|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend publication-status|4.0.1 and you may NOT use codes from other ValueSets.

Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property system as %Boolean (XMLNAME = "system", XMLPROJECTION = "ATTRIBUTE") [ Required ];
boolean

Invoke at the system level?

Property methods: systemDisplayToLogical(), systemGet(), systemIsValid(), systemLogicalToDisplay(), systemLogicalToXSD(), systemNormalize(), systemSet(), systemXSDToLogical()
property title as %String (MAXLEN = 1000000, XMLNAME = "title", XMLPROJECTION = "ATTRIBUTE");
string

Name for this operation definition (human friendly)

Property methods: titleDisplayToLogical(), titleGet(), titleIsValid(), titleLogicalToDisplay(), titleLogicalToOdbc(), titleNormalize(), titleSet()
property type as %Boolean (XMLNAME = "type", XMLPROJECTION = "ATTRIBUTE") [ Required ];
boolean

Invoke at the type level?

Property methods: typeDisplayToLogical(), typeGet(), typeIsValid(), typeLogicalToDisplay(), typeLogicalToXSD(), typeNormalize(), typeSet(), typeXSDToLogical()
property url as %String (MAXLEN = 1000000, XMLNAME = "url", XMLPROJECTION = "ATTRIBUTE");
uri

Canonical identifier for this operation definition, represented as a URI (globally unique)

Property methods: urlDisplayToLogical(), urlGet(), urlIsValid(), urlLogicalToDisplay(), urlLogicalToOdbc(), urlNormalize(), urlSet()
property useContext as list of HS.FHIR.DTL.vR4.Model.Datatype.UsageContext (XMLNAME = "useContext", XMLPROJECTION = "ELEMENT");
UsageContext

The context that the content is intended to support.

Property methods: useContextBuildValueArray(), useContextCollectionToDisplay(), useContextCollectionToOdbc(), useContextDisplayToCollection(), useContextGet(), useContextGetObject(), useContextGetObjectId(), useContextGetSwizzled(), useContextIsValid(), useContextOdbcToCollection(), useContextSet(), useContextSetObject(), useContextSetObjectId()
property version as %String (MAXLEN = 1000000, XMLNAME = "version", XMLPROJECTION = "ATTRIBUTE");
string

Business version of the operation definition.

Property methods: versionDisplayToLogical(), versionGet(), versionIsValid(), versionLogicalToDisplay(), versionLogicalToOdbc(), versionNormalize(), versionSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab