Skip to main content


class HS.FHIR.DTL.vR4.Model.Resource.Provenance extends HS.FHIR.DTL.vR4.Model.Base.DomainResource

Who, What, When for a set of resources.

Property Inventory


Inherited description: ELEMENTQUALIFIED controls the format of exported XML. The ELEMENTQUALIFIED specification should be based on the elementFormDefault attribute of the schema that defines the type. To maintain compatibility, ELEMENTQUALIFIED will default to 1 (true) for literal format export and will default to 0 (false) for encoded or encoded12 format export. These were the values always previously assumed for the elementFormDefault attribute.

NOTE: Direct use of XMLExport method does not support the ELEMENTQUALIFIED. The export must be done using %XML.Writer or SOAP support.

parameter XMLNAME = Provenance;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.
parameter XMLSEQUENCE = 1;
Inherited description: If the XMLSEQUENCE = 1, then the order of the XML elements must match the order of the class properties. This allows us to deal with XML where the same field appears multiple times and is distinguished by the order.
parameter XMLTYPE = 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.


property activity as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "activity", XMLPROJECTION = "ELEMENT");

Activity that occurred.

provenance-activity-type is the REQUIRED FHIR4 ValueSet for codes, but if you need to express meanings not found in provenance-activity-type, you may formally EXTEND provenance-activity-type to add codes to it.

Property methods: activityGet(), activityGetSwizzled(), activityIsValid(), activityNewObject(), activitySet()
property agent as list of HS.FHIR.DTL.vR4.Model.Element.Provenance.agent (XMLNAME = "agent", XMLPROJECTION = "ELEMENT") [ Required ];

Actor involved.

Property methods: agentBuildValueArray(), agentCollectionToDisplay(), agentCollectionToOdbc(), agentDisplayToCollection(), agentGet(), agentGetObject(), agentGetObjectId(), agentGetSwizzled(), agentIsValid(), agentOdbcToCollection(), agentSet(), agentSetObject(), agentSetObjectId()
property entity as list of HS.FHIR.DTL.vR4.Model.Element.Provenance.entity (XMLNAME = "entity", XMLPROJECTION = "ELEMENT");

An entity used in this activity.

Property methods: entityBuildValueArray(), entityCollectionToDisplay(), entityCollectionToOdbc(), entityDisplayToCollection(), entityGet(), entityGetObject(), entityGetObjectId(), entityGetSwizzled(), entityIsValid(), entityOdbcToCollection(), entitySet(), entitySetObject(), entitySetObjectId()
property location as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "location", XMLPROJECTION = "ELEMENT");

Where the activity occurred, if relevant.


Property methods: locationGet(), locationGetSwizzled(), locationIsValid(), locationNewObject(), locationSet()
property occurredDateTime as %String (MAXLEN = 1000000, XMLNAME = "occurredDateTime", XMLPROJECTION = "ATTRIBUTE");

When the activity occurred.

Property methods: occurredDateTimeDisplayToLogical(), occurredDateTimeGet(), occurredDateTimeIsValid(), occurredDateTimeLogicalToDisplay(), occurredDateTimeLogicalToOdbc(), occurredDateTimeNormalize(), occurredDateTimeSet()
property occurredPeriod as HS.FHIR.DTL.vR4.Model.Datatype.Period (XMLNAME = "occurredPeriod", XMLPROJECTION = "ELEMENT");

When the activity occurred.

Property methods: occurredPeriodGet(), occurredPeriodGetSwizzled(), occurredPeriodIsValid(), occurredPeriodNewObject(), occurredPeriodSet()
property policy as list of %String (MAXLEN = 1000000, XMLNAME = "policy", XMLPROJECTION = "ELEMENT");

Policy or plan the activity was defined by.

Property methods: policyBuildValueArray(), policyCollectionToDisplay(), policyCollectionToOdbc(), policyDisplayToCollection(), policyDisplayToLogical(), policyGet(), policyGetObject(), policyGetObjectId(), policyGetSwizzled(), policyIsValid(), policyLogicalToDisplay(), policyLogicalToOdbc(), policyNormalize(), policyOdbcToCollection(), policySet(), policySetObject(), policySetObjectId()
property reason as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "reason", XMLPROJECTION = "ELEMENT");

Reason the activity is occurring.

v3-PurposeOfUse is the REQUIRED FHIR4 ValueSet for codes, but if you need to express meanings not found in v3-PurposeOfUse, you may formally EXTEND v3-PurposeOfUse to add codes to it.

Property methods: reasonBuildValueArray(), reasonCollectionToDisplay(), reasonCollectionToOdbc(), reasonDisplayToCollection(), reasonGet(), reasonGetObject(), reasonGetObjectId(), reasonGetSwizzled(), reasonIsValid(), reasonOdbcToCollection(), reasonSet(), reasonSetObject(), reasonSetObjectId()
property recorded as %String (MAXLEN = 1000000, XMLNAME = "recorded", XMLPROJECTION = "ATTRIBUTE") [ Required ];

When the activity was recorded / updated.

Property methods: recordedDisplayToLogical(), recordedGet(), recordedIsValid(), recordedLogicalToDisplay(), recordedLogicalToOdbc(), recordedNormalize(), recordedSet()
property signature as list of HS.FHIR.DTL.vR4.Model.Datatype.Signature (XMLNAME = "signature", XMLPROJECTION = "ELEMENT");

Signature on target.

Property methods: signatureBuildValueArray(), signatureCollectionToDisplay(), signatureCollectionToOdbc(), signatureDisplayToCollection(), signatureGet(), signatureGetObject(), signatureGetObjectId(), signatureGetSwizzled(), signatureIsValid(), signatureOdbcToCollection(), signatureSet(), signatureSetObject(), signatureSetObjectId()
property target as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "target", XMLPROJECTION = "ELEMENT") [ Required ];

Target Reference(s) (usually version specific)

Any FHIR4 Resource may be indicated by this Reference

Property methods: targetBuildValueArray(), targetCollectionToDisplay(), targetCollectionToOdbc(), targetDisplayToCollection(), targetGet(), targetGetObject(), targetGetObjectId(), targetGetSwizzled(), targetIsValid(), targetOdbcToCollection(), targetSet(), targetSetObject(), targetSetObjectId()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab