HL7 FHIR Implementation Guide: minimal Common Oncology Data Elements (mCODE) Release 1 - US Realm | STU Ballot 1

This page is part of the HL7 FHIR Implementation Guide: minimal Common Oncology Data Elements (mCODE) Release 1 - US Realm | STU1 (v0.9.1: STU 1 Ballot 1) based on FHIR R4. The current version which supercedes this version is 2.0.0. For a full list of available versions, see the Directory of published versions

ReferenceRange

Definitions for obf-ReferenceRange-extension.

1. Extension
Definition

The usual or acceptable range for a test result.

Control0..* This element is affected by the following invariants: ele-1
InvariantsDefined on this element
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.

Control0..1
Typestring
3. Extension.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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

4. Extension.extension:lowerbound
Definition

The lower limit on a range

Control0..1
TypeExtension(LowerBound) (Extension Type: Quantity(SimpleQuantity))
5. Extension.extension:upperbound
Definition

The upper limit on a quantitative value.

Control0..1
TypeExtension(UpperBound) (Extension Type: Quantity(SimpleQuantity))
6. Extension.extension:type
Definition

A code describing the item at a greater level of detail.

Control0..1
TypeExtension(Type) (Extension Type: CodeableConcept)
7. Extension.extension:type.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
8. Extension.extension:type.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.

Control0..0
TypeExtension
Alternate Namesextensions, user content
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.

9. Extension.extension:type.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
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.

Fixed Valuehttp://hl7.org/fhir/us/mcode/StructureDefinition/obf-datatype-Type-extension
10. Extension.extension:type.valueCodeableConcept
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control1..1
BindingThe codes SHALL be taken from ObservationReferenceRangeMeaningCodes; other codes may be used where these codes are not suitable
TypeCodeableConcept
11. Extension.extension:applicablesubpopulation
Definition

Codes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race.

Control0..1
TypeExtension(ApplicableSubpopulation) (Extension Type: CodeableConcept)
12. Extension.extension:applicableagerange
Definition

The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so.

Control0..1
TypeExtension(ApplicableAgeRange) (Extension Type: Range)
13. Extension.extension:text
Definition

A simple string.

Control0..1
TypeExtension(Text) (Extension Type: string)
14. Extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
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.

Fixed Valuehttp://hl7.org/fhir/us/mcode/StructureDefinition/obf-ReferenceRange-extension
15. Extension.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..0
TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage
[x] NoteSee Choice of Data Types for further information about how to use [x]