This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version. For a full list of available versions, see the Directory of published versions
http://www.hl7.org/Special/committees/fiwg/index.cfm | Maturity Level: N | Normative (from v4.2.0) | Compartments: No defined compartments |
Detailed Descriptions for the elements in the CanonicalResource Resource.
CanonicalResource | |||||||||
Definition | Common Interface declaration for conformance and knowledge artifact resources. | ||||||||
Short Display | Common Interface declaration for definitional resources | ||||||||
Cardinality | 0..* | ||||||||
Type | DomainResource | ||||||||
Summary | false | ||||||||
Invariants |
| ||||||||
CanonicalResource.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 an absolute URI (globally unique) | ||||||||
Cardinality | 0..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. | ||||||||
Invariants |
| ||||||||
CanonicalResource.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 {{title}}. | ||||||||
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. | ||||||||
CanonicalResource.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 without additional knowledge. (See the versionAlgorithm element.) | ||||||||
Short Display | Business version of the {{title}} | ||||||||
Note | This is a business versionId, not a resource version id (see discussion) | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Summary | true | ||||||||
Comments | There may be different {{title}}s that have the same url 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. | ||||||||
CanonicalResource.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. | ||||||||
CanonicalResource.name | |||||||||
Definition | A natural language name identifying the {{title}}. This name should be usable as an identifier for the resource by machine processing applications such as code generation. | ||||||||
Short Display | Name for this {{title}} (computer friendly) | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Requirements | Supports code generation. | ||||||||
Summary | true | ||||||||
Comments | The name is not expected to be globally unique. The name should be a simple alphanumeric type no-whitespace name to ensure that it is machine-processing friendly. | ||||||||
Invariants |
| ||||||||
CanonicalResource.title | |||||||||
Definition | A short, descriptive, user-friendly title for the {{title}}. | ||||||||
Short Display | Name for this {{title}} (human friendly) | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Summary | true | ||||||||
Comments | This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. | ||||||||
CanonicalResource.status | |||||||||
Definition | The current state of this {{title}}. | ||||||||
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 | Enables tracking the life-cycle of the content and filtering of {{title}}s that are appropriate for use versus not. | ||||||||
Summary | true | ||||||||
Comments | A nominal state-transition diagram can be found in the Definition pattern documentation. Unknown does not represent 'other' - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is. See guidance around (not) making local changes to elements here. | ||||||||
CanonicalResource.experimental | |||||||||
Definition | A Boolean value to indicate that this {{title}} is authored for testing purposes (or education/evaluation/marketing) and is not intended for genuine usage. | ||||||||
Short Display | For testing purposes, not real usage | ||||||||
Cardinality | 0..1 | ||||||||
Type | boolean | ||||||||
Meaning if Missing | If absent, this resource is treated as though it is not experimental. | ||||||||
Requirements | Enables experimental content to be developed following the same lifecycle that would be used for a production-level {{title}}. | ||||||||
Summary | true | ||||||||
Comments | Allows filtering of {{title}}s that are appropriate for use versus not. | ||||||||
CanonicalResource.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 | 0..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. See guidance around (not) making local changes to elements here. | ||||||||
CanonicalResource.publisher | |||||||||
Definition | The name of the organization or individual responsible for the release and ongoing maintenance of the {{title}}. | ||||||||
Short Display | Name of the publisher/steward (organization or individual) | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Requirements | Helps establish the "authority/credibility" of the {{title}}. May also allow for contact. | ||||||||
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. | ||||||||
CanonicalResource.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. See guidance around (not) making local changes to elements here. | ||||||||
CanonicalResource.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 | 0..1 | ||||||||
Type | markdown | ||||||||
Summary | false | ||||||||
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. | ||||||||
CanonicalResource.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}}s. | ||||||||
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 even any of the contexts apply. | ||||||||
CanonicalResource.jurisdiction | |||||||||
Standards Status | This element has a standards status of "Deprecated" which is different from the status of the whole resource | ||||||||
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 (Extensible) | ||||||||
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. DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) | ||||||||
CanonicalResource.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 | ||||||||
Summary | false | ||||||||
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}}. | ||||||||
CanonicalResource.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 | ||||||||
Summary | false | ||||||||
Comments | The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element. | ||||||||
CanonicalResource.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. | ||||||||
Summary | false | ||||||||
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. |