Skip to main content

HS.FHIRModel.R4.BundleX.Request

class HS.FHIRModel.R4.BundleX.Request extends HS.FHIRModel.FHIRClassSuper

*****************************************
** BundleX.Request generated class schema
*****************************************
A container for a collection of resources.

Property Inventory

Method Inventory

Parameters

parameter XMLTYPE = R4_BUNDLEX_REQUEST;
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 _ifMatch as HS.FHIRModel.R4.Element;
Extensions for ifMatch
Property methods: _ifMatchGet(), _ifMatchGetSwizzled(), _ifMatchIsValid(), _ifMatchNewObject(), _ifMatchSet()
property _ifModifiedSince as HS.FHIRModel.R4.Element;
Extensions for ifModifiedSince
Property methods: _ifModifiedSinceGet(), _ifModifiedSinceGetSwizzled(), _ifModifiedSinceIsValid(), _ifModifiedSinceNewObject(), _ifModifiedSinceSet()
property _ifNoneExist as HS.FHIRModel.R4.Element;
Extensions for ifNoneExist
Property methods: _ifNoneExistGet(), _ifNoneExistGetSwizzled(), _ifNoneExistIsValid(), _ifNoneExistNewObject(), _ifNoneExistSet()
property _ifNoneMatch as HS.FHIRModel.R4.Element;
Extensions for ifNoneMatch
Property methods: _ifNoneMatchGet(), _ifNoneMatchGetSwizzled(), _ifNoneMatchIsValid(), _ifNoneMatchNewObject(), _ifNoneMatchSet()
property _method as HS.FHIRModel.R4.Element;
Extensions for method
Property methods: _methodGet(), _methodGetSwizzled(), _methodIsValid(), _methodNewObject(), _methodSet()
property _url as HS.FHIRModel.R4.Element;
Extensions for url
Property methods: _urlGet(), _urlGetSwizzled(), _urlIsValid(), _urlNewObject(), _urlSet()
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()
property ifMatch as %String;
Only perform the operation if the Etag value matches. For more information, see the API section ["Managing Resource Contention"](http.html#concurrency).
Property methods: ifMatchDisplayToLogical(), ifMatchGet(), ifMatchIsValid(), ifMatchLogicalToDisplay(), ifMatchLogicalToOdbc(), ifMatchNormalize(), ifMatchSet()
property ifModifiedSince as %String;
Only perform the operation if the last updated date matches. See the API documentation for ["Conditional Read"](http.html#cread).
Property methods: ifModifiedSinceDisplayToLogical(), ifModifiedSinceGet(), ifModifiedSinceIsValid(), ifModifiedSinceLogicalToDisplay(), ifModifiedSinceLogicalToOdbc(), ifModifiedSinceNormalize(), ifModifiedSinceSet()
property ifNoneExist as %String;
Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for ["Conditional Create"](http.html#ccreate). This is just the query portion of the URL - what follows the "?" (not including the "?").
Property methods: ifNoneExistDisplayToLogical(), ifNoneExistGet(), ifNoneExistIsValid(), ifNoneExistLogicalToDisplay(), ifNoneExistLogicalToOdbc(), ifNoneExistNormalize(), ifNoneExistSet()
property ifNoneMatch as %String;
If the ETag values match, return a 304 Not Modified status. See the API documentation for ["Conditional Read"](http.html#cread).
Property methods: ifNoneMatchDisplayToLogical(), ifNoneMatchGet(), ifNoneMatchIsValid(), ifNoneMatchLogicalToDisplay(), ifNoneMatchLogicalToOdbc(), ifNoneMatchNormalize(), ifNoneMatchSet()
property method as %String (VALUELIST = ",GET,HEAD,POST,PUT,DELETE,PATCH");
In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.
Property methods: methodDisplayToLogical(), methodGet(), methodIsValid(), methodLogicalToDisplay(), methodLogicalToOdbc(), methodNormalize(), methodSet()
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()
property url as %String;
The URL for this entry, relative to the root (the address to which the request is posted).
Property methods: urlDisplayToLogical(), urlGet(), urlIsValid(), urlLogicalToDisplay(), urlLogicalToOdbc(), urlNormalize(), urlSet()

Methods

method IncludeExtension()
method IncludeModifierExtension()
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