STU 3 Ballot

This page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

14.4.6 Resource DecisionSupportServiceModule - Detailed Descriptions

Detailed Descriptions for the elements in the DecisionSupportServiceModule resource.

DecisionSupportServiceModule
Definition

The DecisionSupportServiceModule describes a unit of decision support functionality that is made available as a service, such as immunization modules or drug-drug interaction checking.

Control1..1
DecisionSupportServiceModule.url
Definition

An absolute URL that is used to identify this module when it is referenced. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this module definition is (or will be) published.

Control0..1
Typeuri
Requirements

Allows the module to be referenced by a single globally unique identifier.

Summarytrue
DecisionSupportServiceModule.identifier
Definition

A logical identifier for the module such as the CMS or NQF identifiers for a measure artifact. Note that at least one identifier is required for non-experimental active artifacts.

NoteThis is a business identifer, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Requirements

Allows external business identifiers to be easily associated with the module.

Summarytrue
To DoAdd constraint to require an identifier for non-experimental active artifacts.
DecisionSupportServiceModule.version
Definition

The version of the module, if any. 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 modules, refer to the Decision Support Service specification. Note that a version is required for non-experimental published artifacts.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
Requirements

Allows for versioning of the content of the module.

Summarytrue
To DoAdd constraint to require a version for non-experimental active artifacts.
DecisionSupportServiceModule.name
Definition

A machine-friendly name for the module. This name should be usable as an identifier for the module by machine processing applications such as code generation.

Control0..1
Typestring
Requirements

Simplifies machine-processing tasks related to the module such as code-generation or logging.

Summarytrue
Comments

This identifier for the module should be unique within the intended scope of use, and should conform to the traditional syntactic definition of an identifier within most programming languages. regex: ([A-Za-z][A-Za-z0-9]*).

DecisionSupportServiceModule.title
Definition

A short, descriptive, user-friendly title for the module.

Control0..1
Typestring
Summarytrue
DecisionSupportServiceModule.status
Definition

The status of the module.

Control1..1
BindingLibraryStatus: The status of the decision support service module (Required)
Typecode
Is Modifiertrue
Requirements

Enables tracking the life-cycle of the content of the module.

Summarytrue
DecisionSupportServiceModule.experimental
Definition

Determines whether the module was developed for testing purposes (or education/evaluation/marketing), and is not intended to be used in production environments.

Control0..1
Typeboolean
Is Modifiertrue
Requirements

Enables experimental content to be developed following the same life-cycle as a production-level module would.

Summarytrue
DecisionSupportServiceModule.description
Definition

A free text natural language description of the module from the consumer's perspective.

Control0..1
Typestring
Comments

This description can be used to capture details such as why the module was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the module as conveyed in the text field of the resource itself. This item SHOULD be populated unless the information is available from context.

DecisionSupportServiceModule.purpose
Definition

A brief description of the purpose of the module.

Control0..1
Typestring
Comments

This description should address the question of why this module was built, though not necessarily in as much detail as the justification, rationale, or clinical recommendation statement of a measure would. That information would typically be provided in the related resource element.

DecisionSupportServiceModule.usage
Definition

A detailed description of how the module is used from a clinical perspective.

Control0..1
Typestring
DecisionSupportServiceModule.publicationDate
Definition

The date on which the module was published.

Control0..1
Typedate
DecisionSupportServiceModule.lastReviewDate
Definition

The date on which the module content was last reviewed.

Control0..1
Typedate
DecisionSupportServiceModule.effectivePeriod
Definition

The period during which the module content is effective.

Control0..1
TypePeriod
Comments

The effective period for a module determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 would be published in 2015.

DecisionSupportServiceModule.coverage
Definition

Specifies various attributes of the patient population for whom and/or environment of care in which, the knowledge module is applicable.

Control0..*
TypeUsageContext
Requirements

Consumers of the module must be able to determine the intended applicability for the module. Ideally, this information would be used programmatically to determine when and how it should be incorporated or exposed.

DecisionSupportServiceModule.topic
Definition

Clinical topics related to the content of the module.

Control0..*
TypeCodeableConcept
Requirements

Repositories must be able to determine how to categorize the module so that it can be found by topical searches.

DecisionSupportServiceModule.contributor
Definition

A contributor to the content of the module, including authors, editors, reviewers, and endorsers.

Control0..*
TypeContributor
Requirements

Consumers of the content must be able to quickly determine who contributed to the content of the knowledge module.

DecisionSupportServiceModule.publisher
Definition

The name of the individual or organization that published the module (also known as the steward for the module). This information is required for non-experimental published artifacts.

Control0..1
Typestring
Requirements

Consumers of the module must be able to determine where to obtain support in the use of this module, as well as where to direct questions and concerns about the content.

Comments

The publisher (or steward) of the module is the organization or individual primarily responsible for the maintenance and upkeep of the module. This is not necessarily the same organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the module.

To DoAdd constraint to require a publisher for non-experimental active artifacts.
DecisionSupportServiceModule.contact
Definition

Contact details to assist a user in finding and communicating with the publisher.

Control0..*
TypeContactDetail
DecisionSupportServiceModule.copyright
Definition

A copyright statement relating to the module and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the module.

Control0..1
Typestring
Requirements

Consumers of the module must be able to determine any legal restrictions on the use of the module and/or its content.

DecisionSupportServiceModule.relatedResource
Definition

Related resources such as additional documentation, justification, or bibliographic references.

Control0..*
TypeRelatedResource
Requirements

Modules 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.

Comments

Each related resource is either an attachment, or a reference to another resource, but not both.

DecisionSupportServiceModule.trigger
Definition

The trigger element defines when the rule should be invoked. This information is used by consumers of the rule to determine how to integrate the rule into a specific workflow.

Control0..*
TypeTriggerDefinition
DecisionSupportServiceModule.parameter
Definition

The parameters to the module. This collection specifies both the input and output parameters. Input parameters are provided by the caller as part of the $evaluate operation. Output parameters are included in the GuidanceResponse.

Control0..*
TypeParameterDefinition
DecisionSupportServiceModule.dataRequirement
Definition

Data requirements are a machine processable description of the data required by the module in order to perform a successful evaluation.

Control0..*
TypeDataRequirement