FHIR for FAIR - FHIR Implementation Guide
1.0.0 - STU 1
FHIR for FAIR - FHIR Implementation Guide
1.0.0 - STU 1
FHIR for FAIR - FHIR Implementation Guide, published by Health Level Seven International - SOA Work Group. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-for-fair/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/Library-uv-f4f | Version: 1.0.0 | |||
| Active as of 2024-01-05 | 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:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Library
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Library | 0..* | Library | Represents a library of quality improvement components | |
  Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 licenceCodeable | 0..1 | CodeableConcept | Licence Terms as CodeableConcept URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/licenceCodeable | |
| licenceAttachment | 0..1 | Attachment | Licence Terms as Attachment URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/licenceAttachment | |
| relatedContent | 0..* | RelatedArtifactF4F | Content 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..* | CodeableConcept | Classifier [Resource] URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/classifier | |
 url | 0..1 | uri | Canonical identifier for this library, represented as a URI (globally unique). | |
| name | 0..1 | string | Name for this library (computer friendly). | |
| title | 0..1 | string | Name for this library (human friendly). | |
| status | 1..1 | code | draft | active | retired |unknown | |
| type | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection |module-definition | |
| subject[x] | 0..1 | CodeableConcept, Reference(Group) | Type of subject the library content is focused on | |
| purpose | 0..1 | markdown | Why this library is defined. | |
| copyright | 0..1 | markdown | Use and/or publishing restrictions. | |
 relatedArtifact | 0..* | RelatedArtifactF4F | Related artifacts for a knowledge resource | |
 content | ||||
  url | 1..1 | url | Uri where the data can be found | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Library | C | 0..* | Library | Represents a library of quality improvement components |
 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 | |
| licenceCodeable | 0..1 | CodeableConcept | Licence Terms as CodeableConcept URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/licenceCodeable | |
| licenceAttachment | 0..1 | Attachment | Licence Terms as Attachment URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/licenceAttachment | |
| relatedContent | 0..* | RelatedArtifactF4F | Content 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..* | CodeableConcept | Classifier [Resource] URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/classifier | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| url | Σ | 0..1 | uri | Canonical identifier for this library, represented as a URI (globally unique). |
| name | ΣC | 0..1 | string | Name for this library (computer friendly). |
| title | Σ | 0..1 | string | Name for this library (human friendly). |
| status | ?!Σ | 1..1 | code | draft | active | retired |unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| type | Σ | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection |module-definition Binding: LibraryType (extensible): The type of knowledge asset this library contains. |
  subject[x] | 0..1 | Type of 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.). | ||
 subjectCodeableConcept | CodeableConcept | |||
 subjectReference | Reference(Group) | |||
| purpose | 0..1 | markdown | Why this library is defined. | |
| copyright | 0..1 | markdown | Use and/or publishing restrictions. | |
| relatedArtifact | 0..* | RelatedArtifactF4F | Related artifacts for a knowledge resource | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Library.status | required | PublicationStatus |
| Library.type | extensible | LibraryType |
| Library.subject[x] | extensible | SubjectType |
| Id | Grade | Path(s) | Details | Requirements |
| cnl-0 | warning | Library | Name 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-2 | error | Library | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Library | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where(((id.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-4 | error | Library | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Library | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Library | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Library | C | 0..* | Library | Represents a library of quality improvement components | ||||
| 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): IETF language tag
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| licenceCodeable | 0..1 | CodeableConcept | Licence Terms as CodeableConcept URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/licenceCodeable | |||||
| licenceAttachment | 0..1 | Attachment | Licence Terms as Attachment URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/licenceAttachment | |||||
| relatedContent | 0..* | RelatedArtifactF4F | Content 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..* | CodeableConcept | Classifier [Resource] URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/classifier | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| url | Σ | 0..1 | uri | Canonical identifier for this library, represented as a URI (globally unique). | ||||
| identifier | Σ | 0..* | Identifier | Additional identifier for the library | ||||
| version | Σ | 0..1 | string | Business version of the library | ||||
| name | ΣC | 0..1 | string | Name for this library (computer friendly). | ||||
| title | Σ | 0..1 | string | Name for this library (human friendly). | ||||
| subtitle | 0..1 | string | Subordinate title of the library | |||||
| status | ?!Σ | 1..1 | code | draft | active | retired |unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
| experimental | Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
| type | Σ | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection |module-definition Binding: LibraryType (extensible): The type of knowledge asset this library contains. | ||||
| subject[x] | 0..1 | Type of 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.). | ||||||
| subjectCodeableConcept | CodeableConcept | |||||||
| subjectReference | Reference(Group) | |||||||
| date | Σ | 0..1 | dateTime | Date last changed | ||||
| publisher | Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
| contact | Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
| description | Σ | 0..1 | markdown | Natural language description of the library | ||||
| 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 | Use and/or publishing restrictions. | |||||
| 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 | Who authored the content | |||||
| editor | 0..* | ContactDetail | Who edited the content | |||||
| reviewer | 0..* | ContactDetail | Who reviewed the content | |||||
| endorser | 0..* | ContactDetail | Who endorsed the content | |||||
| relatedArtifact | 0..* | RelatedArtifactF4F | Related artifacts for a knowledge resource | |||||
| parameter | 0..* | ParameterDefinition | Parameters defined by the library | |||||
| dataRequirement | 0..* | DataRequirement | What data is referenced by this library | |||||
| content | Σ | 0..* | Attachment | Contents of the library, either embedded or referenced | ||||
| id | 0..1 | id | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| contentType | Σ | 0..1 | code | Mime 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..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): IETF language tag
Example General: en-AU | ||||
| data | 0..1 | base64Binary | Data inline, base64ed | |||||
| url | Σ | 1..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
| size | Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | ||||
| hash | Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
| title | Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | ||||
| creation | Σ | 0..1 | dateTime | Date attachment was first created | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Library.language | preferred | CommonLanguages
| ||||
| Library.status | required | PublicationStatus | ||||
| Library.type | extensible | LibraryType | ||||
| Library.subject[x] | extensible | SubjectType | ||||
| Library.jurisdiction | extensible | Jurisdiction ValueSet | ||||
| Library.topic | example | DefinitionTopic | ||||
| Library.content.contentType | required | Mime Types (a valid code from urn:ietf:bcp:13) | ||||
| Library.content.language | preferred | CommonLanguages
|
| Id | Grade | Path(s) | Details | Requirements |
| cnl-0 | warning | Library | Name 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-2 | error | Library | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Library | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where(((id.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-4 | error | Library | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Library | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Library | A resource should have narrative for robust management : text.`div`.exists() | |
| dom-r4b | warning | Library.contained | Containing 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-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Library
Summary
Mandatory: 0 element (1 nested mandatory element)
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from Library
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Library | 0..* | Library | Represents a library of quality improvement components | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| licenceCodeable | 0..1 | CodeableConcept | Licence Terms as CodeableConcept URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/licenceCodeable | |
| licenceAttachment | 0..1 | Attachment | Licence Terms as Attachment URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/licenceAttachment | |
| relatedContent | 0..* | RelatedArtifactF4F | Content 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..* | CodeableConcept | Classifier [Resource] URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/classifier | |
| url | 0..1 | uri | Canonical identifier for this library, represented as a URI (globally unique). | |
| name | 0..1 | string | Name for this library (computer friendly). | |
| title | 0..1 | string | Name for this library (human friendly). | |
| status | 1..1 | code | draft | active | retired |unknown | |
| type | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection |module-definition | |
| subject[x] | 0..1 | CodeableConcept, Reference(Group) | Type of subject the library content is focused on | |
| purpose | 0..1 | markdown | Why this library is defined. | |
| copyright | 0..1 | markdown | Use and/or publishing restrictions. | |
| relatedArtifact | 0..* | RelatedArtifactF4F | Related artifacts for a knowledge resource | |
| content | ||||
| url | 1..1 | url | Uri where the data can be found | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Library | C | 0..* | Library | Represents a library of quality improvement components |
| 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 | |
| licenceCodeable | 0..1 | CodeableConcept | Licence Terms as CodeableConcept URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/licenceCodeable | |
| licenceAttachment | 0..1 | Attachment | Licence Terms as Attachment URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/licenceAttachment | |
| relatedContent | 0..* | RelatedArtifactF4F | Content 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..* | CodeableConcept | Classifier [Resource] URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/classifier | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| url | Σ | 0..1 | uri | Canonical identifier for this library, represented as a URI (globally unique). |
| name | ΣC | 0..1 | string | Name for this library (computer friendly). |
| title | Σ | 0..1 | string | Name for this library (human friendly). |
| status | ?!Σ | 1..1 | code | draft | active | retired |unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| type | Σ | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection |module-definition Binding: LibraryType (extensible): The type of knowledge asset this library contains. |
| subject[x] | 0..1 | Type of 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.). | ||
| subjectCodeableConcept | CodeableConcept | |||
| subjectReference | Reference(Group) | |||
| purpose | 0..1 | markdown | Why this library is defined. | |
| copyright | 0..1 | markdown | Use and/or publishing restrictions. | |
| relatedArtifact | 0..* | RelatedArtifactF4F | Related artifacts for a knowledge resource | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Library.status | required | PublicationStatus |
| Library.type | extensible | LibraryType |
| Library.subject[x] | extensible | SubjectType |
| Id | Grade | Path(s) | Details | Requirements |
| cnl-0 | warning | Library | Name 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-2 | error | Library | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Library | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where(((id.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-4 | error | Library | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Library | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Library | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Library | C | 0..* | Library | Represents a library of quality improvement components | ||||
| 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): IETF language tag
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| licenceCodeable | 0..1 | CodeableConcept | Licence Terms as CodeableConcept URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/licenceCodeable | |||||
| licenceAttachment | 0..1 | Attachment | Licence Terms as Attachment URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/licenceAttachment | |||||
| relatedContent | 0..* | RelatedArtifactF4F | Content 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..* | CodeableConcept | Classifier [Resource] URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/classifier | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| url | Σ | 0..1 | uri | Canonical identifier for this library, represented as a URI (globally unique). | ||||
| identifier | Σ | 0..* | Identifier | Additional identifier for the library | ||||
| version | Σ | 0..1 | string | Business version of the library | ||||
| name | ΣC | 0..1 | string | Name for this library (computer friendly). | ||||
| title | Σ | 0..1 | string | Name for this library (human friendly). | ||||
| subtitle | 0..1 | string | Subordinate title of the library | |||||
| status | ?!Σ | 1..1 | code | draft | active | retired |unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
| experimental | Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
| type | Σ | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection |module-definition Binding: LibraryType (extensible): The type of knowledge asset this library contains. | ||||
| subject[x] | 0..1 | Type of 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.). | ||||||
| subjectCodeableConcept | CodeableConcept | |||||||
| subjectReference | Reference(Group) | |||||||
| date | Σ | 0..1 | dateTime | Date last changed | ||||
| publisher | Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
| contact | Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
| description | Σ | 0..1 | markdown | Natural language description of the library | ||||
| 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 | Use and/or publishing restrictions. | |||||
| 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 | Who authored the content | |||||
| editor | 0..* | ContactDetail | Who edited the content | |||||
| reviewer | 0..* | ContactDetail | Who reviewed the content | |||||
| endorser | 0..* | ContactDetail | Who endorsed the content | |||||
| relatedArtifact | 0..* | RelatedArtifactF4F | Related artifacts for a knowledge resource | |||||
| parameter | 0..* | ParameterDefinition | Parameters defined by the library | |||||
| dataRequirement | 0..* | DataRequirement | What data is referenced by this library | |||||
| content | Σ | 0..* | Attachment | Contents of the library, either embedded or referenced | ||||
| id | 0..1 | id | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| contentType | Σ | 0..1 | code | Mime 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..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): IETF language tag
Example General: en-AU | ||||
| data | 0..1 | base64Binary | Data inline, base64ed | |||||
| url | Σ | 1..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
| size | Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | ||||
| hash | Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
| title | Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | ||||
| creation | Σ | 0..1 | dateTime | Date attachment was first created | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Library.language | preferred | CommonLanguages
| ||||
| Library.status | required | PublicationStatus | ||||
| Library.type | extensible | LibraryType | ||||
| Library.subject[x] | extensible | SubjectType | ||||
| Library.jurisdiction | extensible | Jurisdiction ValueSet | ||||
| Library.topic | example | DefinitionTopic | ||||
| Library.content.contentType | required | Mime Types (a valid code from urn:ietf:bcp:13) | ||||
| Library.content.language | preferred | CommonLanguages
|
| Id | Grade | Path(s) | Details | Requirements |
| cnl-0 | warning | Library | Name 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-2 | error | Library | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Library | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where(((id.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-4 | error | Library | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Library | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Library | A resource should have narrative for robust management : text.`div`.exists() | |
| dom-r4b | warning | Library.contained | Containing 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-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Library
Summary
Mandatory: 0 element (1 nested mandatory element)
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron
IG © 2020+ Health Level Seven International - SOA Work Group. Package hl7.fhir.uv.fhir-for-fair#1.0.0 based on FHIR 4.3.0. Generated 2024-01-05
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change