Skip to main content

HS.FHIR.DTL.vR4.Model.Element.Contract.term.action

class HS.FHIR.DTL.vR4.Model.Element.Contract.term.action extends HS.FHIR.DTL.vR4.Model.Base.BackboneElement

Entity being ascribed responsibility.

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 = Contract.term.action;
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 = Contract.term.action;
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 context as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "context", XMLPROJECTION = "ELEMENT");
Reference

Episode associated with action.

Encounter | EpisodeOfCare

Property methods: contextGet(), contextGetSwizzled(), contextIsValid(), contextNewObject(), contextSet()
property contextLinkId as list of %String (MAXLEN = 1000000, XMLNAME = "contextLinkId", XMLPROJECTION = "ELEMENT");
string

Pointer to specific item.

Property methods: contextLinkIdBuildValueArray(), contextLinkIdCollectionToDisplay(), contextLinkIdCollectionToOdbc(), contextLinkIdDisplayToCollection(), contextLinkIdDisplayToLogical(), contextLinkIdGet(), contextLinkIdGetObject(), contextLinkIdGetObjectId(), contextLinkIdGetSwizzled(), contextLinkIdIsValid(), contextLinkIdLogicalToDisplay(), contextLinkIdLogicalToOdbc(), contextLinkIdNormalize(), contextLinkIdOdbcToCollection(), contextLinkIdSet(), contextLinkIdSetObject(), contextLinkIdSetObjectId()
property doNotPerform as %Boolean (XMLNAME = "doNotPerform", XMLPROJECTION = "ATTRIBUTE");
boolean

True if the term prohibits the action.

Property methods: doNotPerformDisplayToLogical(), doNotPerformGet(), doNotPerformIsValid(), doNotPerformLogicalToDisplay(), doNotPerformLogicalToXSD(), doNotPerformNormalize(), doNotPerformSet(), doNotPerformXSDToLogical()
property intent as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "intent", XMLPROJECTION = "ELEMENT") [ Required ];
CodeableConcept

Purpose for the Contract Term Action.

any FHIR4 code may be used; v3-PurposeOfUse shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: intentGet(), intentGetSwizzled(), intentIsValid(), intentNewObject(), intentSet()
property linkId as list of %String (MAXLEN = 1000000, XMLNAME = "linkId", XMLPROJECTION = "ELEMENT");
string

Pointer to specific item.

Property methods: linkIdBuildValueArray(), linkIdCollectionToDisplay(), linkIdCollectionToOdbc(), linkIdDisplayToCollection(), linkIdDisplayToLogical(), linkIdGet(), linkIdGetObject(), linkIdGetObjectId(), linkIdGetSwizzled(), linkIdIsValid(), linkIdLogicalToDisplay(), linkIdLogicalToOdbc(), linkIdNormalize(), linkIdOdbcToCollection(), linkIdSet(), linkIdSetObject(), linkIdSetObjectId()
property note as list of HS.FHIR.DTL.vR4.Model.Datatype.Annotation (XMLNAME = "note", XMLPROJECTION = "ELEMENT");
Annotation

Comments about the action.

Property methods: noteBuildValueArray(), noteCollectionToDisplay(), noteCollectionToOdbc(), noteDisplayToCollection(), noteGet(), noteGetObject(), noteGetObjectId(), noteGetSwizzled(), noteIsValid(), noteOdbcToCollection(), noteSet(), noteSetObject(), noteSetObjectId()
property occurrenceDateTime as %String (MAXLEN = 1000000, XMLNAME = "occurrenceDateTime", XMLPROJECTION = "ATTRIBUTE");
dateTime

When action happens.

Property methods: occurrenceDateTimeDisplayToLogical(), occurrenceDateTimeGet(), occurrenceDateTimeIsValid(), occurrenceDateTimeLogicalToDisplay(), occurrenceDateTimeLogicalToOdbc(), occurrenceDateTimeNormalize(), occurrenceDateTimeSet()
property occurrencePeriod as HS.FHIR.DTL.vR4.Model.Datatype.Period (XMLNAME = "occurrencePeriod", XMLPROJECTION = "ELEMENT");
Period

When action happens.

Property methods: occurrencePeriodGet(), occurrencePeriodGetSwizzled(), occurrencePeriodIsValid(), occurrencePeriodNewObject(), occurrencePeriodSet()
property occurrenceTiming as HS.FHIR.DTL.vR4.Model.Datatype.Timing (XMLNAME = "occurrenceTiming", XMLPROJECTION = "ELEMENT");
Timing

When action happens.

Property methods: occurrenceTimingGet(), occurrenceTimingGetSwizzled(), occurrenceTimingIsValid(), occurrenceTimingNewObject(), occurrenceTimingSet()
property performer as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "performer", XMLPROJECTION = "ELEMENT");
Reference

Actor that wil execute (or not) the action.

RelatedPerson | Patient | Practitioner | PractitionerRole | CareTeam | Device | Substance | Organization | Location

Property methods: performerGet(), performerGetSwizzled(), performerIsValid(), performerNewObject(), performerSet()
property performerLinkId as list of %String (MAXLEN = 1000000, XMLNAME = "performerLinkId", XMLPROJECTION = "ELEMENT");
string

Pointer to specific item.

Property methods: performerLinkIdBuildValueArray(), performerLinkIdCollectionToDisplay(), performerLinkIdCollectionToOdbc(), performerLinkIdDisplayToCollection(), performerLinkIdDisplayToLogical(), performerLinkIdGet(), performerLinkIdGetObject(), performerLinkIdGetObjectId(), performerLinkIdGetSwizzled(), performerLinkIdIsValid(), performerLinkIdLogicalToDisplay(), performerLinkIdLogicalToOdbc(), performerLinkIdNormalize(), performerLinkIdOdbcToCollection(), performerLinkIdSet(), performerLinkIdSetObject(), performerLinkIdSetObjectId()
property performerRole as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "performerRole", XMLPROJECTION = "ELEMENT");
CodeableConcept

Competency of the performer.

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

Property methods: performerRoleGet(), performerRoleGetSwizzled(), performerRoleIsValid(), performerRoleNewObject(), performerRoleSet()
property performerType as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "performerType", XMLPROJECTION = "ELEMENT");
CodeableConcept

Kind of service performer.

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

Property methods: performerTypeBuildValueArray(), performerTypeCollectionToDisplay(), performerTypeCollectionToOdbc(), performerTypeDisplayToCollection(), performerTypeGet(), performerTypeGetObject(), performerTypeGetObjectId(), performerTypeGetSwizzled(), performerTypeIsValid(), performerTypeOdbcToCollection(), performerTypeSet(), performerTypeSetObject(), performerTypeSetObjectId()
property reason as list of %String (MAXLEN = 1000000, XMLNAME = "reason", XMLPROJECTION = "ELEMENT");
string

Why action is to be performed.

Property methods: reasonBuildValueArray(), reasonCollectionToDisplay(), reasonCollectionToOdbc(), reasonDisplayToCollection(), reasonDisplayToLogical(), reasonGet(), reasonGetObject(), reasonGetObjectId(), reasonGetSwizzled(), reasonIsValid(), reasonLogicalToDisplay(), reasonLogicalToOdbc(), reasonNormalize(), reasonOdbcToCollection(), reasonSet(), reasonSetObject(), reasonSetObjectId()
property reasonCode as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "reasonCode", XMLPROJECTION = "ELEMENT");
CodeableConcept

Why is action (not) needed?

any FHIR4 code may be used; v3-PurposeOfUse shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: reasonCodeBuildValueArray(), reasonCodeCollectionToDisplay(), reasonCodeCollectionToOdbc(), reasonCodeDisplayToCollection(), reasonCodeGet(), reasonCodeGetObject(), reasonCodeGetObjectId(), reasonCodeGetSwizzled(), reasonCodeIsValid(), reasonCodeOdbcToCollection(), reasonCodeSet(), reasonCodeSetObject(), reasonCodeSetObjectId()
property reasonLinkId as list of %String (MAXLEN = 1000000, XMLNAME = "reasonLinkId", XMLPROJECTION = "ELEMENT");
string

Pointer to specific item.

Property methods: reasonLinkIdBuildValueArray(), reasonLinkIdCollectionToDisplay(), reasonLinkIdCollectionToOdbc(), reasonLinkIdDisplayToCollection(), reasonLinkIdDisplayToLogical(), reasonLinkIdGet(), reasonLinkIdGetObject(), reasonLinkIdGetObjectId(), reasonLinkIdGetSwizzled(), reasonLinkIdIsValid(), reasonLinkIdLogicalToDisplay(), reasonLinkIdLogicalToOdbc(), reasonLinkIdNormalize(), reasonLinkIdOdbcToCollection(), reasonLinkIdSet(), reasonLinkIdSetObject(), reasonLinkIdSetObjectId()
property reasonReference as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "reasonReference", XMLPROJECTION = "ELEMENT");
Reference

Why is action (not) needed?

Condition | Observation | DiagnosticReport | DocumentReference | Questionnaire | QuestionnaireResponse

Property methods: reasonReferenceBuildValueArray(), reasonReferenceCollectionToDisplay(), reasonReferenceCollectionToOdbc(), reasonReferenceDisplayToCollection(), reasonReferenceGet(), reasonReferenceGetObject(), reasonReferenceGetObjectId(), reasonReferenceGetSwizzled(), reasonReferenceIsValid(), reasonReferenceOdbcToCollection(), reasonReferenceSet(), reasonReferenceSetObject(), reasonReferenceSetObjectId()
property requester as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "requester", XMLPROJECTION = "ELEMENT");
Reference

Who asked for action.

Patient | RelatedPerson | Practitioner | PractitionerRole | Device | Group | Organization

Property methods: requesterBuildValueArray(), requesterCollectionToDisplay(), requesterCollectionToOdbc(), requesterDisplayToCollection(), requesterGet(), requesterGetObject(), requesterGetObjectId(), requesterGetSwizzled(), requesterIsValid(), requesterOdbcToCollection(), requesterSet(), requesterSetObject(), requesterSetObjectId()
property requesterLinkId as list of %String (MAXLEN = 1000000, XMLNAME = "requesterLinkId", XMLPROJECTION = "ELEMENT");
string

Pointer to specific item.

Property methods: requesterLinkIdBuildValueArray(), requesterLinkIdCollectionToDisplay(), requesterLinkIdCollectionToOdbc(), requesterLinkIdDisplayToCollection(), requesterLinkIdDisplayToLogical(), requesterLinkIdGet(), requesterLinkIdGetObject(), requesterLinkIdGetObjectId(), requesterLinkIdGetSwizzled(), requesterLinkIdIsValid(), requesterLinkIdLogicalToDisplay(), requesterLinkIdLogicalToOdbc(), requesterLinkIdNormalize(), requesterLinkIdOdbcToCollection(), requesterLinkIdSet(), requesterLinkIdSetObject(), requesterLinkIdSetObjectId()
property securityLabelNumber as list of %Integer (XMLNAME = "securityLabelNumber", XMLPROJECTION = "ELEMENT");
unsignedInt

Action restriction numbers.

Property methods: securityLabelNumberBuildValueArray(), securityLabelNumberCollectionToDisplay(), securityLabelNumberCollectionToOdbc(), securityLabelNumberDisplayToCollection(), securityLabelNumberDisplayToLogical(), securityLabelNumberGet(), securityLabelNumberGetObject(), securityLabelNumberGetObjectId(), securityLabelNumberGetSwizzled(), securityLabelNumberIsValid(), securityLabelNumberLogicalToDisplay(), securityLabelNumberNormalize(), securityLabelNumberOdbcToCollection(), securityLabelNumberSet(), securityLabelNumberSetObject(), securityLabelNumberSetObjectId(), securityLabelNumberXSDToLogical()
property status as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "status", XMLPROJECTION = "ELEMENT") [ Required ];
CodeableConcept

State of the action.

any FHIR4 code may be used; contract-actionstatus shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: statusGet(), statusGetSwizzled(), statusIsValid(), statusNewObject(), statusSet()
property subject as list of HS.FHIR.DTL.vR4.Model.Element.Contract.term.action.subject (XMLNAME = "subject", XMLPROJECTION = "ELEMENT");
BackboneElement

Entity of the action.

Property methods: subjectBuildValueArray(), subjectCollectionToDisplay(), subjectCollectionToOdbc(), subjectDisplayToCollection(), subjectGet(), subjectGetObject(), subjectGetObjectId(), subjectGetSwizzled(), subjectIsValid(), subjectOdbcToCollection(), subjectSet(), subjectSetObject(), subjectSetObjectId()
property type as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "type", XMLPROJECTION = "ELEMENT") [ Required ];
CodeableConcept

Type or form of the action.

any FHIR4 code may be used; contract-action shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: typeGet(), typeGetSwizzled(), typeIsValid(), typeNewObject(), typeSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab