Skip to main content

HS.FHIR.DTL.vR4.Model.Element.Provenance.agent

class HS.FHIR.DTL.vR4.Model.Element.Provenance.agent extends HS.FHIR.DTL.vR4.Model.Base.BackboneElement

Actor involved.

Property Inventory

Parameters

parameter ELEMENTQUALIFIED = 1;
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.agent;
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 XMLPROJECTION = ELEMENT;
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.agent;
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 onBehalfOf as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "onBehalfOf", XMLPROJECTION = "ELEMENT");
Reference

Who the agent is representing.

Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization

Property methods: onBehalfOfGet(), onBehalfOfGetSwizzled(), onBehalfOfIsValid(), onBehalfOfNewObject(), onBehalfOfSet()
property role as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "role", XMLPROJECTION = "ELEMENT");
CodeableConcept

What the agents role was.

any FHIR4 code may be used; security-role-type shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: roleBuildValueArray(), roleCollectionToDisplay(), roleCollectionToOdbc(), roleDisplayToCollection(), roleGet(), roleGetObject(), roleGetObjectId(), roleGetSwizzled(), roleIsValid(), roleOdbcToCollection(), roleSet(), roleSetObject(), roleSetObjectId()
property type as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "type", XMLPROJECTION = "ELEMENT");
CodeableConcept

How the agent participated.

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

Property methods: typeGet(), typeGetSwizzled(), typeIsValid(), typeNewObject(), typeSet()
property who as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "who", XMLPROJECTION = "ELEMENT") [ Required ];
Reference

Who participated.

Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization

Property methods: whoGet(), whoGetSwizzled(), whoIsValid(), whoNewObject(), whoSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab