Skip to main content

HS.FHIR.vSTU3.Model.Resource.CapabilityStatement.Resource

deprecated class HS.FHIR.vSTU3.Model.Resource.CapabilityStatement.Resource extends HS.FHIR.vSTU3.Model.Base.BackboneElement

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.

Property Inventory

Method 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 JSONTYPEFIELD;
Inherited description: Type property name for JSON export.
parameter XMLNAME = CapabilityStatement.Resource;
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 = CapabilityStatement.Resource;
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 conditionalCreate as HS.FHIR.vSTU3.Model.Datatype.Boolean (XMLNAME = "conditionalCreate", XMLPROJECTION = "ELEMENT");
A flag that indicates that the server supports conditional create.
Property methods: conditionalCreateGet(), conditionalCreateGetSwizzled(), conditionalCreateIsValid(), conditionalCreateNewObject(), conditionalCreateSet()
property conditionalDelete as HS.FHIR.vSTU3.Model.Base.ConditionalDeleteStatus (XMLNAME = "conditionalDelete", XMLPROJECTION = "ELEMENT");
A code that indicates how the server supports conditional delete.
Property methods: conditionalDeleteGet(), conditionalDeleteGetSwizzled(), conditionalDeleteIsValid(), conditionalDeleteNewObject(), conditionalDeleteSet()
property conditionalRead as HS.FHIR.vSTU3.Model.Base.ConditionalReadStatus (XMLNAME = "conditionalRead", XMLPROJECTION = "ELEMENT");
A code that indicates how the server supports conditional read.
Property methods: conditionalReadGet(), conditionalReadGetSwizzled(), conditionalReadIsValid(), conditionalReadNewObject(), conditionalReadSet()
property conditionalUpdate as HS.FHIR.vSTU3.Model.Datatype.Boolean (XMLNAME = "conditionalUpdate", XMLPROJECTION = "ELEMENT");
A flag that indicates that the server supports conditional update.
Property methods: conditionalUpdateGet(), conditionalUpdateGetSwizzled(), conditionalUpdateIsValid(), conditionalUpdateNewObject(), conditionalUpdateSet()
property documentation as HS.FHIR.vSTU3.Model.Datatype.Markdown (XMLNAME = "documentation", XMLPROJECTION = "ELEMENT");
Additional information about the resource type used by the system.
Property methods: documentationGet(), documentationGetSwizzled(), documentationIsValid(), documentationNewObject(), documentationSet()
property interaction as list of HS.FHIR.vSTU3.Model.Resource.CapabilityStatement.Interaction (XMLNAME = "interaction", XMLPROJECTION = "ELEMENT");
Identifies a restful operation supported by the solution.
Property methods: interactionBuildValueArray(), interactionCollectionToDisplay(), interactionCollectionToOdbc(), interactionDisplayToCollection(), interactionGet(), interactionGetObject(), interactionGetObjectId(), interactionGetSwizzled(), interactionIsValid(), interactionOdbcToCollection(), interactionSet(), interactionSetObject(), interactionSetObjectId()
property profile as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "profile", XMLPROJECTION = "ELEMENT");
A specification of the profile that describes the solution's overall support for the resource, including any constraints on cardinality, bindings, lengths or other limitations. See further discussion in [Using Profiles](profiling.html#profile-uses).
Property methods: profileGet(), profileGetSwizzled(), profileIsValid(), profileNewObject(), profileSet()
property readHistory as HS.FHIR.vSTU3.Model.Datatype.Boolean (XMLNAME = "readHistory", XMLPROJECTION = "ELEMENT");
A flag for whether the server is able to return past versions as part of the vRead operation.
Property methods: readHistoryGet(), readHistoryGetSwizzled(), readHistoryIsValid(), readHistoryNewObject(), readHistorySet()
property referencePolicy as list of HS.FHIR.vSTU3.Model.Base.ReferenceHandlingPolicy (XMLNAME = "referencePolicy", XMLPROJECTION = "ELEMENT");
A set of flags that defines how references are supported.
Property methods: referencePolicyBuildValueArray(), referencePolicyCollectionToDisplay(), referencePolicyCollectionToOdbc(), referencePolicyDisplayToCollection(), referencePolicyGet(), referencePolicyGetObject(), referencePolicyGetObjectId(), referencePolicyGetSwizzled(), referencePolicyIsValid(), referencePolicyOdbcToCollection(), referencePolicySet(), referencePolicySetObject(), referencePolicySetObjectId()
property searchInclude as list of HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "searchInclude", XMLPROJECTION = "ELEMENT");
A list of _include values supported by the server.
Property methods: searchIncludeBuildValueArray(), searchIncludeCollectionToDisplay(), searchIncludeCollectionToOdbc(), searchIncludeDisplayToCollection(), searchIncludeGet(), searchIncludeGetObject(), searchIncludeGetObjectId(), searchIncludeGetSwizzled(), searchIncludeIsValid(), searchIncludeOdbcToCollection(), searchIncludeSet(), searchIncludeSetObject(), searchIncludeSetObjectId()
property searchParam as list of HS.FHIR.vSTU3.Model.Resource.CapabilityStatement.SearchParam (XMLNAME = "searchParam", XMLPROJECTION = "ELEMENT");
Search parameters for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementation.
Property methods: searchParamBuildValueArray(), searchParamCollectionToDisplay(), searchParamCollectionToOdbc(), searchParamDisplayToCollection(), searchParamGet(), searchParamGetObject(), searchParamGetObjectId(), searchParamGetSwizzled(), searchParamIsValid(), searchParamOdbcToCollection(), searchParamSet(), searchParamSetObject(), searchParamSetObjectId()
property searchRevInclude as list of HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "searchRevInclude", XMLPROJECTION = "ELEMENT");
A list of _revinclude (reverse include) values supported by the server.
Property methods: searchRevIncludeBuildValueArray(), searchRevIncludeCollectionToDisplay(), searchRevIncludeCollectionToOdbc(), searchRevIncludeDisplayToCollection(), searchRevIncludeGet(), searchRevIncludeGetObject(), searchRevIncludeGetObjectId(), searchRevIncludeGetSwizzled(), searchRevIncludeIsValid(), searchRevIncludeOdbcToCollection(), searchRevIncludeSet(), searchRevIncludeSetObject(), searchRevIncludeSetObjectId()
property type as HS.FHIR.vSTU3.Model.Base.ResourceType (XMLNAME = "type", XMLPROJECTION = "ELEMENT") [ Required ];
A type of resource exposed via the restful interface.
Property methods: typeGet(), typeGetSwizzled(), typeIsValid(), typeNewObject(), typeSet()
property updateCreate as HS.FHIR.vSTU3.Model.Datatype.Boolean (XMLNAME = "updateCreate", XMLPROJECTION = "ELEMENT");
A flag to indicate that the server allows or needs to allow the client to create new identities on the server (e.g. that is, the client PUTs to a location where there is no existing resource). Allowing this operation means that the server allows the client to create new identities on the server.
Property methods: updateCreateGet(), updateCreateGetSwizzled(), updateCreateIsValid(), updateCreateNewObject(), updateCreateSet()
property versioning as HS.FHIR.vSTU3.Model.Base.ResourceVersionPolicy (XMLNAME = "versioning", XMLPROJECTION = "ELEMENT");
This field is set to no-version to specify that the system does not support (server) or use (client) versioning for this resource type. If this has some other value, the server must at least correctly track and populate the versionId meta-property on resources. If the value is 'versioned-update', then the server supports all the versioning features, including using e-tags for version integrity in the API.
Property methods: versioningGet(), versioningGetSwizzled(), versioningIsValid(), versioningNewObject(), versioningSet()

Methods

deprecated method SetConditionalCreate(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 "conditionalCreate" property.
deprecated method SetConditionalDelete(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 "conditionalDelete" property.
deprecated method SetConditionalRead(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 "conditionalRead" property.
deprecated method SetConditionalUpdate(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 "conditionalUpdate" property.
deprecated method SetDocumentation(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 "documentation" property.
deprecated method SetProfile(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 "profile" property.
deprecated method SetReadHistory(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 "readHistory" property.
deprecated method SetReferencePolicy(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 "referencePolicy" property.
deprecated method SetSearchInclude(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 "searchInclude" property.
deprecated method SetSearchRevInclude(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 "searchRevInclude" 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.
deprecated method SetUpdateCreate(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 "updateCreate" property.
deprecated method SetVersioning(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 "versioning" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab