HS.FHIRModel.R4.Reference
class HS.FHIRModel.R4.Reference extends HS.FHIRModel.FHIRClassSuper
******************************************* Reference generated class schema
*****************************************
A reference from one resource to another.
Property Inventory
Method Inventory
Parameters
parameter XMLTYPE = R4_REFERENCE;
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 _display as HS.FHIRModel.R4.Element;
Extensions for display
Property methods: _displayGet(), _displayGetSwizzled(), _displayIsValid(), _displayNewObject(), _displaySet()
property _reference as HS.FHIRModel.R4.Element;
Extensions for reference
Property methods: _referenceGet(), _referenceGetSwizzled(), _referenceIsValid(), _referenceNewObject(), _referenceSet()
property _type as HS.FHIRModel.R4.Element;
Extensions for type
Property methods: _typeGet(), _typeGetSwizzled(), _typeIsValid(), _typeNewObject(), _typeSet()
property display as %String;
Plain text narrative that identifies the resource in addition to
the resource reference.
Property methods: displayDisplayToLogical(), displayGet(), displayIsValid(), displayLogicalToDisplay(), displayLogicalToOdbc(), displayNormalize(), displaySet()
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 identifier as HS.FHIRModel.R4.Identifier;
An identifier for the target resource. This is used when there is
no way to reference the other resource directly, either because
the entity it represents is not available through a FHIR server,
or because there is no way for the author of the resource to convert
a known identifier to an actual location. There is no requirement
that a Reference.identifier point to something that is actually
exposed as a FHIR instance, but it SHALL point to a business concept
that would be expected to be exposed as a FHIR instance, and that
instance would need to be of a FHIR resource type allowed by the
reference.
Property methods: identifierGet(), identifierGetSwizzled(), identifierIsValid(), identifierNewObject(), identifierSet()
property reference as %String;
A reference to a location at which the other resource is found. The
reference may be a relative reference, in which case it is relative
to the service base URL, or an absolute URL that resolves to the
location where the resource is found. The reference may be version
specific or not. If the reference is not to a FHIR RESTful server,
then it should be assumed to be version specific. Internal fragment
references (start with '#') refer to contained resources.
Property methods: referenceDisplayToLogical(), referenceGet(), referenceIsValid(), referenceLogicalToDisplay(), referenceLogicalToOdbc(), referenceNormalize(), referenceSet()
property type as %String;
The expected type of the target of the reference. If both Reference.type
and Reference.reference are populated and Reference.reference is
a FHIR URL, both SHALL be consistent. The type is the Canonical
URL of Resource Definition that is the type this reference refers
to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/
e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient.
Absolute URLs are only allowed for logical models (and can only
be used in references in logical models, not resources).
Property methods: typeDisplayToLogical(), typeGet(), typeIsValid(), typeLogicalToDisplay(), typeLogicalToOdbc(), typeNormalize(), typeSet()
Methods
method IncludeExtension()
method IncludeIdentifier()
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
classmethod fromDao(dao As %Library.DynamicAbstractObject) as HS.FHIRModel.R4.Reference
method toDao() as %DynamicAbstractObject
Inherited description: >
The toDao() method casts the set to a DAO.
Inherited Members
Inherited Methods
- %AddToSaveSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %IsModified()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %SerializeObject()
- %SetModified()
- %ValidateObject()
- XMLDTD()
- XMLExport()
- XMLExportToStream()
- XMLExportToString()
- XMLNew()
- XMLSchema()
- XMLSchemaNamespace()
- XMLSchemaType()
- add()
- addAll()
- apply()
- clear()
- contains()
- containsAll()
- get()
- iterator()
- put()
- putAll()
- putAllIfAbsent()
- putIfAbsent()
- remove()
- removeAll()
- removeIf()
- rename()
- replace()
- replaceAll()
- size()
- toString()