Skip to main content


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

A compartment definition that defines how resources are accessed on a server.

Property Inventory


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 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.


property base as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "base", XMLPROJECTION = "ELEMENT");

Marks this as a profile of the base.


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

Name used to invoke the operation.

any FHIR3 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");

Additional information about use.

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

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");

Date this was last changed.

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

Natural language description of the operation definition.

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

For testing purposes, not real usage.

Property methods: experimentalDisplayToLogical(), experimentalGet(), experimentalIsValid(), experimentalLogicalToDisplay(), experimentalLogicalToXSD(), experimentalNormalize(), experimentalSet(), experimentalXSDToLogical()
property idempotent as %Boolean (XMLNAME = "idempotent", XMLPROJECTION = "ATTRIBUTE");

Whether content is unchanged by the operation.

Property methods: idempotentDisplayToLogical(), idempotentGet(), idempotentIsValid(), idempotentLogicalToDisplay(), idempotentLogicalToXSD(), idempotentNormalize(), idempotentSet(), idempotentXSDToLogical()
property instance as %Boolean (XMLNAME = "instance", XMLPROJECTION = "ATTRIBUTE") [ Required ];

Invoke on an instance?

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

Intended jurisdiction for operation definition (if applicable)

jurisdiction is the REQUIRED FHIR3 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 ];

operation | query

operation-kind is the REQUIRED FHIR3 ValueSet for codes; you may NOT extend operation-kind 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 ];

Name for this operation definition (computer friendly)

Property methods: nameDisplayToLogical(), nameGet(), nameIsValid(), nameLogicalToDisplay(), nameLogicalToOdbc(), nameNormalize(), nameSet()
property overload as list of HS.FHIR.DTL.vSTU3.Model.Element.OperationDefinition.overload (XMLNAME = "overload", XMLPROJECTION = "ELEMENT");

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.vSTU3.Model.Element.OperationDefinition.parameter (XMLNAME = "parameter", XMLPROJECTION = "ELEMENT");

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");

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");

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");

Types this operation applies to.

resource-types is the REQUIRED FHIR3 ValueSet for codes; you may NOT extend resource-types 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 ];

draft | active | retired | unknown

publication-status is the REQUIRED FHIR3 ValueSet for codes; you may NOT extend publication-status 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 ];

Invoke at the system level?

Property methods: systemDisplayToLogical(), systemGet(), systemIsValid(), systemLogicalToDisplay(), systemLogicalToXSD(), systemNormalize(), systemSet(), systemXSDToLogical()
property type as %Boolean (XMLNAME = "type", XMLPROJECTION = "ATTRIBUTE") [ Required ];

Invole at the type level?

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

Logical URI to reference this operation definition (globally unique)

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

Context 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");

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