Skip to main content

HS.FHIR.DTL.vSTU3.Model.Resource.ActivityDefinition

class HS.FHIR.DTL.vSTU3.Model.Resource.ActivityDefinition extends HS.FHIR.DTL.vSTU3.Model.Base.DomainResource

This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.

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 = ActivityDefinition;
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 = ActivityDefinition;
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 approvalDate as %String (MAXLEN = 1000000, XMLNAME = "approvalDate", XMLPROJECTION = "ATTRIBUTE");
date

When the activity definition was approved by publisher.

Property methods: approvalDateDisplayToLogical(), approvalDateGet(), approvalDateIsValid(), approvalDateLogicalToDisplay(), approvalDateLogicalToOdbc(), approvalDateNormalize(), approvalDateSet()
property bodySite as list of HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "bodySite", XMLPROJECTION = "ELEMENT");
CodeableConcept

What part of body to perform on.

any FHIR3 code may be used; body-site shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: bodySiteBuildValueArray(), bodySiteCollectionToDisplay(), bodySiteCollectionToOdbc(), bodySiteDisplayToCollection(), bodySiteGet(), bodySiteGetObject(), bodySiteGetObjectId(), bodySiteGetSwizzled(), bodySiteIsValid(), bodySiteOdbcToCollection(), bodySiteSet(), bodySiteSetObject(), bodySiteSetObjectId()
property code as HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "code", XMLPROJECTION = "ELEMENT");
CodeableConcept

Detail type of activity.

any FHIR3 code may be used; procedure-code shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: codeGet(), codeGetSwizzled(), codeIsValid(), codeNewObject(), codeSet()
property contact as list of HS.FHIR.DTL.vSTU3.Model.Datatype.ContactDetail (XMLNAME = "contact", XMLPROJECTION = "ELEMENT");
ContactDetail

Contact details for the publisher.

Property methods: contactBuildValueArray(), contactCollectionToDisplay(), contactCollectionToOdbc(), contactDisplayToCollection(), contactGet(), contactGetObject(), contactGetObjectId(), contactGetSwizzled(), contactIsValid(), contactOdbcToCollection(), contactSet(), contactSetObject(), contactSetObjectId()
property contributor as list of HS.FHIR.DTL.vSTU3.Model.Datatype.Contributor (XMLNAME = "contributor", XMLPROJECTION = "ELEMENT");
Contributor

A content contributor.

Property methods: contributorBuildValueArray(), contributorCollectionToDisplay(), contributorCollectionToOdbc(), contributorDisplayToCollection(), contributorGet(), contributorGetObject(), contributorGetObjectId(), contributorGetSwizzled(), contributorIsValid(), contributorOdbcToCollection(), contributorSet(), contributorSetObject(), contributorSetObjectId()
markdown

Use and/or publishing restrictions.

Property methods: copyrightDisplayToLogical(), copyrightGet(), copyrightIsValid(), copyrightLogicalToDisplay(), copyrightLogicalToOdbc(), copyrightNormalize(), copyrightSet()
property date as %String (MAXLEN = 1000000, XMLNAME = "date", XMLPROJECTION = "ATTRIBUTE");
dateTime

Date this was last changed.

Property methods: dateDisplayToLogical(), dateGet(), dateIsValid(), dateLogicalToDisplay(), dateLogicalToOdbc(), dateNormalize(), dateSet()
property description as %String (MAXLEN = 1000000, XMLNAME = "description", XMLPROJECTION = "ATTRIBUTE");
markdown

Natural language description of the activity definition.

Property methods: descriptionDisplayToLogical(), descriptionGet(), descriptionIsValid(), descriptionLogicalToDisplay(), descriptionLogicalToOdbc(), descriptionNormalize(), descriptionSet()
property dosage as list of HS.FHIR.DTL.vSTU3.Model.Element.Dosage (XMLNAME = "dosage", XMLPROJECTION = "ELEMENT");
Dosage

Detailed dosage instructions.

Property methods: dosageBuildValueArray(), dosageCollectionToDisplay(), dosageCollectionToOdbc(), dosageDisplayToCollection(), dosageGet(), dosageGetObject(), dosageGetObjectId(), dosageGetSwizzled(), dosageIsValid(), dosageOdbcToCollection(), dosageSet(), dosageSetObject(), dosageSetObjectId()
property dynamicValue as list of HS.FHIR.DTL.vSTU3.Model.Element.ActivityDefinition.dynamicValue (XMLNAME = "dynamicValue", XMLPROJECTION = "ELEMENT");
BackboneElement

Dynamic aspects of the definition.

Property methods: dynamicValueBuildValueArray(), dynamicValueCollectionToDisplay(), dynamicValueCollectionToOdbc(), dynamicValueDisplayToCollection(), dynamicValueGet(), dynamicValueGetObject(), dynamicValueGetObjectId(), dynamicValueGetSwizzled(), dynamicValueIsValid(), dynamicValueOdbcToCollection(), dynamicValueSet(), dynamicValueSetObject(), dynamicValueSetObjectId()
property effectivePeriod as HS.FHIR.DTL.vSTU3.Model.Datatype.Period (XMLNAME = "effectivePeriod", XMLPROJECTION = "ELEMENT");
Period

When the activity definition is expected to be used.

Property methods: effectivePeriodGet(), effectivePeriodGetSwizzled(), effectivePeriodIsValid(), effectivePeriodNewObject(), effectivePeriodSet()
property experimental as %Boolean (XMLNAME = "experimental", XMLPROJECTION = "ATTRIBUTE");
boolean

For testing purposes, not real usage.

Property methods: experimentalDisplayToLogical(), experimentalGet(), experimentalIsValid(), experimentalLogicalToDisplay(), experimentalLogicalToXSD(), experimentalNormalize(), experimentalSet(), experimentalXSDToLogical()
property identifier as list of HS.FHIR.DTL.vSTU3.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
Identifier

Additional identifier for the activity definition.

Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property jurisdiction as list of HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "jurisdiction", XMLPROJECTION = "ELEMENT");
CodeableConcept

Intended jurisdiction for activity definition (if applicable)

jurisdiction is the REQUIRED FHIR3 ValueSet for codes, but if you need to express meanings not found in jurisdiction, you may formally EXTEND jurisdiction to add codes to it.

Property methods: jurisdictionBuildValueArray(), jurisdictionCollectionToDisplay(), jurisdictionCollectionToOdbc(), jurisdictionDisplayToCollection(), jurisdictionGet(), jurisdictionGetObject(), jurisdictionGetObjectId(), jurisdictionGetSwizzled(), jurisdictionIsValid(), jurisdictionOdbcToCollection(), jurisdictionSet(), jurisdictionSetObject(), jurisdictionSetObjectId()
property kind as %String (MAXLEN = 1000000, XMLNAME = "kind", XMLPROJECTION = "ATTRIBUTE");
code

Kind of resource.

resource-types is the REQUIRED FHIR3 ValueSet for codes; you may NOT extend resource-types and you may NOT use codes from other ValueSets.

Property methods: kindDisplayToLogical(), kindGet(), kindIsValid(), kindLogicalToDisplay(), kindLogicalToOdbc(), kindNormalize(), kindSet()
property lastReviewDate as %String (MAXLEN = 1000000, XMLNAME = "lastReviewDate", XMLPROJECTION = "ATTRIBUTE");
date

When the activity definition was last reviewed.

Property methods: lastReviewDateDisplayToLogical(), lastReviewDateGet(), lastReviewDateIsValid(), lastReviewDateLogicalToDisplay(), lastReviewDateLogicalToOdbc(), lastReviewDateNormalize(), lastReviewDateSet()
property library as list of HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "library", XMLPROJECTION = "ELEMENT");
Reference

Logic used by the asset.

Library

Property methods: libraryBuildValueArray(), libraryCollectionToDisplay(), libraryCollectionToOdbc(), libraryDisplayToCollection(), libraryGet(), libraryGetObject(), libraryGetObjectId(), libraryGetSwizzled(), libraryIsValid(), libraryOdbcToCollection(), librarySet(), librarySetObject(), librarySetObjectId()
property location as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "location", XMLPROJECTION = "ELEMENT");
Reference

Where it should happen.

Location

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

Name for this activity definition (computer friendly)

Property methods: nameDisplayToLogical(), nameGet(), nameIsValid(), nameLogicalToDisplay(), nameLogicalToOdbc(), nameNormalize(), nameSet()
property participant as list of HS.FHIR.DTL.vSTU3.Model.Element.ActivityDefinition.participant (XMLNAME = "participant", XMLPROJECTION = "ELEMENT");
BackboneElement

Who should participate in the action.

Property methods: participantBuildValueArray(), participantCollectionToDisplay(), participantCollectionToOdbc(), participantDisplayToCollection(), participantGet(), participantGetObject(), participantGetObjectId(), participantGetSwizzled(), participantIsValid(), participantOdbcToCollection(), participantSet(), participantSetObject(), participantSetObjectId()
property productCodeableConcept as HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "productCodeableConcept", XMLPROJECTION = "ELEMENT");
CodeableConcept

What's administered/supplied.

any FHIR3 code may be used; medication-codes shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: productCodeableConceptGet(), productCodeableConceptGetSwizzled(), productCodeableConceptIsValid(), productCodeableConceptNewObject(), productCodeableConceptSet()
property productReference as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "productReference", XMLPROJECTION = "ELEMENT");
Reference

What's administered/supplied.

Medication | Substance

Property methods: productReferenceGet(), productReferenceGetSwizzled(), productReferenceIsValid(), productReferenceNewObject(), productReferenceSet()
property publisher as %String (MAXLEN = 1000000, XMLNAME = "publisher", XMLPROJECTION = "ATTRIBUTE");
string

Name of the publisher (organization or individual)

Property methods: publisherDisplayToLogical(), publisherGet(), publisherIsValid(), publisherLogicalToDisplay(), publisherLogicalToOdbc(), publisherNormalize(), publisherSet()
property purpose as %String (MAXLEN = 1000000, XMLNAME = "purpose", XMLPROJECTION = "ATTRIBUTE");
markdown

Why this activity definition is defined.

Property methods: purposeDisplayToLogical(), purposeGet(), purposeIsValid(), purposeLogicalToDisplay(), purposeLogicalToOdbc(), purposeNormalize(), purposeSet()
property quantity as HS.FHIR.DTL.vSTU3.Model.Datatype.SimpleQuantity (XMLNAME = "quantity", XMLPROJECTION = "ELEMENT");
SimpleQuantity

How much is administered/consumed/supplied.

Property methods: quantityGet(), quantityGetSwizzled(), quantityIsValid(), quantityNewObject(), quantitySet()
property relatedArtifact as list of HS.FHIR.DTL.vSTU3.Model.Datatype.RelatedArtifact (XMLNAME = "relatedArtifact", XMLPROJECTION = "ELEMENT");
RelatedArtifact

Additional documentation, citations, etc.

Property methods: relatedArtifactBuildValueArray(), relatedArtifactCollectionToDisplay(), relatedArtifactCollectionToOdbc(), relatedArtifactDisplayToCollection(), relatedArtifactGet(), relatedArtifactGetObject(), relatedArtifactGetObjectId(), relatedArtifactGetSwizzled(), relatedArtifactIsValid(), relatedArtifactOdbcToCollection(), relatedArtifactSet(), relatedArtifactSetObject(), relatedArtifactSetObjectId()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE") [ Required ];
code

draft | active | retired | unknown

publication-status is the REQUIRED FHIR3 ValueSet for codes; you may NOT extend publication-status and you may NOT use codes from other ValueSets.

Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property timingDateTime as %String (MAXLEN = 1000000, XMLNAME = "timingDateTime", XMLPROJECTION = "ATTRIBUTE");
dateTime

When activity is to occur.

Property methods: timingDateTimeDisplayToLogical(), timingDateTimeGet(), timingDateTimeIsValid(), timingDateTimeLogicalToDisplay(), timingDateTimeLogicalToOdbc(), timingDateTimeNormalize(), timingDateTimeSet()
property timingPeriod as HS.FHIR.DTL.vSTU3.Model.Datatype.Period (XMLNAME = "timingPeriod", XMLPROJECTION = "ELEMENT");
Period

When activity is to occur.

Property methods: timingPeriodGet(), timingPeriodGetSwizzled(), timingPeriodIsValid(), timingPeriodNewObject(), timingPeriodSet()
property timingRange as HS.FHIR.DTL.vSTU3.Model.Datatype.Range (XMLNAME = "timingRange", XMLPROJECTION = "ELEMENT");
Range

When activity is to occur.

Property methods: timingRangeGet(), timingRangeGetSwizzled(), timingRangeIsValid(), timingRangeNewObject(), timingRangeSet()
property timingTiming as HS.FHIR.DTL.vSTU3.Model.Datatype.Timing (XMLNAME = "timingTiming", XMLPROJECTION = "ELEMENT");
Timing

When activity is to occur.

Property methods: timingTimingGet(), timingTimingGetSwizzled(), timingTimingIsValid(), timingTimingNewObject(), timingTimingSet()
property title as %String (MAXLEN = 1000000, XMLNAME = "title", XMLPROJECTION = "ATTRIBUTE");
string

Name for this activity definition (human friendly)

Property methods: titleDisplayToLogical(), titleGet(), titleIsValid(), titleLogicalToDisplay(), titleLogicalToOdbc(), titleNormalize(), titleSet()
property topic as list of HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "topic", XMLPROJECTION = "ELEMENT");
CodeableConcept

E.g. Education, Treatment, Assessment, etc.

any FHIR3 code may be used; definition-topic shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: topicBuildValueArray(), topicCollectionToDisplay(), topicCollectionToOdbc(), topicDisplayToCollection(), topicGet(), topicGetObject(), topicGetObjectId(), topicGetSwizzled(), topicIsValid(), topicOdbcToCollection(), topicSet(), topicSetObject(), topicSetObjectId()
property transform as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "transform", XMLPROJECTION = "ELEMENT");
Reference

Transform to apply the template.

StructureMap

Property methods: transformGet(), transformGetSwizzled(), transformIsValid(), transformNewObject(), transformSet()
property url as %String (MAXLEN = 1000000, XMLNAME = "url", XMLPROJECTION = "ATTRIBUTE");
uri

Logical URI to reference this activity definition (globally unique)

Property methods: urlDisplayToLogical(), urlGet(), urlIsValid(), urlLogicalToDisplay(), urlLogicalToOdbc(), urlNormalize(), urlSet()
property usage as %String (MAXLEN = 1000000, XMLNAME = "usage", XMLPROJECTION = "ATTRIBUTE");
string

Describes the clinical usage of the asset.

Property methods: usageDisplayToLogical(), usageGet(), usageIsValid(), usageLogicalToDisplay(), usageLogicalToOdbc(), usageNormalize(), usageSet()
property useContext as list of HS.FHIR.DTL.vSTU3.Model.Datatype.UsageContext (XMLNAME = "useContext", XMLPROJECTION = "ELEMENT");
UsageContext

Context the content is intended to support.

Property methods: useContextBuildValueArray(), useContextCollectionToDisplay(), useContextCollectionToOdbc(), useContextDisplayToCollection(), useContextGet(), useContextGetObject(), useContextGetObjectId(), useContextGetSwizzled(), useContextIsValid(), useContextOdbcToCollection(), useContextSet(), useContextSetObject(), useContextSetObjectId()
property version as %String (MAXLEN = 1000000, XMLNAME = "version", XMLPROJECTION = "ATTRIBUTE");
string

Business version of the activity definition.

Property methods: versionDisplayToLogical(), versionGet(), versionIsValid(), versionLogicalToDisplay(), versionLogicalToOdbc(), versionNormalize(), versionSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab