Quality Measure Implementation Guide
3.0.0-ballot - STU 2 International flag

Quality Measure Implementation Guide, published by HL7 International / Clinical Quality Information. This guide is not an authorized publication; it is the continuous build for version 3.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-cqm/ and changes regularly. See the Directory of published versions

Resource Profile: CQM Publishable Library

Official URL: http://hl7.org/fhir/uv/cqm/StructureDefinition/cqm-publishablelibrary Version: 3.0.0-ballot
Standards status: Trial-use Maturity Level: 4 Computable Name: CQMPublishableLibrary
Other Identifiers: OID:2.16.840.1.113883.4.642.40.61.42.40

The CQM Publishable Library profile defines the minimum expectations to enable appropriate content management, discovery, and utilization of the library resources used for published Quality Measures (QMs). For more information on the usage of this profile, refer to the Profiles and Packaging pages in this implementation guide.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Library C 1..1 CRMIPublishableLibrary(2.0.0) Represents a library of quality improvement components
Constraints: lib-0, pub-1
Library.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Library.meta.Slices for extension Content/Rules for all slices
Library.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
Constraints: ext-1
Library.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Library.text This element must be supported. 1..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Library.Slices for extension Content/Rules for all slices
Library.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
Constraints: ext-1
Library.Slices for extension.extension:logicDefinition This element must be supported. 0..* (Complex) A logic definition used in the artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
Constraints: ext-1
Library.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
Constraints: ext-1
Library.Slices for extension.extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
Constraints: ext-1
Library.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
Constraints: ext-1
Library.Slices for extension.extension:softwaresystem This element must be supported. 0..* Reference(CRMI Software System Device) Extension
URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-softwaresystem
Constraints: ext-1
Library.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
Library.Slices for identifier This element must be supported. This element is included in summaries. 0..* Identifier Additional identifier for the library
Slice: Unordered, Open by value:type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Library.Slices for identifier.identifier:versionIndependentIdentifier This element must be supported. This element is included in summaries. 0..1 Identifier Library guid
Library.Slices for identifier.identifier:versionIndependentIdentifier.use This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: official (no extensions allowed)
Library.Slices for identifier.identifier:versionIndependentIdentifier.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/artifact-identifier-type",
      "code" : "version-independent"
    }
  ]
}
Library.Slices for identifier.identifier:versionIndependentIdentifier.system This element must be supported. This element is included in summaries. 1..1 uri The namespace for the identifier value
Fixed Value: urn:ietf:rfc:3986 (no extensions allowed)
Library.Slices for identifier.identifier:versionIndependentIdentifier.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Library.Slices for identifier.identifier:versionSpecificIdentifier This element must be supported. This element is included in summaries. 0..1 Identifier Library version guid
Library.Slices for identifier.identifier:versionSpecificIdentifier.use This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: official (no extensions allowed)
Library.Slices for identifier.identifier:versionSpecificIdentifier.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/artifact-identifier-type",
      "code" : "version-specific"
    }
  ]
}
Library.Slices for identifier.identifier:versionSpecificIdentifier.system This element must be supported. This element is included in summaries. 1..1 uri The namespace for the identifier value
Fixed Value: urn:ietf:rfc:3986 (no extensions allowed)
Library.Slices for identifier.identifier:versionSpecificIdentifier.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Library.Slices for identifier.identifier:shortName This element must be supported. This element is included in summaries. 0..1 Identifier Short name
Library.Slices for identifier.identifier:shortName.use This element is a modifier element. This element must be supported. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: usual (no extensions allowed)
Library.Slices for identifier.identifier:shortName.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/artifact-identifier-type",
      "code" : "short-name"
    }
  ]
}
Library.Slices for identifier.identifier:shortName.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Library.Slices for identifier.identifier:endorserIdentifier This element must be supported. This element is included in summaries. 0..* Identifier Endorser identifier
Library.Slices for identifier.identifier:endorserIdentifier.use This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: official (no extensions allowed)
Library.Slices for identifier.identifier:endorserIdentifier.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/artifact-identifier-type",
      "code" : "endorser"
    }
  ]
}
Library.Slices for identifier.identifier:endorserIdentifier.system This element must be supported. This element is included in summaries. 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Library.Slices for identifier.identifier:endorserIdentifier.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Library.Slices for identifier.identifier:endorserIdentifier.assigner This element must be supported. This element is included in summaries. 1..1 Reference(Organization) Organization that issued id (may be just text)
Library.Slices for identifier.identifier:endorserIdentifier.assigner.display This element must be supported. This element is included in summaries. 1..1 string Text alternative for the resource
Library.Slices for identifier.identifier:publisherIdentifier This element must be supported. This element is included in summaries. 0..* Identifier Publisher identifier
Library.Slices for identifier.identifier:publisherIdentifier.use This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: official (no extensions allowed)
Library.Slices for identifier.identifier:publisherIdentifier.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/artifact-identifier-type",
      "code" : "publisher"
    }
  ]
}
Library.Slices for identifier.identifier:publisherIdentifier.system This element must be supported. This element is included in summaries. 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Library.Slices for identifier.identifier:publisherIdentifier.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Library.Slices for identifier.identifier:publisherIdentifier.assigner This element must be supported. This element is included in summaries. 1..1 Reference(Organization) Organization that issued id (may be just text)
Library.Slices for identifier.identifier:publisherIdentifier.assigner.display This element must be supported. This element is included in summaries. 1..1 string Text alternative for the resource
Library.title This element must be supported. This element is included in summaries. 1..1 string Name for this library (human friendly)
Library.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
Library.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept logic-library | model-definition | asset-collection | module-definition
Binding: LibraryType (extensible): The type of knowledge asset this library contains.
Library.date This element must be supported. This element is included in summaries. 1..1 dateTime Date last changed
Library.publisher This element must be supported. This element is included in summaries. 1..1 string Name of the publisher (organization or individual)
Library.contact This element must be supported. This element is included in summaries. 1..* ContactDetail Contact details for the publisher
Library.Slices for useContext This element must be supported. This element is included in summaries. 0..* UsageContext The context that the content is intended to support
Slice: Unordered, Open by value:code

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Library.Slices for useContext.useContext:intendedVenue This element must be supported. This element is included in summaries. 0..* UsageContext What venue?
Library.Slices for useContext.useContext:intendedVenue.code This element must be supported. This element is included in summaries. 1..1 Coding Type of context being specified
Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context.
Required Pattern: 
{
  "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type",
  "code" : "venue"
}
Library.Slices for useContext.useContext:intendedVenue.value[x] This element must be supported. This element is included in summaries. 1..1 CodeableConcept Value that defines the context
Binding: IntendedVenue (4.0.0) (extensible)
Library.jurisdiction This element must be supported. This element is included in summaries. 0..* CodeableConcept Intended jurisdiction for library (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
Library.purpose This element must be supported. 0..1 markdown Why this library is defined
Library.usage This element must be supported. 0..1 string Describes the clinical usage of the library
Library.copyright This element must be supported. 0..1 markdown Use and/or publishing restrictions
Library.approvalDate This element must be supported. 0..1 date When the library was approved by publisher
Library.lastReviewDate This element must be supported. 0..1 date When the library was last reviewed
Library.effectivePeriod This element must be supported. This element is included in summaries. 0..1 Period When the library is expected to be used
Library.topic This element must be supported. 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.
Library.author This element must be supported. 0..* ContactDetail Who authored the content
Library.editor This element must be supported. 0..* ContactDetail Who edited the content
Library.reviewer This element must be supported. 0..* ContactDetail Who reviewed the content
Library.endorser This element must be supported. 0..* ContactDetail Who endorsed the content
Library.relatedArtifact This element must be supported. 0..* RelatedArtifact Additional documentation, citations, etc.
Library.relatedArtifact.Slices for extension Content/Rules for all slices
Library.relatedArtifact.Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
Constraints: ext-1
Library.relatedArtifact.Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
Constraints: ext-1
Library.relatedArtifact.type This element is included in summaries. 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
Library.relatedArtifact.display This element must be supported. This element is included in summaries. 0..1 string Brief description of the related artifact
Library.relatedArtifact.document This element must be supported. This element is included in summaries. 0..1 Attachment What document is being referenced
Library.relatedArtifact.resource This element must be supported. This element is included in summaries. 0..1 canonical(Resource) What resource is being referenced

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Library.identifier:versionIndependentIdentifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Library.identifier:versionIndependentIdentifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Library.identifier:versionSpecificIdentifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Library.identifier:versionSpecificIdentifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Library.identifier:shortName.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Library.identifier:shortName.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Library.identifier:endorserIdentifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Library.identifier:endorserIdentifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Library.identifier:publisherIdentifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Library.identifier:publisherIdentifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Library.status Base required PublicationStatus 📍4.0.1 FHIR Std.
Library.type Base extensible LibraryType 📍4.0.1 FHIR Std.
Library.useContext:intendedVenue.​code Base extensible UsageContextType 📍4.0.1 FHIR Std.
Library.useContext:intendedVenue.​value[x] Base extensible Intended Venue 📍4.0.0 This IG
Library.jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.
Library.topic Base example DefinitionTopic 📍4.0.1 FHIR Std.
Library.relatedArtifact.​type Base required RelatedArtifactType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Library If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Library 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 error Library 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 error Library If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Library A resource should have narrative for robust management text.`div`.exists()
ele-1 error Library.meta, Library.meta.extension:packageSource, Library.implicitRules, Library.text, Library.extension:knowledgeCapability, Library.extension:logicDefinition, Library.extension:copyrightLabel, Library.extension:artifactComment, Library.extension:authoritativeSource, Library.extension:softwaresystem, Library.modifierExtension, Library.identifier, Library.identifier:versionIndependentIdentifier, Library.identifier:versionIndependentIdentifier.use, Library.identifier:versionIndependentIdentifier.type, Library.identifier:versionIndependentIdentifier.system, Library.identifier:versionIndependentIdentifier.value, Library.identifier:versionSpecificIdentifier, Library.identifier:versionSpecificIdentifier.use, Library.identifier:versionSpecificIdentifier.type, Library.identifier:versionSpecificIdentifier.system, Library.identifier:versionSpecificIdentifier.value, Library.identifier:shortName, Library.identifier:shortName.use, Library.identifier:shortName.type, Library.identifier:shortName.value, Library.identifier:endorserIdentifier, Library.identifier:endorserIdentifier.use, Library.identifier:endorserIdentifier.type, Library.identifier:endorserIdentifier.system, Library.identifier:endorserIdentifier.value, Library.identifier:endorserIdentifier.assigner, Library.identifier:endorserIdentifier.assigner.display, Library.identifier:publisherIdentifier, Library.identifier:publisherIdentifier.use, Library.identifier:publisherIdentifier.type, Library.identifier:publisherIdentifier.system, Library.identifier:publisherIdentifier.value, Library.identifier:publisherIdentifier.assigner, Library.identifier:publisherIdentifier.assigner.display, Library.title, Library.status, Library.type, Library.date, Library.publisher, Library.contact, Library.useContext, Library.useContext:intendedVenue, Library.useContext:intendedVenue.code, Library.useContext:intendedVenue.value[x], Library.jurisdiction, Library.purpose, Library.usage, Library.copyright, Library.approvalDate, Library.lastReviewDate, Library.effectivePeriod, Library.topic, Library.author, Library.editor, Library.reviewer, Library.endorser, Library.relatedArtifact, Library.relatedArtifact.extension:publicationDate, Library.relatedArtifact.extension:publicationStatus, Library.relatedArtifact.type, Library.relatedArtifact.display, Library.relatedArtifact.document, Library.relatedArtifact.resource All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Library.meta.extension:packageSource, Library.extension:knowledgeCapability, Library.extension:logicDefinition, Library.extension:copyrightLabel, Library.extension:artifactComment, Library.extension:authoritativeSource, Library.extension:softwaresystem, Library.modifierExtension, Library.relatedArtifact.extension:publicationDate, Library.relatedArtifact.extension:publicationStatus Must have either extensions or value[x], not both extension.exists() != value.exists()
lib-0 warning Library 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}')
pub-1 error Library If knowledge capabilities are stated, they SHALL include publishable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()

This structure is derived from CRMIPublishableLibrary

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Library 1..1 CRMIPublishableLibrary(2.0.0) Represents a library of quality improvement components
Library.text This element must be supported. 1..1 Narrative Text summary of the resource, for human interpretation
Library.Slices for extension Content/Rules for all slices
Library.Slices for extension.extension:softwaresystem This element must be supported. 0..* Reference(CRMI Software System Device) Extension
URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-softwaresystem
Library.Slices for identifier This element must be supported. 0..* Identifier Additional identifier for the library
Slice: Unordered, Open by value:type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Library.Slices for identifier.identifier:versionIndependentIdentifier This element must be supported. 0..1 Identifier Library guid
Library.Slices for identifier.identifier:versionIndependentIdentifier.use This element must be supported. 1..1 code usual | official | temp | secondary | old (If known)
Fixed Value: official (no extensions allowed)
Library.Slices for identifier.identifier:versionIndependentIdentifier.type This element must be supported. 1..1 CodeableConcept Description of identifier
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/artifact-identifier-type",
      "code" : "version-independent"
    }
  ]
}
Library.Slices for identifier.identifier:versionIndependentIdentifier.system This element must be supported. 1..1 uri The namespace for the identifier value
Fixed Value: urn:ietf:rfc:3986 (no extensions allowed)
Library.Slices for identifier.identifier:versionIndependentIdentifier.value This element must be supported. 1..1 string The value that is unique
Library.Slices for identifier.identifier:versionSpecificIdentifier This element must be supported. 0..1 Identifier Library version guid
Library.Slices for identifier.identifier:versionSpecificIdentifier.use This element must be supported. 1..1 code usual | official | temp | secondary | old (If known)
Fixed Value: official (no extensions allowed)
Library.Slices for identifier.identifier:versionSpecificIdentifier.type This element must be supported. 1..1 CodeableConcept Description of identifier
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/artifact-identifier-type",
      "code" : "version-specific"
    }
  ]
}
Library.Slices for identifier.identifier:versionSpecificIdentifier.system This element must be supported. 1..1 uri The namespace for the identifier value
Fixed Value: urn:ietf:rfc:3986 (no extensions allowed)
Library.Slices for identifier.identifier:versionSpecificIdentifier.value This element must be supported. 1..1 string The value that is unique
Library.Slices for identifier.identifier:shortName This element must be supported. 0..1 Identifier Short name
Library.Slices for identifier.identifier:shortName.use This element must be supported. 0..1 code usual | official | temp | secondary | old (If known)
Fixed Value: usual (no extensions allowed)
Library.Slices for identifier.identifier:shortName.type This element must be supported. 1..1 CodeableConcept Description of identifier
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/artifact-identifier-type",
      "code" : "short-name"
    }
  ]
}
Library.Slices for identifier.identifier:shortName.value This element must be supported. 1..1 string The value that is unique
Library.Slices for identifier.identifier:endorserIdentifier This element must be supported. 0..* Identifier Endorser identifier
Library.Slices for identifier.identifier:endorserIdentifier.use This element must be supported. 1..1 code usual | official | temp | secondary | old (If known)
Fixed Value: official (no extensions allowed)
Library.Slices for identifier.identifier:endorserIdentifier.type This element must be supported. 1..1 CodeableConcept Description of identifier
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/artifact-identifier-type",
      "code" : "endorser"
    }
  ]
}
Library.Slices for identifier.identifier:endorserIdentifier.system This element must be supported. 0..1 uri The namespace for the identifier value
Library.Slices for identifier.identifier:endorserIdentifier.value This element must be supported. 1..1 string The value that is unique
Library.Slices for identifier.identifier:endorserIdentifier.assigner This element must be supported. 1..1 Reference(Organization) Organization that issued id (may be just text)
Library.Slices for identifier.identifier:endorserIdentifier.assigner.display This element must be supported. 1..1 string Text alternative for the resource
Library.Slices for identifier.identifier:publisherIdentifier This element must be supported. 0..* Identifier Publisher identifier
Library.Slices for identifier.identifier:publisherIdentifier.use This element must be supported. 1..1 code usual | official | temp | secondary | old (If known)
Fixed Value: official (no extensions allowed)
Library.Slices for identifier.identifier:publisherIdentifier.type This element must be supported. 1..1 CodeableConcept Description of identifier
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/artifact-identifier-type",
      "code" : "publisher"
    }
  ]
}
Library.Slices for identifier.identifier:publisherIdentifier.system This element must be supported. 0..1 uri The namespace for the identifier value
Library.Slices for identifier.identifier:publisherIdentifier.value This element must be supported. 1..1 string The value that is unique
Library.Slices for identifier.identifier:publisherIdentifier.assigner This element must be supported. 1..1 Reference(Organization) Organization that issued id (may be just text)
Library.Slices for identifier.identifier:publisherIdentifier.assigner.display This element must be supported. 1..1 string Text alternative for the resource
Library.publisher This element must be supported. 1..1 string Name of the publisher (organization or individual)
Library.contact This element must be supported. 1..* ContactDetail Contact details for the publisher
Library.Slices for useContext This element must be supported. 0..* UsageContext The context that the content is intended to support
Slice: Unordered, Open by value:code

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Library.Slices for useContext.useContext:intendedVenue This element must be supported. 0..* UsageContext What venue?
Library.Slices for useContext.useContext:intendedVenue.code This element must be supported. 1..1 Coding Type of context being specified
Required Pattern: 
{
  "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type",
  "code" : "venue"
}
Library.Slices for useContext.useContext:intendedVenue.value[x] This element must be supported. 1..1 CodeableConcept Value that defines the context
Binding: IntendedVenue (4.0.0) (extensible)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Library.useContext:intendedVenue.​value[x] Base extensible Intended Venue 📍4.0.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Library C 1..1 CRMIPublishableLibrary(2.0.0) Represents a library of quality improvement components
Constraints: lib-0, pub-1
Library.id This element is included in summaries. 0..1 id Logical id of this artifact
Library.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Library.meta.id 0..1 string Unique id for inter-element referencing
Library.meta.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
Library.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
Constraints: ext-1
Library.meta.versionId This element is included in summaries. 0..1 id Version specific identifier
Library.meta.lastUpdated This element is included in summaries. 0..1 instant When the resource version last changed
Library.meta.source This element is included in summaries. 0..1 uri Identifies where the resource comes from
Library.meta.profile This element is included in summaries. 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
Library.meta.security This element is included in summaries. 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Library.meta.tag This element is included in summaries. 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
Library.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Library.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Library.text This element must be supported. 1..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Library.contained 0..* Resource Contained, inline Resources
Library.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
Library.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
Constraints: ext-1
Library.Slices for extension.extension:logicDefinition This element must be supported. 0..* (Complex) A logic definition used in the artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
Constraints: ext-1
Library.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
Constraints: ext-1
Library.Slices for extension.extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
Constraints: ext-1
Library.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
Constraints: ext-1
Library.Slices for extension.extension:softwaresystem This element must be supported. 0..* Reference(CRMI Software System Device) Extension
URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-softwaresystem
Constraints: ext-1
Library.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
Library.url This element is included in summaries. 0..1 uri Canonical identifier for this library, represented as a URI (globally unique)
Library.Slices for identifier This element must be supported. This element is included in summaries. 0..* Identifier Additional identifier for the library
Slice: Unordered, Open by value:type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Library.Slices for identifier.identifier:versionIndependentIdentifier This element must be supported. This element is included in summaries. 0..1 Identifier Library guid
Library.Slices for identifier.identifier:versionIndependentIdentifier.id 0..1 string Unique id for inter-element referencing
Library.Slices for identifier.identifier:versionIndependentIdentifier.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
Library.Slices for identifier.identifier:versionIndependentIdentifier.use This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: official (no extensions allowed)
Library.Slices for identifier.identifier:versionIndependentIdentifier.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/artifact-identifier-type",
      "code" : "version-independent"
    }
  ]
}
Library.Slices for identifier.identifier:versionIndependentIdentifier.system This element must be supported. This element is included in summaries. 1..1 uri The namespace for the identifier value
Fixed Value: urn:ietf:rfc:3986 (no extensions allowed)
Library.Slices for identifier.identifier:versionIndependentIdentifier.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Library.Slices for identifier.identifier:versionIndependentIdentifier.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Library.Slices for identifier.identifier:versionIndependentIdentifier.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Library.Slices for identifier.identifier:versionSpecificIdentifier This element must be supported. This element is included in summaries. 0..1 Identifier Library version guid
Library.Slices for identifier.identifier:versionSpecificIdentifier.id 0..1 string Unique id for inter-element referencing
Library.Slices for identifier.identifier:versionSpecificIdentifier.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
Library.Slices for identifier.identifier:versionSpecificIdentifier.use This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: official (no extensions allowed)
Library.Slices for identifier.identifier:versionSpecificIdentifier.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/artifact-identifier-type",
      "code" : "version-specific"
    }
  ]
}
Library.Slices for identifier.identifier:versionSpecificIdentifier.system This element must be supported. This element is included in summaries. 1..1 uri The namespace for the identifier value
Fixed Value: urn:ietf:rfc:3986 (no extensions allowed)
Library.Slices for identifier.identifier:versionSpecificIdentifier.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Library.Slices for identifier.identifier:versionSpecificIdentifier.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Library.Slices for identifier.identifier:versionSpecificIdentifier.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Library.Slices for identifier.identifier:shortName This element must be supported. This element is included in summaries. 0..1 Identifier Short name
Library.Slices for identifier.identifier:shortName.id 0..1 string Unique id for inter-element referencing
Library.Slices for identifier.identifier:shortName.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
Library.Slices for identifier.identifier:shortName.use This element is a modifier element. This element must be supported. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: usual (no extensions allowed)
Library.Slices for identifier.identifier:shortName.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/artifact-identifier-type",
      "code" : "short-name"
    }
  ]
}
Library.Slices for identifier.identifier:shortName.system This element is included in summaries. 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Library.Slices for identifier.identifier:shortName.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Library.Slices for identifier.identifier:shortName.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Library.Slices for identifier.identifier:shortName.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Library.Slices for identifier.identifier:endorserIdentifier This element must be supported. This element is included in summaries. 0..* Identifier Endorser identifier
Library.Slices for identifier.identifier:endorserIdentifier.id 0..1 string Unique id for inter-element referencing
Library.Slices for identifier.identifier:endorserIdentifier.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
Library.Slices for identifier.identifier:endorserIdentifier.use This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: official (no extensions allowed)
Library.Slices for identifier.identifier:endorserIdentifier.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/artifact-identifier-type",
      "code" : "endorser"
    }
  ]
}
Library.Slices for identifier.identifier:endorserIdentifier.system This element must be supported. This element is included in summaries. 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Library.Slices for identifier.identifier:endorserIdentifier.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Library.Slices for identifier.identifier:endorserIdentifier.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Library.Slices for identifier.identifier:endorserIdentifier.assigner This element must be supported. This element is included in summaries. 1..1 Reference(Organization) Organization that issued id (may be just text)
Library.Slices for identifier.identifier:endorserIdentifier.assigner.id 0..1 string Unique id for inter-element referencing
Library.Slices for identifier.identifier:endorserIdentifier.assigner.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
Library.Slices for identifier.identifier:endorserIdentifier.assigner.reference This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
Library.Slices for identifier.identifier:endorserIdentifier.assigner.type This element is included in summaries. 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Library.Slices for identifier.identifier:endorserIdentifier.assigner.identifier This element is included in summaries. 0..1 Identifier Logical reference, when literal reference is not known
Library.Slices for identifier.identifier:endorserIdentifier.assigner.display This element must be supported. This element is included in summaries. 1..1 string Text alternative for the resource
Library.Slices for identifier.identifier:publisherIdentifier This element must be supported. This element is included in summaries. 0..* Identifier Publisher identifier
Library.Slices for identifier.identifier:publisherIdentifier.id 0..1 string Unique id for inter-element referencing
Library.Slices for identifier.identifier:publisherIdentifier.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
Library.Slices for identifier.identifier:publisherIdentifier.use This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: official (no extensions allowed)
Library.Slices for identifier.identifier:publisherIdentifier.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/artifact-identifier-type",
      "code" : "publisher"
    }
  ]
}
Library.Slices for identifier.identifier:publisherIdentifier.system This element must be supported. This element is included in summaries. 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Library.Slices for identifier.identifier:publisherIdentifier.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Library.Slices for identifier.identifier:publisherIdentifier.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Library.Slices for identifier.identifier:publisherIdentifier.assigner This element must be supported. This element is included in summaries. 1..1 Reference(Organization) Organization that issued id (may be just text)
Library.Slices for identifier.identifier:publisherIdentifier.assigner.id 0..1 string Unique id for inter-element referencing
Library.Slices for identifier.identifier:publisherIdentifier.assigner.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
Library.Slices for identifier.identifier:publisherIdentifier.assigner.reference This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
Library.Slices for identifier.identifier:publisherIdentifier.assigner.type This element is included in summaries. 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Library.Slices for identifier.identifier:publisherIdentifier.assigner.identifier This element is included in summaries. 0..1 Identifier Logical reference, when literal reference is not known
Library.Slices for identifier.identifier:publisherIdentifier.assigner.display This element must be supported. This element is included in summaries. 1..1 string Text alternative for the resource
Library.version This element is included in summaries. 0..1 string Business version of the library
Library.name This element is included in summaries. C 0..1 string Name for this library (computer friendly)
Library.title This element must be supported. This element is included in summaries. 1..1 string Name for this library (human friendly)
Library.subtitle 0..1 string Subordinate title of the library
Library.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
Library.experimental This element is included in summaries. 0..1 boolean For testing purposes, not real usage
Library.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept logic-library | model-definition | asset-collection | module-definition
Binding: LibraryType (extensible): The type of knowledge asset this library contains.
Library.subject[x] 0..1 Type 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.).
Library.subject[x].subjectCodeableConcept CodeableConcept
Library.subject[x].subjectReference Reference(Group)
Library.date This element must be supported. This element is included in summaries. 1..1 dateTime Date last changed
Library.publisher This element must be supported. This element is included in summaries. 1..1 string Name of the publisher (organization or individual)
Library.contact This element must be supported. This element is included in summaries. 1..* ContactDetail Contact details for the publisher
Library.description This element is included in summaries. 0..1 markdown Natural language description of the library
Library.Slices for useContext This element must be supported. This element is included in summaries. 0..* UsageContext The context that the content is intended to support
Slice: Unordered, Open by value:code

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Library.Slices for useContext.useContext:intendedVenue This element must be supported. This element is included in summaries. 0..* UsageContext What venue?
Library.Slices for useContext.useContext:intendedVenue.id 0..1 string Unique id for inter-element referencing
Library.Slices for useContext.useContext:intendedVenue.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
Library.Slices for useContext.useContext:intendedVenue.code This element must be supported. This element is included in summaries. 1..1 Coding Type of context being specified
Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context.
Required Pattern: 
{
  "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type",
  "code" : "venue"
}
Library.Slices for useContext.useContext:intendedVenue.value[x] This element must be supported. This element is included in summaries. 1..1 CodeableConcept Value that defines the context
Binding: IntendedVenue (4.0.0) (extensible)
Library.jurisdiction This element must be supported. This element is included in summaries. 0..* CodeableConcept Intended jurisdiction for library (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
Library.purpose This element must be supported. 0..1 markdown Why this library is defined
Library.usage This element must be supported. 0..1 string Describes the clinical usage of the library
Library.copyright This element must be supported. 0..1 markdown Use and/or publishing restrictions
Library.approvalDate This element must be supported. 0..1 date When the library was approved by publisher
Library.lastReviewDate This element must be supported. 0..1 date When the library was last reviewed
Library.effectivePeriod This element must be supported. This element is included in summaries. 0..1 Period When the library is expected to be used
Library.topic This element must be supported. 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.
Library.author This element must be supported. 0..* ContactDetail Who authored the content
Library.editor This element must be supported. 0..* ContactDetail Who edited the content
Library.reviewer This element must be supported. 0..* ContactDetail Who reviewed the content
Library.endorser This element must be supported. 0..* ContactDetail Who endorsed the content
Library.relatedArtifact This element must be supported. 0..* RelatedArtifact Additional documentation, citations, etc.
Library.relatedArtifact.id 0..1 string Unique id for inter-element referencing
Library.relatedArtifact.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
Library.relatedArtifact.Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
Constraints: ext-1
Library.relatedArtifact.Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
Constraints: ext-1
Library.relatedArtifact.type This element is included in summaries. 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
Library.relatedArtifact.label This element is included in summaries. 0..1 string Short label
Library.relatedArtifact.display This element must be supported. This element is included in summaries. 0..1 string Brief description of the related artifact
Library.relatedArtifact.citation This element is included in summaries. 0..1 markdown Bibliographic citation for the artifact
Library.relatedArtifact.url This element is included in summaries. 0..1 url Where the artifact can be accessed
Library.relatedArtifact.document This element must be supported. This element is included in summaries. 0..1 Attachment What document is being referenced
Library.relatedArtifact.resource This element must be supported. This element is included in summaries. 0..1 canonical(Resource) What resource is being referenced
Library.parameter 0..* ParameterDefinition Parameters defined by the library
Library.dataRequirement 0..* DataRequirement What data is referenced by this library
Library.content This element is included in summaries. 0..* Attachment Contents of the library, either embedded or referenced

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Library.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Library.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Library.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Library.identifier:versionIndependentIdentifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Library.identifier:versionIndependentIdentifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Library.identifier:versionSpecificIdentifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Library.identifier:versionSpecificIdentifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Library.identifier:shortName.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Library.identifier:shortName.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Library.identifier:endorserIdentifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Library.identifier:endorserIdentifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Library.identifier:endorserIdentifier.​assigner.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Library.identifier:publisherIdentifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Library.identifier:publisherIdentifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Library.identifier:publisherIdentifier.​assigner.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Library.status Base required PublicationStatus 📍4.0.1 FHIR Std.
Library.type Base extensible LibraryType 📍4.0.1 FHIR Std.
Library.subject[x] Base extensible Subject type 📍4.0.1 FHIR Std.
Library.useContext:intendedVenue.​code Base extensible UsageContextType 📍4.0.1 FHIR Std.
Library.useContext:intendedVenue.​value[x] Base extensible Intended Venue 📍4.0.0 This IG
Library.jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.
Library.topic Base example DefinitionTopic 📍4.0.1 FHIR Std.
Library.relatedArtifact.​type Base required RelatedArtifactType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Library If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Library 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 error Library 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 error Library If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Library A resource should have narrative for robust management text.`div`.exists()
ele-1 error Library.meta, Library.meta.extension, Library.meta.extension:packageSource, Library.meta.versionId, Library.meta.lastUpdated, Library.meta.source, Library.meta.profile, Library.meta.security, Library.meta.tag, Library.implicitRules, Library.language, Library.text, Library.extension, Library.extension:knowledgeCapability, Library.extension:logicDefinition, Library.extension:copyrightLabel, Library.extension:artifactComment, Library.extension:authoritativeSource, Library.extension:softwaresystem, Library.modifierExtension, Library.url, Library.identifier, Library.identifier:versionIndependentIdentifier, Library.identifier:versionIndependentIdentifier.extension, Library.identifier:versionIndependentIdentifier.use, Library.identifier:versionIndependentIdentifier.type, Library.identifier:versionIndependentIdentifier.system, Library.identifier:versionIndependentIdentifier.value, Library.identifier:versionIndependentIdentifier.period, Library.identifier:versionIndependentIdentifier.assigner, Library.identifier:versionSpecificIdentifier, Library.identifier:versionSpecificIdentifier.extension, Library.identifier:versionSpecificIdentifier.use, Library.identifier:versionSpecificIdentifier.type, Library.identifier:versionSpecificIdentifier.system, Library.identifier:versionSpecificIdentifier.value, Library.identifier:versionSpecificIdentifier.period, Library.identifier:versionSpecificIdentifier.assigner, Library.identifier:shortName, Library.identifier:shortName.extension, Library.identifier:shortName.use, Library.identifier:shortName.type, Library.identifier:shortName.system, Library.identifier:shortName.value, Library.identifier:shortName.period, Library.identifier:shortName.assigner, Library.identifier:endorserIdentifier, Library.identifier:endorserIdentifier.extension, Library.identifier:endorserIdentifier.use, Library.identifier:endorserIdentifier.type, Library.identifier:endorserIdentifier.system, Library.identifier:endorserIdentifier.value, Library.identifier:endorserIdentifier.period, Library.identifier:endorserIdentifier.assigner, Library.identifier:endorserIdentifier.assigner.extension, Library.identifier:endorserIdentifier.assigner.reference, Library.identifier:endorserIdentifier.assigner.type, Library.identifier:endorserIdentifier.assigner.identifier, Library.identifier:endorserIdentifier.assigner.display, Library.identifier:publisherIdentifier, Library.identifier:publisherIdentifier.extension, Library.identifier:publisherIdentifier.use, Library.identifier:publisherIdentifier.type, Library.identifier:publisherIdentifier.system, Library.identifier:publisherIdentifier.value, Library.identifier:publisherIdentifier.period, Library.identifier:publisherIdentifier.assigner, Library.identifier:publisherIdentifier.assigner.extension, Library.identifier:publisherIdentifier.assigner.reference, Library.identifier:publisherIdentifier.assigner.type, Library.identifier:publisherIdentifier.assigner.identifier, Library.identifier:publisherIdentifier.assigner.display, Library.version, Library.name, Library.title, Library.subtitle, Library.status, Library.experimental, Library.type, Library.subject[x], Library.date, Library.publisher, Library.contact, Library.description, Library.useContext, Library.useContext:intendedVenue, Library.useContext:intendedVenue.extension, Library.useContext:intendedVenue.code, Library.useContext:intendedVenue.value[x], Library.jurisdiction, Library.purpose, Library.usage, Library.copyright, Library.approvalDate, Library.lastReviewDate, Library.effectivePeriod, Library.topic, Library.author, Library.editor, Library.reviewer, Library.endorser, Library.relatedArtifact, Library.relatedArtifact.extension, Library.relatedArtifact.extension:publicationDate, Library.relatedArtifact.extension:publicationStatus, Library.relatedArtifact.type, Library.relatedArtifact.label, Library.relatedArtifact.display, Library.relatedArtifact.citation, Library.relatedArtifact.url, Library.relatedArtifact.document, Library.relatedArtifact.resource, Library.parameter, Library.dataRequirement, Library.content All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Library.meta.extension, Library.meta.extension:packageSource, Library.extension, Library.extension:knowledgeCapability, Library.extension:logicDefinition, Library.extension:copyrightLabel, Library.extension:artifactComment, Library.extension:authoritativeSource, Library.extension:softwaresystem, Library.modifierExtension, Library.identifier:versionIndependentIdentifier.extension, Library.identifier:versionSpecificIdentifier.extension, Library.identifier:shortName.extension, Library.identifier:endorserIdentifier.extension, Library.identifier:endorserIdentifier.assigner.extension, Library.identifier:publisherIdentifier.extension, Library.identifier:publisherIdentifier.assigner.extension, Library.useContext:intendedVenue.extension, Library.relatedArtifact.extension, Library.relatedArtifact.extension:publicationDate, Library.relatedArtifact.extension:publicationStatus Must have either extensions or value[x], not both extension.exists() != value.exists()
lib-0 warning Library 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}')
pub-1 error Library If knowledge capabilities are stated, they SHALL include publishable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()

This structure is derived from CRMIPublishableLibrary

Summary

Mandatory: 4 elements(22 nested mandatory elements)
Must-Support: 38 elements
Fixed: 7 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Library.identifier
  • The element 1 is sliced based on the value of Library.useContext

Maturity: 4

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Library C 1..1 CRMIPublishableLibrary(2.0.0) Represents a library of quality improvement components
Constraints: lib-0, pub-1
Library.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Library.meta.Slices for extension Content/Rules for all slices
Library.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
Constraints: ext-1
Library.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Library.text This element must be supported. 1..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Library.Slices for extension Content/Rules for all slices
Library.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
Constraints: ext-1
Library.Slices for extension.extension:logicDefinition This element must be supported. 0..* (Complex) A logic definition used in the artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
Constraints: ext-1
Library.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
Constraints: ext-1
Library.Slices for extension.extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
Constraints: ext-1
Library.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
Constraints: ext-1
Library.Slices for extension.extension:softwaresystem This element must be supported. 0..* Reference(CRMI Software System Device) Extension
URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-softwaresystem
Constraints: ext-1
Library.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
Library.Slices for identifier This element must be supported. This element is included in summaries. 0..* Identifier Additional identifier for the library
Slice: Unordered, Open by value:type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Library.Slices for identifier.identifier:versionIndependentIdentifier This element must be supported. This element is included in summaries. 0..1 Identifier Library guid
Library.Slices for identifier.identifier:versionIndependentIdentifier.use This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: official (no extensions allowed)
Library.Slices for identifier.identifier:versionIndependentIdentifier.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/artifact-identifier-type",
      "code" : "version-independent"
    }
  ]
}
Library.Slices for identifier.identifier:versionIndependentIdentifier.system This element must be supported. This element is included in summaries. 1..1 uri The namespace for the identifier value
Fixed Value: urn:ietf:rfc:3986 (no extensions allowed)
Library.Slices for identifier.identifier:versionIndependentIdentifier.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Library.Slices for identifier.identifier:versionSpecificIdentifier This element must be supported. This element is included in summaries. 0..1 Identifier Library version guid
Library.Slices for identifier.identifier:versionSpecificIdentifier.use This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: official (no extensions allowed)
Library.Slices for identifier.identifier:versionSpecificIdentifier.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/artifact-identifier-type",
      "code" : "version-specific"
    }
  ]
}
Library.Slices for identifier.identifier:versionSpecificIdentifier.system This element must be supported. This element is included in summaries. 1..1 uri The namespace for the identifier value
Fixed Value: urn:ietf:rfc:3986 (no extensions allowed)
Library.Slices for identifier.identifier:versionSpecificIdentifier.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Library.Slices for identifier.identifier:shortName This element must be supported. This element is included in summaries. 0..1 Identifier Short name
Library.Slices for identifier.identifier:shortName.use This element is a modifier element. This element must be supported. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: usual (no extensions allowed)
Library.Slices for identifier.identifier:shortName.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/artifact-identifier-type",
      "code" : "short-name"
    }
  ]
}
Library.Slices for identifier.identifier:shortName.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Library.Slices for identifier.identifier:endorserIdentifier This element must be supported. This element is included in summaries. 0..* Identifier Endorser identifier
Library.Slices for identifier.identifier:endorserIdentifier.use This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: official (no extensions allowed)
Library.Slices for identifier.identifier:endorserIdentifier.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/artifact-identifier-type",
      "code" : "endorser"
    }
  ]
}
Library.Slices for identifier.identifier:endorserIdentifier.system This element must be supported. This element is included in summaries. 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Library.Slices for identifier.identifier:endorserIdentifier.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Library.Slices for identifier.identifier:endorserIdentifier.assigner This element must be supported. This element is included in summaries. 1..1 Reference(Organization) Organization that issued id (may be just text)
Library.Slices for identifier.identifier:endorserIdentifier.assigner.display This element must be supported. This element is included in summaries. 1..1 string Text alternative for the resource
Library.Slices for identifier.identifier:publisherIdentifier This element must be supported. This element is included in summaries. 0..* Identifier Publisher identifier
Library.Slices for identifier.identifier:publisherIdentifier.use This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: official (no extensions allowed)
Library.Slices for identifier.identifier:publisherIdentifier.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/artifact-identifier-type",
      "code" : "publisher"
    }
  ]
}
Library.Slices for identifier.identifier:publisherIdentifier.system This element must be supported. This element is included in summaries. 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Library.Slices for identifier.identifier:publisherIdentifier.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Library.Slices for identifier.identifier:publisherIdentifier.assigner This element must be supported. This element is included in summaries. 1..1 Reference(Organization) Organization that issued id (may be just text)
Library.Slices for identifier.identifier:publisherIdentifier.assigner.display This element must be supported. This element is included in summaries. 1..1 string Text alternative for the resource
Library.title This element must be supported. This element is included in summaries. 1..1 string Name for this library (human friendly)
Library.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
Library.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept logic-library | model-definition | asset-collection | module-definition
Binding: LibraryType (extensible): The type of knowledge asset this library contains.
Library.date This element must be supported. This element is included in summaries. 1..1 dateTime Date last changed
Library.publisher This element must be supported. This element is included in summaries. 1..1 string Name of the publisher (organization or individual)
Library.contact This element must be supported. This element is included in summaries. 1..* ContactDetail Contact details for the publisher
Library.Slices for useContext This element must be supported. This element is included in summaries. 0..* UsageContext The context that the content is intended to support
Slice: Unordered, Open by value:code

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Library.Slices for useContext.useContext:intendedVenue This element must be supported. This element is included in summaries. 0..* UsageContext What venue?
Library.Slices for useContext.useContext:intendedVenue.code This element must be supported. This element is included in summaries. 1..1 Coding Type of context being specified
Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context.
Required Pattern: 
{
  "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type",
  "code" : "venue"
}
Library.Slices for useContext.useContext:intendedVenue.value[x] This element must be supported. This element is included in summaries. 1..1 CodeableConcept Value that defines the context
Binding: IntendedVenue (4.0.0) (extensible)
Library.jurisdiction This element must be supported. This element is included in summaries. 0..* CodeableConcept Intended jurisdiction for library (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
Library.purpose This element must be supported. 0..1 markdown Why this library is defined
Library.usage This element must be supported. 0..1 string Describes the clinical usage of the library
Library.copyright This element must be supported. 0..1 markdown Use and/or publishing restrictions
Library.approvalDate This element must be supported. 0..1 date When the library was approved by publisher
Library.lastReviewDate This element must be supported. 0..1 date When the library was last reviewed
Library.effectivePeriod This element must be supported. This element is included in summaries. 0..1 Period When the library is expected to be used
Library.topic This element must be supported. 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.
Library.author This element must be supported. 0..* ContactDetail Who authored the content
Library.editor This element must be supported. 0..* ContactDetail Who edited the content
Library.reviewer This element must be supported. 0..* ContactDetail Who reviewed the content
Library.endorser This element must be supported. 0..* ContactDetail Who endorsed the content
Library.relatedArtifact This element must be supported. 0..* RelatedArtifact Additional documentation, citations, etc.
Library.relatedArtifact.Slices for extension Content/Rules for all slices
Library.relatedArtifact.Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
Constraints: ext-1
Library.relatedArtifact.Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
Constraints: ext-1
Library.relatedArtifact.type This element is included in summaries. 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
Library.relatedArtifact.display This element must be supported. This element is included in summaries. 0..1 string Brief description of the related artifact
Library.relatedArtifact.document This element must be supported. This element is included in summaries. 0..1 Attachment What document is being referenced
Library.relatedArtifact.resource This element must be supported. This element is included in summaries. 0..1 canonical(Resource) What resource is being referenced

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Library.identifier:versionIndependentIdentifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Library.identifier:versionIndependentIdentifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Library.identifier:versionSpecificIdentifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Library.identifier:versionSpecificIdentifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Library.identifier:shortName.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Library.identifier:shortName.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Library.identifier:endorserIdentifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Library.identifier:endorserIdentifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Library.identifier:publisherIdentifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Library.identifier:publisherIdentifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Library.status Base required PublicationStatus 📍4.0.1 FHIR Std.
Library.type Base extensible LibraryType 📍4.0.1 FHIR Std.
Library.useContext:intendedVenue.​code Base extensible UsageContextType 📍4.0.1 FHIR Std.
Library.useContext:intendedVenue.​value[x] Base extensible Intended Venue 📍4.0.0 This IG
Library.jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.
Library.topic Base example DefinitionTopic 📍4.0.1 FHIR Std.
Library.relatedArtifact.​type Base required RelatedArtifactType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Library If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Library 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 error Library 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 error Library If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Library A resource should have narrative for robust management text.`div`.exists()
ele-1 error Library.meta, Library.meta.extension:packageSource, Library.implicitRules, Library.text, Library.extension:knowledgeCapability, Library.extension:logicDefinition, Library.extension:copyrightLabel, Library.extension:artifactComment, Library.extension:authoritativeSource, Library.extension:softwaresystem, Library.modifierExtension, Library.identifier, Library.identifier:versionIndependentIdentifier, Library.identifier:versionIndependentIdentifier.use, Library.identifier:versionIndependentIdentifier.type, Library.identifier:versionIndependentIdentifier.system, Library.identifier:versionIndependentIdentifier.value, Library.identifier:versionSpecificIdentifier, Library.identifier:versionSpecificIdentifier.use, Library.identifier:versionSpecificIdentifier.type, Library.identifier:versionSpecificIdentifier.system, Library.identifier:versionSpecificIdentifier.value, Library.identifier:shortName, Library.identifier:shortName.use, Library.identifier:shortName.type, Library.identifier:shortName.value, Library.identifier:endorserIdentifier, Library.identifier:endorserIdentifier.use, Library.identifier:endorserIdentifier.type, Library.identifier:endorserIdentifier.system, Library.identifier:endorserIdentifier.value, Library.identifier:endorserIdentifier.assigner, Library.identifier:endorserIdentifier.assigner.display, Library.identifier:publisherIdentifier, Library.identifier:publisherIdentifier.use, Library.identifier:publisherIdentifier.type, Library.identifier:publisherIdentifier.system, Library.identifier:publisherIdentifier.value, Library.identifier:publisherIdentifier.assigner, Library.identifier:publisherIdentifier.assigner.display, Library.title, Library.status, Library.type, Library.date, Library.publisher, Library.contact, Library.useContext, Library.useContext:intendedVenue, Library.useContext:intendedVenue.code, Library.useContext:intendedVenue.value[x], Library.jurisdiction, Library.purpose, Library.usage, Library.copyright, Library.approvalDate, Library.lastReviewDate, Library.effectivePeriod, Library.topic, Library.author, Library.editor, Library.reviewer, Library.endorser, Library.relatedArtifact, Library.relatedArtifact.extension:publicationDate, Library.relatedArtifact.extension:publicationStatus, Library.relatedArtifact.type, Library.relatedArtifact.display, Library.relatedArtifact.document, Library.relatedArtifact.resource All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Library.meta.extension:packageSource, Library.extension:knowledgeCapability, Library.extension:logicDefinition, Library.extension:copyrightLabel, Library.extension:artifactComment, Library.extension:authoritativeSource, Library.extension:softwaresystem, Library.modifierExtension, Library.relatedArtifact.extension:publicationDate, Library.relatedArtifact.extension:publicationStatus Must have either extensions or value[x], not both extension.exists() != value.exists()
lib-0 warning Library 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}')
pub-1 error Library If knowledge capabilities are stated, they SHALL include publishable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()

Differential View

This structure is derived from CRMIPublishableLibrary

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Library 1..1 CRMIPublishableLibrary(2.0.0) Represents a library of quality improvement components
Library.text This element must be supported. 1..1 Narrative Text summary of the resource, for human interpretation
Library.Slices for extension Content/Rules for all slices
Library.Slices for extension.extension:softwaresystem This element must be supported. 0..* Reference(CRMI Software System Device) Extension
URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-softwaresystem
Library.Slices for identifier This element must be supported. 0..* Identifier Additional identifier for the library
Slice: Unordered, Open by value:type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Library.Slices for identifier.identifier:versionIndependentIdentifier This element must be supported. 0..1 Identifier Library guid
Library.Slices for identifier.identifier:versionIndependentIdentifier.use This element must be supported. 1..1 code usual | official | temp | secondary | old (If known)
Fixed Value: official (no extensions allowed)
Library.Slices for identifier.identifier:versionIndependentIdentifier.type This element must be supported. 1..1 CodeableConcept Description of identifier
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/artifact-identifier-type",
      "code" : "version-independent"
    }
  ]
}
Library.Slices for identifier.identifier:versionIndependentIdentifier.system This element must be supported. 1..1 uri The namespace for the identifier value
Fixed Value: urn:ietf:rfc:3986 (no extensions allowed)
Library.Slices for identifier.identifier:versionIndependentIdentifier.value This element must be supported. 1..1 string The value that is unique
Library.Slices for identifier.identifier:versionSpecificIdentifier This element must be supported. 0..1 Identifier Library version guid
Library.Slices for identifier.identifier:versionSpecificIdentifier.use This element must be supported. 1..1 code usual | official | temp | secondary | old (If known)
Fixed Value: official (no extensions allowed)
Library.Slices for identifier.identifier:versionSpecificIdentifier.type This element must be supported. 1..1 CodeableConcept Description of identifier
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/artifact-identifier-type",
      "code" : "version-specific"
    }
  ]
}
Library.Slices for identifier.identifier:versionSpecificIdentifier.system This element must be supported. 1..1 uri The namespace for the identifier value
Fixed Value: urn:ietf:rfc:3986 (no extensions allowed)
Library.Slices for identifier.identifier:versionSpecificIdentifier.value This element must be supported. 1..1 string The value that is unique
Library.Slices for identifier.identifier:shortName This element must be supported. 0..1 Identifier Short name
Library.Slices for identifier.identifier:shortName.use This element must be supported. 0..1 code usual | official | temp | secondary | old (If known)
Fixed Value: usual (no extensions allowed)
Library.Slices for identifier.identifier:shortName.type This element must be supported. 1..1 CodeableConcept Description of identifier
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/artifact-identifier-type",
      "code" : "short-name"
    }
  ]
}
Library.Slices for identifier.identifier:shortName.value This element must be supported. 1..1 string The value that is unique
Library.Slices for identifier.identifier:endorserIdentifier This element must be supported. 0..* Identifier Endorser identifier
Library.Slices for identifier.identifier:endorserIdentifier.use This element must be supported. 1..1 code usual | official | temp | secondary | old (If known)
Fixed Value: official (no extensions allowed)
Library.Slices for identifier.identifier:endorserIdentifier.type This element must be supported. 1..1 CodeableConcept Description of identifier
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/artifact-identifier-type",
      "code" : "endorser"
    }
  ]
}
Library.Slices for identifier.identifier:endorserIdentifier.system This element must be supported. 0..1 uri The namespace for the identifier value
Library.Slices for identifier.identifier:endorserIdentifier.value This element must be supported. 1..1 string The value that is unique
Library.Slices for identifier.identifier:endorserIdentifier.assigner This element must be supported. 1..1 Reference(Organization) Organization that issued id (may be just text)
Library.Slices for identifier.identifier:endorserIdentifier.assigner.display This element must be supported. 1..1 string Text alternative for the resource
Library.Slices for identifier.identifier:publisherIdentifier This element must be supported. 0..* Identifier Publisher identifier
Library.Slices for identifier.identifier:publisherIdentifier.use This element must be supported. 1..1 code usual | official | temp | secondary | old (If known)
Fixed Value: official (no extensions allowed)
Library.Slices for identifier.identifier:publisherIdentifier.type This element must be supported. 1..1 CodeableConcept Description of identifier
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/artifact-identifier-type",
      "code" : "publisher"
    }
  ]
}
Library.Slices for identifier.identifier:publisherIdentifier.system This element must be supported. 0..1 uri The namespace for the identifier value
Library.Slices for identifier.identifier:publisherIdentifier.value This element must be supported. 1..1 string The value that is unique
Library.Slices for identifier.identifier:publisherIdentifier.assigner This element must be supported. 1..1 Reference(Organization) Organization that issued id (may be just text)
Library.Slices for identifier.identifier:publisherIdentifier.assigner.display This element must be supported. 1..1 string Text alternative for the resource
Library.title This element must be supported. 1..1 string Name for this library (human friendly)
Library.publisher This element must be supported. 1..1 string Name of the publisher (organization or individual)
Library.contact This element must be supported. 1..* ContactDetail Contact details for the publisher
Library.Slices for useContext This element must be supported. 0..* UsageContext The context that the content is intended to support
Slice: Unordered, Open by value:code

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Library.Slices for useContext.useContext:intendedVenue This element must be supported. 0..* UsageContext What venue?
Library.Slices for useContext.useContext:intendedVenue.code This element must be supported. 1..1 Coding Type of context being specified
Required Pattern: 
{
  "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type",
  "code" : "venue"
}
Library.Slices for useContext.useContext:intendedVenue.value[x] This element must be supported. 1..1 CodeableConcept Value that defines the context
Binding: IntendedVenue (4.0.0) (extensible)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Library.useContext:intendedVenue.​value[x] Base extensible Intended Venue 📍4.0.0 This IG

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Library C 1..1 CRMIPublishableLibrary(2.0.0) Represents a library of quality improvement components
Constraints: lib-0, pub-1
Library.id This element is included in summaries. 0..1 id Logical id of this artifact
Library.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Library.meta.id 0..1 string Unique id for inter-element referencing
Library.meta.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
Library.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
Constraints: ext-1
Library.meta.versionId This element is included in summaries. 0..1 id Version specific identifier
Library.meta.lastUpdated This element is included in summaries. 0..1 instant When the resource version last changed
Library.meta.source This element is included in summaries. 0..1 uri Identifies where the resource comes from
Library.meta.profile This element is included in summaries. 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
Library.meta.security This element is included in summaries. 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Library.meta.tag This element is included in summaries. 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
Library.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Library.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Library.text This element must be supported. 1..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Library.contained 0..* Resource Contained, inline Resources
Library.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
Library.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
Constraints: ext-1
Library.Slices for extension.extension:logicDefinition This element must be supported. 0..* (Complex) A logic definition used in the artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
Constraints: ext-1
Library.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
Constraints: ext-1
Library.Slices for extension.extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
Constraints: ext-1
Library.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
Constraints: ext-1
Library.Slices for extension.extension:softwaresystem This element must be supported. 0..* Reference(CRMI Software System Device) Extension
URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-softwaresystem
Constraints: ext-1
Library.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
Library.url This element is included in summaries. 0..1 uri Canonical identifier for this library, represented as a URI (globally unique)
Library.Slices for identifier This element must be supported. This element is included in summaries. 0..* Identifier Additional identifier for the library
Slice: Unordered, Open by value:type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Library.Slices for identifier.identifier:versionIndependentIdentifier This element must be supported. This element is included in summaries. 0..1 Identifier Library guid
Library.Slices for identifier.identifier:versionIndependentIdentifier.id 0..1 string Unique id for inter-element referencing
Library.Slices for identifier.identifier:versionIndependentIdentifier.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
Library.Slices for identifier.identifier:versionIndependentIdentifier.use This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: official (no extensions allowed)
Library.Slices for identifier.identifier:versionIndependentIdentifier.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/artifact-identifier-type",
      "code" : "version-independent"
    }
  ]
}
Library.Slices for identifier.identifier:versionIndependentIdentifier.system This element must be supported. This element is included in summaries. 1..1 uri The namespace for the identifier value
Fixed Value: urn:ietf:rfc:3986 (no extensions allowed)
Library.Slices for identifier.identifier:versionIndependentIdentifier.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Library.Slices for identifier.identifier:versionIndependentIdentifier.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Library.Slices for identifier.identifier:versionIndependentIdentifier.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Library.Slices for identifier.identifier:versionSpecificIdentifier This element must be supported. This element is included in summaries. 0..1 Identifier Library version guid
Library.Slices for identifier.identifier:versionSpecificIdentifier.id 0..1 string Unique id for inter-element referencing
Library.Slices for identifier.identifier:versionSpecificIdentifier.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
Library.Slices for identifier.identifier:versionSpecificIdentifier.use This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: official (no extensions allowed)
Library.Slices for identifier.identifier:versionSpecificIdentifier.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/artifact-identifier-type",
      "code" : "version-specific"
    }
  ]
}
Library.Slices for identifier.identifier:versionSpecificIdentifier.system This element must be supported. This element is included in summaries. 1..1 uri The namespace for the identifier value
Fixed Value: urn:ietf:rfc:3986 (no extensions allowed)
Library.Slices for identifier.identifier:versionSpecificIdentifier.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Library.Slices for identifier.identifier:versionSpecificIdentifier.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Library.Slices for identifier.identifier:versionSpecificIdentifier.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Library.Slices for identifier.identifier:shortName This element must be supported. This element is included in summaries. 0..1 Identifier Short name
Library.Slices for identifier.identifier:shortName.id 0..1 string Unique id for inter-element referencing
Library.Slices for identifier.identifier:shortName.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
Library.Slices for identifier.identifier:shortName.use This element is a modifier element. This element must be supported. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: usual (no extensions allowed)
Library.Slices for identifier.identifier:shortName.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/artifact-identifier-type",
      "code" : "short-name"
    }
  ]
}
Library.Slices for identifier.identifier:shortName.system This element is included in summaries. 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Library.Slices for identifier.identifier:shortName.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Library.Slices for identifier.identifier:shortName.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Library.Slices for identifier.identifier:shortName.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Library.Slices for identifier.identifier:endorserIdentifier This element must be supported. This element is included in summaries. 0..* Identifier Endorser identifier
Library.Slices for identifier.identifier:endorserIdentifier.id 0..1 string Unique id for inter-element referencing
Library.Slices for identifier.identifier:endorserIdentifier.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
Library.Slices for identifier.identifier:endorserIdentifier.use This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: official (no extensions allowed)
Library.Slices for identifier.identifier:endorserIdentifier.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/artifact-identifier-type",
      "code" : "endorser"
    }
  ]
}
Library.Slices for identifier.identifier:endorserIdentifier.system This element must be supported. This element is included in summaries. 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Library.Slices for identifier.identifier:endorserIdentifier.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Library.Slices for identifier.identifier:endorserIdentifier.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Library.Slices for identifier.identifier:endorserIdentifier.assigner This element must be supported. This element is included in summaries. 1..1 Reference(Organization) Organization that issued id (may be just text)
Library.Slices for identifier.identifier:endorserIdentifier.assigner.id 0..1 string Unique id for inter-element referencing
Library.Slices for identifier.identifier:endorserIdentifier.assigner.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
Library.Slices for identifier.identifier:endorserIdentifier.assigner.reference This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
Library.Slices for identifier.identifier:endorserIdentifier.assigner.type This element is included in summaries. 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Library.Slices for identifier.identifier:endorserIdentifier.assigner.identifier This element is included in summaries. 0..1 Identifier Logical reference, when literal reference is not known
Library.Slices for identifier.identifier:endorserIdentifier.assigner.display This element must be supported. This element is included in summaries. 1..1 string Text alternative for the resource
Library.Slices for identifier.identifier:publisherIdentifier This element must be supported. This element is included in summaries. 0..* Identifier Publisher identifier
Library.Slices for identifier.identifier:publisherIdentifier.id 0..1 string Unique id for inter-element referencing
Library.Slices for identifier.identifier:publisherIdentifier.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
Library.Slices for identifier.identifier:publisherIdentifier.use This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: official (no extensions allowed)
Library.Slices for identifier.identifier:publisherIdentifier.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/artifact-identifier-type",
      "code" : "publisher"
    }
  ]
}
Library.Slices for identifier.identifier:publisherIdentifier.system This element must be supported. This element is included in summaries. 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Library.Slices for identifier.identifier:publisherIdentifier.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Library.Slices for identifier.identifier:publisherIdentifier.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Library.Slices for identifier.identifier:publisherIdentifier.assigner This element must be supported. This element is included in summaries. 1..1 Reference(Organization) Organization that issued id (may be just text)
Library.Slices for identifier.identifier:publisherIdentifier.assigner.id 0..1 string Unique id for inter-element referencing
Library.Slices for identifier.identifier:publisherIdentifier.assigner.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
Library.Slices for identifier.identifier:publisherIdentifier.assigner.reference This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
Library.Slices for identifier.identifier:publisherIdentifier.assigner.type This element is included in summaries. 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Library.Slices for identifier.identifier:publisherIdentifier.assigner.identifier This element is included in summaries. 0..1 Identifier Logical reference, when literal reference is not known
Library.Slices for identifier.identifier:publisherIdentifier.assigner.display This element must be supported. This element is included in summaries. 1..1 string Text alternative for the resource
Library.version This element is included in summaries. 0..1 string Business version of the library
Library.name This element is included in summaries. C 0..1 string Name for this library (computer friendly)
Library.title This element must be supported. This element is included in summaries. 1..1 string Name for this library (human friendly)
Library.subtitle 0..1 string Subordinate title of the library
Library.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
Library.experimental This element is included in summaries. 0..1 boolean For testing purposes, not real usage
Library.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept logic-library | model-definition | asset-collection | module-definition
Binding: LibraryType (extensible): The type of knowledge asset this library contains.
Library.subject[x] 0..1 Type 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.).
Library.subject[x].subjectCodeableConcept CodeableConcept
Library.subject[x].subjectReference Reference(Group)
Library.date This element must be supported. This element is included in summaries. 1..1 dateTime Date last changed
Library.publisher This element must be supported. This element is included in summaries. 1..1 string Name of the publisher (organization or individual)
Library.contact This element must be supported. This element is included in summaries. 1..* ContactDetail Contact details for the publisher
Library.description This element is included in summaries. 0..1 markdown Natural language description of the library
Library.Slices for useContext This element must be supported. This element is included in summaries. 0..* UsageContext The context that the content is intended to support
Slice: Unordered, Open by value:code

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Library.Slices for useContext.useContext:intendedVenue This element must be supported. This element is included in summaries. 0..* UsageContext What venue?
Library.Slices for useContext.useContext:intendedVenue.id 0..1 string Unique id for inter-element referencing
Library.Slices for useContext.useContext:intendedVenue.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
Library.Slices for useContext.useContext:intendedVenue.code This element must be supported. This element is included in summaries. 1..1 Coding Type of context being specified
Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context.
Required Pattern: 
{
  "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type",
  "code" : "venue"
}
Library.Slices for useContext.useContext:intendedVenue.value[x] This element must be supported. This element is included in summaries. 1..1 CodeableConcept Value that defines the context
Binding: IntendedVenue (4.0.0) (extensible)
Library.jurisdiction This element must be supported. This element is included in summaries. 0..* CodeableConcept Intended jurisdiction for library (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
Library.purpose This element must be supported. 0..1 markdown Why this library is defined
Library.usage This element must be supported. 0..1 string Describes the clinical usage of the library
Library.copyright This element must be supported. 0..1 markdown Use and/or publishing restrictions
Library.approvalDate This element must be supported. 0..1 date When the library was approved by publisher
Library.lastReviewDate This element must be supported. 0..1 date When the library was last reviewed
Library.effectivePeriod This element must be supported. This element is included in summaries. 0..1 Period When the library is expected to be used
Library.topic This element must be supported. 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.
Library.author This element must be supported. 0..* ContactDetail Who authored the content
Library.editor This element must be supported. 0..* ContactDetail Who edited the content
Library.reviewer This element must be supported. 0..* ContactDetail Who reviewed the content
Library.endorser This element must be supported. 0..* ContactDetail Who endorsed the content
Library.relatedArtifact This element must be supported. 0..* RelatedArtifact Additional documentation, citations, etc.
Library.relatedArtifact.id 0..1 string Unique id for inter-element referencing
Library.relatedArtifact.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
Library.relatedArtifact.Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
Constraints: ext-1
Library.relatedArtifact.Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
Constraints: ext-1
Library.relatedArtifact.type This element is included in summaries. 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
Library.relatedArtifact.label This element is included in summaries. 0..1 string Short label
Library.relatedArtifact.display This element must be supported. This element is included in summaries. 0..1 string Brief description of the related artifact
Library.relatedArtifact.citation This element is included in summaries. 0..1 markdown Bibliographic citation for the artifact
Library.relatedArtifact.url This element is included in summaries. 0..1 url Where the artifact can be accessed
Library.relatedArtifact.document This element must be supported. This element is included in summaries. 0..1 Attachment What document is being referenced
Library.relatedArtifact.resource This element must be supported. This element is included in summaries. 0..1 canonical(Resource) What resource is being referenced
Library.parameter 0..* ParameterDefinition Parameters defined by the library
Library.dataRequirement 0..* DataRequirement What data is referenced by this library
Library.content This element is included in summaries. 0..* Attachment Contents of the library, either embedded or referenced

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Library.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Library.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Library.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Library.identifier:versionIndependentIdentifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Library.identifier:versionIndependentIdentifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Library.identifier:versionSpecificIdentifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Library.identifier:versionSpecificIdentifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Library.identifier:shortName.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Library.identifier:shortName.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Library.identifier:endorserIdentifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Library.identifier:endorserIdentifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Library.identifier:endorserIdentifier.​assigner.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Library.identifier:publisherIdentifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Library.identifier:publisherIdentifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Library.identifier:publisherIdentifier.​assigner.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Library.status Base required PublicationStatus 📍4.0.1 FHIR Std.
Library.type Base extensible LibraryType 📍4.0.1 FHIR Std.
Library.subject[x] Base extensible Subject type 📍4.0.1 FHIR Std.
Library.useContext:intendedVenue.​code Base extensible UsageContextType 📍4.0.1 FHIR Std.
Library.useContext:intendedVenue.​value[x] Base extensible Intended Venue 📍4.0.0 This IG
Library.jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.
Library.topic Base example DefinitionTopic 📍4.0.1 FHIR Std.
Library.relatedArtifact.​type Base required RelatedArtifactType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Library If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Library 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 error Library 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 error Library If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Library A resource should have narrative for robust management text.`div`.exists()
ele-1 error Library.meta, Library.meta.extension, Library.meta.extension:packageSource, Library.meta.versionId, Library.meta.lastUpdated, Library.meta.source, Library.meta.profile, Library.meta.security, Library.meta.tag, Library.implicitRules, Library.language, Library.text, Library.extension, Library.extension:knowledgeCapability, Library.extension:logicDefinition, Library.extension:copyrightLabel, Library.extension:artifactComment, Library.extension:authoritativeSource, Library.extension:softwaresystem, Library.modifierExtension, Library.url, Library.identifier, Library.identifier:versionIndependentIdentifier, Library.identifier:versionIndependentIdentifier.extension, Library.identifier:versionIndependentIdentifier.use, Library.identifier:versionIndependentIdentifier.type, Library.identifier:versionIndependentIdentifier.system, Library.identifier:versionIndependentIdentifier.value, Library.identifier:versionIndependentIdentifier.period, Library.identifier:versionIndependentIdentifier.assigner, Library.identifier:versionSpecificIdentifier, Library.identifier:versionSpecificIdentifier.extension, Library.identifier:versionSpecificIdentifier.use, Library.identifier:versionSpecificIdentifier.type, Library.identifier:versionSpecificIdentifier.system, Library.identifier:versionSpecificIdentifier.value, Library.identifier:versionSpecificIdentifier.period, Library.identifier:versionSpecificIdentifier.assigner, Library.identifier:shortName, Library.identifier:shortName.extension, Library.identifier:shortName.use, Library.identifier:shortName.type, Library.identifier:shortName.system, Library.identifier:shortName.value, Library.identifier:shortName.period, Library.identifier:shortName.assigner, Library.identifier:endorserIdentifier, Library.identifier:endorserIdentifier.extension, Library.identifier:endorserIdentifier.use, Library.identifier:endorserIdentifier.type, Library.identifier:endorserIdentifier.system, Library.identifier:endorserIdentifier.value, Library.identifier:endorserIdentifier.period, Library.identifier:endorserIdentifier.assigner, Library.identifier:endorserIdentifier.assigner.extension, Library.identifier:endorserIdentifier.assigner.reference, Library.identifier:endorserIdentifier.assigner.type, Library.identifier:endorserIdentifier.assigner.identifier, Library.identifier:endorserIdentifier.assigner.display, Library.identifier:publisherIdentifier, Library.identifier:publisherIdentifier.extension, Library.identifier:publisherIdentifier.use, Library.identifier:publisherIdentifier.type, Library.identifier:publisherIdentifier.system, Library.identifier:publisherIdentifier.value, Library.identifier:publisherIdentifier.period, Library.identifier:publisherIdentifier.assigner, Library.identifier:publisherIdentifier.assigner.extension, Library.identifier:publisherIdentifier.assigner.reference, Library.identifier:publisherIdentifier.assigner.type, Library.identifier:publisherIdentifier.assigner.identifier, Library.identifier:publisherIdentifier.assigner.display, Library.version, Library.name, Library.title, Library.subtitle, Library.status, Library.experimental, Library.type, Library.subject[x], Library.date, Library.publisher, Library.contact, Library.description, Library.useContext, Library.useContext:intendedVenue, Library.useContext:intendedVenue.extension, Library.useContext:intendedVenue.code, Library.useContext:intendedVenue.value[x], Library.jurisdiction, Library.purpose, Library.usage, Library.copyright, Library.approvalDate, Library.lastReviewDate, Library.effectivePeriod, Library.topic, Library.author, Library.editor, Library.reviewer, Library.endorser, Library.relatedArtifact, Library.relatedArtifact.extension, Library.relatedArtifact.extension:publicationDate, Library.relatedArtifact.extension:publicationStatus, Library.relatedArtifact.type, Library.relatedArtifact.label, Library.relatedArtifact.display, Library.relatedArtifact.citation, Library.relatedArtifact.url, Library.relatedArtifact.document, Library.relatedArtifact.resource, Library.parameter, Library.dataRequirement, Library.content All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Library.meta.extension, Library.meta.extension:packageSource, Library.extension, Library.extension:knowledgeCapability, Library.extension:logicDefinition, Library.extension:copyrightLabel, Library.extension:artifactComment, Library.extension:authoritativeSource, Library.extension:softwaresystem, Library.modifierExtension, Library.identifier:versionIndependentIdentifier.extension, Library.identifier:versionSpecificIdentifier.extension, Library.identifier:shortName.extension, Library.identifier:endorserIdentifier.extension, Library.identifier:endorserIdentifier.assigner.extension, Library.identifier:publisherIdentifier.extension, Library.identifier:publisherIdentifier.assigner.extension, Library.useContext:intendedVenue.extension, Library.relatedArtifact.extension, Library.relatedArtifact.extension:publicationDate, Library.relatedArtifact.extension:publicationStatus Must have either extensions or value[x], not both extension.exists() != value.exists()
lib-0 warning Library 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}')
pub-1 error Library If knowledge capabilities are stated, they SHALL include publishable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()

This structure is derived from CRMIPublishableLibrary

Summary

Mandatory: 4 elements(22 nested mandatory elements)
Must-Support: 38 elements
Fixed: 7 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Library.identifier
  • The element 1 is sliced based on the value of Library.useContext

Maturity: 4

 

Other representations of profile: CSV, Excel, Schematron