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
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. |
Control | 1..1 |
ModuleMetadata.identifier | |
Definition | A logical identifier for the module such as the CMS or NQF identifiers for a measure artifact. |
Note | This is a business identifer, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
Summary | true |
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. |
Note | This is a business versionId, not a resource identifier (see discussion) |
Control | 0..1 |
Type | string |
Summary | true |
ModuleMetadata.title | |
Definition | A short, descriptive title for the module. |
Control | 0..1 |
Type | string |
Summary | true |
ModuleMetadata.type | |
Definition | Identifies the type of knowledge module, such as a rule, library, documentation template, or measure. |
Control | 1..1 |
Binding | ModuleMetadataType: The type of knowledge module being described (Extensible) |
Type | code |
Is Modifier | true |
Summary | true |
ModuleMetadata.status | |
Definition | The status of the module. |
Control | 1..1 |
Binding | ModuleMetadataStatus: The status of the knowledge module (Required) |
Type | code |
Is Modifier | true |
Summary | true |
ModuleMetadata.description | |
Definition | A description of the module from the consumer perspective. |
Control | 0..1 |
Type | string |
ModuleMetadata.purpose | |
Definition | A brief description of the purpose of the module. |
Control | 0..1 |
Type | string |
ModuleMetadata.usage | |
Definition | Notes about usage of the module. |
Control | 0..1 |
Type | string |
ModuleMetadata.publicationDate | |
Definition | The date on which the module was published. |
Control | 0..1 |
Type | date |
ModuleMetadata.lastReviewDate | |
Definition | The date on which the module content was last reviewed. |
Control | 0..1 |
Type | date |
ModuleMetadata.effectivePeriod | |
Definition | The period during which the module content is effective. |
Control | 0..1 |
Type | Period |
ModuleMetadata.coverage | |
Definition | Specifies various attributes of the patient population for whom and/or environment of care in which, the knowledge module is applicable. |
Control | 0..* |
ModuleMetadata.coverage.focus | |
Definition | Specifies the focus of the coverage attribute. |
Control | 1..1 |
Binding | ModuleMetadataFocusType: 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) |
Type | code |
ModuleMetadata.coverage.description | |
Definition | Provides an optional description of the coverage attribute. |
Control | 0..1 |
Type | string |
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. |
Control | 0..1 |
Type | CodeableConcept |
ModuleMetadata.topic | |
Definition | Clinical topics related to the content of the module. |
Control | 0..* |
Type | CodeableConcept |
ModuleMetadata.keyword | |
Definition | Keywords associated with the module. |
Control | 0..* |
Type | string |
ModuleMetadata.contributor | |
Definition | A contributor to the content of the module. |
Control | 0..* |
ModuleMetadata.contributor.type | |
Definition | The type of contributor. |
Control | 1..1 |
Binding | ModuleMetadataContributorType: The type of contributor (Required) |
Type | code |
ModuleMetadata.contributor.party | |
Definition | The contributor. |
Control | 1..1 |
Type | Reference(Person | Organization) |
ModuleMetadata.publisher | |
Definition | The organization responsible for publishing the module. |
Control | 0..1 |
Type | Reference(Organization) |
ModuleMetadata.steward | |
Definition | The organization responsible for stewardship of the module content. |
Control | 0..1 |
Type | Reference(Organization) |
ModuleMetadata.rightsDeclaration | |
Definition | The legal rights declaration for the module. |
Control | 0..1 |
Type | string |
ModuleMetadata.relatedResource | |
Definition | Related resources such as additional documentation, supporting evidence, or bibliographic references. |
Control | 0..* |
ModuleMetadata.relatedResource.type | |
Definition | The type of related resource. |
Control | 1..1 |
Binding | ModuleMetadataResourceType: The type of related resource for the module (Required) |
Type | code |
ModuleMetadata.relatedResource.uri | |
Definition | The uri of the related resource. |
Control | 0..1 |
Type | uri |
ModuleMetadata.relatedResource.description | |
Definition | A brief description of the related resource. |
Control | 0..1 |
Type | string |
ModuleMetadata.relatedResource.document | |
Definition | The document being referenced. |
Control | 0..1 |
Type | Attachment |