athenahealth Estimated Gestational Age - Definitions - Athena Core Implementation Guide v2.33.0

Athena Core Implementation Guide
2.33.0 - release

Athena Core Implementation Guide - Local Development build (v2.33.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Extension: AthenahealthEstimatedGestationalAge - Detailed Descriptions

Active as of 2024-04-12

Definitions for the ah-estimated-gestational-age extension.

Differential Elements Table
Key Elements Table
Snapshot Elements Table

Guidance on how to interpret the contents of this table can be found here

0. Extension
Definition	An Extension to Observation for the estimated gestational age (EGA) of a pregnancy.
Short	athenahealth Estimated Gestational Age
2. Extension.extension
Control	0..0
4. Extension.url
Requirements	The fixed value for this attribute is 'https://fhir.athena.io/StructureDefinition/ah-estimated-gestational-age'
Fixed Value	`https://fhir.athena.io/StructureDefinition/ah-estimated-gestational-age`
6. Extension.value[x]
Definition	Estimated gestational age (EGA) of a pregnancy in weeks and days
Short	Estimated gestational age (EGA) of a pregnancy
Control	1..?
Type	Quantity, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] Note	See Choice of Data Types for further information about how to use [x]
8. Extension.value[x].value
Control	1..?
10. Extension.value[x].comparator
Control	0..0
12. Extension.value[x].unit
Control	1..?
Pattern Value	`weeks.days`
14. Extension.value[x].system
Control	0..0
16. Extension.value[x].code
Control	0..0

Guidance on how to interpret the contents of this table can be found here

0. Extension
Definition	An Extension to Observation for the estimated gestational age (EGA) of a pregnancy. Optional Extension Element - found in all resources.
Short	athenahealth Estimated Gestational AgeOptional Extensions Element
Control	0..* This element is affected by the following invariants: ele-1
Is Modifier	false
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2. Extension.extension
Definition	An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short	ExtensionAdditional content defined by implementations
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control	0..0*
Type	Extension
Is Modifier	false
Summary	false
Alternate Names	extensions, user content
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing	This element introduces a set of slices on `Extension.extension`. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
4. Extension.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Short	identifies the meaning of the extension
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control	1..1
Type	uri
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
Requirements	The fixed value for this attribute is 'https://fhir.athena.io/StructureDefinition/ah-estimated-gestational-age'
Fixed Value	`https://fhir.athena.io/StructureDefinition/ah-estimated-gestational-age`
6. Extension.value[x]
Definition	Estimated gestational age (EGA) of a pregnancy in weeks and days Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short	Estimated gestational age (EGA) of a pregnancyValue of extension
Control	10..1
Type	Quantity, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] Note	See Choice of Data Types for further information about how to use [x]
Is Modifier	false
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. Extension.value[x].value
Definition	The value of the measured amount. The value includes an implicit precision in the presentation of the value.
Short	Numerical value (with implicit precision)
Comments	The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).
Control	10..1
Type	decimal
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Summary	true
Requirements	Precision is handled implicitly in almost all cases of measurement.
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. Extension.value[x].comparator
Definition	How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.
Short	< \| <= \| >= \| > - how to understand the value
Control	0..01
Binding	The codes SHALL be taken from QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator\|4.0.1 (required to `http://hl7.org/fhir/ValueSet/quantity-comparator\|4.0.1`
Type	code
Is Modifier	true because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Summary	true
Requirements	Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.
Meaning if Missing	If there is no comparator, then there is no modification of the value
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. Extension.value[x].unit
Definition	A human-readable form of the unit.
Short	Unit representation
Control	10..1
Type	string
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Summary	true
Requirements	There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.
Pattern Value	`weeks.days`
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. Extension.value[x].system
Definition	The identification of the system that provides the coded form of the unit.
Short	System that defines coded unit form
Control	0..01 This element is affected by the following invariants: qty-3
Type	uri
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Summary	true
Requirements	Need to know the system that defines the coded form of the unit.
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. Extension.value[x].code
Definition	A computer processable form of the unit in some unit representation system.
Short	Coded form of the unit
Comments	The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.
Control	0..01
Type	code
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Summary	true
Requirements	Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be found here

0. Extension
Definition	An Extension to Observation for the estimated gestational age (EGA) of a pregnancy.
Short	athenahealth Estimated Gestational Age
Control	0..* This element is affected by the following invariants: ele-1
Is Modifier	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
2. Extension.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short	Unique id for inter-element referencing
Control	0..1
Type	string
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
4. Extension.extension
Definition	An Extension
Short	Extension
Control	0..0
Type	Extension
Is Modifier	false
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing	This element introduces a set of slices on `Extension.extension`. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
6. Extension.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Short	identifies the meaning of the extension
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control	1..1
Type	uri
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
Requirements	The fixed value for this attribute is 'https://fhir.athena.io/StructureDefinition/ah-estimated-gestational-age'
Fixed Value	`https://fhir.athena.io/StructureDefinition/ah-estimated-gestational-age`
8. Extension.value[x]
Definition	Estimated gestational age (EGA) of a pregnancy in weeks and days
Short	Estimated gestational age (EGA) of a pregnancy
Control	1..1
Type	Quantity
[x] Note	See Choice of Data Types for further information about how to use [x]
Is Modifier	false
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
10. Extension.value[x].id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short	Unique id for inter-element referencing
Control	0..1
Type	string
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
12. Extension.value[x].extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short	Additional content defined by implementations
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control	0..*
Type	Extension
Is Modifier	false
Summary	false
Alternate Names	extensions, user content
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing	This element introduces a set of slices on `Extension.value[x].extension`. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
14. Extension.value[x].value
Definition	The value of the measured amount. The value includes an implicit precision in the presentation of the value.
Short	Numerical value (with implicit precision)
Comments	The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).
Control	1..1
Type	decimal
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Summary	true
Requirements	Precision is handled implicitly in almost all cases of measurement.
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
16. Extension.value[x].comparator
Definition	How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.
Short	< \| <= \| >= \| > - how to understand the value
Control	0..0
Binding	The codes SHALL be taken from QuantityComparator (required to `http://hl7.org/fhir/ValueSet/quantity-comparator\|4.0.1`
Type	code
Is Modifier	true because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Summary	true
Requirements	Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.
Meaning if Missing	If there is no comparator, then there is no modification of the value
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
18. Extension.value[x].unit
Definition	A human-readable form of the unit.
Short	Unit representation
Control	1..1
Type	string
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Summary	true
Requirements	There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.
Pattern Value	`weeks.days`
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
20. Extension.value[x].system
Definition	The identification of the system that provides the coded form of the unit.
Short	System that defines coded unit form
Control	0..0 This element is affected by the following invariants: qty-3
Type	uri
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Summary	true
Requirements	Need to know the system that defines the coded form of the unit.
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
22. Extension.value[x].code
Definition	A computer processable form of the unit in some unit representation system.
Short	Coded form of the unit
Comments	The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.
Control	0..0
Type	code
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Summary	true
Requirements	Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)

IG © 2021+ athenahealth. Package ig-athena-core-ext#2.33.0 based on FHIR 4.0.1. Generated 2024-04-12
Links: Table of Contents | QA Report