Skip to main content

HS.FHIR.DTL.vDSTU2.Model.Resource.OperationDefinition

class HS.FHIR.DTL.vDSTU2.Model.Resource.OperationDefinition extends HS.FHIR.DTL.vDSTU2.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 base as HS.FHIR.DTL.vDSTU2.Model.Base.Reference (XMLNAME = "base", XMLPROJECTION = "ELEMENT");
Reference

Marks this as a profile of the base.

OperationDefinition

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

Name used to invoke the operation.

any FHIR2 code from any ValueSet may be used.

Property methods: codeDisplayToLogical(), codeGet(), codeIsValid(), codeLogicalToDisplay(), codeLogicalToOdbc(), codeNormalize(), codeSet()
property contact as list of HS.FHIR.DTL.vDSTU2.Model.Element.OperationDefinition.contact (XMLNAME = "contact", XMLPROJECTION = "ELEMENT");
BackboneElement

Contact details of 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 for this version of the operation definition.

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

Natural language description of the operation.

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

If for testing purposes, not real usage.

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

Whether content is unchanged by operation.

Property methods: idempotentDisplayToLogical(), idempotentGet(), idempotentIsValid(), idempotentLogicalToDisplay(), idempotentLogicalToXSD(), idempotentNormalize(), idempotentSet(), idempotentXSDToLogical()
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 kind as %String (MAXLEN = 1000000, XMLNAME = "kind", XMLPROJECTION = "ATTRIBUTE") [ Required ];
code

operation | query

operation-kind is the REQUIRED FHIR2 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 ];
string

Informal name for this operation.

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

Additional information about use.

Property methods: notesDisplayToLogical(), notesGet(), notesIsValid(), notesLogicalToDisplay(), notesLogicalToOdbc(), notesNormalize(), notesSet()
property parameter as list of HS.FHIR.DTL.vDSTU2.Model.Element.OperationDefinition.parameter (XMLNAME = "parameter", XMLPROJECTION = "ELEMENT");
BackboneElement

Parameters for the operation/query. Each member of the OperationDefinition:parameter collection must have OperationDefinition:parameter[n].type or OperationDefinition:parameter[n].parts, but not both.

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 requirements as %String (MAXLEN = 1000000, XMLNAME = "requirements", XMLPROJECTION = "ATTRIBUTE");
string

Why is this needed?

Property methods: requirementsDisplayToLogical(), requirementsGet(), requirementsIsValid(), requirementsLogicalToDisplay(), requirementsLogicalToOdbc(), requirementsNormalize(), requirementsSet()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE") [ Required ];
code

draft | active | retired

conformance-resource-status is the REQUIRED FHIR2 ValueSet for codes; you may NOT extend conformance-resource-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 ];
boolean

Invoke at the system level?

Property methods: systemDisplayToLogical(), systemGet(), systemIsValid(), systemLogicalToDisplay(), systemLogicalToXSD(), systemNormalize(), systemSet(), systemXSDToLogical()
property type as list of %String (MAXLEN = 1000000, XMLNAME = "type", XMLPROJECTION = "ELEMENT");
code

Invoke at resource level for these type.

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

Property methods: typeBuildValueArray(), typeCollectionToDisplay(), typeCollectionToOdbc(), typeDisplayToCollection(), typeDisplayToLogical(), typeGet(), typeGetObject(), typeGetObjectId(), typeGetSwizzled(), typeIsValid(), typeLogicalToDisplay(), typeLogicalToOdbc(), typeNormalize(), typeOdbcToCollection(), typeSet(), typeSetObject(), typeSetObjectId()
property url as %String (MAXLEN = 1000000, XMLNAME = "url", XMLPROJECTION = "ATTRIBUTE");
uri

Logical URL to reference this operation definition.

Property methods: urlDisplayToLogical(), urlGet(), urlIsValid(), urlLogicalToDisplay(), urlLogicalToOdbc(), urlNormalize(), urlSet()
property version as %String (MAXLEN = 1000000, XMLNAME = "version", XMLPROJECTION = "ATTRIBUTE");
string

Logical id for this 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