Skip to main content

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

deprecated class HS.FHIR.vSTU3.Model.Resource.CapabilityStatement.Rest 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.Rest;
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.Rest;
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 compartment as list of HS.FHIR.vSTU3.Model.Datatype.Uri (XMLNAME = "compartment", XMLPROJECTION = "ELEMENT");
An absolute URI which is a reference to the definition of a compartment that the system supports. The reference is to a CompartmentDefinition resource by its canonical URL .
Property methods: compartmentBuildValueArray(), compartmentCollectionToDisplay(), compartmentCollectionToOdbc(), compartmentDisplayToCollection(), compartmentGet(), compartmentGetObject(), compartmentGetObjectId(), compartmentGetSwizzled(), compartmentIsValid(), compartmentOdbcToCollection(), compartmentSet(), compartmentSetObject(), compartmentSetObjectId()
property documentation as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "documentation", XMLPROJECTION = "ELEMENT");
Information about the system's restful capabilities that apply across all applications, such as security.
Property methods: documentationGet(), documentationGetSwizzled(), documentationIsValid(), documentationNewObject(), documentationSet()
property interaction as list of HS.FHIR.vSTU3.Model.Resource.CapabilityStatement.Interaction1 (XMLNAME = "interaction", XMLPROJECTION = "ELEMENT");
A specification of restful operations supported by the system.
Property methods: interactionBuildValueArray(), interactionCollectionToDisplay(), interactionCollectionToOdbc(), interactionDisplayToCollection(), interactionGet(), interactionGetObject(), interactionGetObjectId(), interactionGetSwizzled(), interactionIsValid(), interactionOdbcToCollection(), interactionSet(), interactionSetObject(), interactionSetObjectId()
property mode as HS.FHIR.vSTU3.Model.Base.RestfulCapabilityMode (XMLNAME = "mode", XMLPROJECTION = "ELEMENT") [ Required ];
Identifies whether this portion of the statement is describing the ability to initiate or receive restful operations.
Property methods: modeGet(), modeGetSwizzled(), modeIsValid(), modeNewObject(), modeSet()
property operation as list of HS.FHIR.vSTU3.Model.Resource.CapabilityStatement.Operation (XMLNAME = "operation", XMLPROJECTION = "ELEMENT");
Definition of an operation or a named query together with its parameters and their meaning and type.
Property methods: operationBuildValueArray(), operationCollectionToDisplay(), operationCollectionToOdbc(), operationDisplayToCollection(), operationGet(), operationGetObject(), operationGetObjectId(), operationGetSwizzled(), operationIsValid(), operationOdbcToCollection(), operationSet(), operationSetObject(), operationSetObjectId()
property resource as list of HS.FHIR.vSTU3.Model.Resource.CapabilityStatement.Resource (XMLNAME = "resource", XMLPROJECTION = "ELEMENT");
A specification of the restful capabilities of the solution for a specific resource type.
Property methods: resourceBuildValueArray(), resourceCollectionToDisplay(), resourceCollectionToOdbc(), resourceDisplayToCollection(), resourceGet(), resourceGetObject(), resourceGetObjectId(), resourceGetSwizzled(), resourceIsValid(), resourceOdbcToCollection(), resourceSet(), resourceSetObject(), resourceSetObjectId()
property searchParam as list of HS.FHIR.vSTU3.Model.Resource.CapabilityStatement.SearchParam (XMLNAME = "searchParam", XMLPROJECTION = "ELEMENT");
Search parameters that are supported for searching all resources 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 security as HS.FHIR.vSTU3.Model.Resource.CapabilityStatement.Security (XMLNAME = "security", XMLPROJECTION = "ELEMENT");
Information about security implementation from an interface perspective - what a client needs to know.
Property methods: securityGet(), securityGetSwizzled(), securityIsValid(), securityNewObject(), securitySet()

Methods

deprecated method SetCompartment(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 "compartment" 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 SetMode(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 "mode" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab