DSTU2 QA Preview

This page is part of the FHIR Specification (v1.0.0: DSTU 2 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

G.2.1.1.4 StructureDefinition: CQIF-KnowledgeModule - Detailed Descriptions

Definitions for the cqif-knowledgemodule Profile.

Basic(CQIF-KnowledgeModule)
Definition

A knowledge module is a description of a quality improvement function made available by a knowledge evaluation service. A module may correspond directly to an artifact or group of related artifacts, or it may correspond to functionality provided by the service and not necessarily associated with any tangible knowledge artifact. The knowledge module serves as the descriptive unit for functionality supported by a knowledge service such as a decision support service, measure evaluation service, or other quality improvement service.

Control0..*
TypeBasic
Alternate NamesZ-resource, Extension-resource, Custom-resource
Basic.id
Definition

The logical id of the resource, as used in the url for the resource. Once assigned, this value never changes.

Control0..1
Typeid
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.

Basic.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.

Control0..1
TypeMeta
Basic.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

Control0..1
Typeuri
Is Modifiertrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element as much as possible.

Basic.language
Definition

The base language in which the resource is written.

Control0..1
BindingA human language
The codes SHALL be taken from http://tools.ietf.org/html/bcp47
Typecode
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Basic.text
Definition

A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Control0..1 This element is affected by the following invariants: dom-1
TypeNarrative
Alternate Namesnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.

Basic.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Control0..*
TypeResource
Alternate Namesinline resources, anonymous resources, contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.

Basic.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • Open
  • discriminators: url
Basic.extension (http://hl7.org/fhir/StructureDefinition/cqif-basic-moduleVersion)
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.

Control0..1
TypeExtension (Extension Type: string)
Basic.extension (http://hl7.org/fhir/StructureDefinition/cqif-basic-title)
Definition

A short, descriptive title for the module.

Control0..1
TypeExtension (Extension Type: string)
Basic.extension (http://hl7.org/fhir/StructureDefinition/cqif-basic-description)
Definition

A description of the module from the consumer perspective.

Control0..1
TypeExtension (Extension Type: string)
Basic.extension (http://hl7.org/fhir/StructureDefinition/cqif-basic-purpose)
Definition

A brief description of the purpose of the module.

Control0..1
TypeExtension (Extension Type: string)
Basic.extension (http://hl7.org/fhir/StructureDefinition/cqif-basic-usage)
Definition

Notes about usage of the module.

Control0..1
TypeExtension (Extension Type: string)
Basic.extension (http://hl7.org/fhir/StructureDefinition/cqif-basic-publicationDate)
Definition

The date on which the module was published.

Control0..1
TypeExtension (Extension Type: date)
Basic.extension (http://hl7.org/fhir/StructureDefinition/cqif-basic-lastReviewDate)
Definition

The date on which the module content was last reviewed.

Control0..1
TypeExtension (Extension Type: date)
Basic.extension (http://hl7.org/fhir/StructureDefinition/cqif-basic-effectivePeriod)
Definition

The period during which the module content is effective.

Control0..1
TypeExtension (Extension Type: Period)
Basic.extension (http://hl7.org/fhir/StructureDefinition/cqif-basic-topic)
Definition

Clinical topics related to the content of the module.

Control0..*
TypeExtension (Extension Type: CodeableConcept)
Basic.extension (http://hl7.org/fhir/StructureDefinition/cqif-basic-keyword)
Definition

Keywords associated with the module.

Control0..*
TypeExtension (Extension Type: string)
Basic.extension (http://hl7.org/fhir/StructureDefinition/cqif-basic-contributor)
Definition

A contributor to the content of the module.

Control0..*
TypeExtension (Extension Type: Choice of: boolean, integer, decimal, base64Binary, instant, string, uri, date, dateTime, time, code, oid, id, unsignedInt, positiveInt, markdown, Annotation, Attachment, Identifier, CodeableConcept, Coding, Quantity, Range, Period, Ratio, SampledData, Signature, HumanName, Address, ContactPoint, Timing, Reference, Meta)
Basic.extension (http://hl7.org/fhir/StructureDefinition/cqif-basic-publisher)
Definition

The organization responsible for publishing the module.

Control0..1
TypeExtension (Extension Type: Reference(Organization))
Basic.extension (http://hl7.org/fhir/StructureDefinition/cqif-basic-steward)
Definition

The organization responsible for stewardship of the module content.

Control0..1
TypeExtension (Extension Type: Reference(Organization))
Basic.extension (http://hl7.org/fhir/StructureDefinition/cqif-basic-rightsDeclaration)
Definition

The legal rights declaration for the module.

Control0..1
TypeExtension (Extension Type: string)
Basic.extension (http://hl7.org/fhir/StructureDefinition/cqif-basic-relatedResource)
Definition

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

Control0..*
TypeExtension (Extension Type: Choice of: boolean, integer, decimal, base64Binary, instant, string, uri, date, dateTime, time, code, oid, id, unsignedInt, positiveInt, markdown, Annotation, Attachment, Identifier, CodeableConcept, Coding, Quantity, Range, Period, Ratio, SampledData, Signature, HumanName, Address, ContactPoint, Timing, Reference, Meta)
Basic.extension (http://hl7.org/fhir/StructureDefinition/cqif-basic-model)
Definition

A model reference used by the content.

Control0..*
TypeExtension (Extension Type: Choice of: boolean, integer, decimal, base64Binary, instant, string, uri, date, dateTime, time, code, oid, id, unsignedInt, positiveInt, markdown, Annotation, Attachment, Identifier, CodeableConcept, Coding, Quantity, Range, Period, Ratio, SampledData, Signature, HumanName, Address, ContactPoint, Timing, Reference, Meta)
Basic.extension (http://hl7.org/fhir/StructureDefinition/cqif-basic-library)
Definition

A library referenced by the module. The reference must consist of either an id, or a document reference.

Control0..*
TypeExtension (Extension Type: Choice of: boolean, integer, decimal, base64Binary, instant, string, uri, date, dateTime, time, code, oid, id, unsignedInt, positiveInt, markdown, Annotation, Attachment, Identifier, CodeableConcept, Coding, Quantity, Range, Period, Ratio, SampledData, Signature, HumanName, Address, ContactPoint, Timing, Reference, Meta)
Basic.extension (http://hl7.org/fhir/StructureDefinition/cqif-basic-codeSystem)
Definition

A code system definition used within the knowledge module.

Control0..*
TypeExtension (Extension Type: Choice of: boolean, integer, decimal, base64Binary, instant, string, uri, date, dateTime, time, code, oid, id, unsignedInt, positiveInt, markdown, Annotation, Attachment, Identifier, CodeableConcept, Coding, Quantity, Range, Period, Ratio, SampledData, Signature, HumanName, Address, ContactPoint, Timing, Reference, Meta)
Basic.extension (http://hl7.org/fhir/StructureDefinition/cqif-basic-valueSet)
Definition

A value set definition used by the knowledge module.

Control0..*
TypeExtension (Extension Type: Choice of: boolean, integer, decimal, base64Binary, instant, string, uri, date, dateTime, time, code, oid, id, unsignedInt, positiveInt, markdown, Annotation, Attachment, Identifier, CodeableConcept, Coding, Quantity, Range, Period, Ratio, SampledData, Signature, HumanName, Address, ContactPoint, Timing, Reference, Meta)
Basic.extension (http://hl7.org/fhir/StructureDefinition/cqif-basic-parameter)
Definition

Parameters to the module.

Control0..*
TypeExtension (Extension Type: Choice of: boolean, integer, decimal, base64Binary, instant, string, uri, date, dateTime, time, code, oid, id, unsignedInt, positiveInt, markdown, Annotation, Attachment, Identifier, CodeableConcept, Coding, Quantity, Range, Period, Ratio, SampledData, Signature, HumanName, Address, ContactPoint, Timing, Reference, Meta)
Basic.extension (http://hl7.org/fhir/StructureDefinition/cqif-basic-data)
Definition

Describes a required data item for evaluation in terms of the type of data, and optional code- or date-based filters of the data.

Control0..*
TypeExtension (Extension Type: Choice of: boolean, integer, decimal, base64Binary, instant, string, uri, date, dateTime, time, code, oid, id, unsignedInt, positiveInt, markdown, Annotation, Attachment, Identifier, CodeableConcept, Coding, Quantity, Range, Period, Ratio, SampledData, Signature, HumanName, Address, ContactPoint, Timing, Reference, Meta)
Basic.extension (http://hl7.org/fhir/StructureDefinition/cqif-basic-content)
Definition

The content of the module, if any. If this is a library, this would be the CQL or ELM representation of the library contents.

Control0..*
TypeExtension (Extension Type: Attachment)
Basic.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • Open
  • discriminators: url
Basic.modifierExtension (http://hl7.org/fhir/StructureDefinition/cqif-basic-moduleStatus)
Definition

The status of the module.

Control1..1
TypeExtension (Extension Type: code)
Is Modifiertrue
Basic.modifierExtension (http://hl7.org/fhir/StructureDefinition/cqif-basic-evaluationSupported)
Definition

Indicates whether or not the service supports evaluation of the module. If evaluation is supported, an evaluation operation must be exposed as defined by this implementation guide.

Control1..1
TypeExtension (Extension Type: boolean)
Is Modifiertrue
Basic.identifier
Definition

A logical identifier for the knowledge module.

Control0..*
TypeIdentifier
Basic.code
Definition

Identifies the 'type' of resource - equivalent to the resource name for other resources.

Control1..1
BindingThe code for knowledge modules
The codes SHALL be taken from KnowledgeModuleCode; other codes may be used where these codes are not suitable
TypeCodeableConcept
Is Modifiertrue
Requirements

Must be able to distinguish different types of "basic" resources.

Comments

Because resource references will only be able to indicate 'Basic', the type of reference will need to be specified in a Profile identified as part of the resource. Refer to the resource notes section for information on appropriate terminologies for this code.

Basic.subject
Definition

Identifies the patient, practitioner, device or any other resource that is the "focus" of this resoruce.

Control0..1
TypeReference(Resource)
Requirements

Needed for partitioning the resource by Patient.

Comments

Optional as not all resources potential resources will have subjects. Resources associated with multiple subjects can handle this via extension.

Basic.author
Definition

Indicates who was responsible for creating the resource instance.

Control0..1
TypeChoice of: Reference(Practitioner), Reference(Patient), Reference(RelatedPerson)
Requirements

Needed for partitioning the resource.

Basic.created
Definition

Identifies when the resource was first created.

Control0..1
Typedate
Requirements

Allows ordering resource instances by time.