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 canonical resources that meet minimal requirements for sharing via registries or similar mechanisms.
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 "shareable" artifact defines the minimum expectations for knowledge artifact resources to be shared between authoring, publishing, and implementation systems. This pattern is intended to apply to Canonical Resources such as ValueSet, CodeSystem, StructureDefinition, Library, and so on. The pattern is defined to ensure that an artifact has enough metadata to make sharing it through a public repository reliable.
Note that this pattern is a profile pattern in that it is intended to serve as a model for defining Shareable profiles of knowledge artifact resources.
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 shareable pattern is one of four common content management patterns that describe 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 |
---|---|---|---|---|
Shareable | I | Logical | Shareable Pattern | |
url | Σ | 1..1 | uri | Canonical identifier for this {{title}}, represented as a URI (globally unique) |
version | Σ | 1..1 | string | Business version of the {{title}} |
versionAlgorithm[x] | Σ | 0..1 | How to compare versions Binding: Version Algorithm (Extensible) | |
versionAlgorithmString | string | |||
versionAlgorithmCoding | Coding | |||
name | Σ | 0..1 | string | Name for this {{title}} (computer friendly) |
title | Σ | 1..1 | string | Name for this {{title}} (human-friendly) |
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (Required) |
experimental | Σ | 0..1 | boolean | For testing purposes, not real usage |
publisher | Σ | 0..1 | string | Name of the publisher (or steward) (organization or individual) |
description | 1..1 | markdown | Natural language description of the {{title}} | |
knowledgeRepresentationLevel | 0..* | CodeableConcept | narrative | semi-structured | structured | executable Binding: Knowledge Representation Level (Required) | |
Documentation for this format |
UML Diagram (Legend)
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Shareable | I | Logical | Shareable Pattern | |
url | Σ | 1..1 | uri | Canonical identifier for this {{title}}, represented as a URI (globally unique) |
version | Σ | 1..1 | string | Business version of the {{title}} |
versionAlgorithm[x] | Σ | 0..1 | How to compare versions Binding: Version Algorithm (Extensible) | |
versionAlgorithmString | string | |||
versionAlgorithmCoding | Coding | |||
name | Σ | 0..1 | string | Name for this {{title}} (computer friendly) |
title | Σ | 1..1 | string | Name for this {{title}} (human-friendly) |
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (Required) |
experimental | Σ | 0..1 | boolean | For testing purposes, not real usage |
publisher | Σ | 0..1 | string | Name of the publisher (or steward) (organization or individual) |
description | 1..1 | markdown | Natural language description of the {{title}} | |
knowledgeRepresentationLevel | 0..* | CodeableConcept | narrative | semi-structured | structured | executable Binding: Knowledge Representation Level (Required) | |
Documentation for this format |
Alternate definitions: Master Definition XML + JSON.
Path | ValueSet | Type | Documentation |
---|---|---|---|
Shareable.versionAlgorithm[x] | VersionAlgorithm | Extensible | Indicates the mechanism used to compare versions to determine which is more current. |
Shareable.status | PublicationStatus | Required | The lifecycle status of an artifact. |
Shareable.knowledgeRepresentationLevel | KnowledgeRepresentationLevel | Required | A knowledge representation level, narrative, semi-structured, structured, and executable |
Not all resources that follow the 'Shareable' 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.
url | version | versionAlgorithm[x] | name | title | status | experimental | publisher | description | knowledgeRepresentationLevel |
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: