Release 5 Preview #1

This page is part of the FHIR Specification (v4.2.0: R5 Preview #1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4

14.14.12.2 StructureDefinition: ShareableLibrary

Clinical Decision Support Work Group Maturity Level: 1Trial Use Use Context: Any

The official URL for this profile is: 

http://hl7.org/fhir/StructureDefinition/shareablelibrary

Enforces the minimum information set for the library metadata required by HL7 and other organizations that share and publish libraries

This profile was published on [no date] as a draft by HL7.

14.14.12.2.1 Formal Views of Profile Content

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

This structure is derived from Library.

Summary

Mandatory: 6 elements
Must-Support: 6 elements

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library I1..1LibraryRepresents a library of quality improvement components
... id Σ0..1idLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: Common Languages (preferred)
Max Binding: All Languages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... url ΣI1..1uriCanonical identifier for this library, represented as a URI (globally unique)
... identifier SΣI0..*IdentifierAdditional identifier for the library
... version ΣI1..1stringBusiness version of the library
... name ΣI1..1stringName for this library (computer friendly)
... title SΣI0..1stringName for this library (human friendly)
... subtitle I0..1stringSubordinate title of the library
... status ?!ΣI1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required)
... experimental ΣI1..1booleanFor testing purposes, not real usage
... type ΣI1..1CodeableConceptlogic-library | model-definition | asset-collection | module-definition
Binding: LibraryType (extensible)
... subject[x] I0..1Type of individual the library content is focused on
Binding: Subject type (extensible)
.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group)
... date SΣI0..1dateTimeDate last changed
... publisher ΣI1..1stringName of the publisher (organization or individual)
... contact SΣI0..*ContactDetailContact details for the publisher
... description ΣI1..1markdownNatural language description of the library
... useContext SΣI0..*UsageContextThe context that the content is intended to support
... jurisdiction SΣI0..*CodeableConceptIntended jurisdiction for library (if applicable)
Binding: Jurisdiction (extensible)
... purpose I0..1markdownWhy this library is defined
... usage I0..1stringDescribes the clinical usage of the library
... copyright I0..1markdownUse and/or publishing restrictions
... approvalDate I0..1dateWhen the library was approved by publisher
... lastReviewDate I0..1dateWhen the library was last reviewed
... effectivePeriod ΣI0..1PeriodWhen the library is expected to be used
... topic I0..*CodeableConceptE.g. Education, Treatment, Assessment, etc.
Binding: DefinitionTopic (example)
... author I0..*ContactDetailWho authored the content
... editor I0..*ContactDetailWho edited the content
... reviewer I0..*ContactDetailWho reviewed the content
... endorser I0..*ContactDetailWho endorsed the content
... relatedArtifact I0..*RelatedArtifactAdditional documentation, citations, etc.
... parameter I0..*ParameterDefinitionParameters defined by the library
... dataRequirement I0..*DataRequirementWhat data is referenced by this library
... content ΣI0..*AttachmentContents of the library, either embedded or referenced

doco Documentation for this format
<!-- Shareable Library -->doco

<Library xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->
 <meta><!-- ?? 0..1 Meta Metadata about the resource --></meta>
 <implicitRules value="[uri]"/><!-- ?? 0..1 A set of rules under which this content was created -->
 <language value="[code]"/><!-- ?? 0..1 Language of the resource content   -->
 <text><!-- ?? 0..1 Narrative 
     Text summary of the resource, for human interpretation --></text>
 <contained><!-- 0..* Resource Contained, inline Resources --></contained>
 <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <url value="[uri]"/><!-- ?? 1..1 Canonical identifier for this library, represented as a URI (globally unique) -->
 <identifier><!-- ?? 0..* Identifier Additional identifier for the library --></identifier>
 <version value="[string]"/><!-- ?? 1..1 Business version of the library -->
 <name value="[string]"/><!-- ?? 1..1 Name for this library (computer friendly) -->
 <title value="[string]"/><!-- ?? 0..1 Name for this library (human friendly) -->
 <subtitle value="[string]"/><!-- ?? 0..1 Subordinate title of the library -->
 <status value="[code]"/><!-- ?? 1..1 draft | active | retired | unknown   -->
 <experimental value="[boolean]"/><!-- ?? 1..1 For testing purposes, not real usage -->
 <type><!-- ?? 1..1 CodeableConcept logic-library | model-definition | asset-collection | module-definition   --></type>
 <subject[x]><!-- ?? 0..1 CodeableConcept|Reference(Group) Type of individual the library content is focused on   --></subject[x]>
 <date value="[dateTime]"/><!-- ?? 0..1 Date last changed -->
 <publisher value="[string]"/><!-- ?? 1..1 Name of the publisher (organization or individual) -->
 <contact><!-- ?? 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- ?? 1..1 Natural language description of the library -->
 <useContext><!-- ?? 0..* UsageContext 
     The context that the content is intended to support --></useContext>
 <jurisdiction><!-- ?? 0..* CodeableConcept Intended jurisdiction for library (if applicable)   --></jurisdiction>
 <purpose value="[markdown]"/><!-- ?? 0..1 Why this library is defined -->
 <usage value="[string]"/><!-- ?? 0..1 Describes the clinical usage of the library -->
 <copyright value="[markdown]"/><!-- ?? 0..1 Use and/or publishing restrictions -->
 <approvalDate value="[date]"/><!-- ?? 0..1 When the library was approved by publisher -->
 <lastReviewDate value="[date]"/><!-- ?? 0..1 When the library was last reviewed -->
 <effectivePeriod><!-- ?? 0..1 Period 
     When the library is expected to be used --></effectivePeriod>
 <topic><!-- ?? 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.   --></topic>
 <author><!-- ?? 0..* ContactDetail Who authored the content --></author>
 <editor><!-- ?? 0..* ContactDetail Who edited the content --></editor>
 <reviewer><!-- ?? 0..* ContactDetail Who reviewed the content --></reviewer>
 <endorser><!-- ?? 0..* ContactDetail Who endorsed the content --></endorser>
 <relatedArtifact><!-- ?? 0..* RelatedArtifact 
     Additional documentation, citations, etc. --></relatedArtifact>
 <parameter><!-- ?? 0..* ParameterDefinition 
     Parameters defined by the library --></parameter>
 <dataRequirement><!-- ?? 0..* DataRequirement 
     What data is referenced by this library --></dataRequirement>
 <content><!-- ?? 0..* Attachment 
     Contents of the library, either embedded or referenced --></content>
</Library>

{ // Shareable Library
  // from Element: extension
    "meta" : { Meta }, // C?Metadata about the resource
    "implicitRules" : "<uri>", // C?A set of rules under which this content was created
    "language" : "<code>", // C?Language of the resource content
    "text" : { Narrative }, // C?Text summary of the resource, for human interpretation
    "contained" : [{ Resource }], //Contained, inline Resources
    "modifierExtension" : [{ Extension }], // C?Extensions that cannot be ignored
    "url" : "<uri>", // C? R! Canonical identifier for this library, represented as a URI (globally unique)
    "identifier" : [{ Identifier }], // C?Additional identifier for the library
    "version" : "<string>", // C? R! Business version of the library
    "name" : "<string>", // C? R! Name for this library (computer friendly)
    "title" : "<string>", // C?Name for this library (human friendly)
    "subtitle" : "<string>", // C?Subordinate title of the library
    "status" : "<code>", // C? R! draft | active | retired | unknown
    "experimental" : <boolean>, // C? R! For testing purposes, not real usage
    "type" : { CodeableConcept }, // C? R! logic-library | model-definition | asset-collection | module-definition
// value[x]: Type of individual the library content is focused on. One of these 2:
    "subjectCodeableConcept" : { CodeableConcept }, // C?Type of individual the library content is focused on
    "subjectReference" : { Reference(Group) }, // C?Type of individual the library content is focused on
    "date" : "<dateTime>", // C?Date last changed
    "publisher" : "<string>", // C? R! Name of the publisher (organization or individual)
    "contact" : [{ ContactDetail }], // C?Contact details for the publisher
    "description" : "<markdown>", // C? R! Natural language description of the library
    "useContext" : [{ UsageContext }], // C?The context that the content is intended to support
    "jurisdiction" : [{ CodeableConcept }], // C?Intended jurisdiction for library (if applicable)
    "purpose" : "<markdown>", // C?Why this library is defined
    "usage" : "<string>", // C?Describes the clinical usage of the library
    "copyright" : "<markdown>", // C?Use and/or publishing restrictions
    "approvalDate" : "<date>", // C?When the library was approved by publisher
    "lastReviewDate" : "<date>", // C?When the library was last reviewed
    "effectivePeriod" : { Period }, // C?When the library is expected to be used
    "topic" : [{ CodeableConcept }], // C?E.g. Education, Treatment, Assessment, etc.
    "author" : [{ ContactDetail }], // C?Who authored the content
    "editor" : [{ ContactDetail }], // C?Who edited the content
    "reviewer" : [{ ContactDetail }], // C?Who reviewed the content
    "endorser" : [{ ContactDetail }], // C?Who endorsed the content
    "relatedArtifact" : [{ RelatedArtifact }], // C?Additional documentation, citations, etc.
    "parameter" : [{ ParameterDefinition }], // C?Parameters defined by the library
    "dataRequirement" : [{ DataRequirement }] // C?What data is referenced by this library
    "content" : [{ Attachment }], // C?Contents of the library, either embedded or referenced
  }

This structure is derived from Library.

Summary

Mandatory: 6 elements
Must-Support: 6 elements

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library I1..1LibraryRepresents a library of quality improvement components
... id Σ0..1idLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: Common Languages (preferred)
Max Binding: All Languages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... url ΣI1..1uriCanonical identifier for this library, represented as a URI (globally unique)
... identifier SΣI0..*IdentifierAdditional identifier for the library
... version ΣI1..1stringBusiness version of the library
... name ΣI1..1stringName for this library (computer friendly)
... title SΣI0..1stringName for this library (human friendly)
... subtitle I0..1stringSubordinate title of the library
... status ?!ΣI1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required)
... experimental ΣI1..1booleanFor testing purposes, not real usage
... type ΣI1..1CodeableConceptlogic-library | model-definition | asset-collection | module-definition
Binding: LibraryType (extensible)
... subject[x] I0..1Type of individual the library content is focused on
Binding: Subject type (extensible)
.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group)
... date SΣI0..1dateTimeDate last changed
... publisher ΣI1..1stringName of the publisher (organization or individual)
... contact SΣI0..*ContactDetailContact details for the publisher
... description ΣI1..1markdownNatural language description of the library
... useContext SΣI0..*UsageContextThe context that the content is intended to support
... jurisdiction SΣI0..*CodeableConceptIntended jurisdiction for library (if applicable)
Binding: Jurisdiction (extensible)
... purpose I0..1markdownWhy this library is defined
... usage I0..1stringDescribes the clinical usage of the library
... copyright I0..1markdownUse and/or publishing restrictions
... approvalDate I0..1dateWhen the library was approved by publisher
... lastReviewDate I0..1dateWhen the library was last reviewed
... effectivePeriod ΣI0..1PeriodWhen the library is expected to be used
... topic I0..*CodeableConceptE.g. Education, Treatment, Assessment, etc.
Binding: DefinitionTopic (example)
... author I0..*ContactDetailWho authored the content
... editor I0..*ContactDetailWho edited the content
... reviewer I0..*ContactDetailWho reviewed the content
... endorser I0..*ContactDetailWho endorsed the content
... relatedArtifact I0..*RelatedArtifactAdditional documentation, citations, etc.
... parameter I0..*ParameterDefinitionParameters defined by the library
... dataRequirement I0..*DataRequirementWhat data is referenced by this library
... content ΣI0..*AttachmentContents of the library, either embedded or referenced

doco Documentation for this format

XML Template

<!-- Shareable Library -->doco

<Library xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->
 <meta><!-- ?? 0..1 Meta Metadata about the resource --></meta>
 <implicitRules value="[uri]"/><!-- ?? 0..1 A set of rules under which this content was created -->
 <language value="[code]"/><!-- ?? 0..1 Language of the resource content   -->
 <text><!-- ?? 0..1 Narrative 
     Text summary of the resource, for human interpretation --></text>
 <contained><!-- 0..* Resource Contained, inline Resources --></contained>
 <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <url value="[uri]"/><!-- ?? 1..1 Canonical identifier for this library, represented as a URI (globally unique) -->
 <identifier><!-- ?? 0..* Identifier Additional identifier for the library --></identifier>
 <version value="[string]"/><!-- ?? 1..1 Business version of the library -->
 <name value="[string]"/><!-- ?? 1..1 Name for this library (computer friendly) -->
 <title value="[string]"/><!-- ?? 0..1 Name for this library (human friendly) -->
 <subtitle value="[string]"/><!-- ?? 0..1 Subordinate title of the library -->
 <status value="[code]"/><!-- ?? 1..1 draft | active | retired | unknown   -->
 <experimental value="[boolean]"/><!-- ?? 1..1 For testing purposes, not real usage -->
 <type><!-- ?? 1..1 CodeableConcept logic-library | model-definition | asset-collection | module-definition   --></type>
 <subject[x]><!-- ?? 0..1 CodeableConcept|Reference(Group) Type of individual the library content is focused on   --></subject[x]>
 <date value="[dateTime]"/><!-- ?? 0..1 Date last changed -->
 <publisher value="[string]"/><!-- ?? 1..1 Name of the publisher (organization or individual) -->
 <contact><!-- ?? 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- ?? 1..1 Natural language description of the library -->
 <useContext><!-- ?? 0..* UsageContext 
     The context that the content is intended to support --></useContext>
 <jurisdiction><!-- ?? 0..* CodeableConcept Intended jurisdiction for library (if applicable)   --></jurisdiction>
 <purpose value="[markdown]"/><!-- ?? 0..1 Why this library is defined -->
 <usage value="[string]"/><!-- ?? 0..1 Describes the clinical usage of the library -->
 <copyright value="[markdown]"/><!-- ?? 0..1 Use and/or publishing restrictions -->
 <approvalDate value="[date]"/><!-- ?? 0..1 When the library was approved by publisher -->
 <lastReviewDate value="[date]"/><!-- ?? 0..1 When the library was last reviewed -->
 <effectivePeriod><!-- ?? 0..1 Period 
     When the library is expected to be used --></effectivePeriod>
 <topic><!-- ?? 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.   --></topic>
 <author><!-- ?? 0..* ContactDetail Who authored the content --></author>
 <editor><!-- ?? 0..* ContactDetail Who edited the content --></editor>
 <reviewer><!-- ?? 0..* ContactDetail Who reviewed the content --></reviewer>
 <endorser><!-- ?? 0..* ContactDetail Who endorsed the content --></endorser>
 <relatedArtifact><!-- ?? 0..* RelatedArtifact 
     Additional documentation, citations, etc. --></relatedArtifact>
 <parameter><!-- ?? 0..* ParameterDefinition 
     Parameters defined by the library --></parameter>
 <dataRequirement><!-- ?? 0..* DataRequirement 
     What data is referenced by this library --></dataRequirement>
 <content><!-- ?? 0..* Attachment 
     Contents of the library, either embedded or referenced --></content>
</Library>

JSON Template

{ // Shareable Library
  // from Element: extension
    "meta" : { Meta }, // C?Metadata about the resource
    "implicitRules" : "<uri>", // C?A set of rules under which this content was created
    "language" : "<code>", // C?Language of the resource content
    "text" : { Narrative }, // C?Text summary of the resource, for human interpretation
    "contained" : [{ Resource }], //Contained, inline Resources
    "modifierExtension" : [{ Extension }], // C?Extensions that cannot be ignored
    "url" : "<uri>", // C? R! Canonical identifier for this library, represented as a URI (globally unique)
    "identifier" : [{ Identifier }], // C?Additional identifier for the library
    "version" : "<string>", // C? R! Business version of the library
    "name" : "<string>", // C? R! Name for this library (computer friendly)
    "title" : "<string>", // C?Name for this library (human friendly)
    "subtitle" : "<string>", // C?Subordinate title of the library
    "status" : "<code>", // C? R! draft | active | retired | unknown
    "experimental" : <boolean>, // C? R! For testing purposes, not real usage
    "type" : { CodeableConcept }, // C? R! logic-library | model-definition | asset-collection | module-definition
// value[x]: Type of individual the library content is focused on. One of these 2:
    "subjectCodeableConcept" : { CodeableConcept }, // C?Type of individual the library content is focused on
    "subjectReference" : { Reference(Group) }, // C?Type of individual the library content is focused on
    "date" : "<dateTime>", // C?Date last changed
    "publisher" : "<string>", // C? R! Name of the publisher (organization or individual)
    "contact" : [{ ContactDetail }], // C?Contact details for the publisher
    "description" : "<markdown>", // C? R! Natural language description of the library
    "useContext" : [{ UsageContext }], // C?The context that the content is intended to support
    "jurisdiction" : [{ CodeableConcept }], // C?Intended jurisdiction for library (if applicable)
    "purpose" : "<markdown>", // C?Why this library is defined
    "usage" : "<string>", // C?Describes the clinical usage of the library
    "copyright" : "<markdown>", // C?Use and/or publishing restrictions
    "approvalDate" : "<date>", // C?When the library was approved by publisher
    "lastReviewDate" : "<date>", // C?When the library was last reviewed
    "effectivePeriod" : { Period }, // C?When the library is expected to be used
    "topic" : [{ CodeableConcept }], // C?E.g. Education, Treatment, Assessment, etc.
    "author" : [{ ContactDetail }], // C?Who authored the content
    "editor" : [{ ContactDetail }], // C?Who edited the content
    "reviewer" : [{ ContactDetail }], // C?Who reviewed the content
    "endorser" : [{ ContactDetail }], // C?Who endorsed the content
    "relatedArtifact" : [{ RelatedArtifact }], // C?Additional documentation, citations, etc.
    "parameter" : [{ ParameterDefinition }], // C?Parameters defined by the library
    "dataRequirement" : [{ DataRequirement }] // C?What data is referenced by this library
    "content" : [{ Attachment }], // C?Contents of the library, either embedded or referenced
  }

 

Alternate definitions: Master Definition (XML, JSON), Schematron

14.14.12.2.2 Terminology Bindings

PathNameConformanceValueSet
Library.languageCommon LanguagespreferredCommon Languages
Library.statusPublicationStatusrequiredPublicationStatus
Library.typeLibraryTypeextensibleLibraryType
Library.subject[x]Subject typeextensibleSubject type
Library.jurisdictionJurisdictionextensibleJurisdiction
Library.topicDefinitionTopicexampleDefinitionTopic
.