FHIR for FAIR - FHIR Implementation Guide
1.0.0 - STU 1 International flag

This page is part of the FHIR for FAIR - FHIR Implementation Guide (v1.0.0: STU 1) based on FHIR v4.3.0. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: Library [Study Level Medatata]

Official URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/Library-uv-f4f Version: 1.0.0
Active as of 2022-09-28 Computable Name: LibraryF4F

This profile defines how to use the Library resource to convey metadata information for a FAIR dataset realized by using HL7 FHIR. An extension is used to allow to refer as

Usage:

Formal Views of Profile Content

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

This structure is derived from Library

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library 0..*LibraryRepresents a library of quality improvement components
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... licenceCodeable 0..1CodeableConceptLicence Terms as CodeableConcept
URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/licenceCodeable
... licenceAttachment 0..1AttachmentLicence Terms as Attachment
URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/licenceAttachment
... subjectOther 0..*Reference(Resource)Other Subjects [Resource]
URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/subjectOther
... classifier 0..*CodeableConceptClassifier [Resource]
URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/classifier
... url 0..1uriCanonical identifier for this library, represented as a URI (globally unique).
... name 0..1stringName for this library (computer friendly).
... title 0..1stringName for this library (human friendly).
... status 1..1codedraft | active | retired |unknown
... type 1..1CodeableConceptlogic-library | model-definition | asset-collection |module-definition
... subject[x] 0..1CodeableConcept, Reference(Group)Type of subject the library content is focused on
... purpose 0..1markdownWhy this library is defined.
... copyright 0..1markdownUse and/or publishing restrictions.
... relatedArtifact 0..*RelatedArtifactF4FRelated artifacts for a knowledge resource
... content
.... url 1..1urlUri where the data can be found

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Library C0..*LibraryRepresents 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): IETF language tag

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
... licenceCodeable 0..1CodeableConceptLicence Terms as CodeableConcept
URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/licenceCodeable
... licenceAttachment 0..1AttachmentLicence Terms as Attachment
URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/licenceAttachment
... relatedContent 0..*RelatedArtifactF4FContent as RelatedArtifact [Library]
URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/library-relatedContent
... subjectOther 0..*Reference(Resource)Other Subjects [Resource]
URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/subjectOther
... classifier 0..*CodeableConceptClassifier [Resource]
URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/classifier
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ0..1uriCanonical identifier for this library, represented as a URI (globally unique).
... identifier Σ0..*IdentifierAdditional identifier for the library
... version Σ0..1stringBusiness version of the library
... name ΣC0..1stringName for this library (computer friendly).
... title Σ0..1stringName for this library (human friendly).
... subtitle 0..1stringSubordinate title of the library
... status ?!Σ1..1codedraft | active | retired |unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

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

... subject[x] 0..1Type of subject 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 Σ0..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description Σ0..1markdownNatural language description of the library
... useContext Σ0..*UsageContextThe context that the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for library (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


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


... author 0..*ContactDetailWho authored the content
... editor 0..*ContactDetailWho edited the content
... reviewer 0..*ContactDetailWho reviewed the content
... endorser 0..*ContactDetailWho endorsed the content
... relatedArtifact 0..*RelatedArtifactF4FRelated artifacts for a knowledge resource
... 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
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... contentType Σ0..1codeMime type of the content, with charset etc.
Binding: Mime Types (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)


Example General: text/plain; charset=UTF-8, image/png
.... language Σ0..1codeHuman language of the content (BCP-47)
Binding: CommonLanguages (preferred): IETF language tag

Additional BindingsPurpose
AllLanguagesMax Binding

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

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Library C0..*LibraryRepresents a library of quality improvement components

doco Documentation for this format

Differential View

This structure is derived from Library

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library 0..*LibraryRepresents a library of quality improvement components
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... licenceCodeable 0..1CodeableConceptLicence Terms as CodeableConcept
URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/licenceCodeable
... licenceAttachment 0..1AttachmentLicence Terms as Attachment
URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/licenceAttachment
... subjectOther 0..*Reference(Resource)Other Subjects [Resource]
URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/subjectOther
... classifier 0..*CodeableConceptClassifier [Resource]
URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/classifier
... url 0..1uriCanonical identifier for this library, represented as a URI (globally unique).
... name 0..1stringName for this library (computer friendly).
... title 0..1stringName for this library (human friendly).
... status 1..1codedraft | active | retired |unknown
... type 1..1CodeableConceptlogic-library | model-definition | asset-collection |module-definition
... subject[x] 0..1CodeableConcept, Reference(Group)Type of subject the library content is focused on
... purpose 0..1markdownWhy this library is defined.
... copyright 0..1markdownUse and/or publishing restrictions.
... relatedArtifact 0..*RelatedArtifactF4FRelated artifacts for a knowledge resource
... content
.... url 1..1urlUri where the data can be found

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library C0..*LibraryRepresents 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): IETF language tag

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
... licenceCodeable 0..1CodeableConceptLicence Terms as CodeableConcept
URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/licenceCodeable
... licenceAttachment 0..1AttachmentLicence Terms as Attachment
URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/licenceAttachment
... relatedContent 0..*RelatedArtifactF4FContent as RelatedArtifact [Library]
URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/library-relatedContent
... subjectOther 0..*Reference(Resource)Other Subjects [Resource]
URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/subjectOther
... classifier 0..*CodeableConceptClassifier [Resource]
URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/classifier
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ0..1uriCanonical identifier for this library, represented as a URI (globally unique).
... identifier Σ0..*IdentifierAdditional identifier for the library
... version Σ0..1stringBusiness version of the library
... name ΣC0..1stringName for this library (computer friendly).
... title Σ0..1stringName for this library (human friendly).
... subtitle 0..1stringSubordinate title of the library
... status ?!Σ1..1codedraft | active | retired |unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

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

... subject[x] 0..1Type of subject 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 Σ0..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description Σ0..1markdownNatural language description of the library
... useContext Σ0..*UsageContextThe context that the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for library (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


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


... author 0..*ContactDetailWho authored the content
... editor 0..*ContactDetailWho edited the content
... reviewer 0..*ContactDetailWho reviewed the content
... endorser 0..*ContactDetailWho endorsed the content
... relatedArtifact 0..*RelatedArtifactF4FRelated artifacts for a knowledge resource
... 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
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... contentType Σ0..1codeMime type of the content, with charset etc.
Binding: Mime Types (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)


Example General: text/plain; charset=UTF-8, image/png
.... language Σ0..1codeHuman language of the content (BCP-47)
Binding: CommonLanguages (preferred): IETF language tag

Additional BindingsPurpose
AllLanguagesMax Binding

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

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Library.languagepreferredCommonLanguages
Max Binding: AllLanguages
Library.statusrequiredPublicationStatus
Library.typeextensibleLibraryType
Library.subject[x]extensibleSubjectType
Library.jurisdictionextensibleJurisdiction ValueSet
Library.topicexampleDefinitionTopic
Library.content.contentTyperequiredMime Types (a valid code from urn:ietf:bcp:13)
Library.content.languagepreferredCommonLanguages
Max Binding: AllLanguages

Constraints

IdGradePathDetailsRequirements
cnl-0warningLibraryName should be usable as an identifier for the module by machine processing applications such as code generation
: name.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
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.exists() and ('#'+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(uri) = '#').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-1errorLibrary.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
dom-r4bwarningLibrary.containedContaining new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems
: ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
ele-1errorLibrary.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorLibrary.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorLibrary.extension:licenceCodeableAll FHIR elements must have a @value or children unless an empty Parameters resource
: hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1errorLibrary.extension:licenceCodeableMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorLibrary.extension:licenceAttachmentAll FHIR elements must have a @value or children unless an empty Parameters resource
: hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1errorLibrary.extension:licenceAttachmentMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorLibrary.extension:relatedContentAll FHIR elements must have a @value or children unless an empty Parameters resource
: hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1errorLibrary.extension:relatedContentMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorLibrary.extension:subjectOtherAll FHIR elements must have a @value or children unless an empty Parameters resource
: hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1errorLibrary.extension:subjectOtherMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorLibrary.extension:classifierAll FHIR elements must have a @value or children unless an empty Parameters resource
: hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1errorLibrary.extension:classifierMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorLibrary.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorLibrary.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorLibrary.urlAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.versionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.titleAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.subtitleAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.experimentalAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.subject[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.dateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.publisherAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.contactAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.descriptionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.useContextAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.jurisdictionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.purposeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.usageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.copyrightAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.approvalDateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.lastReviewDateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.effectivePeriodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.topicAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.authorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.editorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.reviewerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.endorserAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.relatedArtifactAll FHIR elements must have a @value or children unless an empty Parameters resource
: hasValue() or (children().count() > id.count()) or $this is Parameters
ele-1errorLibrary.parameterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.dataRequirementAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.contentAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.content.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorLibrary.content.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorLibrary.content.contentTypeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.content.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.content.dataAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.content.urlAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.content.sizeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.content.hashAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.content.titleAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLibrary.content.creationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())