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 |
Detailed Descriptions for the elements in the Shareable pattern.
Shareable | |
Definition | A pattern to be followed by canonical resources that meet minimal requirements for sharing via registries or similar mechanisms. |
Short Display | Shareable Pattern |
Cardinality | 0..* |
Type | Logical |
Requirements | The intent of this pattern is to ensure that artifacts have enough metadata to make sharing them through a public repository reliable. |
Comments | The Shareable pattern establishes the minimum expectations for exchanging an artifact, including the URL, version, name, and publisher. Knowledge artifact resources would typically define a Shareable profile based on this pattern, rather than adopting the constraints directly on the resource. |
Shareable.url | |
Definition | An absolute URI that is used to identify this {{title}} when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this {{title}} is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the {{title}} is stored on different servers. |
Short Display | Canonical identifier for this {{title}}, represented as a URI (globally unique) |
Cardinality | 1..1 |
Type | uri |
Requirements | Allows the {{title}} to be referenced by a single globally unique identifier. |
Summary | true |
Comments | Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions. In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found. |
Shareable.version | |
Definition | The identifier that is used to identify this version of the {{title}} when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the {{title}} author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. |
Short Display | Business version of the {{title}} |
Note | This is a business versionId, not a resource version id (see discussion) |
Cardinality | 1..1 |
Type | string |
Summary | true |
Comments | There may be different {{title}} instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the {{title}} with the format [url]|[version]. The version SHOULD NOT contain a '#' - see Business Version. |
Shareable.versionAlgorithm[x] | |
Definition | Indicates the mechanism used to compare versions to determine which is more current. |
Short Display | How to compare versions |
Cardinality | 0..1 |
Terminology Binding | Version Algorithm (Extensible) |
Type | string|Coding |
[x] Note | See Choice of Datatypes for further information about how to use [x] |
Summary | true |
Comments | If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. |
Shareable.name | |
Definition | A natural language name identifying the {{title}}. This name should be usable as an identifier for the module by machine processing applications such as code generation. |
Short Display | Name for this {{title}} (computer friendly) |
Cardinality | 0..1 |
Type | string |
Requirements | Support human navigation and code generation. |
Summary | true |
Comments | The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly. |
Shareable.title | |
Definition | A short, descriptive, user-friendly title for the {{title}}. |
Short Display | Name for this {{title}} (human-friendly) |
Cardinality | 1..1 |
Type | string |
Summary | true |
Comments | This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. |
Shareable.status | |
Definition | The status of this {{title}}. Enables tracking the life-cycle of the content. |
Short Display | draft | active | retired | unknown |
Cardinality | 1..1 |
Terminology Binding | PublicationStatus (Required) |
Type | code |
Is Modifier | true (Reason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration) |
Requirements | Allows filtering of {{title}}s that are appropriate for use versus not. |
Summary | true |
Shareable.experimental | |
Definition | A Boolean value to indicate that this {{title}} is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. |
Short Display | For testing purposes, not real usage |
Cardinality | 0..1 |
Type | boolean |
Meaning if Missing | If experimental is not specified, the artifact is assumed NOT to be experimental |
Requirements | Enables experimental content to be developed following the same lifecycle that would be used for a production-level {{title}}. Allows filtering of {{title}}s that are appropriate for use versus not. |
Summary | true |
Shareable.publisher | |
Definition | The name of the organization or individual that published (or stewards) the {{title}}. |
Short Display | Name of the publisher (or steward) (organization or individual) |
Cardinality | 0..1 |
Type | string |
Requirements | Helps establish the "authority/credibility" of the {{title}}. May also allow for contact. |
Alternate Names | steward |
Summary | true |
Comments | Usually an organization but may be an individual. The publisher (or steward) of the {{title}} is the organization or individual primarily responsible for the maintenance and upkeep of the {{title}}. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the {{title}}. This item SHOULD be populated unless the information is available from context. |
Shareable.description | |
Definition | A free text natural language description of the {{title}} from a consumer's perspective. |
Short Display | Natural language description of the {{title}} |
Cardinality | 1..1 |
Type | markdown |
Comments | This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the {{title}} as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the {{title}} is presumed to be the predominant language in the place the {{title}} was created). |
Shareable.knowledgeRepresentationLevel | |
Definition | Captures the general knowledge representation level of knowledge provided by this artifact. |
Short Display | narrative | semi-structured | structured | executable |
Cardinality | 0..* |
Terminology Binding | Knowledge Representation Level (Required) |
Type | CodeableConcept |
Comments | Knowledge representation level provides consumers with a general overview of the level(s) of knowledge representation afforded by a knowledge artifact, narrative, semi-structured, structured, and executable. |