This page is part of the Quality Measure STU2 for FHIR R4 Implementation Guide (v2.1.0: STU3 Ballot 1) based on FHIR R4. The current version which supercedes this version is 3.0.0. For a full list of available versions, see the Directory of published versions
Defining URL: | http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/quality-program-cqfm |
Version: | 2.1.0 |
Name: | CQFMQualityProgram |
Status: | Active as of 2021-04-13T15:56:35+00:00 |
Definition: | Defines and supports the definition of Quality Programs |
Publisher: | Clinical Quality Information WG |
Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/quality-program-cqfm
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Shareable Library
Summary
Mandatory: 8 elements (4 nested mandatory elements)
Must-Support: 27 elements
Fixed Value: 2 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
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 | |
text | S | 1..1 | Narrative | Text summary of the resource, for human interpretation |
cqfm-partOf | S | 0..1 | canonical() | What program this is part of URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-partOf |
cqfm-directReferenceCode | S | 0..* | Coding | A code directly referenced by the measure URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-directReferenceCode |
cqfm-expansionUri | S | 0..1 | uri | What expansion URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-expansionUri |
cqfm-activeOnly | S | 0..1 | boolean | Only active codes? URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-activeOnly |
identifier | S | 1..* | Identifier | Additional identifier for the library |
title | S | 1..1 | string | Name for this library (human friendly) |
type | S | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection | module-definition Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/library-type | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: asset-collection | |
date | S | 1..1 | dateTime | Date last changed |
useContext | S | 0..* | (Slice Definition) | The context that the content is intended to support Slice: Unordered, Open by value:code |
useContext:qualityProgram | S | 1..1 | UsageContext | The context that the content is intended to support |
code | S | 1..1 | Coding | Type of context being specified Required Pattern: At least the following |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: program | |
value[x] | S | 1..1 | CodeableConcept | Value that defines the context Binding: Quality Programs (extensible): Supports the defintion of Quality Programs and that the set of identified quality program is not exhaustive and not prescribing codes for programs |
effectivePeriod | S | 0..1 | Period | When the library is expected to be used |
relatedArtifact | S | 0..* | (Slice Definition) | Additional documentation, citations, etc. Slice: Unordered, Open by value:type |
relatedArtifact:measure | S | 0..* | RelatedArtifact | Measure (and version) |
cqfm-programIdentifier | S | 0..1 | Identifier | Measure number within the program URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-programIdentifier |
cqfm-qualityDomain | S | 0..* | CodeableConcept | What domain URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-qualityDomain |
cqfm-meaningfulMeasureArea | S | 0..* | CodeableConcept | What measure area URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-meaningfulMeasureArea |
type | S | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Fixed Value: composed-of |
display | S | 0..1 | string | Brief description of the related artifact |
resource | S | 1..1 | canonical(Measure) | What resource is being referenced |
relatedArtifact:dependency | S | 0..* | RelatedArtifact | Library, CodeSystem, or ValueSet (and version) |
cqfm-expansionUri | S | 0..1 | uri | What expansion URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-expansionUri |
type | S | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Fixed Value: depends-on |
display | S | 0..1 | string | Brief description of the related artifact |
resource | S | 1..1 | canonical(CodeSystem | Library | ValueSet) | What resource is being referenced |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Library | I | 1..1 | Shareable 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: A human language. | |
text | S | 1..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
cqfm-partOf | S | 0..1 | canonical() | What program this is part of URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-partOf |
cqfm-directReferenceCode | S | 0..* | Coding | A code directly referenced by the measure URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-directReferenceCode |
cqfm-expansionUri | S | 0..1 | uri | What expansion URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-expansionUri |
cqfm-activeOnly | S | 0..1 | boolean | Only active codes? URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-activeOnly |
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Σ | 1..* | Identifier | Additional identifier for the library |
version | Σ | 1..1 | string | Business version of the library |
name | ΣI | 1..1 | string | Name for this library (computer friendly) |
title | SΣ | 1..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 | SΣ | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection | module-definition Binding: LibraryType (extensible): The type of knowledge asset this library contains. Required Pattern: At least the following |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/library-type | |
version | 0..1 | string | Version of the system - if relevant | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: asset-collection | |
display | 0..1 | string | Representation defined by the system | |
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
text | 0..1 | string | Plain text representation of the concept | |
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 | SΣ | 1..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..* | (Slice Definition) | The context that the content is intended to support Slice: Unordered, Open by value:code |
useContext:qualityProgram | SΣ | 1..1 | UsageContext | The context that the content is intended to support |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
code | SΣ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. Required Pattern: At least the following |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type | |
version | 0..1 | string | Version of the system - if relevant | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: program | |
display | 0..1 | string | Representation defined by the system | |
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
value[x] | SΣ | 1..1 | CodeableConcept | Value that defines the context Binding: Quality Programs (extensible): Supports the defintion of Quality Programs and that the set of identified quality program is not exhaustive and not prescribing codes for programs |
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 | SΣ | 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 | |
relatedArtifact | S | 0..* | (Slice Definition) | Additional documentation, citations, etc. Slice: Unordered, Open by value:type |
relatedArtifact:measure | S | 0..* | RelatedArtifact | Measure (and version) |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
cqfm-programIdentifier | S | 0..1 | Identifier | Measure number within the program URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-programIdentifier |
cqfm-qualityDomain | S | 0..* | CodeableConcept | What domain URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-qualityDomain |
cqfm-meaningfulMeasureArea | S | 0..* | CodeableConcept | What measure area URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-meaningfulMeasureArea |
type | SΣ | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Binding: RelatedArtifactType (required): The type of relationship to the related artifact. Fixed Value: composed-of |
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(Measure) | What resource is being referenced |
relatedArtifact:dependency | S | 0..* | RelatedArtifact | Library, CodeSystem, or ValueSet (and version) |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
cqfm-expansionUri | S | 0..1 | uri | What expansion URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-expansionUri |
type | SΣ | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of 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(CodeSystem | Library | ValueSet) | What resource is being referenced |
parameter | 0..* | ParameterDefinition | Parameters defined by the library | |
dataRequirement | 0..* | DataRequirement | What data is referenced by this library | |
content | Σ | 0..* | Attachment | Contents of the library, either embedded or referenced |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Library | I | 1..1 | Shareable Library | Represents a library of quality improvement components |
text | 1..1 | Narrative | Text summary of the resource, for human interpretation | |
cqfm-partOf | 0..1 | canonical() | What program this is part of URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-partOf | |
cqfm-directReferenceCode | 0..* | Coding | A code directly referenced by the measure URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-directReferenceCode | |
cqfm-expansionUri | 0..1 | uri | What expansion URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-expansionUri | |
cqfm-activeOnly | 0..1 | boolean | Only active codes? URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-activeOnly | |
identifier | Σ | 1..* | Identifier | Additional identifier for the library |
title | Σ | 1..1 | string | Name for this library (human friendly) |
type | Σ | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection | module-definition Binding: LibraryType (extensible): The type of knowledge asset this library contains. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/library-type | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: asset-collection | |
date | Σ | 1..1 | dateTime | Date last changed |
contact | Σ | 0..* | ContactDetail | Contact details for the publisher |
useContext | Σ | 0..* | (Slice Definition) | The context that the content is intended to support Slice: Unordered, Open by value:code |
useContext:qualityProgram | Σ | 1..1 | UsageContext | The context that the content is intended to support |
code | Σ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. Required Pattern: At least the following |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: program | |
value[x] | Σ | 1..1 | CodeableConcept | Value that defines the context Binding: Quality Programs (extensible): Supports the defintion of Quality Programs and that the set of identified quality program is not exhaustive and not prescribing codes for programs |
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for library (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. |
effectivePeriod | Σ | 0..1 | Period | When the library is expected to be used |
relatedArtifact | 0..* | (Slice Definition) | Additional documentation, citations, etc. Slice: Unordered, Open by value:type | |
relatedArtifact:measure | 0..* | RelatedArtifact | Measure (and version) | |
cqfm-programIdentifier | 0..1 | Identifier | Measure number within the program URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-programIdentifier | |
cqfm-qualityDomain | 0..* | CodeableConcept | What domain URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-qualityDomain | |
cqfm-meaningfulMeasureArea | 0..* | CodeableConcept | What measure area URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-meaningfulMeasureArea | |
type | Σ | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Binding: RelatedArtifactType (required): The type of relationship to the related artifact. Fixed Value: composed-of |
display | Σ | 0..1 | string | Brief description of the related artifact |
resource | Σ | 1..1 | canonical(Measure) | What resource is being referenced |
relatedArtifact:dependency | 0..* | RelatedArtifact | Library, CodeSystem, or ValueSet (and version) | |
cqfm-expansionUri | 0..1 | uri | What expansion URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-expansionUri | |
type | Σ | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Binding: RelatedArtifactType (required): The type of relationship to the related artifact. Fixed Value: depends-on |
display | Σ | 0..1 | string | Brief description of the related artifact |
resource | Σ | 1..1 | canonical(CodeSystem | Library | ValueSet) | What resource is being referenced |
Documentation for this format |
This structure is derived from Shareable Library
Summary
Mandatory: 8 elements (4 nested mandatory elements)
Must-Support: 27 elements
Fixed Value: 2 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
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 | |
text | S | 1..1 | Narrative | Text summary of the resource, for human interpretation |
cqfm-partOf | S | 0..1 | canonical() | What program this is part of URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-partOf |
cqfm-directReferenceCode | S | 0..* | Coding | A code directly referenced by the measure URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-directReferenceCode |
cqfm-expansionUri | S | 0..1 | uri | What expansion URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-expansionUri |
cqfm-activeOnly | S | 0..1 | boolean | Only active codes? URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-activeOnly |
identifier | S | 1..* | Identifier | Additional identifier for the library |
title | S | 1..1 | string | Name for this library (human friendly) |
type | S | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection | module-definition Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/library-type | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: asset-collection | |
date | S | 1..1 | dateTime | Date last changed |
useContext | S | 0..* | (Slice Definition) | The context that the content is intended to support Slice: Unordered, Open by value:code |
useContext:qualityProgram | S | 1..1 | UsageContext | The context that the content is intended to support |
code | S | 1..1 | Coding | Type of context being specified Required Pattern: At least the following |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: program | |
value[x] | S | 1..1 | CodeableConcept | Value that defines the context Binding: Quality Programs (extensible): Supports the defintion of Quality Programs and that the set of identified quality program is not exhaustive and not prescribing codes for programs |
effectivePeriod | S | 0..1 | Period | When the library is expected to be used |
relatedArtifact | S | 0..* | (Slice Definition) | Additional documentation, citations, etc. Slice: Unordered, Open by value:type |
relatedArtifact:measure | S | 0..* | RelatedArtifact | Measure (and version) |
cqfm-programIdentifier | S | 0..1 | Identifier | Measure number within the program URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-programIdentifier |
cqfm-qualityDomain | S | 0..* | CodeableConcept | What domain URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-qualityDomain |
cqfm-meaningfulMeasureArea | S | 0..* | CodeableConcept | What measure area URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-meaningfulMeasureArea |
type | S | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Fixed Value: composed-of |
display | S | 0..1 | string | Brief description of the related artifact |
resource | S | 1..1 | canonical(Measure) | What resource is being referenced |
relatedArtifact:dependency | S | 0..* | RelatedArtifact | Library, CodeSystem, or ValueSet (and version) |
cqfm-expansionUri | S | 0..1 | uri | What expansion URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-expansionUri |
type | S | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Fixed Value: depends-on |
display | S | 0..1 | string | Brief description of the related artifact |
resource | S | 1..1 | canonical(CodeSystem | Library | ValueSet) | What resource is being referenced |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Library | I | 1..1 | Shareable 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: A human language. | |
text | S | 1..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
cqfm-partOf | S | 0..1 | canonical() | What program this is part of URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-partOf |
cqfm-directReferenceCode | S | 0..* | Coding | A code directly referenced by the measure URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-directReferenceCode |
cqfm-expansionUri | S | 0..1 | uri | What expansion URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-expansionUri |
cqfm-activeOnly | S | 0..1 | boolean | Only active codes? URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-activeOnly |
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Σ | 1..* | Identifier | Additional identifier for the library |
version | Σ | 1..1 | string | Business version of the library |
name | ΣI | 1..1 | string | Name for this library (computer friendly) |
title | SΣ | 1..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 | SΣ | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection | module-definition Binding: LibraryType (extensible): The type of knowledge asset this library contains. Required Pattern: At least the following |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/library-type | |
version | 0..1 | string | Version of the system - if relevant | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: asset-collection | |
display | 0..1 | string | Representation defined by the system | |
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
text | 0..1 | string | Plain text representation of the concept | |
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 | SΣ | 1..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..* | (Slice Definition) | The context that the content is intended to support Slice: Unordered, Open by value:code |
useContext:qualityProgram | SΣ | 1..1 | UsageContext | The context that the content is intended to support |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
code | SΣ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. Required Pattern: At least the following |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type | |
version | 0..1 | string | Version of the system - if relevant | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: program | |
display | 0..1 | string | Representation defined by the system | |
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
value[x] | SΣ | 1..1 | CodeableConcept | Value that defines the context Binding: Quality Programs (extensible): Supports the defintion of Quality Programs and that the set of identified quality program is not exhaustive and not prescribing codes for programs |
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 | SΣ | 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 | |
relatedArtifact | S | 0..* | (Slice Definition) | Additional documentation, citations, etc. Slice: Unordered, Open by value:type |
relatedArtifact:measure | S | 0..* | RelatedArtifact | Measure (and version) |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
cqfm-programIdentifier | S | 0..1 | Identifier | Measure number within the program URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-programIdentifier |
cqfm-qualityDomain | S | 0..* | CodeableConcept | What domain URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-qualityDomain |
cqfm-meaningfulMeasureArea | S | 0..* | CodeableConcept | What measure area URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-meaningfulMeasureArea |
type | SΣ | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Binding: RelatedArtifactType (required): The type of relationship to the related artifact. Fixed Value: composed-of |
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(Measure) | What resource is being referenced |
relatedArtifact:dependency | S | 0..* | RelatedArtifact | Library, CodeSystem, or ValueSet (and version) |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
cqfm-expansionUri | S | 0..1 | uri | What expansion URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-expansionUri |
type | SΣ | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of 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(CodeSystem | Library | ValueSet) | What resource is being referenced |
parameter | 0..* | ParameterDefinition | Parameters defined by the library | |
dataRequirement | 0..* | DataRequirement | What data is referenced by this library | |
content | Σ | 0..* | Attachment | Contents of the library, either embedded or referenced |
Documentation for this format |
Other representations of profile: Schematron
Path | Conformance | ValueSet / Code |
Library.language | preferred | CommonLanguages Max Binding: AllLanguages |
Library.status | required | PublicationStatus |
Library.type | extensible | Pattern: asset-collection |
Library.subject[x] | extensible | SubjectType |
Library.useContext:qualityProgram.code | extensible | Pattern: program |
Library.useContext:qualityProgram.value[x] | extensible | QualityPrograms |
Library.jurisdiction | extensible | Jurisdiction ValueSet |
Library.topic | example | DefinitionTopic |
Library.relatedArtifact:measure.type | required | Fixed Value: composed-of |
Library.relatedArtifact:dependency.type | required | Fixed Value: depends-on |
Id | Path | Details | Requirements |
dom-2 | Library | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | Library | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | Library | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | Library | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | Library | A resource should have narrative for robust management : text.`div`.exists() | |
lib-0 | Library | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.matches('[A-Z]([A-Za-z0-9_]){0,254}') | |
ele-1 | Library.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Library.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Library.extension:partOf | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Library.extension:partOf | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Library.extension:directReferenceCode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Library.extension:directReferenceCode | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Library.extension:expansionUri | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Library.extension:expansionUri | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Library.extension:activeOnly | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Library.extension:activeOnly | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Library.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Library.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Library.url | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.version | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.name | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.title | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.subtitle | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.experimental | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.subject[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.date | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.publisher | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.contact | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.description | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.useContext | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.useContext:qualityProgram | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.useContext:qualityProgram.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Library.useContext:qualityProgram.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Library.useContext:qualityProgram.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.useContext:qualityProgram.value[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.jurisdiction | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.purpose | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.usage | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.copyright | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.approvalDate | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.lastReviewDate | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.effectivePeriod | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.topic | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.author | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.editor | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.reviewer | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.endorser | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.relatedArtifact | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.relatedArtifact:measure | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.relatedArtifact:measure.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Library.relatedArtifact:measure.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Library.relatedArtifact:measure.extension:programIdentifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Library.relatedArtifact:measure.extension:programIdentifier | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Library.relatedArtifact:measure.extension:qualityDomain | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Library.relatedArtifact:measure.extension:qualityDomain | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Library.relatedArtifact:measure.extension:meaningfulMeasureArea | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Library.relatedArtifact:measure.extension:meaningfulMeasureArea | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Library.relatedArtifact:measure.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.relatedArtifact:measure.label | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.relatedArtifact:measure.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.relatedArtifact:measure.citation | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.relatedArtifact:measure.url | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.relatedArtifact:measure.document | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.relatedArtifact:measure.resource | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.relatedArtifact:dependency | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.relatedArtifact:dependency.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Library.relatedArtifact:dependency.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Library.relatedArtifact:dependency.extension:expansionUri | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Library.relatedArtifact:dependency.extension:expansionUri | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Library.relatedArtifact:dependency.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.relatedArtifact:dependency.label | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.relatedArtifact:dependency.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.relatedArtifact:dependency.citation | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.relatedArtifact:dependency.url | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.relatedArtifact:dependency.document | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.relatedArtifact:dependency.resource | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.parameter | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.dataRequirement | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Library.content | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |