Logical Model Publishable

<?xml version="1.0" encoding="UTF-8"?>

<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="Publishable"/> 
  <text> 
    <status value="generated"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">to do</div> 
  </text> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
    <valueCode value="informative"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="fhir"/> 
  </extension> 
  <url value="http://hl7.org/fhir/StructureDefinition/Publishable"/> 
  <version value="6.0.0-cibuild"/> 
  <name value="Publishable"/> 
  <title value="publishable"/> 
  <status value="draft"/> 
  <experimental value="false"/> 
  <date value="2024-05-14T21:17:27+00:00"/> 
  <publisher value="HL7 International / FHIR Infrastructure"/> 
  <contact> 
    <telecom> 
      <system value="url"/> 
      <value value="http://hl7.org/fhir"/> 
    </telecom> 
  </contact> 
  <contact> 
    <telecom> 
      <system value="url"/> 
      <value value="http://www.hl7.org/Special/committees/fiwg"/> 
    </telecom> 
  </contact> 
  <description value="Logical Model: A pattern to be followed by resources that represent a publishable
   knowledge artifact such as a ValueSet, Profile, Library, Decision Support Rule,
   or Quality Measure."/> 
  <jurisdiction> 
    <coding> 
      <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/> 
      <code value="001"/> 
      <display value="World"/> 
    </coding> 
  </jurisdiction> 
  <purpose value="The Publishable pattern is defined to ensure that artifacts have enough metadata
   to understand when, where, and why a particular artifact would be used, as well
   as who contributed to it, who reviewed or endorsed it, and what evidence supports
   its use. The pattern is about ensuring artifacts can establish trust and credibility,
   as well as carry enough metadata to be discoverable in a public repository or artifact
   catalog."/> 
  <fhirVersion value="6.0.0-cibuild"/> 
  <kind value="logical"/> 
  <abstract value="false"/> 
  <type value="Publishable"/> 
  <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Base"/> 
  <snapshot> 
    <element id="Publishable">
      <path value="Publishable"/> 
      <short value="Publishable Pattern"/> 
      <definition value="A pattern to be followed by resources that represent a publishable knowledge artifact
       such as a ValueSet, Profile, Library, Decision Support Rule, or Quality Measure."/> 
      <comment value="The Publishable pattern builds on the Shareable pattern and establishes the expectations
       for publication and distribution of an artifact as part of an artifact repository."/> 
      <min value="0"/> 
      <max value="*"/> 
      <base> 
        <path value="Publishable"/> 
        <min value="0"/> 
        <max value="*"/> 
      </base> 
      <constraint> 
        <key value="ele-1"/> 
        <severity value="error"/> 
        <human value="All FHIR elements must have a @value or children"/> 
        <expression value="hasValue() or (children().count() &gt; id.count())"/> 
        <source value="http://hl7.org/fhir/StructureDefinition/Element"/> 
      </constraint> 
      <isModifier value="false"/> 
      <isSummary value="false"/> 
    </element> 
    <element id="Publishable.identifier">
      <path value="Publishable.identifier"/> 
      <short value="Additional identifier for the {{title}}"/> 
      <definition value="A formal identifier that is used to identify this {{title}} when it is represented
       in other formats, or referenced in a specification, model, design or an instance."/> 
      <comment value="Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier)
       data type, and can then identify this {{title}} outside of FHIR, where it is not
       possible to use the logical URI."/> 
      <requirements value="Allows externally provided and/or usable business identifiers to be easily associated
       with the module."/> 
      <min value="0"/> 
      <max value="*"/> 
      <base> 
        <path value="Publishable.identifier"/> 
        <min value="0"/> 
        <max value="*"/> 
      </base> 
      <type> 
        <code value="Identifier"/> 
      </type> 
      <constraint> 
        <key value="ele-1"/> 
        <severity value="error"/> 
        <human value="All FHIR elements must have a @value or children"/> 
        <expression value="hasValue() or (children().count() &gt; id.count())"/> 
        <source value="http://hl7.org/fhir/StructureDefinition/Element"/> 
      </constraint> 
      <isModifier value="false"/> 
      <isSummary value="true"/> 
    </element> 
    <element id="Publishable.date">
      <path value="Publishable.date"/> 
      <short value="Date last changed"/> 
      <definition value="The date  (and optionally time) when the {{title}} was last significantly changed.
       The date must change when the business version changes and it must change if the
       status code changes. In addition, it should change when the substantive content
       of the {{title}} changes."/> 
      <comment value="The date is often not tracked until the resource is published, but may be present
       on draft content. Note that this is not the same as the resource last-modified-date,
       since the resource may be a secondary representation of the {{title}}. Additional
       specific dates may be added as extensions or be found by consulting Provenances
       associated with past versions of the resource."/> 
      <alias value="revision date"/> 
      <min value="1"/> 
      <max value="1"/> 
      <base> 
        <path value="Publishable.date"/> 
        <min value="1"/> 
        <max value="1"/> 
      </base> 
      <type> 
        <code value="dateTime"/> 
      </type> 
      <constraint> 
        <key value="ele-1"/> 
        <severity value="error"/> 
        <human value="All FHIR elements must have a @value or children"/> 
        <expression value="hasValue() or (children().count() &gt; id.count())"/> 
        <source value="http://hl7.org/fhir/StructureDefinition/Element"/> 
      </constraint> 
      <isModifier value="false"/> 
      <isSummary value="true"/> 
    </element> 
    <element id="Publishable.contact">
      <path value="Publishable.contact"/> 
      <short value="Contact details for the publisher"/> 
      <definition value="Contact details to assist a user in finding and communicating with the publisher."/> 
      <comment value="May be a web site, an email address, a telephone number, etc."/> 
      <min value="0"/> 
      <max value="*"/> 
      <base> 
        <path value="Publishable.contact"/> 
        <min value="0"/> 
        <max value="*"/> 
      </base> 
      <type> 
        <code value="ContactDetail"/> 
      </type> 
      <constraint> 
        <key value="ele-1"/> 
        <severity value="error"/> 
        <human value="All FHIR elements must have a @value or children"/> 
        <expression value="hasValue() or (children().count() &gt; id.count())"/> 
        <source value="http://hl7.org/fhir/StructureDefinition/Element"/> 
      </constraint> 
      <isModifier value="false"/> 
      <isSummary value="true"/> 
    </element> 
    <element id="Publishable.useContext">
      <path value="Publishable.useContext"/> 
      <short value="The context that the content is intended to support"/> 
      <definition value="The content was developed with a focus and intent of supporting the contexts that
       are listed. These contexts may be general categories (gender, age, ...) or may
       be references to specific programs (insurance plans, studies, ...) and may be used
       to assist with indexing and searching for appropriate {{title}} instances."/> 
      <comment value="When multiple useContexts are specified, there is no expectation that all or any
       of the contexts apply."/> 
      <requirements value="Assist in searching for appropriate content."/> 
      <min value="0"/> 
      <max value="*"/> 
      <base> 
        <path value="Publishable.useContext"/> 
        <min value="0"/> 
        <max value="*"/> 
      </base> 
      <type> 
        <code value="UsageContext"/> 
      </type> 
      <constraint> 
        <key value="ele-1"/> 
        <severity value="error"/> 
        <human value="All FHIR elements must have a @value or children"/> 
        <expression value="hasValue() or (children().count() &gt; id.count())"/> 
        <source value="http://hl7.org/fhir/StructureDefinition/Element"/> 
      </constraint> 
      <isModifier value="false"/> 
      <isSummary value="true"/> 
    </element> 
    <element id="Publishable.jurisdiction">
      <path value="Publishable.jurisdiction"/> 
      <short value="Intended jurisdiction for {{title}} (if applicable)"/> 
      <definition value="A legal or geographic region in which the {{title}} is intended to be used."/> 
      <comment value="It may be possible for the {{title}} to be used in jurisdictions other than those
       for which it was originally designed or intended."/> 
      <min value="0"/> 
      <max value="*"/> 
      <base> 
        <path value="Publishable.jurisdiction"/> 
        <min value="0"/> 
        <max value="*"/> 
      </base> 
      <type> 
        <code value="CodeableConcept"/> 
      </type> 
      <constraint> 
        <key value="ele-1"/> 
        <severity value="error"/> 
        <human value="All FHIR elements must have a @value or children"/> 
        <expression value="hasValue() or (children().count() &gt; id.count())"/> 
        <source value="http://hl7.org/fhir/StructureDefinition/Element"/> 
      </constraint> 
      <isModifier value="false"/> 
      <isSummary value="true"/> 
      <binding> 
        <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
          <valueString value="Jurisdiction"/> 
        </extension> 
        <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding">
          <valueBoolean value="true"/> 
        </extension> 
        <strength value="required"/> 
        <description value="Countries and regions within which this artifact is targeted for use."/> 
        <valueSet value="http://hl7.org/fhir/ValueSet/jurisdiction|6.0.0-cibuild"/> 
      </binding> 
    </element> 
    <element id="Publishable.purpose">
      <path value="Publishable.purpose"/> 
      <short value="Why this {{title}} is defined"/> 
      <definition value="Explanation of why this {{title}} is needed and why it has been designed as it
       has."/> 
      <comment value="This element does not describe the usage of the {{title}}. Instead, it provides
       traceability of ''why'' the resource is either needed or ''why'' it is defined
       as it is.  This may be used to point to source materials or specifications that
       drove the structure of this {{title}}."/> 
      <min value="0"/> 
      <max value="1"/> 
      <base> 
        <path value="Publishable.purpose"/> 
        <min value="0"/> 
        <max value="1"/> 
      </base> 
      <type> 
        <code value="markdown"/> 
      </type> 
      <constraint> 
        <key value="ele-1"/> 
        <severity value="error"/> 
        <human value="All FHIR elements must have a @value or children"/> 
        <expression value="hasValue() or (children().count() &gt; id.count())"/> 
        <source value="http://hl7.org/fhir/StructureDefinition/Element"/> 
      </constraint> 
      <isModifier value="false"/> 
      <isSummary value="false"/> 
    </element> 
    <element id="Publishable.copyright">
      <path value="Publishable.copyright"/> 
      <short value="Use and/or publishing restrictions"/> 
      <definition value="A copyright statement relating to the {{title}} and/or its contents. Copyright
       statements are generally legal restrictions on the use and publishing of the {{title}}."/> 
      <requirements value="Consumers must be able to determine any legal restrictions on the use of the {{title}}
       and/or its content."/> 
      <alias value="license"/> 
      <alias value="restrictions"/> 
      <min value="0"/> 
      <max value="1"/> 
      <base> 
        <path value="Publishable.copyright"/> 
        <min value="0"/> 
        <max value="1"/> 
      </base> 
      <type> 
        <code value="markdown"/> 
      </type> 
      <constraint> 
        <key value="ele-1"/> 
        <severity value="error"/> 
        <human value="All FHIR elements must have a @value or children"/> 
        <expression value="hasValue() or (children().count() &gt; id.count())"/> 
        <source value="http://hl7.org/fhir/StructureDefinition/Element"/> 
      </constraint> 
      <isModifier value="false"/> 
      <isSummary value="false"/> 
    </element> 
    <element id="Publishable.copyrightLabel">
      <path value="Publishable.copyrightLabel"/> 
      <short value="Copyright holder and year(s)"/> 
      <definition value="A short string (&lt;50 characters), suitable for inclusion in a page footer that
       identifies the copyright holder, effective period, and optionally whether rights
       are resctricted. (e.g. 'All rights reserved', 'Some rights reserved')."/> 
      <comment value="The (c) symbol should NOT be included in this string. It will be added by software
       when rendering the notation. Full details about licensing, restrictions, warrantees,
       etc. goes in the more general 'copyright' element."/> 
      <requirements value="Defines the content expected to be rendered in all representations of the artifact."/> 
      <min value="0"/> 
      <max value="1"/> 
      <base> 
        <path value="Publishable.copyrightLabel"/> 
        <min value="0"/> 
        <max value="1"/> 
      </base> 
      <type> 
        <code value="string"/> 
      </type> 
      <constraint> 
        <key value="ele-1"/> 
        <severity value="error"/> 
        <human value="All FHIR elements must have a @value or children"/> 
        <expression value="hasValue() or (children().count() &gt; id.count())"/> 
        <source value="http://hl7.org/fhir/StructureDefinition/Element"/> 
      </constraint> 
      <isModifier value="false"/> 
      <isSummary value="false"/> 
    </element> 
    <element id="Publishable.approvalDate">
      <path value="Publishable.approvalDate"/> 
      <short value="When the {{title}} was approved by publisher"/> 
      <definition value="The date on which the resource content was approved by the publisher. Approval
       happens once when the content is officially approved for usage."/> 
      <comment value="The 'date' element may be more recent than the approval date because of minor changes
       or editorial corrections."/> 
      <min value="0"/> 
      <max value="1"/> 
      <base> 
        <path value="Publishable.approvalDate"/> 
        <min value="0"/> 
        <max value="1"/> 
      </base> 
      <type> 
        <code value="date"/> 
      </type> 
      <constraint> 
        <key value="ele-1"/> 
        <severity value="error"/> 
        <human value="All FHIR elements must have a @value or children"/> 
        <expression value="hasValue() or (children().count() &gt; id.count())"/> 
        <source value="http://hl7.org/fhir/StructureDefinition/Element"/> 
      </constraint> 
      <isModifier value="false"/> 
      <isSummary value="false"/> 
    </element> 
    <element id="Publishable.lastReviewDate">
      <path value="Publishable.lastReviewDate"/> 
      <short value="When the {{title}} was last reviewed"/> 
      <definition value="The date on which the resource content was last reviewed. Review happens periodically
       after approval but does not change the original approval date."/> 
      <comment value="If specified, this date follows the original approval date."/> 
      <requirements value="Gives a sense of how &quot;current&quot; the content is.  Resources that have not
       been reviewed in a long time may have a risk of being less appropriate/relevant."/> 
      <min value="0"/> 
      <max value="1"/> 
      <base> 
        <path value="Publishable.lastReviewDate"/> 
        <min value="0"/> 
        <max value="1"/> 
      </base> 
      <type> 
        <code value="date"/> 
      </type> 
      <constraint> 
        <key value="ele-1"/> 
        <severity value="error"/> 
        <human value="All FHIR elements must have a @value or children"/> 
        <expression value="hasValue() or (children().count() &gt; id.count())"/> 
        <source value="http://hl7.org/fhir/StructureDefinition/Element"/> 
      </constraint> 
      <isModifier value="false"/> 
      <isSummary value="false"/> 
    </element> 
    <element id="Publishable.effectivePeriod">
      <path value="Publishable.effectivePeriod"/> 
      <short value="When the {{title}} is expected to be used"/> 
      <definition value="The period during which the {{title}} content was or is planned to be in active
       use."/> 
      <comment value="The effective period for a {{title}}  determines when the content is applicable
       for usage and is independent of publication and review dates. For example, a measure
       intended to be used for the year 2016 might be published in 2015."/> 
      <requirements value="Allows establishing a transition before a resource comes into effect and also allows
       for a sunsetting  process when new versions of the {{title}} are or are expected
       to be used instead."/> 
      <min value="0"/> 
      <max value="1"/> 
      <base> 
        <path value="Publishable.effectivePeriod"/> 
        <min value="0"/> 
        <max value="1"/> 
      </base> 
      <type> 
        <code value="Period"/> 
      </type> 
      <constraint> 
        <key value="ele-1"/> 
        <severity value="error"/> 
        <human value="All FHIR elements must have a @value or children"/> 
        <expression value="hasValue() or (children().count() &gt; id.count())"/> 
        <source value="http://hl7.org/fhir/StructureDefinition/Element"/> 
      </constraint> 
      <isModifier value="false"/> 
      <isSummary value="true"/> 
    </element> 
    <element id="Publishable.topic">
      <path value="Publishable.topic"/> 
      <short value="E.g. Education, Treatment, Assessment, etc."/> 
      <definition value="Descriptive topics related to the content of the library. Topics provide a high-level
       categorization of the library that can be useful for filtering and searching."/> 
      <comment value="This element provides a topical categorization of the {{title}}, as opposed to
       the more structured context-of-use information provided in the useContext element."/> 
      <requirements value="Repositories must be able to determine how to categorize the {{title}} so that
       it can be found by topical searches."/> 
      <min value="0"/> 
      <max value="*"/> 
      <base> 
        <path value="Publishable.topic"/> 
        <min value="0"/> 
        <max value="*"/> 
      </base> 
      <type> 
        <code value="CodeableConcept"/> 
      </type> 
      <constraint> 
        <key value="ele-1"/> 
        <severity value="error"/> 
        <human value="All FHIR elements must have a @value or children"/> 
        <expression value="hasValue() or (children().count() &gt; id.count())"/> 
        <source value="http://hl7.org/fhir/StructureDefinition/Element"/> 
      </constraint> 
      <isModifier value="false"/> 
      <isSummary value="false"/> 
      <binding> 
        <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
          <valueString value="DefinitionTopic"/> 
        </extension> 
        <strength value="example"/> 
        <description value="Topics associated with the artifact"/> 
        <valueSet value="http://hl7.org/fhir/ValueSet/definition-topic"/> 
      </binding> 
    </element> 
    <element id="Publishable.author">
      <path value="Publishable.author"/> 
      <short value="Who authored the {{title}}"/> 
      <definition value="An individiual or organization primarily involved in the creation and maintenance
       of the {{title}}."/> 
      <min value="0"/> 
      <max value="*"/> 
      <base> 
        <path value="Publishable.author"/> 
        <min value="0"/> 
        <max value="*"/> 
      </base> 
      <type> 
        <code value="ContactDetail"/> 
      </type> 
      <constraint> 
        <key value="ele-1"/> 
        <severity value="error"/> 
        <human value="All FHIR elements must have a @value or children"/> 
        <expression value="hasValue() or (children().count() &gt; id.count())"/> 
        <source value="http://hl7.org/fhir/StructureDefinition/Element"/> 
      </constraint> 
      <isModifier value="false"/> 
      <isSummary value="false"/> 
    </element> 
    <element id="Publishable.editor">
      <path value="Publishable.editor"/> 
      <short value="Who edited the {{title}}"/> 
      <definition value="An individual or organization primarily responsible for internal coherence of the
       {{title}}."/> 
      <min value="0"/> 
      <max value="*"/> 
      <base> 
        <path value="Publishable.editor"/> 
        <min value="0"/> 
        <max value="*"/> 
      </base> 
      <type> 
        <code value="ContactDetail"/> 
      </type> 
      <constraint> 
        <key value="ele-1"/> 
        <severity value="error"/> 
        <human value="All FHIR elements must have a @value or children"/> 
        <expression value="hasValue() or (children().count() &gt; id.count())"/> 
        <source value="http://hl7.org/fhir/StructureDefinition/Element"/> 
      </constraint> 
      <isModifier value="false"/> 
      <isSummary value="false"/> 
    </element> 
    <element id="Publishable.reviewer">
      <path value="Publishable.reviewer"/> 
      <short value="Who reviewed the {{title}}"/> 
      <definition value="An individual or organization asserted by the publisher to be primarily responsible
       for review of some aspect of the {{title}}."/> 
      <min value="0"/> 
      <max value="*"/> 
      <base> 
        <path value="Publishable.reviewer"/> 
        <min value="0"/> 
        <max value="*"/> 
      </base> 
      <type> 
        <code value="ContactDetail"/> 
      </type> 
      <constraint> 
        <key value="ele-1"/> 
        <severity value="error"/> 
        <human value="All FHIR elements must have a @value or children"/> 
        <expression value="hasValue() or (children().count() &gt; id.count())"/> 
        <source value="http://hl7.org/fhir/StructureDefinition/Element"/> 
      </constraint> 
      <isModifier value="false"/> 
      <isSummary value="false"/> 
    </element> 
    <element id="Publishable.endorser">
      <path value="Publishable.endorser"/> 
      <short value="Who endorsed the {{title}}"/> 
      <definition value="An individual or organization asserted by the publisher to be responsible for officially
       endorsing the {{title}} for use in some setting."/> 
      <min value="0"/> 
      <max value="*"/> 
      <base> 
        <path value="Publishable.endorser"/> 
        <min value="0"/> 
        <max value="*"/> 
      </base> 
      <type> 
        <code value="ContactDetail"/> 
      </type> 
      <constraint> 
        <key value="ele-1"/> 
        <severity value="error"/> 
        <human value="All FHIR elements must have a @value or children"/> 
        <expression value="hasValue() or (children().count() &gt; id.count())"/> 
        <source value="http://hl7.org/fhir/StructureDefinition/Element"/> 
      </constraint> 
      <isModifier value="false"/> 
      <isSummary value="false"/> 
    </element> 
    <element id="Publishable.relatedArtifact">
      <path value="Publishable.relatedArtifact"/> 
      <short value="Additional documentation, citations, etc."/> 
      <definition value="Related artifacts such as additional documentation, justification, dependencies,
       bibliographic references, and predecessor and successor artifacts."/> 
      <comment value="Each related artifact is either an attachment, or a reference to another resource,
       but not both."/> 
      <requirements value="A {{title}} must be able to provide enough information for consumers of the content
       (and/or interventions or results produced by the content) to be able to determine
       and understand the justification for and evidence in support of the content."/> 
      <min value="0"/> 
      <max value="*"/> 
      <base> 
        <path value="Publishable.relatedArtifact"/> 
        <min value="0"/> 
        <max value="*"/> 
      </base> 
      <type> 
        <code value="RelatedArtifact"/> 
      </type> 
      <constraint> 
        <key value="ele-1"/> 
        <severity value="error"/> 
        <human value="All FHIR elements must have a @value or children"/> 
        <expression value="hasValue() or (children().count() &gt; id.count())"/> 
        <source value="http://hl7.org/fhir/StructureDefinition/Element"/> 
      </constraint> 
      <isModifier value="false"/> 
      <isSummary value="false"/> 
    </element> 
  </snapshot> 
</StructureDefinition>