Snapshot 3: Connectathon 32 Base

This page is part of the FHIR Specification (v5.0.0-snapshot3: R5 Snapshot #3, to support Connectathon 32). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

14.15.13.7 StructureDefinition: PublishableLibrary

Clinical Decision Support icon Work Group Maturity Level: 0Trial Use Use Context: Country: World, Country: World

The canonical URL for this profile is: 

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

Supports declaration of the library metadata required by HL7 and other organizations that share and publish libraries with a focus on the aspects of that metadata that are important for post-publication activities including distribution, inclusion in repositories, consumption, and implementation.

This profile was published on Thu, Jan 1, 1970 00:00+1000 as a draft by HL7.

14.15.13.7.1 Formal Views of Profile Content

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

This structure is derived from ShareableLibrary.

Summary

Mandatory: 3 elements
Must-Support: 12 elements

Extensions

This structure refers to these extensions:

This indicates the differences between this profile and the base ShareableLibrary structure.

Name iconFlags iconCard. iconType iconDescription & Constraints icondoco icon
.. Library 1..1ShareableLibraryRepresents a library of quality improvement components
... logicDefinition S0..*(Complex)A logic definition used in the artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
... title S1..1stringName for this library (human friendly)
... type 1..1CodeableConceptlogic-library | model-definition | asset-collection | module-definition
... purpose 0..1markdownWhy this library is defined
... usage 0..1stringDescribes the clinical usage of the library
... copyright S0..1markdownUse and/or publishing restrictions
... approvalDate S0..1dateWhen the library was approved by publisher
... lastReviewDate S0..1dateWhen the library was last reviewed
... effectivePeriod S0..1PeriodWhen the library is expected to be used
... topic 0..*CodeableConceptE.g. Education, Treatment, Assessment, etc.
Binding: DefinitionTopic (preferred): Topics for categorization and searching of artifacts

... author 0..*ContactDetailWho authored the content
... editor 0..*ContactDetailWho edited the content
... reviewer 0..*ContactDetailWho reviewed the content
... endorser 0..*ContactDetailWho endorsed the content
... relatedArtifact S0..*RelatedArtifactAdditional documentation, citations, etc.
.... display S0..1stringBrief description of the related artifact
.... document S0..1AttachmentWhat document is being referenced
.... resource S0..1canonical(Resource)What artifact is being referenced
.... resourceReference S0..1Reference(Resource)What artifact, if not a conformance resource

doco Documentation for this format icon

This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base ShareableLibrary structure.

Name iconFlags iconCard. iconType iconDescription & Constraints icondoco icon
.. Library C icon1..1ShareableLibraryRepresents a library of quality improvement components
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (preferred): IETF language tag

Additional BindingsPurpose
All LanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... knowledgeCapability S0..*codeshareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: Knowledge Capability (required)
... knowledgeRepresentationLevel S0..*codenarrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel
Binding: Knowledge Representation Level (required)
... artifactComment S0..*(Complex)Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
... logicDefinition S0..*(Complex)A logic definition used in the artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... url ΣC icon1..1uriCanonical identifier for this library, represented as a URI (globally unique)
... identifier SΣ0..*IdentifierAdditional identifier for the library
... version Σ1..1stringBusiness version of the library
... name ΣC icon1..1stringName for this library (computer friendly)
... title SΣ1..1stringName for this library (human friendly)
... subtitle 0..1stringSubordinate title of the library
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ1..1booleanFor testing purposes, not real usage
... type Σ1..1CodeableConceptlogic-library | model-definition | asset-collection | module-definition
Binding: LibraryType (extensible): The type of knowledge asset this library contains.

... subject[x] 0..1Type of individual the library content is focused on
Binding: Participant Resource Types (extensible): The possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.).

.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group)
... date SΣ1..1dateTimeDate last changed
... publisher Σ1..1stringName of the publisher/steward (organization or individual)
... contact SΣ0..*ContactDetailContact details for the publisher
... description Σ1..1markdownNatural language description of the library
... useContext SΣ0..*UsageContextThe context that the content is intended to support
... jurisdiction SΣ0..*CodeableConceptIntended jurisdiction for library (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose 0..1markdownWhy this library is defined
... usage 0..1stringDescribes the clinical usage of the library
... copyright S0..1markdownUse and/or publishing restrictions
... approvalDate S0..1dateWhen the library was approved by publisher
... lastReviewDate S0..1dateWhen the library was last reviewed
... effectivePeriod SΣ0..1PeriodWhen the library is expected to be used
... topic 0..*CodeableConceptE.g. Education, Treatment, Assessment, etc.
Binding: DefinitionTopic (preferred): Topics for categorization and searching of artifacts


... author 0..*ContactDetailWho authored the content
... editor 0..*ContactDetailWho edited the content
... reviewer 0..*ContactDetailWho reviewed the content
... endorser 0..*ContactDetailWho endorsed the content
... relatedArtifact S0..*RelatedArtifactAdditional documentation, citations, etc.
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... type Σ1..1codedocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as
Binding: RelatedArtifactType (required)
.... classifier Σ0..*CodeableConceptAdditional classifiers
Binding: CitationArtifactClassifier (example)
.... label Σ0..1stringShort label
.... display SΣ0..1stringBrief description of the related artifact
.... citation Σ0..1markdownBibliographic citation for the artifact
.... document SΣ0..1AttachmentWhat document is being referenced
.... resource SΣ0..1canonical(Resource)What artifact is being referenced
.... resourceReference SΣ0..1Reference(Resource)What artifact, if not a conformance resource
.... publicationStatus Σ0..1codedraft | active | retired | unknown
Binding: PublicationStatus (required)
.... publicationDate Σ0..1dateDate of publication of the artifact being referred to
... parameter 0..*ParameterDefinitionParameters defined by the library
... dataRequirement 0..*DataRequirementWhat data is referenced by this library
... content Σ0..*AttachmentContents of the library, either embedded or referenced

doco Documentation for this format icon
<!-- PublishableLibrary -->doco

<Library xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->
 <meta><!-- I 0..1 Meta Metadata about the resource --></meta>
 <implicitRules value="[uri]"/><!-- I 0..1 A set of rules under which this content was created -->
 <language value="[code]"/><!-- I 0..1 Language of the resource content   -->
 <text><!-- I 0..1 Narrative 
     Text summary of the resource, for human interpretation --></text>
 <contained><!-- 0..* Resource Contained, inline Resources --></contained>
 <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <url value="[uri]"/><!-- I 1..1 Canonical identifier for this library, represented as a URI (globally unique) -->
 <identifier><!-- I 0..* Identifier Additional identifier for the library --></identifier>
 <version value="[string]"/><!-- I 1..1 Business version of the library -->
 <name value="[string]"/><!-- I 1..1 Name for this library (computer friendly) -->
 <title value="[string]"/><!-- I 1..1 Name for this library (human friendly) -->
 <subtitle value="[string]"/><!-- I 0..1 Subordinate title of the library -->
 <status value="[code]"/><!-- I 1..1 draft | active | retired | unknown   -->
 <experimental value="[boolean]"/><!-- I 1..1 For testing purposes, not real usage -->
 <type><!-- I 1..1 CodeableConcept logic-library | model-definition | asset-collection | module-definition   --></type>
 <subject[x]><!-- I 0..1 CodeableConcept|Reference(Group) Type of individual the library content is focused on   --></subject[x]>
 <date value="[dateTime]"/><!-- I 1..1 Date last changed -->
 <publisher value="[string]"/><!-- I 1..1 Name of the publisher/steward (organization or individual) -->
 <contact><!-- I 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- I 1..1 Natural language description of the library -->
 <useContext><!-- I 0..* UsageContext 
     The context that the content is intended to support --></useContext>
 <jurisdiction><!-- I 0..* CodeableConcept Intended jurisdiction for library (if applicable)   --></jurisdiction>
 <purpose value="[markdown]"/><!-- I 0..1 Why this library is defined -->
 <usage value="[string]"/><!-- I 0..1 Describes the clinical usage of the library -->
 <copyright value="[markdown]"/><!-- I 0..1 Use and/or publishing restrictions -->
 <approvalDate value="[date]"/><!-- I 0..1 When the library was approved by publisher -->
 <lastReviewDate value="[date]"/><!-- I 0..1 When the library was last reviewed -->
 <effectivePeriod><!-- I 0..1 Period 
     When the library is expected to be used --></effectivePeriod>
 <topic><!-- I 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.   --></topic>
 <author><!-- I 0..* ContactDetail Who authored the content --></author>
 <editor><!-- I 0..* ContactDetail Who edited the content --></editor>
 <reviewer><!-- I 0..* ContactDetail Who reviewed the content --></reviewer>
 <endorser><!-- I 0..* ContactDetail Who endorsed the content --></endorser>
 <relatedArtifact> I 0..* RelatedArtifact  <!-- I 0..* Additional documentation, citations, etc. -->
  <type value="[code]"/><!-- I 1..1 documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as   -->
  <classifier><!-- I 0..* CodeableConcept Additional classifiers   --></classifier>
  <label value="[string]"/><!-- I 0..1 Short label -->
  <display value="[string]"/><!-- I 0..1 Brief description of the related artifact -->
  <citation value="[markdown]"/><!-- I 0..1 Bibliographic citation for the artifact -->
  <document><!-- I 0..1 Attachment 
      What document is being referenced --></document>
  <resource value="[canonical]"/><!-- I 0..1 What artifact is being referenced -->
  <resourceReference><!-- I 0..1 Reference(Resource) 
      What artifact, if not a conformance resource --></resourceReference>
  <publicationStatus value="[code]"/><!-- I 0..1 draft | active | retired | unknown   -->
  <publicationDate value="[date]"/><!-- I 0..1 Date of publication of the artifact being referred to -->
 </relatedArtifact>
 <parameter><!-- I 0..* ParameterDefinition 
     Parameters defined by the library --></parameter>
 <dataRequirement><!-- I 0..* DataRequirement 
     What data is referenced by this library --></dataRequirement>
 <content><!-- I 0..* Attachment 
     Contents of the library, either embedded or referenced --></content>
</Library>

{ // PublishableLibrary
  // from Element: extension
    "meta" : { Meta }, // IMetadata about the resource
    "implicitRules" : "<uri>", // IA set of rules under which this content was created
    "language" : "<code>", // ILanguage of the resource content
    "text" : { Narrative }, // IText summary of the resource, for human interpretation
    "contained" : [{ Resource }], //Contained, inline Resources
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // shareable | computable | publishable | executable // I
        // from Element: extension
      },
      { // narrative | semi-structured | structured | executable // I
        // from Element: extension
      },
      { // Additional documentation, review, or usage guidance // I
        // from Element: extension
      },
      { // A logic definition used in the artifact // I
        // from Element: extension
      }
    ],
    "modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored
    "url" : "<uri>", // I R! Canonical identifier for this library, represented as a URI (globally unique)
    "identifier" : [{ Identifier }], // IAdditional identifier for the library
    "version" : "<string>", // I R! Business version of the library
    "name" : "<string>", // I R! Name for this library (computer friendly)
    "title" : "<string>", // I R! Name for this library (human friendly)
    "subtitle" : "<string>", // ISubordinate title of the library
    "status" : "<code>", // I R! draft | active | retired | unknown
    "experimental" : <boolean>, // I R! For testing purposes, not real usage
    "type" : { CodeableConcept }, // I 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 }, // IType of individual the library content is focused on
    "subjectReference" : { Reference(Group) }, // IType of individual the library content is focused on
    "date" : "<dateTime>", // I R! Date last changed
    "publisher" : "<string>", // I R! Name of the publisher/steward (organization or individual)
    "contact" : [{ ContactDetail }], // IContact details for the publisher
    "description" : "<markdown>", // I R! Natural language description of the library
    "useContext" : [{ UsageContext }], // IThe context that the content is intended to support
    "jurisdiction" : [{ CodeableConcept }], // IIntended jurisdiction for library (if applicable)
    "purpose" : "<markdown>", // IWhy this library is defined
    "usage" : "<string>", // IDescribes the clinical usage of the library
    "copyright" : "<markdown>", // IUse and/or publishing restrictions
    "approvalDate" : "<date>", // IWhen the library was approved by publisher
    "lastReviewDate" : "<date>", // IWhen the library was last reviewed
    "effectivePeriod" : { Period }, // IWhen the library is expected to be used
    "topic" : [{ CodeableConcept }], // IE.g. Education, Treatment, Assessment, etc.
    "author" : [{ ContactDetail }], // IWho authored the content
    "editor" : [{ ContactDetail }], // IWho edited the content
    "reviewer" : [{ ContactDetail }], // IWho reviewed the content
    "endorser" : [{ ContactDetail }], // IWho endorsed the content
    "relatedArtifact" : [{ RelatedArtifact }], // IAdditional documentation, citations, etc.
    "parameter" : [{ ParameterDefinition }], // IParameters defined by the library
    "dataRequirement" : [{ DataRequirement }], // IWhat data is referenced by this library
    "content" : [{ Attachment }], // IContents of the library, either embedded or referenced
  }

This structure is derived from ShareableLibrary.

Summary

Mandatory: 3 elements
Must-Support: 12 elements

Extensions

This structure refers to these extensions:

Differential View

This indicates the differences between this profile and the base ShareableLibrary structure.

Name iconFlags iconCard. iconType iconDescription & Constraints icondoco icon
.. Library 1..1ShareableLibraryRepresents a library of quality improvement components
... logicDefinition S0..*(Complex)A logic definition used in the artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
... title S1..1stringName for this library (human friendly)
... type 1..1CodeableConceptlogic-library | model-definition | asset-collection | module-definition
... purpose 0..1markdownWhy this library is defined
... usage 0..1stringDescribes the clinical usage of the library
... copyright S0..1markdownUse and/or publishing restrictions
... approvalDate S0..1dateWhen the library was approved by publisher
... lastReviewDate S0..1dateWhen the library was last reviewed
... effectivePeriod S0..1PeriodWhen the library is expected to be used
... topic 0..*CodeableConceptE.g. Education, Treatment, Assessment, etc.
Binding: DefinitionTopic (preferred): Topics for categorization and searching of artifacts

... author 0..*ContactDetailWho authored the content
... editor 0..*ContactDetailWho edited the content
... reviewer 0..*ContactDetailWho reviewed the content
... endorser 0..*ContactDetailWho endorsed the content
... relatedArtifact S0..*RelatedArtifactAdditional documentation, citations, etc.
.... display S0..1stringBrief description of the related artifact
.... document S0..1AttachmentWhat document is being referenced
.... resource S0..1canonical(Resource)What artifact is being referenced
.... resourceReference S0..1Reference(Resource)What artifact, if not a conformance resource

doco Documentation for this format icon

Snapshot View

This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base ShareableLibrary structure.

Name iconFlags iconCard. iconType iconDescription & Constraints icondoco icon
.. Library C icon1..1ShareableLibraryRepresents a library of quality improvement components
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (preferred): IETF language tag

Additional BindingsPurpose
All LanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... knowledgeCapability S0..*codeshareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: Knowledge Capability (required)
... knowledgeRepresentationLevel S0..*codenarrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel
Binding: Knowledge Representation Level (required)
... artifactComment S0..*(Complex)Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
... logicDefinition S0..*(Complex)A logic definition used in the artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... url ΣC icon1..1uriCanonical identifier for this library, represented as a URI (globally unique)
... identifier SΣ0..*IdentifierAdditional identifier for the library
... version Σ1..1stringBusiness version of the library
... name ΣC icon1..1stringName for this library (computer friendly)
... title SΣ1..1stringName for this library (human friendly)
... subtitle 0..1stringSubordinate title of the library
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ1..1booleanFor testing purposes, not real usage
... type Σ1..1CodeableConceptlogic-library | model-definition | asset-collection | module-definition
Binding: LibraryType (extensible): The type of knowledge asset this library contains.

... subject[x] 0..1Type of individual the library content is focused on
Binding: Participant Resource Types (extensible): The possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.).

.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group)
... date SΣ1..1dateTimeDate last changed
... publisher Σ1..1stringName of the publisher/steward (organization or individual)
... contact SΣ0..*ContactDetailContact details for the publisher
... description Σ1..1markdownNatural language description of the library
... useContext SΣ0..*UsageContextThe context that the content is intended to support
... jurisdiction SΣ0..*CodeableConceptIntended jurisdiction for library (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose 0..1markdownWhy this library is defined
... usage 0..1stringDescribes the clinical usage of the library
... copyright S0..1markdownUse and/or publishing restrictions
... approvalDate S0..1dateWhen the library was approved by publisher
... lastReviewDate S0..1dateWhen the library was last reviewed
... effectivePeriod SΣ0..1PeriodWhen the library is expected to be used
... topic 0..*CodeableConceptE.g. Education, Treatment, Assessment, etc.
Binding: DefinitionTopic (preferred): Topics for categorization and searching of artifacts


... author 0..*ContactDetailWho authored the content
... editor 0..*ContactDetailWho edited the content
... reviewer 0..*ContactDetailWho reviewed the content
... endorser 0..*ContactDetailWho endorsed the content
... relatedArtifact S0..*RelatedArtifactAdditional documentation, citations, etc.
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... type Σ1..1codedocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as
Binding: RelatedArtifactType (required)
.... classifier Σ0..*CodeableConceptAdditional classifiers
Binding: CitationArtifactClassifier (example)
.... label Σ0..1stringShort label
.... display SΣ0..1stringBrief description of the related artifact
.... citation Σ0..1markdownBibliographic citation for the artifact
.... document SΣ0..1AttachmentWhat document is being referenced
.... resource SΣ0..1canonical(Resource)What artifact is being referenced
.... resourceReference SΣ0..1Reference(Resource)What artifact, if not a conformance resource
.... publicationStatus Σ0..1codedraft | active | retired | unknown
Binding: PublicationStatus (required)
.... publicationDate Σ0..1dateDate of publication of the artifact being referred to
... parameter 0..*ParameterDefinitionParameters defined by the library
... dataRequirement 0..*DataRequirementWhat data is referenced by this library
... content Σ0..*AttachmentContents of the library, either embedded or referenced

doco Documentation for this format icon

XML Template

<!-- PublishableLibrary -->doco

<Library xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->
 <meta><!-- I 0..1 Meta Metadata about the resource --></meta>
 <implicitRules value="[uri]"/><!-- I 0..1 A set of rules under which this content was created -->
 <language value="[code]"/><!-- I 0..1 Language of the resource content   -->
 <text><!-- I 0..1 Narrative 
     Text summary of the resource, for human interpretation --></text>
 <contained><!-- 0..* Resource Contained, inline Resources --></contained>
 <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <url value="[uri]"/><!-- I 1..1 Canonical identifier for this library, represented as a URI (globally unique) -->
 <identifier><!-- I 0..* Identifier Additional identifier for the library --></identifier>
 <version value="[string]"/><!-- I 1..1 Business version of the library -->
 <name value="[string]"/><!-- I 1..1 Name for this library (computer friendly) -->
 <title value="[string]"/><!-- I 1..1 Name for this library (human friendly) -->
 <subtitle value="[string]"/><!-- I 0..1 Subordinate title of the library -->
 <status value="[code]"/><!-- I 1..1 draft | active | retired | unknown   -->
 <experimental value="[boolean]"/><!-- I 1..1 For testing purposes, not real usage -->
 <type><!-- I 1..1 CodeableConcept logic-library | model-definition | asset-collection | module-definition   --></type>
 <subject[x]><!-- I 0..1 CodeableConcept|Reference(Group) Type of individual the library content is focused on   --></subject[x]>
 <date value="[dateTime]"/><!-- I 1..1 Date last changed -->
 <publisher value="[string]"/><!-- I 1..1 Name of the publisher/steward (organization or individual) -->
 <contact><!-- I 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- I 1..1 Natural language description of the library -->
 <useContext><!-- I 0..* UsageContext 
     The context that the content is intended to support --></useContext>
 <jurisdiction><!-- I 0..* CodeableConcept Intended jurisdiction for library (if applicable)   --></jurisdiction>
 <purpose value="[markdown]"/><!-- I 0..1 Why this library is defined -->
 <usage value="[string]"/><!-- I 0..1 Describes the clinical usage of the library -->
 <copyright value="[markdown]"/><!-- I 0..1 Use and/or publishing restrictions -->
 <approvalDate value="[date]"/><!-- I 0..1 When the library was approved by publisher -->
 <lastReviewDate value="[date]"/><!-- I 0..1 When the library was last reviewed -->
 <effectivePeriod><!-- I 0..1 Period 
     When the library is expected to be used --></effectivePeriod>
 <topic><!-- I 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.   --></topic>
 <author><!-- I 0..* ContactDetail Who authored the content --></author>
 <editor><!-- I 0..* ContactDetail Who edited the content --></editor>
 <reviewer><!-- I 0..* ContactDetail Who reviewed the content --></reviewer>
 <endorser><!-- I 0..* ContactDetail Who endorsed the content --></endorser>
 <relatedArtifact> I 0..* RelatedArtifact  <!-- I 0..* Additional documentation, citations, etc. -->
  <type value="[code]"/><!-- I 1..1 documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as   -->
  <classifier><!-- I 0..* CodeableConcept Additional classifiers   --></classifier>
  <label value="[string]"/><!-- I 0..1 Short label -->
  <display value="[string]"/><!-- I 0..1 Brief description of the related artifact -->
  <citation value="[markdown]"/><!-- I 0..1 Bibliographic citation for the artifact -->
  <document><!-- I 0..1 Attachment 
      What document is being referenced --></document>
  <resource value="[canonical]"/><!-- I 0..1 What artifact is being referenced -->
  <resourceReference><!-- I 0..1 Reference(Resource) 
      What artifact, if not a conformance resource --></resourceReference>
  <publicationStatus value="[code]"/><!-- I 0..1 draft | active | retired | unknown   -->
  <publicationDate value="[date]"/><!-- I 0..1 Date of publication of the artifact being referred to -->
 </relatedArtifact>
 <parameter><!-- I 0..* ParameterDefinition 
     Parameters defined by the library --></parameter>
 <dataRequirement><!-- I 0..* DataRequirement 
     What data is referenced by this library --></dataRequirement>
 <content><!-- I 0..* Attachment 
     Contents of the library, either embedded or referenced --></content>
</Library>

JSON Template

{ // PublishableLibrary
  // from Element: extension
    "meta" : { Meta }, // IMetadata about the resource
    "implicitRules" : "<uri>", // IA set of rules under which this content was created
    "language" : "<code>", // ILanguage of the resource content
    "text" : { Narrative }, // IText summary of the resource, for human interpretation
    "contained" : [{ Resource }], //Contained, inline Resources
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // shareable | computable | publishable | executable // I
        // from Element: extension
      },
      { // narrative | semi-structured | structured | executable // I
        // from Element: extension
      },
      { // Additional documentation, review, or usage guidance // I
        // from Element: extension
      },
      { // A logic definition used in the artifact // I
        // from Element: extension
      }
    ],
    "modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored
    "url" : "<uri>", // I R! Canonical identifier for this library, represented as a URI (globally unique)
    "identifier" : [{ Identifier }], // IAdditional identifier for the library
    "version" : "<string>", // I R! Business version of the library
    "name" : "<string>", // I R! Name for this library (computer friendly)
    "title" : "<string>", // I R! Name for this library (human friendly)
    "subtitle" : "<string>", // ISubordinate title of the library
    "status" : "<code>", // I R! draft | active | retired | unknown
    "experimental" : <boolean>, // I R! For testing purposes, not real usage
    "type" : { CodeableConcept }, // I 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 }, // IType of individual the library content is focused on
    "subjectReference" : { Reference(Group) }, // IType of individual the library content is focused on
    "date" : "<dateTime>", // I R! Date last changed
    "publisher" : "<string>", // I R! Name of the publisher/steward (organization or individual)
    "contact" : [{ ContactDetail }], // IContact details for the publisher
    "description" : "<markdown>", // I R! Natural language description of the library
    "useContext" : [{ UsageContext }], // IThe context that the content is intended to support
    "jurisdiction" : [{ CodeableConcept }], // IIntended jurisdiction for library (if applicable)
    "purpose" : "<markdown>", // IWhy this library is defined
    "usage" : "<string>", // IDescribes the clinical usage of the library
    "copyright" : "<markdown>", // IUse and/or publishing restrictions
    "approvalDate" : "<date>", // IWhen the library was approved by publisher
    "lastReviewDate" : "<date>", // IWhen the library was last reviewed
    "effectivePeriod" : { Period }, // IWhen the library is expected to be used
    "topic" : [{ CodeableConcept }], // IE.g. Education, Treatment, Assessment, etc.
    "author" : [{ ContactDetail }], // IWho authored the content
    "editor" : [{ ContactDetail }], // IWho edited the content
    "reviewer" : [{ ContactDetail }], // IWho reviewed the content
    "endorser" : [{ ContactDetail }], // IWho endorsed the content
    "relatedArtifact" : [{ RelatedArtifact }], // IAdditional documentation, citations, etc.
    "parameter" : [{ ParameterDefinition }], // IParameters defined by the library
    "dataRequirement" : [{ DataRequirement }], // IWhat data is referenced by this library
    "content" : [{ Attachment }], // IContents of the library, either embedded or referenced
  }

 

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

14.15.13.7.2 Terminology Bindings

PathNameConformanceValueSet
Library.languageCommon LanguagespreferredCommon Languages
Library.statusPublicationStatusrequiredPublicationStatus
Library.typeLibraryTypeextensibleLibraryType
Library.subject[x]Participant Resource TypesextensibleParticipant Resource Types
Library.jurisdictionJurisdiction ValueSetextensibleJurisdiction ValueSet
Library.topicDefinitionTopicpreferredDefinitionTopic
Library.relatedArtifact.typeRelatedArtifactTyperequiredRelatedArtifactType
Library.relatedArtifact.classifierCitationArtifactClassifierexampleCitationArtifactClassifier
Library.relatedArtifact.publicationStatusPublicationStatusrequiredPublicationStatus
.