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 Publishable pattern.
Publishable | |
Definition | 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. |
Short Display | Publishable Pattern |
Cardinality | 0..* |
Type | Shareable |
Requirements | 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. |
Comments | 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. |
Publishable.identifier | |
Definition | 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. |
Short Display | Additional identifier for the {{title}} |
Note | This is a business identifier, not a resource identifier (see discussion) |
Cardinality | 0..* |
Type | Identifier |
Requirements | Allows externally provided and/or usable business identifiers to be easily associated with the module. |
Summary | true |
Comments | 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. |
Publishable.date | |
Definition | 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. |
Short Display | Date last changed |
Cardinality | 1..1 |
Type | dateTime |
Alternate Names | revision date |
Summary | true |
Comments | 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. |
Publishable.contact | |
Definition | Contact details to assist a user in finding and communicating with the publisher. |
Short Display | Contact details for the publisher |
Cardinality | 0..* |
Type | ContactDetail |
Summary | true |
Comments | May be a web site, an email address, a telephone number, etc. |
Publishable.useContext | |
Definition | 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. |
Short Display | The context that the content is intended to support |
Cardinality | 0..* |
Type | UsageContext |
Requirements | Assist in searching for appropriate content. |
Summary | true |
Comments | When multiple useContexts are specified, there is no expectation that all or any of the contexts apply. |
Publishable.jurisdiction | |
Definition | A legal or geographic region in which the {{title}} is intended to be used. |
Short Display | Intended jurisdiction for {{title}} (if applicable) |
Cardinality | 0..* |
Terminology Binding | Jurisdiction ValueSet (Required) |
Type | CodeableConcept |
Summary | true |
Comments | It may be possible for the {{title}} to be used in jurisdictions other than those for which it was originally designed or intended. |
Publishable.purpose | |
Definition | Explanation of why this {{title}} is needed and why it has been designed as it has. |
Short Display | Why this {{title}} is defined |
Cardinality | 0..1 |
Type | markdown |
Comments | 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}}. |
Publishable.copyright | |
Definition | 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}}. |
Short Display | Use and/or publishing restrictions |
Cardinality | 0..1 |
Type | markdown |
Requirements | Consumers must be able to determine any legal restrictions on the use of the {{title}} and/or its content. |
Alternate Names | license; restrictions |
Publishable.copyrightLabel | |
Definition | 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. (e.g. 'All rights reserved', 'Some rights reserved'). |
Short Display | Copyright holder and year(s) |
Cardinality | 0..1 |
Type | string |
Requirements | Defines the content expected to be rendered in all representations of the artifact. |
Comments | 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. |
Publishable.approvalDate | |
Definition | The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. |
Short Display | When the {{title}} was approved by publisher |
Cardinality | 0..1 |
Type | date |
Comments | The 'date' element may be more recent than the approval date because of minor changes or editorial corrections. |
Publishable.lastReviewDate | |
Definition | The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. |
Short Display | When the {{title}} was last reviewed |
Cardinality | 0..1 |
Type | date |
Requirements | Gives a sense of how "current" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant. |
Comments | If specified, this date follows the original approval date. |
Publishable.effectivePeriod | |
Definition | The period during which the {{title}} content was or is planned to be in active use. |
Short Display | When the {{title}} is expected to be used |
Cardinality | 0..1 |
Type | Period |
Requirements | 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. |
Summary | true |
Comments | 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. |
Publishable.topic | |
Definition | 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. |
Short Display | E.g. Education, Treatment, Assessment, etc. |
Cardinality | 0..* |
Terminology Binding | Definition Topic (Example) |
Type | CodeableConcept |
Requirements | Repositories must be able to determine how to categorize the {{title}} so that it can be found by topical searches. |
Comments | This element provides a topical categorization of the {{title}}, as opposed to the more structured context-of-use information provided in the useContext element. |
Publishable.author | |
Definition | An individiual or organization primarily involved in the creation and maintenance of the {{title}}. |
Short Display | Who authored the {{title}} |
Cardinality | 0..* |
Type | ContactDetail |
Publishable.editor | |
Definition | An individual or organization primarily responsible for internal coherence of the {{title}}. |
Short Display | Who edited the {{title}} |
Cardinality | 0..* |
Type | ContactDetail |
Publishable.reviewer | |
Definition | An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the {{title}}. |
Short Display | Who reviewed the {{title}} |
Cardinality | 0..* |
Type | ContactDetail |
Publishable.endorser | |
Definition | An individual or organization asserted by the publisher to be responsible for officially endorsing the {{title}} for use in some setting. |
Short Display | Who endorsed the {{title}} |
Cardinality | 0..* |
Type | ContactDetail |
Publishable.relatedArtifact | |
Definition | Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts. |
Short Display | Additional documentation, citations, etc. |
Cardinality | 0..* |
Type | RelatedArtifact |
Requirements | 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. |
Comments | Each related artifact is either an attachment, or a reference to another resource, but not both. |