Publish-box (todo)
Clinical Decision Support Work Group | Maturity Level: 0 | Trial Use | Use Context: Country: World |
Definitions for the cqllibrary Profile.
Library | |||||||||||||
Element Id | Library | ||||||||||||
Definition | The Library resource is a general-purpose container for knowledge asset definitions. It can be used to describe and expose existing knowledge assets such as logic libraries and information model descriptions, as well as to describe a collection of knowledge assets. | ||||||||||||
Short Display | Represents a library of quality improvement components | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Invariants |
| ||||||||||||
Library.id | |||||||||||||
Element Id | Library.id | ||||||||||||
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||||||||||
Short Display | Logical id of this artifact | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | id | ||||||||||||
Comments | Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case. | ||||||||||||
Library.meta | |||||||||||||
Element Id | Library.meta | ||||||||||||
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | ||||||||||||
Short Display | Metadata about the resource | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | Meta | ||||||||||||
Invariants |
| ||||||||||||
Library.implicitRules | |||||||||||||
Element Id | Library.implicitRules | ||||||||||||
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | ||||||||||||
Short Display | A set of rules under which this content was created | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | uri | ||||||||||||
Is Modifier | true (Reason: This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation) | ||||||||||||
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc. | ||||||||||||
Invariants |
| ||||||||||||
Library.language | |||||||||||||
Element Id | Library.language | ||||||||||||
Definition | The base language in which the resource is written. | ||||||||||||
Short Display | Language of the resource content | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Terminology Binding | IETF language tag for a human language The codes SHALL be taken from All Languages | ||||||||||||
Type | code | ||||||||||||
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). | ||||||||||||
Invariants |
| ||||||||||||
Library.text | |||||||||||||
Element Id | Library.text | ||||||||||||
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | ||||||||||||
Short Display | Text summary of the resource, for human interpretation | ||||||||||||
Cardinality | 0..1 This element is affected by the following invariants: dom-6 | ||||||||||||
Type | Narrative | ||||||||||||
Alternate Names | narrative, html, xhtml, display | ||||||||||||
Comments | Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. | ||||||||||||
Invariants |
| ||||||||||||
Library.contained | |||||||||||||
Element Id | Library.contained | ||||||||||||
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. | ||||||||||||
Short Display | Contained, inline Resources | ||||||||||||
Cardinality | 0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5 | ||||||||||||
Type | Resource | ||||||||||||
Alternate Names | inline resources, anonymous resources, contained resources | ||||||||||||
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels. | ||||||||||||
Library.extension | |||||||||||||
Element Id | Library.extension | ||||||||||||
Definition | An Extension | ||||||||||||
Short Display | Extension | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | Extension | ||||||||||||
Invariants |
| ||||||||||||
Slicing | This element introduces a set of slices. The slicing rules are:
| ||||||||||||
Library.extension(knowledgeCapability) | |||||||||||||
Element Id | Library.extension:knowledgeCapability | ||||||||||||
Definition | Defines a knowledge capability afforded by this knowledge artifact. | ||||||||||||
Short Display | shareable | computable | publishable | executable | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | Extension(CQFKnowledgeCapability) | ||||||||||||
Must Support | true | ||||||||||||
Invariants |
| ||||||||||||
Library.extension(knowledgeRepresentationLevel) | |||||||||||||
Element Id | Library.extension:knowledgeRepresentationLevel | ||||||||||||
Definition | Defines a knowledge representation level provided by this knowledge artifact. | ||||||||||||
Short Display | narrative | semi-structured | structured | executable | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | Extension(KnowledgeRepresentationLevel) | ||||||||||||
Must Support | true | ||||||||||||
Invariants |
| ||||||||||||
Library.extension(artifactComment) | |||||||||||||
Element Id | Library.extension:artifactComment | ||||||||||||
Definition | A comment containing additional documentation, a review comment, usage guidance, or other relevant information from a particular user. | ||||||||||||
Short Display | Additional documentation, review, or usage guidance | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | Extension(ArtifactComment) | ||||||||||||
Must Support | true | ||||||||||||
Invariants |
| ||||||||||||
Library.extension(directReferenceCode) | |||||||||||||
Element Id | Library.extension:directReferenceCode | ||||||||||||
Definition | Indicates that the given code is directly referenced by artifact logic (e.g. as a direct-reference code in CQL). Terminology dependencies used in logic can be collected and reported, typically using the relatedArtifact element with a type of | ||||||||||||
Short Display | A code directly referenced by the artifact | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | Extension(DirectReferenceCode) | ||||||||||||
Must Support | true | ||||||||||||
Invariants |
| ||||||||||||
Library.modifierExtension | |||||||||||||
Element Id | Library.modifierExtension | ||||||||||||
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||||||
Short Display | Extensions that cannot be ignored | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | Extension | ||||||||||||
Is Modifier | true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them) | ||||||||||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||||||||||
Alternate Names | extensions, user content | ||||||||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||||||
Invariants |
| ||||||||||||
Library.url | |||||||||||||
Element Id | Library.url | ||||||||||||
Definition | An absolute URI that is used to identify this library 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 library is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the library is stored on different servers. | ||||||||||||
Short Display | Canonical identifier for this library, represented as a URI (globally unique) | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Type | uri | ||||||||||||
Must Support | true | ||||||||||||
Requirements | Allows the library to be referenced by a single globally unique identifier. | ||||||||||||
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 |
| ||||||||||||
Library.identifier | |||||||||||||
Element Id | Library.identifier | ||||||||||||
Definition | A formal identifier that is used to identify this library when it is represented in other formats, or referenced in a specification, model, design or an instance. e.g. CMS or NQF identifiers for a measure artifact. Note that at least one identifier is required for non-experimental active artifacts. | ||||||||||||
Short Display | Additional identifier for the library | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | Identifier | ||||||||||||
Requirements | Allows externally provided and/or usable business identifiers to be easily associated with the module. | ||||||||||||
Comments | Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this library outside of FHIR, where it is not possible to use the logical URI. | ||||||||||||
Invariants |
| ||||||||||||
Library.version | |||||||||||||
Element Id | Library.version | ||||||||||||
Definition | The identifier that is used to identify this version of the library when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the library 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. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts. | ||||||||||||
Short Display | Business version of the library | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Type | string | ||||||||||||
Must Support | true | ||||||||||||
Comments | There may be different library 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 library with the format [url]|[version]. The version SHOULD NOT contain a '#' - see Business Version. | ||||||||||||
Invariants |
| ||||||||||||
Library.versionAlgorithm[x] | |||||||||||||
Element Id | Library.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 | null The codes SHALL be taken from Version Algorithm; other codes may be used where these codes are not suitable | ||||||||||||
Type | Choice of: string, Coding | ||||||||||||
[x] Note | See Choice of Datatypes for further information about how to use [x] | ||||||||||||
Must Support | 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. | ||||||||||||
Invariants |
| ||||||||||||
Library.name | |||||||||||||
Element Id | Library.name | ||||||||||||
Definition | A natural language name identifying the library. This name should be usable as an identifier for the module by machine processing applications such as code generation. | ||||||||||||
Short Display | Name for this library (computer friendly) | ||||||||||||
Cardinality | 0..1 This element is affected by the following invariants: cnl-0 | ||||||||||||
Type | string | ||||||||||||
Must Support | true | ||||||||||||
Requirements | Support human navigation and code generation. | ||||||||||||
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. | ||||||||||||
Invariants |
| ||||||||||||
Library.title | |||||||||||||
Element Id | Library.title | ||||||||||||
Definition | A short, descriptive, user-friendly title for the library. | ||||||||||||
Short Display | Name for this library (human friendly) | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Type | string | ||||||||||||
Must Support | true | ||||||||||||
Comments | This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. | ||||||||||||
Invariants |
| ||||||||||||
Library.subtitle | |||||||||||||
Element Id | Library.subtitle | ||||||||||||
Definition | An explanatory or alternate title for the library giving additional information about its content. | ||||||||||||
Short Display | Subordinate title of the library | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | string | ||||||||||||
Invariants |
| ||||||||||||
Library.status | |||||||||||||
Element Id | Library.status | ||||||||||||
Definition | The status of this library. Enables tracking the life-cycle of the content. | ||||||||||||
Short Display | draft | active | retired | unknown | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Terminology Binding | The lifecycle status of an artifact. The codes SHALL be taken from PublicationStatus | ||||||||||||
Type | code | ||||||||||||
Is Modifier | true (Reason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration) | ||||||||||||
Comments | Allows filtering of libraries that are appropriate for use vs. not. See guidance around (not) making local changes to elements here. | ||||||||||||
Invariants |
| ||||||||||||
Library.experimental | |||||||||||||
Element Id | Library.experimental | ||||||||||||
Definition | A Boolean value to indicate that this library 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 | ||||||||||||
Must Support | true | ||||||||||||
Requirements | Enables experimental content to be developed following the same lifecycle that would be used for a production-level library. | ||||||||||||
Comments | Allows filtering of librarys that are appropriate for use versus not. | ||||||||||||
Meaning if Missing | If absent, this resource is treated as though it is not experimental. | ||||||||||||
Invariants |
| ||||||||||||
Library.type | |||||||||||||
Element Id | Library.type | ||||||||||||
Definition | Identifies the type of library such as a Logic Library, Model Definition, Asset Collection, or Module Definition. | ||||||||||||
Short Display | logic-library | model-definition | asset-collection | module-definition | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Terminology Binding | The type of knowledge asset this library contains. The codes SHALL be taken from Library Type; other codes may be used where these codes are not suitable | ||||||||||||
Type | CodeableConcept | ||||||||||||
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://terminology.hl7.org/CodeSystem/library-type"/> <code value="module-definition"/> </coding> </valueCodeableConcept> | ||||||||||||
Invariants |
| ||||||||||||
Library.subject[x] | |||||||||||||
Element Id | Library.subject[x] | ||||||||||||
Definition | A code or group definition that describes the intended subject of the contents of the library. | ||||||||||||
Short Display | Type of individual the library content is focused on | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Terminology Binding | The possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.). The codes SHALL be taken from Participant Resource Types; other codes may be used where these codes are not suitable | ||||||||||||
Type | Choice of: CodeableConcept, Reference(Group) | ||||||||||||
[x] Note | See Choice of Datatypes for further information about how to use [x] | ||||||||||||
Must Support | true | ||||||||||||
Meaning if Missing | Patient | ||||||||||||
Invariants |
| ||||||||||||
Library.date | |||||||||||||
Element Id | Library.date | ||||||||||||
Definition | The date (and optionally time) when the library 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 library changes. | ||||||||||||
Short Display | Date last changed | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | dateTime | ||||||||||||
Alternate Names | Revision Date | ||||||||||||
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 library. 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. | ||||||||||||
Invariants |
| ||||||||||||
Library.publisher | |||||||||||||
Element Id | Library.publisher | ||||||||||||
Definition | The name of the organization or individual responsible for the release and ongoing maintenance of the library. | ||||||||||||
Short Display | Name of the publisher/steward (organization or individual) | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | string | ||||||||||||
Must Support | true | ||||||||||||
Requirements | Helps establish the "authority/credibility" of the library. May also allow for contact. | ||||||||||||
Comments | Usually an organization but may be an individual. The publisher (or steward) of the library is the organization or individual primarily responsible for the maintenance and upkeep of the library. 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 library. This item SHOULD be populated unless the information is available from context. | ||||||||||||
Invariants |
| ||||||||||||
Library.contact | |||||||||||||
Element Id | Library.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 | ||||||||||||
Comments | May be a web site, an email address, a telephone number, etc. See guidance around (not) making local changes to elements here. | ||||||||||||
Invariants |
| ||||||||||||
Library.description | |||||||||||||
Element Id | Library.description | ||||||||||||
Definition | A free text natural language description of the library from a consumer's perspective. | ||||||||||||
Short Display | Natural language description of the library | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Type | markdown | ||||||||||||
Must Support | true | ||||||||||||
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 library 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 library is presumed to be the predominant language in the place the library was created). | ||||||||||||
Invariants |
| ||||||||||||
Library.useContext | |||||||||||||
Element Id | Library.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 library instances. | ||||||||||||
Short Display | The context that the content is intended to support | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | UsageContext | ||||||||||||
Requirements | Assist in searching for appropriate content. | ||||||||||||
Comments | When multiple useContexts are specified, there is no expectation that all or any of the contexts apply. | ||||||||||||
Invariants |
| ||||||||||||
Library.jurisdiction | |||||||||||||
Element Id | Library.jurisdiction | ||||||||||||
Definition | A legal or geographic region in which the library is intended to be used. | ||||||||||||
Short Display | Intended jurisdiction for library (if applicable) | ||||||||||||
Cardinality | 0..* | ||||||||||||
Terminology Binding | Countries and regions within which this artifact is targeted for use. The codes SHALL be taken from Jurisdiction ValueSet; other codes may be used where these codes are not suitable | ||||||||||||
Type | CodeableConcept | ||||||||||||
Comments | It may be possible for the library 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.) | ||||||||||||
Invariants |
| ||||||||||||
Library.purpose | |||||||||||||
Element Id | Library.purpose | ||||||||||||
Definition | Explanation of why this library is needed and why it has been designed as it has. | ||||||||||||
Short Display | Why this library is defined | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | markdown | ||||||||||||
Comments | This element does not describe the usage of the library. 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 library. | ||||||||||||
Invariants |
| ||||||||||||
Library.usage | |||||||||||||
Element Id | Library.usage | ||||||||||||
Definition | A detailed description of how the library is used from a clinical perspective. | ||||||||||||
Short Display | Describes the clinical usage of the library | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | markdown | ||||||||||||
Invariants |
| ||||||||||||
Library.copyright | |||||||||||||
Element Id | Library.copyright | ||||||||||||
Definition | A copyright statement relating to the library and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the library. | ||||||||||||
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 library and/or its content. | ||||||||||||
Alternate Names | License, Restrictions | ||||||||||||
Comments | The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element. | ||||||||||||
Invariants |
| ||||||||||||
Library.copyrightLabel | |||||||||||||
Element Id | Library.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. | ||||||||||||
Invariants |
| ||||||||||||
Library.approvalDate | |||||||||||||
Element Id | Library.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 library 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. See guidance around (not) making local changes to elements here. | ||||||||||||
Invariants |
| ||||||||||||
Library.lastReviewDate | |||||||||||||
Element Id | Library.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 library was last reviewed by the publisher | ||||||||||||
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. See guidance around (not) making local changes to elements here. | ||||||||||||
Invariants |
| ||||||||||||
Library.effectivePeriod | |||||||||||||
Element Id | Library.effectivePeriod | ||||||||||||
Definition | The period during which the library content was or is planned to be in active use. | ||||||||||||
Short Display | When the library 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 library are or are expected to be used instead. | ||||||||||||
Comments | The effective period for a library determines when the content is applicable for usage and is independent of publication and review dates. For example, a library intended to be used for the year 2016 might be published in 2015. See guidance around (not) making local changes to elements here. | ||||||||||||
Invariants |
| ||||||||||||
Library.topic | |||||||||||||
Element Id | Library.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 | High-level categorization of the definition, used for searching, sorting, and filtering. For example codes, see Definition Topic | ||||||||||||
Type | CodeableConcept | ||||||||||||
Requirements | Repositories must be able to determine how to categorize the library so that it can be found by topical searches. | ||||||||||||
Comments | DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'topic' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#topic and useContext.valueCodeableConcept indicating the topic) | ||||||||||||
Invariants |
| ||||||||||||
Library.author | |||||||||||||
Element Id | Library.author | ||||||||||||
Definition | An individiual or organization primarily involved in the creation and maintenance of the content. | ||||||||||||
Short Display | Who authored the content | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | ContactDetail | ||||||||||||
Invariants |
| ||||||||||||
Library.editor | |||||||||||||
Element Id | Library.editor | ||||||||||||
Definition | An individual or organization primarily responsible for internal coherence of the content. | ||||||||||||
Short Display | Who edited the content | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | ContactDetail | ||||||||||||
Invariants |
| ||||||||||||
Library.reviewer | |||||||||||||
Element Id | Library.reviewer | ||||||||||||
Definition | An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the content. | ||||||||||||
Short Display | Who reviewed the content | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | ContactDetail | ||||||||||||
Comments | See guidance around (not) making local changes to elements here. | ||||||||||||
Invariants |
| ||||||||||||
Library.endorser | |||||||||||||
Element Id | Library.endorser | ||||||||||||
Definition | An individual or organization asserted by the publisher to be responsible for officially endorsing the content for use in some setting. | ||||||||||||
Short Display | Who endorsed the content | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | ContactDetail | ||||||||||||
Comments | See guidance around (not) making local changes to elements here. | ||||||||||||
Invariants |
| ||||||||||||
Library.relatedArtifact | |||||||||||||
Element Id | Library.relatedArtifact | ||||||||||||
Definition | Related artifacts such as additional documentation, justification, or bibliographic references. | ||||||||||||
Short Display | Additional documentation, citations, etc | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | RelatedArtifact | ||||||||||||
Must Support | true | ||||||||||||
Requirements | Libraries 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. | ||||||||||||
Invariants |
| ||||||||||||
Slicing | This element introduces a set of slices. The slicing rules are:
| ||||||||||||
Library.relatedArtifact(dependency) | |||||||||||||
Element Id | Library.relatedArtifact:dependency | ||||||||||||
Definition | Related artifacts such as additional documentation, justification, or bibliographic references. | ||||||||||||
Short Display | Additional documentation, citations, etc | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | RelatedArtifact | ||||||||||||
Must Support | true | ||||||||||||
Requirements | Libraries 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. | ||||||||||||
Invariants |
| ||||||||||||
Library.relatedArtifact.id | |||||||||||||
Element Id | Library.relatedArtifact:dependency.id | ||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||
Short Display | Unique id for inter-element referencing | ||||||||||||
Cardinality | 0..1 This element is affected by the following invariants: ele-1 | ||||||||||||
Type | id | ||||||||||||
Library.relatedArtifact.extension | |||||||||||||
Element Id | Library.relatedArtifact:dependency.extension | ||||||||||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||||||
Short Display | Additional content defined by implementations | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | Extension | ||||||||||||
Alternate Names | extensions, user content | ||||||||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||||||
Invariants |
| ||||||||||||
Slicing | This element introduces a set of slices. The slicing rules are:
| ||||||||||||
Library.relatedArtifact.type | |||||||||||||
Element Id | Library.relatedArtifact:dependency.type | ||||||||||||
Definition | The type of relationship to the related artifact. | ||||||||||||
Short Display | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Terminology Binding | The type of relationship to the related artifact. The codes SHALL be taken from RelatedArtifactType | ||||||||||||
Type | code | ||||||||||||
Must Support | true | ||||||||||||
Comments | The presence of both sides of a relationship type (e.g. successor and predecessor) is required to support use cases where one side of a relationship is not represented in FHIR. However, this feature SHALL NOT be used to create bi-directional resource links in FHIR instances. Specifically, following the methodology of "new points to old" and "many points to one", when using related artifact elements to describe and reference FHIR resources, the type element SHALL be drawn from the fhir-related-artifact-type ValueSet. | ||||||||||||
Fixed Value | depends-on | ||||||||||||
Invariants |
| ||||||||||||
Library.relatedArtifact.classifier | |||||||||||||
Element Id | Library.relatedArtifact:dependency.classifier | ||||||||||||
Definition | Provides additional classifiers of the related artifact. | ||||||||||||
Short Display | Additional classifiers | ||||||||||||
Cardinality | 0..* | ||||||||||||
Terminology Binding | Additional classifiers for the related artifact. For example codes, see Citation Artifact Classifier | ||||||||||||
Type | CodeableConcept | ||||||||||||
Invariants |
| ||||||||||||
Library.relatedArtifact.label | |||||||||||||
Element Id | Library.relatedArtifact:dependency.label | ||||||||||||
Definition | A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index. | ||||||||||||
Short Display | Short label | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | string | ||||||||||||
Invariants |
| ||||||||||||
Library.relatedArtifact.display | |||||||||||||
Element Id | Library.relatedArtifact:dependency.display | ||||||||||||
Definition | A brief description of the document or knowledge resource being referenced, suitable for display to a consumer. | ||||||||||||
Short Display | Brief description of the related artifact | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | string | ||||||||||||
Invariants |
| ||||||||||||
Library.relatedArtifact.citation | |||||||||||||
Element Id | Library.relatedArtifact:dependency.citation | ||||||||||||
Definition | A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format. | ||||||||||||
Short Display | Bibliographic citation for the artifact | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | markdown | ||||||||||||
Comments | Additional structured information about citations should be captured as extensions. | ||||||||||||
Invariants |
| ||||||||||||
Library.relatedArtifact.document | |||||||||||||
Element Id | Library.relatedArtifact:dependency.document | ||||||||||||
Definition | The document being referenced, represented as an attachment. This is exclusive with the resource element. | ||||||||||||
Short Display | What document is being referenced | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | Attachment | ||||||||||||
Invariants |
| ||||||||||||
Library.relatedArtifact.resource | |||||||||||||
Element Id | Library.relatedArtifact:dependency.resource | ||||||||||||
Definition | The related artifact, such as a library, value set, profile, or other knowledge resource. | ||||||||||||
Short Display | What artifact is being referenced | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Type | canonical(CodeSystem) | ||||||||||||
Must Support | true | ||||||||||||
Comments | If the type is predecessor, this is a reference to the succeeding knowledge resource. If the type is successor, this is a reference to the prior knowledge resource. | ||||||||||||
Invariants |
| ||||||||||||
Library.relatedArtifact.resourceReference | |||||||||||||
Element Id | Library.relatedArtifact:dependency.resourceReference | ||||||||||||
Definition | The related artifact, if the artifact is not a canonical resource, or a resource reference to a canonical resource. | ||||||||||||
Short Display | What artifact, if not a conformance resource | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | Reference(Resource) | ||||||||||||
Comments | If both resource and resourceReference are present, they SHOULD be consistent and reference the same resource. Although relatedArtifact is intended to support references to definitional resources, there are cases where non-definitional resources can be definitional (such as Location where the kind is mode). Related artifacts SHOULD be used to reference definitional resources, and profiles SHOULD be used to make that explicit for particular use cases. | ||||||||||||
Invariants |
| ||||||||||||
Library.relatedArtifact.publicationStatus | |||||||||||||
Element Id | Library.relatedArtifact:dependency.publicationStatus | ||||||||||||
Definition | The publication status of the artifact being referred to. | ||||||||||||
Short Display | draft | active | retired | unknown | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Terminology Binding | Publication status of an artifact being referred to. The codes SHALL be taken from PublicationStatus | ||||||||||||
Type | code | ||||||||||||
Invariants |
| ||||||||||||
Library.relatedArtifact.publicationDate | |||||||||||||
Element Id | Library.relatedArtifact:dependency.publicationDate | ||||||||||||
Definition | The date of publication of the artifact being referred to. | ||||||||||||
Short Display | Date of publication of the artifact being referred to | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | date | ||||||||||||
Invariants |
| ||||||||||||
Library.parameter | |||||||||||||
Element Id | Library.parameter | ||||||||||||
Definition | The parameter element defines parameters used by the library. | ||||||||||||
Short Display | Parameters defined by the library | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | ParameterDefinition | ||||||||||||
Must Support | true | ||||||||||||
Invariants |
| ||||||||||||
Library.dataRequirement | |||||||||||||
Element Id | Library.dataRequirement | ||||||||||||
Definition | Describes a set of data that must be provided in order to be able to successfully perform the computations defined by the library. | ||||||||||||
Short Display | What data is referenced by this library | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | DataRequirement | ||||||||||||
Must Support | true | ||||||||||||
Invariants |
| ||||||||||||
Library.content | |||||||||||||
Element Id | Library.content | ||||||||||||
Definition | The content of the library as an Attachment. The content may be a reference to a url, or may be directly embedded as a base-64 string. Either way, the contentType of the attachment determines how to interpret the content. | ||||||||||||
Short Display | Contents of the library, either embedded or referenced | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | Attachment | ||||||||||||
Must Support | true | ||||||||||||
Invariants |
| ||||||||||||
Slicing | This element introduces a set of slices. The slicing rules are:
| ||||||||||||
Library.content.id | |||||||||||||
Element Id | Library.content.id | ||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||
Short Display | Unique id for inter-element referencing | ||||||||||||
Cardinality | 0..1 This element is affected by the following invariants: ele-1 | ||||||||||||
Type | id | ||||||||||||
Library.content.extension | |||||||||||||
Element Id | Library.content.extension | ||||||||||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||||||
Short Display | Additional content defined by implementations | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | Extension | ||||||||||||
Alternate Names | extensions, user content | ||||||||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||||||
Invariants |
| ||||||||||||
Slicing | This element introduces a set of slices. The slicing rules are:
| ||||||||||||
Library.content.contentType | |||||||||||||
Element Id | Library.content.contentType | ||||||||||||
Definition | Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate. | ||||||||||||
Short Display | Mime type of the content, with charset etc. | ||||||||||||
Cardinality | 0..1 This element is affected by the following invariants: att-1 | ||||||||||||
Terminology Binding | BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) The codes SHALL be taken from Mime Types | ||||||||||||
Type | code | ||||||||||||
Must Support | true | ||||||||||||
Requirements | Processors of the data need to be able to know how to interpret the data. | ||||||||||||
Example | General:text/plain; charset=UTF-8, image/png | ||||||||||||
Invariants |
| ||||||||||||
Library.content.language | |||||||||||||
Element Id | Library.content.language | ||||||||||||
Definition | The human language of the content. The value can be any valid value according to BCP 47. | ||||||||||||
Short Display | Human language of the content (BCP-47) | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Terminology Binding | IETF language tag for a human language. The codes SHALL be taken from All Languages | ||||||||||||
Type | code | ||||||||||||
Requirements | Users need to be able to choose between the languages in a set of attachments. | ||||||||||||
Example | General:en-AU | ||||||||||||
Invariants |
| ||||||||||||
Library.content.data | |||||||||||||
Element Id | Library.content.data | ||||||||||||
Definition | The actual data of the attachment - a sequence of bytes, base64 encoded. | ||||||||||||
Short Display | Data inline, base64ed | ||||||||||||
Cardinality | 0..1 This element is affected by the following invariants: att-1 | ||||||||||||
Type | base64Binary | ||||||||||||
Must Support | true | ||||||||||||
Requirements | The data needs to able to be transmitted inline. | ||||||||||||
Comments | The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON. | ||||||||||||
Invariants |
| ||||||||||||
Library.content.url | |||||||||||||
Element Id | Library.content.url | ||||||||||||
Definition | A location where the data can be accessed. | ||||||||||||
Short Display | Uri where the data can be found | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | url | ||||||||||||
Requirements | The data needs to be transmitted by reference. | ||||||||||||
Comments | If both data and url are provided, the url SHALL point to the same content as the data contains. Urls may be relative references or may reference transient locations such as a wrapping envelope using cid: though this has ramifications for using signatures. Relative URLs are interpreted relative to the service url, like a resource reference, rather than relative to the resource itself. If a URL is provided, it SHALL resolve to actual data. | ||||||||||||
Example | General:http://www.acme.com/logo-small.png | ||||||||||||
Invariants |
| ||||||||||||
Library.content.size | |||||||||||||
Element Id | Library.content.size | ||||||||||||
Definition | The number of bytes of data that make up this attachment (before base64 encoding, if that is done). | ||||||||||||
Short Display | Number of bytes of content (if url provided) | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | integer64 | ||||||||||||
Requirements | Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all. | ||||||||||||
Comments | The number of bytes is redundant if the data is provided as a base64binary, but is useful if the data is provided as a url reference. | ||||||||||||
Invariants |
| ||||||||||||
Library.content.hash | |||||||||||||
Element Id | Library.content.hash | ||||||||||||
Definition | The calculated hash of the data using SHA-1. Represented using base64. | ||||||||||||
Short Display | Hash of the data (sha-1, base64ed) | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | base64Binary | ||||||||||||
Requirements | Included so that applications can verify that the contents of a location have not changed due to technical failures (e.g., storage rot, transport glitch, incorrect version). | ||||||||||||
Comments | The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded. The hash is not intended to support digital signatures. Where protection against malicious threats a digital signature should be considered, see Provenance.signature for mechanism to protect a resource with a digital signature. | ||||||||||||
Invariants |
| ||||||||||||
Library.content.title | |||||||||||||
Element Id | Library.content.title | ||||||||||||
Definition | A label or set of text to display in place of the data. | ||||||||||||
Short Display | Label to display in place of the data | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | string | ||||||||||||
Requirements | Applications need a label to display to a human user in place of the actual data if the data cannot be rendered or perceived by the viewer. | ||||||||||||
Comments | May sometimes be derived from the source filename. | ||||||||||||
Example | General:Official Corporate Logo | ||||||||||||
Invariants |
| ||||||||||||
Library.content.creation | |||||||||||||
Element Id | Library.content.creation | ||||||||||||
Definition | The date that the attachment was first created. | ||||||||||||
Short Display | Date attachment was first created | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | dateTime | ||||||||||||
Requirements | This is often tracked as an integrity issue for use of the attachment. | ||||||||||||
Invariants |
| ||||||||||||
Library.content.height | |||||||||||||
Element Id | Library.content.height | ||||||||||||
Definition | Height of the image in pixels (photo/video). | ||||||||||||
Short Display | Height of the image in pixels (photo/video) | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | positiveInt | ||||||||||||
Invariants |
| ||||||||||||
Library.content.width | |||||||||||||
Element Id | Library.content.width | ||||||||||||
Definition | Width of the image in pixels (photo/video). | ||||||||||||
Short Display | Width of the image in pixels (photo/video) | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | positiveInt | ||||||||||||
Invariants |
| ||||||||||||
Library.content.frames | |||||||||||||
Element Id | Library.content.frames | ||||||||||||
Definition | The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required. | ||||||||||||
Short Display | Number of frames if > 1 (photo) | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | positiveInt | ||||||||||||
Comments | if the number of frames is not supplied, the value may be unknown. Applications should not assume that there is only one frame unless it is explicitly stated. | ||||||||||||
Invariants |
| ||||||||||||
Library.content.duration | |||||||||||||
Element Id | Library.content.duration | ||||||||||||
Definition | The duration of the recording in seconds - for audio and video. | ||||||||||||
Short Display | Length in seconds (audio / video) | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | decimal | ||||||||||||
Comments | The duration might differ from occurrencePeriod if recording was paused. | ||||||||||||
Invariants |
| ||||||||||||
Library.content.pages | |||||||||||||
Element Id | Library.content.pages | ||||||||||||
Definition | The number of pages when printed. | ||||||||||||
Short Display | Number of printed pages | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | positiveInt | ||||||||||||
Invariants |
| ||||||||||||
Library.content(cqlContent) | |||||||||||||
Element Id | Library.content:cqlContent | ||||||||||||
Definition | The CQL content represented as base-64 encoded data. | ||||||||||||
Short Display | CQL Content | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Type | Attachment | ||||||||||||
Must Support | true | ||||||||||||
Invariants |
| ||||||||||||
Library.content.id | |||||||||||||
Element Id | Library.content:cqlContent.id | ||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||
Short Display | Unique id for inter-element referencing | ||||||||||||
Cardinality | 0..1 This element is affected by the following invariants: ele-1 | ||||||||||||
Type | id | ||||||||||||
Library.content.extension | |||||||||||||
Element Id | Library.content:cqlContent.extension | ||||||||||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||||||
Short Display | Additional content defined by implementations | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | Extension | ||||||||||||
Alternate Names | extensions, user content | ||||||||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||||||
Invariants |
| ||||||||||||
Slicing | This element introduces a set of slices. The slicing rules are:
| ||||||||||||
Library.content.contentType | |||||||||||||
Element Id | Library.content:cqlContent.contentType | ||||||||||||
Definition | Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate. | ||||||||||||
Short Display | Mime type of the content, with charset etc. | ||||||||||||
Cardinality | 1..1 This element is affected by the following invariants: att-1 | ||||||||||||
Terminology Binding | BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) The codes SHALL be taken from Mime Types | ||||||||||||
Type | code | ||||||||||||
Must Support | true | ||||||||||||
Requirements | Processors of the data need to be able to know how to interpret the data. | ||||||||||||
Fixed Value | text/cql | ||||||||||||
Example | General:text/plain; charset=UTF-8, image/png | ||||||||||||
Invariants |
| ||||||||||||
Library.content.language | |||||||||||||
Element Id | Library.content:cqlContent.language | ||||||||||||
Definition | The human language of the content. The value can be any valid value according to BCP 47. | ||||||||||||
Short Display | Human language of the content (BCP-47) | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Terminology Binding | IETF language tag for a human language. The codes SHALL be taken from All Languages | ||||||||||||
Type | code | ||||||||||||
Requirements | Users need to be able to choose between the languages in a set of attachments. | ||||||||||||
Example | General:en-AU | ||||||||||||
Invariants |
| ||||||||||||
Library.content.data | |||||||||||||
Element Id | Library.content:cqlContent.data | ||||||||||||
Definition | The actual data of the attachment - a sequence of bytes, base64 encoded. | ||||||||||||
Short Display | Data inline, base64ed | ||||||||||||
Cardinality | 1..1 This element is affected by the following invariants: att-1 | ||||||||||||
Type | base64Binary | ||||||||||||
Must Support | true | ||||||||||||
Requirements | The data needs to able to be transmitted inline. | ||||||||||||
Comments | The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON. | ||||||||||||
Invariants |
| ||||||||||||
Library.content.url | |||||||||||||
Element Id | Library.content:cqlContent.url | ||||||||||||
Definition | A location where the data can be accessed. | ||||||||||||
Short Display | Uri where the data can be found | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | url | ||||||||||||
Requirements | The data needs to be transmitted by reference. | ||||||||||||
Comments | If both data and url are provided, the url SHALL point to the same content as the data contains. Urls may be relative references or may reference transient locations such as a wrapping envelope using cid: though this has ramifications for using signatures. Relative URLs are interpreted relative to the service url, like a resource reference, rather than relative to the resource itself. If a URL is provided, it SHALL resolve to actual data. | ||||||||||||
Example | General:http://www.acme.com/logo-small.png | ||||||||||||
Invariants |
| ||||||||||||
Library.content.size | |||||||||||||
Element Id | Library.content:cqlContent.size | ||||||||||||
Definition | The number of bytes of data that make up this attachment (before base64 encoding, if that is done). | ||||||||||||
Short Display | Number of bytes of content (if url provided) | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | integer64 | ||||||||||||
Requirements | Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all. | ||||||||||||
Comments | The number of bytes is redundant if the data is provided as a base64binary, but is useful if the data is provided as a url reference. | ||||||||||||
Invariants |
| ||||||||||||
Library.content.hash | |||||||||||||
Element Id | Library.content:cqlContent.hash | ||||||||||||
Definition | The calculated hash of the data using SHA-1. Represented using base64. | ||||||||||||
Short Display | Hash of the data (sha-1, base64ed) | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | base64Binary | ||||||||||||
Requirements | Included so that applications can verify that the contents of a location have not changed due to technical failures (e.g., storage rot, transport glitch, incorrect version). | ||||||||||||
Comments | The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded. The hash is not intended to support digital signatures. Where protection against malicious threats a digital signature should be considered, see Provenance.signature for mechanism to protect a resource with a digital signature. | ||||||||||||
Invariants |
| ||||||||||||
Library.content.title | |||||||||||||
Element Id | Library.content:cqlContent.title | ||||||||||||
Definition | A label or set of text to display in place of the data. | ||||||||||||
Short Display | Label to display in place of the data | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | string | ||||||||||||
Requirements | Applications need a label to display to a human user in place of the actual data if the data cannot be rendered or perceived by the viewer. | ||||||||||||
Comments | May sometimes be derived from the source filename. | ||||||||||||
Example | General:Official Corporate Logo | ||||||||||||
Invariants |
| ||||||||||||
Library.content.creation | |||||||||||||
Element Id | Library.content:cqlContent.creation | ||||||||||||
Definition | The date that the attachment was first created. | ||||||||||||
Short Display | Date attachment was first created | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | dateTime | ||||||||||||
Requirements | This is often tracked as an integrity issue for use of the attachment. | ||||||||||||
Invariants |
| ||||||||||||
Library.content.height | |||||||||||||
Element Id | Library.content:cqlContent.height | ||||||||||||
Definition | Height of the image in pixels (photo/video). | ||||||||||||
Short Display | Height of the image in pixels (photo/video) | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | positiveInt | ||||||||||||
Invariants |
| ||||||||||||
Library.content.width | |||||||||||||
Element Id | Library.content:cqlContent.width | ||||||||||||
Definition | Width of the image in pixels (photo/video). | ||||||||||||
Short Display | Width of the image in pixels (photo/video) | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | positiveInt | ||||||||||||
Invariants |
| ||||||||||||
Library.content.frames | |||||||||||||
Element Id | Library.content:cqlContent.frames | ||||||||||||
Definition | The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required. | ||||||||||||
Short Display | Number of frames if > 1 (photo) | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | positiveInt | ||||||||||||
Comments | if the number of frames is not supplied, the value may be unknown. Applications should not assume that there is only one frame unless it is explicitly stated. | ||||||||||||
Invariants |
| ||||||||||||
Library.content.duration | |||||||||||||
Element Id | Library.content:cqlContent.duration | ||||||||||||
Definition | The duration of the recording in seconds - for audio and video. | ||||||||||||
Short Display | Length in seconds (audio / video) | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | decimal | ||||||||||||
Comments | The duration might differ from occurrencePeriod if recording was paused. | ||||||||||||
Invariants |
| ||||||||||||
Library.content.pages | |||||||||||||
Element Id | Library.content:cqlContent.pages | ||||||||||||
Definition | The number of pages when printed. | ||||||||||||
Short Display | Number of printed pages | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | positiveInt | ||||||||||||
Invariants |
|