Release 4B Snapshot #1

This page is part of the FHIR Specification v4.3.0-snapshot1: R4B Snapshot to support the Jan 2022 Connectathon. About the R4B version of FHIR. The current officially released version is 4.3.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4

14.12.13.2 StructureDefinition: CQL Library

Clinical Decision Support Work Group Maturity Level: 0Trial Use Use Context: Any

The official URL for this profile is: 

http://hl7.org/fhir/StructureDefinition/cqllibrary

Represents a CQL logic library

This profile was published on Thu, Jan 1, 1970 00:00+1000 as a draft by HL7.

14.12.13.2.1 Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from Library.

Summary

Mandatory: 1 element
Must-Support: 2 elements
Fixed Value: 1 element

This structure is derived from Library.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library 1..1LibraryRepresents a library of quality improvement components
... type 1..1CodeableConceptlogic-library | model-definition | asset-collection | module-definition
Fixed Value: As shown
.... coding1..1CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/library-type
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: logic-library
..... display1..1stringRepresentation defined by the system
Fixed Value: Logic Library
... parameter S0..*ParameterDefinitionParameters defined by the library
... dataRequirement S0..*DataRequirementWhat data is referenced by this library

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Library I1..1LibraryRepresents a library of quality improvement components
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (preferred)
Max Binding: All Languages: IETF language tag

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ0..1uriCanonical identifier for this library, represented as a URI (globally unique)
... identifier Σ0..*IdentifierAdditional identifier for the library
... version Σ0..1stringBusiness version of the library
... name ΣI0..1stringName for this library (computer friendly)
... title Σ0..1stringName for this library (human friendly)
... subtitle 0..1stringSubordinate title of the library
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ0..1booleanFor testing purposes, not real usage
... type Σ1..1CodeableConceptlogic-library | model-definition | asset-collection | module-definition
Binding: LibraryType (extensible): The type of knowledge asset this library contains.


Fixed Value: As shown
.... id0..0stringUnique id for inter-element referencing
.... extension0..0ExtensionAdditional content defined by implementations
.... coding1..1CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..0stringUnique id for inter-element referencing
..... extension0..0ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/library-type
..... version0..0stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: logic-library
..... display1..1stringRepresentation defined by the system
Fixed Value: Logic Library
..... userSelected0..0booleanIf this coding was chosen directly by the user
.... text0..0stringPlain text representation of the concept
... subject[x] 0..1Type of individual the library content is focused on
Binding: Subject type (extensible): The possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.).

.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group)
... date Σ0..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description Σ0..1markdownNatural language description of the library
... useContext Σ0..*UsageContextThe context that the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for library (if applicable)
Binding: Jurisdiction (extensible): Countries and regions within which this artifact is targeted for use.


... purpose 0..1markdownWhy this library is defined
... usage 0..1stringDescribes the clinical usage of the library
... copyright 0..1markdownUse and/or publishing restrictions
... approvalDate 0..1dateWhen the library was approved by publisher
... lastReviewDate 0..1dateWhen the library was last reviewed
... effectivePeriod Σ0..1PeriodWhen the library is expected to be used
... topic 0..*CodeableConceptE.g. Education, Treatment, Assessment, etc.
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.


... author 0..*ContactDetailWho authored the content
... editor 0..*ContactDetailWho edited the content
... reviewer 0..*ContactDetailWho reviewed the content
... endorser 0..*ContactDetailWho endorsed the content
... relatedArtifact 0..*RelatedArtifactAdditional documentation, citations, etc.
... parameter S0..*ParameterDefinitionParameters defined by the library
... dataRequirement S0..*DataRequirementWhat data is referenced by this library
... content Σ0..*AttachmentContents of the library, either embedded or referenced

doco Documentation for this format
<!-- CQL Library -->doco

<Library xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->
 <meta><!-- ?? 0..1 Meta Metadata about the resource --></meta>
 <implicitRules value="[uri]"/><!-- ?? 0..1 A set of rules under which this content was created -->
 <language value="[code]"/><!-- ?? 0..1 Language of the resource content   -->
 <text><!-- ?? 0..1 Narrative 
     Text summary of the resource, for human interpretation --></text>
 <contained><!-- 0..* Resource Contained, inline Resources --></contained>
 <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <url value="[uri]"/><!-- ?? 0..1 Canonical identifier for this library, represented as a URI (globally unique) -->
 <identifier><!-- ?? 0..* Identifier Additional identifier for the library --></identifier>
 <version value="[string]"/><!-- ?? 0..1 Business version of the library -->
 <name value="[string]"/><!-- ?? 0..1 Name for this library (computer friendly) -->
 <title value="[string]"/><!-- ?? 0..1 Name for this library (human friendly) -->
 <subtitle value="[string]"/><!-- ?? 0..1 Subordinate title of the library -->
 <status value="[code]"/><!-- ?? 1..1 draft | active | retired | unknown   -->
 <experimental value="[boolean]"/><!-- ?? 0..1 For testing purposes, not real usage -->
 <type><!-- ?? 1..1 CodeableConcept logic-library | model-definition | asset-collection | module-definition   --></type>
 <subject[x]><!-- ?? 0..1 CodeableConcept|Reference(Group) Type of individual the library content is focused on   --></subject[x]>
 <date value="[dateTime]"/><!-- ?? 0..1 Date last changed -->
 <publisher value="[string]"/><!-- ?? 0..1 Name of the publisher (organization or individual) -->
 <contact><!-- ?? 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- ?? 0..1 Natural language description of the library -->
 <useContext><!-- ?? 0..* UsageContext 
     The context that the content is intended to support --></useContext>
 <jurisdiction><!-- ?? 0..* CodeableConcept Intended jurisdiction for library (if applicable)   --></jurisdiction>
 <purpose value="[markdown]"/><!-- ?? 0..1 Why this library is defined -->
 <usage value="[string]"/><!-- ?? 0..1 Describes the clinical usage of the library -->
 <copyright value="[markdown]"/><!-- ?? 0..1 Use and/or publishing restrictions -->
 <approvalDate value="[date]"/><!-- ?? 0..1 When the library was approved by publisher -->
 <lastReviewDate value="[date]"/><!-- ?? 0..1 When the library was last reviewed -->
 <effectivePeriod><!-- ?? 0..1 Period 
     When the library is expected to be used --></effectivePeriod>
 <topic><!-- ?? 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.   --></topic>
 <author><!-- ?? 0..* ContactDetail Who authored the content --></author>
 <editor><!-- ?? 0..* ContactDetail Who edited the content --></editor>
 <reviewer><!-- ?? 0..* ContactDetail Who reviewed the content --></reviewer>
 <endorser><!-- ?? 0..* ContactDetail Who endorsed the content --></endorser>
 <relatedArtifact><!-- ?? 0..* RelatedArtifact 
     Additional documentation, citations, etc. --></relatedArtifact>
 <parameter><!-- ?? 0..* ParameterDefinition 
     Parameters defined by the library --></parameter>
 <dataRequirement><!-- ?? 0..* DataRequirement 
     What data is referenced by this library --></dataRequirement>
 <content><!-- ?? 0..* Attachment 
     Contents of the library, either embedded or referenced --></content>
</Library>

{ // CQL Library
  // from Element: extension
    "meta" : { Meta }, // C?Metadata about the resource
    "implicitRules" : "<uri>", // C?A set of rules under which this content was created
    "language" : "<code>", // C?Language of the resource content
    "text" : { Narrative }, // C?Text summary of the resource, for human interpretation
    "contained" : [{ Resource }], //Contained, inline Resources
    "modifierExtension" : [{ Extension }], // C?Extensions that cannot be ignored
    "url" : "<uri>", // C?Canonical identifier for this library, represented as a URI (globally unique)
    "identifier" : [{ Identifier }], // C?Additional identifier for the library
    "version" : "<string>", // C?Business version of the library
    "name" : "<string>", // C?Name for this library (computer friendly)
    "title" : "<string>", // C?Name for this library (human friendly)
    "subtitle" : "<string>", // C?Subordinate title of the library
    "status" : "<code>", // C? R! draft | active | retired | unknown
    "experimental" : <boolean>, // C?For testing purposes, not real usage
    "type" : { CodeableConcept }, // C? R! 
// value[x]: Type of individual the library content is focused on. One of these 2:
    "subjectCodeableConcept" : { CodeableConcept }, // C?Type of individual the library content is focused on
    "subjectReference" : { Reference(Group) }, // C?Type of individual the library content is focused on
    "date" : "<dateTime>", // C?Date last changed
    "publisher" : "<string>", // C?Name of the publisher (organization or individual)
    "contact" : [{ ContactDetail }], // C?Contact details for the publisher
    "description" : "<markdown>", // C?Natural language description of the library
    "useContext" : [{ UsageContext }], // C?The context that the content is intended to support
    "jurisdiction" : [{ CodeableConcept }], // C?Intended jurisdiction for library (if applicable)
    "purpose" : "<markdown>", // C?Why this library is defined
    "usage" : "<string>", // C?Describes the clinical usage of the library
    "copyright" : "<markdown>", // C?Use and/or publishing restrictions
    "approvalDate" : "<date>", // C?When the library was approved by publisher
    "lastReviewDate" : "<date>", // C?When the library was last reviewed
    "effectivePeriod" : { Period }, // C?When the library is expected to be used
    "topic" : [{ CodeableConcept }], // C?E.g. Education, Treatment, Assessment, etc.
    "author" : [{ ContactDetail }], // C?Who authored the content
    "editor" : [{ ContactDetail }], // C?Who edited the content
    "reviewer" : [{ ContactDetail }], // C?Who reviewed the content
    "endorser" : [{ ContactDetail }], // C?Who endorsed the content
    "relatedArtifact" : [{ RelatedArtifact }], // C?Additional documentation, citations, etc.
    "parameter" : [{ ParameterDefinition }], // C?Parameters defined by the library
    "dataRequirement" : [{ DataRequirement }] // C?What data is referenced by this library
    "content" : [{ Attachment }], // C?Contents of the library, either embedded or referenced
  }

This structure is derived from Library.

Summary

Mandatory: 1 element
Must-Support: 2 elements
Fixed Value: 1 element

Differential View

This structure is derived from Library.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library 1..1LibraryRepresents a library of quality improvement components
... type 1..1CodeableConceptlogic-library | model-definition | asset-collection | module-definition
Fixed Value: As shown
.... coding1..1CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/library-type
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: logic-library
..... display1..1stringRepresentation defined by the system
Fixed Value: Logic Library
... parameter S0..*ParameterDefinitionParameters defined by the library
... dataRequirement S0..*DataRequirementWhat data is referenced by this library

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library I1..1LibraryRepresents a library of quality improvement components
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (preferred)
Max Binding: All Languages: IETF language tag

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ0..1uriCanonical identifier for this library, represented as a URI (globally unique)
... identifier Σ0..*IdentifierAdditional identifier for the library
... version Σ0..1stringBusiness version of the library
... name ΣI0..1stringName for this library (computer friendly)
... title Σ0..1stringName for this library (human friendly)
... subtitle 0..1stringSubordinate title of the library
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ0..1booleanFor testing purposes, not real usage
... type Σ1..1CodeableConceptlogic-library | model-definition | asset-collection | module-definition
Binding: LibraryType (extensible): The type of knowledge asset this library contains.


Fixed Value: As shown
.... id0..0stringUnique id for inter-element referencing
.... extension0..0ExtensionAdditional content defined by implementations
.... coding1..1CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..0stringUnique id for inter-element referencing
..... extension0..0ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/library-type
..... version0..0stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: logic-library
..... display1..1stringRepresentation defined by the system
Fixed Value: Logic Library
..... userSelected0..0booleanIf this coding was chosen directly by the user
.... text0..0stringPlain text representation of the concept
... subject[x] 0..1Type of individual the library content is focused on
Binding: Subject type (extensible): The possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.).

.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group)
... date Σ0..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description Σ0..1markdownNatural language description of the library
... useContext Σ0..*UsageContextThe context that the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for library (if applicable)
Binding: Jurisdiction (extensible): Countries and regions within which this artifact is targeted for use.


... purpose 0..1markdownWhy this library is defined
... usage 0..1stringDescribes the clinical usage of the library
... copyright 0..1markdownUse and/or publishing restrictions
... approvalDate 0..1dateWhen the library was approved by publisher
... lastReviewDate 0..1dateWhen the library was last reviewed
... effectivePeriod Σ0..1PeriodWhen the library is expected to be used
... topic 0..*CodeableConceptE.g. Education, Treatment, Assessment, etc.
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.


... author 0..*ContactDetailWho authored the content
... editor 0..*ContactDetailWho edited the content
... reviewer 0..*ContactDetailWho reviewed the content
... endorser 0..*ContactDetailWho endorsed the content
... relatedArtifact 0..*RelatedArtifactAdditional documentation, citations, etc.
... parameter S0..*ParameterDefinitionParameters defined by the library
... dataRequirement S0..*DataRequirementWhat data is referenced by this library
... content Σ0..*AttachmentContents of the library, either embedded or referenced

doco Documentation for this format

XML Template

<!-- CQL Library -->doco

<Library xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->
 <meta><!-- ?? 0..1 Meta Metadata about the resource --></meta>
 <implicitRules value="[uri]"/><!-- ?? 0..1 A set of rules under which this content was created -->
 <language value="[code]"/><!-- ?? 0..1 Language of the resource content   -->
 <text><!-- ?? 0..1 Narrative 
     Text summary of the resource, for human interpretation --></text>
 <contained><!-- 0..* Resource Contained, inline Resources --></contained>
 <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <url value="[uri]"/><!-- ?? 0..1 Canonical identifier for this library, represented as a URI (globally unique) -->
 <identifier><!-- ?? 0..* Identifier Additional identifier for the library --></identifier>
 <version value="[string]"/><!-- ?? 0..1 Business version of the library -->
 <name value="[string]"/><!-- ?? 0..1 Name for this library (computer friendly) -->
 <title value="[string]"/><!-- ?? 0..1 Name for this library (human friendly) -->
 <subtitle value="[string]"/><!-- ?? 0..1 Subordinate title of the library -->
 <status value="[code]"/><!-- ?? 1..1 draft | active | retired | unknown   -->
 <experimental value="[boolean]"/><!-- ?? 0..1 For testing purposes, not real usage -->
 <type><!-- ?? 1..1 CodeableConcept logic-library | model-definition | asset-collection | module-definition   --></type>
 <subject[x]><!-- ?? 0..1 CodeableConcept|Reference(Group) Type of individual the library content is focused on   --></subject[x]>
 <date value="[dateTime]"/><!-- ?? 0..1 Date last changed -->
 <publisher value="[string]"/><!-- ?? 0..1 Name of the publisher (organization or individual) -->
 <contact><!-- ?? 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- ?? 0..1 Natural language description of the library -->
 <useContext><!-- ?? 0..* UsageContext 
     The context that the content is intended to support --></useContext>
 <jurisdiction><!-- ?? 0..* CodeableConcept Intended jurisdiction for library (if applicable)   --></jurisdiction>
 <purpose value="[markdown]"/><!-- ?? 0..1 Why this library is defined -->
 <usage value="[string]"/><!-- ?? 0..1 Describes the clinical usage of the library -->
 <copyright value="[markdown]"/><!-- ?? 0..1 Use and/or publishing restrictions -->
 <approvalDate value="[date]"/><!-- ?? 0..1 When the library was approved by publisher -->
 <lastReviewDate value="[date]"/><!-- ?? 0..1 When the library was last reviewed -->
 <effectivePeriod><!-- ?? 0..1 Period 
     When the library is expected to be used --></effectivePeriod>
 <topic><!-- ?? 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.   --></topic>
 <author><!-- ?? 0..* ContactDetail Who authored the content --></author>
 <editor><!-- ?? 0..* ContactDetail Who edited the content --></editor>
 <reviewer><!-- ?? 0..* ContactDetail Who reviewed the content --></reviewer>
 <endorser><!-- ?? 0..* ContactDetail Who endorsed the content --></endorser>
 <relatedArtifact><!-- ?? 0..* RelatedArtifact 
     Additional documentation, citations, etc. --></relatedArtifact>
 <parameter><!-- ?? 0..* ParameterDefinition 
     Parameters defined by the library --></parameter>
 <dataRequirement><!-- ?? 0..* DataRequirement 
     What data is referenced by this library --></dataRequirement>
 <content><!-- ?? 0..* Attachment 
     Contents of the library, either embedded or referenced --></content>
</Library>

JSON Template

{ // CQL Library
  // from Element: extension
    "meta" : { Meta }, // C?Metadata about the resource
    "implicitRules" : "<uri>", // C?A set of rules under which this content was created
    "language" : "<code>", // C?Language of the resource content
    "text" : { Narrative }, // C?Text summary of the resource, for human interpretation
    "contained" : [{ Resource }], //Contained, inline Resources
    "modifierExtension" : [{ Extension }], // C?Extensions that cannot be ignored
    "url" : "<uri>", // C?Canonical identifier for this library, represented as a URI (globally unique)
    "identifier" : [{ Identifier }], // C?Additional identifier for the library
    "version" : "<string>", // C?Business version of the library
    "name" : "<string>", // C?Name for this library (computer friendly)
    "title" : "<string>", // C?Name for this library (human friendly)
    "subtitle" : "<string>", // C?Subordinate title of the library
    "status" : "<code>", // C? R! draft | active | retired | unknown
    "experimental" : <boolean>, // C?For testing purposes, not real usage
    "type" : { CodeableConcept }, // C? R! 
// value[x]: Type of individual the library content is focused on. One of these 2:
    "subjectCodeableConcept" : { CodeableConcept }, // C?Type of individual the library content is focused on
    "subjectReference" : { Reference(Group) }, // C?Type of individual the library content is focused on
    "date" : "<dateTime>", // C?Date last changed
    "publisher" : "<string>", // C?Name of the publisher (organization or individual)
    "contact" : [{ ContactDetail }], // C?Contact details for the publisher
    "description" : "<markdown>", // C?Natural language description of the library
    "useContext" : [{ UsageContext }], // C?The context that the content is intended to support
    "jurisdiction" : [{ CodeableConcept }], // C?Intended jurisdiction for library (if applicable)
    "purpose" : "<markdown>", // C?Why this library is defined
    "usage" : "<string>", // C?Describes the clinical usage of the library
    "copyright" : "<markdown>", // C?Use and/or publishing restrictions
    "approvalDate" : "<date>", // C?When the library was approved by publisher
    "lastReviewDate" : "<date>", // C?When the library was last reviewed
    "effectivePeriod" : { Period }, // C?When the library is expected to be used
    "topic" : [{ CodeableConcept }], // C?E.g. Education, Treatment, Assessment, etc.
    "author" : [{ ContactDetail }], // C?Who authored the content
    "editor" : [{ ContactDetail }], // C?Who edited the content
    "reviewer" : [{ ContactDetail }], // C?Who reviewed the content
    "endorser" : [{ ContactDetail }], // C?Who endorsed the content
    "relatedArtifact" : [{ RelatedArtifact }], // C?Additional documentation, citations, etc.
    "parameter" : [{ ParameterDefinition }], // C?Parameters defined by the library
    "dataRequirement" : [{ DataRequirement }] // C?What data is referenced by this library
    "content" : [{ Attachment }], // C?Contents of the library, either embedded or referenced
  }

 

Alternate definitions: Master Definition (XML, JSON), Schematron

14.12.13.2.2 Terminology Bindings

PathNameConformanceValueSet
Library.languageCommon LanguagespreferredCommon Languages
Library.statusPublicationStatusrequiredPublicationStatus
Library.typeLibraryTypeextensibleLibraryType
Library.subject[x]Subject typeextensibleSubject type
Library.jurisdictionJurisdictionextensibleJurisdiction
Library.topicDefinitionTopicexampleDefinitionTopic
.