This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions
FHIR Infrastructure | Maturity Level: 1 | 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.
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:
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 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.
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:
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.
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.
No references for this Pattern.
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
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 |
useContext | Σ | 0..* | UsageContext | The context that the content is intended to support |
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for {{title}} (if applicable) Binding: Jurisdiction ValueSet (Required) |
purpose | 0..1 | markdown | Why this {{title}} is defined | |
copyright | 0..1 | markdown | Use and/or publishing restrictions | |
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. | |
Documentation for this format |
UML Diagram (Legend)
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
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 |
useContext | Σ | 0..* | UsageContext | The context that the content is intended to support |
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for {{title}} (if applicable) Binding: Jurisdiction ValueSet (Required) |
purpose | 0..1 | markdown | Why this {{title}} is defined | |
copyright | 0..1 | markdown | Use and/or publishing restrictions | |
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. | |
Documentation for this format |
Alternate definitions: Master Definition XML + JSON.
Path | ValueSet | Type | Documentation |
---|---|---|---|
Publishable.jurisdiction | JurisdictionValueSet | 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 while the codes for "supra-national" regions are from UN Standard country or area codes for statistical use (M49) . |
Publishable.topic | DefinitionTopic | Example | High-level categorization of the definition, used for searching, sorting, and filtering. |
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.
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:
Flags: