FHIR Clinical Guidelines (v1.0.0) (STU1)

This page is part of the Clinical Guidelines (v1.0.0: STU 1) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions

D.4.1 StructureDefinition-cpg-computablelibrary

Introduction:

Examples:

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is: 

http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-computablelibrary

The computable library profile sets the minimum expectations for a computable CQL library

This profile builds on CPGShareableLibrary.

This profile was published on Thu Jun 06 00:00:00 UTC 2019 as a draft by Health Level Seven, Inc. - CDS WG.

Description of Profiles, Differentials, and Snapshots.

Summary

Mandatory: 3 elements (1 nested mandatory element)
Must-Support: 11 elements
Fixed Value: 2 elements

Slices

This structure defines the following Slices:

  • The element Library.relatedArtifact is sliced based on the value of value:type
  • The element Library.content is sliced based on the value of value:contentType
NameFlagsCard.TypeDescription & Constraintsdoco
.. Library 1..1CPGShareableLibraryRepresents a library of quality improvement components
... subject[x] S0..1CodeableConcept, Reference(Group)Type of individual the library content is focused on
... relatedArtifact S0..*(Slice Definition)Additional documentation, citations, etc.
Slice: Unordered, Open by value:type
.... relatedArtifact:dependency S0..*RelatedArtifactAdditional documentation, citations, etc.
..... type S1..1codedocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Fixed Value: depends-on
..... resource S1..1canonical(CodeSystem | ValueSet | Library)What resource is being referenced
... parameter S0..*ParameterDefinitionParameters defined by the library
... dataRequirement S0..*DataRequirementWhat data is referenced by this library
... content S0..*(Slice Definition)Contents of the library, either embedded or referenced
Slice: Unordered, Open by value:contentType
.... content:cqlContent S1..1AttachmentCQL Content
..... contentType S1..1codeMime type of the content, with charset etc.
Fixed Value: text/cql
..... data S1..1base64BinaryData inline, base64ed

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Library I1..1CPGShareableLibraryRepresents a library of quality improvement components
... id Σ0..1stringLogical 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: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... cpg-knowledgeCapability S1..*codeshareable | computable | publishable | executable
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-knowledgeCapability
Binding: CPG Knowledge Capability (required): A knowledge capability provided by a knowledge artifact


... cpg-knowledgeRepresentationLevel S0..*codenarrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-knowledgeRepresentationLevel
Binding: CPG Knowledge Representation Level (required): A level of knowledge representation provided by this artifact


... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ1..1uriCanonical identifier for this library, represented as a URI (globally unique)
... identifier SΣ0..*IdentifierAdditional identifier for the library
... version Σ1..1stringBusiness version of the library
... name ΣI1..1stringName for this library (computer friendly)
... title SΣ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 Σ1..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.

... subject[x] S0..1Type of individual the library content is focused on
Binding: SubjectType (extensible): The possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.).

.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group)
... date SΣ0..1dateTimeDate last changed
... publisher Σ1..1stringName of the publisher (organization or individual)
... contact SΣ0..*ContactDetailContact details for the publisher
... description Σ1..1markdownNatural language description of the library
... useContext SΣ0..*UsageContextThe context that the content is intended to support
... jurisdiction SΣ0..*CodeableConceptIntended jurisdiction for library (if applicable)
Binding: Jurisdiction ValueSet (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 S0..*(Slice Definition)Additional documentation, citations, etc.
Slice: Unordered, Open by value:type
.... relatedArtifact:dependency S0..*RelatedArtifactAdditional documentation, citations, etc.
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... type SΣ1..1codedocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.


Fixed Value: depends-on
..... label Σ0..1stringShort label
..... display Σ0..1stringBrief description of the related artifact
..... citation Σ0..1markdownBibliographic citation for the artifact
..... url Σ0..1urlWhere the artifact can be accessed
..... document Σ0..1AttachmentWhat document is being referenced
..... resource SΣ1..1canonical(CodeSystem | ValueSet | Library)What resource is being referenced
... parameter S0..*ParameterDefinitionParameters defined by the library
... dataRequirement S0..*DataRequirementWhat data is referenced by this library
... content SΣ0..*(Slice Definition)Contents of the library, either embedded or referenced
Slice: Unordered, Open by value:contentType
.... content:cqlContent SΣ1..1AttachmentCQL Content
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... contentType SΣ1..1codeMime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


Fixed Value: text/cql
..... language Σ0..1codeHuman language of the content (BCP-47)
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.


Example General: en-AU
..... data S1..1base64BinaryData inline, base64ed
..... url Σ0..1urlUri where the data can be found
Example General: http://www.acme.com/logo-small.png
..... size Σ0..1unsignedIntNumber of bytes of content (if url provided)
..... hash Σ0..1base64BinaryHash of the data (sha-1, base64ed)
..... title Σ0..1stringLabel to display in place of the data
Example General: Official Corporate Logo
..... creation Σ0..1dateTimeDate attachment was first created

doco Documentation for this format

Summary

Mandatory: 3 elements (1 nested mandatory element)
Must-Support: 11 elements
Fixed Value: 2 elements

Slices

This structure defines the following Slices:

  • The element Library.relatedArtifact is sliced based on the value of value:type
  • The element Library.content is sliced based on the value of value:contentType

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library 1..1CPGShareableLibraryRepresents a library of quality improvement components
... subject[x] S0..1CodeableConcept, Reference(Group)Type of individual the library content is focused on
... relatedArtifact S0..*(Slice Definition)Additional documentation, citations, etc.
Slice: Unordered, Open by value:type
.... relatedArtifact:dependency S0..*RelatedArtifactAdditional documentation, citations, etc.
..... type S1..1codedocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Fixed Value: depends-on
..... resource S1..1canonical(CodeSystem | ValueSet | Library)What resource is being referenced
... parameter S0..*ParameterDefinitionParameters defined by the library
... dataRequirement S0..*DataRequirementWhat data is referenced by this library
... content S0..*(Slice Definition)Contents of the library, either embedded or referenced
Slice: Unordered, Open by value:contentType
.... content:cqlContent S1..1AttachmentCQL Content
..... contentType S1..1codeMime type of the content, with charset etc.
Fixed Value: text/cql
..... data S1..1base64BinaryData inline, base64ed

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library I1..1CPGShareableLibraryRepresents a library of quality improvement components
... id Σ0..1stringLogical 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: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... cpg-knowledgeCapability S1..*codeshareable | computable | publishable | executable
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-knowledgeCapability
Binding: CPG Knowledge Capability (required): A knowledge capability provided by a knowledge artifact


... cpg-knowledgeRepresentationLevel S0..*codenarrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-knowledgeRepresentationLevel
Binding: CPG Knowledge Representation Level (required): A level of knowledge representation provided by this artifact


... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ1..1uriCanonical identifier for this library, represented as a URI (globally unique)
... identifier SΣ0..*IdentifierAdditional identifier for the library
... version Σ1..1stringBusiness version of the library
... name ΣI1..1stringName for this library (computer friendly)
... title SΣ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 Σ1..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.

... subject[x] S0..1Type of individual the library content is focused on
Binding: SubjectType (extensible): The possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.).

.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group)
... date SΣ0..1dateTimeDate last changed
... publisher Σ1..1stringName of the publisher (organization or individual)
... contact SΣ0..*ContactDetailContact details for the publisher
... description Σ1..1markdownNatural language description of the library
... useContext SΣ0..*UsageContextThe context that the content is intended to support
... jurisdiction SΣ0..*CodeableConceptIntended jurisdiction for library (if applicable)
Binding: Jurisdiction ValueSet (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 S0..*(Slice Definition)Additional documentation, citations, etc.
Slice: Unordered, Open by value:type
.... relatedArtifact:dependency S0..*RelatedArtifactAdditional documentation, citations, etc.
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... type SΣ1..1codedocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.


Fixed Value: depends-on
..... label Σ0..1stringShort label
..... display Σ0..1stringBrief description of the related artifact
..... citation Σ0..1markdownBibliographic citation for the artifact
..... url Σ0..1urlWhere the artifact can be accessed
..... document Σ0..1AttachmentWhat document is being referenced
..... resource SΣ1..1canonical(CodeSystem | ValueSet | Library)What resource is being referenced
... parameter S0..*ParameterDefinitionParameters defined by the library
... dataRequirement S0..*DataRequirementWhat data is referenced by this library
... content SΣ0..*(Slice Definition)Contents of the library, either embedded or referenced
Slice: Unordered, Open by value:contentType
.... content:cqlContent SΣ1..1AttachmentCQL Content
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... contentType SΣ1..1codeMime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


Fixed Value: text/cql
..... language Σ0..1codeHuman language of the content (BCP-47)
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.


Example General: en-AU
..... data S1..1base64BinaryData inline, base64ed
..... url Σ0..1urlUri where the data can be found
Example General: http://www.acme.com/logo-small.png
..... size Σ0..1unsignedIntNumber of bytes of content (if url provided)
..... hash Σ0..1base64BinaryHash of the data (sha-1, base64ed)
..... title Σ0..1stringLabel to display in place of the data
Example General: Official Corporate Logo
..... creation Σ0..1dateTimeDate attachment was first created

doco Documentation for this format

 

D.4.1.2 Terminology Bindings

Terminology Bindings

PathConformanceValueSet / Code
Library.languagepreferredCommonLanguages
Max Binding: AllLanguages
Library.statusrequiredPublicationStatus
Library.typeextensibleLibraryType
Library.subject[x]extensibleSubjectType
Library.jurisdictionextensibleJurisdiction ValueSet
Library.topicexampleDefinitionTopic
Library.relatedArtifact:dependency.typerequiredFixed Value: depends-on
Library.content:cqlContent.contentTyperequiredFixed Value: text/cql
Library.content:cqlContent.languagepreferredCommonLanguages
Max Binding: AllLanguages

D.4.1.3 Constraints

Constraints

IdPathDetailsRequirements
dom-2LibraryIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3LibraryIf 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-4LibraryIf 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-5LibraryIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6LibraryA resource should have narrative for robust management
: text.`div`.exists()
lib-0LibraryName 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}')
ele-1Library.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Library.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Library.extension:knowledgeCapabilityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Library.extension:knowledgeCapabilityMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Library.extension:knowledgeRepresentationLevelAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Library.extension:knowledgeRepresentationLevelMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Library.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Library.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Library.urlAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.versionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.titleAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.subtitleAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.experimentalAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.subject[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.dateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.publisherAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.contactAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.descriptionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.useContextAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.jurisdictionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.purposeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.usageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.copyrightAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.approvalDateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.lastReviewDateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.effectivePeriodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.topicAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.authorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.editorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.reviewerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.endorserAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.relatedArtifactAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.relatedArtifact:dependencyAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.relatedArtifact:dependency.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Library.relatedArtifact:dependency.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Library.relatedArtifact:dependency.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.relatedArtifact:dependency.labelAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.relatedArtifact:dependency.displayAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.relatedArtifact:dependency.citationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.relatedArtifact:dependency.urlAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.relatedArtifact:dependency.documentAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.relatedArtifact:dependency.resourceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.parameterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.dataRequirementAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.contentAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.content:cqlContentAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.content:cqlContent.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Library.content:cqlContent.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Library.content:cqlContent.contentTypeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.content:cqlContent.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.content:cqlContent.dataAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.content:cqlContent.urlAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.content:cqlContent.sizeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.content:cqlContent.hashAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.content:cqlContent.titleAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.content:cqlContent.creationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())