Connectathon 11 Snapshot

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

4.14.5 Resource ModuleMetadata - Detailed Descriptions

Detailed Descriptions for the elements in the ModuleMetadata resource.

ModuleMetadata
Definition

The ModuleMetadata resource defines the common metadata elements used by quality improvement artifacts. This information includes descriptive and topical metadata to enable repository searches, as well as governance and evidentiary support information.

Control1..1
ModuleMetadata.identifier
Definition

A logical identifier for the module such as the CMS or NQF identifiers for a measure artifact.

NoteThis is a business identifer, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Summarytrue
ModuleMetadata.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.

NoteThis is a business versionId, not a resource identifier (see discussion)
Control0..1
Typestring
Summarytrue
ModuleMetadata.title
Definition

A short, descriptive title for the module.

Control0..1
Typestring
Summarytrue
ModuleMetadata.type
Definition

Identifies the type of knowledge module, such as a rule, library, documentation template, or measure.

Control1..1
BindingModuleMetadataType: The type of knowledge module being described (Extensible)
Typecode
Is Modifiertrue
Summarytrue
ModuleMetadata.status
Definition

The status of the module.

Control1..1
BindingModuleMetadataStatus: The status of the knowledge module (Required)
Typecode
Is Modifiertrue
Summarytrue
ModuleMetadata.description
Definition

A description of the module from the consumer perspective.

Control0..1
Typestring
ModuleMetadata.purpose
Definition

A brief description of the purpose of the module.

Control0..1
Typestring
ModuleMetadata.usage
Definition

Notes about usage of the module.

Control0..1
Typestring
ModuleMetadata.publicationDate
Definition

The date on which the module was published.

Control0..1
Typedate
ModuleMetadata.lastReviewDate
Definition

The date on which the module content was last reviewed.

Control0..1
Typedate
ModuleMetadata.effectivePeriod
Definition

The period during which the module content is effective.

Control0..1
TypePeriod
ModuleMetadata.coverage
Definition

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

Control0..*
ModuleMetadata.coverage.focus
Definition

Specifies the focus of the coverage attribute.

Control1..1
BindingModuleMetadataFocusType: Specifies clinical metadata that can be used to retrieve, index and/or categorize the knowledge artifact. This metadata can either be specific to the applicable population (e.g., age category, DRG) or the specific context of care (e.g., venue, care setting, provider of care) (Extensible)
Typecode
ModuleMetadata.coverage.description
Definition

Provides an optional description of the coverage attribute.

Control0..1
Typestring
ModuleMetadata.coverage.value
Definition

Provides a value for the coverage attribute. Different values are appropriate in different focus areas, as specified in the description of values for focus.

Control0..1
TypeCodeableConcept
ModuleMetadata.topic
Definition

Clinical topics related to the content of the module.

Control0..*
TypeCodeableConcept
ModuleMetadata.keyword
Definition

Keywords associated with the module.

Control0..*
Typestring
ModuleMetadata.contributor
Definition

A contributor to the content of the module.

Control0..*
ModuleMetadata.contributor.type
Definition

The type of contributor.

Control1..1
BindingModuleMetadataContributorType: The type of contributor (Required)
Typecode
ModuleMetadata.contributor.party
Definition

The contributor.

Control1..1
TypeReference(Person | Organization)
ModuleMetadata.publisher
Definition

The organization responsible for publishing the module.

Control0..1
TypeReference(Organization)
ModuleMetadata.steward
Definition

The organization responsible for stewardship of the module content.

Control0..1
TypeReference(Organization)
ModuleMetadata.rightsDeclaration
Definition

The legal rights declaration for the module.

Control0..1
Typestring
ModuleMetadata.relatedResource
Definition

Related resources such as additional documentation, supporting evidence, or bibliographic references.

Control0..*
ModuleMetadata.relatedResource.type
Definition

The type of related resource.

Control1..1
BindingModuleMetadataResourceType: The type of related resource for the module (Required)
Typecode
ModuleMetadata.relatedResource.uri
Definition

The uri of the related resource.

Control0..1
Typeuri
ModuleMetadata.relatedResource.description
Definition

A brief description of the related resource.

Control0..1
Typestring
ModuleMetadata.relatedResource.document
Definition

The document being referenced.

Control0..1
TypeAttachment