Extensions for Using Data Elements from FHIR R5 in FHIR R4B
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR R5 in FHIR R4B - Downloaded Version null See the Directory of published versions

Resource Profile: Profile_R5_Library_R4B

Official URL: http://hl7.org/fhir/5.0/StructureDefinition/profile-Library Version: 0.1.0
Standards status: Trial-use Maturity Level: 0 Computable Name: Profile_R5_Library_R4B

This cross-version profile allows R5 Library content to be represented via FHIR R4B Library resources.

Usages:

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(4.3.0) Represents a library of quality improvement components
Constraints: cnl-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
Constraints: ext-1
.... extension:versionAlgorithm 0..1 Coding R5: How to compare versions (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: version-algorithm (??) (extensible)
Constraints: ext-1
.... extension:copyrightLabel 0..1 string R5: Copyright holder and year(s) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... type Σ 1..1 CodeableConcept logic-library | model-definition | asset-collection | module-definition
Binding: LibraryType (extensible): The type of knowledge asset this library contains.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Library.status Base required PublicationStatus 📍4.3.0 FHIR Std.
Library.type Base extensible LibraryType 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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 Library.implicitRules, Library.extension, Library.extension:versionAlgorithm, Library.extension:copyrightLabel, Library.modifierExtension, Library.status, Library.type All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Library.extension, Library.extension:versionAlgorithm, Library.extension:copyrightLabel, Library.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Library

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Library 0..* Library(4.3.0) Represents a library of quality improvement components
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:versionAlgorithm 0..1 Coding R5: How to compare versions (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: version-algorithm (??) (extensible)
.... extension:copyrightLabel 0..1 string R5: Copyright holder and year(s) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Library C 0..* Library(4.3.0) Represents a library of quality improvement components
Constraints: cnl-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): IETF language tag
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
Constraints: dom-r4b
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:versionAlgorithm 0..1 Coding R5: How to compare versions (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: version-algorithm (??) (extensible)
Constraints: ext-1
.... extension:copyrightLabel 0..1 string R5: Copyright holder and year(s) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... 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 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 Σ 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..* 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 Contents of the library, either embedded or referenced

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Library.language Base preferred Common Languages 📍4.3.0 FHIR Std.
Library.status Base required PublicationStatus 📍4.3.0 FHIR Std.
Library.type Base extensible LibraryType 📍4.3.0 FHIR Std.
Library.subject[x] Base extensible Subject type 📍4.3.0 FHIR Std.
Library.jurisdiction Base extensible Jurisdiction 📍4.3.0 FHIR Std.
Library.topic Base example DefinitionTopic 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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 Library.meta, Library.implicitRules, Library.language, Library.text, Library.extension, Library.extension:versionAlgorithm, Library.extension:copyrightLabel, Library.modifierExtension, Library.url, Library.identifier, Library.version, Library.name, Library.title, Library.subtitle, Library.status, Library.experimental, Library.type, Library.subject[x], Library.date, Library.publisher, Library.contact, Library.description, Library.useContext, Library.jurisdiction, Library.purpose, Library.usage, Library.copyright, Library.approvalDate, Library.lastReviewDate, Library.effectivePeriod, Library.topic, Library.author, Library.editor, Library.reviewer, Library.endorser, Library.relatedArtifact, Library.parameter, Library.dataRequirement, Library.content All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Library.extension, Library.extension:versionAlgorithm, Library.extension:copyrightLabel, Library.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Library C 0..* Library(4.3.0) Represents a library of quality improvement components
Constraints: cnl-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
Constraints: ext-1
.... extension:versionAlgorithm 0..1 Coding R5: How to compare versions (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: version-algorithm (??) (extensible)
Constraints: ext-1
.... extension:copyrightLabel 0..1 string R5: Copyright holder and year(s) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... type Σ 1..1 CodeableConcept logic-library | model-definition | asset-collection | module-definition
Binding: LibraryType (extensible): The type of knowledge asset this library contains.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Library.status Base required PublicationStatus 📍4.3.0 FHIR Std.
Library.type Base extensible LibraryType 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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 Library.implicitRules, Library.extension, Library.extension:versionAlgorithm, Library.extension:copyrightLabel, Library.modifierExtension, Library.status, Library.type All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Library.extension, Library.extension:versionAlgorithm, Library.extension:copyrightLabel, Library.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from Library

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Library 0..* Library(4.3.0) Represents a library of quality improvement components
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:versionAlgorithm 0..1 Coding R5: How to compare versions (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: version-algorithm (??) (extensible)
.... extension:copyrightLabel 0..1 string R5: Copyright holder and year(s) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Library C 0..* Library(4.3.0) Represents a library of quality improvement components
Constraints: cnl-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): IETF language tag
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
Constraints: dom-r4b
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:versionAlgorithm 0..1 Coding R5: How to compare versions (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: version-algorithm (??) (extensible)
Constraints: ext-1
.... extension:copyrightLabel 0..1 string R5: Copyright holder and year(s) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... 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 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 Σ 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..* 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 Contents of the library, either embedded or referenced

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Library.language Base preferred Common Languages 📍4.3.0 FHIR Std.
Library.status Base required PublicationStatus 📍4.3.0 FHIR Std.
Library.type Base extensible LibraryType 📍4.3.0 FHIR Std.
Library.subject[x] Base extensible Subject type 📍4.3.0 FHIR Std.
Library.jurisdiction Base extensible Jurisdiction 📍4.3.0 FHIR Std.
Library.topic Base example DefinitionTopic 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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 Library.meta, Library.implicitRules, Library.language, Library.text, Library.extension, Library.extension:versionAlgorithm, Library.extension:copyrightLabel, Library.modifierExtension, Library.url, Library.identifier, Library.version, Library.name, Library.title, Library.subtitle, Library.status, Library.experimental, Library.type, Library.subject[x], Library.date, Library.publisher, Library.contact, Library.description, Library.useContext, Library.jurisdiction, Library.purpose, Library.usage, Library.copyright, Library.approvalDate, Library.lastReviewDate, Library.effectivePeriod, Library.topic, Library.author, Library.editor, Library.reviewer, Library.endorser, Library.relatedArtifact, Library.parameter, Library.dataRequirement, Library.content All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Library.extension, Library.extension:versionAlgorithm, Library.extension:copyrightLabel, Library.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron