CH LAB-Report (R4)
0.1.1 - draft
This page is part of the CH LAB-Report (R4) (v0.1.1: DSTU 1 Draft) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
Active as of 2023-12-28 |
Definitions for the ch-lab-observation-ActivityDefinition resource profile.
Guidance on how to interpret the contents of this table can be found here
0. ObservationDefinition | |
2. ObservationDefinition.extension | |
Control | 2..? |
Slicing | This element introduces a set of slices on ObservationDefinition.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
4. ObservationDefinition.extension:ObservationDefinitionSpecimenR5 | |
Slice Name | ObservationDefinitionSpecimenR5 |
Definition | This extension implements the R5 specimen element. It allow to link this DiagnoticReport with the SpecimenDefinition R5 documenting this Laboratory Report. |
Short | Associated Lab Report SpecimenDefinitions |
Control | 1..1 |
Type | Extension(Extension Definition for ObservationDefinition.specimen for Version 5.0) (Extension Type: Reference(SpecimenDefinition)) |
6. ObservationDefinition.extension:ObservationDefinitionSpecimenR5.value[x] | |
Type | Reference(CH Lab SpecimenDefinition: Laboratory Report) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
8. ObservationDefinition.extension:ObservationDefinitionDeviceR5 | |
Slice Name | ObservationDefinitionDeviceR5 |
Definition | This extension implements the R5 composition element. It allow to link this DiagnoticReport with the Composition documenting this Laboratory Report. |
Short | Associated Lab Report Devices or DeviceDefinitions |
Control | 1..1 |
Type | Extension(Extension Definition for ObservationDefinition.device for Version 5.0) (Extension Type: Reference(DeviceDefinition, Device)) |
10. ObservationDefinition.extension:ObservationDefinitionDeviceR5.value[x] | |
Control | 1..? |
Type | Reference(ChLabReportDeviceTestKit, ChLabReportDeviceDefinition) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
12. ObservationDefinition.method | |
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 |
Summary | false |
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (text.`div`.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 it's 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 it's meaning or interpretation |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
4. ObservationDefinition.extension | |
Definition | An Extension 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Short | ExtensionAdditional content defined by implementations |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 20..* |
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.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
6. ObservationDefinition.extension:ObservationDefinitionSpecimenR5 | |
Slice Name | ObservationDefinitionSpecimenR5 |
Definition | This extension implements the R5 specimen element. It allow to link this DiagnoticReport with the SpecimenDefinition R5 documenting this Laboratory Report. |
Short | Associated Lab Report SpecimenDefinitions |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | Extension(Extension Definition for ObservationDefinition.specimen for Version 5.0) (Extension Type: Reference(SpecimenDefinition)) |
Is Modifier | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
8. ObservationDefinition.extension:ObservationDefinitionSpecimenR5.extension | |
Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Short | ExtensionAdditional content defined by implementations |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..0* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
Slicing | This element introduces a set of slices on ObservationDefinition.extension.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
10. ObservationDefinition.extension:ObservationDefinitionSpecimenR5.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Short | identifies the meaning of the extension |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Control | 1..1 |
Type | uri |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
Fixed Value | http://hl7.org/fhir/5.0/StructureDefinition/extension-ObservationDefinition.specimen |
12. ObservationDefinition.extension:ObservationDefinitionSpecimenR5.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
Short | Value of extension |
Control | 10..1 |
Type | Reference(CH Lab SpecimenDefinition: Laboratory Report), date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
14. ObservationDefinition.extension:ObservationDefinitionDeviceR5 | |
Slice Name | ObservationDefinitionDeviceR5 |
Definition | This extension implements the R5 composition element. It allow to link this DiagnoticReport with the Composition documenting this Laboratory Report. |
Short | Associated Lab Report Devices or DeviceDefinitions |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | Extension(Extension Definition for ObservationDefinition.device for Version 5.0) (Extension Type: Reference(DeviceDefinition, Device)) |
Is Modifier | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
16. ObservationDefinition.extension:ObservationDefinitionDeviceR5.extension | |
Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Short | ExtensionAdditional content defined by implementations |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..0* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
Slicing | This element introduces a set of slices on ObservationDefinition.extension.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
18. ObservationDefinition.extension:ObservationDefinitionDeviceR5.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Short | identifies the meaning of the extension |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Control | 1..1 |
Type | uri |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
Fixed Value | http://hl7.org/fhir/5.0/StructureDefinition/extension-ObservationDefinition.device |
20. ObservationDefinition.extension:ObservationDefinitionDeviceR5.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
Short | Value of extension |
Control | 10..1 |
Type | Reference(ChLabReportDeviceTestKit, ChLabReportDeviceDefinition), date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Is Modifier | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
22. 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 manageable, 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 |
Summary | false |
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()) |
24. ObservationDefinition.code | |
Definition | Describes what will be observed. Sometimes this is called the observation "name". |
Short | Type of observation (code / type) |
Control | 1..1 |
Binding | For example codes, see LOINCCodeshttp://hl7.org/fhir/ValueSet/observation-codes Codes identifying names of simple observations. |
Type | CodeableConcept |
Is Modifier | false |
Summary | true |
Requirements | Knowing what kind of observation is being made is essential to understanding the observation. |
Alternate Names | Name |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
26. 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. |
Control | 0..1 |
Binding | For example codes, see ObservationMethodshttp://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())) |
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 | ||||
Summary | false | ||||
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty() )dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource ( contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() )dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated ( contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() )dom-5: If a resource is contained in another resource, it SHALL NOT have a security label ( contained.meta.security.empty() )dom-6: A resource should have narrative for robust management ( text.`div`.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 | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||||
Control | 0..1 | ||||
Type | id | ||||
Is Modifier | 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 | ||||
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 it's 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 it's meaning or interpretation | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
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 SHOULD be taken from CommonLanguages A human language.
| ||||
Type | code | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
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 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 | ||||
Type | Narrative | ||||
Is Modifier | 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, and nor can they have their own independent transaction scope. | ||||
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..* | ||||
Type | Resource | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | inline resources, anonymous resources, contained resources | ||||
14. ObservationDefinition.extension | |||||
Definition | An Extension | ||||
Short | Extension | ||||
Control | 2..* | ||||
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.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: | ||||
16. ObservationDefinition.extension:ObservationDefinitionSpecimenR5 | |||||
Slice Name | ObservationDefinitionSpecimenR5 | ||||
Definition | This extension implements the R5 specimen element. It allow to link this DiagnoticReport with the SpecimenDefinition R5 documenting this Laboratory Report. | ||||
Short | Associated Lab Report SpecimenDefinitions | ||||
Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(Extension Definition for ObservationDefinition.specimen for Version 5.0) (Extension Type: Reference(SpecimenDefinition)) | ||||
Is Modifier | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
18. ObservationDefinition.extension:ObservationDefinitionSpecimenR5.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
20. ObservationDefinition.extension:ObservationDefinitionSpecimenR5.extension | |||||
Definition | An Extension | ||||
Short | Extension | ||||
Control | 0..0 | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
Slicing | This element introduces a set of slices on ObservationDefinition.extension.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: | ||||
22. ObservationDefinition.extension:ObservationDefinitionSpecimenR5.url | |||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||
Short | identifies the meaning of the extension | ||||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||
Control | 1..1 | ||||
Type | uri | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
Fixed Value | http://hl7.org/fhir/5.0/StructureDefinition/extension-ObservationDefinition.specimen | ||||
24. ObservationDefinition.extension:ObservationDefinitionSpecimenR5.value[x] | |||||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||
Short | Value of extension | ||||
Control | 1..1 | ||||
Type | Reference(CH Lab SpecimenDefinition: Laboratory Report) | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
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.extension:ObservationDefinitionDeviceR5 | |||||
Slice Name | ObservationDefinitionDeviceR5 | ||||
Definition | This extension implements the R5 composition element. It allow to link this DiagnoticReport with the Composition documenting this Laboratory Report. | ||||
Short | Associated Lab Report Devices or DeviceDefinitions | ||||
Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(Extension Definition for ObservationDefinition.device for Version 5.0) (Extension Type: Reference(DeviceDefinition, Device)) | ||||
Is Modifier | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
28. ObservationDefinition.extension:ObservationDefinitionDeviceR5.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
30. ObservationDefinition.extension:ObservationDefinitionDeviceR5.extension | |||||
Definition | An Extension | ||||
Short | Extension | ||||
Control | 0..0 | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
Slicing | This element introduces a set of slices on ObservationDefinition.extension.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: | ||||
32. ObservationDefinition.extension:ObservationDefinitionDeviceR5.url | |||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||
Short | identifies the meaning of the extension | ||||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||
Control | 1..1 | ||||
Type | uri | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
Fixed Value | http://hl7.org/fhir/5.0/StructureDefinition/extension-ObservationDefinition.device | ||||
34. ObservationDefinition.extension:ObservationDefinitionDeviceR5.value[x] | |||||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||
Short | Value of extension | ||||
Control | 1..1 | ||||
Type | Reference(ChLabReportDeviceTestKit, ChLabReportDeviceDefinition) | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
36. 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 manageable, 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 | ||||
Summary | false | ||||
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() ) | ||||
38. ObservationDefinition.category | |||||
Definition | A code that classifies the general type of observation. | ||||
Short | Category 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 Codes for high level observation categories. | ||||
Type | CodeableConcept | ||||
Is Modifier | 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()) ) | ||||
40. ObservationDefinition.code | |||||
Definition | Describes what will be observed. Sometimes this is called the observation "name". | ||||
Short | Type of observation (code / type) | ||||
Control | 1..1 | ||||
Binding | For example codes, see LOINCCodes Codes identifying names of simple observations. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | true | ||||
Requirements | Knowing what kind of observation is being made is essential to understanding the observation. | ||||
Alternate Names | Name | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
42. ObservationDefinition.identifier | |||||
Definition | A unique identifier assigned to this ObservationDefinition artifact. | ||||
Short | Business identifier for this ObservationDefinition instance | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..* | ||||
Type | Identifier | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
44. 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..* | ||||
Binding | The codes SHALL be taken from ObservationDataType 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 | ||||
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()) ) | ||||
46. ObservationDefinition.multipleResultsAllowed | |||||
Definition | Multiple results allowed for observations conforming to this ObservationDefinition. | ||||
Short | Multiple results allowed | ||||
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 | ||||
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()) ) | ||||
48. 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. | ||||
Control | 0..1 | ||||
Binding | For example codes, see ObservationMethods 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()) ) | ||||
50. ObservationDefinition.preferredReportName | |||||
Definition | The preferred name to be used when reporting the results of observations conforming to this ObservationDefinition. | ||||
Short | Preferred report name | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
52. ObservationDefinition.quantitativeDetails | |||||
Definition | Characteristics for quantitative results of this observation. | ||||
Short | Characteristics of quantitative results | ||||
Control | 0..1 | ||||
Type | BackboneElement | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
54. ObservationDefinition.quantitativeDetails.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
56. ObservationDefinition.quantitativeDetails.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Short | Additional content defined by implementations | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
58. ObservationDefinition.quantitativeDetails.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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() ) | ||||
60. ObservationDefinition.quantitativeDetails.customaryUnit | |||||
Definition | Customary unit used to report quantitative results of observations conforming to this ObservationDefinition. | ||||
Short | Customary unit for quantitative results | ||||
Control | 0..1 | ||||
Binding | Unless not suitable, these codes SHALL be taken from UCUMCodes Codes identifying units of measure. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
62. ObservationDefinition.quantitativeDetails.unit | |||||
Definition | SI unit used to report quantitative results of observations conforming to this ObservationDefinition. | ||||
Short | SI unit for quantitative results | ||||
Control | 0..1 | ||||
Binding | Unless not suitable, these codes SHALL be taken from UCUMCodes Codes identifying units of measure. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
64. ObservationDefinition.quantitativeDetails.conversionFactor | |||||
Definition | Factor for converting value expressed with SI unit to value expressed with customary unit. | ||||
Short | SI to Customary unit conversion factor | ||||
Control | 0..1 | ||||
Type | decimal | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
66. ObservationDefinition.quantitativeDetails.decimalPrecision | |||||
Definition | Number of digits after decimal separator when the results of such observations are of type Quantity. | ||||
Short | Decimal precision of observation quantitative results | ||||
Control | 0..1 | ||||
Type | integer | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
68. ObservationDefinition.qualifiedInterval | |||||
Definition | Multiple ranges of results qualified by different contexts for ordinal or continuous observations conforming to this ObservationDefinition. | ||||
Short | Qualified range for continuous and ordinal observation results | ||||
Control | 0..* | ||||
Type | BackboneElement | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
70. ObservationDefinition.qualifiedInterval.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
72. ObservationDefinition.qualifiedInterval.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Short | Additional content defined by implementations | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
74. ObservationDefinition.qualifiedInterval.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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() ) | ||||
76. ObservationDefinition.qualifiedInterval.category | |||||
Definition | The category of interval of values for continuous or ordinal observations conforming to this ObservationDefinition. | ||||
Short | reference | critical | absolute | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from ObservationRangeCategory Codes identifying the category of observation range. | ||||
Type | code | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
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()) ) | ||||
78. ObservationDefinition.qualifiedInterval.range | |||||
Definition | The low and high values determining the interval. There may be only one of the two. | ||||
Short | The interval itself, for continuous or ordinal observations | ||||
Control | 0..1 | ||||
Type | Range | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | The unit may be not relevant for ordinal values. In case it is there, it is the same as quantitativeDetails.unit. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
80. ObservationDefinition.qualifiedInterval.context | |||||
Definition | Codes to indicate the health context the range applies to. For example, the normal or therapeutic range. | ||||
Short | Range context qualifier | ||||
Control | 0..1 | ||||
Binding | Unless not suitable, these codes SHALL be taken from ObservationReferenceRangeMeaningCodes Code identifying the health context of a range. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
82. ObservationDefinition.qualifiedInterval.appliesTo | |||||
Definition | Codes to indicate the target population this reference range applies to. | ||||
Short | Targetted population of the range | ||||
Comments | If this element is not present then the global population is assumed. | ||||
Control | 0..* | ||||
Binding | For example codes, see ObservationReferenceRangeAppliesToCodes Codes identifying the population the reference range applies to. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
84. ObservationDefinition.qualifiedInterval.gender | |||||
Definition | Sex of the population the range applies to. | ||||
Short | male | female | other | unknown | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from AdministrativeGender The gender of a person used for administrative purposes. | ||||
Type | code | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
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()) ) | ||||
86. ObservationDefinition.qualifiedInterval.age | |||||
Definition | The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so. | ||||
Short | Applicable age range, if relevant | ||||
Comments | Some analytes vary greatly over age. | ||||
Control | 0..1 | ||||
Type | Range | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
88. ObservationDefinition.qualifiedInterval.gestationalAge | |||||
Definition | The gestational age to which this reference range is applicable, in the context of pregnancy. | ||||
Short | Applicable gestational age range, if relevant | ||||
Control | 0..1 | ||||
Type | Range | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
90. ObservationDefinition.qualifiedInterval.condition | |||||
Definition | Text based condition for which the reference range is valid. | ||||
Short | Condition associated with the reference range | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
92. ObservationDefinition.validCodedValueSet | |||||
Definition | The set of valid coded results for the observations conforming to this ObservationDefinition. | ||||
Short | Value set of valid coded values for the observations conforming to this ObservationDefinition | ||||
Control | 0..1 | ||||
Type | Reference(ValueSet) | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
94. ObservationDefinition.normalCodedValueSet | |||||
Definition | The set of normal coded results for the observations conforming to this ObservationDefinition. | ||||
Short | Value set of normal coded values for the observations conforming to this ObservationDefinition | ||||
Control | 0..1 | ||||
Type | Reference(ValueSet) | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
96. ObservationDefinition.abnormalCodedValueSet | |||||
Definition | The set of abnormal coded results for the observation conforming to this ObservationDefinition. | ||||
Short | Value set of abnormal coded values for the observations conforming to this ObservationDefinition | ||||
Control | 0..1 | ||||
Type | Reference(ValueSet) | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
98. ObservationDefinition.criticalCodedValueSet | |||||
Definition | The set of critical coded results for the observation conforming to this ObservationDefinition. | ||||
Short | Value set of critical coded values for the observations conforming to this ObservationDefinition | ||||
Control | 0..1 | ||||
Type | Reference(ValueSet) | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |