Skip to main content

HS.FHIRModel.R4.Provenance

class HS.FHIRModel.R4.Provenance extends HS.FHIRModel.FHIRClassSuper

*****************************************
** Provenance 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_PROVENANCE;
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 _implicitRules as HS.FHIRModel.R4.Element;
Extensions for implicitRules
Property methods: _implicitRulesGet(), _implicitRulesGetSwizzled(), _implicitRulesIsValid(), _implicitRulesNewObject(), _implicitRulesSet()
property _language as HS.FHIRModel.R4.Element;
Extensions for language
Property methods: _languageGet(), _languageGetSwizzled(), _languageIsValid(), _languageNewObject(), _languageSet()
property _occurredDateTime as HS.FHIRModel.R4.Element;
Extensions for occurredDateTime
Property methods: _occurredDateTimeGet(), _occurredDateTimeGetSwizzled(), _occurredDateTimeIsValid(), _occurredDateTimeNewObject(), _occurredDateTimeSet()
property _policy as HS.FHIRModel.R4.SeqOfElement;
Extensions for policy
Property methods: _policyGet(), _policyGetSwizzled(), _policyIsValid(), _policyNewObject(), _policySet()
property _recorded as HS.FHIRModel.R4.Element;
Extensions for recorded
Property methods: _recordedGet(), _recordedGetSwizzled(), _recordedIsValid(), _recordedNewObject(), _recordedSet()
property activity as HS.FHIRModel.R4.CodeableConcept;
An activity is something that occurs over a period of time and acts upon or with entities; it may include consuming, processing, transforming, modifying, relocating, using, or generating entities.
Property methods: activityGet(), activityGetSwizzled(), activityIsValid(), activityNewObject(), activitySet()
property agent as HS.FHIRModel.R4.ProvenanceX.SeqOfProvenanceXAgent [ Required ];
An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.
Property methods: agentGet(), agentGetSwizzled(), agentIsValid(), agentNewObject(), agentSet()
property contained as HS.FHIRModel.R4.SeqOfResourceList;
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Property methods: containedGet(), containedGetSwizzled(), containedIsValid(), containedNewObject(), containedSet()
An entity used in this activity.
Property methods: entityGet(), entityGetSwizzled(), entityIsValid(), entityNewObject(), entitySet()
property extension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the resource. 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;
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Property methods: fhirIDDisplayToLogical(), fhirIDGet(), fhirIDIsValid(), fhirIDLogicalToDisplay(), fhirIDLogicalToOdbc(), fhirIDNormalize(), fhirIDSet()
property implicitRules as %String;
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Property methods: implicitRulesDisplayToLogical(), implicitRulesGet(), implicitRulesIsValid(), implicitRulesLogicalToDisplay(), implicitRulesLogicalToOdbc(), implicitRulesNormalize(), implicitRulesSet()
property language as %String;
The base language in which the resource is written.
Property methods: languageDisplayToLogical(), languageGet(), languageIsValid(), languageLogicalToDisplay(), languageLogicalToOdbc(), languageNormalize(), languageSet()
property location as HS.FHIRModel.R4.Reference;
Where the activity occurred, if relevant.
Property methods: locationGet(), locationGetSwizzled(), locationIsValid(), locationNewObject(), locationSet()
property meta as HS.FHIRModel.R4.Meta;
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Property methods: metaGet(), metaGetSwizzled(), metaIsValid(), metaNewObject(), metaSet()
property modifierExtension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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 is allowed to 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 occurredDateTime as %String;
The period during which the activity occurred.
Property methods: occurredDateTimeDisplayToLogical(), occurredDateTimeGet(), occurredDateTimeIsValid(), occurredDateTimeLogicalToDisplay(), occurredDateTimeLogicalToOdbc(), occurredDateTimeNormalize(), occurredDateTimeSet()
property occurredPeriod as HS.FHIRModel.R4.Period;
The period during which the activity occurred.
Property methods: occurredPeriodGet(), occurredPeriodGetSwizzled(), occurredPeriodIsValid(), occurredPeriodNewObject(), occurredPeriodSet()
property policy as HS.FHIRModel.R4.SeqOfString;
Policy or plan the activity was defined by. Typically, a single activity may have multiple applicable policy documents, such as patient consent, guarantor funding, etc.
Property methods: policyGet(), policyGetSwizzled(), policyIsValid(), policyNewObject(), policySet()
The reason that the activity was taking place.
Property methods: reasonGet(), reasonGetSwizzled(), reasonIsValid(), reasonNewObject(), reasonSet()
property recorded as %String;
The instant of time at which the activity was recorded.
Property methods: recordedDisplayToLogical(), recordedGet(), recordedIsValid(), recordedLogicalToDisplay(), recordedLogicalToOdbc(), recordedNormalize(), recordedSet()
property resourceType as %String [ InitialExpression = "Provenance" , Required ];
This is a Provenance resource
Property methods: resourceTypeDisplayToLogical(), resourceTypeGet(), resourceTypeIsValid(), resourceTypeLogicalToDisplay(), resourceTypeLogicalToOdbc(), resourceTypeNormalize(), resourceTypeSet()
property signature as HS.FHIRModel.R4.SeqOfSignature;
A digital signature on the target Reference(s). The signer should match a Provenance.agent. The purpose of the signature is indicated.
Property methods: signatureGet(), signatureGetSwizzled(), signatureIsValid(), signatureNewObject(), signatureSet()
property target as HS.FHIRModel.R4.SeqOfReference [ Required ];
The Reference(s) that were generated or updated by the activity described in this resource. A provenance can point to more than one target if multiple resources were created/updated by the same activity.
Property methods: targetGet(), targetGetSwizzled(), targetIsValid(), targetNewObject(), targetSet()
property text as HS.FHIRModel.R4.Narrative;
A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Property methods: textGet(), textGetSwizzled(), textIsValid(), textNewObject(), textSet()

Methods

method IncludeActivity()
method IncludeAgent()
method IncludeContained()
method IncludeEntity()
method IncludeExtension()
method IncludeLocation()
method IncludeMeta()
method IncludeModifierExtension()
method IncludeOccurredPeriod()
method IncludePolicy()
method IncludeReason()
method IncludeSignature()
method IncludeTarget()
method IncludeText()
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