This page is part of the Clinical Guidelines (v1.0.0: STU 1) based on FHIR R4. This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
The official URL for this profile is:
http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-publishablelibrary
The publishable library defines the must support elements that are important for implementers to use and understand a library
This profile builds on CPGShareableLibrary.
This profile was published on Thu Jun 06 00:00:00 UTC 2019 as a draft by Health Level Seven, Inc. - CDS WG.
Description of Profiles, Differentials, and Snapshots.
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Library | 1..1 | CPGShareableLibrary | Represents a library of quality improvement components | |
title | S | 1..1 | string | Name for this library (human friendly) |
type | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection | module-definition | |
date | S | 1..1 | dateTime | Date last changed |
purpose | 0..1 | markdown | Why this library is defined | |
usage | 0..1 | string | Describes the clinical usage of the library | |
copyright | S | 0..1 | markdown | Use and/or publishing restrictions |
approvalDate | S | 0..1 | date | When the library was approved by publisher |
lastReviewDate | S | 0..1 | date | When the library was last reviewed |
effectivePeriod | S | 0..1 | Period | When the library is expected to be used |
topic | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. Binding: DefinitionTopic (preferred): Topics for categorization and searching of artifacts | |
author | 0..* | ContactDetail | Who authored the content | |
editor | 0..* | ContactDetail | Who edited the content | |
reviewer | 0..* | ContactDetail | Who reviewed the content | |
endorser | 0..* | ContactDetail | Who endorsed the content | |
relatedArtifact | S | 0..* | RelatedArtifact | Additional documentation, citations, etc. |
display | S | 0..1 | string | Brief description of the related artifact |
url | S | 0..1 | url | Where the artifact can be accessed |
resource | S | 0..1 | canonical(Resource) | What resource is being referenced |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Library | I | 1..1 | CPGShareableLibrary | Represents a library of quality improvement components |
id | Σ | 0..1 | string | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
cpg-knowledgeCapability | S | 1..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-knowledgeCapability Binding: CPG Knowledge Capability (required): A knowledge capability provided by a knowledge artifact |
cpg-knowledgeRepresentationLevel | S | 0..* | code | narrative | semi-structured | structured | executable URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-knowledgeRepresentationLevel Binding: CPG Knowledge Representation Level (required): A level of knowledge representation provided by this artifact |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
url | Σ | 1..1 | uri | Canonical identifier for this library, represented as a URI (globally unique) |
identifier | SΣ | 0..* | Identifier | Additional identifier for the library |
version | Σ | 1..1 | string | Business version of the library |
name | ΣI | 1..1 | string | Name for this library (computer friendly) |
title | SΣ | 1..1 | string | Name for this library (human friendly) |
subtitle | 0..1 | string | Subordinate title of the library | |
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
experimental | Σ | 1..1 | boolean | For testing purposes, not real usage |
type | Σ | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection | module-definition Binding: LibraryType (extensible): The type of knowledge asset this library contains. |
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.). | ||
subjectCodeableConcept | CodeableConcept | |||
subjectReference | Reference(Group) | |||
date | SΣ | 1..1 | dateTime | Date last changed |
publisher | Σ | 1..1 | string | Name of the publisher (organization or individual) |
contact | SΣ | 0..* | ContactDetail | Contact details for the publisher |
description | Σ | 1..1 | markdown | Natural language description of the library |
useContext | SΣ | 0..* | UsageContext | The context that the content is intended to support |
jurisdiction | SΣ | 0..* | CodeableConcept | Intended jurisdiction for library (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. |
purpose | 0..1 | markdown | Why this library is defined | |
usage | 0..1 | string | Describes the clinical usage of the library | |
copyright | S | 0..1 | markdown | Use and/or publishing restrictions |
approvalDate | S | 0..1 | date | When the library was approved by publisher |
lastReviewDate | S | 0..1 | date | When the library was last reviewed |
effectivePeriod | SΣ | 0..1 | Period | When the library is expected to be used |
topic | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. Binding: DefinitionTopic (preferred): Topics for categorization and searching of artifacts | |
author | 0..* | ContactDetail | Who authored the content | |
editor | 0..* | ContactDetail | Who edited the content | |
reviewer | 0..* | ContactDetail | Who reviewed the content | |
endorser | 0..* | ContactDetail | Who endorsed the content | |
relatedArtifact | S | 0..* | RelatedArtifact | Additional documentation, citations, etc. |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
type | Σ | 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. |
label | Σ | 0..1 | string | Short label |
display | SΣ | 0..1 | string | Brief description of the related artifact |
citation | Σ | 0..1 | markdown | Bibliographic citation for the artifact |
url | SΣ | 0..1 | url | Where the artifact can be accessed |
document | Σ | 0..1 | Attachment | What document is being referenced |
resource | SΣ | 0..1 | canonical(Resource) | What resource is being referenced |
parameter | 0..* | ParameterDefinition | Parameters defined by the library | |
dataRequirement | 0..* | DataRequirement | What data is referenced by this library | |
content | Σ | 0..* | Attachment | Contents of the library, either embedded or referenced |
Documentation for this format |
Differential View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Library | 1..1 | CPGShareableLibrary | Represents a library of quality improvement components | |
title | S | 1..1 | string | Name for this library (human friendly) |
type | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection | module-definition | |
date | S | 1..1 | dateTime | Date last changed |
purpose | 0..1 | markdown | Why this library is defined | |
usage | 0..1 | string | Describes the clinical usage of the library | |
copyright | S | 0..1 | markdown | Use and/or publishing restrictions |
approvalDate | S | 0..1 | date | When the library was approved by publisher |
lastReviewDate | S | 0..1 | date | When the library was last reviewed |
effectivePeriod | S | 0..1 | Period | When the library is expected to be used |
topic | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. Binding: DefinitionTopic (preferred): Topics for categorization and searching of artifacts | |
author | 0..* | ContactDetail | Who authored the content | |
editor | 0..* | ContactDetail | Who edited the content | |
reviewer | 0..* | ContactDetail | Who reviewed the content | |
endorser | 0..* | ContactDetail | Who endorsed the content | |
relatedArtifact | S | 0..* | RelatedArtifact | Additional documentation, citations, etc. |
display | S | 0..1 | string | Brief description of the related artifact |
url | S | 0..1 | url | Where the artifact can be accessed |
resource | S | 0..1 | canonical(Resource) | What resource is being referenced |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Library | I | 1..1 | CPGShareableLibrary | Represents a library of quality improvement components |
id | Σ | 0..1 | string | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
cpg-knowledgeCapability | S | 1..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-knowledgeCapability Binding: CPG Knowledge Capability (required): A knowledge capability provided by a knowledge artifact |
cpg-knowledgeRepresentationLevel | S | 0..* | code | narrative | semi-structured | structured | executable URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-knowledgeRepresentationLevel Binding: CPG Knowledge Representation Level (required): A level of knowledge representation provided by this artifact |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
url | Σ | 1..1 | uri | Canonical identifier for this library, represented as a URI (globally unique) |
identifier | SΣ | 0..* | Identifier | Additional identifier for the library |
version | Σ | 1..1 | string | Business version of the library |
name | ΣI | 1..1 | string | Name for this library (computer friendly) |
title | SΣ | 1..1 | string | Name for this library (human friendly) |
subtitle | 0..1 | string | Subordinate title of the library | |
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
experimental | Σ | 1..1 | boolean | For testing purposes, not real usage |
type | Σ | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection | module-definition Binding: LibraryType (extensible): The type of knowledge asset this library contains. |
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.). | ||
subjectCodeableConcept | CodeableConcept | |||
subjectReference | Reference(Group) | |||
date | SΣ | 1..1 | dateTime | Date last changed |
publisher | Σ | 1..1 | string | Name of the publisher (organization or individual) |
contact | SΣ | 0..* | ContactDetail | Contact details for the publisher |
description | Σ | 1..1 | markdown | Natural language description of the library |
useContext | SΣ | 0..* | UsageContext | The context that the content is intended to support |
jurisdiction | SΣ | 0..* | CodeableConcept | Intended jurisdiction for library (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. |
purpose | 0..1 | markdown | Why this library is defined | |
usage | 0..1 | string | Describes the clinical usage of the library | |
copyright | S | 0..1 | markdown | Use and/or publishing restrictions |
approvalDate | S | 0..1 | date | When the library was approved by publisher |
lastReviewDate | S | 0..1 | date | When the library was last reviewed |
effectivePeriod | SΣ | 0..1 | Period | When the library is expected to be used |
topic | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. Binding: DefinitionTopic (preferred): Topics for categorization and searching of artifacts | |
author | 0..* | ContactDetail | Who authored the content | |
editor | 0..* | ContactDetail | Who edited the content | |
reviewer | 0..* | ContactDetail | Who reviewed the content | |
endorser | 0..* | ContactDetail | Who endorsed the content | |
relatedArtifact | S | 0..* | RelatedArtifact | Additional documentation, citations, etc. |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
type | Σ | 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. |
label | Σ | 0..1 | string | Short label |
display | SΣ | 0..1 | string | Brief description of the related artifact |
citation | Σ | 0..1 | markdown | Bibliographic citation for the artifact |
url | SΣ | 0..1 | url | Where the artifact can be accessed |
document | Σ | 0..1 | Attachment | What document is being referenced |
resource | SΣ | 0..1 | canonical(Resource) | What resource is being referenced |
parameter | 0..* | ParameterDefinition | Parameters defined by the library | |
dataRequirement | 0..* | DataRequirement | What data is referenced by this library | |
content | Σ | 0..* | Attachment | Contents of the library, either embedded or referenced |
Documentation for this format |
Path | Conformance | ValueSet |
Library.language | preferred | CommonLanguages Max Binding: AllLanguages |
Library.status | required | PublicationStatus |
Library.type | extensible | LibraryType |
Library.subject[x] | extensible | SubjectType |
Library.jurisdiction | extensible | Jurisdiction ValueSet |
Library.topic | preferred | DefinitionTopic |
Library.relatedArtifact.type | required | RelatedArtifactType |
Id | Path | Details | Requirements |
dom-2 | Library | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | 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 | 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 | Library | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | Library | A resource should have narrative for robust management : text.`div`.exists() | |
lib-0 | 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}') | |
ele-1 | Library.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Library.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Library.extension:knowledgeCapability | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Library.extension:knowledgeCapability | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Library.extension:knowledgeRepresentationLevel | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Library.extension:knowledgeRepresentationLevel | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Library.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Library.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Library.url | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.version | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.name | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.title | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.subtitle | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.experimental | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.subject[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.date | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.publisher | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.contact | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.description | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.useContext | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.jurisdiction | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.purpose | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.usage | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.copyright | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.approvalDate | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.lastReviewDate | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.effectivePeriod | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.topic | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.author | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.editor | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.reviewer | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.endorser | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.relatedArtifact | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.relatedArtifact.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Library.relatedArtifact.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Library.relatedArtifact.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.relatedArtifact.label | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.relatedArtifact.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.relatedArtifact.citation | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.relatedArtifact.url | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.relatedArtifact.document | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.relatedArtifact.resource | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.parameter | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.dataRequirement | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.content | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |