STU 3 Candidate

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

1.23.0 Module Metadata

Clinical Decision Support Work GroupMaturity Level: N/ABallot Status: DSTU 2

The ModuleMetadata structure defines the common metadata elements used by knowledge management artifacts. This information includes descriptive and topical metadata to enable repository searches, as well as publication, governance, and evidentiary support information.

This structure contains the following general categories of elements:

  • Module identity and versioning
  • Description and documentation
  • Publication and governance information
  • Repository metadata

1.23.0.1 Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. ModuleMetadata ElementDefines common metadata used by quality artifacts
... url Σ0..1uriLogical URL to reference this module
... identifier Σ0..*IdentifierLogical identifier(s) for the module
... version Σ0..1stringThe version of the module, if any
... name Σ0..1stringA machine-friendly name for the module
... title Σ0..1stringA user-friendly title for the module
... type ?! Σ1..1codemodule | library | decision-support-rule | documentation-template | order-set
ModuleMetadataType (Extensible)
... status ?! Σ1..1codedraft | active | inactive
ModuleMetadataStatus (Required)
... experimental ?! Σ0..1booleanIf for testing purposes, not real usage
... description 0..1stringNatural language description of the module
... purpose 0..1stringDescribes the purpose of the module
... usage 0..1stringDescribes the clinical usage of the module
... publicationDate 0..1datePublication date for this version of the module
... lastReviewDate 0..1dateLast review date for the module
... effectivePeriod 0..1PeriodThe effective date range for the module
... coverage 0..*ElementDescribes the context of use for this module
.... focus 1..1Codingpatient-gender | patient-age-group | clinical-focus | target-user | workflow-setting | workflow-task | clinical-venue | jurisdiction
ModuleMetadataFocusType (Extensible)
.... value 1..1CodeableConceptValue of the coverage attribute
... topic 0..*CodeableConceptDescriptional topics for the module
... contributor 0..*ElementA content contributor
.... type 1..1codeauthor | editor | reviewer | endorser
ModuleMetadataContributorType (Required)
.... name 1..1stringName of the contributor
.... contact 0..*ElementContact details of the contributor
..... name 0..1stringName of an individual to contact
..... telecom 0..*ContactPointContact details for an individual or contributor
... publisher 0..1stringName of the publisher (Organization or individual)
... contact 0..*ElementContact details of the publisher
.... name 0..1stringName of an individual to contact
.... telecom 0..*ContactPointContact details for an individual or publisher
... copyright 0..1stringUse and/or publishing restrictions
... relatedResource 0..*ElementRelated resources for the module
.... type 1..1codedocumentation | justification | citation | predecessor | successor | derived-from
ModuleMetadataResourceType (Required)
.... document 0..1AttachmentThe related document
.... resource 0..1Reference(Any)The related resource

doco Documentation for this format

UML Diagram

ElementExtensions - as described for all elements: additional information that is not part of the basic definition of the resource / typeextension : Extension 0..*ModuleMetadataAn 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) publishedurl : uri [0..1]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 specification. Note that the version is required for non-experimental published artifactversion : string [0..1]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 generationname : string [0..1]A short, descriptive, user-friendly 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! »Determines whether the module was developed for testing purposes (or education/evaluation/marketing), and is not intended to be used in production environments (this element modifies the meaning of other elements)experimental : boolean [0..1]A free text natural language description of the module from the consumer's perspectivedescription : string [0..1]A brief description of the purpose of the modulepurpose : string [0..1]A detailed description of how the module is used from a clinical perspectiveusage : 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..*]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 artifactspublisher : string [0..1]A copyright statement relating to the module and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the modulecopyright : string [0..1]CoverageSpecifies the focus of the coverage attributefocus : Coding [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 a value for the coverage attribute. Different values are appropriate in different focus areas, as specified in the description of values for focusvalue : CodeableConcept [1..1]ContributorThe type of contributortype : code [1..1] « The type of contributor (Strength=Required)ModuleMetadataContributorType! »The name of the individual or organization responsible for the contributionname : string [1..1]ContactThe name of an individual to contact regarding the contributionname : string [0..1]Contact details for the individual (if a name was provided) or the contributortelecom : ContactPoint [0..*]ContactThe name of an individual to contact regarding the modulename : string [0..1]Contact details for the individual (if a name was provided) or the publishertelecom : ContactPoint [0..*]RelatedResourceThe type of related resourcetype : code [1..1] « The type of related resource for the module (Strength=Required)ModuleMetadataResourceType! »The document being referenced, represented as an attachment. This is exclusive with the resource elementdocument : Attachment [0..1]The related resource, such as a library, value set, profile, or other moduleresource : Reference [0..1] « Any »Specifies various attributes of the patient population for whom and/or environment of care in which, the knowledge module is applicablecoverage[0..*]Contacts to assist a user in finding and communicating with the contributorcontact[0..*]A contributor to the content of the module, including authors, editors, reviewers, and endorserscontributor[0..*]Contacts to assist a user in finding and communicating with the publishercontact[0..*]Related resources such as additional documentation, justification, or bibliographic referencesrelatedResource[0..*]

XML Template

<[name] xmlns="http://hl7.org/fhir"> doco
 <!-- from Element: extension -->
 <url value="[uri]"/><!-- 0..1 Logical URL to reference this module -->
 <identifier><!-- 0..* Identifier Logical identifier(s) for the module --></identifier>
 <version value="[string]"/><!-- 0..1 The version of the module, if any -->
 <name value="[string]"/><!-- 0..1 A machine-friendly name for the module -->
 <title value="[string]"/><!-- 0..1 A user-friendly title for the module -->
 <type value="[code]"/><!-- 1..1 module | library | decision-support-rule | documentation-template | order-set -->
 <status value="[code]"/><!-- 1..1 draft | active | inactive -->
 <experimental value="[boolean]"/><!-- 0..1 If for testing purposes, not real usage -->
 <description value="[string]"/><!-- 0..1 Natural language description of the module -->
 <purpose value="[string]"/><!-- 0..1 Describes the purpose of the module -->
 <usage value="[string]"/><!-- 0..1 Describes the clinical usage of the module -->
 <publicationDate value="[date]"/><!-- 0..1 Publication date for this version of the module -->
 <lastReviewDate value="[date]"/><!-- 0..1 Last review date for the module -->
 <effectivePeriod><!-- 0..1 Period The effective date range for the module --></effectivePeriod>
 <coverage>  <!-- 0..* Describes the context of use for this module -->
  <focus><!-- 1..1 Coding patient-gender | patient-age-group | clinical-focus | target-user | workflow-setting | workflow-task | clinical-venue | jurisdiction --></focus>
  <value><!-- 1..1 CodeableConcept Value of the coverage attribute --></value>
 </coverage>
 <topic><!-- 0..* CodeableConcept Descriptional topics for the module --></topic>
 <contributor>  <!-- 0..* A content contributor -->
  <type value="[code]"/><!-- 1..1 author | editor | reviewer | endorser -->
  <name value="[string]"/><!-- 1..1 Name of the contributor -->
  <contact>  <!-- 0..* Contact details of the contributor -->
   <name value="[string]"/><!-- 0..1 Name of an individual to contact -->
   <telecom><!-- 0..* ContactPoint Contact details for an individual or contributor --></telecom>
  </contact>
 </contributor>
 <publisher value="[string]"/><!-- 0..1 Name of the publisher (Organization or individual) -->
 <contact>  <!-- 0..* Contact details of the publisher -->
  <name value="[string]"/><!-- 0..1 Name of an individual to contact -->
  <telecom><!-- 0..* ContactPoint Contact details for an individual or publisher --></telecom>
 </contact>
 <copyright value="[string]"/><!-- 0..1 Use and/or publishing restrictions -->
 <relatedResource>  <!-- 0..* Related resources for the module -->
  <type value="[code]"/><!-- 1..1 documentation | justification | citation | predecessor | successor | derived-from -->
  <document><!-- 0..1 Attachment The related document --></document>
  <resource><!-- 0..1 Reference(Any) The related resource --></resource>
 </relatedResource>
</[name]>

JSON Template

 
{doco
  // from Element: extension
  "url" : "<uri>", // Logical URL to reference this module
  "identifier" : [{ Identifier }], // Logical identifier(s) for the module
  "version" : "<string>", // The version of the module, if any
  "name" : "<string>", // A machine-friendly name for the module
  "title" : "<string>", // A user-friendly title for the module
  "type" : "<code>", // R!  module | library | decision-support-rule | documentation-template | order-set
  "status" : "<code>", // R!  draft | active | inactive
  "experimental" : <boolean>, // If for testing purposes, not real usage
  "description" : "<string>", // Natural language description of the module
  "purpose" : "<string>", // Describes the purpose of the module
  "usage" : "<string>", // Describes the clinical usage of the module
  "publicationDate" : "<date>", // Publication date for this version of the module
  "lastReviewDate" : "<date>", // Last review date for the module
  "effectivePeriod" : { Period }, // The effective date range for the module
  "coverage" : [{ // Describes the context of use for this module
    "focus" : { Coding }, // R!  patient-gender | patient-age-group | clinical-focus | target-user | workflow-setting | workflow-task | clinical-venue | jurisdiction
    "value" : { CodeableConcept } // R!  Value of the coverage attribute
  }],
  "topic" : [{ CodeableConcept }], // Descriptional topics for the module
  "contributor" : [{ // A content contributor
    "type" : "<code>", // R!  author | editor | reviewer | endorser
    "name" : "<string>", // R!  Name of the contributor
    "contact" : [{ // Contact details of the contributor
      "name" : "<string>", // Name of an individual to contact
      "telecom" : [{ ContactPoint }] // Contact details for an individual or contributor
    }]
  }],
  "publisher" : "<string>", // Name of the publisher (Organization or individual)
  "contact" : [{ // Contact details of the publisher
    "name" : "<string>", // Name of an individual to contact
    "telecom" : [{ ContactPoint }] // Contact details for an individual or publisher
  }],
  "copyright" : "<string>", // Use and/or publishing restrictions
  "relatedResource" : [{ // Related resources for the module
    "type" : "<code>", // R!  documentation | justification | citation | predecessor | successor | derived-from
    "document" : { Attachment }, // The related document
    "resource" : { Reference(Any) } // The related resource
  }]
}

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. ModuleMetadata ElementDefines common metadata used by quality artifacts
... url Σ0..1uriLogical URL to reference this module
... identifier Σ0..*IdentifierLogical identifier(s) for the module
... version Σ0..1stringThe version of the module, if any
... name Σ0..1stringA machine-friendly name for the module
... title Σ0..1stringA user-friendly title for the module
... type ?! Σ1..1codemodule | library | decision-support-rule | documentation-template | order-set
ModuleMetadataType (Extensible)
... status ?! Σ1..1codedraft | active | inactive
ModuleMetadataStatus (Required)
... experimental ?! Σ0..1booleanIf for testing purposes, not real usage
... description 0..1stringNatural language description of the module
... purpose 0..1stringDescribes the purpose of the module
... usage 0..1stringDescribes the clinical usage of the module
... publicationDate 0..1datePublication date for this version of the module
... lastReviewDate 0..1dateLast review date for the module
... effectivePeriod 0..1PeriodThe effective date range for the module
... coverage 0..*ElementDescribes the context of use for this module
.... focus 1..1Codingpatient-gender | patient-age-group | clinical-focus | target-user | workflow-setting | workflow-task | clinical-venue | jurisdiction
ModuleMetadataFocusType (Extensible)
.... value 1..1CodeableConceptValue of the coverage attribute
... topic 0..*CodeableConceptDescriptional topics for the module
... contributor 0..*ElementA content contributor
.... type 1..1codeauthor | editor | reviewer | endorser
ModuleMetadataContributorType (Required)
.... name 1..1stringName of the contributor
.... contact 0..*ElementContact details of the contributor
..... name 0..1stringName of an individual to contact
..... telecom 0..*ContactPointContact details for an individual or contributor
... publisher 0..1stringName of the publisher (Organization or individual)
... contact 0..*ElementContact details of the publisher
.... name 0..1stringName of an individual to contact
.... telecom 0..*ContactPointContact details for an individual or publisher
... copyright 0..1stringUse and/or publishing restrictions
... relatedResource 0..*ElementRelated resources for the module
.... type 1..1codedocumentation | justification | citation | predecessor | successor | derived-from
ModuleMetadataResourceType (Required)
.... document 0..1AttachmentThe related document
.... resource 0..1Reference(Any)The related resource

doco Documentation for this format

UML Diagram

ElementExtensions - as described for all elements: additional information that is not part of the basic definition of the resource / typeextension : Extension 0..*ModuleMetadataAn 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) publishedurl : uri [0..1]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 specification. Note that the version is required for non-experimental published artifactversion : string [0..1]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 generationname : string [0..1]A short, descriptive, user-friendly 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! »Determines whether the module was developed for testing purposes (or education/evaluation/marketing), and is not intended to be used in production environments (this element modifies the meaning of other elements)experimental : boolean [0..1]A free text natural language description of the module from the consumer's perspectivedescription : string [0..1]A brief description of the purpose of the modulepurpose : string [0..1]A detailed description of how the module is used from a clinical perspectiveusage : 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..*]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 artifactspublisher : string [0..1]A copyright statement relating to the module and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the modulecopyright : string [0..1]CoverageSpecifies the focus of the coverage attributefocus : Coding [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 a value for the coverage attribute. Different values are appropriate in different focus areas, as specified in the description of values for focusvalue : CodeableConcept [1..1]ContributorThe type of contributortype : code [1..1] « The type of contributor (Strength=Required)ModuleMetadataContributorType! »The name of the individual or organization responsible for the contributionname : string [1..1]ContactThe name of an individual to contact regarding the contributionname : string [0..1]Contact details for the individual (if a name was provided) or the contributortelecom : ContactPoint [0..*]ContactThe name of an individual to contact regarding the modulename : string [0..1]Contact details for the individual (if a name was provided) or the publishertelecom : ContactPoint [0..*]RelatedResourceThe type of related resourcetype : code [1..1] « The type of related resource for the module (Strength=Required)ModuleMetadataResourceType! »The document being referenced, represented as an attachment. This is exclusive with the resource elementdocument : Attachment [0..1]The related resource, such as a library, value set, profile, or other moduleresource : Reference [0..1] « Any »Specifies various attributes of the patient population for whom and/or environment of care in which, the knowledge module is applicablecoverage[0..*]Contacts to assist a user in finding and communicating with the contributorcontact[0..*]A contributor to the content of the module, including authors, editors, reviewers, and endorserscontributor[0..*]Contacts to assist a user in finding and communicating with the publishercontact[0..*]Related resources such as additional documentation, justification, or bibliographic referencesrelatedResource[0..*]

XML Template

<[name] xmlns="http://hl7.org/fhir"> doco
 <!-- from Element: extension -->
 <url value="[uri]"/><!-- 0..1 Logical URL to reference this module -->
 <identifier><!-- 0..* Identifier Logical identifier(s) for the module --></identifier>
 <version value="[string]"/><!-- 0..1 The version of the module, if any -->
 <name value="[string]"/><!-- 0..1 A machine-friendly name for the module -->
 <title value="[string]"/><!-- 0..1 A user-friendly title for the module -->
 <type value="[code]"/><!-- 1..1 module | library | decision-support-rule | documentation-template | order-set -->
 <status value="[code]"/><!-- 1..1 draft | active | inactive -->
 <experimental value="[boolean]"/><!-- 0..1 If for testing purposes, not real usage -->
 <description value="[string]"/><!-- 0..1 Natural language description of the module -->
 <purpose value="[string]"/><!-- 0..1 Describes the purpose of the module -->
 <usage value="[string]"/><!-- 0..1 Describes the clinical usage of the module -->
 <publicationDate value="[date]"/><!-- 0..1 Publication date for this version of the module -->
 <lastReviewDate value="[date]"/><!-- 0..1 Last review date for the module -->
 <effectivePeriod><!-- 0..1 Period The effective date range for the module --></effectivePeriod>
 <coverage>  <!-- 0..* Describes the context of use for this module -->
  <focus><!-- 1..1 Coding patient-gender | patient-age-group | clinical-focus | target-user | workflow-setting | workflow-task | clinical-venue | jurisdiction --></focus>
  <value><!-- 1..1 CodeableConcept Value of the coverage attribute --></value>
 </coverage>
 <topic><!-- 0..* CodeableConcept Descriptional topics for the module --></topic>
 <contributor>  <!-- 0..* A content contributor -->
  <type value="[code]"/><!-- 1..1 author | editor | reviewer | endorser -->
  <name value="[string]"/><!-- 1..1 Name of the contributor -->
  <contact>  <!-- 0..* Contact details of the contributor -->
   <name value="[string]"/><!-- 0..1 Name of an individual to contact -->
   <telecom><!-- 0..* ContactPoint Contact details for an individual or contributor --></telecom>
  </contact>
 </contributor>
 <publisher value="[string]"/><!-- 0..1 Name of the publisher (Organization or individual) -->
 <contact>  <!-- 0..* Contact details of the publisher -->
  <name value="[string]"/><!-- 0..1 Name of an individual to contact -->
  <telecom><!-- 0..* ContactPoint Contact details for an individual or publisher --></telecom>
 </contact>
 <copyright value="[string]"/><!-- 0..1 Use and/or publishing restrictions -->
 <relatedResource>  <!-- 0..* Related resources for the module -->
  <type value="[code]"/><!-- 1..1 documentation | justification | citation | predecessor | successor | derived-from -->
  <document><!-- 0..1 Attachment The related document --></document>
  <resource><!-- 0..1 Reference(Any) The related resource --></resource>
 </relatedResource>
</[name]>

JSON Template

{doco
  // from Element: extension
  "url" : "<uri>", // Logical URL to reference this module
  "identifier" : [{ Identifier }], // Logical identifier(s) for the module
  "version" : "<string>", // The version of the module, if any
  "name" : "<string>", // A machine-friendly name for the module
  "title" : "<string>", // A user-friendly title for the module
  "type" : "<code>", // R!  module | library | decision-support-rule | documentation-template | order-set
  "status" : "<code>", // R!  draft | active | inactive
  "experimental" : <boolean>, // If for testing purposes, not real usage
  "description" : "<string>", // Natural language description of the module
  "purpose" : "<string>", // Describes the purpose of the module
  "usage" : "<string>", // Describes the clinical usage of the module
  "publicationDate" : "<date>", // Publication date for this version of the module
  "lastReviewDate" : "<date>", // Last review date for the module
  "effectivePeriod" : { Period }, // The effective date range for the module
  "coverage" : [{ // Describes the context of use for this module
    "focus" : { Coding }, // R!  patient-gender | patient-age-group | clinical-focus | target-user | workflow-setting | workflow-task | clinical-venue | jurisdiction
    "value" : { CodeableConcept } // R!  Value of the coverage attribute
  }],
  "topic" : [{ CodeableConcept }], // Descriptional topics for the module
  "contributor" : [{ // A content contributor
    "type" : "<code>", // R!  author | editor | reviewer | endorser
    "name" : "<string>", // R!  Name of the contributor
    "contact" : [{ // Contact details of the contributor
      "name" : "<string>", // Name of an individual to contact
      "telecom" : [{ ContactPoint }] // Contact details for an individual or contributor
    }]
  }],
  "publisher" : "<string>", // Name of the publisher (Organization or individual)
  "contact" : [{ // Contact details of the publisher
    "name" : "<string>", // Name of an individual to contact
    "telecom" : [{ ContactPoint }] // Contact details for an individual or publisher
  }],
  "copyright" : "<string>", // Use and/or publishing restrictions
  "relatedResource" : [{ // Related resources for the module
    "type" : "<code>", // R!  documentation | justification | citation | predecessor | successor | derived-from
    "document" : { Attachment }, // The related document
    "resource" : { Reference(Any) } // The related resource
  }]
}

Constraints

ModuleMetaData is used in the following places: (not used as yet)

1.23.0.2 Interpretation of ModuleMetadata in different contexts