Class MeasureReportGroupStratifierStratumPopulationComponent

MeasureReportGroupStratifierStratumPopulationComponent Class

Remarks

FHIR Specification

Short: Population results in this stratum
Definition: The populations that make up the stratum, one for each type of population appropriate to the measure.

See

FHIR MeasureReport

Hierarchy (View Summary)

BackboneElement
- MeasureReportGroupStratifierStratumPopulationComponent

Implements

IBackboneElement

Index

Constructors

constructor

Properties

linkId? code? count? subjectResults? subjectReport? subjects?

Constructors

constructor

new MeasureReportGroupStratifierStratumPopulationComponent(): MeasureReportGroupStratifierStratumPopulationComponent
Returns MeasureReportGroupStratifierStratumPopulationComponent
Overrides BackboneElement.constructor
- Defined in packages/r5-datamodels/src/resources/MeasureReport.ts:4745

Properties

`Private` `Optional`linkId

linkId?: StringType

MeasureReport.group.stratifier.stratum.population.linkId Element

Remarks

FHIR Specification

Short: Pointer to specific population from Measure
Definition: The population from the Measure that corresponds to this population in the MeasureReport resource.
FHIR Type: string
Cardinality: 0..1
isModifier: false
isSummary: false

`Private` `Optional`code

code?: CodeableConcept

MeasureReport.group.stratifier.stratum.population.code Element

Remarks

FHIR Specification

Short: initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation
Definition: The type of the population.
FHIR Type: CodeableConcept
Cardinality: 0..1
isModifier: false
isSummary: false

`Private` `Optional`count

count?: IntegerType

MeasureReport.group.stratifier.stratum.population.count Element

Remarks

FHIR Specification

Short: Size of the population
Definition: The number of members of the population in this stratum.
FHIR Type: integer
Cardinality: 0..1
isModifier: false
isSummary: false

`Private` `Optional`subjectResults

subjectResults?: Reference

MeasureReport.group.stratifier.stratum.population.subjectResults Element

Remarks

FHIR Specification

Short: For subject-list reports, the subject results in this population
Definition: This element refers to a List of individual level MeasureReport resources, one for each subject in this population in this stratum.
FHIR Type: Reference
- TargetProfiles: [ 'http://hl7.org/fhir/StructureDefinition/List', ]
Cardinality: 0..1
isModifier: false
isSummary: false

`Private` `Optional`subjectReport

subjectReport?: Reference[]

MeasureReport.group.stratifier.stratum.population.subjectReport Element

Remarks

FHIR Specification

Short: For subject-list reports, a subject result in this population
Definition: A reference to an individual level MeasureReport resource for a member of the population.
Comment: This element SHALL NOT be used in with subjectResults, either systems provide results as a List of MeasureReport, or as references to individual MeasureReports. Note that using this element introduces a constraint on the size of the subject-list MeasureReport; implementations would be free to return a TOO-COSTLY response if a request is made for a subject-list report with too many subjects.
FHIR Type: Reference
- TargetProfiles: [ 'http://hl7.org/fhir/StructureDefinition/MeasureReport', ]
Cardinality: 0..*
isModifier: false
isSummary: false

`Private` `Optional`subjects

subjects?: Reference

MeasureReport.group.stratifier.stratum.population.subjects Element

Remarks

FHIR Specification

Short: What individual(s) in the population
Definition: Optional Group identifying the individuals that make up the population.
Comment: Note that this element can only be used for summary and subject-list reports where the basis is of the same type as the populations (e.g. a Patient-based measure, rather than an Encounter-based measure). In addition, the referenced Group SHALL be an actual (as opposed to a definitional) group.
FHIR Type: Reference
- TargetProfiles: [ 'http://hl7.org/fhir/StructureDefinition/Group', ]
Cardinality: 0..1
isModifier: false
isSummary: false

Methods

`Static`parse

parse(
sourceJson: Value,
optSourceField?: string,
): undefined | MeasureReportGroupStratifierStratumPopulationComponent
Parse the provided MeasureReportGroupStratifierStratumPopulationComponent JSON to instantiate the MeasureReportGroupStratifierStratumPopulationComponent data model.
Parameters
- sourceJson: Value
  JSON representing FHIR MeasureReportGroupStratifierStratumPopulationComponent
- OptionaloptSourceField: string
  Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to MeasureReportGroupStratifierStratumPopulationComponent
Returns undefined | MeasureReportGroupStratifierStratumPopulationComponent
MeasureReportGroupStratifierStratumPopulationComponent data model or undefined for MeasureReportGroupStratifierStratumPopulationComponent

Throws
JsonError if the provided JSON is not a valid JSON object
- Defined in packages/r5-datamodels/src/resources/MeasureReport.ts:4757

getLinkIdElement

getLinkIdElement(): StringType
Returns StringType
the linkId property value as a StringType object if defined; else an empty StringType object
- Defined in packages/r5-datamodels/src/resources/MeasureReport.ts:4933

setLinkIdElement

setLinkIdElement(element: undefined | StringType): this
Assigns the provided PrimitiveType value to the linkId property.
Parameters
- element: undefined | StringType
  the linkId value
Returns this
this

Throws
InvalidTypeError for invalid data types

Throws
PrimitiveTypeError for invalid primitive types
- Defined in packages/r5-datamodels/src/resources/MeasureReport.ts:4945

hasLinkIdElement

hasLinkIdElement(): boolean
Returns boolean
true if the linkId property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/MeasureReport.ts:4959

getLinkId

getLinkId(): undefined | string
Returns undefined | string
the linkId property value as a fhirString if defined; else undefined
- Defined in packages/r5-datamodels/src/resources/MeasureReport.ts:4966

setLinkId

setLinkId(value: undefined | string): this
Assigns the provided primitive value to the linkId property.
Parameters
- value: undefined | string
  the linkId value
Returns this
this

Throws
PrimitiveTypeError for invalid primitive types
- Defined in packages/r5-datamodels/src/resources/MeasureReport.ts:4977

hasLinkId

hasLinkId(): boolean
Returns boolean
true if the linkId property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/MeasureReport.ts:4990

getCode

getCode(): CodeableConcept
Returns CodeableConcept
the code property value as a CodeableConcept object if defined; else an empty CodeableConcept object
- Defined in packages/r5-datamodels/src/resources/MeasureReport.ts:4997

setCode

setCode(value: undefined | CodeableConcept): this
Assigns the provided Code object value to the code property.
Parameters
- value: undefined | CodeableConcept
  the code object value
Returns this
this

Throws
InvalidTypeError for invalid data types
- Defined in packages/r5-datamodels/src/resources/MeasureReport.ts:5008

hasCode

hasCode(): boolean
Returns boolean
true if the code property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/MeasureReport.ts:5022

getCountElement

getCountElement(): IntegerType
Returns IntegerType
the count property value as a IntegerType object if defined; else an empty IntegerType object
- Defined in packages/r5-datamodels/src/resources/MeasureReport.ts:5029

setCountElement

setCountElement(element: undefined | IntegerType): this
Assigns the provided PrimitiveType value to the count property.
Parameters
- element: undefined | IntegerType
  the count value
Returns this
this

Throws
InvalidTypeError for invalid data types

Throws
PrimitiveTypeError for invalid primitive types
- Defined in packages/r5-datamodels/src/resources/MeasureReport.ts:5041

hasCountElement

hasCountElement(): boolean
Returns boolean
true if the count property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/MeasureReport.ts:5055

getCount

getCount(): undefined | number
Returns undefined | number
the count property value as a fhirInteger if defined; else undefined
- Defined in packages/r5-datamodels/src/resources/MeasureReport.ts:5062

setCount

setCount(value: undefined | number): this
Assigns the provided primitive value to the count property.
Parameters
- value: undefined | number
  the count value
Returns this
this

Throws
PrimitiveTypeError for invalid primitive types
- Defined in packages/r5-datamodels/src/resources/MeasureReport.ts:5073

hasCount

hasCount(): boolean
Returns boolean
true if the count property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/MeasureReport.ts:5086

getSubjectResults

getSubjectResults(): Reference
Returns Reference
the subjectResults property value as a Reference object; else an empty Reference object
- Defined in packages/r5-datamodels/src/resources/MeasureReport.ts:5093

setSubjectResults

setSubjectResults(value: undefined | Reference): this
Assigns the provided SubjectResults object value to the subjectResults property.
Parameters
- value: undefined | Reference
  the subjectResults object value
Returns this
this

Decorator
@ReferenceTargets('MeasureReport.group.stratifier.stratum.population.subjectResults', ['List',])

Throws
InvalidTypeError for invalid data type or reference value
- Defined in packages/r5-datamodels/src/resources/MeasureReport.ts:5109

hasSubjectResults

hasSubjectResults(): boolean
Returns boolean
true if the subjectResults property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/MeasureReport.ts:5122

getSubjectReport

getSubjectReport(): Reference[]
Returns Reference[]
the subjectReport property value as a Reference array
- Defined in packages/r5-datamodels/src/resources/MeasureReport.ts:5129

setSubjectReport

setSubjectReport(value: undefined | Reference[]): this
Assigns the provided Reference array value to the subjectReport property.
Parameters
- value: undefined | Reference[]
  the subjectReport array value
Returns this
this

Decorator
@ReferenceTargets('MeasureReport.group.stratifier.stratum.population.subjectReport', ['MeasureReport',])

Throws
InvalidTypeError for invalid data type or reference value
- Defined in packages/r5-datamodels/src/resources/MeasureReport.ts:5145

addSubjectReport

addSubjectReport(value: undefined | Reference): this
Add the provided Reference value to the subjectReport array property.
Parameters
- value: undefined | Reference
  the subjectReport value
Returns this
this

Decorator
@ReferenceTargets('MeasureReport.group.stratifier.stratum.population.subjectReport', ['MeasureReport',])

Throws
InvalidTypeError for invalid data type or reference value
- Defined in packages/r5-datamodels/src/resources/MeasureReport.ts:5167

hasSubjectReport

hasSubjectReport(): boolean
Returns boolean
true if the subjectReport property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/MeasureReport.ts:5179

getSubjects

getSubjects(): Reference
Returns Reference
the subjects property value as a Reference object; else an empty Reference object
- Defined in packages/r5-datamodels/src/resources/MeasureReport.ts:5195

setSubjects

setSubjects(value: undefined | Reference): this
Assigns the provided Subjects object value to the subjects property.
Parameters
- value: undefined | Reference
  the subjects object value
Returns this
this

Decorator
@ReferenceTargets('MeasureReport.group.stratifier.stratum.population.subjects', ['Group',])

Throws
InvalidTypeError for invalid data type or reference value
- Defined in packages/r5-datamodels/src/resources/MeasureReport.ts:5211

hasSubjects

hasSubjects(): boolean
Returns boolean
true if the subjects property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/MeasureReport.ts:5224

fhirType

fhirType(): string
Returns string
the FHIR type defined in the FHIR standard
Implementation of IBackboneElement.fhirType
Overrides BackboneElement.fhirType
- Defined in packages/r5-datamodels/src/resources/MeasureReport.ts:5233

isEmpty

isEmpty(): boolean
Returns boolean
true if the instance is empty; false otherwise
Implementation of IBackboneElement.isEmpty
Overrides BackboneElement.isEmpty
- Defined in packages/r5-datamodels/src/resources/MeasureReport.ts:5240

copy

copy(): MeasureReportGroupStratifierStratumPopulationComponent
Creates a copy of the current instance.

Returns MeasureReportGroupStratifierStratumPopulationComponent
the a new instance copied from the current instance
Implementation of IBackboneElement.copy
Overrides BackboneElement.copy
- Defined in packages/r5-datamodels/src/resources/MeasureReport.ts:5256

toJSON

toJSON(): undefined | Value
Returns undefined | Value
the JSON value or undefined if the instance is empty
Implementation of IBackboneElement.toJSON
Overrides BackboneElement.toJSON
- Defined in packages/r5-datamodels/src/resources/MeasureReport.ts:5282

getModifierExtension

getModifierExtension(): IExtension[]
Returns IExtension[]
the array of modifierExtension values
Implementation of IBackboneElement.getModifierExtension
Inherited from BackboneElement.getModifierExtension
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:195

setModifierExtension

setModifierExtension(extension: undefined | IExtension[]): this
Assigns the provided array of Extension values to the modifierExtension property.
Parameters
- extension: undefined | IExtension[]
  array of Extensions
Returns this
this
Implementation of IBackboneElement.setModifierExtension
Inherited from BackboneElement.setModifierExtension
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:202

hasModifierExtension

hasModifierExtension(url?: string): boolean
Determines if the modifierExtension property exists.
Parameters
- Optionalurl: string
  the url that identifies a specific Extension
Returns boolean
true if an Extension has the provided url; false otherwise

Remarks
If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the modifierExtension property exists and has any values.

Throws
AssertionError for invalid url
Implementation of IBackboneElement.hasModifierExtension
Inherited from BackboneElement.hasModifierExtension
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:214

getModifierExtensionByUrl

getModifierExtensionByUrl(url: string): undefined | IExtension
Returns the Extension having the provided url.
Parameters
- url: string
  the url that identifies a specific Extension
Returns undefined | IExtension
the Extension having the provided url

Throws
AssertionError for invalid url
Implementation of IBackboneElement.getModifierExtensionByUrl
Inherited from BackboneElement.getModifierExtensionByUrl
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:222

addModifierExtension

addModifierExtension(extension: undefined | IExtension): this
Adds the provided Extension to the modifierExtension property array.
Parameters
- extension: undefined | IExtension
  the Extension value to add to the modifierExtension property array
Returns this
this
Implementation of IBackboneElement.addModifierExtension
Inherited from BackboneElement.addModifierExtension
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:229

removeModifierExtension

removeModifierExtension(url: string): void
Removes the Extension having the provided url from the modifierExtension property array.
Parameters
- url: string
  the url that identifies a specific Extension to remove
Returns void
Throws
AssertionError for invalid url
Implementation of IBackboneElement.removeModifierExtension
Inherited from BackboneElement.removeModifierExtension
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:236

getId

getId(): undefined | string
Returns undefined | string
the id property value
Implementation of IBackboneElement.getId
Inherited from BackboneElement.getId
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:59

setId

setId(value: undefined | string): this
Assigns the provided value to the id property.
Parameters
- value: undefined | string
  the id value
Returns this
this

Throws
PrimitiveTypeError for invalid value
Implementation of IBackboneElement.setId
Inherited from BackboneElement.setId
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:67

hasId

hasId(): boolean
Returns boolean
true if id exists and has a value; false otherwise
Implementation of IBackboneElement.hasId
Inherited from BackboneElement.hasId
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:71

getExtension

getExtension(): IExtension[]
Returns IExtension[]
the array of extension values
Implementation of IBackboneElement.getExtension
Inherited from BackboneElement.getExtension
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:75

setExtension

setExtension(extension: undefined | IExtension[]): this
Assigns the provided array of Extension values to the extension property.
Parameters
- extension: undefined | IExtension[]
  array of Extensions
Returns this
this
Implementation of IBackboneElement.setExtension
Inherited from BackboneElement.setExtension
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:82

hasExtension

hasExtension(url?: string): boolean
Determines if the extension property exists.
Parameters
- Optionalurl: string
  the url that identifies a specific Extension
Returns boolean
true if an Extension has the provided url; false otherwise

Remarks
If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

Throws
AssertionError for invalid url
Implementation of IBackboneElement.hasExtension
Inherited from BackboneElement.hasExtension
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:94

getExtensionByUrl

getExtensionByUrl(url: string): undefined | IExtension
Determines if the extension property exists.
Parameters
- url: string
  the url that identifies a specific Extension
Returns undefined | IExtension
an Extension having the provided url

Remarks
If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

Throws
AssertionError for invalid url
Implementation of IBackboneElement.getExtensionByUrl
Inherited from BackboneElement.getExtensionByUrl
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:106

addExtension

addExtension(extension: undefined | IExtension): this
Adds the provided Extension to the extension property array.
Parameters
- extension: undefined | IExtension
  the Extension value to add to the extension property array
Returns this
this
Implementation of IBackboneElement.addExtension
Inherited from BackboneElement.addExtension
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:113

removeExtension

removeExtension(url: string): void
Removes the Extension having the provided url from the extension property array.
Parameters
- url: string
  the url that identifies a specific Extension to remove
Returns void
Throws
AssertionError for invalid url
Implementation of IBackboneElement.removeExtension
Inherited from BackboneElement.removeExtension
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:120

isRequiredFieldsEmpty

isRequiredFieldsEmpty(): boolean
Returns boolean
true if and only if the data model has required fields (min cardinality > 0) and at least one of those required fields in the instance is empty; false otherwise
Implementation of IBackboneElement.isRequiredFieldsEmpty
Inherited from BackboneElement.isRequiredFieldsEmpty
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:63

isResource

isResource(): boolean
Returns boolean
true if the instance is a FHIR resource; false otherwise
Implementation of IBackboneElement.isResource
Inherited from BackboneElement.isResource
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:67

isDataType

isDataType(): boolean
Returns boolean
true if the instance is a FHIR complex or primitive datatype; false otherwise
Implementation of IBackboneElement.isDataType
Inherited from BackboneElement.isDataType
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:71

isComplexDataType

isComplexDataType(): boolean
Returns boolean
true if the instance is a FHIR complex datatype; false otherwise
Implementation of IBackboneElement.isComplexDataType
Inherited from BackboneElement.isComplexDataType
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:75

isPrimitive

isPrimitive(): boolean
Returns boolean
true if the instance is a FHIR primitive datatype; false otherwise
Implementation of IBackboneElement.isPrimitive
Inherited from BackboneElement.isPrimitive
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:79

isBooleanPrimitive

isBooleanPrimitive(): boolean
Returns boolean
true if the instance is a FHIR primitive boolean datatype; false otherwise
Implementation of IBackboneElement.isBooleanPrimitive
Inherited from BackboneElement.isBooleanPrimitive
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:83

isStringPrimitive

isStringPrimitive(): boolean
Returns boolean
true if the instance is a FHIR primitive string-based datatype; false otherwise
Implementation of IBackboneElement.isStringPrimitive
Inherited from BackboneElement.isStringPrimitive
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:87

isNumberPrimitive

isNumberPrimitive(): boolean
Returns boolean
true if the instance is a FHIR primitive number-based datatype; false otherwise
Implementation of IBackboneElement.isNumberPrimitive
Inherited from BackboneElement.isNumberPrimitive
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:91

isBigIntPrimitive

isBigIntPrimitive(): boolean
Returns boolean
true if the instance is a FHIR primitive bigint-based datatype; false otherwise
Implementation of IBackboneElement.isBigIntPrimitive
Inherited from BackboneElement.isBigIntPrimitive
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:95

isDateTimePrimitive

isDateTimePrimitive(): boolean
Returns boolean
true if the instance is a FHIR primitive datetime-based datatype; false otherwise
Implementation of IBackboneElement.isDateTimePrimitive
Inherited from BackboneElement.isDateTimePrimitive
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:99

`Protected`copyValues

copyValues(dest: MeasureReportGroupStratifierStratumPopulationComponent): void
Protected
Copies the current instance's elements into the provided object.
Parameters
- dest: MeasureReportGroupStratifierStratumPopulationComponent
  the copied instance
Returns void
Overrides BackboneElement.copyValues
- Defined in packages/r5-datamodels/src/resources/MeasureReport.ts:5268

`Private`initSubjectReport

initSubjectReport(): void
Initialize the subjectReport property

Returns void
- Defined in packages/r5-datamodels/src/resources/MeasureReport.ts:5186

Class MeasureReportGroupStratifierStratumPopulationComponent

Remarks

See

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns MeasureReportGroupStratifierStratumPopulationComponent

Properties

Private OptionallinkId

Remarks

Private Optionalcode

Remarks

Private Optionalcount

Remarks

Private OptionalsubjectResults

Remarks

Private OptionalsubjectReport

Remarks

Private Optionalsubjects

Remarks

Methods

Staticparse

Parameters

Returns undefined | MeasureReportGroupStratifierStratumPopulationComponent

Throws

getLinkIdElement

Returns StringType

setLinkIdElement

Parameters

Returns this

Throws

Throws

hasLinkIdElement

Returns boolean

getLinkId

Returns undefined | string

setLinkId

Parameters

Returns this

Throws

hasLinkId

Returns boolean

getCode

Returns CodeableConcept

setCode

Parameters

Returns this

Throws

hasCode

Returns boolean

getCountElement

Returns IntegerType

setCountElement

Parameters

Returns this

Throws

Throws

hasCountElement

Returns boolean

getCount

Returns undefined | number

setCount

Parameters

Returns this

Throws

hasCount

Returns boolean

getSubjectResults

Returns Reference

setSubjectResults

Parameters

Returns this

Decorator

Throws

hasSubjectResults

`Private` `Optional`linkId

`Private` `Optional`code

`Private` `Optional`count

`Private` `Optional`subjectResults

`Private` `Optional`subjectReport

`Private` `Optional`subjects

`Static`parse