Using CQL with FHIR
1.0.0 - STU1 International flag

This page is part of the Using CQL with FHIR Implementation Guide (v1.0.0: STU1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: CQLModule - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 3

Definitions for the cql-module resource profile.

Guidance on how to interpret the contents of this table can be found here

0. Library
Must Supportfalse
2. Library.extension:directReferenceCode
Slice NamedirectReferenceCode
Control0..*
TypeExtension(Direct reference code) (Extension Type: Coding)
Must Supporttrue
Requirements

A module definition library must describe the direct-reference codes it uses.

4. Library.extension:logicDefinition
Slice NamelogicDefinition
Control0..*
TypeExtension(Logic definition) (Complex Extension)
Must Supporttrue
Requirements

A module definition library must be able to describe the logic definitions it uses.

6. Library.extension:inputParameters
Slice NameinputParameters
ShortThe cqf-inputParameters extension is used to provide the actual parameters given to an operation (i.e. when the module is the result of a $data-requirements operation, what were the parameters to the operation). As opposed to the Library.parameter element, which provides the definition of parameters for the module.
Control0..1
TypeExtension(Input parameters) (Extension Type: Reference(Parameters))
Must Supporttrue
8. Library.type
Control1..1
Must Supporttrue
10. Library.subject[x]
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Must Supporttrue
Requirements

A module definition library must report the subject it operates on.

12. Library.relatedArtifact
Definition

Any referenced dependencies including other logic libraries, model definitions, or terminologies.

ShortDependencies used by the artifact
Must Supporttrue
Requirements

A module definition library must describe the dependencies it requires.

SlicingThis element introduces a set of slices on Library.relatedArtifact. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ type
  • 14. Library.relatedArtifact:dependency
    Slice Namedependency
    Definition

    A canonical resource (such as a Library, CodeSystem, or ValueSet) referenced by any artifact in the release, or any dependency of any artifact in the release, recursively.

    ShortWhat dependencies are referenced
    Comments

    This is the full list of dependencies of all artifacts used in the specification.

    Control0..*
    Must Supporttrue
    Requirements

    Artifacts must be able to unambiguously specify the versions of all dependencies used by artifacts in a specification. The version of each dependency SHALL be included in the canonical reference to the dependency.

    Invariantsmnf-2: Dependency reference must be either a resourceReference (referencing a canonical promotion) or a canonical (referencing a canonical resource), but not both (resource.exists() xor extension('http://hl7.org/fhir/5.0/StructureDefinition/extension-RelatedArtifact.resourceReference').exists())
    16. Library.relatedArtifact:dependency.extension:resourceReference
    Slice NameresourceReference
    Definition

    A reference to a canonical promotion of a FHIR resource (i.e. a non-canonical resource that has been promoted to a canonical resource so it can be used in definitional contexts).

    ShortA reference to the dependency artifact (for canonical promotions)
    Control0..1
    This element is affected by the following invariants: mnf-2
    TypeExtension(Extension Definition for RelatedArtifact.resourceReference for Version 5.0) (Extension Type: Reference(Resource))
    Must Supporttrue
    18. Library.relatedArtifact:dependency.type
    Control1..1
    Typecode
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Fixed Valuedepends-on
    20. Library.relatedArtifact:dependency.display
    Control0..1
    Must Supporttrue
    22. Library.relatedArtifact:dependency.resource
    ShortA reference to the dependency artifact (for canonical resources)
    Control0..1
    This element is affected by the following invariants: mnf-2
    Must Supporttrue
    24. Library.parameter
    ShortProvides the definition of parameters for the module.
    Must Supporttrue
    Requirements

    A module definition library must define any input and output parameters.

    26. Library.parameter.extension:defaultValue
    Slice NamedefaultValue
    Shortcqf-defaultValue is used if the parameter definition has a default to provide the expected value of the default. Note that the value is provided according to the FHIR Type Mapping
    Control0..1
    TypeExtension(Default Value) (Extension Type: Choice of: string, boolean, integer, decimal, date, dateTime, Coding, CodeableConcept, Period, Range, Quantity, Ratio)
    Must Supporttrue
    28. Library.parameter.extension:cqlType
    Slice NamecqlType
    Shortcqf-cqlType is used to ensure that the type of the parameter can be unambiguously provided, given that the FHIR Type Mapping is potentially ambiguous (for the Period type specifically)
    Control0..1
    TypeExtension(CQL Type) (Extension Type: string)
    30. Library.parameter.extension:cqlAccessModifier
    Slice NamecqlAccessModifier
    Control0..1
    TypeExtension(CQL Access Modifier) (Extension Type: code)
    32. Library.dataRequirement
    Must Supporttrue
    Requirements

    A module definition library must declare any data requirements.

    34. Library.dataRequirement.extension:isSelective
    Slice NameisSelective
    Definition

    specifies whether a given DataRequirement is "selective", meaning that it can be used, along with other selective requirements, to determine whether an artifact is applicable to a particular subject.

    Shortspecifies whether a given DataRequirement is "selective"
    Control0..1
    TypeExtension(Is Selective) (Extension Type: boolean)
    Must Supporttrue
    36. Library.dataRequirement.extension:valueFilter
    Slice NamevalueFilter
    Control0..*
    TypeExtension(Value Filter) (Complex Extension)
    Must Supporttrue
    38. Library.dataRequirement.extension:fhirQueryPattern
    Slice NamefhirQueryPattern
    Control0..*
    TypeExtension(FHIR Query Pattern) (Extension Type: string)
    Must Supportfalse

    Guidance on how to interpret the contents of this table can be found here

    0. Library
    Definition

    The Library resource is a general-purpose container for knowledge asset definitions. It can be used to describe and expose existing knowledge assets such as logic libraries and information model descriptions, as well as to describe a collection of knowledge assets.

    ShortRepresents a library of quality improvement components
    Control0..*
    Is Modifierfalse
    Must Supportfalse
    Summaryfalse
    Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
    dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
    dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
    dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
    dom-6: A resource should have narrative for robust management (text.`div`.exists())
    lib-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (name.matches('[A-Z]([A-Za-z0-9_]){0,254}'))
    lib-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (name.matches('[A-Z]([A-Za-z0-9_]){0,254}'))
    2. Library.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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

    ShortA set of rules under which this content was created
    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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

    Control0..1
    Typeuri
    Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    4. Library.extension:directReferenceCode
    Slice NamedirectReferenceCode
    Definition

    Indicates that the given code is directly referenced by artifact logic (e.g. as a direct-reference code in CQL). Terminology dependencies used in logic can be collected and reported, typically using the relatedArtifact element with a type of depends-on. However, direct-reference codes cannot be represented in the relatedArtifact element, so this extension provides a means to support communicating direct-reference code dependencies of knowledge artifacts. As with value set dependencies, direct-reference codes may be the terminology target of a data requirement.

    ShortA code directly referenced by the artifact
    Control0..*
    TypeExtension(Direct reference code) (Extension Type: Coding)
    Is Modifierfalse
    Must Supporttrue
    Requirements

    A module definition library must describe the direct-reference codes it uses.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    6. Library.extension:logicDefinition
    Slice NamelogicDefinition
    Definition

    Represents a specific logic definition used by the artifact. When logic is referenced from knowledge artifacts, this extension allows each referenced definition to be represented independently so that consumers know which specific expressions are being referenced (i.e. not all expressions in a given library are always used), as well as allows processing applications (such as narrative generation) to easily surface the definitions to provide capabilities such as navigation.

    ShortA logic definition used in the artifact
    Control0..*
    TypeExtension(Logic definition) (Complex Extension)
    Is Modifierfalse
    Must Supporttrue
    Requirements

    A module definition library must be able to describe the logic definitions it uses.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    8. Library.extension:inputParameters
    Slice NameinputParameters
    Definition

    Specifies the input parameters to the operation (such as a test case description or a data requirements or evaluate operation). This extension can be used as part of the result of an operation to indicate what the parameters were, but it can also be used as part of the definition of a test case to specify what the input parameters are expected to be for the test case.

    ShortThe cqf-inputParameters extension is used to provide the actual parameters given to an operation (i.e. when the module is the result of a $data-requirements operation, what were the parameters to the operation). As opposed to the Library.parameter element, which provides the definition of parameters for the module.
    Control0..1
    TypeExtension(Input parameters) (Extension Type: Reference(Parameters))
    Is Modifierfalse
    Must Supporttrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    10. Library.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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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.

    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

    ShortExtensions that cannot be ignored
    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.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
    Summaryfalse
    Requirements

    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

    Alternate Namesextensions, user content
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    12. Library.status
    Definition

    The status of this library. Enables tracking the life-cycle of the content.

    Shortdraft | active | retired | unknown
    Comments

    Allows filtering of libraries that are appropriate for use vs. not.

    Control1..1
    BindingThe codes SHALL be taken from PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1
    (required to http://hl7.org/fhir/ValueSet/publication-status|4.0.1)

    The lifecycle status of an artifact.

    Typecode
    Is Modifiertrue because This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    14. Library.type
    Definition

    Identifies the type of library such as a Logic Library, Model Definition, Asset Collection, or Module Definition.

    Shortlogic-library | model-definition | asset-collection | module-definition
    Control1..1
    BindingUnless not suitable, these codes SHALL be taken from LibraryTypehttp://hl7.org/fhir/ValueSet/library-type
    (extensible to http://hl7.org/fhir/ValueSet/library-type)

    The type of knowledge asset this library contains.

    TypeCodeableConcept
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    16. Library.subject[x]
    Definition

    A code or group definition that describes the intended subject of the contents of the library.

    ShortType of individual the library content is focused on
    Control0..1
    BindingUnless not suitable, these codes SHALL be taken from SubjectTypehttp://hl7.org/fhir/ValueSet/subject-type
    (extensible to http://hl7.org/fhir/ValueSet/subject-type)

    The possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.).

    TypeChoice of: CodeableConcept, Reference(Group)
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Is Modifierfalse
    Must Supporttrue
    Must Support TypesNo must-support rules about the choice of types/profiles
    Summaryfalse
    Requirements

    A module definition library must report the subject it operates on.

    Meaning if MissingPatient
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    18. Library.relatedArtifact
    Definition

    Any referenced dependencies including other logic libraries, model definitions, or terminologies.


    Related artifacts such as additional documentation, justification, or bibliographic references.

    ShortDependencies used by the artifactAdditional documentation, citations, etc.
    Comments

    Each related artifact is either an attachment, or a reference to another resource, but not both.

    Control0..*
    TypeRelatedArtifact
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Requirements

    A module definition library must describe the dependencies it requires.


    Libraries must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    SlicingThis element introduces a set of slices on Library.relatedArtifact. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ type
    • 20. Library.relatedArtifact:dependency
      Slice Namedependency
      Definition

      A canonical resource (such as a Library, CodeSystem, or ValueSet) referenced by any artifact in the release, or any dependency of any artifact in the release, recursively.


      Related artifacts such as additional documentation, justification, or bibliographic references.

      ShortWhat dependencies are referencedAdditional documentation, citations, etc.
      Comments

      This is the full list of dependencies of all artifacts used in the specification.


      Each related artifact is either an attachment, or a reference to another resource, but not both.

      Control0..*
      TypeRelatedArtifact
      Is Modifierfalse
      Must Supporttrue
      Summaryfalse
      Requirements

      Artifacts must be able to unambiguously specify the versions of all dependencies used by artifacts in a specification. The version of each dependency SHALL be included in the canonical reference to the dependency.


      Libraries must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      mnf-2: Dependency reference must be either a resourceReference (referencing a canonical promotion) or a canonical (referencing a canonical resource), but not both (resource.exists() xor extension('http://hl7.org/fhir/5.0/StructureDefinition/extension-RelatedArtifact.resourceReference').exists())
      22. Library.relatedArtifact:dependency.extension:resourceReference
      Slice NameresourceReference
      Definition

      A reference to a canonical promotion of a FHIR resource (i.e. a non-canonical resource that has been promoted to a canonical resource so it can be used in definitional contexts).

      ShortA reference to the dependency artifact (for canonical promotions)
      Control0..1
      This element is affected by the following invariants: mnf-2
      TypeExtension(Extension Definition for RelatedArtifact.resourceReference for Version 5.0) (Extension Type: Reference(Resource))
      Is Modifierfalse
      Must Supporttrue
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      24. Library.relatedArtifact:dependency.type
      Definition

      The type of relationship to the related artifact.

      Shortdocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
      Control1..1
      BindingThe codes SHALL be taken from RelatedArtifactTypehttp://hl7.org/fhir/ValueSet/related-artifact-type|4.0.1
      (required to http://hl7.org/fhir/ValueSet/related-artifact-type|4.0.1)

      The type of relationship to the related artifact.

      Typecode
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Summarytrue
      Fixed Valuedepends-on
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      26. Library.relatedArtifact:dependency.display
      Definition

      A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.

      ShortBrief description of the related artifact
      Control0..1
      Typestring
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      28. Library.relatedArtifact:dependency.resource
      Definition

      The related resource, such as a library, value set, profile, or other knowledge resource.

      ShortA reference to the dependency artifact (for canonical resources)What resource is being referenced
      Comments

      If the type is predecessor, this is a reference to the succeeding knowledge resource. If the type is successor, this is a reference to the prior knowledge resource.

      Control0..1
      This element is affected by the following invariants: mnf-2
      Typecanonical(Resource)
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      30. Library.parameter
      Definition

      The parameter element defines parameters used by the library.

      ShortProvides the definition of parameters for the module.Parameters defined by the library
      Control0..*
      TypeParameterDefinition
      Is Modifierfalse
      Must Supporttrue
      Summaryfalse
      Requirements

      A module definition library must define any input and output parameters.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      32. Library.parameter.extension:defaultValue
      Slice NamedefaultValue
      Definition

      An Extension

      Shortcqf-defaultValue is used if the parameter definition has a default to provide the expected value of the default. Note that the value is provided according to the FHIR Type Mapping
      Control0..1
      TypeExtension(Default Value) (Extension Type: Choice of: string, boolean, integer, decimal, date, dateTime, Coding, CodeableConcept, Period, Range, Quantity, Ratio)
      Is Modifierfalse
      Must Supporttrue
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      34. Library.parameter.extension:cqlType
      Slice NamecqlType
      Definition

      Surfaces the CQL type of the parameter definition on which it appears. The value of this extension is a string that is the CQL type specifier for the type of the parameter.

      Shortcqf-cqlType is used to ensure that the type of the parameter can be unambiguously provided, given that the FHIR Type Mapping is potentially ambiguous (for the Period type specifically)
      Control0..1
      TypeExtension(CQL Type) (Extension Type: string)
      Is Modifierfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      36. Library.parameter.extension:cqlAccessModifier
      Slice NamecqlAccessModifier
      Definition

      Indicates the access modifier (i.e. public or private) of a CQL declaration.

      ShortWhat CQL access modifier
      Control0..1
      TypeExtension(CQL Access Modifier) (Extension Type: code)
      Is Modifierfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      38. Library.parameter.use
      Definition

      Whether the parameter is input or output for the module.

      Shortin | out
      Control1..1
      BindingThe codes SHALL be taken from OperationParameterUsehttp://hl7.org/fhir/ValueSet/operation-parameter-use|4.0.1
      (required to http://hl7.org/fhir/ValueSet/operation-parameter-use|4.0.1)

      Whether the parameter is input or output.

      Typecode
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      40. Library.parameter.type
      Definition

      The type of the parameter.

      ShortWhat type of value
      Control1..1
      BindingThe codes SHALL be taken from FHIRAllTypeshttp://hl7.org/fhir/ValueSet/all-types|4.0.1
      (required to http://hl7.org/fhir/ValueSet/all-types|4.0.1)

      A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

      Typecode
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      42. Library.dataRequirement
      Definition

      Describes a set of data that must be provided in order to be able to successfully perform the computations defined by the library.

      ShortWhat data is referenced by this library
      Control0..*
      TypeDataRequirement
      Is Modifierfalse
      Must Supporttrue
      Summaryfalse
      Requirements

      A module definition library must declare any data requirements.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      44. Library.dataRequirement.extension:isSelective
      Slice NameisSelective
      Definition

      specifies whether a given DataRequirement is "selective", meaning that it can be used, along with other selective requirements, to determine whether an artifact is applicable to a particular subject.

      Shortspecifies whether a given DataRequirement is "selective"
      Comments

      This extension is useful for helping implementing systems determine which data requirements are expected to be most selective of the target population. A common use case is to identify a subset of the data requirements for an artifact as "selective", meaning that they can be used as an initial filter to establish the overall set of data. For example, the selective requirements can be used to construct an initial query or queries for data, with the non-selective requirements used for subsequent filtering on the resulting data.

      Control0..1
      TypeExtension(Is Selective) (Extension Type: boolean)
      Is Modifierfalse
      Must Supporttrue
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      46. Library.dataRequirement.extension:valueFilter
      Slice NamevalueFilter
      Definition

      Allows additional value-based filters to be specified as part of a data requirement.

      ShortExtension
      Control0..*
      TypeExtension(Value Filter) (Complex Extension)
      Is Modifierfalse
      Must Supporttrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      48. Library.dataRequirement.extension:fhirQueryPattern
      Slice NamefhirQueryPattern
      Definition

      A FHIR Query URL pattern that corresponds to the data specified by the data requirement. If multiple FHIR Query URLs are present, they each contribute to the data specified by the data requirement (i.e. the union of the results of the FHIR Queries represents the complete data for the data requirement). This is not a resolveable URL, in that it will contain 1) No base canonical (i.e. it's a relative query), and 2) Parameters using tokens that are delimited using double-braces and the context parameters are dependent solely on the subjectType, according to the following: Patient: context.patientId, Practitioner: context.practitionerId, Organization: context.organizationId, Location: context.locationId, Device: context.deviceId.

      ShortWhat FHIR query?
      Comments

      Supports communicating a FHIR query (or set of queries) for the given data requirement. The query is server-specific, and will need to be created as informed by a CapabilityStatement. The $data-requirements operation should be expected to be able to provide an Endpoint or CapabilityStatement to provide this information.; If no endpoint or capability statement is provided, the capability statement of the server performing the operation is used.

      Control0..*
      TypeExtension(FHIR Query Pattern) (Extension Type: string)
      Is Modifierfalse
      Must Supportfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      50. Library.dataRequirement.type
      Definition

      The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

      ShortThe type of the required data
      Control1..1
      BindingThe codes SHALL be taken from FHIRAllTypeshttp://hl7.org/fhir/ValueSet/all-types|4.0.1
      (required to http://hl7.org/fhir/ValueSet/all-types|4.0.1)

      A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

      Typecode
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

      Guidance on how to interpret the contents of this table can be found here

      0. Library
      Definition

      The Library resource is a general-purpose container for knowledge asset definitions. It can be used to describe and expose existing knowledge assets such as logic libraries and information model descriptions, as well as to describe a collection of knowledge assets.

      ShortRepresents a library of quality improvement components
      Control0..*
      Is Modifierfalse
      Must Supportfalse
      Summaryfalse
      Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
      dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
      dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
      dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
      dom-6: A resource should have narrative for robust management (text.`div`.exists())
      lib-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (name.matches('[A-Z]([A-Za-z0-9_]){0,254}'))
      2. Library.id
      Definition

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

      ShortLogical id of this artifact
      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.

      Control0..1
      Typeid
      Is Modifierfalse
      Summarytrue
      4. Library.meta
      Definition

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

      ShortMetadata about the resource
      Control0..1
      TypeMeta
      Is Modifierfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      6. Library.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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

      ShortA set of rules under which this content was created
      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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

      Control0..1
      Typeuri
      Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      8. Library.language
      Definition

      The base language in which the resource is written.

      ShortLanguage of the resource content
      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).

      Control0..1
      BindingThe codes SHOULD be taken from CommonLanguages
      (preferred to http://hl7.org/fhir/ValueSet/languages)

      A human language.

      Additional BindingsPurpose
      AllLanguagesMax Binding
      Typecode
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      10. Library.text
      Definition

      A human-readable narrative that contains a summary of the resource and can 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.

      ShortText summary of the resource, for human interpretation
      Comments

      Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

      Control0..1
      TypeNarrative
      Is Modifierfalse
      Summaryfalse
      Alternate Namesnarrative, html, xhtml, display
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      12. Library.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.

      ShortContained, inline 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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

      Control0..*
      TypeResource
      Is Modifierfalse
      Summaryfalse
      Alternate Namesinline resources, anonymous resources, contained resources
      14. Library.extension
      Definition

      An Extension

      ShortExtension
      Control0..*
      TypeExtension
      Is Modifierfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      SlicingThis element introduces a set of slices on Library.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 16. Library.extension:directReferenceCode
        Slice NamedirectReferenceCode
        Definition

        Indicates that the given code is directly referenced by artifact logic (e.g. as a direct-reference code in CQL). Terminology dependencies used in logic can be collected and reported, typically using the relatedArtifact element with a type of depends-on. However, direct-reference codes cannot be represented in the relatedArtifact element, so this extension provides a means to support communicating direct-reference code dependencies of knowledge artifacts. As with value set dependencies, direct-reference codes may be the terminology target of a data requirement.

        ShortA code directly referenced by the artifact
        Control0..*
        TypeExtension(Direct reference code) (Extension Type: Coding)
        Is Modifierfalse
        Must Supporttrue
        Requirements

        A module definition library must describe the direct-reference codes it uses.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        18. Library.extension:logicDefinition
        Slice NamelogicDefinition
        Definition

        Represents a specific logic definition used by the artifact. When logic is referenced from knowledge artifacts, this extension allows each referenced definition to be represented independently so that consumers know which specific expressions are being referenced (i.e. not all expressions in a given library are always used), as well as allows processing applications (such as narrative generation) to easily surface the definitions to provide capabilities such as navigation.

        ShortA logic definition used in the artifact
        Control0..*
        TypeExtension(Logic definition) (Complex Extension)
        Is Modifierfalse
        Must Supporttrue
        Requirements

        A module definition library must be able to describe the logic definitions it uses.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        20. Library.extension:inputParameters
        Slice NameinputParameters
        Definition

        Specifies the input parameters to the operation (such as a test case description or a data requirements or evaluate operation). This extension can be used as part of the result of an operation to indicate what the parameters were, but it can also be used as part of the definition of a test case to specify what the input parameters are expected to be for the test case.

        ShortThe cqf-inputParameters extension is used to provide the actual parameters given to an operation (i.e. when the module is the result of a $data-requirements operation, what were the parameters to the operation). As opposed to the Library.parameter element, which provides the definition of parameters for the module.
        Control0..1
        TypeExtension(Input parameters) (Extension Type: Reference(Parameters))
        Is Modifierfalse
        Must Supporttrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        22. Library.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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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.

        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

        ShortExtensions that cannot be ignored
        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.

        Control0..*
        TypeExtension
        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
        Summaryfalse
        Requirements

        Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

        Alternate Namesextensions, user content
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        24. Library.url
        Definition

        An absolute URI that is used to identify this library when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this library is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the library is stored on different servers.

        ShortCanonical identifier for this library, represented as a URI (globally unique)
        Comments

        Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.

        The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions.

        In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found.

        Control0..1
        Typeuri
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Requirements

        Allows the library to be referenced by a single globally unique identifier.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        26. Library.identifier
        Definition

        A formal identifier that is used to identify this library when it is represented in other formats, or referenced in a specification, model, design or an instance. e.g. CMS or NQF identifiers for a measure artifact. Note that at least one identifier is required for non-experimental active artifacts.

        ShortAdditional identifier for the library
        Comments

        Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this library outside of FHIR, where it is not possible to use the logical URI.

        NoteThis is a business identifier, not a resource identifier (see discussion)
        Control0..*
        TypeIdentifier
        Is Modifierfalse
        Summarytrue
        Requirements

        Allows externally provided and/or usable business identifiers to be easily associated with the module.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        28. Library.version
        Definition

        The identifier that is used to identify this version of the library when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the library author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. 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 assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.

        ShortBusiness version of the library
        Comments

        There may be different library instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the library with the format [url]|[version].

        NoteThis is a business version Id, not a resource version Id (see discussion)
        Control0..1
        Typestring
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        30. Library.name
        Definition

        A natural language name identifying the library. This name should be usable as an identifier for the module by machine processing applications such as code generation.

        ShortName for this library (computer friendly)
        Comments

        The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.

        Control0..1
        This element is affected by the following invariants: inv-0
        Typestring
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Requirements

        Support human navigation and code generation.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        32. Library.title
        Definition

        A short, descriptive, user-friendly title for the library.

        ShortName for this library (human friendly)
        Comments

        This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

        Control0..1
        Typestring
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        34. Library.subtitle
        Definition

        An explanatory or alternate title for the library giving additional information about its content.

        ShortSubordinate title of the library
        Control0..1
        Typestring
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        36. Library.status
        Definition

        The status of this library. Enables tracking the life-cycle of the content.

        Shortdraft | active | retired | unknown
        Comments

        Allows filtering of libraries that are appropriate for use vs. not.

        Control1..1
        BindingThe codes SHALL be taken from PublicationStatus
        (required to http://hl7.org/fhir/ValueSet/publication-status|4.0.1)

        The lifecycle status of an artifact.

        Typecode
        Is Modifiertrue because This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        38. Library.experimental
        Definition

        A Boolean value to indicate that this library is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

        ShortFor testing purposes, not real usage
        Comments

        Allows filtering of librarys that are appropriate for use versus not.

        Control0..1
        Typeboolean
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Requirements

        Enables experimental content to be developed following the same lifecycle that would be used for a production-level library.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        40. Library.type
        Definition

        Identifies the type of library such as a Logic Library, Model Definition, Asset Collection, or Module Definition.

        Shortlogic-library | model-definition | asset-collection | module-definition
        Control1..1
        BindingUnless not suitable, these codes SHALL be taken from LibraryType
        (extensible to http://hl7.org/fhir/ValueSet/library-type)

        The type of knowledge asset this library contains.

        TypeCodeableConcept
        Is Modifierfalse
        Must Supporttrue
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        42. Library.subject[x]
        Definition

        A code or group definition that describes the intended subject of the contents of the library.

        ShortType of individual the library content is focused on
        Control0..1
        BindingUnless not suitable, these codes SHALL be taken from SubjectType
        (extensible to http://hl7.org/fhir/ValueSet/subject-type)

        The possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.).

        TypeChoice of: CodeableConcept, Reference(Group)
        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
        Is Modifierfalse
        Must Supporttrue
        Must Support TypesNo must-support rules about the choice of types/profiles
        Summaryfalse
        Requirements

        A module definition library must report the subject it operates on.

        Meaning if MissingPatient
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        44. Library.date
        Definition

        The date (and optionally time) when the library was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the library changes.

        ShortDate last changed
        Comments

        Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the library. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.

        Control0..1
        TypedateTime
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Alternate NamesRevision Date
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        46. Library.publisher
        Definition

        The name of the organization or individual that published the library.

        ShortName of the publisher (organization or individual)
        Comments

        Usually an organization but may be an individual. The publisher (or steward) of the library is the organization or individual primarily responsible for the maintenance and upkeep of the library. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the library. This item SHOULD be populated unless the information is available from context.

        Control0..1
        Typestring
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Requirements

        Helps establish the "authority/credibility" of the library. May also allow for contact.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        48. Library.contact
        Definition

        Contact details to assist a user in finding and communicating with the publisher.

        ShortContact details for the publisher
        Comments

        May be a web site, an email address, a telephone number, etc.

        Control0..*
        TypeContactDetail
        Is Modifierfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        50. Library.description
        Definition

        A free text natural language description of the library from a consumer's perspective.

        ShortNatural language description of the library
        Comments

        This description can be used to capture details such as why the library was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the library as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the library is presumed to be the predominant language in the place the library was created).

        Control0..1
        Typemarkdown
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        52. Library.useContext
        Definition

        The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate library instances.

        ShortThe context that the content is intended to support
        Comments

        When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

        Control0..*
        TypeUsageContext
        Is Modifierfalse
        Summarytrue
        Requirements

        Assist in searching for appropriate content.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        54. Library.jurisdiction
        Definition

        A legal or geographic region in which the library is intended to be used.

        ShortIntended jurisdiction for library (if applicable)
        Comments

        It may be possible for the library to be used in jurisdictions other than those for which it was originally designed or intended.

        Control0..*
        BindingUnless not suitable, these codes SHALL be taken from Jurisdiction ValueSet
        (extensible to http://hl7.org/fhir/ValueSet/jurisdiction)

        Countries and regions within which this artifact is targeted for use.

        TypeCodeableConcept
        Is Modifierfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        56. Library.purpose
        Definition

        Explanation of why this library is needed and why it has been designed as it has.

        ShortWhy this library is defined
        Comments

        This element does not describe the usage of the library. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this library.

        Control0..1
        Typemarkdown
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        58. Library.usage
        Definition

        A detailed description of how the library is used from a clinical perspective.

        ShortDescribes the clinical usage of the library
        Control0..1
        Typestring
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        60. Library.copyright
        Definition

        A copyright statement relating to the library and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the library.

        ShortUse and/or publishing restrictions
        Control0..1
        Typemarkdown
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summaryfalse
        Requirements

        Consumers must be able to determine any legal restrictions on the use of the library and/or its content.

        Alternate NamesLicense, Restrictions
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        62. Library.approvalDate
        Definition

        The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

        ShortWhen the library was approved by publisher
        Comments

        The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.

        Control0..1
        Typedate
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        64. Library.lastReviewDate
        Definition

        The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

        ShortWhen the library was last reviewed
        Comments

        If specified, this date follows the original approval date.

        Control0..1
        Typedate
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summaryfalse
        Requirements

        Gives a sense of how "current" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        66. Library.effectivePeriod
        Definition

        The period during which the library content was or is planned to be in active use.

        ShortWhen the library is expected to be used
        Comments

        The effective period for a library determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015.

        Control0..1
        TypePeriod
        Is Modifierfalse
        Summarytrue
        Requirements

        Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the library are or are expected to be used instead.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        68. Library.topic
        Definition

        Descriptive topics related to the content of the library. Topics provide a high-level categorization of the library that can be useful for filtering and searching.

        ShortE.g. Education, Treatment, Assessment, etc.
        Control0..*
        BindingFor example codes, see DefinitionTopic
        (example to http://hl7.org/fhir/ValueSet/definition-topic)

        High-level categorization of the definition, used for searching, sorting, and filtering.

        TypeCodeableConcept
        Is Modifierfalse
        Summaryfalse
        Requirements

        Repositories must be able to determine how to categorize the library so that it can be found by topical searches.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        70. Library.author
        Definition

        An individiual or organization primarily involved in the creation and maintenance of the content.

        ShortWho authored the content
        Control0..*
        TypeContactDetail
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        72. Library.editor
        Definition

        An individual or organization primarily responsible for internal coherence of the content.

        ShortWho edited the content
        Control0..*
        TypeContactDetail
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        74. Library.reviewer
        Definition

        An individual or organization primarily responsible for review of some aspect of the content.

        ShortWho reviewed the content
        Control0..*
        TypeContactDetail
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        76. Library.endorser
        Definition

        An individual or organization responsible for officially endorsing the content for use in some setting.

        ShortWho endorsed the content
        Control0..*
        TypeContactDetail
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        78. Library.relatedArtifact
        Definition

        Any referenced dependencies including other logic libraries, model definitions, or terminologies.

        ShortDependencies used by the artifact
        Comments

        Each related artifact is either an attachment, or a reference to another resource, but not both.

        Control0..*
        TypeRelatedArtifact
        Is Modifierfalse
        Must Supporttrue
        Summaryfalse
        Requirements

        A module definition library must describe the dependencies it requires.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        SlicingThis element introduces a set of slices on Library.relatedArtifact. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ type
        • 80. Library.relatedArtifact:dependency
          Slice Namedependency
          Definition

          A canonical resource (such as a Library, CodeSystem, or ValueSet) referenced by any artifact in the release, or any dependency of any artifact in the release, recursively.

          ShortWhat dependencies are referenced
          Comments

          This is the full list of dependencies of all artifacts used in the specification.

          Control0..*
          TypeRelatedArtifact
          Is Modifierfalse
          Must Supporttrue
          Summaryfalse
          Requirements

          Artifacts must be able to unambiguously specify the versions of all dependencies used by artifacts in a specification. The version of each dependency SHALL be included in the canonical reference to the dependency.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          mnf-2: Dependency reference must be either a resourceReference (referencing a canonical promotion) or a canonical (referencing a canonical resource), but not both (resource.exists() xor extension('http://hl7.org/fhir/5.0/StructureDefinition/extension-RelatedArtifact.resourceReference').exists())
          82. Library.relatedArtifact:dependency.id
          Definition

          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

          ShortUnique id for inter-element referencing
          Control0..1
          Typestring
          Is Modifierfalse
          XML FormatIn the XML format, this property is represented as an attribute.
          Summaryfalse
          84. Library.relatedArtifact:dependency.extension
          Definition

          May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

          ShortAdditional content defined by implementations
          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.

          Control0..*
          TypeExtension
          Is Modifierfalse
          Summaryfalse
          Alternate Namesextensions, user content
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          SlicingThis element introduces a set of slices on Library.relatedArtifact.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 86. Library.relatedArtifact:dependency.extension:resourceReference
            Slice NameresourceReference
            Definition

            A reference to a canonical promotion of a FHIR resource (i.e. a non-canonical resource that has been promoted to a canonical resource so it can be used in definitional contexts).

            ShortA reference to the dependency artifact (for canonical promotions)
            Control0..1
            This element is affected by the following invariants: mnf-2
            TypeExtension(Extension Definition for RelatedArtifact.resourceReference for Version 5.0) (Extension Type: Reference(Resource))
            Is Modifierfalse
            Must Supporttrue
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            88. Library.relatedArtifact:dependency.type
            Definition

            The type of relationship to the related artifact.

            Shortdocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
            Control1..1
            BindingThe codes SHALL be taken from RelatedArtifactType
            (required to http://hl7.org/fhir/ValueSet/related-artifact-type|4.0.1)

            The type of relationship to the related artifact.

            Typecode
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Must Supporttrue
            Summarytrue
            Fixed Valuedepends-on
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            90. Library.relatedArtifact:dependency.label
            Definition

            A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.

            ShortShort label
            Control0..1
            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            92. Library.relatedArtifact:dependency.display
            Definition

            A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.

            ShortBrief description of the related artifact
            Control0..1
            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Must Supporttrue
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            94. Library.relatedArtifact:dependency.citation
            Definition

            A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.

            ShortBibliographic citation for the artifact
            Comments

            Additional structured information about citations should be captured as extensions.

            Control0..1
            Typemarkdown
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            96. Library.relatedArtifact:dependency.url
            Definition

            A url for the artifact that can be followed to access the actual content.

            ShortWhere the artifact can be accessed
            Comments

            If a document or resource element is present, this element SHALL NOT be provided (use the url or reference in the Attachment or resource reference).

            Control0..1
            Typeurl
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            98. Library.relatedArtifact:dependency.document
            Definition

            The document being referenced, represented as an attachment. This is exclusive with the resource element.

            ShortWhat document is being referenced
            Control0..1
            TypeAttachment
            Is Modifierfalse
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            100. Library.relatedArtifact:dependency.resource
            Definition

            The related resource, such as a library, value set, profile, or other knowledge resource.

            ShortA reference to the dependency artifact (for canonical resources)
            Comments

            If the type is predecessor, this is a reference to the succeeding knowledge resource. If the type is successor, this is a reference to the prior knowledge resource.

            Control0..1
            This element is affected by the following invariants: mnf-2
            Typecanonical(Resource)
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Must Supporttrue
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            102. Library.parameter
            Definition

            The parameter element defines parameters used by the library.

            ShortProvides the definition of parameters for the module.
            Control0..*
            TypeParameterDefinition
            Is Modifierfalse
            Must Supporttrue
            Summaryfalse
            Requirements

            A module definition library must define any input and output parameters.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            104. Library.parameter.id
            Definition

            Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

            ShortUnique id for inter-element referencing
            Control0..1
            Typestring
            Is Modifierfalse
            XML FormatIn the XML format, this property is represented as an attribute.
            Summaryfalse
            106. Library.parameter.extension
            Definition

            May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            ShortAdditional content defined by implementations
            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.

            Control0..*
            TypeExtension
            Is Modifierfalse
            Summaryfalse
            Alternate Namesextensions, user content
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            SlicingThis element introduces a set of slices on Library.parameter.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 108. Library.parameter.extension:defaultValue
              Slice NamedefaultValue
              Definition

              An Extension

              Shortcqf-defaultValue is used if the parameter definition has a default to provide the expected value of the default. Note that the value is provided according to the FHIR Type Mapping
              Control0..1
              TypeExtension(Default Value) (Extension Type: Choice of: string, boolean, integer, decimal, date, dateTime, Coding, CodeableConcept, Period, Range, Quantity, Ratio)
              Is Modifierfalse
              Must Supporttrue
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              110. Library.parameter.extension:cqlType
              Slice NamecqlType
              Definition

              Surfaces the CQL type of the parameter definition on which it appears. The value of this extension is a string that is the CQL type specifier for the type of the parameter.

              Shortcqf-cqlType is used to ensure that the type of the parameter can be unambiguously provided, given that the FHIR Type Mapping is potentially ambiguous (for the Period type specifically)
              Control0..1
              TypeExtension(CQL Type) (Extension Type: string)
              Is Modifierfalse
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              112. Library.parameter.extension:cqlAccessModifier
              Slice NamecqlAccessModifier
              Definition

              Indicates the access modifier (i.e. public or private) of a CQL declaration.

              ShortWhat CQL access modifier
              Control0..1
              TypeExtension(CQL Access Modifier) (Extension Type: code)
              Is Modifierfalse
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              114. Library.parameter.name
              Definition

              The name of the parameter used to allow access to the value of the parameter in evaluation contexts.

              ShortName used to access the parameter value
              Control0..1
              Typecode
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              116. Library.parameter.use
              Definition

              Whether the parameter is input or output for the module.

              Shortin | out
              Control1..1
              BindingThe codes SHALL be taken from OperationParameterUse
              (required to http://hl7.org/fhir/ValueSet/operation-parameter-use|4.0.1)

              Whether the parameter is input or output.

              Typecode
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              118. Library.parameter.min
              Definition

              The minimum number of times this parameter SHALL appear in the request or response.

              ShortMinimum cardinality
              Control0..1
              Typeinteger
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              120. Library.parameter.max
              Definition

              The maximum number of times this element is permitted to appear in the request or response.

              ShortMaximum cardinality (a number of *)
              Control0..1
              Typestring
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              122. Library.parameter.documentation
              Definition

              A brief discussion of what the parameter is for and how it is used by the module.

              ShortA brief description of the parameter
              Control0..1
              Typestring
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              124. Library.parameter.type
              Definition

              The type of the parameter.

              ShortWhat type of value
              Control1..1
              BindingThe codes SHALL be taken from FHIRAllTypes
              (required to http://hl7.org/fhir/ValueSet/all-types|4.0.1)

              A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

              Typecode
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              126. Library.parameter.profile
              Definition

              If specified, this indicates a profile that the input data must conform to, or that the output data will conform to.

              ShortWhat profile the value is expected to be
              Control0..1
              Typecanonical(StructureDefinition)
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              128. Library.dataRequirement
              Definition

              Describes a set of data that must be provided in order to be able to successfully perform the computations defined by the library.

              ShortWhat data is referenced by this library
              Control0..*
              TypeDataRequirement
              Is Modifierfalse
              Must Supporttrue
              Summaryfalse
              Requirements

              A module definition library must declare any data requirements.

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              130. Library.dataRequirement.id
              Definition

              Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

              ShortUnique id for inter-element referencing
              Control0..1
              Typestring
              Is Modifierfalse
              XML FormatIn the XML format, this property is represented as an attribute.
              Summaryfalse
              132. Library.dataRequirement.extension
              Definition

              May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

              ShortAdditional content defined by implementations
              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.

              Control0..*
              TypeExtension
              Is Modifierfalse
              Summaryfalse
              Alternate Namesextensions, user content
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              SlicingThis element introduces a set of slices on Library.dataRequirement.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 134. Library.dataRequirement.extension:isSelective
                Slice NameisSelective
                Definition

                specifies whether a given DataRequirement is "selective", meaning that it can be used, along with other selective requirements, to determine whether an artifact is applicable to a particular subject.

                Shortspecifies whether a given DataRequirement is "selective"
                Comments

                This extension is useful for helping implementing systems determine which data requirements are expected to be most selective of the target population. A common use case is to identify a subset of the data requirements for an artifact as "selective", meaning that they can be used as an initial filter to establish the overall set of data. For example, the selective requirements can be used to construct an initial query or queries for data, with the non-selective requirements used for subsequent filtering on the resulting data.

                Control0..1
                TypeExtension(Is Selective) (Extension Type: boolean)
                Is Modifierfalse
                Must Supporttrue
                Summaryfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                136. Library.dataRequirement.extension:valueFilter
                Slice NamevalueFilter
                Definition

                Allows additional value-based filters to be specified as part of a data requirement.

                ShortExtension
                Control0..*
                TypeExtension(Value Filter) (Complex Extension)
                Is Modifierfalse
                Must Supporttrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                138. Library.dataRequirement.extension:fhirQueryPattern
                Slice NamefhirQueryPattern
                Definition

                A FHIR Query URL pattern that corresponds to the data specified by the data requirement. If multiple FHIR Query URLs are present, they each contribute to the data specified by the data requirement (i.e. the union of the results of the FHIR Queries represents the complete data for the data requirement). This is not a resolveable URL, in that it will contain 1) No base canonical (i.e. it's a relative query), and 2) Parameters using tokens that are delimited using double-braces and the context parameters are dependent solely on the subjectType, according to the following: Patient: context.patientId, Practitioner: context.practitionerId, Organization: context.organizationId, Location: context.locationId, Device: context.deviceId.

                ShortWhat FHIR query?
                Comments

                Supports communicating a FHIR query (or set of queries) for the given data requirement. The query is server-specific, and will need to be created as informed by a CapabilityStatement. The $data-requirements operation should be expected to be able to provide an Endpoint or CapabilityStatement to provide this information.; If no endpoint or capability statement is provided, the capability statement of the server performing the operation is used.

                Control0..*
                TypeExtension(FHIR Query Pattern) (Extension Type: string)
                Is Modifierfalse
                Must Supportfalse
                Summaryfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                140. Library.dataRequirement.type
                Definition

                The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

                ShortThe type of the required data
                Control1..1
                BindingThe codes SHALL be taken from FHIRAllTypes
                (required to http://hl7.org/fhir/ValueSet/all-types|4.0.1)

                A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

                Typecode
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                142. Library.dataRequirement.profile
                Definition

                The profile of the required data, specified as the uri of the profile definition.

                ShortThe profile of the required data
                Control0..*
                Typecanonical(StructureDefinition)
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                144. Library.dataRequirement.subject[x]
                Definition

                The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.

                ShortE.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
                Comments

                The subject of a data requirement is critical, as the data being specified is determined with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what data is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.

                Control0..1
                BindingUnless not suitable, these codes SHALL be taken from SubjectType
                (extensible to http://hl7.org/fhir/ValueSet/subject-type)

                The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).

                TypeChoice of: CodeableConcept, Reference(Group)
                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                Is Modifierfalse
                Summarytrue
                Meaning if MissingPatient
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                146. Library.dataRequirement.mustSupport
                Definition

                Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available.

                The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the Simple FHIRPath Profile for full details).

                ShortIndicates specific structure elements that are referenced by the knowledge module
                Control0..*
                Typestring
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                148. Library.dataRequirement.codeFilter
                Definition

                Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.

                ShortWhat codes are expected
                Control0..*
                TypeElement
                Is Modifierfalse
                Summarytrue
                Invariantsdrq-1: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
                ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                150. Library.dataRequirement.codeFilter.id
                Definition

                Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                ShortUnique id for inter-element referencing
                Control0..1
                Typestring
                Is Modifierfalse
                XML FormatIn the XML format, this property is represented as an attribute.
                Summaryfalse
                152. Library.dataRequirement.codeFilter.extension
                Definition

                May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                ShortAdditional content defined by implementations
                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.

                Control0..*
                TypeExtension
                Is Modifierfalse
                Summaryfalse
                Alternate Namesextensions, user content
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                SlicingThis element introduces a set of slices on Library.dataRequirement.codeFilter.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 154. Library.dataRequirement.codeFilter.path
                  Definition

                  The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.

                  ShortA code-valued attribute to filter on
                  Comments

                  The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

                  Control0..1
                  Typestring
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  156. Library.dataRequirement.codeFilter.searchParam
                  Definition

                  A token parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type code, Coding, or CodeableConcept.

                  ShortA coded (token) parameter to search on
                  Control0..1
                  Typestring
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  158. Library.dataRequirement.codeFilter.valueSet
                  Definition

                  The valueset for the code filter. The valueSet and code elements are additive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.

                  ShortValueset for the filter
                  Control0..1
                  Typecanonical(ValueSet)
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  160. Library.dataRequirement.codeFilter.code
                  Definition

                  The codes for the code filter. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes. If codes are specified in addition to a value set, the filter returns items matching a code in the value set or one of the specified codes.

                  ShortWhat code is expected
                  Control0..*
                  TypeCoding
                  Is Modifierfalse
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  162. Library.dataRequirement.dateFilter
                  Definition

                  Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.

                  ShortWhat dates/date ranges are expected
                  Control0..*
                  TypeElement
                  Is Modifierfalse
                  Summarytrue
                  Invariantsdrq-2: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
                  ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  164. Library.dataRequirement.dateFilter.id
                  Definition

                  Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                  ShortUnique id for inter-element referencing
                  Control0..1
                  Typestring
                  Is Modifierfalse
                  XML FormatIn the XML format, this property is represented as an attribute.
                  Summaryfalse
                  166. Library.dataRequirement.dateFilter.extension
                  Definition

                  May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                  ShortAdditional content defined by implementations
                  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.

                  Control0..*
                  TypeExtension
                  Is Modifierfalse
                  Summaryfalse
                  Alternate Namesextensions, user content
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                  SlicingThis element introduces a set of slices on Library.dataRequirement.dateFilter.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 168. Library.dataRequirement.dateFilter.path
                    Definition

                    The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timing.

                    ShortA date-valued attribute to filter on
                    Comments

                    The path attribute contains a Simple FHIR Subset that allows path traversal, but not calculation.

                    Control0..1
                    Typestring
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    170. Library.dataRequirement.dateFilter.searchParam
                    Definition

                    A date parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type date, dateTime, Period, Schedule, or Timing.

                    ShortA date valued parameter to search on
                    Control0..1
                    Typestring
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    172. Library.dataRequirement.dateFilter.value[x]
                    Definition

                    The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now.

                    ShortThe value of the filter, as a Period, DateTime, or Duration value
                    Control0..1
                    TypeChoice of: dateTime, Period, Duration
                    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    174. Library.dataRequirement.limit
                    Definition

                    Specifies a maximum number of results that are required (uses the _count search parameter).

                    ShortNumber of results
                    Comments

                    This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5".

                    Control0..1
                    TypepositiveInt
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summarytrue
                    Requirements

                    Enables the requirement "most recent 5 results" to be expressed.

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    176. Library.dataRequirement.sort
                    Definition

                    Specifies the order of the results to be returned.

                    ShortOrder of the results
                    Comments

                    This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5". When multiple sorts are specified, they are applied in the order they appear in the resource.

                    Control0..*
                    TypeElement
                    Is Modifierfalse
                    Summarytrue
                    Requirements

                    Enables the requirement "most recent 5 results" to be expressed.

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    178. Library.dataRequirement.sort.id
                    Definition

                    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                    ShortUnique id for inter-element referencing
                    Control0..1
                    Typestring
                    Is Modifierfalse
                    XML FormatIn the XML format, this property is represented as an attribute.
                    Summaryfalse
                    180. Library.dataRequirement.sort.extension
                    Definition

                    May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                    ShortAdditional content defined by implementations
                    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.

                    Control0..*
                    TypeExtension
                    Is Modifierfalse
                    Summaryfalse
                    Alternate Namesextensions, user content
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    SlicingThis element introduces a set of slices on Library.dataRequirement.sort.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • value @ url
                    • 182. Library.dataRequirement.sort.path
                      Definition

                      The attribute of the sort. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant.

                      ShortThe name of the attribute to perform the sort
                      Control1..1
                      Typestring
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      184. Library.dataRequirement.sort.direction
                      Definition

                      The direction of the sort, ascending or descending.

                      Shortascending | descending
                      Control1..1
                      BindingThe codes SHALL be taken from SortDirection
                      (required to http://hl7.org/fhir/ValueSet/sort-direction|4.0.1)

                      The possible sort directions, ascending or descending.

                      Typecode
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      186. Library.content
                      Definition

                      The content of the library as an Attachment. The content may be a reference to a url, or may be directly embedded as a base-64 string. Either way, the contentType of the attachment determines how to interpret the content.

                      ShortContents of the library, either embedded or referenced
                      Control0..*
                      TypeAttachment
                      Is Modifierfalse
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))