US Public Health Triggering Valueset Library - HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR)

A set of rules under which this content was created

language

0..1

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

Additional Bindings

Purpose

AllLanguages

Max Binding

0..1

Narrative

Text summary of the resource, for human interpretation

contained

0..*

Resource

Contained, inline Resources

Slices for extension

0..*

Extension
Slice: Unordered, Open by value:url

expansionParameters

S

0..1

Reference(Parameters)

Expansion Parameters for the ValueSet.
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-expansion-parameters-extension

modifierExtension

?!

0..*

Extensions that cannot be ignored

url

Σ

1..1

Canonical identifier for this library, represented as a URI (globally unique)

identifier

SΣ

0..*

Identifier

Additional identifier for the library

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations
Slice: Unordered, Open by value:url

use

?!Σ

0..1

usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

Σ

0..1

Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

SΣ

1..1

The namespace for Object Identifiers
Required Pattern: urn:ietf:rfc:3986

value

SΣ

1..1

The value that is unique
Example General: 123456

period

Σ

0..1

Time period when id is/was valid for use

assigner

Σ

0..1

Reference(Organization)

Organization that issued id (may be just text)

SΣ

1..1

Value Sets Definition Version

name

ΣC

1..1

Name for this library (computer friendly)

title

SΣ

1..1

Value Sets Name

subtitle

0..1

Subordinate title of the library

status

?!Σ

1..1

draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

experimental

Σ

1..1

For testing purposes, not real usage

SΣ

1..1

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

Required Pattern: At least the following

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

1..*

Code defined by a terminology system
Fixed Value: (complex)

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

1..1

Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/library-type

0..1

Version of the system - if relevant

1..1

Symbol in syntax defined by the system
Fixed Value: asset-collection

0..1

Representation defined by the system

0..1

If this coding was chosen directly by the user

0..1

Plain text representation of the concept

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

subjectCodeableConcept

subjectReference

Reference(Group)

SΣ

0..1

Date last changed

publisher

Σ

1..1

Name of the publisher (organization or individual)

contact

SΣ

0..*

Contact details for the publisher

description

SΣ

1..1

Value Sets Release Description

Slices for useContext

SΣ

2..*

useContext:reportingContext

The context that the content is intended to support
Slice: Unordered, Open by pattern:code

SΣ

1..1

The context that the content is intended to support

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations
Slice: Unordered, Open by value:url

Σ

1..1

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

Required Pattern: At least the following

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

1..1

Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-usage-context-type

0..1

Version of the system - if relevant

1..1

Symbol in syntax defined by the system
Fixed Value: reporting

0..1

Representation defined by the system

0..1

If this coding was chosen directly by the user

Σ

1..1

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

Required Pattern: At least the following

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

1..*

Code defined by a terminology system
Fixed Value: (complex)

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

1..1

Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-usage-context

0..1

Version of the system - if relevant

1..1

Symbol in syntax defined by the system
Fixed Value: triggering

0..1

Representation defined by the system

0..1

If this coding was chosen directly by the user

0..1

useContext:specificationTypeContext

Plain text representation of the concept

SΣ

1..1

The context that the content is intended to support

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations
Slice: Unordered, Open by value:url

Σ

1..1

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

Required Pattern: At least the following

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

1..1

Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-usage-context-type

0..1

Version of the system - if relevant

1..1

Symbol in syntax defined by the system
Fixed Value: specification-type

0..1

Representation defined by the system

0..1

If this coding was chosen directly by the user

Σ

1..1

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

Required Pattern: At least the following

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

1..*

Code defined by a terminology system
Fixed Value: (complex)

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

1..1

Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-usage-context

0..1

Version of the system - if relevant

1..1

Symbol in syntax defined by the system
Fixed Value: value-set-library

0..1

Representation defined by the system

0..1

If this coding was chosen directly by the user

0..1

Plain text representation of the concept

jurisdiction

SΣ

0..*

Intended jurisdiction for library (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.

purpose

S

1..1

Value Sets Purpose

usage

0..1

Describes the clinical usage of the library

copyright

0..1

Use and/or publishing restrictions

approvalDate

0..1

When the library was approved by publisher

lastReviewDate

0..1

When the library was last reviewed

effectivePeriod

SΣ

1..1

When the library is expected to be used

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations
Slice: Unordered, Open by value:url

start

SΣC

1..1

Value Sets Effective Start Date

end

ΣC

0..1

End time with inclusive boundary, if not ongoing

topic

0..*

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

author

0..*

Who authored the content

editor

0..*

Who edited the content

reviewer

0..*

Who reviewed the content

endorser

0..*

Slices for relatedArtifact

Who endorsed the content

1..*

relatedArtifact:sliceUSPHValueSet

Additional documentation, citations, etc.
Slice: Unordered, Open by value:type

S

1..*

US Public Health Triggering Value Set

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations
Slice: Unordered, Open by value:url

Σ

1..1

composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.

Required Pattern: composed-of

label

Σ

0..1

Short label

Σ

0..1

Brief description of the related artifact

citation

Σ

0..1

Bibliographic citation for the artifact

url

Σ

0..1

url

Where the artifact can be accessed

document

Σ

0..1

canonical(US Public Health Triggering ValueSet)

What document is being referenced

resource

SΣ

1..1

What resource is being referenced

parameter

0..*

ParameterDefinition

Parameters defined by the library

dataRequirement

0..*

DataRequirement

What data is referenced by this library

content

Σ

0..*

Documentation for this format

Contents of the library, either embedded or referenced

Terminology Bindings

Path

Conformance

ValueSet / Code

Library.language

preferred

CommonLanguages

Additional Bindings

Purpose

AllLanguages

Max Binding

Library.identifier.use

IdentifierUse

Library.identifier.type

Identifier Type Codes

Library.status

PublicationStatus

Library.type

Pattern: asset-collection

Library.subject[x]

SubjectType

Library.useContext:reportingContext.code

Pattern: reporting

Library.useContext:reportingContext.value[x]

Pattern: triggering

Library.useContext:specificationTypeContext.code

Pattern: specification-type

Library.useContext:specificationTypeContext.value[x]

Pattern: value-set-library

Library.jurisdiction

Jurisdiction ValueSet

Library.topic

DefinitionTopic

Library.relatedArtifact:sliceUSPHValueSet.type

Description & Constraints

Pattern: composed-of

Constraints

Id	Grade	Path(s)	Details	Requirements
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 USPublicHealthValueSetLibrary

Summary

Mandatory: 9 elements
Must-Support: 2 elements

Structures

This structure refers to these other structures:

US Public Health Triggering ValueSet (http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-triggering-valueset)

Slices

This structure defines the following Slices:

The element Library.useContext is sliced based on the value of pattern:code
The element Library.relatedArtifact is sliced based on the value of value:type

Differential View

This structure is derived from USPublicHealthValueSetLibrary

Name	Flags	Card.	Type	Description & Constraints
Library		1..1	USPublicHealthValueSetLibrary	US Public Health Triggering ValueSet Library
Slices for useContext		2..*	UsageContext	The context that the content is intended to support Slice: Unordered, Open by pattern:code
useContext:reportingContext		1..1	UsageContext	The context that the content is intended to support
code		1..1	Coding	Type of context being specified Required Pattern: At least the following
system		1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-usage-context-type
code		1..1	code	Symbol in syntax defined by the system Fixed Value: reporting
value[x]		1..1	CodeableConcept	Library useContext Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-usage-context
code		1..1	code	Symbol in syntax defined by the system Fixed Value: triggering
useContext:specificationTypeContext		1..1	UsageContext	The context that the content is intended to support
code		1..1	Coding	Type of context being specified Required Pattern: At least the following
system		1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-usage-context-type
code		1..1	code	Symbol in syntax defined by the system Fixed Value: specification-type
value[x]		1..1	CodeableConcept	Library useContext Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-usage-context
code		1..1	code	Symbol in syntax defined by the system Fixed Value: value-set-library
Slices for relatedArtifact		1..*	RelatedArtifact	Additional documentation, citations, etc. Slice: Unordered, Open by value:type
relatedArtifact:sliceUSPHValueSet	S	1..*	RelatedArtifact	US Public Health Triggering Value Set
type		1..1	code	composed-of Required Pattern: composed-of
resource	S	1..1	canonical(US Public Health Triggering ValueSet)	What resource is being referenced
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Library	C	1..1	USPublicHealthValueSetLibrary	US Public Health Triggering ValueSet Library
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
expansionParameters	S	0..1	Reference(Parameters)	Expansion Parameters for the ValueSet. URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-expansion-parameters-extension
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
url	Σ	1..1	uri	Canonical identifier for this library, represented as a URI (globally unique)
identifier	SΣ	0..*	Identifier	Additional identifier for the library
use	?!Σ	0..1	code	usual \| official \| temp \| secondary \| old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	SΣ	1..1	uri	The namespace for Object Identifiers Required Pattern: urn:ietf:rfc:3986
value	SΣ	1..1	string	The value that is unique Example General: 123456
version	SΣ	1..1	string	Value Sets Definition Version
name	ΣC	1..1	string	Name for this library (computer friendly)
title	SΣ	1..1	string	Value Sets Name
status	?!Σ	1..1	code	draft \| active \| retired \| unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
experimental	Σ	1..1	boolean	For testing purposes, not real usage
type	SΣ	1..1	CodeableConcept	asset-collection Binding: LibraryType (extensible): The type of knowledge asset this library contains. Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/library-type
code		1..1	code	Symbol in syntax defined by the system Fixed Value: asset-collection
date	SΣ	0..1	dateTime	Date last changed
publisher	Σ	1..1	string	Name of the publisher (organization or individual)
contact	SΣ	0..*	ContactDetail	Contact details for the publisher
description	SΣ	1..1	markdown	Value Sets Release Description
Slices for useContext	SΣ	2..*	UsageContext	The context that the content is intended to support Slice: Unordered, Open by pattern:code
useContext:reportingContext	SΣ	1..1	UsageContext	The context that the content is intended to support
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: At least the following
system		1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-usage-context-type
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 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: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-usage-context
code		1..1	code	Symbol in syntax defined by the system Fixed Value: triggering
useContext:specificationTypeContext	SΣ	1..1	UsageContext	The context that the content is intended to support
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: At least the following
system		1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-usage-context-type
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 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: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-usage-context
code		1..1	code	Symbol in syntax defined by the system Fixed Value: value-set-library
jurisdiction	SΣ	0..*	CodeableConcept	Intended jurisdiction for library (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
purpose	S	1..1	markdown	Value Sets Purpose
effectivePeriod	SΣ	1..1	Period	When the library is expected to be used
start	SΣC	1..1	dateTime	Value Sets Effective Start Date
Slices for relatedArtifact		1..*	RelatedArtifact	Additional documentation, citations, etc. Slice: Unordered, Open by value:type
relatedArtifact:sliceUSPHValueSet	S	1..*	RelatedArtifact	US Public Health Triggering Value Set
type	Σ	1..1	code	composed-of Binding: RelatedArtifactType (required): The type of relationship to the related artifact. Required Pattern: composed-of
resource	SΣ	1..1	canonical(US Public Health Triggering ValueSet)	What resource is being referenced
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
Library.identifier.use	required	IdentifierUse
Library.status	required	PublicationStatus
Library.type	extensible	Pattern: asset-collection
Library.useContext:reportingContext.code	extensible	Pattern: reporting
Library.useContext:reportingContext.value[x]	example	Pattern: triggering
Library.useContext:specificationTypeContext.code	extensible	Pattern: specification-type
Library.useContext:specificationTypeContext.value[x]	example	Pattern: value-set-library
Library.jurisdiction	extensible	Jurisdiction ValueSet
Library.relatedArtifact:sliceUSPHValueSet.type	required	Pattern: composed-of

Constraints

Id	Grade	Path(s)	Details	Requirements
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}')

Snapshot View

Library

C

1..1

USPublicHealthValueSetLibrary

US Public Health Triggering ValueSet Library

id

Σ

0..1

id

Logical id of this artifact

Meta

Metadata about the resource

implicitRules

?!Σ

0..1

A set of rules under which this content was created

language

0..1

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

Additional Bindings

Purpose

AllLanguages

Max Binding

0..1

Narrative

Text summary of the resource, for human interpretation

contained

0..*

Resource

Contained, inline Resources

Slices for extension

0..*

Extension
Slice: Unordered, Open by value:url

expansionParameters

S

0..1

Reference(Parameters)

Expansion Parameters for the ValueSet.
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-expansion-parameters-extension

modifierExtension

?!

0..*

Extensions that cannot be ignored

url

Σ

1..1

Canonical identifier for this library, represented as a URI (globally unique)

identifier

SΣ

0..*

Identifier

Additional identifier for the library

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations
Slice: Unordered, Open by value:url

use

?!Σ

0..1

usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

Σ

0..1

Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

SΣ

1..1

The namespace for Object Identifiers
Required Pattern: urn:ietf:rfc:3986

value

SΣ

1..1

The value that is unique
Example General: 123456

period

Σ

0..1

Time period when id is/was valid for use

assigner

Σ

0..1

Reference(Organization)

Organization that issued id (may be just text)

SΣ

1..1

Value Sets Definition Version

name

ΣC

1..1

Name for this library (computer friendly)

title

SΣ

1..1

Value Sets Name

subtitle

0..1

Subordinate title of the library

status

?!Σ

1..1

draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

experimental

Σ

1..1

For testing purposes, not real usage

SΣ

1..1

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

Required Pattern: At least the following

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

1..*

Code defined by a terminology system
Fixed Value: (complex)

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

1..1

Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/library-type

0..1

Version of the system - if relevant

1..1

Symbol in syntax defined by the system
Fixed Value: asset-collection

0..1

Representation defined by the system

0..1

If this coding was chosen directly by the user

0..1

Plain text representation of the concept

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

subjectCodeableConcept

subjectReference

Reference(Group)

SΣ

0..1

Date last changed

publisher

Σ

1..1

Name of the publisher (organization or individual)

contact

SΣ

0..*

Contact details for the publisher

description

SΣ

1..1

Value Sets Release Description

Slices for useContext

SΣ

2..*

useContext:reportingContext

The context that the content is intended to support
Slice: Unordered, Open by pattern:code

SΣ

1..1

The context that the content is intended to support

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations
Slice: Unordered, Open by value:url

Σ

1..1

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

Required Pattern: At least the following

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

1..1

Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-usage-context-type

0..1

Version of the system - if relevant

1..1

Symbol in syntax defined by the system
Fixed Value: reporting

0..1

Representation defined by the system

0..1

If this coding was chosen directly by the user

Σ

1..1

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

Required Pattern: At least the following

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

1..*

Code defined by a terminology system
Fixed Value: (complex)

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

1..1

Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-usage-context

0..1

Version of the system - if relevant

1..1

Symbol in syntax defined by the system
Fixed Value: triggering

0..1

Representation defined by the system

0..1

If this coding was chosen directly by the user

0..1

useContext:specificationTypeContext

Plain text representation of the concept

SΣ

1..1

The context that the content is intended to support

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations
Slice: Unordered, Open by value:url

Σ

1..1

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

Required Pattern: At least the following

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

1..1

Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-usage-context-type

0..1

Version of the system - if relevant

1..1

Symbol in syntax defined by the system
Fixed Value: specification-type

0..1

Representation defined by the system

0..1

If this coding was chosen directly by the user

Σ

1..1

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

Required Pattern: At least the following

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

1..*

Code defined by a terminology system
Fixed Value: (complex)

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

1..1

Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-usage-context

0..1

Version of the system - if relevant

1..1

Symbol in syntax defined by the system
Fixed Value: value-set-library

0..1

Representation defined by the system

0..1

If this coding was chosen directly by the user

0..1

Plain text representation of the concept

jurisdiction

SΣ

0..*

Intended jurisdiction for library (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.

purpose

S

1..1

Value Sets Purpose

usage

0..1

Describes the clinical usage of the library

copyright

0..1

Use and/or publishing restrictions

approvalDate

0..1

When the library was approved by publisher

lastReviewDate

0..1

When the library was last reviewed

effectivePeriod

SΣ

1..1

When the library is expected to be used

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations
Slice: Unordered, Open by value:url

start

SΣC

1..1

Value Sets Effective Start Date

end

ΣC

0..1

End time with inclusive boundary, if not ongoing

topic

0..*

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

author

0..*

Who authored the content

editor

0..*

Who edited the content

reviewer

0..*

Who reviewed the content

endorser

0..*

Slices for relatedArtifact

Who endorsed the content

1..*

relatedArtifact:sliceUSPHValueSet

Additional documentation, citations, etc.
Slice: Unordered, Open by value:type

S

1..*

US Public Health Triggering Value Set

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations
Slice: Unordered, Open by value:url

Σ

1..1

composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.

Required Pattern: composed-of

label

Σ

0..1

Short label

Σ

0..1

Brief description of the related artifact

citation

Σ

0..1

Bibliographic citation for the artifact

url

Σ

0..1

url

Where the artifact can be accessed

document

Σ

0..1

canonical(US Public Health Triggering ValueSet)

What document is being referenced

resource

SΣ

1..1

What resource is being referenced

parameter

0..*

ParameterDefinition

Parameters defined by the library

dataRequirement

0..*

DataRequirement

What data is referenced by this library

content

Σ

0..*

Documentation for this format

Contents of the library, either embedded or referenced

Terminology Bindings

Path

Conformance

ValueSet / Code

Library.language

preferred

CommonLanguages

Additional Bindings

Purpose

AllLanguages

Max Binding

Library.identifier.use

IdentifierUse

Library.identifier.type

Identifier Type Codes

Library.status

PublicationStatus

Library.type

Pattern: asset-collection

Library.subject[x]

SubjectType

Library.useContext:reportingContext.code

Pattern: reporting

Library.useContext:reportingContext.value[x]

Pattern: triggering

Library.useContext:specificationTypeContext.code

Pattern: specification-type

Library.useContext:specificationTypeContext.value[x]

Pattern: value-set-library

Library.jurisdiction

Jurisdiction ValueSet

Library.topic

DefinitionTopic

Library.relatedArtifact:sliceUSPHValueSet.type