Generated Narrative: StructureDefinition praxis-billing-rule-set-library Name Flags Card. Type Description & Constraints<img src="[binary]" alt="doco" style="background-color: inherit"/> Library 0..* Library Represents a library of quality improvement components #xD; Slices for extension 2..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:sourceManifest S 1..1 (Complex) Billing Source Manifest URL: https://fhir.cognovis.de/praxis/StructureDefinition/billing-source-manifest #xD; extension:payloadSchema S 1..1 uri Billing Rule Payload Schema URL: https://fhir.cognovis.de/praxis/StructureDefinition/billing-rule-payload-schema #xD; url S 1..1 uri Canonical identifier for this library, represented as a URI (globally unique) #xD; Slices for identifier S 2..* Identifier Additional identifier for the library Slice: Unordered, Open by value:system #xD; identifier:ruleSetId S 1..1 Identifier Additional identifier for the library #xD; system 1..1 uri The namespace for the identifier value Fixed Value: https://fhir.cognovis.de/praxis/sid/billing-rule-set-id #xD; value 1..1 string The value that is unique #xD; identifier:sourceBatchId S 1..1 Identifier Additional identifier for the library #xD; system 1..1 uri The namespace for the identifier value Fixed Value: https://fhir.cognovis.de/praxis/sid/billing-rule-source-batch-id #xD; value 1..1 string The value that is unique #xD; version S 1..1 string Business version of the library #xD; name S 1..1 string Name for this library (computer friendly) #xD; title S 1..1 string Name for this library (human friendly) #xD; status S 1..1 code draft | active | retired | unknown Binding: Billing Rule Set Status (required) #xD; experimental S 1..1 boolean For testing purposes, not real usage Required Pattern: false #xD; type S 1..1 CodeableConcept logic-library | model-definition | asset-collection | module-definition Fixed Value: As shown (Asset Collection) #xD; coding 1..1 Coding Code defined by a terminology system Fixed Value: (Complex) #xD; system 1..1 uri Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/library-type #xD; code 1..1 code Symbol in syntax defined by the system Fixed Value: asset-collection #xD; Slices for useContext S 3..* UsageContext The context that the content is intended to support Slice: Unordered, Open by pattern:code #xD; useContext:billingRegime S 1..1 UsageContext The context that the content is intended to support #xD; code 1..1 Coding Type of context being specified Required Pattern: At least the following #xD; system 1..1 uri Identity of the terminology system Fixed Value: https://fhir.cognovis.de/praxis/CodeSystem/billing-rule-use-context #xD; code 1..1 code Symbol in syntax defined by the system Fixed Value: billing-regime #xD; value[x] 1..1 CodeableConcept Value that defines the context Binding: Abrechnungsart (extensible) #xD; coding 1..* Coding Code defined by a terminology system #xD; system 1..1 uri Identity of the terminology system #xD; code 1..1 code Symbol in syntax defined by the system #xD; useContext:catalogScope S 1..1 UsageContext The context that the content is intended to support #xD; code 1..1 Coding Type of context being specified Required Pattern: At least the following #xD; system 1..1 uri Identity of the terminology system Fixed Value: https://fhir.cognovis.de/praxis/CodeSystem/billing-rule-use-context #xD; code 1..1 code Symbol in syntax defined by the system Fixed Value: catalog-scope #xD; value[x] 1..1 CodeableConcept Value that defines the context #xD; coding 1..* Coding Code defined by a terminology system #xD; system 1..1 uri Identity of the terminology system #xD; code 1..1 code Symbol in syntax defined by the system #xD; useContext:source S 1..1 UsageContext The context that the content is intended to support #xD; code 1..1 Coding Type of context being specified Required Pattern: At least the following #xD; system 1..1 uri Identity of the terminology system Fixed Value: https://fhir.cognovis.de/praxis/CodeSystem/billing-rule-use-context #xD; code 1..1 code Symbol in syntax defined by the system Fixed Value: source #xD; value[x] 1..1 CodeableConcept Value that defines the context #xD; coding 1..* Coding Code defined by a terminology system #xD; system 1..1 uri Identity of the terminology system #xD; code 1..1 code Symbol in syntax defined by the system #xD; useContext:contract S 0..* UsageContext The context that the content is intended to support #xD; code 1..1 Coding Type of context being specified Required Pattern: At least the following #xD; system 1..1 uri Identity of the terminology system Fixed Value: https://fhir.cognovis.de/praxis/CodeSystem/billing-rule-use-context #xD; code 1..1 code Symbol in syntax defined by the system Fixed Value: contract #xD; value[x] 1..1 CodeableConcept Value that defines the context #xD; coding 1..* Coding Code defined by a terminology system #xD; system 1..1 uri Identity of the terminology system #xD; code 1..1 code Symbol in syntax defined by the system #xD; useContext:tenant S 0..1 UsageContext The context that the content is intended to support #xD; code 1..1 Coding Type of context being specified Required Pattern: At least the following #xD; system 1..1 uri Identity of the terminology system Fixed Value: https://fhir.cognovis.de/praxis/CodeSystem/billing-rule-use-context #xD; code 1..1 code Symbol in syntax defined by the system Fixed Value: tenant #xD; value[x] 1..1 Reference(Organization) Value that defines the context #xD; useContext:specialty S 0..* UsageContext The context that the content is intended to support #xD; code 1..1 Coding Type of context being specified Required Pattern: At least the following #xD; system 1..1 uri Identity of the terminology system Fixed Value: https://fhir.cognovis.de/praxis/CodeSystem/billing-rule-use-context #xD; code 1..1 code Symbol in syntax defined by the system Fixed Value: specialty #xD; value[x] 1..1 CodeableConcept Value that defines the context #xD; coding 1..* Coding Code defined by a terminology system #xD; system 1..1 uri Identity of the terminology system #xD; code 1..1 code Symbol in syntax defined by the system #xD; effectivePeriod S 1..1 Period When the library is expected to be used #xD; start S 1..1 dateTime Starting time with inclusive boundary #xD; end S 1..1 dateTime End time with inclusive boundary, if not ongoing #xD; parameter 0..0 Parameters defined by the library #xD; dataRequirement 0..0 What data is referenced by this library #xD; content S 1..1 Attachment Contents of the library, either embedded or referenced #xD; contentType S 1..1 code Mime type of the content, with charset etc. Fixed Value: application/json #xD; language 0..0 Human language of the content (BCP-47) #xD; data S 1..1 base64Binary Data inline, base64ed #xD; url 0..0 Uri where the data can be found #xD; title S 0..1 string Label to display in place of the data #xD; creation S 0..1 dateTime Date attachment was first created #xD; <img src="[binary]" alt="doco" style="background-color: inherit"/> Documentation for this format
Versioned, partitioned envelope for declarative relational and aggregate billing rules. The Library contains one schema-identified JSON payload. It does not carry CQL or FHIRPath execution logic. Rule semantics are defined by the billing-rule vocabularies and the referenced payload schema; a private evaluator consumes the resolved artifact. One instance represents one source, catalog scope, effective period, and optional contract, tenant, or specialty partition.
Copyright 2026+ cognovis GmbH. Cognovis-authored material is licensed under Apache-2.0; third-party material retains its own terms as documented in THIRD_PARTY_NOTICES.md.
Represents a library of quality improvement components
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 NOT contain nested Resources
not(parent::f:contained and f:contained)
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(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@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
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
If a resource is contained in another resource, it SHALL NOT have a security label
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.
A resource should have narrative for robust management
Name should be usable as an identifier for the module by machine processing applications such as code generation
not(exists(f:name/@value)) or matches(f:name/@value, '[A-Z]([A-Za-z0-9_]){0,254}')
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.
All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
A set of rules under which this content was created
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
The base language in which the resource is written.
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).
Text summary of the resource, for human interpretation
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.
Must have either extensions or value[x], not both
exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
Source identity and reproducibility metadata for an immutable billing catalog or rule snapshot. The extension identifies the source artifact without embedding its bytes.
exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
The source digest must be a lowercase SHA-256 value prefixed with sha256:.
extension.where(url = 'sourceDigest').value.ofType(string).matches('^sha256:[0-9a-f]{64}$')
URI of the JSON Schema that validates the rule payload carried by a billing rule-set Library.
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/fhir/R4/extensibility.html#modifierExtension).
Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Canonical identifier for this library, represented as a URI (globally unique)
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/R4/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/R4/resource.html#meta) element to indicate where the current master source of the resource can be found.
Allows the library to be referenced by a single globally unique identifier.
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.
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Extensions are always sliced by (at least) url
Additional content defined by implementations
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 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.
usual | official | temp | secondary | old (If known)
Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Identifies the purpose for this identifier, if known .
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Allows users to make use of identifiers when the identifier system is not known.
A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Identifier.system is always case sensitive.
There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](http://hl7.org/fhir/R4/extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
Time period when id is/was valid for use
Time period during which identifier is/was valid for use.
Role.effectiveTime or implied by context
Organization that issued id (may be just text)
Organization that issued/manages the identifier.
The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
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].
Name for this library (computer friendly)
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.
Support human navigation and code generation.
A short, descriptive, user-friendly title for the library.
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.
The status of this library. Enables tracking the life-cycle of the content.
Allows filtering of libraries that are appropriate for use vs. not.
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/evaluation/marketing) and is not intended to be used for genuine usage.
Allows filtering of librarys that are appropriate for use versus not.
Enables experimental content to be developed following the same lifecycle that would be used for a production-level library.
logic-library | model-definition | asset-collection | module-definition
Identifies the type of library such as a Logic Library, Model Definition, Asset Collection, or Module Definition.
The type of knowledge asset this library contains.
Type of individual the library content is focused on
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.
Name of the publisher (organization or individual)
The name of the organization or individual that published the library.
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.
Contact details to assist a user in finding and communicating with the publisher.
May be a web site, an email address, a telephone number, etc.
Natural language description of the library
A free text natural language description of the library from a consumer's perspective.
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 context that the content is intended to support
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.
Assist in searching for appropriate content.
A code that identifies the type of context being specified by this usage context.
A code that specifies a type of context being specified by a usage context.
A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.
A reference to a code defined by a terminology system.
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Allows for alternative encodings within a code system, and translations to other code systems.
fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
The identification of the code system that defines the meaning of the symbol in the code.
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
Need to be unambiguous about the source of the definition of the symbol.
fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Need to refer to a particular code in the system.
fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
A representation of the meaning of the code in the system, following the rules of the system.
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
C*E.2 - but note this is not well followed
fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
If this coding was chosen directly by the user
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
Plain text representation of the concept
A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
Very often the text is the same as a displayName of one of the codings.
The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.
C*E.9. But note many systems use C*E.2 for this
fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
A code that defines the specific value for the context being specified.
Intended jurisdiction for library (if applicable)
A legal or geographic region in which the library is intended to be used.
It may be possible for the library to be used in jurisdictions other than those for which it was originally designed or intended.
Countries and regions within which this artifact is targeted for use.
Explanation of why this library is needed and why it has been designed as it has.
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.
Describes the clinical usage of the library
A detailed description of how the library is used from a clinical perspective.
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.
When the library was approved by publisher
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.
The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
If specified, this date follows 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;moodCode=EVN;code="review"].effectiveTime
The period during which the library content was or is planned to be in active use.
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.
The start of the period. The boundary is inclusive.
If the low element is missing, the meaning is that the low boundary is not known.
End time with inclusive boundary, if not ongoing
The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.
The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.
If the end of the period is missing, it means that the period is ongoing
E.g. Education, Treatment, Assessment, etc.
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.
High-level categorization of the definition, used for searching, sorting, and filtering.
An individiual or organization primarily involved in the creation and maintenance of the content.
An individual or organization primarily responsible for internal coherence of the content.
An individual or organization primarily responsible for review of some aspect of the content.
.participation[typeCode=VRF] {not clear whether VRF best corresponds to reviewer or endorser}
An individual or organization responsible for officially endorsing the content for use in some setting.
Additional documentation, citations, etc.
Related artifacts such as additional documentation, justification, or bibliographic references.
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}
The parameter element defines parameters used by the library.
Describes a set of data that must be provided in order to be able to successfully perform the computations defined by the library.
Contents of the library, either embedded or referenced
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.
Mime type of the content, with charset etc.
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.
Processors of the data need to be able to know how to interpret the data.
The mime type of an attachment. Any valid mime type is allowed.
ED.2+ED.3/RP.2+RP.3. Note conversion may be needed if old style values are being used
The human language of the content. The value can be any valid value according to BCP 47.
Users need to be able to choose between the languages in a set of attachments.
The actual data of the attachment - a sequence of bytes, base64 encoded.
The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON.
The data needs to able to be transmitted inline.
A location where the data can be accessed.
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.
The data needs to be transmitted by reference.
RP.1+RP.2 - if they refer to a URL (see v2.6)
Number of bytes of content (if url provided)
The number of bytes of data that make up this attachment (before base64 encoding, if that is done).
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.
Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all.
The calculated hash of the data using SHA-1. Represented using base64.
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](http://hl7.org/fhir/R4/provenance-definitions.html#Provenance.signature) for mechanism to protect a resource with a digital signature.
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).
A label or set of text to display in place of the data.
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.
The date that the attachment was first created.
This is often tracked as an integrity issue for use of the attachment.