Pharmaceutical Quality (Industry), published by HL7 International / Biomedical Research and Regulation. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/uv-dx-pq/ and changes regularly. See the Directory of published versions
Active as of 2024-05-08 |
Definitions for the ObservationDefinition-test-method-drug-pq resource profile.
Guidance on how to interpret the contents of this table can be found here
0. ObservationDefinition | |
2. ObservationDefinition.title | |
4. ObservationDefinition.title.extension | |
Slicing | This element introduces a set of slices on ObservationDefinition.title.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
6. ObservationDefinition.title.extension:test-comment-title | |
Slice Name | test-comment-title |
Short | test-comment-title |
Control | 0..1 |
Type | Extension(Extension - Test Comment PQ) (Extension Type: string) |
Must Support | true |
8. ObservationDefinition.code | |
Binding | For example codes, see Test Method (example to http://hl7.org/fhir/uv/pharm-quality/ValueSet/vs-test-method-pq ) |
Must Support | true |
10. ObservationDefinition.method | |
Must Support | true |
12. ObservationDefinition.specimen | |
Must Support | true |
14. ObservationDefinition.device | |
Type | Reference(DeviceDefinition, Device) |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
16. ObservationDefinition.qualifiedValue | |
Must Support | true |
18. ObservationDefinition.qualifiedValue.extension | |
Slicing | This element introduces a set of slices on ObservationDefinition.qualifiedValue.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
20. ObservationDefinition.qualifiedValue.extension:qualified-value-text | |
Slice Name | qualified-value-text |
Short | qualified-value-text |
Type | Extension(Extension - Qualified Value Text PQ) (Extension Type: string) |
Must Support | true |
22. ObservationDefinition.qualifiedValue.extension:qualified-value-display | |
Slice Name | qualified-value-display |
Short | qualified-value-display |
Type | Extension(Extension - Qualified Value Display PQ) (Extension Type: string) |
Must Support | true |
24. ObservationDefinition.qualifiedValue.extension:qualified-value-target | |
Slice Name | qualified-value-target |
Short | qualified-value-target |
Type | Extension(Extension - Qualified Value Target PQ) (Extension Type: Quantity) |
Must Support | true |
26. ObservationDefinition.qualifiedValue.extension:qualified-value-criticality | |
Slice Name | qualified-value-criticality |
Short | qualified-value-criticality |
Type | Extension(Extension - Qualified Value Criticality PQ) (Extension Type: CodeableConcept) |
Must Support | true |
28. ObservationDefinition.qualifiedValue.appliesTo | |
30. ObservationDefinition.qualifiedValue.appliesTo.extension | |
Slicing | This element introduces a set of slices on ObservationDefinition.qualifiedValue.appliesTo.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
32. ObservationDefinition.qualifiedValue.appliesTo.extension:test-comment | |
Slice Name | test-comment |
Short | test-comment |
Control | 0..1 |
Type | Extension(Extension - Test Comment PQ) (Extension Type: string) |
Must Support | true |
34. ObservationDefinition.qualifiedValue.range | |
Must Support | true |
36. ObservationDefinition.qualifiedValue.range.extension | |
Slicing | This element introduces a set of slices on ObservationDefinition.qualifiedValue.range.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
38. ObservationDefinition.qualifiedValue.range.extension:qualified-value-target | |
Slice Name | qualified-value-target |
Short | qualified-value-target |
Control | 0..1 |
Type | Extension(Extension - Qualified Value Target PQ) (Extension Type: Quantity) |
Must Support | true |
40. ObservationDefinition.hasMember | |
Must Support | true |
Guidance on how to interpret the contents of this table can be found here
0. ObservationDefinition | |
Definition | Set of definitional characteristics for a kind of observation or measurement produced or consumed by an orderable health care service. |
Short | Definition of an observation |
Comments | An instance of this resource informs the consumer of a health-related service (such as a lab diagnostic test or panel) about how the observations used or produced by this service will look like. |
Control | 0..* |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')) obd-0: If permittedUnit exists, then permittedDataType=Quantity must exist. (permittedUnit.exists() implies (permittedDataType = 'Quantity').exists()) |
2. ObservationDefinition.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Short | A set of rules under which this content was created |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc. |
Control | 0..1 |
Type | uri |
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
4. ObservationDefinition.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. |
Short | Contained, inline Resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels. |
Control | 0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5 |
Type | Resource |
Is Modifier | false |
Must Support | false |
Summary | false |
Alternate Names | inline resources, anonymous resources, contained resources |
6. ObservationDefinition.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored |
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 | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them |
Must Support | false |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
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()) |
8. ObservationDefinition.title | |
Definition | A short, descriptive, user-friendly title for the ObservationDefinition. |
Short | Name for this ObservationDefinition (human friendly) |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
10. ObservationDefinition.title.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 managable, 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..* |
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 ObservationDefinition.title.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
12. ObservationDefinition.title.extension:test-comment-title | |
Slice Name | test-comment-title |
Definition | An Extension |
Short | test-comment-title |
Control | 0..1 |
Type | Extension(Extension - Test Comment PQ) (Extension Type: string) |
Is Modifier | false |
Must Support | true |
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()) |
14. ObservationDefinition.status | |
Definition | The current state of the ObservationDefinition. |
Short | draft | active | retired | unknown |
Comments | A nominal state-transition diagram can be found in the Definition pattern documentation Unknown does not represent "other" - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is. See guidance around (not) making local changes to elements here. |
Control | 1..1 |
Binding | The codes SHALL be taken from PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|5.0.0 (required to http://hl7.org/fhir/ValueSet/publication-status|5.0.0 )Codes identifying the state of an ObservationDefinition. |
Type | code |
Is Modifier | true because Not known why this is labelled a modifier |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
16. ObservationDefinition.code | |
Definition | Describes what will be observed. Sometimes this is called the observation "name". |
Short | Type of observation |
Control | 1..1 |
Binding | For example codes, see Test Methodhttp://hl7.org/fhir/ValueSet/observation-codes (example to http://hl7.org/fhir/uv/pharm-quality/ValueSet/vs-test-method-pq ) |
Type | CodeableConcept |
Is Modifier | false |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
18. ObservationDefinition.method | |
Definition | The method or technique used to perform the observation. |
Short | Method used to produce the observation |
Comments | Only used if not implicit in observation code Example: 702659008 |Automated count technique|. |
Control | 0..1 |
Binding | For example codes, see ObservationMethodshttp://hl7.org/fhir/ValueSet/observation-methods (example to http://hl7.org/fhir/ValueSet/observation-methods )Methods for simple observations. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | true |
Summary | false |
Requirements | In some cases, method can impact results. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
20. ObservationDefinition.specimen | |
Definition | The kind of specimen that this type of observation is produced on. |
Short | Kind of specimen used by this type of observation |
Comments | Only used for in vitro observations. When multiple occurrences of specimen are present, they are to be combined with a logical AND: all specified specimens are needed for the observation. |
Control | 0..* |
Type | Reference(SpecimenDefinition) |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
22. ObservationDefinition.device | |
Definition | The measurement model of device or actual device used to produce observations of this type. |
Short | Measurement device or model of device |
Comments | When multiple occurrences of device are present, they are to be combined with a logical OR: at least one of the specified devices is used to produce the observation. |
Control | 0..* |
Type | Reference(DeviceDefinition, Device) |
Is Modifier | false |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
24. ObservationDefinition.qualifiedValue | |
Definition | A set of qualified values associated with a context and a set of conditions - provides a range for quantitative and ordinal observations and a collection of value sets for qualitative observations. |
Short | Set of qualified values for observation results |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
26. ObservationDefinition.qualifiedValue.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 managable, 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..* |
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 ObservationDefinition.qualifiedValue.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
28. ObservationDefinition.qualifiedValue.extension:qualified-value-text | |
Slice Name | qualified-value-text |
Definition | An Extension |
Short | qualified-value-text |
Control | 0..* |
Type | Extension(Extension - Qualified Value Text PQ) (Extension Type: string) |
Is Modifier | false |
Must Support | true |
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()) |
30. ObservationDefinition.qualifiedValue.extension:qualified-value-display | |
Slice Name | qualified-value-display |
Definition | An Extension |
Short | qualified-value-display |
Control | 0..* |
Type | Extension(Extension - Qualified Value Display PQ) (Extension Type: string) |
Is Modifier | false |
Must Support | true |
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()) |
32. ObservationDefinition.qualifiedValue.extension:qualified-value-target | |
Slice Name | qualified-value-target |
Definition | An Extension |
Short | qualified-value-target |
Control | 0..* |
Type | Extension(Extension - Qualified Value Target PQ) (Extension Type: Quantity) |
Is Modifier | false |
Must Support | true |
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()) |
34. ObservationDefinition.qualifiedValue.extension:qualified-value-criticality | |
Slice Name | qualified-value-criticality |
Definition | An Extension |
Short | qualified-value-criticality |
Control | 0..* |
Type | Extension(Extension - Qualified Value Criticality PQ) (Extension Type: CodeableConcept) |
Is Modifier | false |
Must Support | true |
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()) |
36. ObservationDefinition.qualifiedValue.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
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 | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
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()) |
38. ObservationDefinition.qualifiedValue.appliesTo | |
Definition | The target population this set of qualified values applies to. |
Short | Targetted population for the set of qualified values |
Comments | If this element is not present then the global population is assumed. |
Control | 0..* |
Binding | For example codes, see ObservationReferenceRangeAppliesToCodeshttp://hl7.org/fhir/ValueSet/referencerange-appliesto (example to http://hl7.org/fhir/ValueSet/referencerange-appliesto ) |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
40. ObservationDefinition.qualifiedValue.appliesTo.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 managable, 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..* |
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 ObservationDefinition.qualifiedValue.appliesTo.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
42. ObservationDefinition.qualifiedValue.appliesTo.extension:test-comment | |
Slice Name | test-comment |
Definition | An Extension |
Short | test-comment |
Control | 0..1 |
Type | Extension(Extension - Test Comment PQ) (Extension Type: string) |
Is Modifier | false |
Must Support | true |
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()) |
44. ObservationDefinition.qualifiedValue.range | |
Definition | The range of values defined for continuous or ordinal observations that match the criteria of this set of qualified values. |
Short | The range for continuous or ordinal observations |
Control | 0..1 |
Type | Range |
Is Modifier | false |
Must Support | true |
Summary | false |
Requirements | The unit may be not relevant for ordinal values. In case it is there, it is the same as ObservationDefinition.unit. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
46. ObservationDefinition.qualifiedValue.range.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 managable, 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..* |
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 ObservationDefinition.qualifiedValue.range.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
48. ObservationDefinition.qualifiedValue.range.extension:qualified-value-target | |
Slice Name | qualified-value-target |
Definition | An Extension |
Short | qualified-value-target |
Control | 0..1 |
Type | Extension(Extension - Qualified Value Target PQ) (Extension Type: Quantity) |
Is Modifier | false |
Must Support | true |
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()) |
50. ObservationDefinition.hasMember | |
Definition | This ObservationDefinition defines a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group. |
Short | Definitions of related resources belonging to this kind of observation group |
Control | 0..* |
Type | Reference(ObservationDefinition, Questionnaire) |
Is Modifier | false |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
Summary | false |
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. ObservationDefinition | |
Definition | Set of definitional characteristics for a kind of observation or measurement produced or consumed by an orderable health care service. |
Short | Definition of an observation |
Comments | An instance of this resource informs the consumer of a health-related service (such as a lab diagnostic test or panel) about how the observations used or produced by this service will look like. |
Control | 0..* |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$') )obd-0: If permittedUnit exists, then permittedDataType=Quantity must exist. ( permittedUnit.exists() implies (permittedDataType = 'Quantity').exists() ) |
2. ObservationDefinition.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Short | Logical id of this artifact |
Comments | Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case. |
Control | 0..1 |
Type | id |
Is Modifier | false |
Must Support | false |
Summary | true |
4. ObservationDefinition.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
Short | Metadata about the resource |
Control | 0..1 |
Type | Meta |
Is Modifier | false |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
6. ObservationDefinition.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Short | A set of rules under which this content was created |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc. |
Control | 0..1 |
Type | uri |
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
8. ObservationDefinition.language | |
Definition | The base language in which the resource is written. |
Short | Language of the resource content |
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
Control | 0..1 |
Binding | The codes SHALL be taken from AllLanguages (required to http://hl7.org/fhir/ValueSet/all-languages|5.0.0 )IETF language tag for a human language |
Type | code |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
10. ObservationDefinition.text | |
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Short | Text summary of the resource, for human interpretation |
Comments | Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
Control | 0..1 This element is affected by the following invariants: dom-6 |
Type | Narrative |
Is Modifier | false |
Must Support | false |
Summary | false |
Alternate Names | narrative, html, xhtml, display |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
12. ObservationDefinition.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. |
Short | Contained, inline Resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels. |
Control | 0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5 |
Type | Resource |
Is Modifier | false |
Must Support | false |
Summary | false |
Alternate Names | inline resources, anonymous resources, contained resources |
14. ObservationDefinition.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, 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 |
Must Support | 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() ) |
16. ObservationDefinition.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored |
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 | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them |
Must Support | false |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
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() ) |
18. ObservationDefinition.url | |
Definition | An absolute URL that is used to identify this ObservationDefinition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this ObservationDefinition is (or will be) published. The URL SHOULD include the major version of the ObservationDefinition. For more information see Technical and Business Versions. |
Short | Logical canonical URL to reference this ObservationDefinition (globally unique) |
Comments | Can be a urn:uuid: or a urn:oid:, but real http: addresses are preferred. This is the URI that will be used when making canonical references to this resource. |
Control | 0..1 |
Type | uri |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Requirements | Allows the ObservationDefinition to be referenced by a single globally unique identifier. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
20. ObservationDefinition.identifier | |
Definition | Business identifiers assigned to this ObservationDefinition. by the performer and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server. |
Short | Business identifier of the ObservationDefinition |
Comments | This is a business identifier, not a resource identifier. It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..1 |
Type | Identifier |
Is Modifier | false |
Must Support | false |
Summary | true |
Requirements | Allows identification of the ObservationDefinition as it is known by various participating systems and in a way that remains consistent across servers. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
22. ObservationDefinition.version | |
Definition | The identifier that is used to identify this version of the ObservationDefinition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the ObservationDefinition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions are orderable. |
Short | Business version of the ObservationDefinition |
Comments | There may be multiple different instances of an observationDefinition that have the same identifier but different versions. |
Note | This is a business versionId, not a resource version id (see discussion) |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
24. ObservationDefinition.versionAlgorithm[x] | |
Definition | Indicates the mechanism used to compare versions to determine which is more current. |
Short | How to compare versions |
Comments | If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. |
Control | 0..1 |
Binding | Unless not suitable, these codes SHALL be taken from VersionAlgorithm (extensible to http://hl7.org/fhir/ValueSet/version-algorithm ) |
Type | Choice of: string, Coding |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
26. ObservationDefinition.name | |
Definition | A natural language name identifying the ObservationDefinition. This name should be usable as an identifier for the module by machine processing applications such as code generation. |
Short | Name for this ObservationDefinition (computer friendly) |
Comments | The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly. |
Control | 0..1 This element is affected by the following invariants: cnl-0 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Requirements | Support human navigation and code generation. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
28. ObservationDefinition.title | |
Definition | A short, descriptive, user-friendly title for the ObservationDefinition. |
Short | Name for this ObservationDefinition (human friendly) |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
30. ObservationDefinition.title.id | |
Definition | unique id for the element within a resource (for internal references) |
Short | xml:id (or equivalent in JSON) |
Control | 0..1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
32. ObservationDefinition.title.extension | |
Definition | An Extension |
Short | Extension |
Control | 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 ObservationDefinition.title.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
34. ObservationDefinition.title.extension:test-comment-title | |
Slice Name | test-comment-title |
Definition | An Extension |
Short | test-comment-title |
Control | 0..1 |
Type | Extension(Extension - Test Comment PQ) (Extension Type: string) |
Is Modifier | false |
Must Support | true |
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() ) |
36. ObservationDefinition.title.value | |
Definition | The actual value |
Short | Primitive value for string |
Control | 0..1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
Max Length | 1048576 |
38. ObservationDefinition.status | |
Definition | The current state of the ObservationDefinition. |
Short | draft | active | retired | unknown |
Comments | A nominal state-transition diagram can be found in the Definition pattern documentation Unknown does not represent "other" - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is. See guidance around (not) making local changes to elements here. |
Control | 1..1 |
Binding | The codes SHALL be taken from PublicationStatus (required to http://hl7.org/fhir/ValueSet/publication-status|5.0.0 )Codes identifying the state of an ObservationDefinition. |
Type | code |
Is Modifier | true because Not known why this is labelled a modifier |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
40. ObservationDefinition.experimental | |
Definition | A flag to indicate that this ObservationDefinition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage. |
Short | If for testing purposes, not real usage |
Comments | Allows filtering of ObservationDefinition that are appropriate for use vs. not. |
Control | 0..1 |
Type | boolean |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Meaning if Missing | If absent, this resource is treated as though it is not experimental. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
42. ObservationDefinition.date | |
Definition | The date (and optionally time) when the ObservationDefinition was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the ObservationDefinition changes. |
Short | Date last changed |
Comments | The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the ObservationDefinition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource. See guidance around (not) making local changes to elements here. |
Control | 0..1 |
Type | dateTime |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Alternate Names | revision date |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
44. ObservationDefinition.publisher | |
Definition | Helps establish the "authority/credibility" of the ObservationDefinition. May also allow for contact. |
Short | The name of the individual or organization that published the ObservationDefinition |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Requirements | Usually an organization, but may be an individual. The publisher (or steward) of the ObservationDefinition is the organization or individual primarily responsible for the maintenance and upkeep of the ObservationDefinition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the ObservationDefinition. This item SHOULD be populated unless the information is available from context. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
46. ObservationDefinition.contact | |
Definition | Contact details to assist a user in finding and communicating with the publisher. |
Short | Contact details for the publisher |
Comments | May be a web site, an email address, a telephone number, etc. See guidance around (not) making local changes to elements here. |
Control | 0..* |
Type | ContactDetail |
Is Modifier | false |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
48. ObservationDefinition.description | |
Definition | A free text natural language description of the ObservationDefinition from the consumer's perspective. |
Short | Natural language description of the ObservationDefinition |
Comments | This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the module as conveyed in the text field of the resource itself. This item SHOULD be populated unless the information is available from context. |
Control | 0..1 |
Type | markdown |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
50. ObservationDefinition.useContext | |
Definition | The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate ObservationDefinition instances. |
Short | Content intends to support these contexts |
Comments | When multiple usageContexts are specified, there is no expectation for whether all or any of the contexts apply. |
Control | 0..* |
Type | UsageContext |
Is Modifier | false |
Must Support | false |
Summary | true |
Requirements | Assist in searching for appropriate content. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
52. ObservationDefinition.jurisdiction | |
Definition | A jurisdiction in which the ObservationDefinition is intended to be used. |
Short | Intended jurisdiction for this ObservationDefinition (if applicable) |
Comments | It may be possible for the ObservationDefinition to be used in jurisdictions other than those for which it was originally designed or intended. DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) |
Control | 0..* |
Binding | Unless not suitable, these codes SHALL be taken from JurisdictionValueSet (extensible to http://hl7.org/fhir/ValueSet/jurisdiction )Codes for country, country subdivision and region for indicating where a resource is intended to be used. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
54. ObservationDefinition.purpose | |
Definition | Explains why this ObservationDefinition is needed and why it has been designed as it has. |
Short | Why this ObservationDefinition is defined |
Comments | This element does not describe the usage of the ObservationDefinition. Rather it is for traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this ObservationDefinition. |
Control | 0..1 |
Type | markdown |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
56. ObservationDefinition.copyright | |
Definition | Copyright statement relating to the ObservationDefinition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the ObservationDefinition. |
Short | Use and/or publishing restrictions |
Control | 0..1 |
Type | markdown |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | false |
Requirements | Consumers of the ObservationDefinition must be able to determine any legal restrictions on the use of the artifact and/or its content. |
Alternate Names | License, Restrictions |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
58. ObservationDefinition.copyrightLabel | |
Definition | A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). |
Short | Copyright holder and year(s) |
Comments | The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element. |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | false |
Requirements | Defines the content expected to be rendered in all representations of the artifact. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
60. ObservationDefinition.approvalDate | |
Definition | The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage. |
Short | When ObservationDefinition was approved by publisher |
Comments | The date may be more recent than the approval date because of minor changes / editorial corrections. See guidance around (not) making local changes to elements here. |
Control | 0..1 |
Type | date |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
62. ObservationDefinition.lastReviewDate | |
Definition | The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date. |
Short | Date on which the asset content was last reviewed by the publisher |
Comments | If specified, this is usually after the approval date. See guidance around (not) making local changes to elements here. |
Control | 0..1 |
Type | date |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
64. ObservationDefinition.effectivePeriod | |
Definition | The period during which the ObservationDefinition content was or is planned to be effective. |
Short | The effective date range for the ObservationDefinition |
Comments | The effective period for an ObservationDefinition determines when the content is applicable for usage and is independent of publication and review dates. For example, an observation definition intended to be used for the year 2021 might be published in 2020. See guidance around (not) making local changes to elements here. |
Control | 0..1 |
Type | Period |
Is Modifier | false |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
66. ObservationDefinition.derivedFromCanonical | |
Definition | The canonical URL pointing to another FHIR-defined ObservationDefinition that is adhered to in whole or in part by this definition. |
Short | Based on FHIR definition of another observation |
Control | 0..* |
Type | canonical(ObservationDefinition) |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
68. ObservationDefinition.derivedFromUri | |
Definition | The URL pointing to an externally-defined observation definition, guideline or other definition that is adhered to in whole or in part by this definition. |
Short | Based on external definition |
Control | 0..* |
Type | uri |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Requirements | Observation definitions may be refinements of other definitions. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
70. ObservationDefinition.subject | |
Definition | A code that describes the intended kind of subject of Observation instances conforming to this ObservationDefinition. |
Short | Type of subject for the defined observation |
Comments | Examples: person, animal, device, air, surface …. |
Control | 0..* |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
72. ObservationDefinition.performerType | |
Definition | The type of individual/organization/device that is expected to act upon instances of this definition. |
Short | Desired kind of performer for such kind of observation |
Control | 0..1 |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
74. ObservationDefinition.category | |
Definition | A code that classifies the general type of observation. |
Short | General type of observation |
Comments | This element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used for one instance of ObservationDefinition. The level of granularity is defined by the category concepts in the value set. |
Control | 0..* |
Binding | For example codes, see ObservationCategoryCodes (example to http://hl7.org/fhir/ValueSet/observation-category )Codes for high level observation categories. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | true |
Requirements | Used for filtering what kinds of observations are retrieved and displayed. |
Alternate Names | Class of observation |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
76. ObservationDefinition.code | |
Definition | Describes what will be observed. Sometimes this is called the observation "name". |
Short | Type of observation |
Control | 1..1 |
Binding | For example codes, see Test Method (example to http://hl7.org/fhir/uv/pharm-quality/ValueSet/vs-test-method-pq ) |
Type | CodeableConcept |
Is Modifier | false |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
78. ObservationDefinition.permittedDataType | |
Definition | The data types allowed for the value element of the instance observations conforming to this ObservationDefinition. |
Short | Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period |
Control | 0..* This element is affected by the following invariants: obd-0 |
Binding | The codes SHALL be taken from ObservationDataType (required to http://hl7.org/fhir/ValueSet/permitted-data-type|5.0.0 )Permitted data type for observation value. |
Type | code |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | false |
Example | <br/><b>General</b>:CodeableConcept |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
80. ObservationDefinition.multipleResultsAllowed | |
Definition | Multiple results allowed for observations conforming to this ObservationDefinition. |
Short | Multiple results allowed for conforming observations |
Comments | An example of observation allowing multiple results is "bacteria identified by culture". Conversely, the measurement of a potassium level allows a single result. |
Control | 0..1 |
Type | boolean |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | false |
Example | <br/><b>General</b>:true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
82. ObservationDefinition.bodySite | |
Definition | The site on the subject's body where the observation is to be made. |
Short | Body part to be observed |
Comments | Only used if the defined observation is to be made directly on a body part and if this body part is not implied by code found in ObservationDefinition.code. Not used for in vitro diagnostic observations. Example: 14975008 |Forearm structure|. |
Control | 0..1 |
Binding | For example codes, see SNOMEDCTBodyStructures (example to http://hl7.org/fhir/ValueSet/body-site )SNOMED CT body structures. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
84. ObservationDefinition.method | |
Definition | The method or technique used to perform the observation. |
Short | Method used to produce the observation |
Comments | Only used if not implicit in observation code Example: 702659008 |Automated count technique|. |
Control | 0..1 |
Binding | For example codes, see ObservationMethods (example to http://hl7.org/fhir/ValueSet/observation-methods )Methods for simple observations. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | true |
Summary | false |
Requirements | In some cases, method can impact results. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
86. ObservationDefinition.specimen | |
Definition | The kind of specimen that this type of observation is produced on. |
Short | Kind of specimen used by this type of observation |
Comments | Only used for in vitro observations. When multiple occurrences of specimen are present, they are to be combined with a logical AND: all specified specimens are needed for the observation. |
Control | 0..* |
Type | Reference(SpecimenDefinition) |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
88. ObservationDefinition.device | |
Definition | The measurement model of device or actual device used to produce observations of this type. |
Short | Measurement device or model of device |
Comments | When multiple occurrences of device are present, they are to be combined with a logical OR: at least one of the specified devices is used to produce the observation. |
Control | 0..* |
Type | Reference(DeviceDefinition, Device) |
Is Modifier | false |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
90. ObservationDefinition.preferredReportName | |
Definition | The preferred name to be used when reporting the results of observations conforming to this ObservationDefinition. |
Short | The preferred name to be used when reporting the observation results |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
92. ObservationDefinition.permittedUnit | |
Definition | Units allowed for the valueQuantity element in the instance observations conforming to this ObservationDefinition. |
Short | Unit for quantitative results |
Control | 0..* This element is affected by the following invariants: obd-0 |
Binding | The codes SHOULD be taken from UCUMCodes (preferred to http://hl7.org/fhir/ValueSet/ucum-units )Codes identifying units of measure. |
Type | Coding |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
94. ObservationDefinition.qualifiedValue | |
Definition | A set of qualified values associated with a context and a set of conditions - provides a range for quantitative and ordinal observations and a collection of value sets for qualitative observations. |
Short | Set of qualified values for observation results |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
96. ObservationDefinition.qualifiedValue.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 This element is affected by the following invariants: ele-1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
98. ObservationDefinition.qualifiedValue.extension | |
Definition | An Extension |
Short | Extension |
Control | 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 ObservationDefinition.qualifiedValue.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
100. ObservationDefinition.qualifiedValue.extension:qualified-value-text | |
Slice Name | qualified-value-text |
Definition | An Extension |
Short | qualified-value-text |
Control | 0..* |
Type | Extension(Extension - Qualified Value Text PQ) (Extension Type: string) |
Is Modifier | false |
Must Support | true |
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() ) |
102. ObservationDefinition.qualifiedValue.extension:qualified-value-display | |
Slice Name | qualified-value-display |
Definition | An Extension |
Short | qualified-value-display |
Control | 0..* |
Type | Extension(Extension - Qualified Value Display PQ) (Extension Type: string) |
Is Modifier | false |
Must Support | true |
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() ) |
104. ObservationDefinition.qualifiedValue.extension:qualified-value-target | |
Slice Name | qualified-value-target |
Definition | An Extension |
Short | qualified-value-target |
Control | 0..* |
Type | Extension(Extension - Qualified Value Target PQ) (Extension Type: Quantity) |
Is Modifier | false |
Must Support | true |
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() ) |
106. ObservationDefinition.qualifiedValue.extension:qualified-value-criticality | |
Slice Name | qualified-value-criticality |
Definition | An Extension |
Short | qualified-value-criticality |
Control | 0..* |
Type | Extension(Extension - Qualified Value Criticality PQ) (Extension Type: CodeableConcept) |
Is Modifier | false |
Must Support | true |
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() ) |
108. ObservationDefinition.qualifiedValue.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
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 | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
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() ) |
110. ObservationDefinition.qualifiedValue.context | |
Definition | A concept defining the context for this set of qualified values. |
Short | Context qualifier for the set of qualified values |
Control | 0..1 |
Binding | Unless not suitable, these codes SHALL be taken from ObservationReferenceRangeMeaningCodes (extensible to http://hl7.org/fhir/ValueSet/referencerange-meaning ) |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
112. ObservationDefinition.qualifiedValue.appliesTo | |
Definition | The target population this set of qualified values applies to. |
Short | Targetted population for the set of qualified values |
Comments | If this element is not present then the global population is assumed. |
Control | 0..* |
Binding | For example codes, see ObservationReferenceRangeAppliesToCodes (example to http://hl7.org/fhir/ValueSet/referencerange-appliesto ) |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
114. ObservationDefinition.qualifiedValue.appliesTo.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 This element is affected by the following invariants: ele-1 |
Type | id |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
116. ObservationDefinition.qualifiedValue.appliesTo.extension | |
Definition | An Extension |
Short | Extension |
Control | 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 ObservationDefinition.qualifiedValue.appliesTo.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
118. ObservationDefinition.qualifiedValue.appliesTo.extension:test-comment | |
Slice Name | test-comment |
Definition | An Extension |
Short | test-comment |
Control | 0..1 |
Type | Extension(Extension - Test Comment PQ) (Extension Type: string) |
Is Modifier | false |
Must Support | true |
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() ) |
120. ObservationDefinition.qualifiedValue.appliesTo.coding | |
Definition | A reference to a code defined by a terminology system. |
Short | Code defined by a terminology system |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
Control | 0..* |
Type | Coding |
Is Modifier | false |
Summary | true |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
122. ObservationDefinition.qualifiedValue.appliesTo.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Short | Plain text representation of the concept |
Comments | Very often the text is the same as a displayName of one of the codings. |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
124. ObservationDefinition.qualifiedValue.gender | |
Definition | The gender this set of qualified values applies to. |
Short | male | female | other | unknown |
Control | 0..1 |
Binding | The codes SHALL be taken from AdministrativeGender (required to http://hl7.org/fhir/ValueSet/administrative-gender|5.0.0 ) |
Type | code |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | false |
Example | <br/><b>General</b>:female |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
126. ObservationDefinition.qualifiedValue.age | |
Definition | The age range this set of qualified values applies to. |
Short | Applicable age range for the set of qualified values |
Comments | Some analytes vary greatly over age. |
Control | 0..1 |
Type | Range |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
128. ObservationDefinition.qualifiedValue.gestationalAge | |
Definition | The gestational age this set of qualified values applies to. |
Short | Applicable gestational age range for the set of qualified values |
Control | 0..1 |
Type | Range |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
130. ObservationDefinition.qualifiedValue.condition | |
Definition | Text based condition for which the the set of qualified values is valid. |
Short | Condition associated with the set of qualified values |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
132. ObservationDefinition.qualifiedValue.rangeCategory | |
Definition | The category of range of values for continuous or ordinal observations that match the criteria of this set of qualified values. |
Short | reference | critical | absolute |
Control | 0..1 |
Binding | The codes SHALL be taken from ObservationRangeCategory (required to http://hl7.org/fhir/ValueSet/observation-range-category|5.0.0 ) |
Type | code |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | false |
Example | <br/><b>General</b>:critical |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
134. ObservationDefinition.qualifiedValue.range | |
Definition | The range of values defined for continuous or ordinal observations that match the criteria of this set of qualified values. |
Short | The range for continuous or ordinal observations |
Control | 0..1 |
Type | Range |
Is Modifier | false |
Must Support | true |
Summary | false |
Requirements | The unit may be not relevant for ordinal values. In case it is there, it is the same as ObservationDefinition.unit. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
136. ObservationDefinition.qualifiedValue.range.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 This element is affected by the following invariants: ele-1 |
Type | id |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
138. ObservationDefinition.qualifiedValue.range.extension | |
Definition | An Extension |
Short | Extension |
Control | 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 ObservationDefinition.qualifiedValue.range.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
140. ObservationDefinition.qualifiedValue.range.extension:qualified-value-target | |
Slice Name | qualified-value-target |
Definition | An Extension |
Short | qualified-value-target |
Control | 0..1 |
Type | Extension(Extension - Qualified Value Target PQ) (Extension Type: Quantity) |
Is Modifier | false |
Must Support | true |
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() ) |
142. ObservationDefinition.qualifiedValue.range.low | |
Definition | The low limit. The boundary is inclusive. |
Short | Low limit |
Comments | If the low element is missing, the low boundary is not known. |
Control | 0..1 This element is affected by the following invariants: rng-2 |
Type | Quantity(SimpleQuantity) |
Is Modifier | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
144. ObservationDefinition.qualifiedValue.range.high | |
Definition | The high limit. The boundary is inclusive. |
Short | High limit |
Comments | If the high element is missing, the high boundary is not known. |
Control | 0..1 This element is affected by the following invariants: rng-2 |
Type | Quantity(SimpleQuantity) |
Is Modifier | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
146. ObservationDefinition.qualifiedValue.validCodedValueSet | |
Definition | The set of valid coded results for qualitative observations that match the criteria of this set of qualified values. |
Short | Value set of valid coded values as part of this set of qualified values |
Control | 0..1 |
Type | canonical(ValueSet) |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
148. ObservationDefinition.qualifiedValue.normalCodedValueSet | |
Definition | The set of normal coded results for qualitative observations that match the criteria of this set of qualified values. |
Short | Value set of normal coded values as part of this set of qualified values |
Control | 0..1 |
Type | canonical(ValueSet) |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
150. ObservationDefinition.qualifiedValue.abnormalCodedValueSet | |
Definition | The set of abnormal coded results for qualitative observations that match the criteria of this set of qualified values. |
Short | Value set of abnormal coded values as part of this set of qualified values |
Control | 0..1 |
Type | canonical(ValueSet) |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
152. ObservationDefinition.qualifiedValue.criticalCodedValueSet | |
Definition | The set of critical coded results for qualitative observations that match the criteria of this set of qualified values. |
Short | Value set of critical coded values as part of this set of qualified values |
Control | 0..1 |
Type | canonical(ValueSet) |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
154. ObservationDefinition.hasMember | |
Definition | This ObservationDefinition defines a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group. |
Short | Definitions of related resources belonging to this kind of observation group |
Control | 0..* |
Type | Reference(ObservationDefinition, Questionnaire) |
Is Modifier | false |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
156. ObservationDefinition.component | |
Definition | Some observations have multiple component observations, expressed as separate code value pairs. |
Short | Component results |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | false |
Summary | false |
Requirements | Component observations share the same attributes as the primary observation and are always treated as a part of it (they are not separable). |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )obd-1: If permittedUnit exists, then permittedDataType=Quantity must exist. ( permittedUnit.exists() implies (permittedDataType = 'Quantity').exists() ) |
158. ObservationDefinition.component.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 This element is affected by the following invariants: ele-1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
160. ObservationDefinition.component.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 managable, 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() ) |
162. ObservationDefinition.component.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
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 | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
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() ) |
164. ObservationDefinition.component.code | |
Definition | Describes what will be observed. |
Short | Type of observation |
Control | 1..1 |
Binding | For example codes, see LOINCCodes (example to http://hl7.org/fhir/ValueSet/observation-codes )Codes identifying names of simple observations. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
166. ObservationDefinition.component.permittedDataType | |
Definition | The data types allowed for the value element of the instance of this component observations. |
Short | Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period |
Control | 0..* This element is affected by the following invariants: obd-1 |
Binding | The codes SHALL be taken from ObservationDataType (required to http://hl7.org/fhir/ValueSet/permitted-data-type|5.0.0 )Permitted data type for observation value. |
Type | code |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | false |
Example | <br/><b>General</b>:CodeableConcept |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
168. ObservationDefinition.component.permittedUnit | |
Definition | Units allowed for the valueQuantity element in the instance observations conforming to this ObservationDefinition. |
Short | Unit for quantitative results |
Control | 0..* This element is affected by the following invariants: obd-1 |
Binding | The codes SHOULD be taken from UCUMCodes (preferred to http://hl7.org/fhir/ValueSet/ucum-units )Codes identifying units of measure. |
Type | Coding |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
170. ObservationDefinition.component.qualifiedValue | |
Definition | A set of qualified values associated with a context and a set of conditions - provides a range for quantitative and ordinal observations and a collection of value sets for qualitative observations. |
Short | Set of qualified values for observation results |
Control | 0..* |
Type | See ttp://hl7.org/fhir/StructureDefinition/ObservationDefinition#ObservationDefinition.qualifiedValue |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |