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

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Resource Profile: US Public Health Computable Library

This Library profile defines the Library that contains Clinical Quality Language (CQL) text, but not necessarily the compiled Expression Logical Model (ELM) for that CQL. It is intended to be used in environments that are capable of translating CQL to the executable ELM.

Usage:

• Refer to this Resource Profile: US Public Health Supplemental Library
• Examples for this Resource Profile: RuleFilters

Formal Views of Profile Content

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

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from Shareable Library

Name	Flags	Card.	Type	Description & Constraints
Library		1..1	Shareable Library	Represents a library of quality improvement components
subject[x]	S	0..1	CodeableConcept, Reference(Group)	Type of individual the library content is focused on
Slices for relatedArtifact	S	0..*	RelatedArtifact	Additional documentation, citations, etc. Slice: Unordered, Open by value:type
relatedArtifact:dependency		0..*	RelatedArtifact	Additional documentation, citations, etc.
type	S	1..1	code	Required dependency Fixed Value: depends-on
display	S	0..1	string	Brief description of the related artifact
resource	S	1..1	canonical(Shareable CodeSystem | Shareable Library | Shareable ValueSet)	What resource is being referenced
parameter	S	0..*	ParameterDefinition	Parameters defined by the library
dataRequirement	S	0..*	DataRequirement	What data is referenced by this library
Slices for content	S	1..*	Attachment	Contents of the library, either embedded or referenced Slice: Unordered, Open by value:contentType
content:cqlContent		1..1	Attachment	CQL Content
contentType	S	1..1	code	Mime type of the content, with charset etc. Fixed Value: text/cql
data		1..1	base64Binary	Data inline, base64ed
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Library	C	1..1	Shareable Library	Represents a library of quality improvement components
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
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
version	Σ	1..1	string	Business version of the library
name	ΣC	1..1	string	Name for this library (computer friendly)
title	SΣ	0..1	string	Name for this library (human friendly)
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	Σ	1..1	CodeableConcept	logic-library | model-definition | asset-collection | module-definition Binding: LibraryType (extensible): The type of knowledge asset this library contains.
subject[x]	S	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			CodeableConcept
subjectReference			Reference(Group)
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	Σ	1..1	markdown	Natural language description of the library
useContext	SΣ	0..*	UsageContext	The context that the content is intended to support
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.
Slices for relatedArtifact	S	0..*	RelatedArtifact	Additional documentation, citations, etc. Slice: Unordered, Open by value:type
relatedArtifact:dependency		0..*	RelatedArtifact	Additional documentation, citations, etc.
type	SΣ	1..1	code	Required dependency Binding: RelatedArtifactType (required): The type of relationship to the related artifact. Fixed Value: depends-on
display	SΣ	0..1	string	Brief description of the related artifact
resource	SΣ	1..1	canonical(Shareable CodeSystem | Shareable Library | Shareable ValueSet)	What resource is being referenced
parameter	S	0..*	ParameterDefinition	Parameters defined by the library
dataRequirement	S	0..*	DataRequirement	What data is referenced by this library
Slices for content	SΣ	1..*	Attachment	Contents of the library, either embedded or referenced Slice: Unordered, Open by value:contentType
content:cqlContent	Σ	1..1	Attachment	CQL Content
contentType	SΣ	1..1	code	Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Fixed Value: text/cql
data		1..1	base64Binary	Data inline, base64ed
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
Library.status	required	PublicationStatus
Library.type	extensible	LibraryType
Library.subject[x]	extensible	SubjectType
Library.jurisdiction	extensible	Jurisdiction ValueSet
Library.relatedArtifact:dependency.type	required	Fixed Value: depends-on
Library.content:cqlContent.contentType	required	Fixed Value: text/cql

Name	Flags	Card.	Type	Description & Constraints
Library	C	1..1	Shareable Library	Represents a library of quality improvement components
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	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
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
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
version	Σ	1..1	string	Business version of the library
name	ΣC	1..1	string	Name for this library (computer friendly)
title	SΣ	0..1	string	Name for this library (human friendly)
subtitle		0..1	string	Subordinate title of the library
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	Σ	1..1	CodeableConcept	logic-library | model-definition | asset-collection | module-definition Binding: LibraryType (extensible): The type of knowledge asset this library contains.
subject[x]	S	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			CodeableConcept
subjectReference			Reference(Group)
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	Σ	1..1	markdown	Natural language description of the library
useContext	SΣ	0..*	UsageContext	The context that the content is intended to support
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		0..1	markdown	Why this library is defined
usage		0..1	string	Describes the clinical usage of the library
copyright		0..1	markdown	Use and/or publishing restrictions
approvalDate		0..1	date	When the library was approved by publisher
lastReviewDate		0..1	date	When the library was last reviewed
effectivePeriod	Σ	0..1	Period	When the library is expected to be used
topic		0..*	CodeableConcept	E.g. Education, Treatment, Assessment, etc. Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.
author		0..*	ContactDetail	Who authored the content
editor		0..*	ContactDetail	Who edited the content
reviewer		0..*	ContactDetail	Who reviewed the content
endorser		0..*	ContactDetail	Who endorsed the content
Slices for relatedArtifact	S	0..*	RelatedArtifact	Additional documentation, citations, etc. Slice: Unordered, Open by value:type
relatedArtifact:dependency		0..*	RelatedArtifact	Additional documentation, citations, etc.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
type	SΣ	1..1	code	Required dependency Binding: RelatedArtifactType (required): The type of relationship to the related artifact. Fixed Value: depends-on
label	Σ	0..1	string	Short label
display	SΣ	0..1	string	Brief description of the related artifact
citation	Σ	0..1	markdown	Bibliographic citation for the artifact
url	Σ	0..1	url	Where the artifact can be accessed
document	Σ	0..1	Attachment	What document is being referenced
resource	SΣ	1..1	canonical(Shareable CodeSystem | Shareable Library | Shareable ValueSet)	What resource is being referenced
parameter	S	0..*	ParameterDefinition	Parameters defined by the library
dataRequirement	S	0..*	DataRequirement	What data is referenced by this library
Slices for content	SΣ	1..*	Attachment	Contents of the library, either embedded or referenced Slice: Unordered, Open by value:contentType
content:cqlContent	Σ	1..1	Attachment	CQL Content
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
contentType	SΣ	1..1	code	Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Fixed Value: text/cql
language	Σ	0..1	code	Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding Example General: en-AU
data		1..1	base64Binary	Data inline, base64ed
url	Σ	0..1	url	Uri where the data can be found Example General: http://www.acme.com/logo-small.png
size	Σ	0..1	unsignedInt	Number of bytes of content (if url provided)
hash	Σ	0..1	base64Binary	Hash of the data (sha-1, base64ed)
title	Σ	0..1	string	Label to display in place of the data Example General: Official Corporate Logo
creation	Σ	0..1	dateTime	Date attachment was first created
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
Library.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
Library.status	required	PublicationStatus
Library.type	extensible	LibraryType
Library.subject[x]	extensible	SubjectType
Library.jurisdiction	extensible	Jurisdiction ValueSet
Library.topic	example	DefinitionTopic
Library.relatedArtifact:dependency.type	required	Fixed Value: depends-on
Library.content:cqlContent.contentType	required	Fixed Value: text/cql
Library.content:cqlContent.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding

This structure is derived from Shareable Library

Summary

Mandatory: 4 elements (1 nested mandatory element)
Must-Support: 9 elements
Fixed Value: 2 elements

Structures

This structure refers to these other structures:

• Shareable CodeSystem (http://hl7.org/fhir/StructureDefinition/shareablecodesystem)
• Shareable Library (http://hl7.org/fhir/StructureDefinition/shareablelibrary)
• Shareable ValueSet (http://hl7.org/fhir/StructureDefinition/shareablevalueset)

Slices

This structure defines the following Slices:

• The element Library.relatedArtifact is sliced based on the value of value:type
• The element Library.content is sliced based on the value of value:contentType

Differential View

This structure is derived from Shareable Library

Name	Flags	Card.	Type	Description & Constraints
Library		1..1	Shareable Library	Represents a library of quality improvement components
subject[x]	S	0..1	CodeableConcept, Reference(Group)	Type of individual the library content is focused on
Slices for relatedArtifact	S	0..*	RelatedArtifact	Additional documentation, citations, etc. Slice: Unordered, Open by value:type
relatedArtifact:dependency		0..*	RelatedArtifact	Additional documentation, citations, etc.
type	S	1..1	code	Required dependency Fixed Value: depends-on
display	S	0..1	string	Brief description of the related artifact
resource	S	1..1	canonical(Shareable CodeSystem | Shareable Library | Shareable ValueSet)	What resource is being referenced
parameter	S	0..*	ParameterDefinition	Parameters defined by the library
dataRequirement	S	0..*	DataRequirement	What data is referenced by this library
Slices for content	S	1..*	Attachment	Contents of the library, either embedded or referenced Slice: Unordered, Open by value:contentType
content:cqlContent		1..1	Attachment	CQL Content
contentType	S	1..1	code	Mime type of the content, with charset etc. Fixed Value: text/cql
data		1..1	base64Binary	Data inline, base64ed
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Library	C	1..1	Shareable Library	Represents a library of quality improvement components
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
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
version	Σ	1..1	string	Business version of the library
name	ΣC	1..1	string	Name for this library (computer friendly)
title	SΣ	0..1	string	Name for this library (human friendly)
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	Σ	1..1	CodeableConcept	logic-library | model-definition | asset-collection | module-definition Binding: LibraryType (extensible): The type of knowledge asset this library contains.
subject[x]	S	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			CodeableConcept
subjectReference			Reference(Group)
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	Σ	1..1	markdown	Natural language description of the library
useContext	SΣ	0..*	UsageContext	The context that the content is intended to support
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.
Slices for relatedArtifact	S	0..*	RelatedArtifact	Additional documentation, citations, etc. Slice: Unordered, Open by value:type
relatedArtifact:dependency		0..*	RelatedArtifact	Additional documentation, citations, etc.
type	SΣ	1..1	code	Required dependency Binding: RelatedArtifactType (required): The type of relationship to the related artifact. Fixed Value: depends-on
display	SΣ	0..1	string	Brief description of the related artifact
resource	SΣ	1..1	canonical(Shareable CodeSystem | Shareable Library | Shareable ValueSet)	What resource is being referenced
parameter	S	0..*	ParameterDefinition	Parameters defined by the library
dataRequirement	S	0..*	DataRequirement	What data is referenced by this library
Slices for content	SΣ	1..*	Attachment	Contents of the library, either embedded or referenced Slice: Unordered, Open by value:contentType
content:cqlContent	Σ	1..1	Attachment	CQL Content
contentType	SΣ	1..1	code	Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Fixed Value: text/cql
data		1..1	base64Binary	Data inline, base64ed
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
Library.status	required	PublicationStatus
Library.type	extensible	LibraryType
Library.subject[x]	extensible	SubjectType
Library.jurisdiction	extensible	Jurisdiction ValueSet
Library.relatedArtifact:dependency.type	required	Fixed Value: depends-on
Library.content:cqlContent.contentType	required	Fixed Value: text/cql

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Library	C	1..1	Shareable Library	Represents a library of quality improvement components
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	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
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
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
version	Σ	1..1	string	Business version of the library
name	ΣC	1..1	string	Name for this library (computer friendly)
title	SΣ	0..1	string	Name for this library (human friendly)
subtitle		0..1	string	Subordinate title of the library
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	Σ	1..1	CodeableConcept	logic-library | model-definition | asset-collection | module-definition Binding: LibraryType (extensible): The type of knowledge asset this library contains.
subject[x]	S	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			CodeableConcept
subjectReference			Reference(Group)
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	Σ	1..1	markdown	Natural language description of the library
useContext	SΣ	0..*	UsageContext	The context that the content is intended to support
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		0..1	markdown	Why this library is defined
usage		0..1	string	Describes the clinical usage of the library
copyright		0..1	markdown	Use and/or publishing restrictions
approvalDate		0..1	date	When the library was approved by publisher
lastReviewDate		0..1	date	When the library was last reviewed
effectivePeriod	Σ	0..1	Period	When the library is expected to be used
topic		0..*	CodeableConcept	E.g. Education, Treatment, Assessment, etc. Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.
author		0..*	ContactDetail	Who authored the content
editor		0..*	ContactDetail	Who edited the content
reviewer		0..*	ContactDetail	Who reviewed the content
endorser		0..*	ContactDetail	Who endorsed the content
Slices for relatedArtifact	S	0..*	RelatedArtifact	Additional documentation, citations, etc. Slice: Unordered, Open by value:type
relatedArtifact:dependency		0..*	RelatedArtifact	Additional documentation, citations, etc.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
type	SΣ	1..1	code	Required dependency Binding: RelatedArtifactType (required): The type of relationship to the related artifact. Fixed Value: depends-on
label	Σ	0..1	string	Short label
display	SΣ	0..1	string	Brief description of the related artifact
citation	Σ	0..1	markdown	Bibliographic citation for the artifact
url	Σ	0..1	url	Where the artifact can be accessed
document	Σ	0..1	Attachment	What document is being referenced
resource	SΣ	1..1	canonical(Shareable CodeSystem | Shareable Library | Shareable ValueSet)	What resource is being referenced
parameter	S	0..*	ParameterDefinition	Parameters defined by the library
dataRequirement	S	0..*	DataRequirement	What data is referenced by this library
Slices for content	SΣ	1..*	Attachment	Contents of the library, either embedded or referenced Slice: Unordered, Open by value:contentType
content:cqlContent	Σ	1..1	Attachment	CQL Content
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
contentType	SΣ	1..1	code	Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Fixed Value: text/cql
language	Σ	0..1	code	Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding Example General: en-AU
data		1..1	base64Binary	Data inline, base64ed
url	Σ	0..1	url	Uri where the data can be found Example General: http://www.acme.com/logo-small.png
size	Σ	0..1	unsignedInt	Number of bytes of content (if url provided)
hash	Σ	0..1	base64Binary	Hash of the data (sha-1, base64ed)
title	Σ	0..1	string	Label to display in place of the data Example General: Official Corporate Logo
creation	Σ	0..1	dateTime	Date attachment was first created
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
Library.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
Library.status	required	PublicationStatus
Library.type	extensible	LibraryType
Library.subject[x]	extensible	SubjectType
Library.jurisdiction	extensible	Jurisdiction ValueSet
Library.topic	example	DefinitionTopic
Library.relatedArtifact:dependency.type	required	Fixed Value: depends-on
Library.content:cqlContent.contentType	required	Fixed Value: text/cql
Library.content:cqlContent.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding

This structure is derived from Shareable Library

Summary

Mandatory: 4 elements (1 nested mandatory element)
Must-Support: 9 elements
Fixed Value: 2 elements

Structures

This structure refers to these other structures:

• Shareable CodeSystem (http://hl7.org/fhir/StructureDefinition/shareablecodesystem)
• Shareable Library (http://hl7.org/fhir/StructureDefinition/shareablelibrary)
• Shareable ValueSet (http://hl7.org/fhir/StructureDefinition/shareablevalueset)

Slices

This structure defines the following Slices:

• The element Library.relatedArtifact is sliced based on the value of value:type
• The element Library.content is sliced based on the value of value:contentType

Other representations of profile: CSV, Excel, Schematron