FHIR for FAIR - FHIR Implementation Guide
0.1.0 - STU 1 Ballot

This page is part of the FHIR for FAIR - FHIR Implementation Guide (v0.1.0: STU 1 (FHIR R4b) Ballot 1) based on FHIR v4.1.0. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions

Resource Profile: Library (Study Level Medatata)

Defining URL:http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/Library-uv-f4f
Version:0.1.0
Name:LibraryF4F
Title:Library (Study Level Medatata)
Status:Active as of 12/5/21 12:01 AM
Definition:

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

Publisher:Health Level Seven International - SOA Work Group
Source Resource:XML / JSON / Turtle

The official URL for this profile is: 

http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/Library-uv-f4f

Formal Views of Profile Content

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

This structure is derived from Library

Summary

Mandatory: 0 element (1 nested mandatory element)
Must-Support: 9 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

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
... library-relatedContent 0..*RelatedArtifactF4FRelatedArtifact (Library)
URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/library-relatedContent
... url S0..1uriCanonical identifier for this library, represented as a URI (globally unique)
... name S0..1stringName for this library (computer friendly)
... title S0..1stringName for this library (human friendly)
... status S1..1codedraft | active | retired | unknown
... type S1..1CodeableConceptlogic-library | model-definition | asset-collection | module-definition
... purpose S0..1markdownWhy this library is defined
... copyright S0..1markdownUse and/or publishing restrictions
... relatedArtifact 0..*RelatedArtifactF4FRelated artifacts for a knowledge resource
... content
.... url S1..1urlUri where the data can be found

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

... 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
... library-relatedContent 0..*RelatedArtifactF4FRelatedArtifact (Library)
URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/library-relatedContent
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url SΣ0..1uriCanonical identifier for this library, represented as a URI (globally unique)
... identifier SΣ0..*IdentifierAdditional identifier for the library
... version Σ0..1stringBusiness version of the library
... name SΣI0..1stringName for this library (computer friendly)
... title SΣ0..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 Σ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 Σ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 S0..1markdownWhy this library is defined
... usage 0..1stringDescribes the clinical usage of the library
... copyright S0..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..1stringUnique id for inter-element referencing
.... Slices for 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)
Max Binding: AllLanguages: IETF language tag


Example General: en-AU
.... data 0..1base64BinaryData inline, base64ed
.... url SΣ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 I0..*LibraryRepresents a library of quality improvement components
... url Σ0..1uriCanonical identifier for this library, represented as a URI (globally unique)
... identifier Σ0..*IdentifierAdditional identifier for the library
... name ΣI0..1stringName for this library (computer friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... type Σ1..1CodeableConceptlogic-library | model-definition | asset-collection | module-definition
Binding: LibraryType (extensible): The type of knowledge asset this library contains.

... purpose 0..1markdownWhy this library is defined
... copyright 0..1markdownUse and/or publishing restrictions
... content Σ0..*AttachmentContents of the library, either embedded or referenced
.... url Σ1..1urlUri where the data can be found

doco Documentation for this format

This structure is derived from Library

Summary

Mandatory: 0 element (1 nested mandatory element)
Must-Support: 9 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

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
... library-relatedContent 0..*RelatedArtifactF4FRelatedArtifact (Library)
URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/library-relatedContent
... url S0..1uriCanonical identifier for this library, represented as a URI (globally unique)
... name S0..1stringName for this library (computer friendly)
... title S0..1stringName for this library (human friendly)
... status S1..1codedraft | active | retired | unknown
... type S1..1CodeableConceptlogic-library | model-definition | asset-collection | module-definition
... purpose S0..1markdownWhy this library is defined
... copyright S0..1markdownUse and/or publishing restrictions
... relatedArtifact 0..*RelatedArtifactF4FRelated artifacts for a knowledge resource
... content
.... url S1..1urlUri where the data can be found

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library I0..*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)
Max Binding: AllLanguages: IETF language tag

... 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
... library-relatedContent 0..*RelatedArtifactF4FRelatedArtifact (Library)
URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/library-relatedContent
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url SΣ0..1uriCanonical identifier for this library, represented as a URI (globally unique)
... identifier SΣ0..*IdentifierAdditional identifier for the library
... version Σ0..1stringBusiness version of the library
... name SΣI0..1stringName for this library (computer friendly)
... title SΣ0..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 Σ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 Σ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 S0..1markdownWhy this library is defined
... usage 0..1stringDescribes the clinical usage of the library
... copyright S0..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..1stringUnique id for inter-element referencing
.... Slices for 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)
Max Binding: AllLanguages: IETF language tag


Example General: en-AU
.... data 0..1base64BinaryData inline, base64ed
.... url SΣ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
Library.content.languagepreferredCommonLanguages
Max Binding: AllLanguages

Constraints

IdPathDetailsRequirements
cnl-0LibraryName should be usable as an identifier for the module by machine processing applications such as code generation
: name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
dom-2LibraryIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3LibraryIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where(((id.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-4LibraryIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5LibraryIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6LibraryA resource should have narrative for robust management
: text.`div`.exists()
ele-1Library.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Library.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Library.extension: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-1Library.extension:relatedContentMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Library.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Library.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Library.urlAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.versionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.titleAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.subtitleAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.experimentalAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.subject[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.dateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.publisherAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.contactAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.descriptionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.useContextAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.jurisdictionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.purposeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.usageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.copyrightAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.approvalDateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.lastReviewDateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.effectivePeriodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.topicAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.authorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.editorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.reviewerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.endorserAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.relatedArtifactAll FHIR elements must have a @value or children unless an empty Parameters resource
: hasValue() or (children().count() > id.count()) or $this is Parameters
ele-1Library.parameterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.dataRequirementAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.contentAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.content.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Library.content.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Library.content.contentTypeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.content.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.content.dataAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.content.urlAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.content.sizeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.content.hashAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.content.titleAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Library.content.creationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())