Data Model Libraries
    Preparing search index...

    Class ActivityDefinition

    ActivityDefinition Class

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

    FHIR Specification

    • Short: The definition of a specific activity to be taken, independent of any particular patient or context
    • Definition: This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.
    • FHIR Version: 5.0.0

    FHIR ActivityDefinition

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    url? identifier? version? versionAlgorithm? name? title? subtitle? publicationStatusEnum status experimental? subject? date? publisher? contact? description? useContext? jurisdiction? purpose? usage? copyright? copyrightLabel? approvalDate? lastReviewDate? effectivePeriod? topic? author? editor? reviewer? endorser? relatedArtifact? library? fhirTypesEnum kind? profile? code? requestIntentEnum intent? requestPriorityEnum priority? doNotPerform? timing? asNeeded? location? participant? product? quantity? dosage? bodySite? specimenRequirement? observationRequirement? observationResultRequirement? transform? dynamicValue?

    Methods

    parse getUrlElement setUrlElement hasUrlElement getUrl setUrl hasUrl getIdentifier setIdentifier addIdentifier hasIdentifier getVersionElement setVersionElement hasVersionElement getVersion setVersion hasVersion getVersionAlgorithm setVersionAlgorithm hasVersionAlgorithm getVersionAlgorithmStringType hasVersionAlgorithmStringType getVersionAlgorithmCoding hasVersionAlgorithmCoding getNameElement setNameElement hasNameElement getName setName hasName getTitleElement setTitleElement hasTitleElement getTitle setTitle hasTitle getSubtitleElement setSubtitleElement hasSubtitleElement getSubtitle setSubtitle hasSubtitle getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getExperimentalElement setExperimentalElement hasExperimentalElement getExperimental setExperimental hasExperimental getSubject setSubject hasSubject getSubjectCodeableConcept hasSubjectCodeableConcept getSubjectReference hasSubjectReference getSubjectCanonicalType hasSubjectCanonicalType getDateElement setDateElement hasDateElement getDate setDate hasDate getPublisherElement setPublisherElement hasPublisherElement getPublisher setPublisher hasPublisher getContact setContact addContact hasContact getDescriptionElement setDescriptionElement hasDescriptionElement getDescription setDescription hasDescription getUseContext setUseContext addUseContext hasUseContext getJurisdiction setJurisdiction addJurisdiction hasJurisdiction getPurposeElement setPurposeElement hasPurposeElement getPurpose setPurpose hasPurpose getUsageElement setUsageElement hasUsageElement getUsage setUsage hasUsage getCopyrightElement setCopyrightElement hasCopyrightElement getCopyright setCopyright hasCopyright getCopyrightLabelElement setCopyrightLabelElement hasCopyrightLabelElement getCopyrightLabel setCopyrightLabel hasCopyrightLabel getApprovalDateElement setApprovalDateElement hasApprovalDateElement getApprovalDate setApprovalDate hasApprovalDate getLastReviewDateElement setLastReviewDateElement hasLastReviewDateElement getLastReviewDate setLastReviewDate hasLastReviewDate getEffectivePeriod setEffectivePeriod hasEffectivePeriod getTopic setTopic addTopic hasTopic getAuthor setAuthor addAuthor hasAuthor getEditor setEditor addEditor hasEditor getReviewer setReviewer addReviewer hasReviewer getEndorser setEndorser addEndorser hasEndorser getRelatedArtifact setRelatedArtifact addRelatedArtifact hasRelatedArtifact getLibraryElement setLibraryElement addLibraryElement hasLibraryElement getLibrary setLibrary addLibrary hasLibrary getKindEnumType setKindEnumType hasKindEnumType getKindElement setKindElement hasKindElement getKind setKind hasKind getProfileElement setProfileElement hasProfileElement getProfile setProfile hasProfile getCode setCode hasCode getIntentEnumType setIntentEnumType hasIntentEnumType getIntentElement setIntentElement hasIntentElement getIntent setIntent hasIntent getPriorityEnumType setPriorityEnumType hasPriorityEnumType getPriorityElement setPriorityElement hasPriorityElement getPriority setPriority hasPriority getDoNotPerformElement setDoNotPerformElement hasDoNotPerformElement getDoNotPerform setDoNotPerform hasDoNotPerform getTiming setTiming hasTiming getTimingTiming hasTimingTiming getTimingAge hasTimingAge getTimingRange hasTimingRange getTimingDuration hasTimingDuration getAsNeeded setAsNeeded hasAsNeeded getAsNeededBooleanType hasAsNeededBooleanType getAsNeededCodeableConcept hasAsNeededCodeableConcept getLocation setLocation hasLocation getParticipant setParticipant addParticipant hasParticipant getProduct setProduct hasProduct getProductReference hasProductReference getProductCodeableConcept hasProductCodeableConcept getQuantity setQuantity hasQuantity getDosage setDosage addDosage hasDosage getBodySite setBodySite addBodySite hasBodySite getSpecimenRequirementElement setSpecimenRequirementElement addSpecimenRequirementElement hasSpecimenRequirementElement getSpecimenRequirement setSpecimenRequirement addSpecimenRequirement hasSpecimenRequirement getObservationRequirementElement setObservationRequirementElement addObservationRequirementElement hasObservationRequirementElement getObservationRequirement setObservationRequirement addObservationRequirement hasObservationRequirement getObservationResultRequirementElement setObservationResultRequirementElement addObservationResultRequirementElement hasObservationResultRequirementElement getObservationResultRequirement setObservationResultRequirement addObservationResultRequirement hasObservationResultRequirement getTransformElement setTransformElement hasTransformElement getTransform setTransform hasTransform getDynamicValue setDynamicValue addDynamicValue hasDynamicValue fhirType isEmpty isRequiredFieldsEmpty copy toJSON getText setText hasText getContained setContained addContained hasContained getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension resourceType getIdElement setIdElement hasIdElement getId setId hasId getMeta setMeta hasMeta getImplicitRulesElement setImplicitRulesElement hasImplicitRulesElement getImplicitRules setImplicitRules hasImplicitRules getLanguageElement setLanguageElement hasLanguageElement getLanguage setLanguage hasLanguage isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initIdentifier initContact initUseContext initJurisdiction initTopic initAuthor initEditor initReviewer initEndorser initRelatedArtifact initLibrary initParticipant initDosage initBodySite initSpecimenRequirement initObservationRequirement initObservationResultRequirement initDynamicValue

    Constructors

    Properties

    url?: UriType

    ActivityDefinition.url Element

    FHIR Specification

    • Short: Canonical identifier for this activity definition, represented as a URI (globally unique)
    • Definition: An absolute URI that is used to identify this activity definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this activity definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the activity definition is stored on different servers.
    • Comment: Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions. In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found.
    • Requirements: Allows the activity definition to be referenced by a single globally unique identifier.
    • FHIR Type: uri
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    identifier?: Identifier[]

    ActivityDefinition.identifier Element

    FHIR Specification

    • Short: Additional identifier for the activity definition
    • Definition: A formal identifier that is used to identify this activity definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
    • Comment: Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this activity definition outside of FHIR, where it is not possible to use the logical URI.
    • Requirements: Allows externally provided and/or usable business identifiers to be easily associated with the module.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    version?: StringType

    ActivityDefinition.version Element

    FHIR Specification

    • Short: Business version of the activity definition
    • Definition: The identifier that is used to identify this version of the activity definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the activity definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active assets.
    • Comment: There may be different activity definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the activity definition with the format [url]|[version]. The version SHOULD NOT contain a '#' - see Business Version.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    versionAlgorithm?: IDataType

    ActivityDefinition.versionAlgorithm[x] Element

    @ChoiceDataTypesMeta('ActivityDefinition.versionAlgorithm[x]', ['string','Coding',]

    FHIR Specification

    • Short: How to compare versions
    • Definition: Indicates the mechanism used to compare versions to determine which is more current.
    • Comment: If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.
    • FHIR Types: 'string', 'Coding',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    name?: StringType

    ActivityDefinition.name Element

    FHIR Specification

    • Short: Name for this activity definition (computer friendly)
    • Definition: A natural language name identifying the activity definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
    • Comment: The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.
    • Requirements: Support human navigation and code generation.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    title?: StringType

    ActivityDefinition.title Element

    FHIR Specification

    • Short: Name for this activity definition (human friendly)
    • Definition: A short, descriptive, user-friendly title for the activity definition.
    • Comment: This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    subtitle?: StringType

    ActivityDefinition.subtitle Element

    FHIR Specification

    • Short: Subordinate title of the activity definition
    • Definition: An explanatory or alternate title for the activity definition giving additional information about its content.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    publicationStatusEnum: PublicationStatusEnum

    FHIR CodeSystem: PublicationStatus

    PublicationStatusEnum

    status: null | EnumCodeType

    ActivityDefinition.status Element

    FHIR Specification

    • Short: draft | active | retired | unknown
    • Definition: The status of this activity definition. Enables tracking the life-cycle of the content.
    • Comment: Allows filtering of activity definitions that are appropriate for use versus not. See guidance around (not) making local changes to elements here.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: true
    • isModifierReason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
    • isSummary: true

    CodeSystem Enumeration: PublicationStatusEnum

    experimental?: BooleanType

    ActivityDefinition.experimental Element

    FHIR Specification

    • Short: For testing purposes, not real usage
    • Definition: A Boolean value to indicate that this activity definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
    • Comment: Allows filtering of activity definitions that are appropriate for use versus not.
    • Requirements: Enables experimental content to be developed following the same lifecycle that would be used for a production-level activity definition.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    subject?: IDataType

    ActivityDefinition.subject[x] Element

    @ChoiceDataTypesMeta('ActivityDefinition.subject[x]', ['CodeableConcept','Reference','canonical',]

    FHIR Specification

    • Short: Type of individual the activity definition is intended for
    • Definition: A code, group definition, or canonical reference that describes or identifies the intended subject of the activity being defined. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource.
    • Comment: Note that the choice of canonical for the subject element was introduced in R4B to support pharmaceutical quality use cases. To ensure as much backwards-compatibility as possible, it is recommended to only use the new canonical type with these use cases.
    • FHIR Types: 'CodeableConcept', 'Reference', 'canonical',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    date?: DateTimeType

    ActivityDefinition.date Element

    FHIR Specification

    • Short: Date last changed
    • Definition: The date (and optionally time) when the activity definition was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the activity definition changes.
    • Comment: The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the activity definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource. See guidance around (not) making local changes to elements here.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    publisher?: StringType

    ActivityDefinition.publisher Element

    FHIR Specification

    • Short: Name of the publisher/steward (organization or individual)
    • Definition: The name of the organization or individual responsible for the release and ongoing maintenance of the activity definition.
    • Comment: Usually an organization but may be an individual. The publisher (or steward) of the activity definition is the organization or individual primarily responsible for the maintenance and upkeep of the activity definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the activity definition. This item SHOULD be populated unless the information is available from context.
    • Requirements: Helps establish the "authority/credibility" of the activity definition. May also allow for contact.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    contact?: ContactDetail[]

    ActivityDefinition.contact Element

    FHIR Specification

    • Short: Contact details for the publisher
    • Definition: Contact details to assist a user in finding and communicating with the publisher.
    • Comment: May be a web site, an email address, a telephone number, etc. See guidance around (not) making local changes to elements here.
    • FHIR Type: ContactDetail
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    description?: MarkdownType

    ActivityDefinition.description Element

    FHIR Specification

    • Short: Natural language description of the activity definition
    • Definition: A free text natural language description of the activity definition from a consumer's perspective.
    • Comment: This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the activity definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the activity definition is presumed to be the predominant language in the place the activity definition was created).
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    useContext?: UsageContext[]

    ActivityDefinition.useContext Element

    FHIR Specification

    • Short: The context that the content is intended to support
    • Definition: The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate activity definition instances.
    • Comment: When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
    • Requirements: Assist in searching for appropriate content.
    • FHIR Type: UsageContext
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    jurisdiction?: CodeableConcept[]

    ActivityDefinition.jurisdiction Element

    FHIR Specification

    • Short: Intended jurisdiction for activity definition (if applicable)
    • Definition: A legal or geographic region in which the activity definition is intended to be used.
    • Comment: It may be possible for the activity definition to be used in jurisdictions other than those for which it was originally designed or intended. DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.)
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    purpose?: MarkdownType

    ActivityDefinition.purpose Element

    FHIR Specification

    • Short: Why this activity definition is defined
    • Definition: Explanation of why this activity definition is needed and why it has been designed as it has.
    • Comment: This element does not describe the usage of the activity definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this activity definition.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    usage?: MarkdownType

    ActivityDefinition.usage Element

    FHIR Specification

    • Short: Describes the clinical usage of the activity definition
    • Definition: A detailed description of how the activity definition is used from a clinical perspective.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    copyright?: MarkdownType

    ActivityDefinition.copyright Element

    FHIR Specification

    • Short: Use and/or publishing restrictions
    • Definition: A copyright statement relating to the activity definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the activity definition.
    • Comment: The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element.
    • Requirements: Consumers must be able to determine any legal restrictions on the use of the activity definition and/or its content.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    copyrightLabel?: StringType

    ActivityDefinition.copyrightLabel Element

    FHIR Specification

    • Short: Copyright holder and year(s)
    • Definition: A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').
    • Comment: The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.
    • Requirements: Defines the content expected to be rendered in all representations of the artifact.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    approvalDate?: DateType

    ActivityDefinition.approvalDate Element

    FHIR Specification

    • Short: When the activity definition was approved by publisher
    • Definition: The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
    • Comment: The 'date' element may be more recent than the approval date because of minor changes or editorial corrections. See guidance around (not) making local changes to elements here.
    • FHIR Type: date
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    lastReviewDate?: DateType

    ActivityDefinition.lastReviewDate Element

    FHIR Specification

    • Short: When the activity definition was last reviewed by the publisher
    • Definition: The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
    • Comment: If specified, this date follows the original approval date. See guidance around (not) making local changes to elements here.
    • Requirements: Gives a sense of how "current" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.
    • FHIR Type: date
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    effectivePeriod?: Period

    ActivityDefinition.effectivePeriod Element

    FHIR Specification

    • Short: When the activity definition is expected to be used
    • Definition: The period during which the activity definition content was or is planned to be in active use.
    • Comment: The effective period for an activity definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a activity intended to be used for the year 2016 might be published in 2015. See guidance around (not) making local changes to elements here.
    • Requirements: Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the activity definition are or are expected to be used instead.
    • FHIR Type: Period
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    topic?: CodeableConcept[]

    ActivityDefinition.topic Element

    FHIR Specification

    • Short: E.g. Education, Treatment, Assessment, etc
    • Definition: Descriptive topics related to the content of the activity. Topics provide a high-level categorization of the activity that can be useful for filtering and searching.
    • Comment: DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'topic' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#topic and useContext.valueCodeableConcept indicating the topic)
    • Requirements: Repositories must be able to determine how to categorize the activity definition so that it can be found by topical searches.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    author?: ContactDetail[]

    ActivityDefinition.author Element

    FHIR Specification

    • Short: Who authored the content
    • Definition: An individiual or organization primarily involved in the creation and maintenance of the content.
    • FHIR Type: ContactDetail
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    editor?: ContactDetail[]

    ActivityDefinition.editor Element

    FHIR Specification

    • Short: Who edited the content
    • Definition: An individual or organization primarily responsible for internal coherence of the content.
    • FHIR Type: ContactDetail
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    reviewer?: ContactDetail[]

    ActivityDefinition.reviewer Element

    FHIR Specification

    • Short: Who reviewed the content
    • Definition: An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the content.
    • Comment: See guidance around (not) making local changes to elements here.
    • FHIR Type: ContactDetail
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    endorser?: ContactDetail[]

    ActivityDefinition.endorser Element

    FHIR Specification

    • Short: Who endorsed the content
    • Definition: An individual or organization asserted by the publisher to be responsible for officially endorsing the content for use in some setting.
    • Comment: See guidance around (not) making local changes to elements here.
    • FHIR Type: ContactDetail
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    relatedArtifact?: RelatedArtifact[]

    ActivityDefinition.relatedArtifact Element

    FHIR Specification

    • Short: Additional documentation, citations, etc
    • Definition: Related artifacts such as additional documentation, justification, or bibliographic references.
    • Comment: Each related artifact is either an attachment, or a reference to another resource, but not both.
    • Requirements: Activity definitions must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.
    • FHIR Type: RelatedArtifact
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    library?: CanonicalType[]

    ActivityDefinition.library Element

    FHIR Specification

    • Short: Logic used by the activity definition
    • Definition: A reference to a Library resource containing any formal logic used by the activity definition.
    • FHIR Type: canonical
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    fhirTypesEnum: FhirTypesEnum

    FHIR CodeSystem: FhirTypes

    FhirTypesEnum

    kind?: EnumCodeType

    ActivityDefinition.kind Element

    FHIR Specification

    • Short: Kind of resource
    • Definition: A description of the kind of resource the activity definition is representing. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest.
    • Comment: The kind element may only specify Request resource types to facilitate considering user input as part of processing the result of any automated clinical reasoning processes. To support creation of event resources, such as Observations, RiskAssessments, and DetectedIssues, use a Task resource with the focus of the task set to the event resource to be created. Note that the kind of resource to be created may determine what types of extensions are permitted.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: FhirTypesEnum

    profile?: CanonicalType

    ActivityDefinition.profile Element

    FHIR Specification

    • Short: What profile the resource needs to conform to
    • Definition: A profile to which the target of the activity definition is expected to conform.
    • Requirements: Allows profiles to be used to describe the types of activities that can be performed within a workflow, protocol, or order set.
    • FHIR Type: canonical
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    code?: CodeableConcept

    ActivityDefinition.code Element

    FHIR Specification

    • Short: Detail type of activity
    • Definition: Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.
    • Comment: Tends to be less relevant for activities involving particular products.
    • Requirements: Allows matching performed to planned as well as validation against protocols.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    requestIntentEnum: RequestIntentEnum

    FHIR CodeSystem: RequestIntent

    RequestIntentEnum

    intent?: EnumCodeType

    ActivityDefinition.intent Element

    FHIR Specification

    • Short: proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
    • Definition: Indicates the level of authority/intentionality associated with the activity and where the request should fit into the workflow chain.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    CodeSystem Enumeration: RequestIntentEnum

    requestPriorityEnum: RequestPriorityEnum

    FHIR CodeSystem: RequestPriority

    RequestPriorityEnum

    priority?: EnumCodeType

    ActivityDefinition.priority Element

    FHIR Specification

    • Short: routine | urgent | asap | stat
    • Definition: Indicates how quickly the activity should be addressed with respect to other requests.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    CodeSystem Enumeration: RequestPriorityEnum

    doNotPerform?: BooleanType

    ActivityDefinition.doNotPerform Element

    FHIR Specification

    • Short: True if the activity should not be performed
    • Definition: Set this to true if the definition is to indicate that a particular activity should NOT be performed. If true, this element should be interpreted to reinforce a negative coding. For example NPO as a code with a doNotPerform of true would still indicate to NOT perform the action.
    • Comment: This element is not intended to be used to communicate a decision support response to cancel an order in progress. That should be done with the "remove" type of a PlanDefinition or RequestOrchestration.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: true
    • isModifierReason: If true this element negates the specified action. For Example, instead of a request for a procedure, it is a request for the procedure to not occur.
    • isSummary: true
    timing?: IDataType

    ActivityDefinition.timing[x] Element

    @ChoiceDataTypesMeta('ActivityDefinition.timing[x]', ['Timing','Age','Range','Duration',]

    FHIR Specification

    • Short: When activity is to occur
    • Definition: The timing or frequency upon which the described activity is to occur.
    • Comment: The intent of the timing element is to provide timing when the action should be performed. As a definitional resource, this timing is interpreted as part of an apply operation so that the timing of the result actions in a CarePlan or RequestOrchestration, for example, would be specified by evaluating the timing definition in the context of the apply and setting the resulting timing on the appropriate elements of the target resource. If the timing is an Age, the activity is expected to be performed when the subject is the given Age. When the timing is a Duration, the activity is expected to be performed within the specified duration from the apply. When the timing is a Range, it may be a range of Ages or Durations, providing a range for the expected timing of the resulting activity. When the timing is a Timing, it is establishing a schedule for the timing of the resulting activity.
    • Requirements: Allows prompting for activities and detection of missed planned activities.
    • FHIR Types: 'Timing', 'Age', 'Range', 'Duration',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    asNeeded?: IDataType

    ActivityDefinition.asNeeded[x] Element

    @ChoiceDataTypesMeta('ActivityDefinition.asNeeded[x]', ['boolean','CodeableConcept',]

    FHIR Specification

    • Short: Preconditions for service
    • Definition: If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc.
    • FHIR Types: 'boolean', 'CodeableConcept',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    location?: CodeableReference

    ActivityDefinition.location Element

    FHIR Specification

    • Short: Where it should happen
    • Definition: Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.
    • Comment: May reference a specific clinical location or may just identify a type of location.
    • Requirements: Helps in planning of activity.
    • FHIR Type: CodeableReference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    participant?: ActivityDefinitionParticipantComponent[]

    ActivityDefinition.participant Element

    FHIR Specification

    • Short: Who should participate in the action
    • Definition: Indicates who should participate in performing the action described.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    product?: IDataType

    ActivityDefinition.product[x] Element

    @ChoiceDataTypesMeta('ActivityDefinition.product[x]', ['Reference','CodeableConcept',]

    FHIR Specification

    • Short: What's administered/supplied
    • Definition: Identifies the food, drug or other product being consumed or supplied in the activity.
    • FHIR Types: 'Reference', 'CodeableConcept',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    quantity?: Quantity

    ActivityDefinition.quantity Element

    FHIR Specification

    • Short: How much is administered/consumed/supplied
    • Definition: Identifies the quantity expected to be consumed at once (per dose, per meal, etc.).
    • FHIR Type: Quantity
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    dosage?: Dosage[]

    ActivityDefinition.dosage Element

    FHIR Specification

    • Short: Detailed dosage instructions
    • Definition: Provides detailed dosage instructions in the same way that they are described for MedicationRequest resources.
    • Comment: If a dosage instruction is used, the definition should not specify timing or quantity.
    • FHIR Type: Dosage
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    bodySite?: CodeableConcept[]

    ActivityDefinition.bodySite Element

    FHIR Specification

    • Short: What part of body to perform on
    • Definition: Indicates the sites on the subject's body where the procedure should be performed (I.e. the target sites).
    • Comment: Only used if not implicit in the code found in ServiceRequest.type.
    • Requirements: Knowing where the procedure is made is important for tracking if multiple sites are possible.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    specimenRequirement?: CanonicalType[]

    ActivityDefinition.specimenRequirement Element

    FHIR Specification

    • Short: What specimens are required to perform this action
    • Definition: Defines specimen requirements for the action to be performed, such as required specimens for a lab test.
    • Requirements: Needed to represent lab order definitions.
    • FHIR Type: canonical
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    observationRequirement?: CanonicalType[]

    ActivityDefinition.observationRequirement Element

    FHIR Specification

    • Short: What observations are required to perform this action
    • Definition: Defines observation requirements for the action to be performed, such as body weight or surface area.
    • Requirements: Needed to represent observation definitions.
    • FHIR Type: canonical
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    observationResultRequirement?: CanonicalType[]

    ActivityDefinition.observationResultRequirement Element

    FHIR Specification

    transform?: CanonicalType

    ActivityDefinition.transform Element

    FHIR Specification

    • Short: Transform to apply the template
    • Definition: A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.
    • Comment: Note that if both a transform and dynamic values are specified, the dynamic values will be applied to the result of the transform.
    • FHIR Type: canonical
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    dynamicValue?: ActivityDefinitionDynamicValueComponent[]

    ActivityDefinition.dynamicValue Element

    FHIR Specification

    • Short: Dynamic aspects of the definition
    • Definition: Dynamic values that will be evaluated to produce values for elements of the resulting resource. For example, if the dosage of a medication must be computed based on the patient's weight, a dynamic value would be used to specify an expression that calculated the weight, and the path on the request resource that would contain the result.
    • Comment: Dynamic values are applied in the order in which they are defined in the ActivityDefinition. Note that if both a transform and dynamic values are specified, the dynamic values will be applied to the result of the transform.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

    • Parse the provided ActivityDefinition JSON to instantiate the ActivityDefinition data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR ActivityDefinition

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to ActivityDefinition

      Returns undefined | ActivityDefinition

      ActivityDefinition data model or undefined for ActivityDefinition

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided value to the text property.

      Parameters

      Returns this

      this

    • Returns boolean

      true if the text property exists and has a value; false otherwise

    • Assigns the provided Resource array value to the contained property.

      Parameters

      • value: undefined | IResource[]

        the contained array value

      Returns this

      this

    • Returns boolean

      true if the contained property exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Determines if the modifierExtension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the modifierExtension property exists and has any values.

      AssertionError for invalid url

    • Assigns the provided PrimitiveType value to the id property.

      Parameters

      • element: undefined | IdType

        the id value

      Returns this

      this

    • Returns undefined | string

      the id property value as a primitive value

    • Assigns the provided primitive value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Assigns the provided value to the meta property.

      Parameters

      • value: undefined | Meta

        the meta value

      Returns this

      this

    • Returns boolean

      true if the meta property exists and has a value; false otherwise

    • Assigns the provided primitive value to the implicitRules property.

      Parameters

      • value: undefined | string

        the implicitRules value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns undefined | string

      the language property value as a primitive value

    • Assigns the provided primitive value to the language property.

      Parameters

      • value: undefined | string

        the language value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the language property exists and has a value; false otherwise

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetUrlElementsetUrlElementhasUrlElementgetUrlsetUrlhasUrlgetIdentifiersetIdentifieraddIdentifierhasIdentifiergetVersionElementsetVersionElementhasVersionElementgetVersionsetVersionhasVersiongetVersionAlgorithmsetVersionAlgorithmhasVersionAlgorithmgetVersionAlgorithmStringTypehasVersionAlgorithmStringTypegetVersionAlgorithmCodinghasVersionAlgorithmCodinggetNameElementsetNameElementhasNameElementgetNamesetNamehasNamegetTitleElementsetTitleElementhasTitleElementgetTitlesetTitlehasTitlegetSubtitleElementsetSubtitleElementhasSubtitleElementgetSubtitlesetSubtitlehasSubtitlegetStatusEnumTypesetStatusEnumTypehasStatusEnumTypegetStatusElementsetStatusElementhasStatusElementgetStatussetStatushasStatusgetExperimentalElementsetExperimentalElementhasExperimentalElementgetExperimentalsetExperimentalhasExperimentalgetSubjectsetSubjecthasSubjectgetSubjectCodeableConcepthasSubjectCodeableConceptgetSubjectReferencehasSubjectReferencegetSubjectCanonicalTypehasSubjectCanonicalTypegetDateElementsetDateElementhasDateElementgetDatesetDatehasDategetPublisherElementsetPublisherElementhasPublisherElementgetPublishersetPublisherhasPublishergetContactsetContactaddContacthasContactgetDescriptionElementsetDescriptionElementhasDescriptionElementgetDescriptionsetDescriptionhasDescriptiongetUseContextsetUseContextaddUseContexthasUseContextgetJurisdictionsetJurisdictionaddJurisdictionhasJurisdictiongetPurposeElementsetPurposeElementhasPurposeElementgetPurposesetPurposehasPurposegetUsageElementsetUsageElementhasUsageElementgetUsagesetUsagehasUsagegetCopyrightElementsetCopyrightElementhasCopyrightElementgetCopyrightsetCopyrighthasCopyrightgetCopyrightLabelElementsetCopyrightLabelElementhasCopyrightLabelElementgetCopyrightLabelsetCopyrightLabelhasCopyrightLabelgetApprovalDateElementsetApprovalDateElementhasApprovalDateElementgetApprovalDatesetApprovalDatehasApprovalDategetLastReviewDateElementsetLastReviewDateElementhasLastReviewDateElementgetLastReviewDatesetLastReviewDatehasLastReviewDategetEffectivePeriodsetEffectivePeriodhasEffectivePeriodgetTopicsetTopicaddTopichasTopicgetAuthorsetAuthoraddAuthorhasAuthorgetEditorsetEditoraddEditorhasEditorgetReviewersetRevieweraddReviewerhasReviewergetEndorsersetEndorseraddEndorserhasEndorsergetRelatedArtifactsetRelatedArtifactaddRelatedArtifacthasRelatedArtifactgetLibraryElementsetLibraryElementaddLibraryElementhasLibraryElementgetLibrarysetLibraryaddLibraryhasLibrarygetKindEnumTypesetKindEnumTypehasKindEnumTypegetKindElementsetKindElementhasKindElementgetKindsetKindhasKindgetProfileElementsetProfileElementhasProfileElementgetProfilesetProfilehasProfilegetCodesetCodehasCodegetIntentEnumTypesetIntentEnumTypehasIntentEnumTypegetIntentElementsetIntentElementhasIntentElementgetIntentsetIntenthasIntentgetPriorityEnumTypesetPriorityEnumTypehasPriorityEnumTypegetPriorityElementsetPriorityElementhasPriorityElementgetPrioritysetPriorityhasPrioritygetDoNotPerformElementsetDoNotPerformElementhasDoNotPerformElementgetDoNotPerformsetDoNotPerformhasDoNotPerformgetTimingsetTiminghasTiminggetTimingTiminghasTimingTiminggetTimingAgehasTimingAgegetTimingRangehasTimingRangegetTimingDurationhasTimingDurationgetAsNeededsetAsNeededhasAsNeededgetAsNeededBooleanTypehasAsNeededBooleanTypegetAsNeededCodeableConcepthasAsNeededCodeableConceptgetLocationsetLocationhasLocationgetParticipantsetParticipantaddParticipanthasParticipantgetProductsetProducthasProductgetProductReferencehasProductReferencegetProductCodeableConcepthasProductCodeableConceptgetQuantitysetQuantityhasQuantitygetDosagesetDosageaddDosagehasDosagegetBodySitesetBodySiteaddBodySitehasBodySitegetSpecimenRequirementElementsetSpecimenRequirementElementaddSpecimenRequirementElementhasSpecimenRequirementElementgetSpecimenRequirementsetSpecimenRequirementaddSpecimenRequirementhasSpecimenRequirementgetObservationRequirementElementsetObservationRequirementElementaddObservationRequirementElementhasObservationRequirementElementgetObservationRequirementsetObservationRequirementaddObservationRequirementhasObservationRequirementgetObservationResultRequirementElementsetObservationResultRequirementElementaddObservationResultRequirementElementhasObservationResultRequirementElementgetObservationResultRequirementsetObservationResultRequirementaddObservationResultRequirementhasObservationResultRequirementgetTransformElementsetTransformElementhasTransformElementgetTransformsetTransformhasTransformgetDynamicValuesetDynamicValueaddDynamicValuehasDynamicValuefhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitContactinitUseContextinitJurisdictioninitTopicinitAuthorinitEditorinitReviewerinitEndorserinitRelatedArtifactinitLibraryinitParticipantinitDosageinitBodySiteinitSpecimenRequirementinitObservationRequirementinitObservationResultRequirementinitDynamicValue