OneAquaHealth Project
0.1.0-ci-build - ci-build 150

OneAquaHealth Project, published by OneAquaHealth Project. This guide is not an authorized publication; it is the continuous build for version 0.1.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/oah/ and changes regularly. See the Directory of published versions

Resource Profile: Library: OAH Indicators

Official URL: http://hl7.eu/fhir/ig/oah/StructureDefinition/library-oah Version: 0.1.0-ci-build
Draft as of 2025-08-11 Computable Name: LibraryOah

It defines the rules to be applied to the Library resource for the purpose of the OneAquaHealth project. This resource is used to describe the data set of indicators that are used in the OneAquaHealth project.

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Library C 0..* Library Represents a library of quality improvement components
Constraints: lib-0
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:size 0..1 Quantity Library: size
URL: http://hl7.eu/fhir/ig/oah/StructureDefinition/library-size
.... extension:numberOfRecords 0..1 integer Library: number of records
URL: http://hl7.eu/fhir/ig/oah/StructureDefinition/library-numberOfRecords
.... extension:copyrightLabel 0..1 string Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Library.copyrightLabel
.... extension:licence 0..1 CodeableConcept Licence Terms as CodeableConcept
URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/licenceCodeable
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Data Set identifier
... version Σ 0..1 string Data Set version
... title Σ 1..1 string Data Set title
... status ?!Σ 1..1 code Data Set status
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... type Σ 1..1 CodeableConcept Data Set type
Binding: LibraryType (extensible): The type of knowledge asset this library contains.
... date Σ 1..1 dateTime Data Set date of publication
... publisher Σ 0..1 string Data Set publisher
... contact Σ 0..* ContactDetail Data Set contact
... description Σ 0..1 markdown Data Set description
... copyright 0..1 markdown Data Set copyright
... author 0..* ContactDetail Data Set author
... content Σ 0..* Attachment Data Set content

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Library.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
From the FHIR Standard
Library.typeextensibleLibraryType
http://hl7.org/fhir/ValueSet/library-type
From the FHIR Standard

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}')

This structure is derived from Library

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Library 0..* Library Represents a library of quality improvement components
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:size 0..1 Quantity Library: size
URL: http://hl7.eu/fhir/ig/oah/StructureDefinition/library-size
.... extension:numberOfRecords 0..1 integer Library: number of records
URL: http://hl7.eu/fhir/ig/oah/StructureDefinition/library-numberOfRecords
.... extension:copyrightLabel 0..1 string Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Library.copyrightLabel
.... extension:licence 0..1 CodeableConcept Licence Terms as CodeableConcept
URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/licenceCodeable
... url 1..1 uri Data Set unique identifier
... identifier 0..* Identifier Data Set identifier
... title 1..1 string Data Set title
... status 1..1 code Data Set status
... type 1..1 CodeableConcept Data Set type
... date 1..1 dateTime Data Set date of publication
... publisher 0..1 string Data Set publisher
... contact 0..* ContactDetail Data Set contact
... description 0..1 markdown Data Set description
... copyright 0..1 markdown Data Set copyright
... author 0..* ContactDetail Data Set author
... content 0..* Attachment Data Set content

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Library C 0..* Library Represents a library of quality improvement components
Constraints: lib-0
... id Σ 0..1 id 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): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:size 0..1 Quantity Library: size
URL: http://hl7.eu/fhir/ig/oah/StructureDefinition/library-size
.... extension:numberOfRecords 0..1 integer Library: number of records
URL: http://hl7.eu/fhir/ig/oah/StructureDefinition/library-numberOfRecords
.... extension:copyrightLabel 0..1 string Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Library.copyrightLabel
.... extension:licence 0..1 CodeableConcept Licence Terms as CodeableConcept
URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/licenceCodeable
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... url Σ 1..1 uri Data Set unique identifier
... identifier Σ 0..* Identifier Data Set identifier
... version Σ 0..1 string Data Set version
... name ΣC 0..1 string Name for this library (computer friendly)
... title Σ 1..1 string Data Set title
... subtitle 0..1 string Subordinate title of the library
... status ?!Σ 1..1 code Data Set status
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... experimental Σ 0..1 boolean For testing purposes, not real usage
... type Σ 1..1 CodeableConcept Data Set type
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 Σ 1..1 dateTime Data Set date of publication
... publisher Σ 0..1 string Data Set publisher
... contact Σ 0..* ContactDetail Data Set contact
... description Σ 0..1 markdown Data Set description
... useContext Σ 0..* UsageContext The context that the content is intended to support
... jurisdiction Σ 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 0..1 markdown Data Set copyright
... approvalDate 0..1 date When the library was approved by publisher
... lastReviewDate 0..1 date When the library was last reviewed
... effectivePeriod Σ 0..1 Period When the library is expected to be used
... topic 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.
... author 0..* ContactDetail Data Set author
... editor 0..* ContactDetail Who edited the content
... reviewer 0..* ContactDetail Who reviewed the content
... endorser 0..* ContactDetail Who endorsed the content
... relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc.
... parameter 0..* ParameterDefinition Parameters defined by the library
... dataRequirement 0..* DataRequirement What data is referenced by this library
... content Σ 0..* Attachment Data Set content

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Library.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Library.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
From the FHIR Standard
Library.typeextensibleLibraryType
http://hl7.org/fhir/ValueSet/library-type
From the FHIR Standard
Library.subject[x]extensibleSubjectType
http://hl7.org/fhir/ValueSet/subject-type
From the FHIR Standard
Library.jurisdictionextensibleJurisdiction ValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
From the FHIR Standard
Library.topicexampleDefinitionTopic
http://hl7.org/fhir/ValueSet/definition-topic
From the FHIR Standard

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}')

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Library C 0..* Library Represents a library of quality improvement components
Constraints: lib-0
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:size 0..1 Quantity Library: size
URL: http://hl7.eu/fhir/ig/oah/StructureDefinition/library-size
.... extension:numberOfRecords 0..1 integer Library: number of records
URL: http://hl7.eu/fhir/ig/oah/StructureDefinition/library-numberOfRecords
.... extension:copyrightLabel 0..1 string Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Library.copyrightLabel
.... extension:licence 0..1 CodeableConcept Licence Terms as CodeableConcept
URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/licenceCodeable
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Data Set identifier
... version Σ 0..1 string Data Set version
... title Σ 1..1 string Data Set title
... status ?!Σ 1..1 code Data Set status
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... type Σ 1..1 CodeableConcept Data Set type
Binding: LibraryType (extensible): The type of knowledge asset this library contains.
... date Σ 1..1 dateTime Data Set date of publication
... publisher Σ 0..1 string Data Set publisher
... contact Σ 0..* ContactDetail Data Set contact
... description Σ 0..1 markdown Data Set description
... copyright 0..1 markdown Data Set copyright
... author 0..* ContactDetail Data Set author
... content Σ 0..* Attachment Data Set content

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Library.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
From the FHIR Standard
Library.typeextensibleLibraryType
http://hl7.org/fhir/ValueSet/library-type
From the FHIR Standard

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}')

Differential View

This structure is derived from Library

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Library 0..* Library Represents a library of quality improvement components
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:size 0..1 Quantity Library: size
URL: http://hl7.eu/fhir/ig/oah/StructureDefinition/library-size
.... extension:numberOfRecords 0..1 integer Library: number of records
URL: http://hl7.eu/fhir/ig/oah/StructureDefinition/library-numberOfRecords
.... extension:copyrightLabel 0..1 string Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Library.copyrightLabel
.... extension:licence 0..1 CodeableConcept Licence Terms as CodeableConcept
URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/licenceCodeable
... url 1..1 uri Data Set unique identifier
... identifier 0..* Identifier Data Set identifier
... title 1..1 string Data Set title
... status 1..1 code Data Set status
... type 1..1 CodeableConcept Data Set type
... date 1..1 dateTime Data Set date of publication
... publisher 0..1 string Data Set publisher
... contact 0..* ContactDetail Data Set contact
... description 0..1 markdown Data Set description
... copyright 0..1 markdown Data Set copyright
... author 0..* ContactDetail Data Set author
... content 0..* Attachment Data Set content

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Library C 0..* Library Represents a library of quality improvement components
Constraints: lib-0
... id Σ 0..1 id 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): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:size 0..1 Quantity Library: size
URL: http://hl7.eu/fhir/ig/oah/StructureDefinition/library-size
.... extension:numberOfRecords 0..1 integer Library: number of records
URL: http://hl7.eu/fhir/ig/oah/StructureDefinition/library-numberOfRecords
.... extension:copyrightLabel 0..1 string Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Library.copyrightLabel
.... extension:licence 0..1 CodeableConcept Licence Terms as CodeableConcept
URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/licenceCodeable
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... url Σ 1..1 uri Data Set unique identifier
... identifier Σ 0..* Identifier Data Set identifier
... version Σ 0..1 string Data Set version
... name ΣC 0..1 string Name for this library (computer friendly)
... title Σ 1..1 string Data Set title
... subtitle 0..1 string Subordinate title of the library
... status ?!Σ 1..1 code Data Set status
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... experimental Σ 0..1 boolean For testing purposes, not real usage
... type Σ 1..1 CodeableConcept Data Set type
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 Σ 1..1 dateTime Data Set date of publication
... publisher Σ 0..1 string Data Set publisher
... contact Σ 0..* ContactDetail Data Set contact
... description Σ 0..1 markdown Data Set description
... useContext Σ 0..* UsageContext The context that the content is intended to support
... jurisdiction Σ 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 0..1 markdown Data Set copyright
... approvalDate 0..1 date When the library was approved by publisher
... lastReviewDate 0..1 date When the library was last reviewed
... effectivePeriod Σ 0..1 Period When the library is expected to be used
... topic 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.
... author 0..* ContactDetail Data Set author
... editor 0..* ContactDetail Who edited the content
... reviewer 0..* ContactDetail Who reviewed the content
... endorser 0..* ContactDetail Who endorsed the content
... relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc.
... parameter 0..* ParameterDefinition Parameters defined by the library
... dataRequirement 0..* DataRequirement What data is referenced by this library
... content Σ 0..* Attachment Data Set content

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Library.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Library.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
From the FHIR Standard
Library.typeextensibleLibraryType
http://hl7.org/fhir/ValueSet/library-type
From the FHIR Standard
Library.subject[x]extensibleSubjectType
http://hl7.org/fhir/ValueSet/subject-type
From the FHIR Standard
Library.jurisdictionextensibleJurisdiction ValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
From the FHIR Standard
Library.topicexampleDefinitionTopic
http://hl7.org/fhir/ValueSet/definition-topic
From the FHIR Standard

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}')

 

Other representations of profile: CSV, Excel, Schematron