Skip to main content

HS.FHIRModel.R4.ProvenanceX.Entity

class HS.FHIRModel.R4.ProvenanceX.Entity extends HS.FHIRModel.FHIRClassSuper

*****************************************
** ProvenanceX.Entity generated class schema
*****************************************
Provenance of a resource is a record that describes entities and processes involved in producing and delivering or otherwise influencing that resource. Provenance provides a critical foundation for assessing authenticity, enabling trust, and allowing reproducibility. Provenance assertions are a form of contextual metadata and can themselves become important records with their own provenance. Provenance statement indicates clinical significance in terms of confidence in authenticity, reliability, and trustworthiness, integrity, and stage in lifecycle (e.g. Document Completion - has the artifact been legally authenticated), all of which may impact security, privacy, and trust policies.

Property Inventory

Method Inventory

Parameters

parameter XMLTYPE = R4_PROVENANCEX_ENTITY;
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 _role as HS.FHIRModel.R4.Element;
Extensions for role
Property methods: _roleGet(), _roleGetSwizzled(), _roleIsValid(), _roleNewObject(), _roleSet()
The entity is attributed to an agent to express the agent's responsibility for that entity, possibly along with other agents. This description can be understood as shorthand for saying that the agent was responsible for the activity which generated the entity.
Property methods: agentGet(), agentGetSwizzled(), agentIsValid(), agentNewObject(), agentSet()
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 role as %String (VALUELIST = ",derivation,revision,quotation,source,removal");
How the entity was used during the activity.
Property methods: roleDisplayToLogical(), roleGet(), roleIsValid(), roleLogicalToDisplay(), roleLogicalToOdbc(), roleNormalize(), roleSet()
property what as HS.FHIRModel.R4.Reference [ Required ];
Identity of the Entity used. May be a logical or physical uri and maybe absolute or relative.
Property methods: whatGet(), whatGetSwizzled(), whatIsValid(), whatNewObject(), whatSet()

Methods

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