Gravitate Health FHIR Implementation Guide
0.1.0 - CI Build

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

Resource Profile: Lens - Detailed Descriptions

Active as of 2024-11-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
Control1..?
Must Supporttrue
SlicingThis element introduces a set of slices on Library.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 4. Library.extension:lee-version
    Slice Namelee-version
    ShortLEE version - string
    Control1..1
    TypeExtension(LEEversion) (Extension Type: string)
    6. Library.identifier
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control1..?
    Must Supporttrue
    SlicingThis element introduces a set of slices on Library.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ system
    • 8. Library.identifier:gravitateIdentifier
      Slice NamegravitateIdentifier
      NoteThis is a business identifier, not a resource identifier (see discussion)
      Control0..1
      10. Library.identifier:gravitateIdentifier.system
      Control1..?
      Pattern Valuehttp://gravitate-health.lst.tfo.upm.es
      12. Library.identifier:gravitateIdentifier.value
      BindingUnless not suitable, these codes SHALL be taken from LensCategories
      (extensible to http://hl7.eu/fhir/ig/gravitate-health/ValueSet/LensCategories)
      14. Library.version
      NoteThis is a business version Id, not a resource version Id (see discussion)
      Control1..?
      Must Supporttrue
      16. Library.name
      Control1..?
      Must Supporttrue
      18. Library.name.extension
      SlicingThis element introduces a set of slices on Library.name.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 20. Library.name.extension:translation
        Slice Nametranslation
        Control0..*
        TypeExtension(Translation) (Complex Extension)
        Must Supporttrue
        22. Library.type
        Pattern Value{
          "coding" : [{
            "code" : "logical-library"
          }]
        }
        24. Library.subject[x]
        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
        Must Supporttrue
        26. Library.description
        Shortdocumentation
        Control1..?
        Must Supporttrue
        28. Library.description.extension
        SlicingThis element introduces a set of slices on Library.description.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 30. Library.description.extension:translation
          Slice Nametranslation
          Control0..*
          TypeExtension(Translation) (Complex Extension)
          Must Supporttrue
          32. Library.jurisdiction
          Shortregion
          Control1..?
          Must Supporttrue
          34. Library.purpose
          ShortIntent
          Control1..?
          Must Supporttrue
          36. Library.purpose.extension
          SlicingThis element introduces a set of slices on Library.purpose.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 38. Library.purpose.extension:translation
            Slice Nametranslation
            Control0..*
            TypeExtension(Translation) (Complex Extension)
            Must Supporttrue
            40. Library.usage
            Shortexplanation
            Control1..?
            Must Supporttrue
            42. Library.usage.extension
            SlicingThis element introduces a set of slices on Library.usage.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 44. Library.usage.extension:translation
              Slice Nametranslation
              Control0..*
              TypeExtension(Translation) (Complex Extension)
              Must Supporttrue
              46. Library.copyright
              Control1..?
              Must Supporttrue
              48. Library.copyright.extension
              SlicingThis element introduces a set of slices on Library.copyright.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 50. Library.copyright.extension:translation
                Slice Nametranslation
                Control0..*
                TypeExtension(Translation) (Complex Extension)
                Must Supporttrue
                52. Library.approvalDate
                Must Supporttrue
                54. Library.lastReviewDate
                Must Supporttrue
                56. Library.topic
                Must Supporttrue
                58. Library.author
                Must Supporttrue
                60. Library.relatedArtifact
                Shortalternative
                Must Supporttrue
                62. Library.parameter
                Control1..?
                Must Supporttrue
                64. Library.parameter.documentation
                66. Library.parameter.documentation.extension
                SlicingThis element introduces a set of slices on Library.parameter.documentation.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 68. Library.parameter.documentation.extension:translation
                  Slice Nametranslation
                  Control0..*
                  TypeExtension(Translation) (Complex Extension)
                  Must Supporttrue
                  70. Library.content
                  ShortThe code of the lens - base64
                  Control1..?
                  Must Supporttrue
                  72. Library.content.contentType
                  Must Supporttrue
                  74. Library.content.language
                  Must Supporttrue
                  76. Library.content.data
                  Must Supporttrue
                  78. Library.content.url
                  Must Supporttrue
                  80. Library.content.hash
                  Must Supporttrue
                  82. Library.content.title
                  Must Supporttrue
                  84. Library.content.title.extension
                  SlicingThis element introduces a set of slices on Library.content.title.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 86. Library.content.title.extension:translation
                    Slice Nametranslation
                    Control0..*
                    TypeExtension(Translation) (Complex Extension)
                    Must Supporttrue
                    88. Library.content.creation
                    Must Supporttrue

                    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.

                    ShortRepresents a library of quality improvement components
                    Control0..*
                    Is Modifierfalse
                    Must Supportfalse
                    Summaryfalse
                    Invariantscnl-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.

                    ShortA 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.

                    Control0..1
                    Typeuri
                    Is Modifiertrue 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 ValueThis primitive element may be present, or absent, or replaced by an extension
                    Must Supportfalse
                    Summarytrue
                    Invariantsele-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.

                    ShortContained, 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.

                    Control0..*
                    This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
                    TypeResource
                    Is Modifierfalse
                    Must Supportfalse
                    Summaryfalse
                    Alternate Namesinline 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.

                    ShortExtensionAdditional 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.

                    Control10..*
                    TypeExtension
                    Is Modifierfalse
                    Must Supporttrue
                    Summaryfalse
                    Alternate Namesextensions, user content
                    Invariantsele-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())
                    SlicingThis element introduces a set of slices on Library.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • value @ url
                    • 8. Library.extension:lee-version
                      Slice Namelee-version
                      Definition

                      Version of the Lens Execution Environment (LEE)

                      ShortLEE version - string
                      Control1..1
                      TypeExtension(LEEversion) (Extension Type: string)
                      Is Modifierfalse
                      Must Supportfalse
                      Invariantsele-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).

                      ShortExtensions 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.

                      Control0..*
                      TypeExtension
                      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
                      Must Supportfalse
                      Summarytrue
                      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 Namesextensions, user content
                      Invariantsele-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.

                      ShortAdditional 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.

                      NoteThis is a business identifier, not a resource identifier (see discussion)
                      Control10..*
                      TypeIdentifier
                      Is Modifierfalse
                      Must Supporttrue
                      Summarytrue
                      Requirements

                      Allows externally provided and/or usable business identifiers to be easily associated with the module.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      SlicingThis element introduces a set of slices on Library.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                      • value @ system
                      • 14. Library.identifier:gravitateIdentifier
                        Slice NamegravitateIdentifier
                        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.

                        ShortAdditional 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.

                        NoteThis is a business identifier, not a resource identifier (see discussion)
                        Control0..1*
                        TypeIdentifier
                        Is Modifierfalse
                        Must Supportfalse
                        Summarytrue
                        Requirements

                        Allows externally provided and/or usable business identifiers to be easily associated with the module.

                        Invariantsele-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.

                        Shortusual | official | temp | secondary | old (If known)
                        Comments

                        Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

                        Control0..1
                        BindingThe 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 .

                        Typecode
                        Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        Requirements

                        Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

                        Invariantsele-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.

                        ShortThe namespace for the identifier value
                        Comments

                        Identifier.system is always case sensitive.

                        Control10..1
                        Typeuri
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        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 Valuehttp://gravitate-health.lst.tfo.upm.es
                        Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
                        Invariantsele-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.

                        ShortThe 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.

                        Control0..1
                        This element is affected by the following invariants: ident-1
                        BindingUnless not suitable, these codes SHALL be taken from For codes, see LensCategories
                        (extensible to http://hl7.eu/fhir/ig/gravitate-health/ValueSet/LensCategories)
                        Typestring
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        Example<br/><b>General</b>:123456
                        Invariantsele-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.

                        ShortBusiness 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.

                        NoteThis is a business version Id, not a resource version Id (see discussion)
                        Control10..1
                        Typestring
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supporttrue
                        Summarytrue
                        Invariantsele-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.

                        ShortName 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.

                        Control10..1
                        This element is affected by the following invariants: cnl-0
                        Typestring
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supporttrue
                        Summarytrue
                        Requirements

                        Support human navigation and code generation.

                        Invariantsele-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.

                        ShortExtensionAdditional 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.

                        Control0..*
                        TypeExtension
                        Is Modifierfalse
                        Summaryfalse
                        Alternate Namesextensions, user content
                        Invariantsele-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())
                        SlicingThis element introduces a set of slices on Library.name.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                        • value @ url
                        • 28. Library.name.extension:translation
                          Slice Nametranslation
                          Definition

                          Language translation from base language of resource to another language.

                          ShortLanguage Translation (Localization)
                          Control0..*
                          TypeExtension(Translation) (Complex Extension)
                          Is Modifierfalse
                          Must Supporttrue
                          Invariantsele-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.

                          Shortdraft | 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.

                          Control1..1
                          BindingThe 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.

                          Typecode
                          Is Modifiertrue because This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Must Supportfalse
                          Summarytrue
                          Invariantsele-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.

                          Shortlogic-library | model-definition | asset-collection | module-definition
                          Control1..1
                          BindingUnless 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.

                          TypeCodeableConcept
                          Is Modifierfalse
                          Must Supportfalse
                          Summarytrue
                          Pattern Value{
                            "coding" : [{
                              "code" : "logical-library"
                            }]
                          }
                          Invariantsele-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.

                          ShortType of individual the library content is focused on
                          Control0..1
                          BindingUnless 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.).

                          TypeChoice of: CodeableConcept, Reference(Group)
                          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                          Is Modifierfalse
                          Must Supporttrue
                          Must Support TypesNo must-support rules about the choice of types/profiles
                          Summaryfalse
                          Meaning if MissingPatient
                          Invariantsele-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.

                          ShortdocumentationNatural 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).

                          Control10..1
                          Typemarkdown
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Must Supporttrue
                          Summarytrue
                          Invariantsele-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.

                          ShortExtensionAdditional 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.

                          Control0..*
                          TypeExtension
                          Is Modifierfalse
                          Summaryfalse
                          Alternate Namesextensions, user content
                          Invariantsele-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())
                          SlicingThis element introduces a set of slices on Library.description.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                          • value @ url
                          • 40. Library.description.extension:translation
                            Slice Nametranslation
                            Definition

                            Language translation from base language of resource to another language.

                            ShortLanguage Translation (Localization)
                            Control0..*
                            TypeExtension(Translation) (Complex Extension)
                            Is Modifierfalse
                            Must Supporttrue
                            Invariantsele-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.

                            ShortregionIntended 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.)

                            Control10..*
                            BindingUnless 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.

                            TypeCodeableConcept
                            Is Modifierfalse
                            Must Supporttrue
                            Summarytrue
                            Invariantsele-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.

                            ShortIntentWhy 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.

                            Control10..1
                            Typemarkdown
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Must Supporttrue
                            Summaryfalse
                            Invariantsele-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.

                            ShortExtensionAdditional 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.

                            Control0..*
                            TypeExtension
                            Is Modifierfalse
                            Summaryfalse
                            Alternate Namesextensions, user content
                            Invariantsele-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())
                            SlicingThis element introduces a set of slices on Library.purpose.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                            • value @ url
                            • 48. Library.purpose.extension:translation
                              Slice Nametranslation
                              Definition

                              Language translation from base language of resource to another language.

                              ShortLanguage Translation (Localization)
                              Control0..*
                              TypeExtension(Translation) (Complex Extension)
                              Is Modifierfalse
                              Must Supporttrue
                              Invariantsele-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.

                              ShortexplanationDescribes the clinical usage of the library
                              Control10..1
                              Typemarkdown
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Must Supporttrue
                              Summaryfalse
                              Invariantsele-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.

                              ShortExtensionAdditional 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.

                              Control0..*
                              TypeExtension
                              Is Modifierfalse
                              Summaryfalse
                              Alternate Namesextensions, user content
                              Invariantsele-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())
                              SlicingThis element introduces a set of slices on Library.usage.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                              • value @ url
                              • 54. Library.usage.extension:translation
                                Slice Nametranslation
                                Definition

                                Language translation from base language of resource to another language.

                                ShortLanguage Translation (Localization)
                                Control0..*
                                TypeExtension(Translation) (Complex Extension)
                                Is Modifierfalse
                                Must Supporttrue
                                Invariantsele-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.

                                ShortUse and/or publishing restrictions
                                Comments

                                The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element.

                                Control10..1
                                Typemarkdown
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Must Supporttrue
                                Summaryfalse
                                Requirements

                                Consumers must be able to determine any legal restrictions on the use of the library and/or its content.

                                Alternate NamesLicense, Restrictions
                                Invariantsele-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.

                                ShortExtensionAdditional 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.

                                Control0..*
                                TypeExtension
                                Is Modifierfalse
                                Summaryfalse
                                Alternate Namesextensions, user content
                                Invariantsele-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())
                                SlicingThis element introduces a set of slices on Library.copyright.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                • value @ url
                                • 60. Library.copyright.extension:translation
                                  Slice Nametranslation
                                  Definition

                                  Language translation from base language of resource to another language.

                                  ShortLanguage Translation (Localization)
                                  Control0..*
                                  TypeExtension(Translation) (Complex Extension)
                                  Is Modifierfalse
                                  Must Supporttrue
                                  Invariantsele-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.

                                  ShortWhen 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.

                                  Control0..1
                                  Typedate
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Must Supporttrue
                                  Summaryfalse
                                  Invariantsele-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.

                                  ShortWhen 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.

                                  Control0..1
                                  Typedate
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Must Supporttrue
                                  Summaryfalse
                                  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.

                                  Invariantsele-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.

                                  ShortE.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)

                                  Control0..*
                                  BindingFor 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.

                                  TypeCodeableConcept
                                  Is Modifierfalse
                                  Must Supporttrue
                                  Summaryfalse
                                  Requirements

                                  Repositories must be able to determine how to categorize the library so that it can be found by topical searches.

                                  Invariantsele-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.

                                  ShortWho authored the content
                                  Control0..*
                                  TypeContactDetail
                                  Is Modifierfalse
                                  Must Supporttrue
                                  Summaryfalse
                                  Invariantsele-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.

                                  ShortalternativeAdditional documentation, citations, etc
                                  Comments

                                  Each related artifact is either an attachment, or a reference to another resource, but not both.

                                  Control0..*
                                  TypeRelatedArtifact
                                  Is Modifierfalse
                                  Must Supporttrue
                                  Summaryfalse
                                  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.

                                  Invariantsele-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.

                                  ShortParameters defined by the library
                                  Control10..*
                                  TypeParameterDefinition
                                  Is Modifierfalse
                                  Must Supporttrue
                                  Summaryfalse
                                  Invariantsele-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.

                                  Shortin | out
                                  Control1..1
                                  BindingThe 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.

                                  Typecode
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summarytrue
                                  Invariantsele-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.

                                  ShortA brief description of the parameter
                                  Control0..1
                                  Typestring
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summarytrue
                                  Invariantsele-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.

                                  ShortExtensionAdditional 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.

                                  Control0..*
                                  TypeExtension
                                  Is Modifierfalse
                                  Summaryfalse
                                  Alternate Namesextensions, user content
                                  Invariantsele-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())
                                  SlicingThis element introduces a set of slices on Library.parameter.documentation.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                  • value @ url
                                  • 80. Library.parameter.documentation.extension:translation
                                    Slice Nametranslation
                                    Definition

                                    Language translation from base language of resource to another language.

                                    ShortLanguage Translation (Localization)
                                    Control0..*
                                    TypeExtension(Translation) (Complex Extension)
                                    Is Modifierfalse
                                    Must Supporttrue
                                    Invariantsele-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.

                                    ShortWhat type of value
                                    Control1..1
                                    BindingThe 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).

                                    Typecode
                                    Is Modifierfalse
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Summarytrue
                                    Invariantsele-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.

                                    ShortThe code of the lens - base64Contents of the library, either embedded or referenced
                                    Control10..*
                                    TypeAttachment
                                    Is Modifierfalse
                                    Must Supporttrue
                                    Summarytrue
                                    Invariantsele-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.

                                    ShortMime type of the content, with charset etc.
                                    Control0..1
                                    This element is affected by the following invariants: att-1
                                    BindingThe 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)

                                    Typecode
                                    Is Modifierfalse
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Must Supporttrue
                                    Summarytrue
                                    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
                                    Invariantsele-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.

                                    ShortHuman language of the content (BCP-47)
                                    Control0..1
                                    BindingThe 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.

                                    Typecode
                                    Is Modifierfalse
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Must Supporttrue
                                    Summarytrue
                                    Requirements

                                    Users need to be able to choose between the languages in a set of attachments.

                                    Example<br/><b>General</b>:en-AU
                                    Invariantsele-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.

                                    ShortData inline, base64ed
                                    Comments

                                    The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON.

                                    Control0..1
                                    This element is affected by the following invariants: att-1
                                    Typebase64Binary
                                    Is Modifierfalse
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Must Supporttrue
                                    Summaryfalse
                                    Requirements

                                    The data needs to able to be transmitted inline.

                                    Invariantsele-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.

                                    ShortUri 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.

                                    Control0..1
                                    Typeurl
                                    Is Modifierfalse
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Must Supporttrue
                                    Summarytrue
                                    Requirements

                                    The data needs to be transmitted by reference.

                                    Example<br/><b>General</b>:http://www.acme.com/logo-small.png
                                    Invariantsele-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.

                                    ShortHash 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.

                                    Control0..1
                                    Typebase64Binary
                                    Is Modifierfalse
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Must Supporttrue
                                    Summarytrue
                                    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).

                                    Invariantsele-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.

                                    ShortLabel to display in place of the data
                                    Comments

                                    May sometimes be derived from the source filename.

                                    Control0..1
                                    Typestring
                                    Is Modifierfalse
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Must Supporttrue
                                    Summarytrue
                                    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
                                    Invariantsele-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.

                                    ShortExtensionAdditional 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.

                                    Control0..*
                                    TypeExtension
                                    Is Modifierfalse
                                    Summaryfalse
                                    Alternate Namesextensions, user content
                                    Invariantsele-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())
                                    SlicingThis element introduces a set of slices on Library.content.title.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                    • value @ url
                                    • 100. Library.content.title.extension:translation
                                      Slice Nametranslation
                                      Definition

                                      Language translation from base language of resource to another language.

                                      ShortLanguage Translation (Localization)
                                      Control0..*
                                      TypeExtension(Translation) (Complex Extension)
                                      Is Modifierfalse
                                      Must Supporttrue
                                      Invariantsele-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.

                                      ShortDate attachment was first created
                                      Control0..1
                                      TypedateTime
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Must Supporttrue
                                      Summarytrue
                                      Requirements

                                      This is often tracked as an integrity issue for use of the attachment.

                                      Invariantsele-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.

                                      ShortRepresents a library of quality improvement components
                                      Control0..*
                                      Is Modifierfalse
                                      Must Supportfalse
                                      Summaryfalse
                                      Invariantscnl-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.

                                      ShortLogical 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.

                                      Control0..1
                                      Typeid
                                      Is Modifierfalse
                                      Must Supportfalse
                                      Summarytrue
                                      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.

                                      ShortMetadata about the resource
                                      Control0..1
                                      TypeMeta
                                      Is Modifierfalse
                                      Must Supportfalse
                                      Summarytrue
                                      Invariantsele-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.

                                      ShortA 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.

                                      Control0..1
                                      Typeuri
                                      Is Modifiertrue 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 ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Must Supportfalse
                                      Summarytrue
                                      Invariantsele-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.

                                      ShortLanguage 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).

                                      Control0..1
                                      BindingThe 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

                                      Typecode
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Must Supportfalse
                                      Summaryfalse
                                      Invariantsele-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.

                                      ShortText 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.

                                      Control0..1
                                      This element is affected by the following invariants: dom-6
                                      TypeNarrative
                                      Is Modifierfalse
                                      Must Supportfalse
                                      Summaryfalse
                                      Alternate Namesnarrative, html, xhtml, display
                                      Invariantsele-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.

                                      ShortContained, 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.

                                      Control0..*
                                      This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
                                      TypeResource
                                      Is Modifierfalse
                                      Must Supportfalse
                                      Summaryfalse
                                      Alternate Namesinline resources, anonymous resources, contained resources
                                      14. Library.extension
                                      Definition

                                      An Extension

                                      ShortExtension
                                      Control1..*
                                      TypeExtension
                                      Is Modifierfalse
                                      Must Supporttrue
                                      Summaryfalse
                                      Invariantsele-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())
                                      SlicingThis element introduces a set of slices on Library.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                      • value @ url
                                      • 16. Library.extension:lee-version
                                        Slice Namelee-version
                                        Definition

                                        Version of the Lens Execution Environment (LEE)

                                        ShortLEE version - string
                                        Control1..1
                                        TypeExtension(LEEversion) (Extension Type: string)
                                        Is Modifierfalse
                                        Must Supportfalse
                                        Invariantsele-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).

                                        ShortExtensions 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.

                                        Control0..*
                                        TypeExtension
                                        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
                                        Must Supportfalse
                                        Summarytrue
                                        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 Namesextensions, user content
                                        Invariantsele-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.

                                        ShortCanonical 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.

                                        Control0..1
                                        Typeuri
                                        Is Modifierfalse
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Must Supportfalse
                                        Summarytrue
                                        Requirements

                                        Allows the library to be referenced by a single globally unique identifier.

                                        Invariantscnl-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.

                                        ShortAdditional 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.

                                        NoteThis is a business identifier, not a resource identifier (see discussion)
                                        Control1..*
                                        TypeIdentifier
                                        Is Modifierfalse
                                        Must Supporttrue
                                        Summarytrue
                                        Requirements

                                        Allows externally provided and/or usable business identifiers to be easily associated with the module.

                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        SlicingThis element introduces a set of slices on Library.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                        • value @ system
                                        • 24. Library.identifier:gravitateIdentifier
                                          Slice NamegravitateIdentifier
                                          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.

                                          ShortAdditional 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.

                                          NoteThis is a business identifier, not a resource identifier (see discussion)
                                          Control0..1
                                          TypeIdentifier
                                          Is Modifierfalse
                                          Must Supportfalse
                                          Summarytrue
                                          Requirements

                                          Allows externally provided and/or usable business identifiers to be easily associated with the module.

                                          Invariantsele-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.

                                          ShortUnique id for inter-element referencing
                                          Control0..1
                                          This element is affected by the following invariants: ele-1
                                          Typeid
                                          Is Modifierfalse
                                          XML FormatIn the XML format, this property is represented as an attribute.
                                          Summaryfalse
                                          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.

                                          ShortAdditional 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.

                                          Control0..*
                                          TypeExtension
                                          Is Modifierfalse
                                          Summaryfalse
                                          Alternate Namesextensions, user content
                                          Invariantsele-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())
                                          SlicingThis element introduces a set of slices on Library.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                          • value @ url
                                          • 30. Library.identifier:gravitateIdentifier.use
                                            Definition

                                            The purpose of this identifier.

                                            Shortusual | official | temp | secondary | old (If known)
                                            Comments

                                            Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

                                            Control0..1
                                            BindingThe 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 .

                                            Typecode
                                            Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Summarytrue
                                            Requirements

                                            Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

                                            Invariantsele-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.

                                            ShortDescription 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.

                                            Control0..1
                                            BindingUnless 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.

                                            TypeCodeableConcept
                                            Is Modifierfalse
                                            Summarytrue
                                            Requirements

                                            Allows users to make use of identifiers when the identifier system is not known.

                                            Invariantsele-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.

                                            ShortThe namespace for the identifier value
                                            Comments

                                            Identifier.system is always case sensitive.

                                            Control1..1
                                            Typeuri
                                            Is Modifierfalse
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Summarytrue
                                            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 Valuehttp://gravitate-health.lst.tfo.upm.es
                                            Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
                                            Invariantsele-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.

                                            ShortThe 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.

                                            Control0..1
                                            This element is affected by the following invariants: ident-1
                                            BindingUnless not suitable, these codes SHALL be taken from LensCategories
                                            (extensible to http://hl7.eu/fhir/ig/gravitate-health/ValueSet/LensCategories)
                                            Typestring
                                            Is Modifierfalse
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Summarytrue
                                            Example<br/><b>General</b>:123456
                                            Invariantsele-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.

                                            ShortTime period when id is/was valid for use
                                            Control0..1
                                            TypePeriod
                                            Is Modifierfalse
                                            Summarytrue
                                            Invariantsele-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.

                                            ShortOrganization 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.

                                            Control0..1
                                            TypeReference(Organization)
                                            Is Modifierfalse
                                            Summarytrue
                                            Invariantsele-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.

                                            ShortBusiness 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.

                                            NoteThis is a business version Id, not a resource version Id (see discussion)
                                            Control1..1
                                            Typestring
                                            Is Modifierfalse
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Must Supporttrue
                                            Summarytrue
                                            Invariantsele-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.

                                            ShortHow 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.

                                            Control0..1
                                            BindingUnless not suitable, these codes SHALL be taken from VersionAlgorithm
                                            (extensible to http://hl7.org/fhir/ValueSet/version-algorithm)
                                            TypeChoice of: string, Coding
                                            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                            Is Modifierfalse
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Must Supportfalse
                                            Summarytrue
                                            Invariantsele-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.

                                            ShortName 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.

                                            Control1..1
                                            This element is affected by the following invariants: cnl-0
                                            Typestring
                                            Is Modifierfalse
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Must Supporttrue
                                            Summarytrue
                                            Requirements

                                            Support human navigation and code generation.

                                            Invariantsele-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)

                                            Shortxml:id (or equivalent in JSON)
                                            Control0..1
                                            Typestring
                                            Is Modifierfalse
                                            XML FormatIn the XML format, this property is represented as an attribute.
                                            Summaryfalse
                                            50. Library.name.extension
                                            Definition

                                            An Extension

                                            ShortExtension
                                            Control0..*
                                            TypeExtension
                                            Is Modifierfalse
                                            Summaryfalse
                                            Invariantsele-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())
                                            SlicingThis element introduces a set of slices on Library.name.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                            • value @ url
                                            • 52. Library.name.extension:translation
                                              Slice Nametranslation
                                              Definition

                                              Language translation from base language of resource to another language.

                                              ShortLanguage Translation (Localization)
                                              Control0..*
                                              TypeExtension(Translation) (Complex Extension)
                                              Is Modifierfalse
                                              Must Supporttrue
                                              Invariantsele-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

                                              ShortPrimitive value for string
                                              Control0..1
                                              Typestring
                                              Is Modifierfalse
                                              XML FormatIn the XML format, this property is represented as an attribute.
                                              Summaryfalse
                                              Max Length:1048576
                                              56. Library.title
                                              Definition

                                              A short, descriptive, user-friendly title for the library.

                                              ShortName for this library (human friendly)
                                              Comments

                                              This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

                                              Control0..1
                                              Typestring
                                              Is Modifierfalse
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Must Supportfalse
                                              Summarytrue
                                              Invariantsele-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.

                                              ShortSubordinate title of the library
                                              Control0..1
                                              Typestring
                                              Is Modifierfalse
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Must Supportfalse
                                              Summaryfalse
                                              Invariantsele-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.

                                              Shortdraft | 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.

                                              Control1..1
                                              BindingThe codes SHALL be taken from PublicationStatus
                                              (required to http://hl7.org/fhir/ValueSet/publication-status|5.0.0)

                                              The lifecycle status of an artifact.

                                              Typecode
                                              Is Modifiertrue because This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Must Supportfalse
                                              Summarytrue
                                              Invariantsele-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.

                                              ShortFor testing purposes, not real usage
                                              Comments

                                              Allows filtering of librarys that are appropriate for use versus not.

                                              Control0..1
                                              Typeboolean
                                              Is Modifierfalse
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Must Supportfalse
                                              Summarytrue
                                              Requirements

                                              Enables experimental content to be developed following the same lifecycle that would be used for a production-level library.

                                              Meaning if MissingIf absent, this resource is treated as though it is not experimental.
                                              Invariantsele-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.

                                              Shortlogic-library | model-definition | asset-collection | module-definition
                                              Control1..1
                                              BindingUnless 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.

                                              TypeCodeableConcept
                                              Is Modifierfalse
                                              Must Supportfalse
                                              Summarytrue
                                              Pattern Value{
                                                "coding" : [{
                                                  "code" : "logical-library"
                                                }]
                                              }
                                              Invariantsele-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.

                                              ShortType of individual the library content is focused on
                                              Control0..1
                                              BindingUnless 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.).

                                              TypeChoice of: CodeableConcept, Reference(Group)
                                              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                              Is Modifierfalse
                                              Must Supporttrue
                                              Must Support TypesNo must-support rules about the choice of types/profiles
                                              Summaryfalse
                                              Meaning if MissingPatient
                                              Invariantsele-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.

                                              ShortDate 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.

                                              Control0..1
                                              TypedateTime
                                              Is Modifierfalse
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Must Supportfalse
                                              Summarytrue
                                              Alternate NamesRevision Date
                                              Invariantsele-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.

                                              ShortName 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.

                                              Control0..1
                                              Typestring
                                              Is Modifierfalse
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Must Supportfalse
                                              Summarytrue
                                              Requirements

                                              Helps establish the "authority/credibility" of the library. May also allow for contact.

                                              Invariantsele-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.

                                              ShortContact 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.

                                              Control0..*
                                              TypeContactDetail
                                              Is Modifierfalse
                                              Must Supportfalse
                                              Summarytrue
                                              Invariantsele-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.

                                              Shortdocumentation
                                              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).

                                              Control1..1
                                              Typemarkdown
                                              Is Modifierfalse
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Must Supporttrue
                                              Summarytrue
                                              Invariantsele-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)

                                              Shortxml:id (or equivalent in JSON)
                                              Control0..1
                                              Typestring
                                              Is Modifierfalse
                                              XML FormatIn the XML format, this property is represented as an attribute.
                                              Summaryfalse
                                              78. Library.description.extension
                                              Definition

                                              An Extension

                                              ShortExtension
                                              Control0..*
                                              TypeExtension
                                              Is Modifierfalse
                                              Summaryfalse
                                              Invariantsele-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())
                                              SlicingThis element introduces a set of slices on Library.description.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                              • value @ url
                                              • 80. Library.description.extension:translation
                                                Slice Nametranslation
                                                Definition

                                                Language translation from base language of resource to another language.

                                                ShortLanguage Translation (Localization)
                                                Control0..*
                                                TypeExtension(Translation) (Complex Extension)
                                                Is Modifierfalse
                                                Must Supporttrue
                                                Invariantsele-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

                                                ShortPrimitive value for markdown
                                                Control0..1
                                                Typemarkdown
                                                Is Modifierfalse
                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                Summaryfalse
                                                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.

                                                ShortThe 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.

                                                Control0..*
                                                TypeUsageContext
                                                Is Modifierfalse
                                                Must Supportfalse
                                                Summarytrue
                                                Requirements

                                                Assist in searching for appropriate content.

                                                Invariantsele-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.

                                                Shortregion
                                                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.)

                                                Control1..*
                                                BindingUnless 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.

                                                TypeCodeableConcept
                                                Is Modifierfalse
                                                Must Supporttrue
                                                Summarytrue
                                                Invariantsele-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.

                                                ShortIntent
                                                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.

                                                Control1..1
                                                Typemarkdown
                                                Is Modifierfalse
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Must Supporttrue
                                                Summaryfalse
                                                Invariantsele-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)

                                                Shortxml:id (or equivalent in JSON)
                                                Control0..1
                                                Typestring
                                                Is Modifierfalse
                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                Summaryfalse
                                                92. Library.purpose.extension
                                                Definition

                                                An Extension

                                                ShortExtension
                                                Control0..*
                                                TypeExtension
                                                Is Modifierfalse
                                                Summaryfalse
                                                Invariantsele-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())
                                                SlicingThis element introduces a set of slices on Library.purpose.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                • value @ url
                                                • 94. Library.purpose.extension:translation
                                                  Slice Nametranslation
                                                  Definition

                                                  Language translation from base language of resource to another language.

                                                  ShortLanguage Translation (Localization)
                                                  Control0..*
                                                  TypeExtension(Translation) (Complex Extension)
                                                  Is Modifierfalse
                                                  Must Supporttrue
                                                  Invariantsele-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

                                                  ShortPrimitive value for markdown
                                                  Control0..1
                                                  Typemarkdown
                                                  Is Modifierfalse
                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                  Summaryfalse
                                                  98. Library.usage
                                                  Definition

                                                  A detailed description of how the library is used from a clinical perspective.

                                                  Shortexplanation
                                                  Control1..1
                                                  Typemarkdown
                                                  Is Modifierfalse
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Must Supporttrue
                                                  Summaryfalse
                                                  Invariantsele-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)

                                                  Shortxml:id (or equivalent in JSON)
                                                  Control0..1
                                                  Typestring
                                                  Is Modifierfalse
                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                  Summaryfalse
                                                  102. Library.usage.extension
                                                  Definition

                                                  An Extension

                                                  ShortExtension
                                                  Control0..*
                                                  TypeExtension
                                                  Is Modifierfalse
                                                  Summaryfalse
                                                  Invariantsele-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())
                                                  SlicingThis element introduces a set of slices on Library.usage.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                  • value @ url
                                                  • 104. Library.usage.extension:translation
                                                    Slice Nametranslation
                                                    Definition

                                                    Language translation from base language of resource to another language.

                                                    ShortLanguage Translation (Localization)
                                                    Control0..*
                                                    TypeExtension(Translation) (Complex Extension)
                                                    Is Modifierfalse
                                                    Must Supporttrue
                                                    Invariantsele-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

                                                    ShortPrimitive value for markdown
                                                    Control0..1
                                                    Typemarkdown
                                                    Is Modifierfalse
                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                    Summaryfalse
                                                    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.

                                                    ShortUse and/or publishing restrictions
                                                    Comments

                                                    The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element.

                                                    Control1..1
                                                    Typemarkdown
                                                    Is Modifierfalse
                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                    Must Supporttrue
                                                    Summaryfalse
                                                    Requirements

                                                    Consumers must be able to determine any legal restrictions on the use of the library and/or its content.

                                                    Alternate NamesLicense, Restrictions
                                                    Invariantsele-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)

                                                    Shortxml:id (or equivalent in JSON)
                                                    Control0..1
                                                    Typestring
                                                    Is Modifierfalse
                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                    Summaryfalse
                                                    112. Library.copyright.extension
                                                    Definition

                                                    An Extension

                                                    ShortExtension
                                                    Control0..*
                                                    TypeExtension
                                                    Is Modifierfalse
                                                    Summaryfalse
                                                    Invariantsele-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())
                                                    SlicingThis element introduces a set of slices on Library.copyright.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                    • value @ url
                                                    • 114. Library.copyright.extension:translation
                                                      Slice Nametranslation
                                                      Definition

                                                      Language translation from base language of resource to another language.

                                                      ShortLanguage Translation (Localization)
                                                      Control0..*
                                                      TypeExtension(Translation) (Complex Extension)
                                                      Is Modifierfalse
                                                      Must Supporttrue
                                                      Invariantsele-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

                                                      ShortPrimitive value for markdown
                                                      Control0..1
                                                      Typemarkdown
                                                      Is Modifierfalse
                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                      Summaryfalse
                                                      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').

                                                      ShortCopyright 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.

                                                      Control0..1
                                                      Typestring
                                                      Is Modifierfalse
                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                      Must Supportfalse
                                                      Summaryfalse
                                                      Requirements

                                                      Defines the content expected to be rendered in all representations of the artifact.

                                                      Invariantsele-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.

                                                      ShortWhen 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.

                                                      Control0..1
                                                      Typedate
                                                      Is Modifierfalse
                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                      Must Supporttrue
                                                      Summaryfalse
                                                      Invariantsele-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.

                                                      ShortWhen 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.

                                                      Control0..1
                                                      Typedate
                                                      Is Modifierfalse
                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                      Must Supporttrue
                                                      Summaryfalse
                                                      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.

                                                      Invariantsele-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.

                                                      ShortWhen 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.

                                                      Control0..1
                                                      TypePeriod
                                                      Is Modifierfalse
                                                      Must Supportfalse
                                                      Summarytrue
                                                      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.

                                                      Invariantsele-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.

                                                      ShortE.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)

                                                      Control0..*
                                                      BindingFor 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.

                                                      TypeCodeableConcept
                                                      Is Modifierfalse
                                                      Must Supporttrue
                                                      Summaryfalse
                                                      Requirements

                                                      Repositories must be able to determine how to categorize the library so that it can be found by topical searches.

                                                      Invariantsele-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.

                                                      ShortWho authored the content
                                                      Control0..*
                                                      TypeContactDetail
                                                      Is Modifierfalse
                                                      Must Supporttrue
                                                      Summaryfalse
                                                      Invariantsele-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.

                                                      ShortWho edited the content
                                                      Control0..*
                                                      TypeContactDetail
                                                      Is Modifierfalse
                                                      Must Supportfalse
                                                      Summaryfalse
                                                      Invariantsele-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.

                                                      ShortWho reviewed the content
                                                      Comments

                                                      See guidance around (not) making local changes to elements here.

                                                      Control0..*
                                                      TypeContactDetail
                                                      Is Modifierfalse
                                                      Must Supportfalse
                                                      Summaryfalse
                                                      Invariantsele-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.

                                                      ShortWho endorsed the content
                                                      Comments

                                                      See guidance around (not) making local changes to elements here.

                                                      Control0..*
                                                      TypeContactDetail
                                                      Is Modifierfalse
                                                      Must Supportfalse
                                                      Summaryfalse
                                                      Invariantsele-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.

                                                      Shortalternative
                                                      Comments

                                                      Each related artifact is either an attachment, or a reference to another resource, but not both.

                                                      Control0..*
                                                      TypeRelatedArtifact
                                                      Is Modifierfalse
                                                      Must Supporttrue
                                                      Summaryfalse
                                                      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.

                                                      Invariantsele-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.

                                                      ShortParameters defined by the library
                                                      Control1..*
                                                      TypeParameterDefinition
                                                      Is Modifierfalse
                                                      Must Supporttrue
                                                      Summaryfalse
                                                      Invariantsele-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.

                                                      ShortUnique id for inter-element referencing
                                                      Control0..1
                                                      This element is affected by the following invariants: ele-1
                                                      Typeid
                                                      Is Modifierfalse
                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                      Summaryfalse
                                                      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.

                                                      ShortAdditional 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.

                                                      Control0..*
                                                      TypeExtension
                                                      Is Modifierfalse
                                                      Summaryfalse
                                                      Alternate Namesextensions, user content
                                                      Invariantsele-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())
                                                      SlicingThis element introduces a set of slices on Library.parameter.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                      • value @ url
                                                      • 144. Library.parameter.name
                                                        Definition

                                                        The name of the parameter used to allow access to the value of the parameter in evaluation contexts.

                                                        ShortName used to access the parameter value
                                                        Control0..1
                                                        Typecode
                                                        Is Modifierfalse
                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                        Summarytrue
                                                        Invariantsele-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.

                                                        Shortin | out
                                                        Control1..1
                                                        BindingThe 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.

                                                        Typecode
                                                        Is Modifierfalse
                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                        Summarytrue
                                                        Invariantsele-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.

                                                        ShortMinimum cardinality
                                                        Control0..1
                                                        Typeinteger
                                                        Is Modifierfalse
                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                        Summarytrue
                                                        Invariantsele-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.

                                                        ShortMaximum cardinality (a number of *)
                                                        Control0..1
                                                        Typestring
                                                        Is Modifierfalse
                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                        Summarytrue
                                                        Invariantsele-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.

                                                        ShortA brief description of the parameter
                                                        Control0..1
                                                        Typestring
                                                        Is Modifierfalse
                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                        Summarytrue
                                                        Invariantsele-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)

                                                        Shortxml:id (or equivalent in JSON)
                                                        Control0..1
                                                        Typestring
                                                        Is Modifierfalse
                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                        Summaryfalse
                                                        156. Library.parameter.documentation.extension
                                                        Definition

                                                        An Extension

                                                        ShortExtension
                                                        Control0..*
                                                        TypeExtension
                                                        Is Modifierfalse
                                                        Summaryfalse
                                                        Invariantsele-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())
                                                        SlicingThis element introduces a set of slices on Library.parameter.documentation.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                        • value @ url
                                                        • 158. Library.parameter.documentation.extension:translation
                                                          Slice Nametranslation
                                                          Definition

                                                          Language translation from base language of resource to another language.

                                                          ShortLanguage Translation (Localization)
                                                          Control0..*
                                                          TypeExtension(Translation) (Complex Extension)
                                                          Is Modifierfalse
                                                          Must Supporttrue
                                                          Invariantsele-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

                                                          ShortPrimitive value for string
                                                          Control0..1
                                                          Typestring
                                                          Is Modifierfalse
                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                          Summaryfalse
                                                          Max Length:1048576
                                                          162. Library.parameter.type
                                                          Definition

                                                          The type of the parameter.

                                                          ShortWhat type of value
                                                          Control1..1
                                                          BindingThe 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).

                                                          Typecode
                                                          Is Modifierfalse
                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                          Summarytrue
                                                          Invariantsele-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.

                                                          ShortWhat profile the value is expected to be
                                                          Control0..1
                                                          Typecanonical(StructureDefinition)
                                                          Is Modifierfalse
                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                          Summarytrue
                                                          Invariantsele-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.

                                                          ShortWhat data is referenced by this library
                                                          Control0..*
                                                          TypeDataRequirement
                                                          Is Modifierfalse
                                                          Must Supportfalse
                                                          Summaryfalse
                                                          Invariantsele-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.

                                                          ShortThe code of the lens - base64
                                                          Control1..*
                                                          TypeAttachment
                                                          Is Modifierfalse
                                                          Must Supporttrue
                                                          Summarytrue
                                                          Invariantsele-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.

                                                          ShortUnique id for inter-element referencing
                                                          Control0..1
                                                          This element is affected by the following invariants: ele-1
                                                          Typeid
                                                          Is Modifierfalse
                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                          Summaryfalse
                                                          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.

                                                          ShortAdditional 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.

                                                          Control0..*
                                                          TypeExtension
                                                          Is Modifierfalse
                                                          Summaryfalse
                                                          Alternate Namesextensions, user content
                                                          Invariantsele-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())
                                                          SlicingThis element introduces a set of slices on Library.content.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                          • value @ url
                                                          • 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.

                                                            ShortMime type of the content, with charset etc.
                                                            Control0..1
                                                            This element is affected by the following invariants: att-1
                                                            BindingThe 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)

                                                            Typecode
                                                            Is Modifierfalse
                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                            Must Supporttrue
                                                            Summarytrue
                                                            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
                                                            Invariantsele-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.

                                                            ShortHuman language of the content (BCP-47)
                                                            Control0..1
                                                            BindingThe 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.

                                                            Typecode
                                                            Is Modifierfalse
                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                            Must Supporttrue
                                                            Summarytrue
                                                            Requirements

                                                            Users need to be able to choose between the languages in a set of attachments.

                                                            Example<br/><b>General</b>:en-AU
                                                            Invariantsele-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.

                                                            ShortData inline, base64ed
                                                            Comments

                                                            The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON.

                                                            Control0..1
                                                            This element is affected by the following invariants: att-1
                                                            Typebase64Binary
                                                            Is Modifierfalse
                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                            Must Supporttrue
                                                            Summaryfalse
                                                            Requirements

                                                            The data needs to able to be transmitted inline.

                                                            Invariantsele-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.

                                                            ShortUri 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.

                                                            Control0..1
                                                            Typeurl
                                                            Is Modifierfalse
                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                            Must Supporttrue
                                                            Summarytrue
                                                            Requirements

                                                            The data needs to be transmitted by reference.

                                                            Example<br/><b>General</b>:http://www.acme.com/logo-small.png
                                                            Invariantsele-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).

                                                            ShortNumber 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.

                                                            Control0..1
                                                            Typeinteger64
                                                            Is Modifierfalse
                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                            Summarytrue
                                                            Requirements

                                                            Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all.

                                                            Invariantsele-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.

                                                            ShortHash 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.

                                                            Control0..1
                                                            Typebase64Binary
                                                            Is Modifierfalse
                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                            Must Supporttrue
                                                            Summarytrue
                                                            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).

                                                            Invariantsele-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.

                                                            ShortLabel to display in place of the data
                                                            Comments

                                                            May sometimes be derived from the source filename.

                                                            Control0..1
                                                            Typestring
                                                            Is Modifierfalse
                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                            Must Supporttrue
                                                            Summarytrue
                                                            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
                                                            Invariantsele-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)

                                                            Shortxml:id (or equivalent in JSON)
                                                            Control0..1
                                                            Typestring
                                                            Is Modifierfalse
                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                            Summaryfalse
                                                            190. Library.content.title.extension
                                                            Definition

                                                            An Extension

                                                            ShortExtension
                                                            Control0..*
                                                            TypeExtension
                                                            Is Modifierfalse
                                                            Summaryfalse
                                                            Invariantsele-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())
                                                            SlicingThis element introduces a set of slices on Library.content.title.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                            • value @ url
                                                            • 192. Library.content.title.extension:translation
                                                              Slice Nametranslation
                                                              Definition

                                                              Language translation from base language of resource to another language.

                                                              ShortLanguage Translation (Localization)
                                                              Control0..*
                                                              TypeExtension(Translation) (Complex Extension)
                                                              Is Modifierfalse
                                                              Must Supporttrue
                                                              Invariantsele-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

                                                              ShortPrimitive value for string
                                                              Control0..1
                                                              Typestring
                                                              Is Modifierfalse
                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                              Summaryfalse
                                                              Max Length:1048576
                                                              196. Library.content.creation
                                                              Definition

                                                              The date that the attachment was first created.

                                                              ShortDate attachment was first created
                                                              Control0..1
                                                              TypedateTime
                                                              Is Modifierfalse
                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                              Must Supporttrue
                                                              Summarytrue
                                                              Requirements

                                                              This is often tracked as an integrity issue for use of the attachment.

                                                              Invariantsele-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).

                                                              ShortHeight of the image in pixels (photo/video)
                                                              Control0..1
                                                              TypepositiveInt
                                                              Is Modifierfalse
                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                              Summaryfalse
                                                              Invariantsele-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).

                                                              ShortWidth of the image in pixels (photo/video)
                                                              Control0..1
                                                              TypepositiveInt
                                                              Is Modifierfalse
                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                              Summaryfalse
                                                              Invariantsele-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.

                                                              ShortNumber 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.

                                                              Control0..1
                                                              TypepositiveInt
                                                              Is Modifierfalse
                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                              Summaryfalse
                                                              Invariantsele-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.

                                                              ShortLength in seconds (audio / video)
                                                              Comments

                                                              The duration might differ from occurrencePeriod if recording was paused.

                                                              Control0..1
                                                              Typedecimal
                                                              Is Modifierfalse
                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                              Summaryfalse
                                                              Invariantsele-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.

                                                              ShortNumber of printed pages
                                                              Control0..1
                                                              TypepositiveInt
                                                              Is Modifierfalse
                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                              Summaryfalse
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))