eRSD Supplemental Library - Electronic Case Reporting (eCR) v3.0.0-ballot

Electronic Case Reporting (eCR), published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 3.0.0-ballot 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: eRSD Supplemental Library

Official URL: http://hl7.org/fhir/us/ecr/StructureDefinition/ersd-supplemental-library	Version: 3.0.0-ballot	Highlight text changes?
Standards status: Trial-use	Maturity Level: 3	Computable Name: ERSDSupplementalLibrary
Other Identifiers: OID:2.16.840.1.113883.4.642.40.46.42.13

Defines the asset-collection library containing the eRSD supplemental assets.

Usages:

Examples for this Profile: ERSDSupplementalLibraryExample

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

Key Elements Table
Differential Table
Snapshot Table
Statistics/References
All

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
Library	C	1..1	USPublicHealthSupplementalLibrary	eRSD Supplemental Library Constraints: lib-0
Library.implicitRules	This element is a modifier element. This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Library.Slices for extension				Content/Rules for all slices
Library.Slices for extension.extension:knowledgeCapability	This element must be supported.	0..*	code	shareable \| computable \| publishable \| executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required)
Library.Slices for extension.extension:artifactComment	This element must be supported.	0..*	(Complex)	Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
Library.Slices for extension.extension:versionAlgorithm	This element must be supported.	0..1	Coding	How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: VersionAlgorithm (extensible)
Library.Slices for extension.extension:versionPolicy	This element must be supported.	0..1	CodeableConcept	metadata \| strict URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy Binding: ValueSet Artifact Version Policy (extensible): The versioning policy of the artifact
Library.modifierExtension	This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Library.url	This element must be supported. This element is included in summaries.	1..1	uri	Canonical identifier for this library, represented as a URI (globally unique)
Library.version	This element must be supported. This element is included in summaries.	1..1	string	Business version of the library
Library.name	This element must be supported. This element is included in summaries. C	0..1	string	Name for this library (computer friendly)
Library.title	This element must be supported. This element is included in summaries.	1..1	string	Name for this library (human friendly)
Library.status	This element is a modifier element. This element must be supported. This element is included in summaries.	1..1	code	draft \| active \| retired \| unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
Library.experimental	This element must be supported. This element is included in summaries.	0..1	boolean	For testing purposes, not real usage
Library.type	This element must be supported. This element is included in summaries.	1..1	CodeableConcept	asset-collection Binding: LibraryType (extensible): The type of knowledge asset this library contains. Required Pattern: `{ "coding" : [ { "system" : "http://terminology.hl7.org/CodeSystem/library-type", "code" : "asset-collection" } ] }`
Library.publisher	This element must be supported. This element is included in summaries.	0..1	string	Name of the publisher (organization or individual)
Library.description	This element must be supported. This element is included in summaries.	1..1	markdown	Natural language description of the library
Library.Slices for useContext	This element must be supported. This element is included in summaries.	2..*	UsageContext	The context that the content is intended to support Slice: Unordered, Open by value:code Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Library.Slices for useContext.useContext:reportingContext	This element must be supported. This element is included in summaries.	1..1	UsageContext	The context that the content is intended to support
Library.Slices for useContext.useContext:reportingContext.code	This element is included in summaries.	1..1	Coding	Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. Required Pattern: `{ "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-usage-context-type", "code" : "reporting" }`
Library.Slices for useContext.useContext:reportingContext.value[x]	This element is included in summaries.	1..1	CodeableConcept	Library useContext Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified. Required Pattern: `{ "coding" : [ { "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-usage-context", "code" : "supplemental" } ] }`
Library.Slices for useContext.useContext:specificationTypeContext	This element must be supported. This element is included in summaries.	1..1	UsageContext	The context that the content is intended to support
Library.Slices for useContext.useContext:specificationTypeContext.code	This element is included in summaries.	1..1	Coding	Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. Required Pattern: `{ "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-usage-context-type", "code" : "specification-type" }`
Library.Slices for useContext.useContext:specificationTypeContext.value[x]	This element is included in summaries.	1..1	CodeableConcept	Library useContext Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified. Required Pattern: `{ "coding" : [ { "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-usage-context", "code" : "program" } ] }`
Library.Slices for relatedArtifact	This element must be supported.	3..*	RelatedArtifact	Additional documentation, citations, etc. Slice: Unordered, Open by profile:resource.resolve() Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Library.Slices for relatedArtifact.relatedArtifact:computableLibrary	This element must be supported.	1..1	RelatedArtifact	US Public Health Computable Library
Library.Slices for relatedArtifact.relatedArtifact:computableLibrary.type	This element is included in summaries.	1..1	code	composed-of Binding: RelatedArtifactType (required): The type of relationship to the related artifact. Required Pattern: composed-of (extensions allowed)
Library.Slices for relatedArtifact.relatedArtifact:computableLibrary.resource	This element must be supported. This element is included in summaries.	1..1	canonical(CQL Library)	What resource is being referenced
Library.Slices for relatedArtifact.relatedArtifact:supplementalValueSetLibrary	This element must be supported.	1..*	RelatedArtifact	US Public Health Triggering ValueSet Library
Library.Slices for relatedArtifact.relatedArtifact:supplementalValueSetLibrary.type	This element is included in summaries.	1..1	code	composed-of Binding: RelatedArtifactType (required): The type of relationship to the related artifact. Required Pattern: composed-of (extensions allowed)
Library.Slices for relatedArtifact.relatedArtifact:supplementalValueSetLibrary.resource	This element must be supported. This element is included in summaries.	1..1	canonical(US Public Health Supplemental ValueSet Library)	What resource is being referenced
Library.Slices for relatedArtifact.relatedArtifact:sliceJurisdictionsCodeSystem	This element must be supported.	1..1	RelatedArtifact	Jurisdiction CodeSystem
Library.Slices for relatedArtifact.relatedArtifact:sliceJurisdictionsCodeSystem.type	This element is included in summaries.	1..1	code	composed-of Binding: RelatedArtifactType (required): The type of relationship to the related artifact. Required Pattern: composed-of (extensions allowed)
Library.Slices for relatedArtifact.relatedArtifact:sliceJurisdictionsCodeSystem.resource	This element must be supported. This element is included in summaries.	1..1	canonical(US Public Health CodeSystem)	What resource is being referenced
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Library.status	Base	required	PublicationStatus	📍4.0.1	FHIR Std.
Library.type	Base	extensible	LibraryType	📦4.0.1	FHIR Std.
Library.useContext:reportingContext.code	Base	extensible	UsageContextType	📍4.0.1	FHIR Std.
Library.useContext:reportingContext.value[x]	Base	example	ConformanceUseContext	📍4.0.1	FHIR Std.
Library.useContext:specificationTypeContext.code	Base	extensible	UsageContextType	📍4.0.1	FHIR Std.
Library.useContext:specificationTypeContext.value[x]	Base	example	ConformanceUseContext	📍4.0.1	FHIR Std.
Library.relatedArtifact:computableLibrary.type	Base	required	RelatedArtifactType	📍4.0.1	FHIR Std.
Library.relatedArtifact:supplementalValueSetLibrary.type	Base	required	RelatedArtifactType	📍4.0.1	FHIR Std.
Library.relatedArtifact:sliceJurisdictionsCodeSystem.type	Base	required	RelatedArtifactType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	Library	If the resource is contained in another resource, it SHALL NOT contain nested Resources	`contained.contained.empty()`
dom-3	error	Library	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	error	Library	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	error	Library	If a resource is contained in another resource, it SHALL NOT have a security label	`contained.meta.security.empty()`
dom-6	best practice	Library	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	ALL elements	All FHIR elements must have a @value or children	`hasValue() or (children().count() > id.count())`
ext-1	error	ALL extensions	Must have either extensions or value[x], not both	`extension.exists() != value.exists()`
lib-0	warning	Library	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}')`

This structure is derived from USPublicHealthSupplementalLibrary

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
Library		1..1	USPublicHealthSupplementalLibrary	eRSD Supplemental Library
Library.relatedArtifact		3..*	RelatedArtifact	Additional documentation, citations, etc.
Library.Slices for relatedArtifact				Content/Rules for all slices
Library.Slices for relatedArtifact.relatedArtifact:sliceJurisdictionsCodeSystem	This element must be supported.	1..1	RelatedArtifact	Jurisdiction CodeSystem
Library.Slices for relatedArtifact.relatedArtifact:sliceJurisdictionsCodeSystem.type		1..1	code	composed-of Required Pattern: composed-of (extensions allowed)
Library.Slices for relatedArtifact.relatedArtifact:sliceJurisdictionsCodeSystem.resource	This element must be supported.	1..1	canonical(US Public Health CodeSystem)	What resource is being referenced
Documentation for this format

Description & Constraints Filter:

Library C 1..1 USPublicHealthSupplementalLibrary eRSD Supplemental Library
Constraints: lib-0

Library.id This element is included in summaries. 0..1 id Logical id of this artifact

Library.meta This element is included in summaries. 0..1 Meta Metadata about the resource

Library.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created

language

0..1

code

Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional Bindings

Purpose

AllLanguages

Max Binding

Library.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements

Library.contained 0..* Resource Contained, inline Resources

Library.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Library.Slices for extension.extension:knowledgeCapability This element must be supported. 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)

Library.Slices for extension.extension:artifactComment This element must be supported. 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment

Library.Slices for extension.extension:versionAlgorithm This element must be supported. 0..1 Coding How to compare versions
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: VersionAlgorithm (extensible)

Library.Slices for extension.extension:versionPolicy This element must be supported. 0..1 CodeableConcept metadata | strict
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy
Binding: ValueSet Artifact Version Policy (extensible): The versioning policy of the artifact

Library.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored

Library.url This element must be supported. This element is included in summaries. 1..1 uri Canonical identifier for this library, represented as a URI (globally unique)

Library.identifier This element is included in summaries. 0..* Identifier Additional identifier for the library

Library.version This element must be supported. This element is included in summaries. 1..1 string Business version of the library

Library.name This element must be supported. This element is included in summaries. C 0..1 string Name for this library (computer friendly)

Library.title This element must be supported. This element is included in summaries. 1..1 string Name for this library (human friendly)

Library.subtitle 0..1 string Subordinate title of the library

Library.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

Library.experimental This element must be supported. This element is included in summaries. 0..1 boolean For testing purposes, not real usage

type

1..1

CodeableConcept

asset-collection
Binding: LibraryType (extensible): The type of knowledge asset this library contains.
Required Pattern:

{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/library-type",
      "code" : "asset-collection"
    }
  ]
}

Library.subject[x] 0..1 Type of individual the library content is focused on
Binding: SubjectType (extensible): The possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.).

Library.subject[x].subjectCodeableConcept CodeableConcept

Library.subject[x].subjectReference Reference(Group)

Library.date This element is included in summaries. 0..1 dateTime Date last changed

Library.publisher This element must be supported. This element is included in summaries. 0..1 string Name of the publisher (organization or individual)

Library.contact This element is included in summaries. 0..* ContactDetail Contact details for the publisher

Library.description This element must be supported. This element is included in summaries. 1..1 markdown Natural language description of the library

Library.Slices for useContext This element must be supported. This element is included in summaries. 2..* UsageContext The context that the content is intended to support
Slice: Unordered, Open by value:code

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

Library.Slices for useContext.useContext:reportingContext This element must be supported. This element is included in summaries. 1..1 UsageContext The context that the content is intended to support

Library.Slices for useContext.useContext:reportingContext.id 0..1 string Unique id for inter-element referencing

Library.Slices for useContext.useContext:reportingContext.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url

code

1..1

Coding

Type of context being specified
Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context.
Required Pattern:

{
  "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-usage-context-type",
  "code" : "reporting"
}

value[x]

1..1

CodeableConcept

Library useContext
Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified.
Required Pattern:

{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-usage-context",
      "code" : "supplemental"
    }
  ]
}

Library.Slices for useContext.useContext:specificationTypeContext This element must be supported. This element is included in summaries. 1..1 UsageContext The context that the content is intended to support

Library.Slices for useContext.useContext:specificationTypeContext.id 0..1 string Unique id for inter-element referencing

Library.Slices for useContext.useContext:specificationTypeContext.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url

code

1..1

Coding

Type of context being specified
Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context.
Required Pattern:

{
  "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-usage-context-type",
  "code" : "specification-type"
}

value[x]

1..1

CodeableConcept

Library useContext
Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified.
Required Pattern:

{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-usage-context",
      "code" : "program"
    }
  ]
}

Library.jurisdiction This element is included in summaries. 0..* CodeableConcept Intended jurisdiction for library (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.

Library.purpose 0..1 markdown Why this library is defined

Library.usage 0..1 string Describes the clinical usage of the library

Library.copyright 0..1 markdown Use and/or publishing restrictions

Library.approvalDate 0..1 date When the library was approved by publisher

Library.lastReviewDate 0..1 date When the library was last reviewed

Library.effectivePeriod This element is included in summaries. 0..1 Period When the library is expected to be used

Library.topic 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.

Library.author 0..* ContactDetail Who authored the content

Library.editor 0..* ContactDetail Who edited the content

Library.reviewer 0..* ContactDetail Who reviewed the content

Library.endorser 0..* ContactDetail Who endorsed the content

Library.Slices for relatedArtifact This element must be supported. 3..* RelatedArtifact Additional documentation, citations, etc.
Slice: Unordered, Open by profile:resource.resolve()

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

Library.Slices for relatedArtifact.relatedArtifact:computableLibrary This element must be supported. 1..1 RelatedArtifact US Public Health Computable Library

Library.Slices for relatedArtifact.relatedArtifact:computableLibrary.id 0..1 string Unique id for inter-element referencing

Library.Slices for relatedArtifact.relatedArtifact:computableLibrary.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url

Library.Slices for relatedArtifact.relatedArtifact:computableLibrary.type This element is included in summaries. 1..1 code composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
Required Pattern: composed-of (extensions allowed)

Library.Slices for relatedArtifact.relatedArtifact:computableLibrary.label This element is included in summaries. 0..1 string Short label

Library.Slices for relatedArtifact.relatedArtifact:computableLibrary.display This element is included in summaries. 0..1 string Brief description of the related artifact

Library.Slices for relatedArtifact.relatedArtifact:computableLibrary.citation This element is included in summaries. 0..1 markdown Bibliographic citation for the artifact

Library.Slices for relatedArtifact.relatedArtifact:computableLibrary.url This element is included in summaries. 0..1 url Where the artifact can be accessed

Library.Slices for relatedArtifact.relatedArtifact:computableLibrary.document This element is included in summaries. 0..1 Attachment What document is being referenced

Library.Slices for relatedArtifact.relatedArtifact:computableLibrary.resource This element must be supported. This element is included in summaries. 1..1 canonical(CQL Library) What resource is being referenced

Library.Slices for relatedArtifact.relatedArtifact:supplementalValueSetLibrary This element must be supported. 1..* RelatedArtifact US Public Health Triggering ValueSet Library

Library.Slices for relatedArtifact.relatedArtifact:supplementalValueSetLibrary.id 0..1 string Unique id for inter-element referencing

Library.Slices for relatedArtifact.relatedArtifact:supplementalValueSetLibrary.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url

Library.Slices for relatedArtifact.relatedArtifact:supplementalValueSetLibrary.type This element is included in summaries. 1..1 code composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
Required Pattern: composed-of (extensions allowed)

Library.Slices for relatedArtifact.relatedArtifact:supplementalValueSetLibrary.label This element is included in summaries. 0..1 string Short label

Library.Slices for relatedArtifact.relatedArtifact:supplementalValueSetLibrary.display This element is included in summaries. 0..1 string Brief description of the related artifact

Library.Slices for relatedArtifact.relatedArtifact:supplementalValueSetLibrary.citation This element is included in summaries. 0..1 markdown Bibliographic citation for the artifact

Library.Slices for relatedArtifact.relatedArtifact:supplementalValueSetLibrary.url This element is included in summaries. 0..1 url Where the artifact can be accessed

Library.Slices for relatedArtifact.relatedArtifact:supplementalValueSetLibrary.document This element is included in summaries. 0..1 Attachment What document is being referenced

Library.Slices for relatedArtifact.relatedArtifact:supplementalValueSetLibrary.resource This element must be supported. This element is included in summaries. 1..1 canonical(US Public Health Supplemental ValueSet Library) What resource is being referenced

Library.Slices for relatedArtifact.relatedArtifact:sliceJurisdictionsCodeSystem This element must be supported. 1..1 RelatedArtifact Jurisdiction CodeSystem

Library.Slices for relatedArtifact.relatedArtifact:sliceJurisdictionsCodeSystem.id 0..1 string Unique id for inter-element referencing

Library.Slices for relatedArtifact.relatedArtifact:sliceJurisdictionsCodeSystem.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url

Library.Slices for relatedArtifact.relatedArtifact:sliceJurisdictionsCodeSystem.type This element is included in summaries. 1..1 code composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
Required Pattern: composed-of (extensions allowed)

Library.Slices for relatedArtifact.relatedArtifact:sliceJurisdictionsCodeSystem.label This element is included in summaries. 0..1 string Short label

Library.Slices for relatedArtifact.relatedArtifact:sliceJurisdictionsCodeSystem.display This element is included in summaries. 0..1 string Brief description of the related artifact

Library.Slices for relatedArtifact.relatedArtifact:sliceJurisdictionsCodeSystem.citation This element is included in summaries. 0..1 markdown Bibliographic citation for the artifact

Library.Slices for relatedArtifact.relatedArtifact:sliceJurisdictionsCodeSystem.url This element is included in summaries. 0..1 url Where the artifact can be accessed

Library.Slices for relatedArtifact.relatedArtifact:sliceJurisdictionsCodeSystem.document This element is included in summaries. 0..1 Attachment What document is being referenced

Library.Slices for relatedArtifact.relatedArtifact:sliceJurisdictionsCodeSystem.resource This element must be supported. This element is included in summaries. 1..1 canonical(US Public Health CodeSystem) What resource is being referenced

Library.parameter 0..* ParameterDefinition Parameters defined by the library

Library.dataRequirement 0..* DataRequirement What data is referenced by this library

Library.content This element is included in summaries. 0..* Attachment Contents of the library, either embedded or referenced

Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Library.language	Base	preferred	Common Languages	📦4.0.1	FHIR Std.
Library.status	Base	required	PublicationStatus	📍4.0.1	FHIR Std.
Library.type	Base	extensible	LibraryType	📦4.0.1	FHIR Std.
Library.subject[x]	Base	extensible	Subject type	📦4.0.1	FHIR Std.
Library.useContext:reportingContext.code	Base	extensible	UsageContextType	📍4.0.1	FHIR Std.
Library.useContext:reportingContext.value[x]	Base	example	ConformanceUseContext	📍4.0.1	FHIR Std.
Library.useContext:specificationTypeContext.code	Base	extensible	UsageContextType	📍4.0.1	FHIR Std.
Library.useContext:specificationTypeContext.value[x]	Base	example	ConformanceUseContext	📍4.0.1	FHIR Std.
Library.jurisdiction	Base	extensible	Jurisdiction	📦4.0.1	FHIR Std.
Library.topic	Base	example	DefinitionTopic	📦4.0.1	FHIR Std.
Library.relatedArtifact:computableLibrary.type	Base	required	RelatedArtifactType	📍4.0.1	FHIR Std.
Library.relatedArtifact:supplementalValueSetLibrary.type	Base	required	RelatedArtifactType	📍4.0.1	FHIR Std.
Library.relatedArtifact:sliceJurisdictionsCodeSystem.type	Base	required	RelatedArtifactType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	Library	If the resource is contained in another resource, it SHALL NOT contain nested Resources	`contained.contained.empty()`
dom-3	error	Library	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	error	Library	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	error	Library	If a resource is contained in another resource, it SHALL NOT have a security label	`contained.meta.security.empty()`
dom-6	best practice	Library	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	ALL elements	All FHIR elements must have a @value or children	`hasValue() or (children().count() > id.count())`
ext-1	error	ALL extensions	Must have either extensions or value[x], not both	`extension.exists() != value.exists()`
lib-0	warning	Library	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}')`

This structure is derived from USPublicHealthSupplementalLibrary

Summary

Mandatory: 2 elements
Must-Support: 2 elements

Structures

This structure refers to these other structures:

US Public Health CodeSystem (http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-codesystem)

Maturity: 3

Key Elements View

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
Library	C	1..1	USPublicHealthSupplementalLibrary	eRSD Supplemental Library Constraints: lib-0
Library.implicitRules	This element is a modifier element. This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Library.Slices for extension				Content/Rules for all slices
Library.Slices for extension.extension:knowledgeCapability	This element must be supported.	0..*	code	shareable \| computable \| publishable \| executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required)
Library.Slices for extension.extension:artifactComment	This element must be supported.	0..*	(Complex)	Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
Library.Slices for extension.extension:versionAlgorithm	This element must be supported.	0..1	Coding	How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: VersionAlgorithm (extensible)
Library.Slices for extension.extension:versionPolicy	This element must be supported.	0..1	CodeableConcept	metadata \| strict URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy Binding: ValueSet Artifact Version Policy (extensible): The versioning policy of the artifact
Library.modifierExtension	This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Library.url	This element must be supported. This element is included in summaries.	1..1	uri	Canonical identifier for this library, represented as a URI (globally unique)
Library.version	This element must be supported. This element is included in summaries.	1..1	string	Business version of the library
Library.name	This element must be supported. This element is included in summaries. C	0..1	string	Name for this library (computer friendly)
Library.title	This element must be supported. This element is included in summaries.	1..1	string	Name for this library (human friendly)
Library.status	This element is a modifier element. This element must be supported. This element is included in summaries.	1..1	code	draft \| active \| retired \| unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
Library.experimental	This element must be supported. This element is included in summaries.	0..1	boolean	For testing purposes, not real usage
Library.type	This element must be supported. This element is included in summaries.	1..1	CodeableConcept	asset-collection Binding: LibraryType (extensible): The type of knowledge asset this library contains. Required Pattern: `{ "coding" : [ { "system" : "http://terminology.hl7.org/CodeSystem/library-type", "code" : "asset-collection" } ] }`
Library.publisher	This element must be supported. This element is included in summaries.	0..1	string	Name of the publisher (organization or individual)
Library.description	This element must be supported. This element is included in summaries.	1..1	markdown	Natural language description of the library
Library.Slices for useContext	This element must be supported. This element is included in summaries.	2..*	UsageContext	The context that the content is intended to support Slice: Unordered, Open by value:code Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Library.Slices for useContext.useContext:reportingContext	This element must be supported. This element is included in summaries.	1..1	UsageContext	The context that the content is intended to support
Library.Slices for useContext.useContext:reportingContext.code	This element is included in summaries.	1..1	Coding	Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. Required Pattern: `{ "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-usage-context-type", "code" : "reporting" }`
Library.Slices for useContext.useContext:reportingContext.value[x]	This element is included in summaries.	1..1	CodeableConcept	Library useContext Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified. Required Pattern: `{ "coding" : [ { "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-usage-context", "code" : "supplemental" } ] }`
Library.Slices for useContext.useContext:specificationTypeContext	This element must be supported. This element is included in summaries.	1..1	UsageContext	The context that the content is intended to support
Library.Slices for useContext.useContext:specificationTypeContext.code	This element is included in summaries.	1..1	Coding	Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. Required Pattern: `{ "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-usage-context-type", "code" : "specification-type" }`
Library.Slices for useContext.useContext:specificationTypeContext.value[x]	This element is included in summaries.	1..1	CodeableConcept	Library useContext Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified. Required Pattern: `{ "coding" : [ { "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-usage-context", "code" : "program" } ] }`
Library.Slices for relatedArtifact	This element must be supported.	3..*	RelatedArtifact	Additional documentation, citations, etc. Slice: Unordered, Open by profile:resource.resolve() Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Library.Slices for relatedArtifact.relatedArtifact:computableLibrary	This element must be supported.	1..1	RelatedArtifact	US Public Health Computable Library
Library.Slices for relatedArtifact.relatedArtifact:computableLibrary.type	This element is included in summaries.	1..1	code	composed-of Binding: RelatedArtifactType (required): The type of relationship to the related artifact. Required Pattern: composed-of (extensions allowed)
Library.Slices for relatedArtifact.relatedArtifact:computableLibrary.resource	This element must be supported. This element is included in summaries.	1..1	canonical(CQL Library)	What resource is being referenced
Library.Slices for relatedArtifact.relatedArtifact:supplementalValueSetLibrary	This element must be supported.	1..*	RelatedArtifact	US Public Health Triggering ValueSet Library
Library.Slices for relatedArtifact.relatedArtifact:supplementalValueSetLibrary.type	This element is included in summaries.	1..1	code	composed-of Binding: RelatedArtifactType (required): The type of relationship to the related artifact. Required Pattern: composed-of (extensions allowed)
Library.Slices for relatedArtifact.relatedArtifact:supplementalValueSetLibrary.resource	This element must be supported. This element is included in summaries.	1..1	canonical(US Public Health Supplemental ValueSet Library)	What resource is being referenced
Library.Slices for relatedArtifact.relatedArtifact:sliceJurisdictionsCodeSystem	This element must be supported.	1..1	RelatedArtifact	Jurisdiction CodeSystem
Library.Slices for relatedArtifact.relatedArtifact:sliceJurisdictionsCodeSystem.type	This element is included in summaries.	1..1	code	composed-of Binding: RelatedArtifactType (required): The type of relationship to the related artifact. Required Pattern: composed-of (extensions allowed)
Library.Slices for relatedArtifact.relatedArtifact:sliceJurisdictionsCodeSystem.resource	This element must be supported. This element is included in summaries.	1..1	canonical(US Public Health CodeSystem)	What resource is being referenced
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Library.status	Base	required	PublicationStatus	📍4.0.1	FHIR Std.
Library.type	Base	extensible	LibraryType	📦4.0.1	FHIR Std.
Library.useContext:reportingContext.code	Base	extensible	UsageContextType	📍4.0.1	FHIR Std.
Library.useContext:reportingContext.value[x]	Base	example	ConformanceUseContext	📍4.0.1	FHIR Std.
Library.useContext:specificationTypeContext.code	Base	extensible	UsageContextType	📍4.0.1	FHIR Std.
Library.useContext:specificationTypeContext.value[x]	Base	example	ConformanceUseContext	📍4.0.1	FHIR Std.
Library.relatedArtifact:computableLibrary.type	Base	required	RelatedArtifactType	📍4.0.1	FHIR Std.
Library.relatedArtifact:supplementalValueSetLibrary.type	Base	required	RelatedArtifactType	📍4.0.1	FHIR Std.
Library.relatedArtifact:sliceJurisdictionsCodeSystem.type	Base	required	RelatedArtifactType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	Library	If the resource is contained in another resource, it SHALL NOT contain nested Resources	`contained.contained.empty()`
dom-3	error	Library	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	error	Library	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	error	Library	If a resource is contained in another resource, it SHALL NOT have a security label	`contained.meta.security.empty()`
dom-6	best practice	Library	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	ALL elements	All FHIR elements must have a @value or children	`hasValue() or (children().count() > id.count())`
ext-1	error	ALL extensions	Must have either extensions or value[x], not both	`extension.exists() != value.exists()`
lib-0	warning	Library	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}')`

Differential View

This structure is derived from USPublicHealthSupplementalLibrary

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
Library		1..1	USPublicHealthSupplementalLibrary	eRSD Supplemental Library
Library.relatedArtifact		3..*	RelatedArtifact	Additional documentation, citations, etc.
Library.Slices for relatedArtifact				Content/Rules for all slices
Library.Slices for relatedArtifact.relatedArtifact:sliceJurisdictionsCodeSystem	This element must be supported.	1..1	RelatedArtifact	Jurisdiction CodeSystem
Library.Slices for relatedArtifact.relatedArtifact:sliceJurisdictionsCodeSystem.type		1..1	code	composed-of Required Pattern: composed-of (extensions allowed)
Library.Slices for relatedArtifact.relatedArtifact:sliceJurisdictionsCodeSystem.resource	This element must be supported.	1..1	canonical(US Public Health CodeSystem)	What resource is being referenced
Documentation for this format

Snapshot ViewView