This page is part of the Situational Awareness for Novel Epidemic Response (v0.1.0: STU 1 Ballot 1) based on FHIR R4. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions
Defining URL: | http://hl7.org/fhir/uv/saner/StructureDefinition/PublicHealthMeasureLibrary |
Version: | 0.1.0 |
Name: | PublicHealthMeasureLibrary |
Title: | Public Health Measure Library |
Status: | Draft as of 2020-10-19T21:09:16+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
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Library
This structure is derived from Library
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Library | 0..* | Library | Represents a library of quality improvement components | |
url | 1..1 | uri | Each resource must have a url. | |
version | 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 | 1..1 | string | Each resource must have a name. | |
status | 1..1 | code | draft | active | retired Binding: Measure Status Values (required) | |
experimental | 1..1 | boolean | A resource must indicate its experimental status | |
publisher | 1..1 | string | The name of the organization publishing this resource | |
contact | 1..* | ContactDetail | The contact information for whom to contact about this resource | |
useContext | 1..* | UsageContext | The ISO 3166 code for use context | |
author | 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 | 1..1 | string | The author must be identified by name. Can be the name of an individual or an organization. | |
telecom | 1..* | ContactPoint | There must be contact information for the author. | |
relatedArtifact | 1..* | RelatedArtifact | There must be at least one artifact describing the measure in human readable form. | |
content | 1..* | PublicHealthMeasureMetadataAttachment | Content in a format defined elsewhere | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Library | I | 0..* | Library | Represents a library of quality improvement components |
id | Σ | 0..1 | string | 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) Max Binding: AllLanguages | |
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 | Each resource must have a url. |
identifier | Σ | 0..* | Identifier | Additional identifier for the library |
version | Σ | 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 | ΣI | 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 | Σ | 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) |
subject[x] | 0..1 | Type of individual the library content is focused on Binding: SubjectType (extensible) | ||
subjectCodeableConcept | CodeableConcept | |||
subjectReference | Reference(Group) | |||
date | Σ | 0..1 | dateTime | Date last changed |
publisher | Σ | 1..1 | string | The name of the organization publishing this resource |
contact | Σ | 1..* | ContactDetail | The contact information for whom to contact about this resource |
description | Σ | 0..1 | markdown | Natural language description of the library |
useContext | Σ | 1..* | UsageContext | The ISO 3166 code for use context |
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for library (if applicable) Binding: Jurisdiction ValueSet (extensible) |
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) | |
author | 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 | Σ | 1..1 | string | The author must be identified by name. Can be the name of an individual or an organization. |
telecom | Σ | 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 | 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 | I | 1..* | PublicHealthMeasureMetadataAttachment | Content in a format defined elsewhere |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Library | I | 0..* | Library | Represents a library of quality improvement components |
Documentation for this format |
This structure is derived from Library
Differential View
This structure is derived from Library
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Library | 0..* | Library | Represents a library of quality improvement components | |
url | 1..1 | uri | Each resource must have a url. | |
version | 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 | 1..1 | string | Each resource must have a name. | |
status | 1..1 | code | draft | active | retired Binding: Measure Status Values (required) | |
experimental | 1..1 | boolean | A resource must indicate its experimental status | |
publisher | 1..1 | string | The name of the organization publishing this resource | |
contact | 1..* | ContactDetail | The contact information for whom to contact about this resource | |
useContext | 1..* | UsageContext | The ISO 3166 code for use context | |
author | 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 | 1..1 | string | The author must be identified by name. Can be the name of an individual or an organization. | |
telecom | 1..* | ContactPoint | There must be contact information for the author. | |
relatedArtifact | 1..* | RelatedArtifact | There must be at least one artifact describing the measure in human readable form. | |
content | 1..* | PublicHealthMeasureMetadataAttachment | Content in a format defined elsewhere | |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Library | I | 0..* | Library | Represents a library of quality improvement components |
id | Σ | 0..1 | string | 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) Max Binding: AllLanguages | |
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 | Each resource must have a url. |
identifier | Σ | 0..* | Identifier | Additional identifier for the library |
version | Σ | 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 | ΣI | 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 | Σ | 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) |
subject[x] | 0..1 | Type of individual the library content is focused on Binding: SubjectType (extensible) | ||
subjectCodeableConcept | CodeableConcept | |||
subjectReference | Reference(Group) | |||
date | Σ | 0..1 | dateTime | Date last changed |
publisher | Σ | 1..1 | string | The name of the organization publishing this resource |
contact | Σ | 1..* | ContactDetail | The contact information for whom to contact about this resource |
description | Σ | 0..1 | markdown | Natural language description of the library |
useContext | Σ | 1..* | UsageContext | The ISO 3166 code for use context |
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for library (if applicable) Binding: Jurisdiction ValueSet (extensible) |
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) | |
author | 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 | Σ | 1..1 | string | The author must be identified by name. Can be the name of an individual or an organization. |
telecom | Σ | 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 | 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 | I | 1..* | PublicHealthMeasureMetadataAttachment | Content in a format defined elsewhere |
Documentation for this format |
Other representations of profile: Schematron
Path | Conformance | ValueSet |
Library.language | preferred | CommonLanguages Max Binding: AllLanguages |
Library.status | required | MeasureStatus |
Library.type | extensible | LibraryType |
Library.subject[x] | extensible | SubjectType |
Library.jurisdiction | extensible | Jurisdiction ValueSet |
Library.topic | example | DefinitionTopic |