US Public Health Profiles Library
1.0.0 - STU1 United States of America flag

US Public Health Profiles Library, published by HL7 Public Health Working Group. This is not an authorized publication; it is the continuous build for version 1.0.0). This version is based on the current content of https://github.com/HL7/fhir-us-ph-common-library-ig/ and changes regularly. See the Directory of published versions

Resource Profile: US Public Health Supplemental ValueSet Library

Official URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-supplemental-valueset-library Version: 1.0.0
Active as of 2023-10-04 Computable Name: USPublicHealthSupplementalValuesetLibrary

This Library profile defines the library that is a computable supplement for a public health reporting program specification, including computable routing rules that can be evaluated to help facilitate reportability determination at reporting sites, typically consisting of Clinical Quality Language (CQL) Rule libraries and additional terminiology artifacts required to evaluate those rules.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from USPublicHealthValueSetLibrary

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library 1..1USPublicHealthValueSetLibraryRepresents a library of quality improvement components
... relatedArtifact:USPHValueSet 1..*RelatedArtifactUS Public Health Supplemental Value Set
.... resource 1..1canonical(US Public Health Supplemental ValueSet)What resource is being referenced

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Library C1..1USPublicHealthValueSetLibraryRepresents a library of quality improvement components
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... expansionParameters S0..1Reference(Parameters)Expansion Parameters for the ValueSet.
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-expansion-parameters-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierAdditional identifier for the library
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... system SΣ1..1uriThe namespace for Object Identifiers
Required Pattern: urn:ietf:rfc:3986
.... value SΣ1..1stringThe value that is unique
Example General: 123456
... version SΣ1..1stringValue Sets Definition Version
... name ΣC1..1stringName for this library (computer friendly)
... title SΣ1..1stringValue Sets Name
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ1..1booleanFor testing purposes, not real usage
... type SΣ1..1CodeableConceptasset-collection
Binding: LibraryType (extensible): The type of knowledge asset this library contains.


Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/library-type
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: asset-collection
... date SΣ0..1dateTimeDate last changed
... publisher Σ1..1stringName of the publisher (organization or individual)
... contact SΣ0..*ContactDetailContact details for the publisher
... description SΣ1..1markdownThe description should succinctly and lucidly state the scope of the value sets included (the domains covered with as much specificity as to make the collection unique) and the intended use of the collection (a sense of what guides can use the collection).
... useContext SΣ0..*UsageContextThe context that the content is intended to support
... jurisdiction SΣ0..*CodeableConceptIntended jurisdiction for library (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose S1..1markdownValue Sets Purpose
... effectivePeriod SΣ1..1PeriodWhen the library is expected to be used
.... start SΣC1..1dateTimeValue Sets Effective Start Date
... Slices for relatedArtifact 1..*RelatedArtifactAdditional documentation, citations, etc.
Slice: Unordered, Open by profile:resource.resolve()
.... relatedArtifact:USPHValueSet S1..*RelatedArtifactUS Public Health Supplemental Value Set
..... type Σ1..1codecomposed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.


Required Pattern: composed-of
..... resource SΣ1..1canonical(US Public Health Supplemental ValueSet)What resource is being referenced

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Library.identifier.userequiredIdentifierUse
Library.statusrequiredPublicationStatus
Library.typeextensiblePattern: asset-collection
Library.jurisdictionextensibleJurisdiction ValueSet
Library.relatedArtifact:USPHValueSet.typerequiredPattern: composed-of
NameFlagsCard.TypeDescription & Constraintsdoco
.. Library C1..1USPublicHealthValueSetLibraryRepresents a library of quality improvement components
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... expansionParameters S0..1Reference(Parameters)Expansion Parameters for the ValueSet.
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-expansion-parameters-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ1..1uriCanonical identifier for this library, represented as a URI (globally unique)
... identifier SΣ0..*IdentifierAdditional identifier for the library
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..1CodeableConceptDescription 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.

.... system SΣ1..1uriThe namespace for Object Identifiers
Required Pattern: urn:ietf:rfc:3986
.... value SΣ1..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... version SΣ1..1stringValue Sets Definition Version
... name ΣC1..1stringName for this library (computer friendly)
... title SΣ1..1stringValue Sets Name
... subtitle 0..1stringSubordinate title of the library
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ1..1booleanFor testing purposes, not real usage
... type SΣ1..1CodeableConceptasset-collection
Binding: LibraryType (extensible): The type of knowledge asset this library contains.


Required Pattern: At least the following
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/library-type
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: asset-collection
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... subject[x] 0..1Type 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.).

.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group)
... date SΣ0..1dateTimeDate last changed
... publisher Σ1..1stringName of the publisher (organization or individual)
... contact SΣ0..*ContactDetailContact details for the publisher
... description SΣ1..1markdownThe description should succinctly and lucidly state the scope of the value sets included (the domains covered with as much specificity as to make the collection unique) and the intended use of the collection (a sense of what guides can use the collection).
... useContext SΣ0..*UsageContextThe context that the content is intended to support
... jurisdiction SΣ0..*CodeableConceptIntended jurisdiction for library (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose S1..1markdownValue Sets Purpose
... usage 0..1stringDescribes the clinical usage of the library
... copyright 0..1markdownUse and/or publishing restrictions
... approvalDate 0..1dateWhen the library was approved by publisher
... lastReviewDate 0..1dateWhen the library was last reviewed
... effectivePeriod SΣ1..1PeriodWhen the library is expected to be used
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... start SΣC1..1dateTimeValue Sets Effective Start Date
.... end ΣC0..1dateTimeEnd time with inclusive boundary, if not ongoing
... topic 0..*CodeableConceptE.g. Education, Treatment, Assessment, etc.
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.


... author 0..*ContactDetailWho authored the content
... editor 0..*ContactDetailWho edited the content
... reviewer 0..*ContactDetailWho reviewed the content
... endorser 0..*ContactDetailWho endorsed the content
... Slices for relatedArtifact 1..*RelatedArtifactAdditional documentation, citations, etc.
Slice: Unordered, Open by profile:resource.resolve()
.... relatedArtifact:USPHValueSet S1..*RelatedArtifactUS Public Health Supplemental Value Set
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... type Σ1..1codecomposed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.


Required Pattern: composed-of
..... label Σ0..1stringShort label
..... display Σ0..1stringBrief description of the related artifact
..... citation Σ0..1markdownBibliographic citation for the artifact
..... url Σ0..1urlWhere the artifact can be accessed
..... document Σ0..1AttachmentWhat document is being referenced
..... resource SΣ1..1canonical(US Public Health Supplemental ValueSet)What resource is being referenced
... parameter 0..*ParameterDefinitionParameters defined by the library
... dataRequirement 0..*DataRequirementWhat data is referenced by this library
... content Σ0..*AttachmentContents of the library, either embedded or referenced

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Library.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Library.identifier.userequiredIdentifierUse
Library.identifier.typeextensibleIdentifier Type Codes
Library.statusrequiredPublicationStatus
Library.typeextensiblePattern: asset-collection
Library.subject[x]extensibleSubjectType
Library.jurisdictionextensibleJurisdiction ValueSet
Library.topicexampleDefinitionTopic
Library.relatedArtifact:USPHValueSet.typerequiredPattern: composed-of

Differential View

This structure is derived from USPublicHealthValueSetLibrary

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library 1..1USPublicHealthValueSetLibraryRepresents a library of quality improvement components
... relatedArtifact:USPHValueSet 1..*RelatedArtifactUS Public Health Supplemental Value Set
.... resource 1..1canonical(US Public Health Supplemental ValueSet)What resource is being referenced

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library C1..1USPublicHealthValueSetLibraryRepresents a library of quality improvement components
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... expansionParameters S0..1Reference(Parameters)Expansion Parameters for the ValueSet.
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-expansion-parameters-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierAdditional identifier for the library
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... system SΣ1..1uriThe namespace for Object Identifiers
Required Pattern: urn:ietf:rfc:3986
.... value SΣ1..1stringThe value that is unique
Example General: 123456
... version SΣ1..1stringValue Sets Definition Version
... name ΣC1..1stringName for this library (computer friendly)
... title SΣ1..1stringValue Sets Name
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ1..1booleanFor testing purposes, not real usage
... type SΣ1..1CodeableConceptasset-collection
Binding: LibraryType (extensible): The type of knowledge asset this library contains.


Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/library-type
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: asset-collection
... date SΣ0..1dateTimeDate last changed
... publisher Σ1..1stringName of the publisher (organization or individual)
... contact SΣ0..*ContactDetailContact details for the publisher
... description SΣ1..1markdownThe description should succinctly and lucidly state the scope of the value sets included (the domains covered with as much specificity as to make the collection unique) and the intended use of the collection (a sense of what guides can use the collection).
... useContext SΣ0..*UsageContextThe context that the content is intended to support
... jurisdiction SΣ0..*CodeableConceptIntended jurisdiction for library (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose S1..1markdownValue Sets Purpose
... effectivePeriod SΣ1..1PeriodWhen the library is expected to be used
.... start SΣC1..1dateTimeValue Sets Effective Start Date
... Slices for relatedArtifact 1..*RelatedArtifactAdditional documentation, citations, etc.
Slice: Unordered, Open by profile:resource.resolve()
.... relatedArtifact:USPHValueSet S1..*RelatedArtifactUS Public Health Supplemental Value Set
..... type Σ1..1codecomposed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.


Required Pattern: composed-of
..... resource SΣ1..1canonical(US Public Health Supplemental ValueSet)What resource is being referenced

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Library.identifier.userequiredIdentifierUse
Library.statusrequiredPublicationStatus
Library.typeextensiblePattern: asset-collection
Library.jurisdictionextensibleJurisdiction ValueSet
Library.relatedArtifact:USPHValueSet.typerequiredPattern: composed-of

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library C1..1USPublicHealthValueSetLibraryRepresents a library of quality improvement components
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... expansionParameters S0..1Reference(Parameters)Expansion Parameters for the ValueSet.
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-expansion-parameters-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ1..1uriCanonical identifier for this library, represented as a URI (globally unique)
... identifier SΣ0..*IdentifierAdditional identifier for the library
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..1CodeableConceptDescription 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.

.... system SΣ1..1uriThe namespace for Object Identifiers
Required Pattern: urn:ietf:rfc:3986
.... value SΣ1..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... version SΣ1..1stringValue Sets Definition Version
... name ΣC1..1stringName for this library (computer friendly)
... title SΣ1..1stringValue Sets Name
... subtitle 0..1stringSubordinate title of the library
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ1..1booleanFor testing purposes, not real usage
... type SΣ1..1CodeableConceptasset-collection
Binding: LibraryType (extensible): The type of knowledge asset this library contains.


Required Pattern: At least the following
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/library-type
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: asset-collection
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... subject[x] 0..1Type 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.).

.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group)
... date SΣ0..1dateTimeDate last changed
... publisher Σ1..1stringName of the publisher (organization or individual)
... contact SΣ0..*ContactDetailContact details for the publisher
... description SΣ1..1markdownThe description should succinctly and lucidly state the scope of the value sets included (the domains covered with as much specificity as to make the collection unique) and the intended use of the collection (a sense of what guides can use the collection).
... useContext SΣ0..*UsageContextThe context that the content is intended to support
... jurisdiction SΣ0..*CodeableConceptIntended jurisdiction for library (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose S1..1markdownValue Sets Purpose
... usage 0..1stringDescribes the clinical usage of the library
... copyright 0..1markdownUse and/or publishing restrictions
... approvalDate 0..1dateWhen the library was approved by publisher
... lastReviewDate 0..1dateWhen the library was last reviewed
... effectivePeriod SΣ1..1PeriodWhen the library is expected to be used
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... start SΣC1..1dateTimeValue Sets Effective Start Date
.... end ΣC0..1dateTimeEnd time with inclusive boundary, if not ongoing
... topic 0..*CodeableConceptE.g. Education, Treatment, Assessment, etc.
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.


... author 0..*ContactDetailWho authored the content
... editor 0..*ContactDetailWho edited the content
... reviewer 0..*ContactDetailWho reviewed the content
... endorser 0..*ContactDetailWho endorsed the content
... Slices for relatedArtifact 1..*RelatedArtifactAdditional documentation, citations, etc.
Slice: Unordered, Open by profile:resource.resolve()
.... relatedArtifact:USPHValueSet S1..*RelatedArtifactUS Public Health Supplemental Value Set
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... type Σ1..1codecomposed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.


Required Pattern: composed-of
..... label Σ0..1stringShort label
..... display Σ0..1stringBrief description of the related artifact
..... citation Σ0..1markdownBibliographic citation for the artifact
..... url Σ0..1urlWhere the artifact can be accessed
..... document Σ0..1AttachmentWhat document is being referenced
..... resource SΣ1..1canonical(US Public Health Supplemental ValueSet)What resource is being referenced
... parameter 0..*ParameterDefinitionParameters defined by the library
... dataRequirement 0..*DataRequirementWhat data is referenced by this library
... content Σ0..*AttachmentContents of the library, either embedded or referenced

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Library.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Library.identifier.userequiredIdentifierUse
Library.identifier.typeextensibleIdentifier Type Codes
Library.statusrequiredPublicationStatus
Library.typeextensiblePattern: asset-collection
Library.subject[x]extensibleSubjectType
Library.jurisdictionextensibleJurisdiction ValueSet
Library.topicexampleDefinitionTopic
Library.relatedArtifact:USPHValueSet.typerequiredPattern: composed-of

 

Other representations of profile: CSV, Excel, Schematron