ShareableLibrary
QuantityTranslation
<?xml version="1.0" encoding="UTF-8"?>
Enforces the minimum information set for the library metadata required by HL7 and other
organizations that share and publish libraries
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.
If the resource is contained in another resource, it SHALL be referred to from elsewhere
in the resource or SHALL refer to the containing resource
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonica
l) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(refer
ence = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(c
anonical) = '#').exists()).not()).trace('unmatched', id).empty()
not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:refere
nce/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))
If a resource is contained in another resource, it SHALL NOT have a meta.versionId or
a meta.lastUpdated
When a resource has no narrative, only systems that fully understand the data can display
the resource to a human safely. Including a human readable representation in the resource
makes for a much more robust eco-system and cheaper handling of resources by intermediary
systems. Some ecosystems restrict distribution of resources to only those systems that
do fully understand the resources, and as a consequence implementers may believe that
the narrative is superfluous. However experience shows that such eco-systems often open
up to new participants over time.
Name should be usable as an identifier for the module by machine processing applications
such as code generation
The logical id of the resource, as used in the URL for the resource. Once assigned, this
value never changes.
The only time that a resource does not have an id is when it is being submitted to the
server using a create operation.
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.
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.
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
it's narrative along with other profiles, value sets, etc.
This element is labeled as a modifier because the implicit rules may provide additional
knowledge about the resource that modifies it's meaning or interpretation
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).
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.
Contained resources do not have 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.
These resources do not have an independent existence apart from the resource that contains
them - they cannot be identified independently, and nor can they have their own independent
transaction scope.
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.
May be used to represent additional information that is not part of the basic definition
of the resource. To make the use of extensions safe and manageable, 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.
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.
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 manageable, 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).
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.
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](http://hl7.org/f
hir/extensibility.html#modifierExtension).
Modifier extensions are expected to modify the meaning or interpretation of the resource
that contains them
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 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.
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](http://hl7.org/fhir/resource.html#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](http://hl7.org/fhir/resource.html#meta)
element to indicate where the current master source of the resource can be found.
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.
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.
Allows externally provided and/or usable business identifiers to be easily associated
with the module.
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.
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].
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.
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.
This name does not need to be machine-processing friendly and may contain punctuation,
white-space, etc.
An explanatory or alternate title for the library giving additional information about
its content.
This is labeled as "Is Modifier" because applications should not use a retired
{{title}} without due consideration
A Boolean value to indicate that this library is authored for testing purposes (or education/evaluat
ion/marketing) and is not intended to be used for genuine usage.
Enables experimental content to be developed following the same lifecycle that would be
used for a production-level library.
Identifies the type of library such as a Logic Library, Model Definition, Asset Collection,
or Module Definition.
A code or group definition that describes the intended subject of the contents of the
library.
The possible types of subjects for a library (E.g. Patient, Practitioner, Organization,
Location, etc.).
The date (and optionally time) when the library was published. 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.
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.
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.
Helps establish the "authority/credibility" of the library. May also allow
for contact.
This description can be used to capture details such as why the library was built, 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).
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.
When multiple useContexts are specified, there is no expectation that all or any of the
contexts apply.
It may be possible for the library to be used in jurisdictions other than those for which
it was originally designed or intended.
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.
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.
Consumers must be able to determine any legal restrictions on the use of the library and/or
its content.
The date on which the resource content was approved by the publisher. Approval happens
once when the content is officially approved for usage.
The 'date' element may be more recent than the approval date because of minor changes
or editorial corrections.
.outboundRelationship[typeCode="SUBJ"].act[classCode=CACT;moodCode=EVN;code="approval
"].effectiveTime
The date on which the resource content was last reviewed. Review happens periodically
after approval but does not change the original approval date.
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.
.outboundRelationship[typeCode="SUBJ"; subsetCode="RECENT"].act[classCode=CACT;m
oodCode=EVN;code="review"].effectiveTime
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 measure intended to
be used for the year 2016 might be published in 2015.
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.
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.
Repositories must be able to determine how to categorize the library so that it can be
found by topical searches.
An individiual or organization primarily involved in the creation and maintenance of the
content.
An individual or organization responsible for officially endorsing the content for use
in some setting.
Each related artifact is either an attachment, or a reference to another resource, but
not both.
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.
.outboundRelationship[typeCode=DOC,RSON,PREV, DRIV, USE, COMP] {successor would be PREV
w/ inversionInd=true; No support for citation}
Describes a set of data that must be provided in order to be able to successfully perform
the computations defined by the library.
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.
</
StructureDefinition
>
{
"resourceType" : "StructureDefinition",
"id" : "extension-quantity-translation",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "fhir"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 1
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/extension-quantity-translation",
"version" : "5.0.0-snapshot3",
"name" : "QuantityTranslation",
"title" : "Quantity Translation",
"status" : "draft",
"experimental" : false,
"date" : "2013-12-05",
"publisher" : "Health Level Seven International (FHIR Infrastructure)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/fiwg"
}]
}],
"description" : "An alternative representation of the same physical quantity expressed in a different unit from a different unit code system and possibly with a different value.",
"fhirVersion" : "5.0.0-snapshot3",
"mapping" : [{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
}],
"kind" : "complex-type",
"abstract" : false,
"context" : [{
"type" : "element",
"expression" : "Quantity"
}],
"type" : "Extension",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Extension",
"derivation" : "constraint",
"snapshot" : {
"element" : [{
"id" : "Extension",
"path" : "Extension",
"short" : "Same quantity with different units",
"definition" : "An alternative representation of the same physical quantity expressed in a different unit from a different unit code system and possibly with a different value.",
"comment" : "It is not necessary for information processing entities to check and enforce that the translations are valid translations of the base unit, but they are allowed to do so, and to reject instances where the translations are not valid. \nNOTE Translations are allowed to contain other representations in UCUM units, but there is generally no point to this as it is possible to convert from one UCUM form to another.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Extension",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"mapping" : [{
"identity" : "rim",
"map" : "PQ.translation"
}]
},
{
"id" : "Extension.id",
"path" : "Extension.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "id"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Extension.extension",
"path" : "Extension.extension",
"slicing" : {
"discriminator" : [{
"type" : "value",
"path" : "url"
}],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"short" : "Extension",
"definition" : "An Extension",
"min" : 0,
"max" : "0",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Extension.url",
"path" : "Extension.url",
"representation" : ["xmlAttr"],
"short" : "identifies the meaning of the extension",
"definition" : "Source of the definition for the extension code - a logical name or a URL.",
"comment" : "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Extension.url",
"min" : 1,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "uri"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"fixedUri" : "http://hl7.org/fhir/StructureDefinition/extension-quantity-translation",
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Extension.value[x]",
"path" : "Extension.value[x]",
"short" : "Value of extension",
"definition" : "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Extension.value[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Quantity"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
}]
},
"differential" : {
"element" : [{
"id" : "Extension",
"path" : "Extension",
"short" : "Same quantity with different units",
"definition" : "An alternative representation of the same physical quantity expressed in a different unit from a different unit code system and possibly with a different value.",
"comment" : "It is not necessary for information processing entities to check and enforce that the translations are valid translations of the base unit, but they are allowed to do so, and to reject instances where the translations are not valid. \nNOTE Translations are allowed to contain other representations in UCUM units, but there is generally no point to this as it is possible to convert from one UCUM form to another.",
"min" : 0,
"max" : "*",
"mapping" : [{
"identity" : "rim",
"map" : "PQ.translation"
}]
},
{
"id" : "Extension.extension",
"path" : "Extension.extension",
"max" : "0"
},
{
"id" : "Extension.url",
"path" : "Extension.url",
"fixedUri" : "http://hl7.org/fhir/StructureDefinition/extension-quantity-translation"
},
{
"id" : "Extension.value[x]",
"path" : "Extension.value[x]",
"min" : 1,
"type" : [{
"code" : "Quantity"
}]
}]
}
}
Foundation
|
Propose
a
change