This page is part of the Loinc/IVD Mapping FHIR IG (v1.0.0-ballot: STU1 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. . For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org/fhir/uv/livd/StructureDefinition/observationdefinition-uv-livd | Version: 1.0.0-ballot | |||
Active as of 2018-08-14 | Computable Name: LIVDObservationDefinition |
Profile on the ObservationDefinition resource for representing the analytes that can be measured by the included devices for which the test codes and applicable result values are mapped.
The LIVD ObservationDefinition is a profile on the ObservationDefinition resource for representing the analytes that can be measured by the included devices for which the test codes and applicable result values are mapped.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ObservationDefinition
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ObservationDefinition | 0..* | ObservationDefinition | LIVDObservationDefinition | |
Slices for extension | S | 1..* | Extension | Extension Slice: Unordered, Open by value:url |
ObservationDefinitionDevice | S | 1..* | Reference(LIVDDeviceDefinition) | LIVD Device URL: http://hl7.org/fhir/uv/livd/StructureDefinition/ext-device |
ObservationDefinitionVendorReferenceIdentifier | S | 0..1 | Identifier | LIVD Vendor Reference Identifier URL: http://hl7.org/fhir/uv/livd/StructureDefinition/ext-vendorReferenceIdentifier |
category | 0..0 | |||
code | S | 1..1 | CodeableConcept | Type of observation (code / type) |
identifier | S | 0..* | Identifier | Business identifier for this ObservationDefinition instance |
permittedDataType | S | 0..1 | code | Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period |
multipleResultsAllowed | 0..0 | |||
method | S | 0..1 | CodeableConcept | Method used to produce the observation |
preferredReportName | 0..0 | |||
quantitativeDetails | S | 0..1 | BackboneElement | Characteristics of quantitative results |
customaryUnit | S | 0..1 | CodeableConcept | Customary unit for quantitative results |
unit | S | 0..1 | CodeableConcept | SI unit for quantitative results |
conversionFactor | S | 0..1 | decimal | SI unit to customary unit conversion factor |
decimalPrecision | S | 0..1 | integer | Decimal precision of observation quantitative results |
qualifiedInterval | 0..0 | |||
validCodedValueSet | S | 0..1 | Reference(ValueSet) | Value set of valid coded values for the observations conforming to this ObservationDefinition |
normalCodedValueSet | 0..0 | |||
abnormalCodedValueSet | 0..0 | |||
criticalCodedValueSet | 0..0 | |||
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ObservationDefinition | 0..* | ObservationDefinition | LIVDObservationDefinition | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | S | 1..* | Extension | Extension Slice: Unordered, Open by value:url |
ObservationDefinitionDevice | S | 1..* | Reference(LIVDDeviceDefinition) | LIVD Device URL: http://hl7.org/fhir/uv/livd/StructureDefinition/ext-device |
ObservationDefinitionVendorReferenceIdentifier | S | 0..1 | Identifier | LIVD Vendor Reference Identifier URL: http://hl7.org/fhir/uv/livd/StructureDefinition/ext-vendorReferenceIdentifier |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
code | SΣ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. |
identifier | SΣ | 0..* | Identifier | Business identifier for this ObservationDefinition instance |
permittedDataType | S | 0..1 | code | Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period Binding: ObservationDataType (required): Permitted data type for observation value. Example General: CodeableConcept |
method | S | 0..1 | CodeableConcept | Method used to produce the observation Binding: ObservationMethods (example): Methods for simple observations. |
quantitativeDetails | S | 0..1 | BackboneElement | Characteristics of quantitative results |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
customaryUnit | S | 0..1 | CodeableConcept | Customary unit for quantitative results Binding: UCUMCodes (extensible): Codes identifying units of measure. |
unit | S | 0..1 | CodeableConcept | SI unit for quantitative results Binding: UCUMCodes (extensible): Codes identifying units of measure. |
conversionFactor | S | 0..1 | decimal | SI unit to customary unit conversion factor |
decimalPrecision | S | 0..1 | integer | Decimal precision of observation quantitative results |
validCodedValueSet | S | 0..1 | Reference(ValueSet) | Value set of valid coded values for the observations conforming to this ObservationDefinition |
Documentation for this format |
Path | Conformance | ValueSet |
ObservationDefinition.code | example | LOINCCodes (a valid code from LOINC) |
ObservationDefinition.permittedDataType | required | ObservationDataType |
ObservationDefinition.method | example | ObservationMethods |
ObservationDefinition.quantitativeDetails.customaryUnit | extensible | UCUMCodes (a valid code from UCUM) |
ObservationDefinition.quantitativeDetails.unit | extensible | UCUMCodes (a valid code from UCUM) |
ObservationDefinition.qualifiedInterval.category | required | ObservationRangeCategory |
ObservationDefinition.qualifiedInterval.context | extensible | ObservationReferenceRangeMeaningCodes |
ObservationDefinition.qualifiedInterval.appliesTo | example | ObservationReferenceRangeAppliesToCodes |
ObservationDefinition.qualifiedInterval.gender | required | AdministrativeGender |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | ObservationDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | ObservationDefinition | 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 | error | ObservationDefinition | 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 | error | ObservationDefinition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | ObservationDefinition | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
ObservationDefinition | 0..* | ObservationDefinition | LIVDObservationDefinition | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | S | 1..* | Extension | Extension Slice: Unordered, Open by value:url | ||||
ObservationDefinitionDevice | S | 1..* | Reference(LIVDDeviceDefinition) | LIVD Device URL: http://hl7.org/fhir/uv/livd/StructureDefinition/ext-device | ||||
ObservationDefinitionVendorReferenceIdentifier | S | 0..1 | Identifier | LIVD Vendor Reference Identifier URL: http://hl7.org/fhir/uv/livd/StructureDefinition/ext-vendorReferenceIdentifier | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
code | SΣ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. | ||||
identifier | SΣ | 0..* | Identifier | Business identifier for this ObservationDefinition instance | ||||
permittedDataType | S | 0..1 | code | Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period Binding: ObservationDataType (required): Permitted data type for observation value. Example General: CodeableConcept | ||||
method | S | 0..1 | CodeableConcept | Method used to produce the observation Binding: ObservationMethods (example): Methods for simple observations. | ||||
quantitativeDetails | S | 0..1 | BackboneElement | Characteristics of quantitative results | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
customaryUnit | S | 0..1 | CodeableConcept | Customary unit for quantitative results Binding: UCUMCodes (extensible): Codes identifying units of measure. | ||||
unit | S | 0..1 | CodeableConcept | SI unit for quantitative results Binding: UCUMCodes (extensible): Codes identifying units of measure. | ||||
conversionFactor | S | 0..1 | decimal | SI unit to customary unit conversion factor | ||||
decimalPrecision | S | 0..1 | integer | Decimal precision of observation quantitative results | ||||
validCodedValueSet | S | 0..1 | Reference(ValueSet) | Value set of valid coded values for the observations conforming to this ObservationDefinition | ||||
Documentation for this format |
Path | Conformance | ValueSet | ||||
ObservationDefinition.language | preferred | CommonLanguages
| ||||
ObservationDefinition.code | example | LOINCCodes (a valid code from LOINC) | ||||
ObservationDefinition.permittedDataType | required | ObservationDataType | ||||
ObservationDefinition.method | example | ObservationMethods | ||||
ObservationDefinition.quantitativeDetails.customaryUnit | extensible | UCUMCodes (a valid code from UCUM) | ||||
ObservationDefinition.quantitativeDetails.unit | extensible | UCUMCodes (a valid code from UCUM) | ||||
ObservationDefinition.qualifiedInterval.category | required | ObservationRangeCategory | ||||
ObservationDefinition.qualifiedInterval.context | extensible | ObservationReferenceRangeMeaningCodes | ||||
ObservationDefinition.qualifiedInterval.appliesTo | example | ObservationReferenceRangeAppliesToCodes | ||||
ObservationDefinition.qualifiedInterval.gender | required | AdministrativeGender |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | ObservationDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | ObservationDefinition | 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 | error | ObservationDefinition | 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 | error | ObservationDefinition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | ObservationDefinition | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from ObservationDefinition
Differential View
This structure is derived from ObservationDefinition
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ObservationDefinition | 0..* | ObservationDefinition | LIVDObservationDefinition | |
Slices for extension | S | 1..* | Extension | Extension Slice: Unordered, Open by value:url |
ObservationDefinitionDevice | S | 1..* | Reference(LIVDDeviceDefinition) | LIVD Device URL: http://hl7.org/fhir/uv/livd/StructureDefinition/ext-device |
ObservationDefinitionVendorReferenceIdentifier | S | 0..1 | Identifier | LIVD Vendor Reference Identifier URL: http://hl7.org/fhir/uv/livd/StructureDefinition/ext-vendorReferenceIdentifier |
category | 0..0 | |||
code | S | 1..1 | CodeableConcept | Type of observation (code / type) |
identifier | S | 0..* | Identifier | Business identifier for this ObservationDefinition instance |
permittedDataType | S | 0..1 | code | Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period |
multipleResultsAllowed | 0..0 | |||
method | S | 0..1 | CodeableConcept | Method used to produce the observation |
preferredReportName | 0..0 | |||
quantitativeDetails | S | 0..1 | BackboneElement | Characteristics of quantitative results |
customaryUnit | S | 0..1 | CodeableConcept | Customary unit for quantitative results |
unit | S | 0..1 | CodeableConcept | SI unit for quantitative results |
conversionFactor | S | 0..1 | decimal | SI unit to customary unit conversion factor |
decimalPrecision | S | 0..1 | integer | Decimal precision of observation quantitative results |
qualifiedInterval | 0..0 | |||
validCodedValueSet | S | 0..1 | Reference(ValueSet) | Value set of valid coded values for the observations conforming to this ObservationDefinition |
normalCodedValueSet | 0..0 | |||
abnormalCodedValueSet | 0..0 | |||
criticalCodedValueSet | 0..0 | |||
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ObservationDefinition | 0..* | ObservationDefinition | LIVDObservationDefinition | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | S | 1..* | Extension | Extension Slice: Unordered, Open by value:url |
ObservationDefinitionDevice | S | 1..* | Reference(LIVDDeviceDefinition) | LIVD Device URL: http://hl7.org/fhir/uv/livd/StructureDefinition/ext-device |
ObservationDefinitionVendorReferenceIdentifier | S | 0..1 | Identifier | LIVD Vendor Reference Identifier URL: http://hl7.org/fhir/uv/livd/StructureDefinition/ext-vendorReferenceIdentifier |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
code | SΣ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. |
identifier | SΣ | 0..* | Identifier | Business identifier for this ObservationDefinition instance |
permittedDataType | S | 0..1 | code | Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period Binding: ObservationDataType (required): Permitted data type for observation value. Example General: CodeableConcept |
method | S | 0..1 | CodeableConcept | Method used to produce the observation Binding: ObservationMethods (example): Methods for simple observations. |
quantitativeDetails | S | 0..1 | BackboneElement | Characteristics of quantitative results |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
customaryUnit | S | 0..1 | CodeableConcept | Customary unit for quantitative results Binding: UCUMCodes (extensible): Codes identifying units of measure. |
unit | S | 0..1 | CodeableConcept | SI unit for quantitative results Binding: UCUMCodes (extensible): Codes identifying units of measure. |
conversionFactor | S | 0..1 | decimal | SI unit to customary unit conversion factor |
decimalPrecision | S | 0..1 | integer | Decimal precision of observation quantitative results |
validCodedValueSet | S | 0..1 | Reference(ValueSet) | Value set of valid coded values for the observations conforming to this ObservationDefinition |
Documentation for this format |
Path | Conformance | ValueSet |
ObservationDefinition.code | example | LOINCCodes (a valid code from LOINC) |
ObservationDefinition.permittedDataType | required | ObservationDataType |
ObservationDefinition.method | example | ObservationMethods |
ObservationDefinition.quantitativeDetails.customaryUnit | extensible | UCUMCodes (a valid code from UCUM) |
ObservationDefinition.quantitativeDetails.unit | extensible | UCUMCodes (a valid code from UCUM) |
ObservationDefinition.qualifiedInterval.category | required | ObservationRangeCategory |
ObservationDefinition.qualifiedInterval.context | extensible | ObservationReferenceRangeMeaningCodes |
ObservationDefinition.qualifiedInterval.appliesTo | example | ObservationReferenceRangeAppliesToCodes |
ObservationDefinition.qualifiedInterval.gender | required | AdministrativeGender |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | ObservationDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | ObservationDefinition | 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 | error | ObservationDefinition | 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 | error | ObservationDefinition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | ObservationDefinition | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
ObservationDefinition | 0..* | ObservationDefinition | LIVDObservationDefinition | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | S | 1..* | Extension | Extension Slice: Unordered, Open by value:url | ||||
ObservationDefinitionDevice | S | 1..* | Reference(LIVDDeviceDefinition) | LIVD Device URL: http://hl7.org/fhir/uv/livd/StructureDefinition/ext-device | ||||
ObservationDefinitionVendorReferenceIdentifier | S | 0..1 | Identifier | LIVD Vendor Reference Identifier URL: http://hl7.org/fhir/uv/livd/StructureDefinition/ext-vendorReferenceIdentifier | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
code | SΣ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. | ||||
identifier | SΣ | 0..* | Identifier | Business identifier for this ObservationDefinition instance | ||||
permittedDataType | S | 0..1 | code | Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period Binding: ObservationDataType (required): Permitted data type for observation value. Example General: CodeableConcept | ||||
method | S | 0..1 | CodeableConcept | Method used to produce the observation Binding: ObservationMethods (example): Methods for simple observations. | ||||
quantitativeDetails | S | 0..1 | BackboneElement | Characteristics of quantitative results | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
customaryUnit | S | 0..1 | CodeableConcept | Customary unit for quantitative results Binding: UCUMCodes (extensible): Codes identifying units of measure. | ||||
unit | S | 0..1 | CodeableConcept | SI unit for quantitative results Binding: UCUMCodes (extensible): Codes identifying units of measure. | ||||
conversionFactor | S | 0..1 | decimal | SI unit to customary unit conversion factor | ||||
decimalPrecision | S | 0..1 | integer | Decimal precision of observation quantitative results | ||||
validCodedValueSet | S | 0..1 | Reference(ValueSet) | Value set of valid coded values for the observations conforming to this ObservationDefinition | ||||
Documentation for this format |
Path | Conformance | ValueSet | ||||
ObservationDefinition.language | preferred | CommonLanguages
| ||||
ObservationDefinition.code | example | LOINCCodes (a valid code from LOINC) | ||||
ObservationDefinition.permittedDataType | required | ObservationDataType | ||||
ObservationDefinition.method | example | ObservationMethods | ||||
ObservationDefinition.quantitativeDetails.customaryUnit | extensible | UCUMCodes (a valid code from UCUM) | ||||
ObservationDefinition.quantitativeDetails.unit | extensible | UCUMCodes (a valid code from UCUM) | ||||
ObservationDefinition.qualifiedInterval.category | required | ObservationRangeCategory | ||||
ObservationDefinition.qualifiedInterval.context | extensible | ObservationReferenceRangeMeaningCodes | ||||
ObservationDefinition.qualifiedInterval.appliesTo | example | ObservationReferenceRangeAppliesToCodes | ||||
ObservationDefinition.qualifiedInterval.gender | required | AdministrativeGender |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | ObservationDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | ObservationDefinition | 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 | error | ObservationDefinition | 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 | error | ObservationDefinition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | ObservationDefinition | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from ObservationDefinition
Other representations of profile: CSV, Excel, Schematron