The definition of a specific activity to be taken,
independent of any particular patient or context.
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()
ContactDetail
Who authored the content.
Property methods: authorBuildValueArray(), authorCollectionToDisplay(), authorCollectionToOdbc(), authorDisplayToCollection(), authorGet(), authorGetObject(), authorGetObjectId(), authorGetSwizzled(), authorIsValid(), authorOdbcToCollection(), authorSet(), authorSetObject(), authorSetObjectId()
property bodySite as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "bodySite", XMLPROJECTION = "ELEMENT");
CodeableConcept
What part of body to perform on.
any FHIR4 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()
CodeableConcept
Detail type of activity.
any FHIR4 code may be used;
procedure-code shows EXAMPLE codes,
but you may use codes from any ValueSet.
Property methods: codeGet(), codeGetSwizzled(), codeIsValid(), codeNewObject(), codeSet()
ContactDetail
Contact details for the publisher.
Property methods: contactBuildValueArray(), contactCollectionToDisplay(), contactCollectionToOdbc(), contactDisplayToCollection(), contactGet(), contactGetObject(), contactGetObjectId(), contactGetSwizzled(), contactIsValid(), contactOdbcToCollection(), contactSet(), contactSetObject(), contactSetObjectId()
property copyright as %String (MAXLEN = 1000000, XMLNAME = "copyright", XMLPROJECTION = "ATTRIBUTE");
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 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()
boolean
True if the activity should not be performed.
Property methods: doNotPerformDisplayToLogical(), doNotPerformGet(), doNotPerformIsValid(), doNotPerformLogicalToDisplay(), doNotPerformLogicalToXSD(), doNotPerformNormalize(), doNotPerformSet(), doNotPerformXSDToLogical()
Dosage
Detailed dosage instructions.
Property methods: dosageBuildValueArray(), dosageCollectionToDisplay(), dosageCollectionToOdbc(), dosageDisplayToCollection(), dosageGet(), dosageGetObject(), dosageGetObjectId(), dosageGetSwizzled(), dosageIsValid(), dosageOdbcToCollection(), dosageSet(), dosageSetObject(), dosageSetObjectId()
BackboneElement
Dynamic aspects of the definition.
Property methods: dynamicValueBuildValueArray(), dynamicValueCollectionToDisplay(), dynamicValueCollectionToOdbc(), dynamicValueDisplayToCollection(), dynamicValueGet(), dynamicValueGetObject(), dynamicValueGetObjectId(), dynamicValueGetSwizzled(), dynamicValueIsValid(), dynamicValueOdbcToCollection(), dynamicValueSet(), dynamicValueSetObject(), dynamicValueSetObjectId()
ContactDetail
Who edited the content.
Property methods: editorBuildValueArray(), editorCollectionToDisplay(), editorCollectionToOdbc(), editorDisplayToCollection(), editorGet(), editorGetObject(), editorGetObjectId(), editorGetSwizzled(), editorIsValid(), editorOdbcToCollection(), editorSet(), editorSetObject(), editorSetObjectId()
Period
When the activity definition is expected to be used.
Property methods: effectivePeriodGet(), effectivePeriodGetSwizzled(), effectivePeriodIsValid(), effectivePeriodNewObject(), effectivePeriodSet()
ContactDetail
Who endorsed the content.
Property methods: endorserBuildValueArray(), endorserCollectionToDisplay(), endorserCollectionToOdbc(), endorserDisplayToCollection(), endorserGet(), endorserGetObject(), endorserGetObjectId(), endorserGetSwizzled(), endorserIsValid(), endorserOdbcToCollection(), endorserSet(), endorserSetObject(), endorserSetObjectId()
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()
Identifier
Additional identifier for the activity definition.
Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property intent as %String (MAXLEN = 1000000, XMLNAME = "intent", XMLPROJECTION = "ATTRIBUTE");
code
proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
request-intent|4.0.1 is the REQUIRED FHIR4 ValueSet for codes;
you may NOT extend request-intent|4.0.1 and you may NOT use codes from other ValueSets.
Property methods: intentDisplayToLogical(), intentGet(), intentIsValid(), intentLogicalToDisplay(), intentLogicalToOdbc(), intentNormalize(), intentSet()
CodeableConcept
Intended jurisdiction for activity definition (if applicable)
jurisdiction is the REQUIRED FHIR4 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.
request-resource-types|4.0.1 is the REQUIRED FHIR4 ValueSet for codes;
you may NOT extend request-resource-types|4.0.1 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 %String (MAXLEN = 1000000, XMLNAME = "library", XMLPROJECTION = "ELEMENT");
canonical
Logic used by the activity definition.
TO DO: Unrecognized value type for the FHIR4 model
Property methods: libraryBuildValueArray(), libraryCollectionToDisplay(), libraryCollectionToOdbc(), libraryDisplayToCollection(), libraryDisplayToLogical(), libraryGet(), libraryGetObject(), libraryGetObjectId(), libraryGetSwizzled(), libraryIsValid(), libraryLogicalToDisplay(), libraryLogicalToOdbc(), libraryNormalize(), libraryOdbcToCollection(), librarySet(), librarySetObject(), librarySetObjectId()
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()
Reference
What observations are required to perform this action.
ObservationDefinition
Property methods: observationRequirementBuildValueArray(), observationRequirementCollectionToDisplay(), observationRequirementCollectionToOdbc(), observationRequirementDisplayToCollection(), observationRequirementGet(), observationRequirementGetObject(), observationRequirementGetObjectId(), observationRequirementGetSwizzled(), observationRequirementIsValid(), observationRequirementOdbcToCollection(), observationRequirementSet(), observationRequirementSetObject(), observationRequirementSetObjectId()
Reference
What observations must be produced by this action.
ObservationDefinition
Property methods: observationResultRequirementBuildValueArray(), observationResultRequirementCollectionToDisplay(), observationResultRequirementCollectionToOdbc(), observationResultRequirementDisplayToCollection(), observationResultRequirementGet(), observationResultRequirementGetObject(), observationResultRequirementGetObjectId(), observationResultRequirementGetSwizzled(), observationResultRequirementIsValid(), observationResultRequirementOdbcToCollection(), observationResultRequirementSet(), observationResultRequirementSetObject(), observationResultRequirementSetObjectId()
BackboneElement
Who should participate in the action.
Property methods: participantBuildValueArray(), participantCollectionToDisplay(), participantCollectionToOdbc(), participantDisplayToCollection(), participantGet(), participantGetObject(), participantGetObjectId(), participantGetSwizzled(), participantIsValid(), participantOdbcToCollection(), participantSet(), participantSetObject(), participantSetObjectId()
property priority as %String (MAXLEN = 1000000, XMLNAME = "priority", XMLPROJECTION = "ATTRIBUTE");
code
routine | urgent | asap | stat
request-priority|4.0.1 is the REQUIRED FHIR4 ValueSet for codes;
you may NOT extend request-priority|4.0.1 and you may NOT use codes from other ValueSets.
Property methods: priorityDisplayToLogical(), priorityGet(), priorityIsValid(), priorityLogicalToDisplay(), priorityLogicalToOdbc(), priorityNormalize(), prioritySet()
CodeableConcept
What's administered/supplied.
any FHIR4 code may be used;
medication-codes shows EXAMPLE codes,
but you may use codes from any ValueSet.
Property methods: productCodeableConceptGet(), productCodeableConceptGetSwizzled(), productCodeableConceptIsValid(), productCodeableConceptNewObject(), productCodeableConceptSet()
Reference
What's administered/supplied.
Medication | Substance
Property methods: productReferenceGet(), productReferenceGetSwizzled(), productReferenceIsValid(), productReferenceNewObject(), productReferenceSet()
property profile as %String (MAXLEN = 1000000, XMLNAME = "profile", XMLPROJECTION = "ATTRIBUTE");
canonical
What profile the resource needs to conform to.
TO DO: Unrecognized value type for the FHIR4 model
Property methods: profileDisplayToLogical(), profileGet(), profileIsValid(), profileLogicalToDisplay(), profileLogicalToOdbc(), profileNormalize(), profileSet()
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()
Quantity
How much is administered/consumed/supplied.
Property methods: quantityGet(), quantityGetSwizzled(), quantityIsValid(), quantityNewObject(), quantitySet()
RelatedArtifact
Additional documentation,
citations,
etc.
Property methods: relatedArtifactBuildValueArray(), relatedArtifactCollectionToDisplay(), relatedArtifactCollectionToOdbc(), relatedArtifactDisplayToCollection(), relatedArtifactGet(), relatedArtifactGetObject(), relatedArtifactGetObjectId(), relatedArtifactGetSwizzled(), relatedArtifactIsValid(), relatedArtifactOdbcToCollection(), relatedArtifactSet(), relatedArtifactSetObject(), relatedArtifactSetObjectId()
ContactDetail
Who reviewed the content.
Property methods: reviewerBuildValueArray(), reviewerCollectionToDisplay(), reviewerCollectionToOdbc(), reviewerDisplayToCollection(), reviewerGet(), reviewerGetObject(), reviewerGetObjectId(), reviewerGetSwizzled(), reviewerIsValid(), reviewerOdbcToCollection(), reviewerSet(), reviewerSetObject(), reviewerSetObjectId()
Reference
What specimens are required to perform this action.
SpecimenDefinition
Property methods: specimenRequirementBuildValueArray(), specimenRequirementCollectionToDisplay(), specimenRequirementCollectionToOdbc(), specimenRequirementDisplayToCollection(), specimenRequirementGet(), specimenRequirementGetObject(), specimenRequirementGetObjectId(), specimenRequirementGetSwizzled(), specimenRequirementIsValid(), specimenRequirementOdbcToCollection(), specimenRequirementSet(), specimenRequirementSetObject(), specimenRequirementSetObjectId()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE") [ Required ];
code
draft | active | retired | unknown
publication-status|4.0.1 is the REQUIRED FHIR4 ValueSet for codes;
you may NOT extend publication-status|4.0.1 and you may NOT use codes from other ValueSets.
Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
CodeableConcept
Type of individual the activity definition is intended for.
subject-type is the REQUIRED FHIR4 ValueSet for codes,
but if you need to express meanings not found in subject-type,
you may formally EXTEND subject-type to add codes to it.
Property methods: subjectCodeableConceptGet(), subjectCodeableConceptGetSwizzled(), subjectCodeableConceptIsValid(), subjectCodeableConceptNewObject(), subjectCodeableConceptSet()
Reference
Type of individual the activity definition is intended for.
Group.
Property methods: subjectReferenceGet(), subjectReferenceGetSwizzled(), subjectReferenceIsValid(), subjectReferenceNewObject(), subjectReferenceSet()
property subtitle as %String (MAXLEN = 1000000, XMLNAME = "subtitle", XMLPROJECTION = "ATTRIBUTE");
string
Subordinate title of the activity definition.
Property methods: subtitleDisplayToLogical(), subtitleGet(), subtitleIsValid(), subtitleLogicalToDisplay(), subtitleLogicalToOdbc(), subtitleNormalize(), subtitleSet()
Age
When activity is to occur.
Property methods: timingAgeGet(), timingAgeGetSwizzled(), timingAgeIsValid(), timingAgeNewObject(), timingAgeSet()
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()
Duration
When activity is to occur.
Property methods: timingDurationGet(), timingDurationGetSwizzled(), timingDurationIsValid(), timingDurationNewObject(), timingDurationSet()
Period
When activity is to occur.
Property methods: timingPeriodGet(), timingPeriodGetSwizzled(), timingPeriodIsValid(), timingPeriodNewObject(), timingPeriodSet()
Range
When activity is to occur.
Property methods: timingRangeGet(), timingRangeGetSwizzled(), timingRangeIsValid(), timingRangeNewObject(), timingRangeSet()
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()
CodeableConcept
E.g.
Education,
Treatment,
Assessment,
etc.
any FHIR4 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()
canonical
Transform to apply the template.
TO DO: Unrecognized value type for the FHIR4 model
Property methods: transformDisplayToLogical(), transformGet(), transformIsValid(), transformLogicalToDisplay(), transformLogicalToOdbc(), transformNormalize(), transformSet()
property url as %String (MAXLEN = 1000000, XMLNAME = "url", XMLPROJECTION = "ATTRIBUTE");
uri
Canonical identifier for this activity definition,
represented as a URI (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 activity definition.
Property methods: usageDisplayToLogical(), usageGet(), usageIsValid(), usageLogicalToDisplay(), usageLogicalToOdbc(), usageNormalize(), usageSet()
property useContext as list of HS.FHIR.DTL.vR4.Model.Datatype.UsageContext (XMLNAME = "useContext", XMLPROJECTION = "ELEMENT");
UsageContext
The context that 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()