HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR) - US Realm
2.1.2 - STU 2 United States of America flag

HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR) - US Realm, published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 2.1.2 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/case-reporting/ and changes regularly. See the Directory of published versions

Resource Profile: USPublicHealthTriggeringValueSetLibrary - Detailed Descriptions

Active as of 2020-11-11

Definitions for the us-ph-triggering-valueset-library resource profile.

Guidance on how to interpret the contents of this table can be found here

0. Library
ShortUS Public Health Triggering ValueSet Library
2. Library.useContext
Control2..*
SlicingThis element introduces a set of slices on Library.useContext. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • pattern @ code
  • 4. Library.useContext:reportingContext
    Slice NamereportingContext
    Control1..1
    6. Library.useContext:reportingContext.code
    Control1..1
    Pattern Value{
      "system" : "http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-usage-context-type",
      "code" : "reporting"
    }
    8. Library.useContext:reportingContext.value[x]
    Definition

    The US Public Health use context of the Library.

    ShortLibrary useContext
    Control1..1
    TypeCodeableConcept
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Pattern Value{
      "coding" : [{
        "system" : "http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-usage-context",
        "code" : "triggering"
      }]
    }
    10. Library.useContext:specificationTypeContext
    Slice NamespecificationTypeContext
    Control1..1
    12. Library.useContext:specificationTypeContext.code
    Control1..1
    Pattern Value{
      "system" : "http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-usage-context-type",
      "code" : "specification-type"
    }
    14. Library.useContext:specificationTypeContext.value[x]
    Definition

    The US Public Health use context of the Library.

    ShortLibrary useContext
    Control1..1
    TypeCodeableConcept
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Pattern Value{
      "coding" : [{
        "system" : "http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-usage-context",
        "code" : "value-set-library"
      }]
    }
    16. Library.relatedArtifact
    Control1..?
    SlicingThis element introduces a set of slices on Library.relatedArtifact. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ type
    • 18. Library.relatedArtifact:sliceUSPHValueSet
      Slice NamesliceUSPHValueSet
      Definition

      Reference to one of the US Public Health Triggering value sets

      ShortUS Public Health Triggering Value Set
      Control1..?
      Must Supporttrue
      20. Library.relatedArtifact:sliceUSPHValueSet.type
      Definition

      The type of relationship to the related artifact. Fixed to composed-of.

      Shortcomposed-of
      Pattern Valuecomposed-of
      22. Library.relatedArtifact:sliceUSPHValueSet.resource
      Control1..?
      Typecanonical(US Public Health Triggering ValueSet)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      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.

      ShortUS Public Health Triggering ValueSet LibraryRepresents a library of quality improvement components
      Control10..1*
      Is Modifierfalse
      Summaryfalse
      Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
      dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
      dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
      dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
      dom-6: A resource should have narrative for robust management (text.`div`.exists())
      lib-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (name.matches('[A-Z]([A-Za-z0-9_]){0,254}'))
      lib-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (name.matches('[A-Z]([A-Za-z0-9_]){0,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 it's 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 it's meaning or interpretation
      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()))
      4. Library.extension:expansionParameters
      Slice NameexpansionParameters
      Definition

      Supports the definition of expansion parameters for the ValueSet.

      ShortExpansion Parameters for the ValueSet.
      Control0..1
      This element is affected by the following invariants: ele-1
      TypeExtension(US Public Health Expansion Parameters Extension) (Extension Type: Reference(Parameters))
      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())
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      6. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

      Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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


      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())
      8. 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 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.


      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.

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

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

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      10. 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)
      Control0..*
      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()))
      12. Library.identifier.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|4.0.1
      (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

      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()))
      14. Library.identifier.system
      Definition

      Fixed to the namespace: urn:ietf:rfc:3986 for OIDs


      Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

      ShortThe namespace for Object IdentifiersThe 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
      Must Supporttrue
      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 Valueurn:ietf:rfc:3986
      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()))
      16. Library.identifier.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 Rendered Value extension. 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.

      Control10..1
      Typestring
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Summarytrue
      Example<br/><b>General</b>:123456
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      18. 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.

      ShortValue Sets Definition VersionBusiness 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].

      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()))
      20. 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: inv-0
      Typestring
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      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()))
      22. Library.title
      Definition

      Value Sets Name


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

      ShortValue Sets NameName for this library (human friendly)
      Comments

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

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

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

      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
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      26. 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.

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

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

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      28. Library.type
      Definition

      Identifies the type of library. Constrained to a pattern that includes asset-collection.


      Identifies the type of library such as a Logic Library, Model Definition, Asset Collection, or Module Definition.

      Shortasset-collectionlogic-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 Supporttrue
      Summarytrue
      Pattern Value{
        "coding" : [{
          "system" : "http://terminology.hl7.org/CodeSystem/library-type",
          "code" : "asset-collection"
        }]
      }
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      30. Library.date
      Definition

      The date (and optionally time) when the library was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the library changes.

      ShortDate last changed
      Comments

      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.

      Control0..1
      TypedateTime
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Summarytrue
      Alternate NamesRevision Date
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      32. Library.publisher
      Definition

      The name of the organization or individual that published the library.

      ShortName of the publisher (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.

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

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

      Alternate Namessteward
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      34. 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.

      Control0..*
      TypeContactDetail
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      36. Library.description
      Definition

      Value Sets Release Description


      A free text natural language description of the library from a consumer's perspective.

      ShortValue Sets Release DescriptionNatural language description of the library
      Comments

      This description can be used to capture details such as why the library was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the library as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the library is presumed to be the predominant language in the place the library was created).

      Control10..1
      Typemarkdown
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Summarytrue
      Alternate Namesscope
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      38. 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.

      Control20..*
      TypeUsageContext
      Is Modifierfalse
      Must Supporttrue
      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()))
      SlicingThis element introduces a set of slices on Library.useContext. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • pattern @ code
      • 40. Library.useContext:reportingContext
        Slice NamereportingContext
        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.

        Control10..1*
        TypeUsageContext
        Is Modifierfalse
        Must Supporttrue
        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()))
        42. Library.useContext:reportingContext.code
        Definition

        A code that identifies the type of context being specified by this usage context.

        ShortType of context being specified
        Control1..1
        BindingUnless not suitable, these codes SHALL be taken from UsageContextTypehttp://hl7.org/fhir/ValueSet/usage-context-type
        (extensible to http://hl7.org/fhir/ValueSet/usage-context-type)

        A code that specifies a type of context being specified by a usage context.

        TypeCoding
        Is Modifierfalse
        Summarytrue
        Pattern Value{
          "system" : "http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-usage-context-type",
          "code" : "reporting"
        }
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        44. Library.useContext:reportingContext.value[x]
        Definition

        The US Public Health use context of the Library.


        A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.

        ShortLibrary useContextValue that defines the context
        Control1..1
        BindingFor example codes, see Context of Use ValueSethttp://hl7.org/fhir/ValueSet/use-context
        (example to http://hl7.org/fhir/ValueSet/use-context)

        A code that defines the specific value for the context being specified.

        TypeCodeableConcept, Reference(PlanDefinition, ResearchStudy, InsurancePlan, HealthcareService, Group, Location, Organization), Quantity, Range
        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
        Is Modifierfalse
        Summarytrue
        Pattern Value{
          "coding" : [{
            "system" : "http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-usage-context",
            "code" : "triggering"
          }]
        }
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        46. Library.useContext:specificationTypeContext
        Slice NamespecificationTypeContext
        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.

        Control10..1*
        TypeUsageContext
        Is Modifierfalse
        Must Supporttrue
        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()))
        48. Library.useContext:specificationTypeContext.code
        Definition

        A code that identifies the type of context being specified by this usage context.

        ShortType of context being specified
        Control1..1
        BindingUnless not suitable, these codes SHALL be taken from UsageContextTypehttp://hl7.org/fhir/ValueSet/usage-context-type
        (extensible to http://hl7.org/fhir/ValueSet/usage-context-type)

        A code that specifies a type of context being specified by a usage context.

        TypeCoding
        Is Modifierfalse
        Summarytrue
        Pattern Value{
          "system" : "http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-usage-context-type",
          "code" : "specification-type"
        }
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        50. Library.useContext:specificationTypeContext.value[x]
        Definition

        The US Public Health use context of the Library.


        A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.

        ShortLibrary useContextValue that defines the context
        Control1..1
        BindingFor example codes, see Context of Use ValueSethttp://hl7.org/fhir/ValueSet/use-context
        (example to http://hl7.org/fhir/ValueSet/use-context)

        A code that defines the specific value for the context being specified.

        TypeCodeableConcept, Reference(PlanDefinition, ResearchStudy, InsurancePlan, HealthcareService, Group, Location, Organization), Quantity, Range
        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
        Is Modifierfalse
        Summarytrue
        Pattern Value{
          "coding" : [{
            "system" : "http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-usage-context",
            "code" : "value-set-library"
          }]
        }
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        52. Library.jurisdiction
        Definition

        A legal or geographic region in which the library is intended to be used.

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

        Control0..*
        BindingUnless not suitable, these codes SHALL be taken from Jurisdiction ValueSethttp://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()))
        54. Library.purpose
        Definition

        Value Sets Purpose


        Explanation of why this library is needed and why it has been designed as it has.

        ShortValue Sets PurposeWhy 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()))
        56. 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 measure intended to be used for the year 2016 might be published in 2015.

        Control10..1
        TypePeriod
        Is Modifierfalse
        Must Supporttrue
        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()))
        58. Library.effectivePeriod.start
        Definition

        Value Sets Effective Start Date


        The start of the period. The boundary is inclusive.

        ShortValue Sets Effective Start DateStarting time with inclusive boundary
        Comments

        If the low element is missing, the meaning is that the low boundary is not known.

        Control10..1
        This element is affected by the following invariants: per-1
        TypedateTime
        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()))
        60. Library.relatedArtifact
        Definition

        Related artifacts such as additional documentation, justification, or bibliographic references.

        ShortAdditional documentation, citations, etc.
        Comments

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

        Control10..*
        TypeRelatedArtifact
        Is Modifierfalse
        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()))
        SlicingThis element introduces a set of slices on Library.relatedArtifact. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ type
        • 62. Library.relatedArtifact:sliceUSPHValueSet
          Slice NamesliceUSPHValueSet
          Definition

          Reference to one of the US Public Health Triggering value sets


          Related artifacts such as additional documentation, justification, or bibliographic references.

          ShortUS Public Health Triggering Value SetAdditional documentation, citations, etc.
          Comments

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

          Control10..*
          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()))
          64. Library.relatedArtifact:sliceUSPHValueSet.type
          Definition

          The type of relationship to the related artifact. Fixed to composed-of.


          The type of relationship to the related artifact.

          Shortcomposed-ofdocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
          Control1..1
          BindingThe codes SHALL be taken from RelatedArtifactTypehttp://hl7.org/fhir/ValueSet/related-artifact-type|4.0.1
          (required to http://hl7.org/fhir/ValueSet/related-artifact-type|4.0.1)

          The type of relationship to the related artifact.

          Typecode
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Pattern Valuecomposed-of
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          66. Library.relatedArtifact:sliceUSPHValueSet.resource
          Definition

          The related resource, such as a library, value set, profile, or other knowledge resource.

          ShortWhat resource is being referenced
          Comments

          If the type is predecessor, this is a reference to the succeeding knowledge resource. If the type is successor, this is a reference to the prior knowledge resource.

          Control10..1
          Typecanonical(US Public Health Triggering ValueSet, Resource)
          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()))

          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.

          ShortUS Public Health Triggering ValueSet Library
          Control1..1
          Is Modifierfalse
          Summaryfalse
          Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
          dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
          dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
          dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
          dom-6: A resource should have narrative for robust management (text.`div`.exists())
          lib-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (name.matches('[A-Z]([A-Za-z0-9_]){0,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

          The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

          Control0..1
          Typeid
          Is Modifierfalse
          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
          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 it's 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 it's meaning or interpretation
          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()))
          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 SHOULD be taken from CommonLanguages
          (preferred to http://hl7.org/fhir/ValueSet/languages)

          A human language.

          Additional BindingsPurpose
          AllLanguagesMax Binding
          Typecode
          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()))
          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 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
          TypeNarrative
          Is Modifierfalse
          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, and nor can they have their own independent transaction scope.

          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..*
          TypeResource
          Is Modifierfalse
          Summaryfalse
          Alternate Namesinline resources, anonymous resources, contained resources
          14. Library.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.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 16. Library.extension:expansionParameters
            Slice NameexpansionParameters
            Definition

            Supports the definition of expansion parameters for the ValueSet.

            ShortExpansion Parameters for the ValueSet.
            Control0..1
            This element is affected by the following invariants: ele-1
            TypeExtension(US Public Health Expansion Parameters Extension) (Extension Type: Reference(Parameters))
            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())
            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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

            Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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

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

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

            Invariantsele-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)
            Control0..*
            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()))
            24. Library.identifier.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
            Typestring
            Is Modifierfalse
            XML FormatIn the XML format, this property is represented as an attribute.
            Summaryfalse
            26. Library.identifier.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            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
            • 28. Library.identifier.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|4.0.1)

              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()))
              30. Library.identifier.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 Identifier Type Codes
              (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()))
              32. Library.identifier.system
              Definition

              Fixed to the namespace: urn:ietf:rfc:3986 for OIDs

              ShortThe namespace for Object Identifiers
              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
              Must Supporttrue
              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 Valueurn:ietf:rfc:3986
              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()))
              34. Library.identifier.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 Rendered Value extension. 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.

              Control1..1
              Typestring
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Must Supporttrue
              Summarytrue
              Example<br/><b>General</b>:123456
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              36. Library.identifier.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()))
              38. Library.identifier.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()))
              40. 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.

              ShortValue Sets Definition Version
              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].

              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()))
              42. 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: inv-0
              Typestring
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              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()))
              44. Library.title
              Definition

              Value Sets Name

              ShortValue Sets Name
              Comments

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

              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()))
              46. 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
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              48. 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.

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

              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
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              50. 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.

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

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

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              52. Library.type
              Definition

              Identifies the type of library. Constrained to a pattern that includes asset-collection.

              Shortasset-collection
              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 Supporttrue
              Summarytrue
              Pattern Value{
                "coding" : [{
                  "system" : "http://terminology.hl7.org/CodeSystem/library-type",
                  "code" : "asset-collection"
                }]
              }
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              54. 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 SubjectType
              (extensible to http://hl7.org/fhir/ValueSet/subject-type)

              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
              Summaryfalse
              Meaning if MissingPatient
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              56. Library.date
              Definition

              The date (and optionally time) when the library was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the library changes.

              ShortDate last changed
              Comments

              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.

              Control0..1
              TypedateTime
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Must Supporttrue
              Summarytrue
              Alternate NamesRevision Date
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              58. Library.publisher
              Definition

              The name of the organization or individual that published the library.

              ShortName of the publisher (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.

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

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

              Alternate Namessteward
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              60. 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.

              Control0..*
              TypeContactDetail
              Is Modifierfalse
              Must Supporttrue
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              62. Library.description
              Definition

              Value Sets Release Description

              ShortValue Sets Release Description
              Comments

              This description can be used to capture details such as why the library was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the library as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the library is presumed to be the predominant language in the place the library was created).

              Control1..1
              Typemarkdown
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Must Supporttrue
              Summarytrue
              Alternate Namesscope
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              64. 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.

              Control2..*
              TypeUsageContext
              Is Modifierfalse
              Must Supporttrue
              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()))
              SlicingThis element introduces a set of slices on Library.useContext. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • pattern @ code
              • 66. Library.useContext:reportingContext
                Slice NamereportingContext
                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.

                Control1..1
                TypeUsageContext
                Is Modifierfalse
                Must Supporttrue
                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()))
                68. Library.useContext:reportingContext.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
                Typestring
                Is Modifierfalse
                XML FormatIn the XML format, this property is represented as an attribute.
                Summaryfalse
                70. Library.useContext:reportingContext.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                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.useContext.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 72. Library.useContext:reportingContext.code
                  Definition

                  A code that identifies the type of context being specified by this usage context.

                  ShortType of context being specified
                  Control1..1
                  BindingUnless not suitable, these codes SHALL be taken from UsageContextType
                  (extensible to http://hl7.org/fhir/ValueSet/usage-context-type)

                  A code that specifies a type of context being specified by a usage context.

                  TypeCoding
                  Is Modifierfalse
                  Summarytrue
                  Pattern Value{
                    "system" : "http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-usage-context-type",
                    "code" : "reporting"
                  }
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  74. Library.useContext:reportingContext.value[x]
                  Definition

                  The US Public Health use context of the Library.

                  ShortLibrary useContext
                  Control1..1
                  BindingFor example codes, see Context of Use ValueSet
                  (example to http://hl7.org/fhir/ValueSet/use-context)

                  A code that defines the specific value for the context being specified.

                  TypeCodeableConcept
                  [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                  Is Modifierfalse
                  Summarytrue
                  Pattern Value{
                    "coding" : [{
                      "system" : "http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-usage-context",
                      "code" : "triggering"
                    }]
                  }
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  76. Library.useContext:specificationTypeContext
                  Slice NamespecificationTypeContext
                  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.

                  Control1..1
                  TypeUsageContext
                  Is Modifierfalse
                  Must Supporttrue
                  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()))
                  78. Library.useContext:specificationTypeContext.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
                  Typestring
                  Is Modifierfalse
                  XML FormatIn the XML format, this property is represented as an attribute.
                  Summaryfalse
                  80. Library.useContext:specificationTypeContext.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                  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.useContext.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 82. Library.useContext:specificationTypeContext.code
                    Definition

                    A code that identifies the type of context being specified by this usage context.

                    ShortType of context being specified
                    Control1..1
                    BindingUnless not suitable, these codes SHALL be taken from UsageContextType
                    (extensible to http://hl7.org/fhir/ValueSet/usage-context-type)

                    A code that specifies a type of context being specified by a usage context.

                    TypeCoding
                    Is Modifierfalse
                    Summarytrue
                    Pattern Value{
                      "system" : "http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-usage-context-type",
                      "code" : "specification-type"
                    }
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    84. Library.useContext:specificationTypeContext.value[x]
                    Definition

                    The US Public Health use context of the Library.

                    ShortLibrary useContext
                    Control1..1
                    BindingFor example codes, see Context of Use ValueSet
                    (example to http://hl7.org/fhir/ValueSet/use-context)

                    A code that defines the specific value for the context being specified.

                    TypeCodeableConcept
                    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                    Is Modifierfalse
                    Summarytrue
                    Pattern Value{
                      "coding" : [{
                        "system" : "http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-usage-context",
                        "code" : "value-set-library"
                      }]
                    }
                    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.

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

                    Control0..*
                    BindingUnless not suitable, these codes SHALL be taken from Jurisdiction ValueSet
                    (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

                    Value Sets Purpose

                    ShortValue Sets Purpose
                    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.usage
                    Definition

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

                    ShortDescribes the clinical usage of the library
                    Control0..1
                    Typestring
                    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()))
                    92. 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
                    Control0..1
                    Typemarkdown
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    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()))
                    94. 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.

                    Control0..1
                    Typedate
                    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()))
                    96. 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
                    Comments

                    If specified, this date follows the original approval date.

                    Control0..1
                    Typedate
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    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()))
                    98. 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 measure intended to be used for the year 2016 might be published in 2015.

                    Control1..1
                    TypePeriod
                    Is Modifierfalse
                    Must Supporttrue
                    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()))
                    100. Library.effectivePeriod.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
                    Typestring
                    Is Modifierfalse
                    XML FormatIn the XML format, this property is represented as an attribute.
                    Summaryfalse
                    102. Library.effectivePeriod.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                    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.effectivePeriod.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • value @ url
                    • 104. Library.effectivePeriod.start
                      Definition

                      Value Sets Effective Start Date

                      ShortValue Sets Effective Start Date
                      Comments

                      If the low element is missing, the meaning is that the low boundary is not known.

                      Control1..1
                      This element is affected by the following invariants: per-1
                      TypedateTime
                      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()))
                      106. Library.effectivePeriod.end
                      Definition

                      The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

                      ShortEnd time with inclusive boundary, if not ongoing
                      Comments

                      The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.

                      Control0..1
                      This element is affected by the following invariants: per-1
                      TypedateTime
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Meaning if MissingIf the end of the period is missing, it means that the period is ongoing
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      108. 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.
                      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
                      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()))
                      110. 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
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      112. Library.editor
                      Definition

                      An individual or organization primarily responsible for internal coherence of the content.

                      ShortWho edited the content
                      Control0..*
                      TypeContactDetail
                      Is Modifierfalse
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      114. Library.reviewer
                      Definition

                      An individual or organization primarily responsible for review of some aspect of the content.

                      ShortWho reviewed the content
                      Control0..*
                      TypeContactDetail
                      Is Modifierfalse
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      116. Library.endorser
                      Definition

                      An individual or organization responsible for officially endorsing the content for use in some setting.

                      ShortWho endorsed the content
                      Control0..*
                      TypeContactDetail
                      Is Modifierfalse
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      118. Library.relatedArtifact
                      Definition

                      Related artifacts such as additional documentation, justification, or bibliographic references.

                      ShortAdditional documentation, citations, etc.
                      Comments

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

                      Control1..*
                      TypeRelatedArtifact
                      Is Modifierfalse
                      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()))
                      SlicingThis element introduces a set of slices on Library.relatedArtifact. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                      • value @ type
                      • 120. Library.relatedArtifact:sliceUSPHValueSet
                        Slice NamesliceUSPHValueSet
                        Definition

                        Reference to one of the US Public Health Triggering value sets

                        ShortUS Public Health Triggering Value Set
                        Comments

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

                        Control1..*
                        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()))
                        122. Library.relatedArtifact:sliceUSPHValueSet.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
                        Typestring
                        Is Modifierfalse
                        XML FormatIn the XML format, this property is represented as an attribute.
                        Summaryfalse
                        124. Library.relatedArtifact:sliceUSPHValueSet.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                        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.relatedArtifact.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                        • value @ url
                        • 126. Library.relatedArtifact:sliceUSPHValueSet.type
                          Definition

                          The type of relationship to the related artifact. Fixed to composed-of.

                          Shortcomposed-of
                          Control1..1
                          BindingThe codes SHALL be taken from RelatedArtifactType
                          (required to http://hl7.org/fhir/ValueSet/related-artifact-type|4.0.1)

                          The type of relationship to the related artifact.

                          Typecode
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          Pattern Valuecomposed-of
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          128. Library.relatedArtifact:sliceUSPHValueSet.label
                          Definition

                          A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.

                          ShortShort label
                          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()))
                          130. Library.relatedArtifact:sliceUSPHValueSet.display
                          Definition

                          A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.

                          ShortBrief description of the related artifact
                          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()))
                          132. Library.relatedArtifact:sliceUSPHValueSet.citation
                          Definition

                          A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.

                          ShortBibliographic citation for the artifact
                          Comments

                          Additional structured information about citations should be captured as extensions.

                          Control0..1
                          Typemarkdown
                          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()))
                          134. Library.relatedArtifact:sliceUSPHValueSet.url
                          Definition

                          A url for the artifact that can be followed to access the actual content.

                          ShortWhere the artifact can be accessed
                          Comments

                          If a document or resource element is present, this element SHALL NOT be provided (use the url or reference in the Attachment or resource reference).

                          Control0..1
                          Typeurl
                          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()))
                          136. Library.relatedArtifact:sliceUSPHValueSet.document
                          Definition

                          The document being referenced, represented as an attachment. This is exclusive with the resource element.

                          ShortWhat document is being referenced
                          Control0..1
                          TypeAttachment
                          Is Modifierfalse
                          Summarytrue
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          138. Library.relatedArtifact:sliceUSPHValueSet.resource
                          Definition

                          The related resource, such as a library, value set, profile, or other knowledge resource.

                          ShortWhat resource is being referenced
                          Comments

                          If the type is predecessor, this is a reference to the succeeding knowledge resource. If the type is successor, this is a reference to the prior knowledge resource.

                          Control1..1
                          Typecanonical(US Public Health Triggering ValueSet)
                          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()))
                          140. Library.parameter
                          Definition

                          The parameter element defines parameters used by the library.

                          ShortParameters defined by the library
                          Control0..*
                          TypeParameterDefinition
                          Is Modifierfalse
                          Summaryfalse
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          142. 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
                          Summaryfalse
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          144. 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.

                          ShortContents of the library, either embedded or referenced
                          Control0..*
                          TypeAttachment
                          Is Modifierfalse
                          Summarytrue
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))