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 Resource ModuleMetadata - Content

Clinical Decision Support Work GroupMaturity Level: 0Compartments: Not linked to any defined compartments

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.

4.14.1 Scope and Usage

This resource is a draft proposal for use as part of an approach to Clinical Quality within FHIR, and is documented as part of the Clinical Quality Improvement Framework Implementation Guide. Future updates to this resource will incorporate documentation from that guide.

This resource is referenced by DecisionSupportRule, DecisionSupportServiceModule, Library, Measure and OrderSet

4.14.2 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. ModuleMetadata DomainResourceDefines common metadata used by quality artifacts
... identifier Σ0..*IdentifierLogical identifier
... version Σ0..1stringThe version of the module, if any
... title Σ0..1string
... type ?! Σ1..1codemodule | library | decision-support-rule | documentation-template | order-set
ModuleMetadataType (Extensible)
... status ?! Σ1..1codedraft | test | active | inactive
ModuleMetadataStatus (Required)
... description 0..1string
... purpose 0..1string
... usage 0..1string
... publicationDate 0..1date
... lastReviewDate 0..1date
... effectivePeriod 0..1Period
... coverage 0..*BackboneElement
.... focus 1..1codepatient-gender | patient-age-group | clinical-focus | target-user | workflow-setting | workflow-task | clinical-venue
ModuleMetadataFocusType (Extensible)
.... description 0..1string
.... value 0..1CodeableConcept
... topic 0..*CodeableConcept
... keyword 0..*string
... contributor 0..*BackboneElement
.... type 1..1codeauthor | editor | reviewer | endorser
ModuleMetadataContributorType (Required)
.... party 1..1Reference(Person | Organization)
... publisher 0..1Reference(Organization)
... steward 0..1Reference(Organization)
... rightsDeclaration 0..1string
... relatedResource 0..*BackboneElement
.... type 1..1codedocumentation | evidence | citation | predecessor | successor | derived-from
ModuleMetadataResourceType (Required)
.... uri 0..1uri
.... description 0..1string
.... document 0..1Attachment

doco Documentation for this format

UML Diagram

ModuleMetadata (DomainResource)A logical identifier for the module such as the CMS or NQF identifiers for a measure artifactidentifier : Identifier [0..*]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 specificationversion : string [0..1]A short, descriptive title for the moduletitle : string [0..1]Identifies the type of knowledge module, such as a rule, library, documentation template, or measure (this element modifies the meaning of other elements)type : code [1..1] « The type of knowledge module being described (Strength=Extensible)ModuleMetadataType+ »The status of the module (this element modifies the meaning of other elements)status : code [1..1] « The status of the knowledge module (Strength=Required)ModuleMetadataStatus! »A description of the module from the consumer perspectivedescription : string [0..1]A brief description of the purpose of the modulepurpose : string [0..1]Notes about usage of the moduleusage : string [0..1]The date on which the module was publishedpublicationDate : date [0..1]The date on which the module content was last reviewedlastReviewDate : date [0..1]The period during which the module content is effectiveeffectivePeriod : Period [0..1]Clinical topics related to the content of the moduletopic : CodeableConcept [0..*]Keywords associated with the modulekeyword : string [0..*]The organization responsible for publishing the modulepublisher : Reference [0..1] « Organization »The organization responsible for stewardship of the module contentsteward : Reference [0..1] « Organization »The legal rights declaration for the modulerightsDeclaration : string [0..1]CoverageSpecifies the focus of the coverage attributefocus : code [1..1] « 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) (Strength=Extensible)ModuleMetadataFocusType+ »Provides an optional description of the coverage attributedescription : string [0..1]Provides a value for the coverage attribute. Different values are appropriate in different focus areas, as specified in the description of values for focusvalue : CodeableConcept [0..1]ContributorThe type of contributortype : code [1..1] « The type of contributor (Strength=Required)ModuleMetadataContributorType! »The contributorparty : Reference [1..1] « Person|Organization »RelatedResourceThe type of related resourcetype : code [1..1] « The type of related resource for the module (Strength=Required)ModuleMetadataResourceType! »The uri of the related resourceuri : uri [0..1]A brief description of the related resourcedescription : string [0..1]The document being referenceddocument : Attachment [0..1]Specifies various attributes of the patient population for whom and/or environment of care in which, the knowledge module is applicablecoverage[0..*]A contributor to the content of the modulecontributor[0..*]Related resources such as additional documentation, supporting evidence, or bibliographic referencesrelatedResource[0..*]

XML Template

<ModuleMetadata xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Logical identifier --></identifier>
 <version value="[string]"/><!-- 0..1 The version of the module, if any -->
 <title value="[string]"/><!-- 0..1  -->
 <type value="[code]"/><!-- 1..1 module | library | decision-support-rule | documentation-template | order-set -->
 <status value="[code]"/><!-- 1..1 draft | test | active | inactive -->
 <description value="[string]"/><!-- 0..1  -->
 <purpose value="[string]"/><!-- 0..1  -->
 <usage value="[string]"/><!-- 0..1  -->
 <publicationDate value="[date]"/><!-- 0..1  -->
 <lastReviewDate value="[date]"/><!-- 0..1  -->
 <effectivePeriod><!-- 0..1 Period  --></effectivePeriod>
 <coverage>  <!-- 0..* -->
  <focus value="[code]"/><!-- 1..1 patient-gender | patient-age-group | clinical-focus | target-user | workflow-setting | workflow-task | clinical-venue -->
  <description value="[string]"/><!-- 0..1  -->
  <value><!-- 0..1 CodeableConcept  --></value>
 </coverage>
 <topic><!-- 0..* CodeableConcept  --></topic>
 <keyword value="[string]"/><!-- 0..*  -->
 <contributor>  <!-- 0..* -->
  <type value="[code]"/><!-- 1..1 author | editor | reviewer | endorser -->
  <party><!-- 1..1 Reference(Person|Organization)  --></party>
 </contributor>
 <publisher><!-- 0..1 Reference(Organization)  --></publisher>
 <steward><!-- 0..1 Reference(Organization)  --></steward>
 <rightsDeclaration value="[string]"/><!-- 0..1  -->
 <relatedResource>  <!-- 0..* -->
  <type value="[code]"/><!-- 1..1 documentation | evidence | citation | predecessor | successor | derived-from -->
  <uri value="[uri]"/><!-- 0..1  -->
  <description value="[string]"/><!-- 0..1  -->
  <document><!-- 0..1 Attachment  --></document>
 </relatedResource>
</ModuleMetadata>

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. ModuleMetadata DomainResourceDefines common metadata used by quality artifacts
... identifier Σ0..*IdentifierLogical identifier
... version Σ0..1stringThe version of the module, if any
... title Σ0..1string
... type ?! Σ1..1codemodule | library | decision-support-rule | documentation-template | order-set
ModuleMetadataType (Extensible)
... status ?! Σ1..1codedraft | test | active | inactive
ModuleMetadataStatus (Required)
... description 0..1string
... purpose 0..1string
... usage 0..1string
... publicationDate 0..1date
... lastReviewDate 0..1date
... effectivePeriod 0..1Period
... coverage 0..*BackboneElement
.... focus 1..1codepatient-gender | patient-age-group | clinical-focus | target-user | workflow-setting | workflow-task | clinical-venue
ModuleMetadataFocusType (Extensible)
.... description 0..1string
.... value 0..1CodeableConcept
... topic 0..*CodeableConcept
... keyword 0..*string
... contributor 0..*BackboneElement
.... type 1..1codeauthor | editor | reviewer | endorser
ModuleMetadataContributorType (Required)
.... party 1..1Reference(Person | Organization)
... publisher 0..1Reference(Organization)
... steward 0..1Reference(Organization)
... rightsDeclaration 0..1string
... relatedResource 0..*BackboneElement
.... type 1..1codedocumentation | evidence | citation | predecessor | successor | derived-from
ModuleMetadataResourceType (Required)
.... uri 0..1uri
.... description 0..1string
.... document 0..1Attachment

doco Documentation for this format

UML Diagram

ModuleMetadata (DomainResource)A logical identifier for the module such as the CMS or NQF identifiers for a measure artifactidentifier : Identifier [0..*]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 specificationversion : string [0..1]A short, descriptive title for the moduletitle : string [0..1]Identifies the type of knowledge module, such as a rule, library, documentation template, or measure (this element modifies the meaning of other elements)type : code [1..1] « The type of knowledge module being described (Strength=Extensible)ModuleMetadataType+ »The status of the module (this element modifies the meaning of other elements)status : code [1..1] « The status of the knowledge module (Strength=Required)ModuleMetadataStatus! »A description of the module from the consumer perspectivedescription : string [0..1]A brief description of the purpose of the modulepurpose : string [0..1]Notes about usage of the moduleusage : string [0..1]The date on which the module was publishedpublicationDate : date [0..1]The date on which the module content was last reviewedlastReviewDate : date [0..1]The period during which the module content is effectiveeffectivePeriod : Period [0..1]Clinical topics related to the content of the moduletopic : CodeableConcept [0..*]Keywords associated with the modulekeyword : string [0..*]The organization responsible for publishing the modulepublisher : Reference [0..1] « Organization »The organization responsible for stewardship of the module contentsteward : Reference [0..1] « Organization »The legal rights declaration for the modulerightsDeclaration : string [0..1]CoverageSpecifies the focus of the coverage attributefocus : code [1..1] « 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) (Strength=Extensible)ModuleMetadataFocusType+ »Provides an optional description of the coverage attributedescription : string [0..1]Provides a value for the coverage attribute. Different values are appropriate in different focus areas, as specified in the description of values for focusvalue : CodeableConcept [0..1]ContributorThe type of contributortype : code [1..1] « The type of contributor (Strength=Required)ModuleMetadataContributorType! »The contributorparty : Reference [1..1] « Person|Organization »RelatedResourceThe type of related resourcetype : code [1..1] « The type of related resource for the module (Strength=Required)ModuleMetadataResourceType! »The uri of the related resourceuri : uri [0..1]A brief description of the related resourcedescription : string [0..1]The document being referenceddocument : Attachment [0..1]Specifies various attributes of the patient population for whom and/or environment of care in which, the knowledge module is applicablecoverage[0..*]A contributor to the content of the modulecontributor[0..*]Related resources such as additional documentation, supporting evidence, or bibliographic referencesrelatedResource[0..*]

XML Template

<ModuleMetadata xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Logical identifier --></identifier>
 <version value="[string]"/><!-- 0..1 The version of the module, if any -->
 <title value="[string]"/><!-- 0..1  -->
 <type value="[code]"/><!-- 1..1 module | library | decision-support-rule | documentation-template | order-set -->
 <status value="[code]"/><!-- 1..1 draft | test | active | inactive -->
 <description value="[string]"/><!-- 0..1  -->
 <purpose value="[string]"/><!-- 0..1  -->
 <usage value="[string]"/><!-- 0..1  -->
 <publicationDate value="[date]"/><!-- 0..1  -->
 <lastReviewDate value="[date]"/><!-- 0..1  -->
 <effectivePeriod><!-- 0..1 Period  --></effectivePeriod>
 <coverage>  <!-- 0..* -->
  <focus value="[code]"/><!-- 1..1 patient-gender | patient-age-group | clinical-focus | target-user | workflow-setting | workflow-task | clinical-venue -->
  <description value="[string]"/><!-- 0..1  -->
  <value><!-- 0..1 CodeableConcept  --></value>
 </coverage>
 <topic><!-- 0..* CodeableConcept  --></topic>
 <keyword value="[string]"/><!-- 0..*  -->
 <contributor>  <!-- 0..* -->
  <type value="[code]"/><!-- 1..1 author | editor | reviewer | endorser -->
  <party><!-- 1..1 Reference(Person|Organization)  --></party>
 </contributor>
 <publisher><!-- 0..1 Reference(Organization)  --></publisher>
 <steward><!-- 0..1 Reference(Organization)  --></steward>
 <rightsDeclaration value="[string]"/><!-- 0..1  -->
 <relatedResource>  <!-- 0..* -->
  <type value="[code]"/><!-- 1..1 documentation | evidence | citation | predecessor | successor | derived-from -->
  <uri value="[uri]"/><!-- 0..1  -->
  <description value="[string]"/><!-- 0..1  -->
  <document><!-- 0..1 Attachment  --></document>
 </relatedResource>
</ModuleMetadata>

 

Alternate definitions: Schema/Schematron, Resource Profile (XML, JSON), Questionnaire

4.14.2.1 Terminology Bindings

PathDefinitionTypeReference
ModuleMetadata.type The type of knowledge module being describedExtensibleModuleMetadataType
ModuleMetadata.status The status of the knowledge moduleRequiredModuleMetadataStatus
ModuleMetadata.coverage.focus 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)ExtensibleModuleMetadataFocusType
ModuleMetadata.contributor.type The type of contributorRequiredModuleMetadataContributorType
ModuleMetadata.relatedResource.type The type of related resource for the moduleRequiredModuleMetadataResourceType

4.14.3 Search Parameters

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionPaths
descriptionstringText search against the descriptionModuleMetadata.description
identifiertokenLogical identifier for the module (e.g. CMS-143)ModuleMetadata.identifier
keywordstringKeywords associated with the moduleModuleMetadata.keyword
statustokenStatus of the moduleModuleMetadata.status
titlestringText search against the titleModuleMetadata.title
topictokenTopics associated with the moduleModuleMetadata.topic
versionstringVersion of the module (e.g. 1.0.0)ModuleMetadata.version