Situational Awareness for Novel Epidemic Response
1.0.1 - CI Build International flag

Situational Awareness for Novel Epidemic Response, published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 1.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-saner/ and changes regularly. See the Directory of published versions

Resource Profile: Public Health Measure Library

Official URL: http://hl7.org/fhir/uv/saner/StructureDefinition/PublicHealthMeasureLibrary Version: 1.0.1
Draft as of 2024-05-18 Computable Name: PublicHealthMeasureLibrary
Other Identifiers: OID:2.16.840.1.113883.4.642.40.42.42.11

A Public Health Measure Library contains essential ConceptMap, ValueSet, CodingSystem, NamingSystem, SearchParameter, CQL definitions or other resources for measure evaluation.

Usage:

Formal Views of Profile Content

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

This structure is derived from Library

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library Library
... url S 1..1 uri Each resource must have a url.
... version S 1..1 string Resources are versioned like IG's 0.1.0 = first development version, 0.2.0 - first published for review version, 1.0.0 first official version ...
... name S 1..1 string Each resource must have a name.
... experimental S 1..1 boolean A resource must indicate its experimental status
... publisher S 1..1 string The name of the organization publishing this resource
... contact S 1..* ContactDetail The contact information for whom to contact about this resource
... useContext S 1..* UsageContext The ISO 3166 code for use context
... author S 1..1 ContactDetail The original author of the measure content, may be same as publisher, when otherwise, must include a relatedArtifact for the original author's publication
.... name S 1..1 string The author must be identified by name. Can be the name of an individual or an organization.
.... telecom S 1..* ContactPoint There must be contact information for the author.
... relatedArtifact S 1..* RelatedArtifact There must be at least one artifact describing the measure in human readable form.
... content S 1..* PublicHealthMeasureMetadataAttachment Content in a format defined elsewhere

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Library.statusrequiredMeasureStatus
http://hl7.org/fhir/uv/saner/ValueSet/MeasureStatus
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. Library C 0..* Library Represents a library of quality improvement components
lib-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... url SΣ 1..1 uri Each resource must have a url.
... name SΣC 1..1 string Each resource must have a name.
... status ?!Σ 1..1 code draft | active | retired
Binding: Measure Status Values (required)
... experimental SΣ 1..1 boolean A resource must indicate its experimental status
... type Σ 1..1 CodeableConcept logic-library | model-definition | asset-collection | module-definition
Binding: LibraryType (extensible): The type of knowledge asset this library contains.

... publisher SΣ 1..1 string The name of the organization publishing this resource
... contact SΣ 1..* ContactDetail The contact information for whom to contact about this resource
... useContext SΣ 1..* UsageContext The ISO 3166 code for use context
... author S 1..1 ContactDetail The original author of the measure content, may be same as publisher, when otherwise, must include a relatedArtifact for the original author's publication
.... name SΣ 1..1 string The author must be identified by name. Can be the name of an individual or an organization.
.... telecom SΣ 1..* ContactPoint There must be contact information for the author.
... relatedArtifact S 1..* RelatedArtifact There must be at least one artifact describing the measure in human readable form.
... content SC 1..* PublicHealthMeasureMetadataAttachment Content in a format defined elsewhere
att-1: If the Attachment has data, it SHALL have a contentType

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Library.statusrequiredMeasureStatus
http://hl7.org/fhir/uv/saner/ValueSet/MeasureStatus
from this IG
Library.typeextensibleLibraryType
http://hl7.org/fhir/ValueSet/library-type
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. Library C 0..* Library Represents a library of quality improvement components
lib-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
... 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 BindingsPurpose
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 SΣ 1..1 uri Each resource must have a url.
... identifier Σ 0..* Identifier Additional identifier for the library
... version SΣ 1..1 string Resources are versioned like IG's 0.1.0 = first development version, 0.2.0 - first published for review version, 1.0.0 first official version ...
... name SΣC 1..1 string Each resource must have a name.
... title Σ 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
Binding: Measure Status Values (required)
... experimental SΣ 1..1 boolean A resource must indicate its experimental status
... 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] 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 Σ 0..1 dateTime Date last changed
... publisher SΣ 1..1 string The name of the organization publishing this resource
... contact SΣ 1..* ContactDetail The contact information for whom to contact about this resource
... description Σ 0..1 markdown Natural language description of the library
... useContext SΣ 1..* UsageContext The ISO 3166 code for use context
... jurisdiction Σ 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 S 1..1 ContactDetail The original author of the measure content, may be same as publisher, when otherwise, must include a relatedArtifact for the original author's publication
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... name SΣ 1..1 string The author must be identified by name. Can be the name of an individual or an organization.
.... telecom SΣ 1..* ContactPoint There must be contact information for the author.
... editor 0..* ContactDetail Who edited the content
... reviewer 0..* ContactDetail Who reviewed the content
... endorser 0..* ContactDetail Who endorsed the content
... relatedArtifact S 1..* RelatedArtifact There must be at least one artifact describing the measure in human readable form.
... parameter 0..* ParameterDefinition Parameters defined by the library
... dataRequirement 0..* DataRequirement What data is referenced by this library
... content SC 1..* PublicHealthMeasureMetadataAttachment Content in a format defined elsewhere
att-1: If the Attachment has data, it SHALL have a contentType

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Library.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Library.statusrequiredMeasureStatus
http://hl7.org/fhir/uv/saner/ValueSet/MeasureStatus
from this IG
Library.typeextensibleLibraryType
http://hl7.org/fhir/ValueSet/library-type
from the FHIR Standard
Library.subject[x]extensibleSubjectType
http://hl7.org/fhir/ValueSet/subject-type
from the FHIR Standard
Library.jurisdictionextensibleJurisdiction ValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
Library.topicexampleDefinitionTopic
http://hl7.org/fhir/ValueSet/definition-topic
from the FHIR Standard

This structure is derived from Library

Summary

Mandatory: 12 elements
Must-Support: 12 elements

Structures

This structure refers to these other structures:

Differential View

This structure is derived from Library

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library Library
... url S 1..1 uri Each resource must have a url.
... version S 1..1 string Resources are versioned like IG's 0.1.0 = first development version, 0.2.0 - first published for review version, 1.0.0 first official version ...
... name S 1..1 string Each resource must have a name.
... experimental S 1..1 boolean A resource must indicate its experimental status
... publisher S 1..1 string The name of the organization publishing this resource
... contact S 1..* ContactDetail The contact information for whom to contact about this resource
... useContext S 1..* UsageContext The ISO 3166 code for use context
... author S 1..1 ContactDetail The original author of the measure content, may be same as publisher, when otherwise, must include a relatedArtifact for the original author's publication
.... name S 1..1 string The author must be identified by name. Can be the name of an individual or an organization.
.... telecom S 1..* ContactPoint There must be contact information for the author.
... relatedArtifact S 1..* RelatedArtifact There must be at least one artifact describing the measure in human readable form.
... content S 1..* PublicHealthMeasureMetadataAttachment Content in a format defined elsewhere

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Library.statusrequiredMeasureStatus
http://hl7.org/fhir/uv/saner/ValueSet/MeasureStatus
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library C 0..* Library Represents a library of quality improvement components
lib-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... url SΣ 1..1 uri Each resource must have a url.
... name SΣC 1..1 string Each resource must have a name.
... status ?!Σ 1..1 code draft | active | retired
Binding: Measure Status Values (required)
... experimental SΣ 1..1 boolean A resource must indicate its experimental status
... type Σ 1..1 CodeableConcept logic-library | model-definition | asset-collection | module-definition
Binding: LibraryType (extensible): The type of knowledge asset this library contains.

... publisher SΣ 1..1 string The name of the organization publishing this resource
... contact SΣ 1..* ContactDetail The contact information for whom to contact about this resource
... useContext SΣ 1..* UsageContext The ISO 3166 code for use context
... author S 1..1 ContactDetail The original author of the measure content, may be same as publisher, when otherwise, must include a relatedArtifact for the original author's publication
.... name SΣ 1..1 string The author must be identified by name. Can be the name of an individual or an organization.
.... telecom SΣ 1..* ContactPoint There must be contact information for the author.
... relatedArtifact S 1..* RelatedArtifact There must be at least one artifact describing the measure in human readable form.
... content SC 1..* PublicHealthMeasureMetadataAttachment Content in a format defined elsewhere
att-1: If the Attachment has data, it SHALL have a contentType

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Library.statusrequiredMeasureStatus
http://hl7.org/fhir/uv/saner/ValueSet/MeasureStatus
from this IG
Library.typeextensibleLibraryType
http://hl7.org/fhir/ValueSet/library-type
from the FHIR Standard

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library C 0..* Library Represents a library of quality improvement components
lib-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
... 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 BindingsPurpose
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 SΣ 1..1 uri Each resource must have a url.
... identifier Σ 0..* Identifier Additional identifier for the library
... version SΣ 1..1 string Resources are versioned like IG's 0.1.0 = first development version, 0.2.0 - first published for review version, 1.0.0 first official version ...
... name SΣC 1..1 string Each resource must have a name.
... title Σ 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
Binding: Measure Status Values (required)
... experimental SΣ 1..1 boolean A resource must indicate its experimental status
... 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] 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 Σ 0..1 dateTime Date last changed
... publisher SΣ 1..1 string The name of the organization publishing this resource
... contact SΣ 1..* ContactDetail The contact information for whom to contact about this resource
... description Σ 0..1 markdown Natural language description of the library
... useContext SΣ 1..* UsageContext The ISO 3166 code for use context
... jurisdiction Σ 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 S 1..1 ContactDetail The original author of the measure content, may be same as publisher, when otherwise, must include a relatedArtifact for the original author's publication
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... name SΣ 1..1 string The author must be identified by name. Can be the name of an individual or an organization.
.... telecom SΣ 1..* ContactPoint There must be contact information for the author.
... editor 0..* ContactDetail Who edited the content
... reviewer 0..* ContactDetail Who reviewed the content
... endorser 0..* ContactDetail Who endorsed the content
... relatedArtifact S 1..* RelatedArtifact There must be at least one artifact describing the measure in human readable form.
... parameter 0..* ParameterDefinition Parameters defined by the library
... dataRequirement 0..* DataRequirement What data is referenced by this library
... content SC 1..* PublicHealthMeasureMetadataAttachment Content in a format defined elsewhere
att-1: If the Attachment has data, it SHALL have a contentType

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Library.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Library.statusrequiredMeasureStatus
http://hl7.org/fhir/uv/saner/ValueSet/MeasureStatus
from this IG
Library.typeextensibleLibraryType
http://hl7.org/fhir/ValueSet/library-type
from the FHIR Standard
Library.subject[x]extensibleSubjectType
http://hl7.org/fhir/ValueSet/subject-type
from the FHIR Standard
Library.jurisdictionextensibleJurisdiction ValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
Library.topicexampleDefinitionTopic
http://hl7.org/fhir/ValueSet/definition-topic
from the FHIR Standard

This structure is derived from Library

Summary

Mandatory: 12 elements
Must-Support: 12 elements

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel, Schematron