Data Exchange For Quality Measures Implementation Guide: STU1 Ballot 1 (for FHIR 3.0.1)

This page is part of the Da Vinci Data Exchange for Quality Measures (DEQM) FHIR IG (v0.1.0: STU 1 Ballot 1) based on FHIR R3. The current version which supercedes this version is 3.1.0. For a full list of available versions, see the Directory of published versions

StructureDefinition-library-deqm

source file: source/pages/_includes/library-deqm-intro.md

The DEQM Library Profile describes a shareable, published library resource that can be used to share clinical knowledge

Mandatory Data Elements and Terminology

The following data-elements are mandatory (i.e data MUST be present).

Each Library must have:

  1. A canonical url
  2. An identifier
  3. A content version
  4. A valid, machine-friendly name
  5. A human-friendly title
  6. A date the library content was last changed
  7. Publisher and contact information
  8. Concise description of the library content
  9. A date the library content was approved by the publisher
  10. A date when the library content was last reviewed
  11. Contents of the library in at least one media format

Each Library should have (Must Support):

  1. A clear description of the purpose of the library
  2. Clinical usage notes for the library
  3. An indication of the period during which the library content can be effectively applied
  4. Clear indication of the expected contexts of use for the library content
  5. Intended jurisdictions for the library content
  6. Relevant topics for the library content
  7. Information on contributors to the library content
  8. Copyright information
  9. Description of the data requirements for logic contained in the library
  10. Description of any parameters defined by the library
  11. Provide related information such as supporting evidence, citations, and documentation

Additional Profile specific implementation guidance:

None

Examples

Formal Views of Profile Content

Description of Profiles, Differentials, and Snapshots.

The official URL for this profile is: http://hl7.org/fhir/us/davinci-deqm/STU3/StructureDefinition/library-deqm

Published on Tue Jun 19 00:00:00 AEST 2018 as a active by Da Vinci Project.

This profile builds on Library


Summary

Mandatory: 12 elements
Must-Support: 23 elements

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library I0..*Represents a library of quality improvement components
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url SΣ1..1uriLogical URI to reference this library (globally unique)
... identifier SΣ1..*IdentifierAdditional identifier for the library
... version SΣ1..1stringBusiness version of the library
... name SΣ1..1stringName for this library (computer friendly)
... title SΣ1..1stringName for this library (human friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required)
... experimental ?!Σ0..1booleanFor testing purposes, not real usage
... type Σ1..1CodeableConceptlogic-library | model-definition | asset-collection | module-definition
Binding: LibraryType (extensible)
... date SΣ1..1dateTimeDate this was last changed
... publisher SΣ1..1stringName of the publisher (organization or individual)
... description SΣ1..1markdownNatural language description of the library
... purpose S0..1markdownWhy this library is defined
... usage S0..1stringDescribes the clinical usage of the library
... approvalDate S1..1dateWhen the library was approved by publisher
... lastReviewDate S1..1dateWhen the library was last reviewed
... effectivePeriod SΣ0..1PeriodWhen the library is expected to be used
... useContext SΣ0..*UsageContextContext the content is intended to support
... jurisdiction SΣ0..*CodeableConceptIntended jurisdiction for library (if applicable)
Binding: Jurisdiction ValueSet (extensible)
... topic S0..*CodeableConceptE.g. Education, Treatment, Assessment, etc
Binding: DefinitionTopic (example)
... contributor S0..*ContributorA content contributor
... contact SΣ1..*ContactDetailContact details for the publisher
... copyright S0..1markdownUse and/or publishing restrictions
... relatedArtifact S0..*RelatedArtifactAdditional documentation, citations, etc.
... parameter S0..*ParameterDefinitionParameters defined by the library
... dataRequirement S0..*DataRequirementWhat data is referenced by this library
... content S1..*AttachmentContents of the library, either embedded or referenced

doco Documentation for this format

Summary

Mandatory: 12 elements
Must-Support: 23 elements

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library I0..*Represents a library of quality improvement components
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url SΣ1..1uriLogical URI to reference this library (globally unique)
... identifier SΣ1..*IdentifierAdditional identifier for the library
... version SΣ1..1stringBusiness version of the library
... name SΣ1..1stringName for this library (computer friendly)
... title SΣ1..1stringName for this library (human friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required)
... experimental ?!Σ0..1booleanFor testing purposes, not real usage
... type Σ1..1CodeableConceptlogic-library | model-definition | asset-collection | module-definition
Binding: LibraryType (extensible)
... date SΣ1..1dateTimeDate this was last changed
... publisher SΣ1..1stringName of the publisher (organization or individual)
... description SΣ1..1markdownNatural language description of the library
... purpose S0..1markdownWhy this library is defined
... usage S0..1stringDescribes the clinical usage of the library
... approvalDate S1..1dateWhen the library was approved by publisher
... lastReviewDate S1..1dateWhen the library was last reviewed
... effectivePeriod SΣ0..1PeriodWhen the library is expected to be used
... useContext SΣ0..*UsageContextContext the content is intended to support
... jurisdiction SΣ0..*CodeableConceptIntended jurisdiction for library (if applicable)
Binding: Jurisdiction ValueSet (extensible)
... topic S0..*CodeableConceptE.g. Education, Treatment, Assessment, etc
Binding: DefinitionTopic (example)
... contributor S0..*ContributorA content contributor
... contact SΣ1..*ContactDetailContact details for the publisher
... copyright S0..1markdownUse and/or publishing restrictions
... relatedArtifact S0..*RelatedArtifactAdditional documentation, citations, etc.
... parameter S0..*ParameterDefinitionParameters defined by the library
... dataRequirement S0..*DataRequirementWhat data is referenced by this library
... content S1..*AttachmentContents of the library, either embedded or referenced

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron


Quick Start

Below is an overview of the required set of RESTful FHIR interactions - for example, search and read operations - for this profile. See the Conformance requirements for a complete list of supported RESTful interactions for this IG.

source file: source/pages/_includes/library-deqm-search.md

Use cases:

  • currently none defined