Release 5 FHIR CI-Build

This page is part of the Continuous Integration Build of FHIR Specification (v5.0.0: R5 - STU ). This is the current published version in it's permanent home (it will always (will be available incorrect/inconsistent at this URL). For a full list of available versions, see times).
See the Directory of published versions icon

14.3.2 17.3.2 Pattern Publishable - Content

Maturity Level : 1
Responsible Owner: FHIR Infrastructure icon Informative

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.

14.3.2.1 17.3.2.1 Scope and Usage

This is NOT a resource. It is not part of the FHIR schema and cannot appear directly in FHIR instances. It is a logical model that defines a pattern adhered to by other resources (or profiles of those resources). This pattern serves two purposes:

  • It offers guidance to work groups designing resources and helps ensure consistency of content created by different work groups
  • It provides a standard "view" that might be useful for implementers in processing and manipulating all resources that adhere to the same pattern. (Tooling that supports this may become available in a future release.)

For knowledge artifacts, a "publishable" artifact defines the expectations for publication and distribution of an artifact, typically as part of an artifact repository. 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. All "publishable" artifacts are also "shareable". This pattern is intended to apply to Canonical Resources such as ValueSet, CodeSystem, StructureDefinition, Library, and so on.

Note that this pattern is a profile pattern in that it is intended to serve as a model for defining Publishable profiles of knowledge artifact resources, and that all Publishable profiles should be derived from a Shareable profile of the same resource.

Note that the Canonical Resource Management Infrastructure icon implementation guide includes general guidance for the Shareable, Publishable, Computable, and Executable content patterns. The profiles in the CRMI have the same URL as the equivalent profiles in this specification, the intent being to use the CRMI profiles to continue maturing the patterns and related profiles, with the ultimate goal of including the matured profiles in a future FHIR publication. Applications making use of the Shareable and Publishable patterns should use the profiles defined in the CRMI.

14.3.2.2 17.3.2.2 Boundaries and Relationships

The publishable pattern is one of four common content management patterns that introduce knowledge capabilities to support separation of concerns across the content management and consumption lifecycle:

  • Shareable : Shareable profiles set the minimum expectations for reliably exchanging an artifact in public repositories, including the URL, version, name, and publisher.
  • Computable : Computable profiles deal with authoring and design-time considerations, describing the minimum expectations for exchanging a machine-readable representation of an artifact. At a minimum, a computable artifact is one that does not have only human-readable content.
  • Publishable : Publishable profiles describe the expectations for publication and distribution of an artifact, typically as part of an artifact repository.
  • Executable : Executable profiles deal with run-time behavior and implementation considerations. For example, an executable library may contain compiled content that can be directly executed by an engine. At a minimum, an executable artifact is guaranteed to have all the elements required to support at least one operation appropriate to the type of artifact.

A given artifact may provide all knowledge capabilities (Shareable plus Computable, Publishable, and Executable), or it may be focused on a particular capability. For example, a ValueSet may be only Shareable and Executable because it is intended for use in environments without access to a terminology service capable of expanding the Computable value set.

14.3.2.3 17.3.2.3 Background and Context

This model represents a pattern. It provides a standard list of data elements with cardinalities, data types, definitions, rationale and usage notes that will ideally be adhered to by resources that describe "knowledge artifacts" such as value sets, profiles, decision support rules, and quality measures. However, adherence to this pattern is not mandatory. Not all healthcare domains are the same. Concepts that may be generally applicable (and thus are included in this standard pattern) might still not be relevant everywhere or may be sufficiently uncommon that they are more appropriate to include as extensions than as core properties of the resource. Work groups are encouraged to adjust descriptions, usage notes and rationale to be specific to their resource.

14.3.2.4 17.3.2.4 References to this Pattern

No references for this Pattern.

14.3.2.5 17.3.2.5 Pattern Content

Structure

Use and/or publishing
Name Flags Card. Type Description & Constraints      Filter: Filters doco
. . Publishable I Shareable Publishable Pattern

Elements defined in Ancestors: url , version , versionAlgorithm[x] , name , title , status , experimental , publisher , description , knowledgeRepresentationLevel
. . . identifier Σ 0..* Identifier Additional identifier for the {{title}}

. . . date Σ 1..1 dateTime Date last changed
. . . contact Σ 0..* ContactDetail Contact details for the publisher

. . . jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for {{title}} (if applicable)
Binding: Jurisdiction ValueSet icon ( Required )

. . . purpose 0..1 markdown Why this {{title}} is defined
. . . copyright 0..1 markdown Notice about intellectual property ownership, can include restrictions on use
. . . copyrightLabel 0..1 string Copyright holder and year(s)
. . . approvalDate 0..1 date When the {{title}} was approved by publisher
. . . lastReviewDate 0..1 date When the {{title}} was last reviewed
. . . effectivePeriod Σ 0..1 Period When the {{title}} is expected to be used
. . . topic 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
Binding: Definition Topic ( Example )

. . . author 0..* ContactDetail Who authored the {{title}}

. . . editor 0..* ContactDetail Who edited the {{title}}

. . . reviewer 0..* ContactDetail Who reviewed the {{title}}

. . . endorser 0..* ContactDetail Who endorsed the {{title}}

. . . relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc.


doco Documentation for this format icon

UML Diagram ( Legend )

Publishable ( Shareable ) 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 identifier : Identifier [0..*] 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 date : dateTime [1..1] Contact details to assist a user in finding and communicating with the publisher contact : ContactDetail [0..*] 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 useContext : UsageContext [0..*] A legal or geographic region in which the {{title}} is intended to be used jurisdiction : CodeableConcept [0..*] « (Strength=Required) JurisdictionValueSet ! » Explanation of why this {{title}} is needed and why it has been designed as it has purpose : markdown [0..1] A copyright statement relating to the {{title}} and/or its contents. Copyright statements are generally legal notices of intellectual property ownership and can include restrictions on the use and publishing of the {{title}} copyright : markdown [0..1] A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. restricted. (e.g. 'All rights reserved', 'Some rights reserved') copyrightLabel : string [0..1] The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage approvalDate : date [0..1] The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date lastReviewDate : date [0..1] The period during which the {{title}} content was or is planned to be in active use effectivePeriod : Period [0..1] 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 topic : CodeableConcept [0..*] « (Strength=Example) DefinitionTopic ?? » An individiual or organization primarily involved in the creation and maintenance of the {{title}} author : ContactDetail [0..*] An individual or organization primarily responsible for internal coherence of the {{title}} editor : ContactDetail [0..*] An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the {{title}} reviewer : ContactDetail [0..*] An individual or organization asserted by the publisher to be responsible for officially endorsing the {{title}} for use in some setting endorser : ContactDetail [0..*] Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts relatedArtifact : RelatedArtifact [0..*]

Structure

Use and/or publishing
Name Flags Card. Type Description & Constraints      Filter: Filters doco
. . Publishable I Shareable Publishable Pattern

Elements defined in Ancestors: url , version , versionAlgorithm[x] , name , title , status , experimental , publisher , description , knowledgeRepresentationLevel
. . . identifier Σ 0..* Identifier Additional identifier for the {{title}}

. . . date Σ 1..1 dateTime Date last changed
. . . contact Σ 0..* ContactDetail Contact details for the publisher

. . . jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for {{title}} (if applicable)
Binding: Jurisdiction ValueSet icon ( Required )

. . . purpose 0..1 markdown Why this {{title}} is defined
. . . copyright 0..1 markdown Notice about intellectual property ownership, can include restrictions on use
. . . copyrightLabel 0..1 string Copyright holder and year(s)
. . . approvalDate 0..1 date When the {{title}} was approved by publisher
. . . lastReviewDate 0..1 date When the {{title}} was last reviewed
. . . effectivePeriod Σ 0..1 Period When the {{title}} is expected to be used
. . . topic 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
Binding: Definition Topic ( Example )

. . . author 0..* ContactDetail Who authored the {{title}}

. . . editor 0..* ContactDetail Who edited the {{title}}

. . . reviewer 0..* ContactDetail Who reviewed the {{title}}

. . . endorser 0..* ContactDetail Who endorsed the {{title}}

. . . relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc.


doco Documentation for this format icon

UML Diagram ( Legend )

Publishable ( Shareable ) 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 identifier : Identifier [0..*] 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 date : dateTime [1..1] Contact details to assist a user in finding and communicating with the publisher contact : ContactDetail [0..*] 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 useContext : UsageContext [0..*] A legal or geographic region in which the {{title}} is intended to be used jurisdiction : CodeableConcept [0..*] « (Strength=Required) JurisdictionValueSet ! » Explanation of why this {{title}} is needed and why it has been designed as it has purpose : markdown [0..1] A copyright statement relating to the {{title}} and/or its contents. Copyright statements are generally legal notices of intellectual property ownership and can include restrictions on the use and publishing of the {{title}} copyright : markdown [0..1] A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. restricted. (e.g. 'All rights reserved', 'Some rights reserved') copyrightLabel : string [0..1] The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage approvalDate : date [0..1] The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date lastReviewDate : date [0..1] The period during which the {{title}} content was or is planned to be in active use effectivePeriod : Period [0..1] 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 topic : CodeableConcept [0..*] « (Strength=Example) DefinitionTopic ?? » An individiual or organization primarily involved in the creation and maintenance of the {{title}} author : ContactDetail [0..*] An individual or organization primarily responsible for internal coherence of the {{title}} editor : ContactDetail [0..*] An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the {{title}} reviewer : ContactDetail [0..*] An individual or organization asserted by the publisher to be responsible for officially endorsing the {{title}} for use in some setting endorser : ContactDetail [0..*] Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts relatedArtifact : RelatedArtifact [0..*]

 

Alternate definitions: Master Definition XML + JSON .

14.3.2.5.1 17.3.2.5.1 Terminology Bindings

Path ValueSet Type Documentation
Publishable.jurisdiction JurisdictionValueSet icon Required

This value set defines a base set of codes for country, country subdivision and region for indicating where a resource is intended to be used.

Note: The codes for countries and country subdivisions are taken from ISO 3166 icon while the codes for "supra-national" regions are from UN Standard country or area codes for statistical use (M49) icon .

Publishable.topic DefinitionTopic Example

High-level categorization of the definition, used for searching, sorting, and filtering.

14.3.2.6 17.3.2.6 Extensions

Not all resources that follow the 'Publishable' pattern will necessarily include all of the above elements. A set of standard extensions have been defined for use with resources where an element might be "applicable" but is not commonly supported. A list of these can be found on the Artifact Extensions page.

14.3.2.6.1 17.3.2.7 Mappings

identifier date contact useContext jurisdiction purpose copyright copyrightLabel approvalDate lastReviewDate effectivePeriod topic author editor reviewer endorser relatedArtifact

Each non-grey cell contains a number, the number of elements and extensions (if > 0) mapped in the resource that are mapped to the pattern element in the column. If there are 0 elements and extensions, the number is not shown. In addition, the cell has a color and some character flags.

Colors:

  • Grey: the resource has no element or extension for the pattern element
  • White: the resource has an element that implements the pattern element with the same name
  • Yellow: the resource has a documented extension that implements the pattern element with the same name
  • Blue: the resource has an element that implements the pattern element with a different name
  • Red: the resource has an element that implements that pattern element, but the type or cardinality does not match

Flags:

  • E: pattern element implemented by an extension
  • N: pattern element implemented by an element with a different name
  • T: pattern element implemented by an element with a different type
  • C: pattern element implemented by an element with a different cardinality