Situational Awareness for Novel Epidemic Response
1.0.0 - STU Release

This page is part of the Situational Awareness for Novel Epidemic Response (v1.0.0: STU 1) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: Public Health Measure Library

Defining URL:http://hl7.org/fhir/uv/saner/StructureDefinition/PublicHealthMeasureLibrary
Version:1.0.0
Name:PublicHealthMeasureLibrary
Title:Public Health Measure Library
Status:Draft as of 2021-09-07T19:08:29+00:00
Definition:

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

Publisher:HL7 International Public Health Workgroup
Source Resource:XML / JSON / Turtle

The official URL for this profile is: 

http://hl7.org/fhir/uv/saner/StructureDefinition/PublicHealthMeasureLibrary

Formal Views of Profile Content

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

This structure is derived from Library

Summary

Mandatory: 12 elements
Must-Support: 12 elements

Structures

This structure refers to these other structures:

This structure is derived from Library

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library 0..*LibraryRepresents a library of quality improvement components
... url S1..1uriEach resource must have a url.
... version S1..1stringResources 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 S1..1stringEach resource must have a name.
... experimental S1..1booleanA resource must indicate its experimental status
... publisher S1..1stringThe name of the organization publishing this resource
... contact S1..*ContactDetailThe contact information for whom to contact about this resource
... useContext S1..*UsageContextThe ISO 3166 code for use context
... author S1..1ContactDetailThe original author of the measure content, may be same as publisher, when otherwise, must include a relatedArtifact for the original author's publication
.... name S1..1stringThe author must be identified by name. Can be the name of an individual or an organization.
.... telecom S1..*ContactPointThere must be contact information for the author.
... relatedArtifact S1..*RelatedArtifactThere must be at least one artifact describing the measure in human readable form.
... content S1..*PublicHealthMeasureMetadataAttachmentContent in a format defined elsewhere

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Library I0..*LibraryRepresents a library of quality improvement components
... id Σ0..1stringLogical 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)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url SΣ1..1uriEach resource must have a url.
... identifier Σ0..*IdentifierAdditional identifier for the library
... version SΣ1..1stringResources 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ΣI1..1stringEach resource must have a name.
... title Σ0..1stringName for this library (human friendly)
... subtitle 0..1stringSubordinate title of the library
... status ?!Σ1..1codedraft | active | retired
Binding: Measure Status Values (required)
... experimental SΣ1..1booleanA resource must indicate its experimental status
... type Σ1..1CodeableConceptlogic-library | model-definition | asset-collection | module-definition
Binding: LibraryType (extensible): The type of knowledge asset this library contains.

... 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 Σ0..1dateTimeDate last changed
... publisher SΣ1..1stringThe name of the organization publishing this resource
... contact SΣ1..*ContactDetailThe contact information for whom to contact about this resource
... description Σ0..1markdownNatural language description of the library
... useContext SΣ1..*UsageContextThe ISO 3166 code for use context
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for library (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose 0..1markdownWhy this library is defined
... 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 Σ0..1PeriodWhen the library is expected to be used
... topic 0..*CodeableConceptE.g. Education, Treatment, Assessment, etc.
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.


... author S1..1ContactDetailThe 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..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... name SΣ1..1stringThe author must be identified by name. Can be the name of an individual or an organization.
.... telecom SΣ1..*ContactPointThere must be contact information for the author.
... editor 0..*ContactDetailWho edited the content
... reviewer 0..*ContactDetailWho reviewed the content
... endorser 0..*ContactDetailWho endorsed the content
... relatedArtifact S1..*RelatedArtifactThere must be at least one artifact describing the measure in human readable form.
... parameter 0..*ParameterDefinitionParameters defined by the library
... dataRequirement 0..*DataRequirementWhat data is referenced by this library
... content SI1..*PublicHealthMeasureMetadataAttachmentContent in a format defined elsewhere

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Library I0..*LibraryRepresents a library of quality improvement components
... url Σ1..1uriEach resource must have a url.
... version Σ1..1stringResources 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 ΣI1..1stringEach resource must have a name.
... publisher Σ1..1stringThe name of the organization publishing this resource
... contact Σ1..*ContactDetailThe contact information for whom to contact about this resource
... useContext Σ1..*UsageContextThe ISO 3166 code for use context
... author 1..1ContactDetailThe original author of the measure content, may be same as publisher, when otherwise, must include a relatedArtifact for the original author's publication
.... name Σ1..1stringThe author must be identified by name. Can be the name of an individual or an organization.
.... telecom Σ1..*ContactPointThere must be contact information for the author.
... relatedArtifact 1..*RelatedArtifactThere must be at least one artifact describing the measure in human readable form.
... content I1..*PublicHealthMeasureMetadataAttachmentContent in a format defined elsewhere

doco Documentation for this format

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 0..*LibraryRepresents a library of quality improvement components
... url S1..1uriEach resource must have a url.
... version S1..1stringResources 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 S1..1stringEach resource must have a name.
... experimental S1..1booleanA resource must indicate its experimental status
... publisher S1..1stringThe name of the organization publishing this resource
... contact S1..*ContactDetailThe contact information for whom to contact about this resource
... useContext S1..*UsageContextThe ISO 3166 code for use context
... author S1..1ContactDetailThe original author of the measure content, may be same as publisher, when otherwise, must include a relatedArtifact for the original author's publication
.... name S1..1stringThe author must be identified by name. Can be the name of an individual or an organization.
.... telecom S1..*ContactPointThere must be contact information for the author.
... relatedArtifact S1..*RelatedArtifactThere must be at least one artifact describing the measure in human readable form.
... content S1..*PublicHealthMeasureMetadataAttachmentContent in a format defined elsewhere

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library I0..*LibraryRepresents a library of quality improvement components
... id Σ0..1stringLogical 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)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url SΣ1..1uriEach resource must have a url.
... identifier Σ0..*IdentifierAdditional identifier for the library
... version SΣ1..1stringResources 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ΣI1..1stringEach resource must have a name.
... title Σ0..1stringName for this library (human friendly)
... subtitle 0..1stringSubordinate title of the library
... status ?!Σ1..1codedraft | active | retired
Binding: Measure Status Values (required)
... experimental SΣ1..1booleanA resource must indicate its experimental status
... type Σ1..1CodeableConceptlogic-library | model-definition | asset-collection | module-definition
Binding: LibraryType (extensible): The type of knowledge asset this library contains.

... 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 Σ0..1dateTimeDate last changed
... publisher SΣ1..1stringThe name of the organization publishing this resource
... contact SΣ1..*ContactDetailThe contact information for whom to contact about this resource
... description Σ0..1markdownNatural language description of the library
... useContext SΣ1..*UsageContextThe ISO 3166 code for use context
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for library (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose 0..1markdownWhy this library is defined
... 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 Σ0..1PeriodWhen the library is expected to be used
... topic 0..*CodeableConceptE.g. Education, Treatment, Assessment, etc.
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.


... author S1..1ContactDetailThe 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..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... name SΣ1..1stringThe author must be identified by name. Can be the name of an individual or an organization.
.... telecom SΣ1..*ContactPointThere must be contact information for the author.
... editor 0..*ContactDetailWho edited the content
... reviewer 0..*ContactDetailWho reviewed the content
... endorser 0..*ContactDetailWho endorsed the content
... relatedArtifact S1..*RelatedArtifactThere must be at least one artifact describing the measure in human readable form.
... parameter 0..*ParameterDefinitionParameters defined by the library
... dataRequirement 0..*DataRequirementWhat data is referenced by this library
... content SI1..*PublicHealthMeasureMetadataAttachmentContent in a format defined elsewhere

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Library.languagepreferredCommonLanguages
Max Binding: AllLanguages
Library.statusrequiredMeasureStatus
Library.typeextensibleLibraryType
Library.subject[x]extensibleSubjectType
Library.jurisdictionextensibleJurisdiction ValueSet
Library.topicexampleDefinitionTopic