Gravitate Health FHIR Implementation Guide, published by Gravitate Health Project. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/gravitate-health/ and changes regularly. See the Directory of published versions
Active as of 2024-12-20 |
Definitions for the lens resource profile.
Guidance on how to interpret the contents of this table can be found here
0. Library | |
2. Library.extension | |
Control | 1..? |
Must Support | true |
Slicing | This element introduces a set of slices on Library.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
4. Library.extension:lee-version | |
Slice Name | lee-version |
Short | LEE version - string |
Control | 1..1 |
Type | Extension(LEEversion) (Extension Type: string) |
6. Library.identifier | |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 1..? |
Must Support | true |
Slicing | This element introduces a set of slices on Library.identifier . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
8. Library.identifier:gravitateIdentifier | |
Slice Name | gravitateIdentifier |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..1 |
10. Library.identifier:gravitateIdentifier.system | |
Control | 1..? |
Pattern Value | http://gravitate-health.lst.tfo.upm.es |
12. Library.identifier:gravitateIdentifier.value | |
Binding | Unless not suitable, these codes SHALL be taken from LensCategories (extensible to http://hl7.eu/fhir/ig/gravitate-health/ValueSet/LensCategories ) |
14. Library.version | |
Note | This is a business version Id, not a resource version Id (see discussion) |
Control | 1..? |
Must Support | true |
16. Library.name | |
Control | 1..? |
Must Support | true |
18. Library.name.extension | |
Slicing | This element introduces a set of slices on Library.name.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
20. Library.name.extension:translation | |
Slice Name | translation |
Control | 0..* |
Type | Extension(Translation) (Complex Extension) |
Must Support | true |
22. Library.type | |
Pattern Value | { |
24. Library.subject[x] | |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Must Support | true |
26. Library.description | |
Short | documentation |
Control | 1..? |
Must Support | true |
28. Library.description.extension | |
Slicing | This element introduces a set of slices on Library.description.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
30. Library.description.extension:translation | |
Slice Name | translation |
Control | 0..* |
Type | Extension(Translation) (Complex Extension) |
Must Support | true |
32. Library.jurisdiction | |
Short | region |
Control | 1..? |
Must Support | true |
34. Library.purpose | |
Short | Intent |
Control | 1..? |
Must Support | true |
36. Library.purpose.extension | |
Slicing | This element introduces a set of slices on Library.purpose.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
38. Library.purpose.extension:translation | |
Slice Name | translation |
Control | 0..* |
Type | Extension(Translation) (Complex Extension) |
Must Support | true |
40. Library.usage | |
Short | explanation |
Control | 1..? |
Must Support | true |
42. Library.usage.extension | |
Slicing | This element introduces a set of slices on Library.usage.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
44. Library.usage.extension:translation | |
Slice Name | translation |
Control | 0..* |
Type | Extension(Translation) (Complex Extension) |
Must Support | true |
46. Library.copyright | |
Control | 1..? |
Must Support | true |
48. Library.copyright.extension | |
Slicing | This element introduces a set of slices on Library.copyright.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
50. Library.copyright.extension:translation | |
Slice Name | translation |
Control | 0..* |
Type | Extension(Translation) (Complex Extension) |
Must Support | true |
52. Library.approvalDate | |
Must Support | true |
54. Library.lastReviewDate | |
Must Support | true |
56. Library.topic | |
Must Support | true |
58. Library.author | |
Must Support | true |
60. Library.relatedArtifact | |
Short | alternative |
Must Support | true |
62. Library.parameter | |
Control | 1..? |
Must Support | true |
64. Library.parameter.documentation | |
66. Library.parameter.documentation.extension | |
Slicing | This element introduces a set of slices on Library.parameter.documentation.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
68. Library.parameter.documentation.extension:translation | |
Slice Name | translation |
Control | 0..* |
Type | Extension(Translation) (Complex Extension) |
Must Support | true |
70. Library.content | |
Short | The code of the lens - base64 |
Control | 1..? |
Must Support | true |
72. Library.content.contentType | |
Must Support | true |
74. Library.content.language | |
Must Support | true |
76. Library.content.data | |
Must Support | true |
78. Library.content.url | |
Must Support | true |
80. Library.content.hash | |
Must Support | true |
82. Library.content.title | |
Must Support | true |
84. Library.content.title.extension | |
Slicing | This element introduces a set of slices on Library.content.title.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
86. Library.content.title.extension:translation | |
Slice Name | translation |
Control | 0..* |
Type | Extension(Translation) (Complex Extension) |
Must Support | true |
88. Library.content.creation | |
Must Support | true |
Guidance on how to interpret the contents of this table can be found here
0. 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 | Represents a library of quality improvement components |
Control | 0..* |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')) |
2. 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 | A set of rules under which this content was created |
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. |
Control | 0..1 |
Type | uri |
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
4. 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 | Contained, inline 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. |
Control | 0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5 |
Type | Resource |
Is Modifier | false |
Must Support | false |
Summary | false |
Alternate Names | inline resources, anonymous resources, contained resources |
6. Library.extension | |
Definition | An Extension 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 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 | ExtensionAdditional content defined by implementations |
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. |
Control | 10..* |
Type | Extension |
Is Modifier | false |
Must Support | true |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
Slicing | This element introduces a set of slices on Library.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
8. Library.extension:lee-version | |
Slice Name | lee-version |
Definition | Version of the Lens Execution Environment (LEE) |
Short | LEE version - string |
Control | 1..1 |
Type | Extension(LEEversion) (Extension Type: string) |
Is Modifier | false |
Must Support | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
10. 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 | Extensions that cannot be ignored |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them |
Must Support | false |
Summary | true |
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 |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
12. 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 | Additional identifier for the library |
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. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 10..* |
Type | Identifier |
Is Modifier | false |
Must Support | true |
Summary | true |
Requirements | Allows externally provided and/or usable business identifiers to be easily associated with the module. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on Library.identifier . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
14. Library.identifier:gravitateIdentifier | |
Slice Name | gravitateIdentifier |
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 | Additional identifier for the library |
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. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..1* |
Type | Identifier |
Is Modifier | false |
Must Support | false |
Summary | true |
Requirements | Allows externally provided and/or usable business identifiers to be easily associated with the module. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
16. Library.identifier:gravitateIdentifier.use | |
Definition | The purpose of this identifier. |
Short | usual | official | temp | secondary | old (If known) |
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
Control | 0..1 |
Binding | The codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0 (required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 )Identifies the purpose for this identifier, if known . |
Type | code |
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
18. Library.identifier:gravitateIdentifier.system | |
Definition | Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. |
Short | The namespace for the identifier value |
Comments | Identifier.system is always case sensitive. |
Control | 10..1 |
Type | uri |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | 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. |
Pattern Value | http://gravitate-health.lst.tfo.upm.es |
Example | <br/><b>General</b>:http://www.acme.com/identifiers/patient |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
20. Library.identifier:gravitateIdentifier.value | |
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
Short | The value that is unique |
Comments | 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 http://hl7.org/fhir/StructureDefinition/rendered-value). 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. |
Control | 0..1 This element is affected by the following invariants: ident-1 |
Binding | Unless not suitable, these codes SHALL be taken from For codes, see LensCategories (extensible to http://hl7.eu/fhir/ig/gravitate-health/ValueSet/LensCategories ) |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Example | <br/><b>General</b>:123456 |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
22. 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 | Business version of the library |
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. |
Note | This is a business version Id, not a resource version Id (see discussion) |
Control | 10..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
24. 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 | Name for this library (computer friendly) |
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. |
Control | 10..1 This element is affected by the following invariants: cnl-0 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Requirements | Support human navigation and code generation. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
26. Library.name.extension | |
Definition | An Extension 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 | ExtensionAdditional content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
Slicing | This element introduces a set of slices on Library.name.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
28. Library.name.extension:translation | |
Slice Name | translation |
Definition | Language translation from base language of resource to another language. |
Short | Language Translation (Localization) |
Control | 0..* |
Type | Extension(Translation) (Complex Extension) |
Is Modifier | false |
Must Support | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
30. Library.status | |
Definition | The status of this library. Enables tracking the life-cycle of the content. |
Short | draft | active | retired | unknown |
Comments | Allows filtering of libraries that are appropriate for use vs. not. See guidance around (not) making local changes to elements here. Allows filtering of libraries that are appropriate for use vs. not. See guidance around (not) making local changes to elements here. |
Control | 1..1 |
Binding | The codes SHALL be taken from PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|5.0.0 (required to http://hl7.org/fhir/ValueSet/publication-status|5.0.0 )The lifecycle status of an artifact. |
Type | code |
Is Modifier | true because This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
32. Library.type | |
Definition | Identifies the type of library such as a Logic Library, Model Definition, Asset Collection, or Module Definition. |
Short | logic-library | model-definition | asset-collection | module-definition |
Control | 1..1 |
Binding | Unless not suitable, these codes SHALL be taken from LibraryTypehttp://hl7.org/fhir/ValueSet/library-type (extensible to http://hl7.org/fhir/ValueSet/library-type )The type of knowledge asset this library contains. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | true |
Pattern Value | { |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
34. Library.subject[x] | |
Definition | A code or group definition that describes the intended subject of the contents of the library. |
Short | Type of individual the library content is focused on |
Control | 0..1 |
Binding | Unless not suitable, these codes SHALL be taken from ParticipantResourceTypeshttp://hl7.org/fhir/ValueSet/participant-resource-types (extensible to http://hl7.org/fhir/ValueSet/participant-resource-types )The possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.). |
Type | Choice of: CodeableConcept, Reference(Group) |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
Summary | false |
Meaning if Missing | Patient |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
36. Library.description | |
Definition | A free text natural language description of the library from a consumer's perspective. |
Short | documentationNatural language description of the library |
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). |
Control | 10..1 |
Type | markdown |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
38. Library.description.extension | |
Definition | An Extension 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 | ExtensionAdditional content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
Slicing | This element introduces a set of slices on Library.description.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
40. Library.description.extension:translation | |
Slice Name | translation |
Definition | Language translation from base language of resource to another language. |
Short | Language Translation (Localization) |
Control | 0..* |
Type | Extension(Translation) (Complex Extension) |
Is Modifier | false |
Must Support | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
42. Library.jurisdiction | |
Definition | A legal or geographic region in which the library is intended to be used. |
Short | regionIntended jurisdiction for library (if applicable) |
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.) |
Control | 10..* |
Binding | Unless not suitable, these codes SHALL be taken from JurisdictionValueSethttp://hl7.org/fhir/ValueSet/jurisdiction (extensible to http://hl7.org/fhir/ValueSet/jurisdiction )Countries and regions within which this artifact is targeted for use. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
44. Library.purpose | |
Definition | Explanation of why this library is needed and why it has been designed as it has. |
Short | IntentWhy this library is defined |
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. |
Control | 10..1 |
Type | markdown |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
46. Library.purpose.extension | |
Definition | An Extension 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 | ExtensionAdditional content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
Slicing | This element introduces a set of slices on Library.purpose.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
48. Library.purpose.extension:translation | |
Slice Name | translation |
Definition | Language translation from base language of resource to another language. |
Short | Language Translation (Localization) |
Control | 0..* |
Type | Extension(Translation) (Complex Extension) |
Is Modifier | false |
Must Support | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
50. Library.usage | |
Definition | A detailed description of how the library is used from a clinical perspective. |
Short | explanationDescribes the clinical usage of the library |
Control | 10..1 |
Type | markdown |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
52. Library.usage.extension | |
Definition | An Extension 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 | ExtensionAdditional content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
Slicing | This element introduces a set of slices on Library.usage.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
54. Library.usage.extension:translation | |
Slice Name | translation |
Definition | Language translation from base language of resource to another language. |
Short | Language Translation (Localization) |
Control | 0..* |
Type | Extension(Translation) (Complex Extension) |
Is Modifier | false |
Must Support | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
56. 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 | Use and/or publishing restrictions |
Comments | The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element. |
Control | 10..1 |
Type | markdown |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | false |
Requirements | Consumers must be able to determine any legal restrictions on the use of the library and/or its content. |
Alternate Names | License, Restrictions |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
58. Library.copyright.extension | |
Definition | An Extension 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 | ExtensionAdditional content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
Slicing | This element introduces a set of slices on Library.copyright.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
60. Library.copyright.extension:translation | |
Slice Name | translation |
Definition | Language translation from base language of resource to another language. |
Short | Language Translation (Localization) |
Control | 0..* |
Type | Extension(Translation) (Complex Extension) |
Is Modifier | false |
Must Support | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
62. 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 | When the library was approved by publisher |
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. 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. |
Control | 0..1 |
Type | date |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
64. 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 | When the library was last reviewed by the publisher |
Comments | If specified, this date follows the original approval date. See guidance around (not) making local changes to elements here. If specified, this date follows the original approval date. See guidance around (not) making local changes to elements here. |
Control | 0..1 |
Type | date |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | false |
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. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
66. 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 | E.g. Education, Treatment, Assessment, etc |
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) |
Control | 0..* |
Binding | For example codes, see DefinitionTopichttp://hl7.org/fhir/ValueSet/definition-topic (example to http://hl7.org/fhir/ValueSet/definition-topic )High-level categorization of the definition, used for searching, sorting, and filtering. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | true |
Summary | false |
Requirements | Repositories must be able to determine how to categorize the library so that it can be found by topical searches. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
68. Library.author | |
Definition | An individiual or organization primarily involved in the creation and maintenance of the content. |
Short | Who authored the content |
Control | 0..* |
Type | ContactDetail |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
70. Library.relatedArtifact | |
Definition | Related artifacts such as additional documentation, justification, or bibliographic references. |
Short | alternativeAdditional documentation, citations, etc |
Comments | Each related artifact is either an attachment, or a reference to another resource, but not both. |
Control | 0..* |
Type | RelatedArtifact |
Is Modifier | false |
Must Support | true |
Summary | false |
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. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
72. Library.parameter | |
Definition | The parameter element defines parameters used by the library. |
Short | Parameters defined by the library |
Control | 10..* |
Type | ParameterDefinition |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
74. Library.parameter.use | |
Definition | Whether the parameter is input or output for the module. |
Short | in | out |
Control | 1..1 |
Binding | The codes SHALL be taken from OperationParameterUsehttp://hl7.org/fhir/ValueSet/operation-parameter-use|5.0.0 (required to http://hl7.org/fhir/ValueSet/operation-parameter-use|5.0.0 )Whether the parameter is input or output. |
Type | code |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
76. Library.parameter.documentation | |
Definition | A brief discussion of what the parameter is for and how it is used by the module. |
Short | A brief description of the parameter |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
78. Library.parameter.documentation.extension | |
Definition | An Extension 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 | ExtensionAdditional content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
Slicing | This element introduces a set of slices on Library.parameter.documentation.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
80. Library.parameter.documentation.extension:translation | |
Slice Name | translation |
Definition | Language translation from base language of resource to another language. |
Short | Language Translation (Localization) |
Control | 0..* |
Type | Extension(Translation) (Complex Extension) |
Is Modifier | false |
Must Support | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
82. Library.parameter.type | |
Definition | The type of the parameter. |
Short | What type of value |
Control | 1..1 |
Binding | The codes SHALL be taken from FHIRTypeshttp://hl7.org/fhir/ValueSet/fhir-types|5.0.0 (required to http://hl7.org/fhir/ValueSet/fhir-types|5.0.0 )List of FHIR types (resources, data types). |
Type | code |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
84. 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 | The code of the lens - base64Contents of the library, either embedded or referenced |
Control | 10..* |
Type | Attachment |
Is Modifier | false |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
86. 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 | Mime type of the content, with charset etc. |
Control | 0..1 This element is affected by the following invariants: att-1 |
Binding | The codes SHALL be taken from MimeTypeshttp://hl7.org/fhir/ValueSet/mimetypes|5.0.0 (required to http://hl7.org/fhir/ValueSet/mimetypes|5.0.0 )BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) |
Type | code |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Requirements | Processors of the data need to be able to know how to interpret the data. |
Example | <br/><b>General</b>:text/plain; charset=UTF-8, image/png |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
88. Library.content.language | |
Definition | The human language of the content. The value can be any valid value according to BCP 47. |
Short | Human language of the content (BCP-47) |
Control | 0..1 |
Binding | The codes SHALL be taken from AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 (required to http://hl7.org/fhir/ValueSet/all-languages|5.0.0 )IETF language tag for a human language. |
Type | code |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Requirements | Users need to be able to choose between the languages in a set of attachments. |
Example | <br/><b>General</b>:en-AU |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
90. Library.content.data | |
Definition | The actual data of the attachment - a sequence of bytes, base64 encoded. |
Short | Data inline, base64ed |
Comments | The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON. |
Control | 0..1 This element is affected by the following invariants: att-1 |
Type | base64Binary |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | false |
Requirements | The data needs to able to be transmitted inline. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
92. Library.content.url | |
Definition | A location where the data can be accessed. |
Short | Uri where the data can be found |
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. |
Control | 0..1 |
Type | url |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Requirements | The data needs to be transmitted by reference. |
Example | <br/><b>General</b>:http://www.acme.com/logo-small.png |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
94. Library.content.hash | |
Definition | The calculated hash of the data using SHA-1. Represented using base64. |
Short | Hash of the data (sha-1, base64ed) |
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. 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. |
Control | 0..1 |
Type | base64Binary |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
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). |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
96. Library.content.title | |
Definition | A label or set of text to display in place of the data. |
Short | Label to display in place of the data |
Comments | May sometimes be derived from the source filename. |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
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. |
Example | <br/><b>General</b>:Official Corporate Logo |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
98. Library.content.title.extension | |
Definition | An Extension 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 | ExtensionAdditional content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
Slicing | This element introduces a set of slices on Library.content.title.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
100. Library.content.title.extension:translation | |
Slice Name | translation |
Definition | Language translation from base language of resource to another language. |
Short | Language Translation (Localization) |
Control | 0..* |
Type | Extension(Translation) (Complex Extension) |
Is Modifier | false |
Must Support | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
102. Library.content.creation | |
Definition | The date that the attachment was first created. |
Short | Date attachment was first created |
Control | 0..1 |
Type | dateTime |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Requirements | This is often tracked as an integrity issue for use of the attachment. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Guidance on how to interpret the contents of this table can be found here
0. 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 | Represents a library of quality improvement components |
Control | 0..* |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$') ) |
2. Library.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Short | Logical id of this artifact |
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. |
Control | 0..1 |
Type | id |
Is Modifier | false |
Must Support | false |
Summary | true |
4. 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 | Metadata about the resource |
Control | 0..1 |
Type | Meta |
Is Modifier | false |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
6. 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 | A set of rules under which this content was created |
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. |
Control | 0..1 |
Type | uri |
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
8. Library.language | |
Definition | The base language in which the resource is written. |
Short | Language of the resource content |
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). |
Control | 0..1 |
Binding | The codes SHALL be taken from AllLanguages (required to http://hl7.org/fhir/ValueSet/all-languages|5.0.0 )IETF language tag for a human language |
Type | code |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
10. 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 | Text summary of the resource, for human interpretation |
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. |
Control | 0..1 This element is affected by the following invariants: dom-6 |
Type | Narrative |
Is Modifier | false |
Must Support | false |
Summary | false |
Alternate Names | narrative, html, xhtml, display |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
12. 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 | Contained, inline 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. |
Control | 0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5 |
Type | Resource |
Is Modifier | false |
Must Support | false |
Summary | false |
Alternate Names | inline resources, anonymous resources, contained resources |
14. Library.extension | |
Definition | An Extension |
Short | Extension |
Control | 1..* |
Type | Extension |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
Slicing | This element introduces a set of slices on Library.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
16. Library.extension:lee-version | |
Slice Name | lee-version |
Definition | Version of the Lens Execution Environment (LEE) |
Short | LEE version - string |
Control | 1..1 |
Type | Extension(LEEversion) (Extension Type: string) |
Is Modifier | false |
Must Support | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
18. 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 | Extensions that cannot be ignored |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them |
Must Support | false |
Summary | true |
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 |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
20. 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 | Canonical identifier for this library, represented as a URI (globally unique) |
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. |
Control | 0..1 |
Type | uri |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Requirements | Allows the library to be referenced by a single globally unique identifier. |
Invariants | cnl-1: URL should not contain | or # - these characters make processing canonical references problematic (exists() implies matches('^[^|# ]+$') )ele-1: All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count()) ) |
22. 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 | Additional identifier for the library |
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. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 1..* |
Type | Identifier |
Is Modifier | false |
Must Support | true |
Summary | true |
Requirements | Allows externally provided and/or usable business identifiers to be easily associated with the module. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
Slicing | This element introduces a set of slices on Library.identifier . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
24. Library.identifier:gravitateIdentifier | |
Slice Name | gravitateIdentifier |
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 | Additional identifier for the library |
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. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..1 |
Type | Identifier |
Is Modifier | false |
Must Support | false |
Summary | true |
Requirements | Allows externally provided and/or usable business identifiers to be easily associated with the module. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
26. Library.identifier:gravitateIdentifier.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 | Unique id for inter-element referencing |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | id |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
28. Library.identifier:gravitateIdentifier.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 | Additional content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
Slicing | This element introduces a set of slices on Library.identifier.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
30. Library.identifier:gravitateIdentifier.use | |
Definition | The purpose of this identifier. |
Short | usual | official | temp | secondary | old (If known) |
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
Control | 0..1 |
Binding | The codes SHALL be taken from IdentifierUse (required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 )Identifies the purpose for this identifier, if known . |
Type | code |
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
32. Library.identifier:gravitateIdentifier.type | |
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
Short | Description of identifier |
Comments | 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. |
Control | 0..1 |
Binding | Unless not suitable, these codes SHALL be taken from IdentifierTypeCodes (extensible to http://hl7.org/fhir/ValueSet/identifier-type )A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
Type | CodeableConcept |
Is Modifier | false |
Summary | true |
Requirements | Allows users to make use of identifiers when the identifier system is not known. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
34. Library.identifier:gravitateIdentifier.system | |
Definition | Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. |
Short | The namespace for the identifier value |
Comments | Identifier.system is always case sensitive. |
Control | 1..1 |
Type | uri |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | 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. |
Pattern Value | http://gravitate-health.lst.tfo.upm.es |
Example | <br/><b>General</b>:http://www.acme.com/identifiers/patient |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
36. Library.identifier:gravitateIdentifier.value | |
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
Short | The value that is unique |
Comments | 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 http://hl7.org/fhir/StructureDefinition/rendered-value). 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. |
Control | 0..1 This element is affected by the following invariants: ident-1 |
Binding | Unless not suitable, these codes SHALL be taken from LensCategories (extensible to http://hl7.eu/fhir/ig/gravitate-health/ValueSet/LensCategories ) |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Example | <br/><b>General</b>:123456 |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
38. Library.identifier:gravitateIdentifier.period | |
Definition | Time period during which identifier is/was valid for use. |
Short | Time period when id is/was valid for use |
Control | 0..1 |
Type | Period |
Is Modifier | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
40. Library.identifier:gravitateIdentifier.assigner | |
Definition | Organization that issued/manages the identifier. |
Short | Organization that issued id (may be just text) |
Comments | 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. |
Control | 0..1 |
Type | Reference(Organization) |
Is Modifier | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
42. 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 | Business version of the library |
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. |
Note | This is a business version Id, not a resource version Id (see discussion) |
Control | 1..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
44. Library.versionAlgorithm[x] | |
Definition | Indicates the mechanism used to compare versions to determine which is more current. |
Short | How to compare versions |
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. |
Control | 0..1 |
Binding | Unless not suitable, these codes SHALL be taken from VersionAlgorithm (extensible to http://hl7.org/fhir/ValueSet/version-algorithm ) |
Type | Choice of: string, Coding |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
46. 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 | Name for this library (computer friendly) |
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. |
Control | 1..1 This element is affected by the following invariants: cnl-0 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Requirements | Support human navigation and code generation. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
48. Library.name.id | |
Definition | unique id for the element within a resource (for internal references) |
Short | xml:id (or equivalent in JSON) |
Control | 0..1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
50. Library.name.extension | |
Definition | An Extension |
Short | Extension |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
Slicing | This element introduces a set of slices on Library.name.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
52. Library.name.extension:translation | |
Slice Name | translation |
Definition | Language translation from base language of resource to another language. |
Short | Language Translation (Localization) |
Control | 0..* |
Type | Extension(Translation) (Complex Extension) |
Is Modifier | false |
Must Support | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
54. Library.name.value | |
Definition | The actual value |
Short | Primitive value for string |
Control | 0..1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
Max Length: | 1048576 |
56. Library.title | |
Definition | A short, descriptive, user-friendly title for the library. |
Short | Name for this library (human friendly) |
Comments | This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
58. Library.subtitle | |
Definition | An explanatory or alternate title for the library giving additional information about its content. |
Short | Subordinate title of the library |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
60. Library.status | |
Definition | The status of this library. Enables tracking the life-cycle of the content. |
Short | draft | active | retired | unknown |
Comments | Allows filtering of libraries that are appropriate for use vs. not. See guidance around (not) making local changes to elements here. |
Control | 1..1 |
Binding | The codes SHALL be taken from PublicationStatus (required to http://hl7.org/fhir/ValueSet/publication-status|5.0.0 )The lifecycle status of an artifact. |
Type | code |
Is Modifier | true because This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
62. 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 | For testing purposes, not real usage |
Comments | Allows filtering of librarys that are appropriate for use versus not. |
Control | 0..1 |
Type | boolean |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Requirements | Enables experimental content to be developed following the same lifecycle that would be used for a production-level library. |
Meaning if Missing | If absent, this resource is treated as though it is not experimental. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
64. Library.type | |
Definition | Identifies the type of library such as a Logic Library, Model Definition, Asset Collection, or Module Definition. |
Short | logic-library | model-definition | asset-collection | module-definition |
Control | 1..1 |
Binding | Unless not suitable, these codes SHALL be taken from LibraryType (extensible to http://hl7.org/fhir/ValueSet/library-type )The type of knowledge asset this library contains. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | true |
Pattern Value | { |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
66. Library.subject[x] | |
Definition | A code or group definition that describes the intended subject of the contents of the library. |
Short | Type of individual the library content is focused on |
Control | 0..1 |
Binding | Unless not suitable, these codes SHALL be taken from ParticipantResourceTypes (extensible to http://hl7.org/fhir/ValueSet/participant-resource-types )The possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.). |
Type | Choice of: CodeableConcept, Reference(Group) |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
Summary | false |
Meaning if Missing | Patient |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
68. 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 | Date last changed |
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. |
Control | 0..1 |
Type | dateTime |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Alternate Names | Revision Date |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
70. Library.publisher | |
Definition | The name of the organization or individual responsible for the release and ongoing maintenance of the library. |
Short | Name of the publisher/steward (organization or individual) |
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. |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Requirements | Helps establish the "authority/credibility" of the library. May also allow for contact. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
72. Library.contact | |
Definition | Contact details to assist a user in finding and communicating with the publisher. |
Short | Contact details for the publisher |
Comments | May be a web site, an email address, a telephone number, etc. See guidance around (not) making local changes to elements here. |
Control | 0..* |
Type | ContactDetail |
Is Modifier | false |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
74. Library.description | |
Definition | A free text natural language description of the library from a consumer's perspective. |
Short | documentation |
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). |
Control | 1..1 |
Type | markdown |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
76. Library.description.id | |
Definition | unique id for the element within a resource (for internal references) |
Short | xml:id (or equivalent in JSON) |
Control | 0..1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
78. Library.description.extension | |
Definition | An Extension |
Short | Extension |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
Slicing | This element introduces a set of slices on Library.description.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
80. Library.description.extension:translation | |
Slice Name | translation |
Definition | Language translation from base language of resource to another language. |
Short | Language Translation (Localization) |
Control | 0..* |
Type | Extension(Translation) (Complex Extension) |
Is Modifier | false |
Must Support | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
82. Library.description.value | |
Definition | Primitive value for markdown |
Short | Primitive value for markdown |
Control | 0..1 |
Type | markdown |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
84. 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 | The context that the content is intended to support |
Comments | When multiple useContexts are specified, there is no expectation that all or any of the contexts apply. |
Control | 0..* |
Type | UsageContext |
Is Modifier | false |
Must Support | false |
Summary | true |
Requirements | Assist in searching for appropriate content. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
86. Library.jurisdiction | |
Definition | A legal or geographic region in which the library is intended to be used. |
Short | region |
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.) |
Control | 1..* |
Binding | Unless not suitable, these codes SHALL be taken from JurisdictionValueSet (extensible to http://hl7.org/fhir/ValueSet/jurisdiction )Countries and regions within which this artifact is targeted for use. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
88. Library.purpose | |
Definition | Explanation of why this library is needed and why it has been designed as it has. |
Short | Intent |
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. |
Control | 1..1 |
Type | markdown |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
90. Library.purpose.id | |
Definition | unique id for the element within a resource (for internal references) |
Short | xml:id (or equivalent in JSON) |
Control | 0..1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
92. Library.purpose.extension | |
Definition | An Extension |
Short | Extension |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
Slicing | This element introduces a set of slices on Library.purpose.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
94. Library.purpose.extension:translation | |
Slice Name | translation |
Definition | Language translation from base language of resource to another language. |
Short | Language Translation (Localization) |
Control | 0..* |
Type | Extension(Translation) (Complex Extension) |
Is Modifier | false |
Must Support | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
96. Library.purpose.value | |
Definition | Primitive value for markdown |
Short | Primitive value for markdown |
Control | 0..1 |
Type | markdown |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
98. Library.usage | |
Definition | A detailed description of how the library is used from a clinical perspective. |
Short | explanation |
Control | 1..1 |
Type | markdown |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
100. Library.usage.id | |
Definition | unique id for the element within a resource (for internal references) |
Short | xml:id (or equivalent in JSON) |
Control | 0..1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
102. Library.usage.extension | |
Definition | An Extension |
Short | Extension |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
Slicing | This element introduces a set of slices on Library.usage.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
104. Library.usage.extension:translation | |
Slice Name | translation |
Definition | Language translation from base language of resource to another language. |
Short | Language Translation (Localization) |
Control | 0..* |
Type | Extension(Translation) (Complex Extension) |
Is Modifier | false |
Must Support | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
106. Library.usage.value | |
Definition | Primitive value for markdown |
Short | Primitive value for markdown |
Control | 0..1 |
Type | markdown |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
108. 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 | Use and/or publishing restrictions |
Comments | The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element. |
Control | 1..1 |
Type | markdown |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | false |
Requirements | Consumers must be able to determine any legal restrictions on the use of the library and/or its content. |
Alternate Names | License, Restrictions |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
110. Library.copyright.id | |
Definition | unique id for the element within a resource (for internal references) |
Short | xml:id (or equivalent in JSON) |
Control | 0..1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
112. Library.copyright.extension | |
Definition | An Extension |
Short | Extension |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
Slicing | This element introduces a set of slices on Library.copyright.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
114. Library.copyright.extension:translation | |
Slice Name | translation |
Definition | Language translation from base language of resource to another language. |
Short | Language Translation (Localization) |
Control | 0..* |
Type | Extension(Translation) (Complex Extension) |
Is Modifier | false |
Must Support | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
116. Library.copyright.value | |
Definition | Primitive value for markdown |
Short | Primitive value for markdown |
Control | 0..1 |
Type | markdown |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
118. 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 | Copyright holder and year(s) |
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. |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | false |
Requirements | Defines the content expected to be rendered in all representations of the artifact. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
120. 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 | When the library was approved by publisher |
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. |
Control | 0..1 |
Type | date |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
122. 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 | When the library was last reviewed by the publisher |
Comments | If specified, this date follows the original approval date. See guidance around (not) making local changes to elements here. |
Control | 0..1 |
Type | date |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | false |
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. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
124. Library.effectivePeriod | |
Definition | The period during which the library content was or is planned to be in active use. |
Short | When the library is expected to be used |
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. |
Control | 0..1 |
Type | Period |
Is Modifier | false |
Must Support | false |
Summary | true |
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. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
126. 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 | E.g. Education, Treatment, Assessment, etc |
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) |
Control | 0..* |
Binding | For example codes, see DefinitionTopic (example to http://hl7.org/fhir/ValueSet/definition-topic )High-level categorization of the definition, used for searching, sorting, and filtering. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | true |
Summary | false |
Requirements | Repositories must be able to determine how to categorize the library so that it can be found by topical searches. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
128. Library.author | |
Definition | An individiual or organization primarily involved in the creation and maintenance of the content. |
Short | Who authored the content |
Control | 0..* |
Type | ContactDetail |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
130. Library.editor | |
Definition | An individual or organization primarily responsible for internal coherence of the content. |
Short | Who edited the content |
Control | 0..* |
Type | ContactDetail |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
132. Library.reviewer | |
Definition | An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the content. |
Short | Who reviewed the content |
Comments | See guidance around (not) making local changes to elements here. |
Control | 0..* |
Type | ContactDetail |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
134. 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 | Who endorsed the content |
Comments | See guidance around (not) making local changes to elements here. |
Control | 0..* |
Type | ContactDetail |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
136. Library.relatedArtifact | |
Definition | Related artifacts such as additional documentation, justification, or bibliographic references. |
Short | alternative |
Comments | Each related artifact is either an attachment, or a reference to another resource, but not both. |
Control | 0..* |
Type | RelatedArtifact |
Is Modifier | false |
Must Support | true |
Summary | false |
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. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
138. Library.parameter | |
Definition | The parameter element defines parameters used by the library. |
Short | Parameters defined by the library |
Control | 1..* |
Type | ParameterDefinition |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
140. Library.parameter.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 | Unique id for inter-element referencing |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | id |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
142. Library.parameter.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 | Additional content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
Slicing | This element introduces a set of slices on Library.parameter.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
144. Library.parameter.name | |
Definition | The name of the parameter used to allow access to the value of the parameter in evaluation contexts. |
Short | Name used to access the parameter value |
Control | 0..1 |
Type | code |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
146. Library.parameter.use | |
Definition | Whether the parameter is input or output for the module. |
Short | in | out |
Control | 1..1 |
Binding | The codes SHALL be taken from OperationParameterUse (required to http://hl7.org/fhir/ValueSet/operation-parameter-use|5.0.0 )Whether the parameter is input or output. |
Type | code |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
148. Library.parameter.min | |
Definition | The minimum number of times this parameter SHALL appear in the request or response. |
Short | Minimum cardinality |
Control | 0..1 |
Type | integer |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
150. Library.parameter.max | |
Definition | The maximum number of times this element is permitted to appear in the request or response. |
Short | Maximum cardinality (a number of *) |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
152. Library.parameter.documentation | |
Definition | A brief discussion of what the parameter is for and how it is used by the module. |
Short | A brief description of the parameter |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
154. Library.parameter.documentation.id | |
Definition | unique id for the element within a resource (for internal references) |
Short | xml:id (or equivalent in JSON) |
Control | 0..1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
156. Library.parameter.documentation.extension | |
Definition | An Extension |
Short | Extension |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
Slicing | This element introduces a set of slices on Library.parameter.documentation.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
158. Library.parameter.documentation.extension:translation | |
Slice Name | translation |
Definition | Language translation from base language of resource to another language. |
Short | Language Translation (Localization) |
Control | 0..* |
Type | Extension(Translation) (Complex Extension) |
Is Modifier | false |
Must Support | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
160. Library.parameter.documentation.value | |
Definition | The actual value |
Short | Primitive value for string |
Control | 0..1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
Max Length: | 1048576 |
162. Library.parameter.type | |
Definition | The type of the parameter. |
Short | What type of value |
Control | 1..1 |
Binding | The codes SHALL be taken from FHIRTypes (required to http://hl7.org/fhir/ValueSet/fhir-types|5.0.0 )List of FHIR types (resources, data types). |
Type | code |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
164. Library.parameter.profile | |
Definition | If specified, this indicates a profile that the input data must conform to, or that the output data will conform to. |
Short | What profile the value is expected to be |
Control | 0..1 |
Type | canonical(StructureDefinition) |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
166. 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 | What data is referenced by this library |
Control | 0..* |
Type | DataRequirement |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
168. 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 | The code of the lens - base64 |
Control | 1..* |
Type | Attachment |
Is Modifier | false |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
170. 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 | Unique id for inter-element referencing |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | id |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
172. 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 | Additional content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
Slicing | This element introduces a set of slices on Library.content.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
174. 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 | Mime type of the content, with charset etc. |
Control | 0..1 This element is affected by the following invariants: att-1 |
Binding | The codes SHALL be taken from MimeTypes (required to http://hl7.org/fhir/ValueSet/mimetypes|5.0.0 )BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) |
Type | code |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Requirements | Processors of the data need to be able to know how to interpret the data. |
Example | <br/><b>General</b>:text/plain; charset=UTF-8, image/png |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
176. Library.content.language | |
Definition | The human language of the content. The value can be any valid value according to BCP 47. |
Short | Human language of the content (BCP-47) |
Control | 0..1 |
Binding | The codes SHALL be taken from AllLanguages (required to http://hl7.org/fhir/ValueSet/all-languages|5.0.0 )IETF language tag for a human language. |
Type | code |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Requirements | Users need to be able to choose between the languages in a set of attachments. |
Example | <br/><b>General</b>:en-AU |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
178. Library.content.data | |
Definition | The actual data of the attachment - a sequence of bytes, base64 encoded. |
Short | Data inline, base64ed |
Comments | The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON. |
Control | 0..1 This element is affected by the following invariants: att-1 |
Type | base64Binary |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | false |
Requirements | The data needs to able to be transmitted inline. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
180. Library.content.url | |
Definition | A location where the data can be accessed. |
Short | Uri where the data can be found |
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. |
Control | 0..1 |
Type | url |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Requirements | The data needs to be transmitted by reference. |
Example | <br/><b>General</b>:http://www.acme.com/logo-small.png |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
182. Library.content.size | |
Definition | The number of bytes of data that make up this attachment (before base64 encoding, if that is done). |
Short | Number of bytes of content (if url provided) |
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. |
Control | 0..1 |
Type | integer64 |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
184. Library.content.hash | |
Definition | The calculated hash of the data using SHA-1. Represented using base64. |
Short | Hash of the data (sha-1, base64ed) |
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. |
Control | 0..1 |
Type | base64Binary |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
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). |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
186. Library.content.title | |
Definition | A label or set of text to display in place of the data. |
Short | Label to display in place of the data |
Comments | May sometimes be derived from the source filename. |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
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. |
Example | <br/><b>General</b>:Official Corporate Logo |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
188. Library.content.title.id | |
Definition | unique id for the element within a resource (for internal references) |
Short | xml:id (or equivalent in JSON) |
Control | 0..1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
190. Library.content.title.extension | |
Definition | An Extension |
Short | Extension |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
Slicing | This element introduces a set of slices on Library.content.title.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
192. Library.content.title.extension:translation | |
Slice Name | translation |
Definition | Language translation from base language of resource to another language. |
Short | Language Translation (Localization) |
Control | 0..* |
Type | Extension(Translation) (Complex Extension) |
Is Modifier | false |
Must Support | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
194. Library.content.title.value | |
Definition | The actual value |
Short | Primitive value for string |
Control | 0..1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
Max Length: | 1048576 |
196. Library.content.creation | |
Definition | The date that the attachment was first created. |
Short | Date attachment was first created |
Control | 0..1 |
Type | dateTime |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Requirements | This is often tracked as an integrity issue for use of the attachment. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
198. Library.content.height | |
Definition | Height of the image in pixels (photo/video). |
Short | Height of the image in pixels (photo/video) |
Control | 0..1 |
Type | positiveInt |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
200. Library.content.width | |
Definition | Width of the image in pixels (photo/video). |
Short | Width of the image in pixels (photo/video) |
Control | 0..1 |
Type | positiveInt |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
202. 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 | Number of frames if > 1 (photo) |
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. |
Control | 0..1 |
Type | positiveInt |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
204. Library.content.duration | |
Definition | The duration of the recording in seconds - for audio and video. |
Short | Length in seconds (audio / video) |
Comments | The duration might differ from occurrencePeriod if recording was paused. |
Control | 0..1 |
Type | decimal |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
206. Library.content.pages | |
Definition | The number of pages when printed. |
Short | Number of printed pages |
Control | 0..1 |
Type | positiveInt |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |