Skip to main content

HS.FHIR.DTL.vSTU3.Model.Element.CapabilityStatement.rest.resource

class HS.FHIR.DTL.vSTU3.Model.Element.CapabilityStatement.rest.resource extends HS.FHIR.DTL.vSTU3.Model.Base.BackboneElement

Resource served on the REST interface.

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 = CapabilityStatement.rest.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 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 = CapabilityStatement.rest.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 %Boolean (XMLNAME = "conditionalCreate", XMLPROJECTION = "ATTRIBUTE");
boolean

If allows/uses conditional create.

Property methods: conditionalCreateDisplayToLogical(), conditionalCreateGet(), conditionalCreateIsValid(), conditionalCreateLogicalToDisplay(), conditionalCreateLogicalToXSD(), conditionalCreateNormalize(), conditionalCreateSet(), conditionalCreateXSDToLogical()
property conditionalDelete as %String (MAXLEN = 1000000, XMLNAME = "conditionalDelete", XMLPROJECTION = "ATTRIBUTE");
code

not-supported | single | multiple - how conditional delete is supported

conditional-delete-status is the REQUIRED FHIR3 ValueSet for codes; you may NOT extend conditional-delete-status and you may NOT use codes from other ValueSets.

Property methods: conditionalDeleteDisplayToLogical(), conditionalDeleteGet(), conditionalDeleteIsValid(), conditionalDeleteLogicalToDisplay(), conditionalDeleteLogicalToOdbc(), conditionalDeleteNormalize(), conditionalDeleteSet()
property conditionalRead as %String (MAXLEN = 1000000, XMLNAME = "conditionalRead", XMLPROJECTION = "ATTRIBUTE");
code

not-supported | modified-since | not-match | full-support

conditional-read-status is the REQUIRED FHIR3 ValueSet for codes; you may NOT extend conditional-read-status and you may NOT use codes from other ValueSets.

Property methods: conditionalReadDisplayToLogical(), conditionalReadGet(), conditionalReadIsValid(), conditionalReadLogicalToDisplay(), conditionalReadLogicalToOdbc(), conditionalReadNormalize(), conditionalReadSet()
property conditionalUpdate as %Boolean (XMLNAME = "conditionalUpdate", XMLPROJECTION = "ATTRIBUTE");
boolean

If allows/uses conditional update.

Property methods: conditionalUpdateDisplayToLogical(), conditionalUpdateGet(), conditionalUpdateIsValid(), conditionalUpdateLogicalToDisplay(), conditionalUpdateLogicalToXSD(), conditionalUpdateNormalize(), conditionalUpdateSet(), conditionalUpdateXSDToLogical()
property documentation as %String (MAXLEN = 1000000, XMLNAME = "documentation", XMLPROJECTION = "ATTRIBUTE");
markdown

Additional information about the use of the resource type.

Property methods: documentationDisplayToLogical(), documentationGet(), documentationIsValid(), documentationLogicalToDisplay(), documentationLogicalToOdbc(), documentationNormalize(), documentationSet()
property interaction as list of HS.FHIR.DTL.vSTU3.Model.Element.CapabilityStatement.rest.resource.interaction (XMLNAME = "interaction", XMLPROJECTION = "ELEMENT") [ Required ];
BackboneElement

What operations are supported?

Property methods: interactionBuildValueArray(), interactionCollectionToDisplay(), interactionCollectionToOdbc(), interactionDisplayToCollection(), interactionGet(), interactionGetObject(), interactionGetObjectId(), interactionGetSwizzled(), interactionIsValid(), interactionOdbcToCollection(), interactionSet(), interactionSetObject(), interactionSetObjectId()
property profile as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "profile", XMLPROJECTION = "ELEMENT");
Reference

Base System profile for all uses of resource.

StructureDefinition

Property methods: profileGet(), profileGetSwizzled(), profileIsValid(), profileNewObject(), profileSet()
property readHistory as %Boolean (XMLNAME = "readHistory", XMLPROJECTION = "ATTRIBUTE");
boolean

Whether vRead can return past versions.

Property methods: readHistoryDisplayToLogical(), readHistoryGet(), readHistoryIsValid(), readHistoryLogicalToDisplay(), readHistoryLogicalToXSD(), readHistoryNormalize(), readHistorySet(), readHistoryXSDToLogical()
property referencePolicy as list of %String (MAXLEN = 1000000, XMLNAME = "referencePolicy", XMLPROJECTION = "ELEMENT");
code

literal | logical | resolves | enforced | local

reference-handling-policy is the REQUIRED FHIR3 ValueSet for codes; you may NOT extend reference-handling-policy and you may NOT use codes from other ValueSets.

Property methods: referencePolicyBuildValueArray(), referencePolicyCollectionToDisplay(), referencePolicyCollectionToOdbc(), referencePolicyDisplayToCollection(), referencePolicyDisplayToLogical(), referencePolicyGet(), referencePolicyGetObject(), referencePolicyGetObjectId(), referencePolicyGetSwizzled(), referencePolicyIsValid(), referencePolicyLogicalToDisplay(), referencePolicyLogicalToOdbc(), referencePolicyNormalize(), referencePolicyOdbcToCollection(), referencePolicySet(), referencePolicySetObject(), referencePolicySetObjectId()
property searchInclude as list of %String (MAXLEN = 1000000, XMLNAME = "searchInclude", XMLPROJECTION = "ELEMENT");
string

_include values supported by the server.

Property methods: searchIncludeBuildValueArray(), searchIncludeCollectionToDisplay(), searchIncludeCollectionToOdbc(), searchIncludeDisplayToCollection(), searchIncludeDisplayToLogical(), searchIncludeGet(), searchIncludeGetObject(), searchIncludeGetObjectId(), searchIncludeGetSwizzled(), searchIncludeIsValid(), searchIncludeLogicalToDisplay(), searchIncludeLogicalToOdbc(), searchIncludeNormalize(), searchIncludeOdbcToCollection(), searchIncludeSet(), searchIncludeSetObject(), searchIncludeSetObjectId()
property searchParam as list of HS.FHIR.DTL.vSTU3.Model.Element.CapabilityStatement.rest.resource.searchParam (XMLNAME = "searchParam", XMLPROJECTION = "ELEMENT");
BackboneElement

Search parameters supported by implementation.

Property methods: searchParamBuildValueArray(), searchParamCollectionToDisplay(), searchParamCollectionToOdbc(), searchParamDisplayToCollection(), searchParamGet(), searchParamGetObject(), searchParamGetObjectId(), searchParamGetSwizzled(), searchParamIsValid(), searchParamOdbcToCollection(), searchParamSet(), searchParamSetObject(), searchParamSetObjectId()
property searchRevInclude as list of %String (MAXLEN = 1000000, XMLNAME = "searchRevInclude", XMLPROJECTION = "ELEMENT");
string

_revinclude values supported by the server.

Property methods: searchRevIncludeBuildValueArray(), searchRevIncludeCollectionToDisplay(), searchRevIncludeCollectionToOdbc(), searchRevIncludeDisplayToCollection(), searchRevIncludeDisplayToLogical(), searchRevIncludeGet(), searchRevIncludeGetObject(), searchRevIncludeGetObjectId(), searchRevIncludeGetSwizzled(), searchRevIncludeIsValid(), searchRevIncludeLogicalToDisplay(), searchRevIncludeLogicalToOdbc(), searchRevIncludeNormalize(), searchRevIncludeOdbcToCollection(), searchRevIncludeSet(), searchRevIncludeSetObject(), searchRevIncludeSetObjectId()
property type as %String (MAXLEN = 1000000, XMLNAME = "type", XMLPROJECTION = "ATTRIBUTE") [ Required ];
code

A resource type that is supported.

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

Property methods: typeDisplayToLogical(), typeGet(), typeIsValid(), typeLogicalToDisplay(), typeLogicalToOdbc(), typeNormalize(), typeSet()
property updateCreate as %Boolean (XMLNAME = "updateCreate", XMLPROJECTION = "ATTRIBUTE");
boolean

If update can commit to a new identity.

Property methods: updateCreateDisplayToLogical(), updateCreateGet(), updateCreateIsValid(), updateCreateLogicalToDisplay(), updateCreateLogicalToXSD(), updateCreateNormalize(), updateCreateSet(), updateCreateXSDToLogical()
property versioning as %String (MAXLEN = 1000000, XMLNAME = "versioning", XMLPROJECTION = "ATTRIBUTE");
code

no-version | versioned | versioned-update

versioning-policy is the REQUIRED FHIR3 ValueSet for codes; you may NOT extend versioning-policy and you may NOT use codes from other ValueSets.

Property methods: versioningDisplayToLogical(), versioningGet(), versioningIsValid(), versioningLogicalToDisplay(), versioningLogicalToOdbc(), versioningNormalize(), versioningSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab