Canonical Resource Management Infrastructure Implementation Guide
1.0.0-ballot - Ballot International flag

This page is part of the Canonical Resource Management Infrastructure Implementation Guide (v1.0.0-ballot: STU1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

Resource Profile: CRMI Publishable Library

Official URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-publishablelibrary Version: 1.0.0-ballot
Standards status: Trial-use Maturity Level: 3 Computable Name: CRMIPublishableLibrary

Supports declaration of the library metadata required by HL7 and other organizations that share and publish libraries with a focus on the aspects of that metadata that are important for post-publication activities including distribution, inclusion in repositories, consumption, and implementation.

Usage:

Formal Views of Profile Content

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

This structure is derived from CRMIShareableLibrary

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library 1..1CRMIShareableLibraryRepresents a library of quality improvement components
... logicDefinition S0..*(Complex)A logic definition used in the artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
... copyrightLabel S0..1stringCopyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
... identifier S0..*IdentifierAdditional identifier for the library
... date S1..1dateTimeDate last changed
... contact S0..*ContactDetailContact details for the publisher
... useContext S0..*UsageContextThe context that the content is intended to support
... jurisdiction S0..*CodeableConceptIntended jurisdiction for library (if applicable)
... purpose S0..1markdownWhy this library is defined
... usage S0..1stringDescribes the clinical usage of the library
... copyright S0..1markdownUse and/or publishing restrictions
... approvalDate S0..1dateWhen the library was approved by publisher
... lastReviewDate S0..1dateWhen the library was last reviewed
... effectivePeriod S0..1PeriodWhen the library is expected to be used
... topic S0..*CodeableConceptE.g. Education, Treatment, Assessment, etc.
... author S0..*ContactDetailWho authored the content
... editor S0..*ContactDetailWho edited the content
... reviewer S0..*ContactDetailWho reviewed the content
... endorser S0..*ContactDetailWho endorsed the content
... relatedArtifact S0..*RelatedArtifactAdditional documentation, citations, etc.
.... display S0..1stringBrief description of the related artifact
.... document S0..1AttachmentWhat document is being referenced
.... resource S0..1canonical(Resource)What resource is being referenced

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Library C1..1CRMIShareableLibraryRepresents a library of quality improvement components
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... knowledgeCapability S0..*codeshareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapabilityValues (required)
... knowledgeRepresentationLevel S0..*codenarrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel
Binding: KnowledgeRepresentationLevelValues (required)
... artifactComment S0..*(Complex)Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
... versionAlgorithm S0..1string, CodingHow to compare versions
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: VersionAlgorithm (extensible): The algorithm used to compare versions for the artifact


... versionPolicy S0..1Codingmetadata | strict
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy
Binding: Artifact Version Policy Values (extensible): The versioning policy of the artifact


... logicDefinition S0..*(Complex)A logic definition used in the artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
... copyrightLabel S0..1stringCopyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url SΣ1..1uriCanonical identifier for this library, represented as a URI (globally unique)
... identifier SΣ0..*IdentifierAdditional identifier for the library
... version SΣ1..1stringBusiness version of the library
... name SΣC0..1stringName for this library (computer friendly)
... title SΣ1..1stringName for this library (human friendly)
... status ?!SΣ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

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

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


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


... author S0..*ContactDetailWho authored the content
... editor S0..*ContactDetailWho edited the content
... reviewer S0..*ContactDetailWho reviewed the content
... endorser S0..*ContactDetailWho endorsed the content
... relatedArtifact S0..*RelatedArtifactAdditional documentation, citations, etc.
.... type Σ1..1codedocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.

.... display SΣ0..1stringBrief description of the related artifact
.... document SΣ0..1AttachmentWhat document is being referenced
.... resource SΣ0..1canonical(Resource)What resource is being referenced

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Library.statusrequiredPublicationStatus
Library.typeextensibleLibraryType
Library.jurisdictionextensibleJurisdiction ValueSet
Library.topicexampleDefinitionTopic
Library.relatedArtifact.typerequiredRelatedArtifactType

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorLibraryIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorLibraryIf 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-4errorLibraryIf 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-5errorLibraryIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceLibraryA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
lib-0warningLibraryName 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}')
NameFlagsCard.TypeDescription & Constraintsdoco
.. Library C1..1CRMIShareableLibraryRepresents a library of quality improvement components
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... knowledgeCapability S0..*codeshareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapabilityValues (required)
... knowledgeRepresentationLevel S0..*codenarrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel
Binding: KnowledgeRepresentationLevelValues (required)
... artifactComment S0..*(Complex)Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
... versionAlgorithm S0..1string, CodingHow to compare versions
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: VersionAlgorithm (extensible): The algorithm used to compare versions for the artifact


... versionPolicy S0..1Codingmetadata | strict
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy
Binding: Artifact Version Policy Values (extensible): The versioning policy of the artifact


... logicDefinition S0..*(Complex)A logic definition used in the artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
... copyrightLabel S0..1stringCopyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url SΣ1..1uriCanonical identifier for this library, represented as a URI (globally unique)
... identifier SΣ0..*IdentifierAdditional identifier for the library
... version SΣ1..1stringBusiness version of the library
... name SΣC0..1stringName for this library (computer friendly)
... title SΣ1..1stringName for this library (human friendly)
... subtitle 0..1stringSubordinate title of the library
... status ?!SΣ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

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

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

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


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


... author S0..*ContactDetailWho authored the content
... editor S0..*ContactDetailWho edited the content
... reviewer S0..*ContactDetailWho reviewed the content
... endorser S0..*ContactDetailWho endorsed the content
... relatedArtifact S0..*RelatedArtifactAdditional documentation, citations, etc.
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... type Σ1..1codedocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.

.... label Σ0..1stringShort label
.... display SΣ0..1stringBrief description of the related artifact
.... citation Σ0..1markdownBibliographic citation for the artifact
.... url Σ0..1urlWhere the artifact can be accessed
.... document SΣ0..1AttachmentWhat document is being referenced
.... resource SΣ0..1canonical(Resource)What resource is being referenced
... parameter 0..*ParameterDefinitionParameters defined by the library
... dataRequirement 0..*DataRequirementWhat data is referenced by this library
... content Σ0..*AttachmentContents of the library, either embedded or referenced

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Library.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Library.statusrequiredPublicationStatus
Library.typeextensibleLibraryType
Library.subject[x]extensibleSubjectType
Library.jurisdictionextensibleJurisdiction ValueSet
Library.topicexampleDefinitionTopic
Library.relatedArtifact.typerequiredRelatedArtifactType

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from CRMIShareableLibrary

Summary

Mandatory: 2 elements
Must-Support: 23 elements

Extensions

This structure refers to these extensions:

Maturity: 3

Differential View

This structure is derived from CRMIShareableLibrary

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library 1..1CRMIShareableLibraryRepresents a library of quality improvement components
... logicDefinition S0..*(Complex)A logic definition used in the artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
... copyrightLabel S0..1stringCopyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
... identifier S0..*IdentifierAdditional identifier for the library
... date S1..1dateTimeDate last changed
... contact S0..*ContactDetailContact details for the publisher
... useContext S0..*UsageContextThe context that the content is intended to support
... jurisdiction S0..*CodeableConceptIntended jurisdiction for library (if applicable)
... purpose S0..1markdownWhy this library is defined
... usage S0..1stringDescribes the clinical usage of the library
... copyright S0..1markdownUse and/or publishing restrictions
... approvalDate S0..1dateWhen the library was approved by publisher
... lastReviewDate S0..1dateWhen the library was last reviewed
... effectivePeriod S0..1PeriodWhen the library is expected to be used
... topic S0..*CodeableConceptE.g. Education, Treatment, Assessment, etc.
... author S0..*ContactDetailWho authored the content
... editor S0..*ContactDetailWho edited the content
... reviewer S0..*ContactDetailWho reviewed the content
... endorser S0..*ContactDetailWho endorsed the content
... relatedArtifact S0..*RelatedArtifactAdditional documentation, citations, etc.
.... display S0..1stringBrief description of the related artifact
.... document S0..1AttachmentWhat document is being referenced
.... resource S0..1canonical(Resource)What resource is being referenced

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library C1..1CRMIShareableLibraryRepresents a library of quality improvement components
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... knowledgeCapability S0..*codeshareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapabilityValues (required)
... knowledgeRepresentationLevel S0..*codenarrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel
Binding: KnowledgeRepresentationLevelValues (required)
... artifactComment S0..*(Complex)Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
... versionAlgorithm S0..1string, CodingHow to compare versions
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: VersionAlgorithm (extensible): The algorithm used to compare versions for the artifact


... versionPolicy S0..1Codingmetadata | strict
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy
Binding: Artifact Version Policy Values (extensible): The versioning policy of the artifact


... logicDefinition S0..*(Complex)A logic definition used in the artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
... copyrightLabel S0..1stringCopyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url SΣ1..1uriCanonical identifier for this library, represented as a URI (globally unique)
... identifier SΣ0..*IdentifierAdditional identifier for the library
... version SΣ1..1stringBusiness version of the library
... name SΣC0..1stringName for this library (computer friendly)
... title SΣ1..1stringName for this library (human friendly)
... status ?!SΣ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

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

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


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


... author S0..*ContactDetailWho authored the content
... editor S0..*ContactDetailWho edited the content
... reviewer S0..*ContactDetailWho reviewed the content
... endorser S0..*ContactDetailWho endorsed the content
... relatedArtifact S0..*RelatedArtifactAdditional documentation, citations, etc.
.... type Σ1..1codedocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.

.... display SΣ0..1stringBrief description of the related artifact
.... document SΣ0..1AttachmentWhat document is being referenced
.... resource SΣ0..1canonical(Resource)What resource is being referenced

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Library.statusrequiredPublicationStatus
Library.typeextensibleLibraryType
Library.jurisdictionextensibleJurisdiction ValueSet
Library.topicexampleDefinitionTopic
Library.relatedArtifact.typerequiredRelatedArtifactType

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorLibraryIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorLibraryIf 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-4errorLibraryIf 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-5errorLibraryIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceLibraryA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
lib-0warningLibraryName 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}')

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library C1..1CRMIShareableLibraryRepresents a library of quality improvement components
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... knowledgeCapability S0..*codeshareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapabilityValues (required)
... knowledgeRepresentationLevel S0..*codenarrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel
Binding: KnowledgeRepresentationLevelValues (required)
... artifactComment S0..*(Complex)Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
... versionAlgorithm S0..1string, CodingHow to compare versions
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: VersionAlgorithm (extensible): The algorithm used to compare versions for the artifact


... versionPolicy S0..1Codingmetadata | strict
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy
Binding: Artifact Version Policy Values (extensible): The versioning policy of the artifact


... logicDefinition S0..*(Complex)A logic definition used in the artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
... copyrightLabel S0..1stringCopyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url SΣ1..1uriCanonical identifier for this library, represented as a URI (globally unique)
... identifier SΣ0..*IdentifierAdditional identifier for the library
... version SΣ1..1stringBusiness version of the library
... name SΣC0..1stringName for this library (computer friendly)
... title SΣ1..1stringName for this library (human friendly)
... subtitle 0..1stringSubordinate title of the library
... status ?!SΣ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

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

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

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


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


... author S0..*ContactDetailWho authored the content
... editor S0..*ContactDetailWho edited the content
... reviewer S0..*ContactDetailWho reviewed the content
... endorser S0..*ContactDetailWho endorsed the content
... relatedArtifact S0..*RelatedArtifactAdditional documentation, citations, etc.
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... type Σ1..1codedocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.

.... label Σ0..1stringShort label
.... display SΣ0..1stringBrief description of the related artifact
.... citation Σ0..1markdownBibliographic citation for the artifact
.... url Σ0..1urlWhere the artifact can be accessed
.... document SΣ0..1AttachmentWhat document is being referenced
.... resource SΣ0..1canonical(Resource)What resource is being referenced
... parameter 0..*ParameterDefinitionParameters defined by the library
... dataRequirement 0..*DataRequirementWhat data is referenced by this library
... content Σ0..*AttachmentContents of the library, either embedded or referenced

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Library.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Library.statusrequiredPublicationStatus
Library.typeextensibleLibraryType
Library.subject[x]extensibleSubjectType
Library.jurisdictionextensibleJurisdiction ValueSet
Library.topicexampleDefinitionTopic
Library.relatedArtifact.typerequiredRelatedArtifactType

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from CRMIShareableLibrary

Summary

Mandatory: 2 elements
Must-Support: 23 elements

Extensions

This structure refers to these extensions:

Maturity: 3

 

Other representations of profile: CSV, Excel, Schematron