Skip to main content

HS.FHIRModel.R4.CapabilityStatementX.Resource

class HS.FHIRModel.R4.CapabilityStatementX.Resource extends HS.FHIRModel.FHIRClassSuper

*****************************************
** CapabilityStatementX.Resource generated class schema
*****************************************
A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server for a particular version of FHIR 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 XMLTYPE = R4_CAPABILITYSTATEMENTX_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.FHIRModel.R4.Element;
Extensions for conditionalCreate
Property methods: _conditionalCreateGet(), _conditionalCreateGetSwizzled(), _conditionalCreateIsValid(), _conditionalCreateNewObject(), _conditionalCreateSet()
property _conditionalDelete as HS.FHIRModel.R4.Element;
Extensions for conditionalDelete
Property methods: _conditionalDeleteGet(), _conditionalDeleteGetSwizzled(), _conditionalDeleteIsValid(), _conditionalDeleteNewObject(), _conditionalDeleteSet()
property _conditionalRead as HS.FHIRModel.R4.Element;
Extensions for conditionalRead
Property methods: _conditionalReadGet(), _conditionalReadGetSwizzled(), _conditionalReadIsValid(), _conditionalReadNewObject(), _conditionalReadSet()
property _conditionalUpdate as HS.FHIRModel.R4.Element;
Extensions for conditionalUpdate
Property methods: _conditionalUpdateGet(), _conditionalUpdateGetSwizzled(), _conditionalUpdateIsValid(), _conditionalUpdateNewObject(), _conditionalUpdateSet()
property _documentation as HS.FHIRModel.R4.Element;
Extensions for documentation
Property methods: _documentationGet(), _documentationGetSwizzled(), _documentationIsValid(), _documentationNewObject(), _documentationSet()
property _readHistory as HS.FHIRModel.R4.Element;
Extensions for readHistory
Property methods: _readHistoryGet(), _readHistoryGetSwizzled(), _readHistoryIsValid(), _readHistoryNewObject(), _readHistorySet()
property _referencePolicy as HS.FHIRModel.R4.SeqOfElement;
Extensions for referencePolicy
Property methods: _referencePolicyGet(), _referencePolicyGetSwizzled(), _referencePolicyIsValid(), _referencePolicyNewObject(), _referencePolicySet()
property _searchInclude as HS.FHIRModel.R4.SeqOfElement;
Extensions for searchInclude
Property methods: _searchIncludeGet(), _searchIncludeGetSwizzled(), _searchIncludeIsValid(), _searchIncludeNewObject(), _searchIncludeSet()
property _searchRevInclude as HS.FHIRModel.R4.SeqOfElement;
Extensions for searchRevInclude
Property methods: _searchRevIncludeGet(), _searchRevIncludeGetSwizzled(), _searchRevIncludeIsValid(), _searchRevIncludeNewObject(), _searchRevIncludeSet()
property _type as HS.FHIRModel.R4.Element;
Extensions for type
Property methods: _typeGet(), _typeGetSwizzled(), _typeIsValid(), _typeNewObject(), _typeSet()
property _updateCreate as HS.FHIRModel.R4.Element;
Extensions for updateCreate
Property methods: _updateCreateGet(), _updateCreateGetSwizzled(), _updateCreateIsValid(), _updateCreateNewObject(), _updateCreateSet()
property _versioning as HS.FHIRModel.R4.Element;
Extensions for versioning
Property methods: _versioningGet(), _versioningGetSwizzled(), _versioningIsValid(), _versioningNewObject(), _versioningSet()
property conditionalCreate as %Boolean;
A flag that indicates that the server supports conditional create.
Property methods: conditionalCreateDisplayToLogical(), conditionalCreateGet(), conditionalCreateIsValid(), conditionalCreateLogicalToDisplay(), conditionalCreateLogicalToXSD(), conditionalCreateNormalize(), conditionalCreateSet(), conditionalCreateXSDToLogical()
property conditionalDelete as %String (VALUELIST = ",not-supported,single,multiple");
A code that indicates how the server supports conditional delete.
Property methods: conditionalDeleteDisplayToLogical(), conditionalDeleteGet(), conditionalDeleteIsValid(), conditionalDeleteLogicalToDisplay(), conditionalDeleteLogicalToOdbc(), conditionalDeleteNormalize(), conditionalDeleteSet()
property conditionalRead as %String (VALUELIST = ",not-supported,modified-since,not-match,full-support");
A code that indicates how the server supports conditional read.
Property methods: conditionalReadDisplayToLogical(), conditionalReadGet(), conditionalReadIsValid(), conditionalReadLogicalToDisplay(), conditionalReadLogicalToOdbc(), conditionalReadNormalize(), conditionalReadSet()
property conditionalUpdate as %Boolean;
A flag that indicates that the server supports conditional update.
Property methods: conditionalUpdateDisplayToLogical(), conditionalUpdateGet(), conditionalUpdateIsValid(), conditionalUpdateLogicalToDisplay(), conditionalUpdateLogicalToXSD(), conditionalUpdateNormalize(), conditionalUpdateSet(), conditionalUpdateXSDToLogical()
property documentation as %String;
Additional information about the resource type used by the system.
Property methods: documentationDisplayToLogical(), documentationGet(), documentationIsValid(), documentationLogicalToDisplay(), documentationLogicalToOdbc(), documentationNormalize(), documentationSet()
property extension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Property methods: extensionGet(), extensionGetSwizzled(), extensionIsValid(), extensionNewObject(), extensionSet()
property fhirID as %String;
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Property methods: fhirIDDisplayToLogical(), fhirIDGet(), fhirIDIsValid(), fhirIDLogicalToDisplay(), fhirIDLogicalToOdbc(), fhirIDNormalize(), fhirIDSet()
Identifies a restful operation supported by the solution.
Property methods: interactionGet(), interactionGetSwizzled(), interactionIsValid(), interactionNewObject(), interactionSet()
property modifierExtension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Property methods: modifierExtensionGet(), modifierExtensionGetSwizzled(), modifierExtensionIsValid(), modifierExtensionNewObject(), modifierExtensionSet()
Definition of an operation or a named query together with its parameters and their meaning and type. Consult the definition of the operation for details about how to invoke the operation, and the parameters.
Property methods: operationGet(), operationGetSwizzled(), operationIsValid(), operationNewObject(), operationSet()
property profile as %String;
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: profileDisplayToLogical(), profileGet(), profileIsValid(), profileLogicalToDisplay(), profileLogicalToOdbc(), profileNormalize(), profileSet()
property readHistory as %Boolean;
A flag for whether the server is able to return past versions as part of the vRead operation.
Property methods: readHistoryDisplayToLogical(), readHistoryGet(), readHistoryIsValid(), readHistoryLogicalToDisplay(), readHistoryLogicalToXSD(), readHistoryNormalize(), readHistorySet(), readHistoryXSDToLogical()
property referencePolicy as %String (VALUELIST = ",literal,logical,resolves,enforced,local");
A set of flags that defines how references are supported.
Property methods: referencePolicyDisplayToLogical(), referencePolicyGet(), referencePolicyIsValid(), referencePolicyLogicalToDisplay(), referencePolicyLogicalToOdbc(), referencePolicyNormalize(), referencePolicySet()
property searchInclude as HS.FHIRModel.R4.SeqOfString;
A list of _include values supported by the server.
Property methods: searchIncludeGet(), searchIncludeGetSwizzled(), searchIncludeIsValid(), searchIncludeNewObject(), searchIncludeSet()
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: searchParamGet(), searchParamGetSwizzled(), searchParamIsValid(), searchParamNewObject(), searchParamSet()
property searchRevInclude as HS.FHIRModel.R4.SeqOfString;
A list of _revinclude (reverse include) values supported by the server.
Property methods: searchRevIncludeGet(), searchRevIncludeGetSwizzled(), searchRevIncludeIsValid(), searchRevIncludeNewObject(), searchRevIncludeSet()
property supportedProfile as HS.FHIRModel.R4.SeqOfString;
A list of profiles that represent different use cases supported by the system. For a server, "supported by the system" means the system hosts/produces a set of resources that are conformant to a particular profile, and allows clients that use its services to search using this profile and to find appropriate data. For a client, it means the system will search by this profile and process data according to the guidance implicit in the profile. See further discussion in [Using Profiles](profiling.html#profile-uses).
Property methods: supportedProfileGet(), supportedProfileGetSwizzled(), supportedProfileIsValid(), supportedProfileNewObject(), supportedProfileSet()
property type as %String;
A type of resource exposed via the restful interface.
Property methods: typeDisplayToLogical(), typeGet(), typeIsValid(), typeLogicalToDisplay(), typeLogicalToOdbc(), typeNormalize(), typeSet()
property updateCreate as %Boolean;
A flag to indicate that the server allows or needs to allow the client to create new identities on the server (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: updateCreateDisplayToLogical(), updateCreateGet(), updateCreateIsValid(), updateCreateLogicalToDisplay(), updateCreateLogicalToXSD(), updateCreateNormalize(), updateCreateSet(), updateCreateXSDToLogical()
property versioning as %String (VALUELIST = ",no-version,versioned,versioned-update");
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: versioningDisplayToLogical(), versioningGet(), versioningIsValid(), versioningLogicalToDisplay(), versioningLogicalToOdbc(), versioningNormalize(), versioningSet()

Methods

method IncludeExtension()
method IncludeInteraction()
method IncludeModifierExtension()
method IncludeOperation()
method IncludeSearchInclude()
method IncludeSearchParam()
method IncludeSearchRevInclude()
method IncludeSupportedProfile()
method _getProperties() as %DynamicArray
Inherited description: Return an array of the defined properties of this class in the definition order that they were discovered in the the HL7FHIR JSchema document
method toDao() as %DynamicAbstractObject
Inherited description: >

The toDao() method casts the set to a DAO.

Inherited Members

Inherited Methods

FeedbackOpens in a new tab