Skip to main content

HS.FHIRModel.R4.CapabilityStatementX.SearchParam

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

*****************************************
** CapabilityStatementX.SearchParam 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_SEARCHPARAM;
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 _documentation as HS.FHIRModel.R4.Element;
Extensions for documentation
Property methods: _documentationGet(), _documentationGetSwizzled(), _documentationIsValid(), _documentationNewObject(), _documentationSet()
property _name as HS.FHIRModel.R4.Element;
Extensions for name
Property methods: _nameGet(), _nameGetSwizzled(), _nameIsValid(), _nameNewObject(), _nameSet()
property _type as HS.FHIRModel.R4.Element;
Extensions for type
Property methods: _typeGet(), _typeGetSwizzled(), _typeIsValid(), _typeNewObject(), _typeSet()
property definition as %String;
An absolute URI that is a formal reference to where this parameter was first defined, so that a client can be confident of the meaning of the search parameter (a reference to [[[SearchParameter.url]]]). This element SHALL be populated if the search parameter refers to a SearchParameter defined by the FHIR core specification or externally defined IGs.
Property methods: definitionDisplayToLogical(), definitionGet(), definitionIsValid(), definitionLogicalToDisplay(), definitionLogicalToOdbc(), definitionNormalize(), definitionSet()
property documentation as %String;
This allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithms.
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()
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 name as %String;
The name of the search parameter used in the interface.
Property methods: nameDisplayToLogical(), nameGet(), nameIsValid(), nameLogicalToDisplay(), nameLogicalToOdbc(), nameNormalize(), nameSet()
property type as %String (VALUELIST = ",number,date,string,token,reference,composite,quantity,uri,special");
The type of value a search parameter refers to, and how the content is interpreted.
Property methods: typeDisplayToLogical(), typeGet(), typeIsValid(), typeLogicalToDisplay(), typeLogicalToOdbc(), typeNormalize(), typeSet()

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