HS.FHIR.vSTU3.Model.Resource.OperationDefinition
deprecated class HS.FHIR.vSTU3.Model.Resource.OperationDefinition extends HS.FHIR.vSTU3.Model.Base.DomainResource
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.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
Property Inventory
- base
- code
- comment
- contact
- date
- description
- experimental
- idempotent
- instance
- jurisdiction
- kind
- name
- overload
- parameter
- publisher
- purpose
- resource
- status
- system
- type
- url
- useContext
- version
Method Inventory
- SetBase()
- SetCode()
- SetComment()
- SetDate()
- SetDescription()
- SetExperimental()
- SetIdempotent()
- SetInstance()
- SetJurisdiction()
- SetKind()
- SetName()
- SetPublisher()
- SetPurpose()
- SetResource()
- SetStatus()
- SetSystem()
- SetType()
- SetUrl()
- SetVersion()
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 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.
Properties
property base as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "base", XMLPROJECTION = "ELEMENT");
Indicates that this operation definition is a constraining profile on the base.
Property methods: baseGet(), baseGetSwizzled(), baseIsValid(), baseNewObject(), baseSet()
property code as HS.FHIR.vSTU3.Model.Datatype.Code (XMLNAME = "code", XMLPROJECTION = "ELEMENT") [ Required ];
The name used to invoke the operation.
Property methods: codeGet(), codeGetSwizzled(), codeIsValid(), codeNewObject(), codeSet()
property comment as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "comment", XMLPROJECTION = "ELEMENT");
Additional information about how to use this operation or named query.
Property methods: commentGet(), commentGetSwizzled(), commentIsValid(), commentNewObject(), commentSet()
property contact as list of HS.FHIR.vSTU3.Model.Base.ContactDetail (XMLNAME = "contact", XMLPROJECTION = "ELEMENT");
Contact details to assist a user in finding and communicating with the publisher.
Property methods: contactBuildValueArray(), contactCollectionToDisplay(), contactCollectionToOdbc(), contactDisplayToCollection(), contactGet(), contactGetObject(), contactGetObjectId(), contactGetSwizzled(), contactIsValid(), contactOdbcToCollection(), contactSet(), contactSetObject(), contactSetObjectId()
property date as HS.FHIR.vSTU3.Model.Datatype.DateTime (XMLNAME = "date", XMLPROJECTION = "ELEMENT");
The date (and optionally time) when the operation definition was published. The date must change if and 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: dateGet(), dateGetSwizzled(), dateIsValid(), dateNewObject(), dateSet()
property description as HS.FHIR.vSTU3.Model.Datatype.Markdown (XMLNAME = "description", XMLPROJECTION = "ELEMENT");
A free text natural language description of the operation definition from a consumer's perspective.
Property methods: descriptionGet(), descriptionGetSwizzled(), descriptionIsValid(), descriptionNewObject(), descriptionSet()
property experimental as HS.FHIR.vSTU3.Model.Datatype.Boolean (XMLNAME = "experimental", XMLPROJECTION = "ELEMENT");
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: experimentalGet(), experimentalGetSwizzled(), experimentalIsValid(), experimentalNewObject(), experimentalSet()
property idempotent as HS.FHIR.vSTU3.Model.Datatype.Boolean (XMLNAME = "idempotent", XMLPROJECTION = "ELEMENT");
Operations that are idempotent (see [HTTP specification definition of idempotent](http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html)) may be invoked by performing an HTTP GET operation instead of a POST.
Property methods: idempotentGet(), idempotentGetSwizzled(), idempotentIsValid(), idempotentNewObject(), idempotentSet()
property instance as HS.FHIR.vSTU3.Model.Datatype.Boolean (XMLNAME = "instance", XMLPROJECTION = "ELEMENT") [ Required ];
Indicates whether this operation can be invoked on a particular instance of one of the given types.
Property methods: instanceGet(), instanceGetSwizzled(), instanceIsValid(), instanceNewObject(), instanceSet()
property jurisdiction as list of HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "jurisdiction", XMLPROJECTION = "ELEMENT");
A legal or geographic region in which the operation definition is intended to be used.
Property methods: jurisdictionBuildValueArray(), jurisdictionCollectionToDisplay(), jurisdictionCollectionToOdbc(), jurisdictionDisplayToCollection(), jurisdictionGet(), jurisdictionGetObject(), jurisdictionGetObjectId(), jurisdictionGetSwizzled(), jurisdictionIsValid(), jurisdictionOdbcToCollection(), jurisdictionSet(), jurisdictionSetObject(), jurisdictionSetObjectId()
property kind as HS.FHIR.vSTU3.Model.Base.OperationKind (XMLNAME = "kind", XMLPROJECTION = "ELEMENT") [ Required ];
Whether this is an operation or a named query.
Property methods: kindGet(), kindGetSwizzled(), kindIsValid(), kindNewObject(), kindSet()
property name as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "name", XMLPROJECTION = "ELEMENT") [ Required ];
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: nameGet(), nameGetSwizzled(), nameIsValid(), nameNewObject(), nameSet()
property overload as list of HS.FHIR.vSTU3.Model.Resource.OperationDefinition.Overload (XMLNAME = "overload", XMLPROJECTION = "ELEMENT");
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: overloadBuildValueArray(), overloadCollectionToDisplay(), overloadCollectionToOdbc(), overloadDisplayToCollection(), overloadGet(), overloadGetObject(), overloadGetObjectId(), overloadGetSwizzled(), overloadIsValid(), overloadOdbcToCollection(), overloadSet(), overloadSetObject(), overloadSetObjectId()
property parameter as list of HS.FHIR.vSTU3.Model.Resource.OperationDefinition.Parameter (XMLNAME = "parameter", XMLPROJECTION = "ELEMENT");
The parameters for the operation/query.
Property methods: parameterBuildValueArray(), parameterCollectionToDisplay(), parameterCollectionToOdbc(), parameterDisplayToCollection(), parameterGet(), parameterGetObject(), parameterGetObjectId(), parameterGetSwizzled(), parameterIsValid(), parameterOdbcToCollection(), parameterSet(), parameterSetObject(), parameterSetObjectId()
property publisher as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "publisher", XMLPROJECTION = "ELEMENT");
The name of the individual or organization that published the operation definition.
Property methods: publisherGet(), publisherGetSwizzled(), publisherIsValid(), publisherNewObject(), publisherSet()
property purpose as HS.FHIR.vSTU3.Model.Datatype.Markdown (XMLNAME = "purpose", XMLPROJECTION = "ELEMENT");
Explaination of why this operation definition is needed and why it has been designed as it has.
Property methods: purposeGet(), purposeGetSwizzled(), purposeIsValid(), purposeNewObject(), purposeSet()
property resource as list of HS.FHIR.vSTU3.Model.Base.ResourceType (XMLNAME = "resource", XMLPROJECTION = "ELEMENT");
The types on which this operation can be executed.
Property methods: resourceBuildValueArray(), resourceCollectionToDisplay(), resourceCollectionToOdbc(), resourceDisplayToCollection(), resourceGet(), resourceGetObject(), resourceGetObjectId(), resourceGetSwizzled(), resourceIsValid(), resourceOdbcToCollection(), resourceSet(), resourceSetObject(), resourceSetObjectId()
property status as HS.FHIR.vSTU3.Model.Base.PublicationStatus (XMLNAME = "status", XMLPROJECTION = "ELEMENT") [ Required ];
The status of this operation definition. Enables tracking the life-cycle of the content.
Property methods: statusGet(), statusGetSwizzled(), statusIsValid(), statusNewObject(), statusSet()
property system as HS.FHIR.vSTU3.Model.Datatype.Boolean (XMLNAME = "system", XMLPROJECTION = "ELEMENT") [ Required ];
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: systemGet(), systemGetSwizzled(), systemIsValid(), systemNewObject(), systemSet()
property type as HS.FHIR.vSTU3.Model.Datatype.Boolean (XMLNAME = "type", XMLPROJECTION = "ELEMENT") [ Required ];
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: typeGet(), typeGetSwizzled(), typeIsValid(), typeNewObject(), typeSet()
property url as HS.FHIR.vSTU3.Model.Datatype.Uri (XMLNAME = "url", XMLPROJECTION = "ELEMENT");
An absolute URI that is used to identify this operation definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this operation definition is (or will be) published. The URL SHOULD include the major version of the operation definition. For more information see [Technical and Business Versions](resource.html#versions).
Property methods: urlGet(), urlGetSwizzled(), urlIsValid(), urlNewObject(), urlSet()
property useContext as list of HS.FHIR.vSTU3.Model.Base.UsageContext (XMLNAME = "useContext", XMLPROJECTION = "ELEMENT");
The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate operation definition instances.
Property methods: useContextBuildValueArray(), useContextCollectionToDisplay(), useContextCollectionToOdbc(), useContextDisplayToCollection(), useContextGet(), useContextGetObject(), useContextGetObjectId(), useContextGetSwizzled(), useContextIsValid(), useContextOdbcToCollection(), useContextSet(), useContextSetObject(), useContextSetObjectId()
property version as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "version", XMLPROJECTION = "ELEMENT");
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: versionGet(), versionGetSwizzled(), versionIsValid(), versionNewObject(), versionSet()
Methods
deprecated method SetBase(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "base" property.
Set method for the "base" property.
deprecated method SetCode(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "code" property.
Set method for the "code" property.
deprecated method SetComment(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "comment" property.
Set method for the "comment" property.
deprecated method SetDate(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "date" property.
Set method for the "date" property.
deprecated method SetDescription(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "description" property.
Set method for the "description" property.
deprecated method SetExperimental(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "experimental" property.
Set method for the "experimental" property.
deprecated method SetIdempotent(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "idempotent" property.
Set method for the "idempotent" property.
deprecated method SetInstance(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "instance" property.
Set method for the "instance" property.
deprecated method SetJurisdiction(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "jurisdiction" property.
Insert method for the "jurisdiction" property.
deprecated method SetKind(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "kind" property.
Set method for the "kind" property.
deprecated method SetName(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "name" property.
Set method for the "name" property.
deprecated method SetPublisher(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "publisher" property.
Set method for the "publisher" property.
deprecated method SetPurpose(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "purpose" property.
Set method for the "purpose" property.
deprecated method SetResource(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "resource" property.
Insert method for the "resource" property.
deprecated method SetStatus(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "status" property.
Set method for the "status" property.
deprecated method SetSystem(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "system" property.
Set method for the "system" property.
deprecated method SetType(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "type" property.
Set method for the "type" property.
deprecated method SetUrl(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "url" property.
Set method for the "url" property.
deprecated method SetVersion(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "version" property.
Set method for the "version" property.
Inherited Members
Inherited Properties
Inherited Methods
- %AddToSaveSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %CreateProxy()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %FHIRObjectHasValue()
- %FromFHIRJSON()
- %FromFHIRXML()
- %GetClassName()
- %GetJSONType()
- %GetParameter()
- %IsA()
- %IsModified()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %SerializeObject()
- %SetModified()
- %ToFHIRJSON()
- %ToFHIRXML()
- %ValidateObject()
- GetReferenceMap()
- SetContained()
- SetId()
- SetImplicitRules()
- SetLanguage()
- SetText()
- UpdateReferences()
- XMLDTD()
- XMLExport()
- XMLExportToStream()
- XMLExportToString()
- XMLNew()
- XMLSchema()
- XMLSchemaNamespace()
- XMLSchemaType()