OMI-Protocol-IG

There are no (further) constraints on this element

Element id

Device.id

Short description

Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

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.

Data type

meta

0..1

There are no (further) constraints on this element

Element id

Device.meta

Short description

Metadata about the resource

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.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

implicitRules

Σ ?!

0..1

There are no (further) constraints on this element

Element id

Device.implicitRules

Short description

A set of rules under which this content was created

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.

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.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

language

0..1

codeBinding

There are no (further) constraints on this element

Element id

Device.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

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).

Data type

Binding

A human language.

Binding extensions

maxValueSet	AllLanguages

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

text

0..1

There are no (further) constraints on this element

Element id

Device.text

Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

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.

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.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: Act.text?

contained

0..*

There are no (further) constraints on this element

Element id

Device.contained

Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

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.

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.

Data type

Mappings

rim: N/A

extension

S C

0..*

Element id

Device.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

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 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.

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.

Data type

http://omi.de/fhir/registry/StructureDefinition/build-hash-extension

Slicing

Unordered, Open, by url(Value)

Constraints

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()

Mappings

rim: N/A

buildHashExtension

S C

0..1

Extension(Complex)

Element id

Device.extension:buildHashExtension

Short description

Build Hash Extension

Alternate names

extensions, user content

Definition

Extension holding a hash value and some information about the hash type.

Comments

Data type

Extension(Complex)

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: N/A
rim: n/a

inputParameters

S C

0..1

Element id

Device.extension:inputParameters

Short description

Service Input Parameter Extension

Alternate names

extensions, user content

Definition

Extension to link input parameters to the HealthcareService resource.

Comments

Data type

http://omi.de/fhir/registry/StructureDefinition/input-parameter-extension

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: N/A
rim: n/a

outputParameters

S C

0..1

Element id

Device.extension:outputParameters

Short description

Service Output Parameter Extension

Alternate names

extensions, user content

Definition

Extension to link output parameters to the HealthcareService resource.

Comments

Data type

http://omi.de/fhir/registry/StructureDefinition/output-parameter-extension

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: N/A
rim: n/a

doiExtension

S C

0..*

Extension(Complex)

Element id

Device.extension:doiExtension

Short description

DOI extension

Alternate names

extensions, user content

Definition

Holds a Document Object Identifier (DOI) and a citation string of an algorithm.

Comments

Data type

Extension(Complex)

Extension URL

http://omi.de/fhir/registry/StructureDefinition/doi-extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: N/A
rim: n/a

resolutionRequirementExtension

S C

0..1

Extension(Complex)

Element id

Device.extension:resolutionRequirementExtension

Short description

MRT resolution requirement extension

Alternate names

extensions, user content

Definition

Defines the minimum, recommended and max resolution for an algorithm.

Comments

Data type

Extension(Complex)

Extension URL

http://omi.de/fhir/registry/StructureDefinition/mrt-resolution-requirement-extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: N/A
rim: n/a

algorithmSymbolExtension

S C

0..1

Extension(base64Binary)

Element id

Device.extension:algorithmSymbolExtension

Short description

AlgorithmSymbolExtension

Alternate names

extensions, user content

Definition

Extension to capture the PNG symbol of an algorithm.

Comments

Data type

Extension(base64Binary)

Extension URL

http://omi.de/fhir/registry/StructureDefinition/AlgorithmSymbolExtension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: N/A
rim: n/a

deidentificationParameters

S C

0..1

Extension(Reference(OmiDeidentificationParameters))

Element id

Device.extension:deidentificationParameters

Short description

Algorithm Deidentification Parameters Extension

Alternate names

extensions, user content

Definition

Documents the deidentification parameters for an algorithm.

Comments

Data type

Extension(Reference(OmiDeidentificationParameters))

Extension URL

http://omi.de/fhir/registry/StructureDefinition/deidentification-extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: N/A
rim: n/a

softwareLicenseExtension

S C

0..1

Element id

Device.extension:softwareLicenseExtension

Short description

Software License Extension

Alternate names

extensions, user content

Definition

Extension holding software license information.

Comments

Data type

http://omi.de/fhir/registry/StructureDefinition/software-license-extension

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: N/A
rim: n/a

modifierExtension

?! C

0..*

There are no (further) constraints on this element

Element id

Device.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

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).

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.

Comments

Data type

Constraints

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()

Mappings

rim: N/A

identifier

0..*

IdentifierPattern

Element id

Device.identifier

Short description

Instance identifier

Definition

Unique instance identifiers assigned to a device by manufacturers other organizations or owners.

Comments

The barcode string from a barcode present on a device label or package may identify the instance, include names given to the device in local usage, or may identify the type of device. If the identifier identifies the type of device, Device.type element should be used.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "system": "http://omi.de/fhir/registry/sid/device"
}

Mappings

w5: FiveWs.identifier
rim: .id
udi: The serial number which is a component of the production identifier (PI), a conditional, variable portion of a UDI. The identifier.type code should be set to “SNO”(Serial Number) and the system left empty.

0..1

There are no (further) constraints on this element

Element id

Device.identifier.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Device.identifier.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

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.

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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()

Mappings

rim: n/a

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

Device.identifier.use

Short description

usual | official | temp | secondary | old (If known)

Definition

The purpose of this identifier.

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Data type

Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: Role.code or implied by context

type

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Device.identifier.type

Short description

Description of identifier

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Data type

Identifier Type Codes (extensible)

Binding

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: CX.5
rim: Role.code or implied by context

system

S Σ

0..1

uriPattern

There are no (further) constraints on this element

Element id

Device.identifier.system

Short description

The namespace for the identifier value

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

http://omi.de/fhir/registry/sid/device

Examples
General

http://www.acme.com/identifiers/patient

Mappings

v2: CX.4 / EI-2-4
rim: II.root or Role.id.root
servd: ./IdentifierType

value

S Σ

0..1

There are no (further) constraints on this element

Element id

Device.identifier.value

Short description

The value that is unique

Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples
General

Mappings

v2: CX.1 / EI.1
rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
servd: ./Value

period

0..1

There are no (further) constraints on this element

Element id

Device.identifier.period

Short description

Time period when id is/was valid for use

Definition

Time period during which identifier is/was valid for use.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

assigner

0..1

There are no (further) constraints on this element

Element id

Device.identifier.assigner

Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Data type

Reference(DeviceDefinition)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: CX.4 / (CX.4,CX.9,CX.10)
rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
servd: ./IdentifierIssuingAuthority

definition

0..1

There are no (further) constraints on this element

Element id

Device.definition

Short description

The reference to the definition for the device

Definition

The reference to the definition for the device.

Data type

Reference(DeviceDefinition)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

udiCarrier

0..*

There are no (further) constraints on this element

Element id

Device.udiCarrier

Short description

Unique Device Identifier (UDI) Barcode string

Definition

Unique device identifier (UDI) assigned to device label or package. Note that the Device may include multiple udiCarriers as it either may include just the udiCarrier for the jurisdiction it is sold, or for multiple jurisdictions it could have been sold.

Comments

UDI may identify an unique instance of a device, or it may only identify the type of the device. See UDI mappings for a complete mapping of UDI parts to Device.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.identifier
rim: .id and .code

0..1

There are no (further) constraints on this element

Element id

Device.udiCarrier.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Device.udiCarrier.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Device.udiCarrier.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

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).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

deviceIdentifier

0..1

There are no (further) constraints on this element

Element id

Device.udiCarrier.deviceIdentifier

Short description

Mandatory fixed portion of UDI

Alternate names

Definition

The device identifier (DI) is a mandatory, fixed portion of a UDI that identifies the labeler and the specific version or model of a device.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.what[x]
rim: Role.id.extension
udi: The device identifier (DI), a mandatory, fixed portion of a UDI that identifies the labeler and the specific version or model of a device.

issuer

0..1

There are no (further) constraints on this element

Element id

Device.udiCarrier.issuer

Short description

UDI Issuing Organization

Alternate names

Barcode System

Definition

Organization that is charged with issuing UDIs for devices. For example, the US FDA issuers include :

GS1: http://hl7.org/fhir/NamingSystem/gs1-di,
HIBCC: http://hl7.org/fhir/NamingSystem/hibcc-dI,
ICCBBA for blood containers: http://hl7.org/fhir/NamingSystem/iccbba-blood-di,
ICCBA for other devices: http://hl7.org/fhir/NamingSystem/iccbba-other-di.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: Role.id.root
udi: All UDIs are to be issued under a system operated by an Jurisdiction-accredited issuing agency. GS1 DIs: http://hl7.org/fhir/NamingSystem/gs1 HIBCC DIs: http://hl7.org/fhir/NamingSystem/hibcc ICCBBA DIs for blood containers: http://hl7.org/fhir/NamingSystem/iccbba-blood ICCBA DIs for other devices: http://hl7.org/fhir/NamingSystem/iccbba-other

jurisdiction

0..1

There are no (further) constraints on this element

Element id

Device.udiCarrier.jurisdiction

Short description

Regional UDI authority

Definition

The identity of the authoritative source for UDI generation within a jurisdiction. All UDIs are globally unique within a single namespace with the appropriate repository uri as the system. For example, UDIs of devices managed in the U.S. by the FDA, the value is http://hl7.org/fhir/NamingSystem/fda-udi.

Requirements

Allows a recipient of a UDI to know which database will contain the UDI-associated metadata.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: Role.scoper

carrierAIDC

0..1

There are no (further) constraints on this element

Element id

Device.udiCarrier.carrierAIDC

Short description

UDI Machine Readable Barcode String

Alternate names

Automatic Identification and Data Capture

Definition

The full UDI carrier of the Automatic Identification and Data Capture (AIDC) technology representation of the barcode string as printed on the packaging of the device - e.g., a barcode or RFID. Because of limitations on character sets in XML and the need to round-trip JSON data through XML, AIDC Formats SHALL be base64 encoded.

Comments

The AIDC form of UDIs should be scanned or otherwise used for the identification of the device whenever possible to minimize errors in records resulting from manual transcriptions. If separate barcodes for DI and PI are present, concatenate the string with DI first and in order of human readable expression on label.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: Role.id.extension
udi: A unique device identifier (UDI) on a device label a form that uses automatic identification and data capture (AIDC) technology.

carrierHRF

0..1

There are no (further) constraints on this element

Element id

Device.udiCarrier.carrierHRF

Short description

UDI Human Readable Barcode String

Alternate names

Human Readable Form

Definition

The full UDI carrier as the human readable form (HRF) representation of the barcode string as printed on the packaging of the device.

Comments

If separate barcodes for DI and PI are present, concatenate the string with DI first and in order of human readable expression on label.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: Role.id.extension
udi: A unique device identifier (UDI) on a device label in plain text

entryType

0..1

codeBinding

There are no (further) constraints on this element

Element id

Device.udiCarrier.entryType

Short description

barcode | rfid | manual +

Definition

A coded entry to indicate how the data was entered.

Requirements

Supports a way to distinguish hand entered from machine read data.

Data type

Binding

Codes to identify how UDI data was entered.

UDIEntryType (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: NA

status

S Σ ?!

1..1

codeBinding

Element id

Device.status

Short description

Is this algorithm still available

Definition

Status of the Device availability.

Comments

This element is labeled as a modifier because the status contains the codes inactive and entered-in-error that mark the device (record)as not currently valid.

Data type

Binding

The availability status of the device.

FHIRDeviceStatus (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.status
rim: .statusCode

statusReason

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Device.statusReason

Short description

Definition

Reason for the dtatus of the Device availability.

Data type

FHIRDeviceStatusReason (extensible)

Binding

The availability status reason of the device.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.status

distinctIdentifier

0..1

There are no (further) constraints on this element

Element id

Device.distinctIdentifier

Short description

The distinct identification string

Alternate names

Distinct Identification Code (DIC)

Definition

The distinct identification string as required by regulation for a human cell, tissue, or cellular and tissue-based product.

Comments

For example, this applies to devices in the United States regulated under Code of Federal Regulation 21CFR§1271.290(c).

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.what[x]
rim: .lotNumberText
udi: The lot or batch number within which a device was manufactured - which is a component of the production identifier (PI), a conditional, variable portion of a UDI.

manufacturer

0..1

There are no (further) constraints on this element

Element id

Device.manufacturer

Short description

Name of device manufacturer

Definition

A name of the manufacturer.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.what[x]
rim: .playedRole[typeCode=MANU].scoper.name
udi: N/A

manufactureDate

0..1

There are no (further) constraints on this element

Element id

Device.manufactureDate

Short description

Date when the device was made

Definition

The date and time when the device was manufactured.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.what[x]
rim: .existenceTime.low
udi: The date a specific device was manufactured - which is a component of the production identifier (PI), a conditional, variable portion of a UDI. For FHIR, The datetime syntax must converted to YYYY-MM-DD[THH:MM:SS]. If hour is present, the minutes and seconds should both be set to “00”.

expirationDate

0..1

There are no (further) constraints on this element

Element id

Device.expirationDate

Short description

Date and time of expiry of this device (if applicable)

Definition

The date and time beyond which this device is no longer valid or should not be used (if applicable).

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.what[x]
rim: .expirationTime
udi: the expiration date of a specific device - which is a component of the production identifier (PI), a conditional, variable portion of a UDI. For FHIR, The datetime syntax must converted to YYYY-MM-DD[THH:MM:SS]. If hour is present, the minutes and seconds should both be set to “00”.

lotNumber

0..1

There are no (further) constraints on this element

Element id

Device.lotNumber

Short description

Lot number of manufacture

Definition

Lot number assigned by the manufacturer.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.what[x]
rim: .lotNumberText
udi: The lot or batch number within which a device was manufactured - which is a component of the production identifier (PI), a conditional, variable portion of a UDI.

serialNumber

0..1

There are no (further) constraints on this element

Element id

Device.serialNumber

Short description

Serial number assigned by the manufacturer

Definition

The serial number assigned by the organization when the device was manufactured.

Comments

Alphanumeric Maximum 20.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.what[x]
rim: .playedRole[typeCode=MANU].id

deviceName

2..*

Element id

Device.deviceName

Short description

The name of the device as given by the manufacturer

Definition

This represents the manufacturer's name of the device as provided by the device, from a UDI label, or by a person describing the Device. This typically would be used when a person provides the name(s) or when the device represents one of the names available from DeviceDefinition.

Data type

Slicing

Unordered, Open, by type(Pattern)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

(All Slices)

The requirements in this element apply to all slices

0..1

There are no (further) constraints on this element

Element id

Device.deviceName.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Device.deviceName.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Device.deviceName.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

name

1..1

There are no (further) constraints on this element

Element id

Device.deviceName.name

Short description

The name of the device

Alternate names

Definition

The name of the device.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

type

1..1

codeBinding

There are no (further) constraints on this element

Element id

Device.deviceName.type

Short description

Definition

The type of deviceName. UDILabelName | UserFriendlyName | PatientReportedName | ManufactureDeviceName | ModelName.

Data type

Binding

The type of name the device is referred by.

DeviceNameType (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.what[x]
rim: .playedRole[typeCode=MANU].code

user-friendly-name

1..1

There are no (further) constraints on this element

Element id

Device.deviceName:user-friendly-name

Short description

The name of the device as given by the manufacturer

Definition

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

There are no (further) constraints on this element

Element id

Device.deviceName:user-friendly-name.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Device.deviceName:user-friendly-name.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Device.deviceName:user-friendly-name.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

name

1..1

There are no (further) constraints on this element

Element id

Device.deviceName:user-friendly-name.name

Short description

The name of the device

Alternate names

Definition

The name of the device.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

type

1..1

codeBindingPattern

Element id

Device.deviceName:user-friendly-name.type

Short description

Definition

The type of deviceName. UDILabelName | UserFriendlyName | PatientReportedName | ManufactureDeviceName | ModelName.

Data type

Binding

The type of name the device is referred by.

DeviceNameType (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

user-friendly-name

Mappings

w5: FiveWs.what[x]
rim: .playedRole[typeCode=MANU].code

model-name

1..1

There are no (further) constraints on this element

Element id

Device.deviceName:model-name

Short description

The name of the device as given by the manufacturer

Definition

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

There are no (further) constraints on this element

Element id

Device.deviceName:model-name.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Device.deviceName:model-name.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Device.deviceName:model-name.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

name

1..1

There are no (further) constraints on this element

Element id

Device.deviceName:model-name.name

Short description

The name of the device

Alternate names

Definition

The name of the device.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

type

1..1

codeBindingPattern

Element id

Device.deviceName:model-name.type

Short description

Definition

The type of deviceName. UDILabelName | UserFriendlyName | PatientReportedName | ManufactureDeviceName | ModelName.

Data type

Binding

The type of name the device is referred by.

DeviceNameType (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

model-name

Mappings

w5: FiveWs.what[x]
rim: .playedRole[typeCode=MANU].code

modelNumber

0..1

There are no (further) constraints on this element

Element id

Device.modelNumber

Short description

The model number for the device

Definition

The model number for the device.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.what[x]
rim: .softwareName (included as part)

partNumber

0..1

There are no (further) constraints on this element

Element id

Device.partNumber

Short description

The part number of the device

Definition

The part number of the device.

Comments

Alphanumeric Maximum 20.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.what[x]
rim: .playedRole[typeCode=MANU].id

type

0..1

There are no (further) constraints on this element

Element id

Device.type

Short description

The kind or type of device

Definition

The kind or type of device.

Data type

Binding

Codes to identify medical devices.

DeviceType (example)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

specialization

0..*

There are no (further) constraints on this element

Element id

Device.specialization

Short description

The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication

Definition

The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

There are no (further) constraints on this element

Element id

Device.specialization.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Device.specialization.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Device.specialization.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

systemType

1..1

There are no (further) constraints on this element

Element id

Device.specialization.systemType

Short description

The standard that is used to operate and communicate

Alternate names

Definition

The standard that is used to operate and communicate.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

version

0..1

There are no (further) constraints on this element

Element id

Device.specialization.version

Short description

The version of the standard that is used to operate and communicate

Definition

The version of the standard that is used to operate and communicate.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.what[x]

version

0..*

There are no (further) constraints on this element

Element id

Device.version

Short description

The actual design of the device or software version running on the device

Definition

The actual design of the device or software version running on the device.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

There are no (further) constraints on this element

Element id

Device.version.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Device.version.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Device.version.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

type

0..1

There are no (further) constraints on this element

Element id

Device.version.type

Short description

The type of the device version

Alternate names

Definition

The type of the device version.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

component

0..1

There are no (further) constraints on this element

Element id

Device.version.component

Short description

A single component of the device version

Definition

A single component of the device version.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.what[x]

value

1..1

There are no (further) constraints on this element

Element id

Device.version.value

Short description

The version text

Definition

The version text.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

property

0..*

Element id

Device.property

Short description

The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties

Definition

The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties.

Data type

Slicing

Unordered, Open, by type(Pattern)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

(All Slices)

The requirements in this element apply to all slices

0..1

There are no (further) constraints on this element

Element id

Device.property.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Device.property.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Device.property.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

type

1..1

There are no (further) constraints on this element

Element id

Device.property.type

Short description

Code that specifies the property DeviceDefinitionPropetyCode (Extensible)

Definition

Code that specifies the property DeviceDefinitionPropetyCode (Extensible).

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

valueQuantity

0..*

There are no (further) constraints on this element

Element id

Device.property.valueQuantity

Short description

Property value as a quantity

Definition

Property value as a quantity.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

valueCode

0..*

There are no (further) constraints on this element

Element id

Device.property.valueCode

Short description

Property value as a code, e.g., NTP4 (synced to NTP)

Definition

Property value as a code, e.g., NTP4 (synced to NTP).

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

maturityLevel

0..1

There are no (further) constraints on this element

Element id

Device.property:maturityLevel

Short description

The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties

Definition

The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

There are no (further) constraints on this element

Element id

Device.property:maturityLevel.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Device.property:maturityLevel.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Device.property:maturityLevel.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

type

1..1

CodeableConceptPattern

Element id

Device.property:maturityLevel.type

Short description

Code that specifies the property DeviceDefinitionPropetyCode (Extensible)

Definition

Code that specifies the property DeviceDefinitionPropetyCode (Extensible).

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://snomed.info/sct",
      "code": "246102003"
    }
  ]
}

valueQuantity

0..*

There are no (further) constraints on this element

Element id

Device.property:maturityLevel.valueQuantity

Short description

Property value as a quantity

Definition

Property value as a quantity.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

valueCode

1..*

CodeableConceptBinding

Element id

Device.property:maturityLevel.valueCode

Short description

Property value as a code, e.g., NTP4 (synced to NTP)

Definition

Property value as a code, e.g., NTP4 (synced to NTP).

Data type

Binding

MaturityLevelVS (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

supportedModality

0..*

There are no (further) constraints on this element

Element id

Device.property:supportedModality

Short description

The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties

Definition

The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

There are no (further) constraints on this element

Element id

Device.property:supportedModality.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Device.property:supportedModality.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Device.property:supportedModality.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

type

1..1

CodeableConceptPattern

Element id

Device.property:supportedModality.type

Short description

Code that specifies the property DeviceDefinitionPropetyCode (Extensible)

Definition

Code that specifies the property DeviceDefinitionPropetyCode (Extensible).

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://snomed.info/sct",
      "code": "360037004"
    }
  ]
}

valueQuantity

0..*

There are no (further) constraints on this element

Element id

Device.property:supportedModality.valueQuantity

Short description

Property value as a quantity

Definition

Property value as a quantity.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

valueCode

1..*

CodeableConceptBinding

Element id

Device.property:supportedModality.valueCode

Short description

Property value as a code, e.g., NTP4 (synced to NTP)

Definition

Property value as a code, e.g., NTP4 (synced to NTP).

Data type

Binding

Modality (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

supportedLaterality

0..*

There are no (further) constraints on this element

Element id

Device.property:supportedLaterality

Short description

The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties

Definition

The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

There are no (further) constraints on this element

Element id

Device.property:supportedLaterality.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Device.property:supportedLaterality.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Device.property:supportedLaterality.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

type

1..1

CodeableConceptPattern

Element id

Device.property:supportedLaterality.type

Short description

Code that specifies the property DeviceDefinitionPropetyCode (Extensible)

Definition

Code that specifies the property DeviceDefinitionPropetyCode (Extensible).

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://snomed.info/sct",
      "code": "272741003"
    }
  ]
}

valueQuantity

0..*

There are no (further) constraints on this element

Element id

Device.property:supportedLaterality.valueQuantity

Short description

Property value as a quantity

Definition

Property value as a quantity.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

valueCode

1..*

CodeableConceptBinding

Element id

Device.property:supportedLaterality.valueCode

Short description

Property value as a code, e.g., NTP4 (synced to NTP)

Definition

Property value as a code, e.g., NTP4 (synced to NTP).

Data type

https://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_244.html (required)

Binding

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

imageReconstructionPlane

0..*

There are no (further) constraints on this element

Element id

Device.property:imageReconstructionPlane

Short description

The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties

Definition

The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

There are no (further) constraints on this element

Element id

Device.property:imageReconstructionPlane.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Device.property:imageReconstructionPlane.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Device.property:imageReconstructionPlane.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

type

1..1

CodeableConceptPattern

Element id

Device.property:imageReconstructionPlane.type

Short description

Code that specifies the property DeviceDefinitionPropetyCode (Extensible)

Definition

Code that specifies the property DeviceDefinitionPropetyCode (Extensible).

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://snomed.info/sct",
      "code": "260225008"
    }
  ]
}

valueQuantity

0..*

There are no (further) constraints on this element

Element id

Device.property:imageReconstructionPlane.valueQuantity

Short description

Property value as a quantity

Definition

Property value as a quantity.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

valueCode

1..*

CodeableConceptBinding

Element id

Device.property:imageReconstructionPlane.valueCode

Short description

Property value as a code, e.g., NTP4 (synced to NTP)

Definition

Property value as a code, e.g., NTP4 (synced to NTP).

Data type

CrosssectionalScanPlaneOrientation (required)

Binding

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

supportedBodySite

0..*

There are no (further) constraints on this element

Element id

Device.property:supportedBodySite

Short description

The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties

Definition

The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

There are no (further) constraints on this element

Element id

Device.property:supportedBodySite.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Device.property:supportedBodySite.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Device.property:supportedBodySite.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

type

1..1

CodeableConceptPattern

Element id

Device.property:supportedBodySite.type

Short description

Code that specifies the property DeviceDefinitionPropetyCode (Extensible)

Definition

Code that specifies the property DeviceDefinitionPropetyCode (Extensible).

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://snomed.info/sct",
      "code": "123037004"
    }
  ]
}

valueQuantity

0..*

There are no (further) constraints on this element

Element id

Device.property:supportedBodySite.valueQuantity

Short description

Property value as a quantity

Definition

Property value as a quantity.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

valueCode

1..*

CodeableConceptBinding

Element id

Device.property:supportedBodySite.valueCode

Short description

Property value as a code, e.g., NTP4 (synced to NTP)

Definition

Property value as a code, e.g., NTP4 (synced to NTP).

Data type

SNOMEDCTBodyStructures (required)

Binding

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

AIServiceType

0..*

There are no (further) constraints on this element

Element id

Device.property:AIServiceType

Short description

The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties

Definition

The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

There are no (further) constraints on this element

Element id

Device.property:AIServiceType.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Device.property:AIServiceType.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Device.property:AIServiceType.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

type

1..1

CodeableConceptPattern

Element id

Device.property:AIServiceType.type

Short description

Code that specifies the property DeviceDefinitionPropetyCode (Extensible)

Definition

Code that specifies the property DeviceDefinitionPropetyCode (Extensible).

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://snomed.info/sct",
      "code": "410656007"
    }
  ]
}

valueQuantity

0..*

There are no (further) constraints on this element

Element id

Device.property:AIServiceType.valueQuantity

Short description

Property value as a quantity

Definition

Property value as a quantity.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

valueCode

1..*

CodeableConceptBinding

Element id

Device.property:AIServiceType.valueCode

Short description

Property value as a code, e.g., NTP4 (synced to NTP)

Definition

Property value as a code, e.g., NTP4 (synced to NTP).

Data type

Binding

AIServiceTypeVS (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

patient

0..1

Reference(Patient)

There are no (further) constraints on this element

Element id

Device.patient

Short description

Patient to whom Device is affixed

Definition

Patient information, If the device is affixed to a person.

Requirements

If the device is implanted in a patient, then need to associate the device to the patient.

Data type

Reference(Patient)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.subject[x]
rim: .playedRole[typeCode=USED].scoper.playedRole[typeCode=PAT]
w5: FiveWs.subject

owner

0..1

Element id

Device.owner

Short description

Organization responsible for device

Definition

An organization that is responsible for the provision and ongoing maintenance of the device.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.source
rim: .playedRole[typeCode=OWN].scoper

contact

0..1

There are no (further) constraints on this element

Element id

Device.contact

Short description

Details for human/organization for support

Definition

Contact details for an organization or a particular human that is responsible for the device.

Comments

used for troubleshooting etc.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.source
rim: .scopedRole[typeCode=CON].player

0..1

There are no (further) constraints on this element

Element id

Device.contact.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Device.contact.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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()

Mappings

rim: n/a

system

S Σ C

0..1

codeBindingPattern

Element id

Device.contact.system

Short description

phone | fax | email | pager | url | sms | other

Definition

Telecommunications form for contact point - what communications system is required to make use of the contact.

Data type

Binding

Telecommunications form for contact point.

ContactPointSystem (required)

Conditions

The cardinality or value of this element may be affected by these constraints: cpt-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

email

Mappings

v2: XTN.3
rim: ./scheme
servd: ./ContactPointType

value

S Σ

1..1

There are no (further) constraints on this element

Element id

Device.contact.value

Short description

The actual contact point details

Definition

The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).

Requirements

Need to support legacy numbers that are not in a tightly controlled format.

Comments

Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: XTN.1 (or XTN.12)
rim: ./url
servd: ./Value

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

Device.contact.use

Short description

home | work | temp | old | mobile - purpose of this contact point

Definition

Identifies the purpose for the contact point.

Requirements

Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

Comments

Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

Data type

Binding

Use of contact point.

ContactPointUse (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: XTN.2 - but often indicated by field
rim: unique(./use)
servd: ./ContactPointPurpose

rank

0..1

There are no (further) constraints on this element

Element id

Device.contact.rank

Short description

Specify preferred order of use (1 = highest)

Definition

Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.

Comments

Note that rank does not necessarily follow the order in which the contacts are represented in the instance.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: n/a
rim: n/a

period

0..1

There are no (further) constraints on this element

Element id

Device.contact.period

Short description

Time period when the contact point was/is in use

Definition

Time period when the contact point was/is in use.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: ./usablePeriod[type="IVL<TS>"]
servd: ./StartDate and ./EndDate

location

0..1

There are no (further) constraints on this element

Element id

Device.location

Short description

Where the device is found

Definition

The place where the device can be found.

Requirements

Device.location can be used to track device location.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.where[x]
rim: .playedRole[typeCode=LOCE].scoper

url

0..1

There are no (further) constraints on this element

Element id

Device.url

Short description

Network address to contact device

Definition

A network address on which the device may be contacted directly.

Comments

If the device is running a FHIR server, the network address should be the Base URL from which a conformance statement may be retrieved.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.where[x]
rim: .telecom

note

0..*

There are no (further) constraints on this element

Element id

Device.note

Short description

Device notes and comments

Definition

Descriptive information, usage information or implantation information that is not captured in an existing element.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .text

0..1

There are no (further) constraints on this element

Element id

Device.note.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Device.note.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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()

Mappings

rim: n/a

deviceNoteTypeExtension

S C

0..1

Element id

Device.note.extension:deviceNoteTypeExtension

Short description

DeviceNoteTypeExtension

Alternate names

extensions, user content

Definition

Extension for the note field in the Device resource.

Comments

Data type

http://omi.de/fhir/registry/StructureDefinition/DeviceNoteTypeExtension

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

author[x]

0..1

There are no (further) constraints on this element

Element id

Device.note.author[x]

Short description

Individual responsible for the annotation

Definition

The individual responsible for making the annotation.

Comments

Organization is used when there's no need for specific attribution as to who made the comment.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: Act.participant[typeCode=AUT].role

authorString

There are no (further) constraints on this element

Data type

authorReference

Reference(Practitioner | Patient | RelatedPerson | Organization)

There are no (further) constraints on this element

Data type

Reference(Practitioner | Patient | RelatedPerson | Organization)

time

0..1

There are no (further) constraints on this element

Element id

Device.note.time

Short description

When the annotation was made

Definition

Indicates when this particular annotation was made.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: Act.effectiveTime

text

S Σ

1..1

There are no (further) constraints on this element

Element id

Device.note.text

Short description

The annotation - text content (as markdown)

Definition

The text of the annotation in markdown format.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: Act.text

safety

0..*

There are no (further) constraints on this element

Element id

Device.safety

Short description

Safety Characteristics of Device

Definition

Provides additional safety characteristics about a medical device. For example devices containing latex.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: NA

parent

0..1

Reference(Device)

There are no (further) constraints on this element

Element id

Device.parent

Short description

The parent device

Definition

The parent device.

Data type

Reference(Device)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Example

Device

id : GbmAlgorithm

meta

profile : http://omi.de/fhir/registry/StructureDefinition/algorithm-device

extension

url : hash

value : b7edda3172c39fe8754d607f2182047479b05d31406009cdcf1183970f5397a4

extension

url : type

value

coding

code : SHA-256

system : http://terminology.hl7.org/CodeSystem/v3-IntegrityCheckAlgorithm

display : secure hash algorithm - 256

url : http://omi.de/fhir/registry/StructureDefinition/build-hash-extension

extension

url : http://omi.de/fhir/registry/StructureDefinition/deidentification-extension

value

reference : Parameters/GbmDeidentification

extension

url : http://omi.de/fhir/registry/StructureDefinition/input-parameter-extension

value : http://omi.de/fhir/registry/StructureDefinition/GbmServiceInputParameters

extension

url : http://omi.de/fhir/registry/StructureDefinition/output-parameter-extension

value : http://omi.de/fhir/registry/StructureDefinition/GbmServiceOutputParameters

extension

value

value : 1

url : resolutionx

extension

value

value : 1.25

url : resolutiony

extension

value

value : 1.75

url : resolutionz

extension

url : qualifier

value

code : C25570

system : http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl

display : Minimum

url : minres

url : http://omi.de/fhir/registry/StructureDefinition/mrt-resolution-requirement-extension

identifier

system : http://omi.de/fhir/registry/sid/device

value : 3b6bed46-442d-4f28-bdf6-ab01ea005a59

version

value : 0.1.0 (da9a697)

deviceName

type : user-friendly-name

name : Glioblastoma

deviceName

type : model-name

name : Glioblastoma

property

valueCode

coding

code : CT

system : http://dicom.nema.org/resources/ontology/DCM

display : Computed Tomography

type

coding

code : 360037004

system : http://snomed.info/sct

property

valueCode

coding

code : diagnostics

system : http://omi.de/fhir/registry/CodeSystem/ai-service-type-codesystem

display : Diagnostics

type

coding

code : 410656007

system : http://snomed.info/sct

property

valueCode

coding

code : LVL3

system : http://omi.de/fhir/registry/CodeSystem/maturity-level-codesystem

display : LEVEL 3

type

coding

code : 246102003

system : http://snomed.info/sct

status : active

owner

reference : Organization/ShipAI

HealthcareService - FHIR Model

Profile

OmiHealthcareService (HealthcareService)

HealthcareService

There are no (further) constraints on this element

Element id

HealthcareService

Short description

The details of a healthcare service available at a location

Definition

The details of a healthcare service available at a location.

Data type

HealthcareService

Constraints

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()

Mappings

rim: Entity. Role, or Act
rim: act[classCode=ACT][moodCode=DEF]

0..1

There are no (further) constraints on this element

Element id

HealthcareService.id

Short description

Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

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.

Data type

meta

0..1

There are no (further) constraints on this element

Element id

HealthcareService.meta

Short description

Metadata about the resource

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.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

implicitRules

Σ ?!

0..1

There are no (further) constraints on this element

Element id

HealthcareService.implicitRules

Short description

A set of rules under which this content was created

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

language

0..1

codeBinding

There are no (further) constraints on this element

Element id

HealthcareService.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Data type

Binding

A human language.

Binding extensions

maxValueSet	AllLanguages

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

text

0..1

There are no (further) constraints on this element

Element id

HealthcareService.text

Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: Act.text?

contained

0..*

There are no (further) constraints on this element

Element id

HealthcareService.contained

Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

Comments

Data type

Mappings

rim: N/A

extension

S C

1..*

Element id

HealthcareService.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension(Reference(HeartbeatObservationProfile))

Slicing

Unordered, Open, by url(Value)

Constraints

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()

Mappings

rim: N/A

serviceToHeartBeatObservationLinkExtension

S C

1..1

Element id

HealthcareService.extension:serviceToHeartBeatObservationLinkExtension

Short description

HealthcareService to Heartbeat Link Extension

Alternate names

extensions, user content

Definition

Links a service to heartbeat parameters.

Comments

Data type

Extension(Reference(HeartbeatObservationProfile))

Extension URL

http://omi.de/fhir/registry/StructureDefinition/service-to-heart-beat-observation-link-extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: N/A
rim: n/a

serviceToAlgorithmLinkExtension

S C

0..*

Extension(Reference(OmiDevice))

Element id

HealthcareService.extension:serviceToAlgorithmLinkExtension

Short description

Algorithm to Service Link Extension

Alternate names

extensions, user content

Definition

Links a service to a algorithm.

Comments

Data type

Extension(Reference(OmiDevice))

Extension URL

http://omi.de/fhir/registry/StructureDefinition/service-to-algorithm-link-extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: N/A
rim: n/a

softwareLicenseExtension

S C

0..1

Element id

HealthcareService.extension:softwareLicenseExtension

Short description

Software License Extension

Alternate names

extensions, user content

Definition

Extension holding software license information.

Comments

Data type

http://omi.de/fhir/registry/StructureDefinition/software-license-extension

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: N/A
rim: n/a

modifierExtension

?! C

0..*

There are no (further) constraints on this element

Element id

HealthcareService.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

identifier

S Σ

0..*

IdentifierPattern

Element id

HealthcareService.identifier

Short description

External identifiers for this item

Definition

External identifiers for this item.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "system": "http://omi.de/fhir/registry/sid/healthcare-service"
}

Mappings

w5: FiveWs.identifier
rim: .id

0..1

There are no (further) constraints on this element

Element id

HealthcareService.identifier.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

HealthcareService.identifier.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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()

Mappings

rim: n/a

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

HealthcareService.identifier.use

Short description

usual | official | temp | secondary | old (If known)

Definition

The purpose of this identifier.

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Data type

Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: Role.code or implied by context

type

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

HealthcareService.identifier.type

Short description

Description of identifier

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

Data type

Identifier Type Codes (extensible)

Binding

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: CX.5
rim: Role.code or implied by context

system

S Σ

0..1

uriPattern

There are no (further) constraints on this element

Element id

HealthcareService.identifier.system

Short description

The namespace for the identifier value

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

http://omi.de/fhir/registry/sid/healthcare-service

Examples
General

http://www.acme.com/identifiers/patient

Mappings

v2: CX.4 / EI-2-4
rim: II.root or Role.id.root
servd: ./IdentifierType

value

S Σ

0..1

There are no (further) constraints on this element

Element id

HealthcareService.identifier.value

Short description

The value that is unique

Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples
General

Mappings

v2: CX.1 / EI.1
rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
servd: ./Value

period

0..1

There are no (further) constraints on this element

Element id

HealthcareService.identifier.period

Short description

Time period when id is/was valid for use

Definition

Time period during which identifier is/was valid for use.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

assigner

0..1

There are no (further) constraints on this element

Element id

HealthcareService.identifier.assigner

Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: CX.4 / (CX.4,CX.9,CX.10)
rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
servd: ./IdentifierIssuingAuthority

active

S Σ ?!

0..1

There are no (further) constraints on this element

Element id

HealthcareService.active

Short description

Whether this HealthcareService record is in active use

Definition

This flag is used to mark the record to not be used. This is not used when a center is closed for maintenance, or for holidays, the notAvailable period is to be used for this.

Comments

This element is labeled as a modifier because it may be used to mark that the resource was created in error.

Meaning when missing

This resource is generally assumed to be active if no value is provided for the active element

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.status
rim: .statusCode

providedBy

S Σ

0..1

Element id

HealthcareService.providedBy

Short description

Organization that provides this service

Definition

The organization that provides this healthcare service.

Comments

This property is recommended to be the same as the Location's managingOrganization, and if not provided should be interpreted as such. If the Location does not have a managing Organization, then this property should be populated.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .scopingRole.Organization

category

S Σ

1..*

CodeableConceptPattern

Element id

HealthcareService.category

Short description

Broad category of service being performed or delivered

Alternate names

service category

Definition

Identifies the broad category of service being performed or delivered.

Comments

Selecting a Service Category then determines the list of relevant service types that can be selected in the primary service type.

Data type

Binding

A category of the service(s) that could be provided.

ServiceCategory (example)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl",
      "code": "C16309",
      "display": "Artificial Intelligence"
    }
  ]
}

Mappings

w5: FiveWs.class
rim: .code

type

0..*

There are no (further) constraints on this element

Element id

HealthcareService.type

Short description

Type of service that may be delivered or performed

Alternate names

service type

Definition

The specific type of service that may be delivered or performed.

Data type

Binding

Additional details about where the content was created (e.g. clinical specialty).

ServiceType (example)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .actrelationship[typeCode=COMP.act[classCode=ACT][moodCode=DEF].code

specialty

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

HealthcareService.specialty

Short description

Specialties handled by the HealthcareService

Definition

Collection of specialties handled by the service site. This is more of a medical term.

Data type

PracticeSettingCodeValueSet (preferred)

Binding

A specialty that a healthcare service may provide.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .actrelationship[typeCode=COMP.act[classCode=ACT][moodCode=DEF].code

location

0..*

There are no (further) constraints on this element

Element id

HealthcareService.location

Short description

Location(s) where service may be provided

Definition

The location(s) where this healthcare service may be provided.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.where[x]
rim: .location.role[classCode=SDLOC]

name

S Σ

0..1

There are no (further) constraints on this element

Element id

HealthcareService.name

Short description

Description of service as presented to a consumer while searching

Definition

Further description of the service as it would be presented to a consumer while searching.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .name

comment

0..1

There are no (further) constraints on this element

Element id

HealthcareService.comment

Short description

Additional description and/or any specific issues not covered elsewhere

Definition

Any additional description of the service and/or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName.

Comments

Would expect that a user would not see this information on a search results, and it would only be available when viewing the complete details of the service.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .location.role[classCode=SDLOC].desc

extraDetails

0..1

There are no (further) constraints on this element

Element id

HealthcareService.extraDetails

Short description

Extra details about the service that can't be placed in the other fields

Definition

Extra details about the service that can't be placed in the other fields.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .actrelationship[typeCode=COMP.act[classCode=ACT][moodCode=DEF].text

photo

0..1

There are no (further) constraints on this element

Element id

HealthcareService.photo

Short description

Facilitates quick identification of the service

Definition

If there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .actrelationship[typeCode=SBJ].observation.value

telecom

0..*

There are no (further) constraints on this element

Element id

HealthcareService.telecom

Short description

Contacts related to the healthcare service

Definition

List of contacts related to this specific healthcare service.

Comments

If this is empty, then refer to the location's contacts.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .telecom

coverageArea

0..*

There are no (further) constraints on this element

Element id

HealthcareService.coverageArea

Short description

Location(s) service is intended for/available to

Definition

The location(s) that this service is available to (not where the service is provided).

Comments

The locations referenced by the coverage area can include both specific locations, including areas, and also conceptual domains too (mode = kind), such as a physical area (tri-state area) and some other attribute (covered by Example Care Organization). These types of Locations are often not managed by any specific organization. This could also include generic locations such as "in-home".

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .location.role[classCode=SDLOC].subjectOf.A_SpatialCoordinate

serviceProvisionCode

0..*

There are no (further) constraints on this element

Element id

HealthcareService.serviceProvisionCode

Short description

Conditions under which service is available/offered

Definition

The code(s) that detail the conditions under which the healthcare service is available/offered.

Comments

The provision means being commissioned by, contractually obliged or financially sourced. Types of costings that may apply to this healthcare service, such if the service may be available for free, some discounts available, or fees apply.

Data type

ServiceProvisionConditions (example)

Binding

The code(s) that detail the conditions under which the healthcare service is available/offered.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .actrelationship[typeCode=PRCN].observation[moodCode=EVN.CRT]

eligibility

0..*

There are no (further) constraints on this element

Element id

HealthcareService.eligibility

Short description

Specific eligibility requirements required to use the service

Definition

Does this service have specific eligibility requirements that need to be met in order to use the service?

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

There are no (further) constraints on this element

Element id

HealthcareService.eligibility.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

HealthcareService.eligibility.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

HealthcareService.eligibility.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

code

0..1

There are no (further) constraints on this element

Element id

HealthcareService.eligibility.code

Short description

Coded value for the eligibility

Definition

Coded value for the eligibility.

Data type

Binding

Coded values underwhich a specific service is made available.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .actrelationship[typeCode=PRCN].observation[moodCode=EVN.CRT]

comment

0..1

There are no (further) constraints on this element

Element id

HealthcareService.eligibility.comment

Short description

Describes the eligibility conditions for the service

Definition

Describes the eligibility conditions for the service.

Comments

The description of service eligibility should, in general, not exceed one or two paragraphs. It should be sufficient for a prospective consumer to determine if they are likely to be eligible or not. Where eligibility requirements and conditions are complex, it may simply be noted that an eligibility assessment is required. Where eligibility is determined by an outside source, such as an Act of Parliament, this should be noted, preferably with a reference to a commonly available copy of the source document such as a web page.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .actrelationship[typeCode=PRCN].observation[moodCode=EVN.CRT].text

program

0..*

There are no (further) constraints on this element

Element id

HealthcareService.program

Short description

Programs that this service is applicable to

Definition

Programs that this service is applicable to.

Comments

Programs are often defined externally to an Organization, commonly by governments; e.g. Home and Community Care Programs, Homeless Program, ….

Data type

Binding

Government or local programs that this service applies to.

Program (example)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .actrelationship[typeCode=PERT].observation

characteristic

0..*

There are no (further) constraints on this element

Element id

HealthcareService.characteristic

Short description

Collection of characteristics (attributes)

Definition

Collection of characteristics (attributes).

Comments

These could be such things as is wheelchair accessible.

Data type

Binding

A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .actrelationship[typeCode=PERT].observation

communication

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

HealthcareService.communication

Short description

The language that this service is offered in

Definition

Some services are specifically made available in multiple languages, this property permits a directory to declare the languages this is offered in. Typically this is only provided where a service operates in communities with mixed languages used.

Comments

When using this property it indicates that the service is available with this language, it is not derived from the practitioners, and not all are required to use this language, just that this language is available while scheduling.

Data type

Binding

A human language.

Binding extensions

maxValueSet	AllLanguages

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

referralMethod

0..*

There are no (further) constraints on this element

Element id

HealthcareService.referralMethod

Short description

Ways that the service accepts referrals

Definition

Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required.

Data type

Binding

The methods of referral can be used when referring to a specific HealthCareService resource.

ReferralMethod (example)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .actrelationship[typeCode=PERT].observation

appointmentRequired

0..1

There are no (further) constraints on this element

Element id

HealthcareService.appointmentRequired

Short description

If an appointment is required for access to this service

Definition

Indicates whether or not a prospective consumer will require an appointment for a particular service at a site to be provided by the Organization. Indicates if an appointment is required for access to this service.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .actrelationship[typeCode=PERT].observation

availableTime

0..*

There are no (further) constraints on this element

Element id

HealthcareService.availableTime

Short description

Times the Service Site is available

Definition

A collection of times that the Service Site is available.

Comments

More detailed availability information may be provided in associated Schedule/Slot resources.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .effectiveTime

0..1

There are no (further) constraints on this element

Element id

HealthcareService.availableTime.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

HealthcareService.availableTime.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

HealthcareService.availableTime.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

daysOfWeek

0..*

codeBinding

There are no (further) constraints on this element

Element id

HealthcareService.availableTime.daysOfWeek

Short description

mon | tue | wed | thu | fri | sat | sun

Definition

Indicates which days of the week are available between the start and end Times.

Data type

Binding

The days of the week.

DaysOfWeek (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .effectiveTime

allDay

0..1

There are no (further) constraints on this element

Element id

HealthcareService.availableTime.allDay

Short description

Always available? e.g. 24 hour service

Definition

Is this always available? (hence times are irrelevant) e.g. 24 hour service.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .effectiveTime

availableStartTime

0..1

There are no (further) constraints on this element

Element id

HealthcareService.availableTime.availableStartTime

Short description

Opening time of day (ignored if allDay = true)

Definition

The opening time of day. Note: If the AllDay flag is set, then this time is ignored.

Comments

The time zone is expected to be for where this HealthcareService is provided at.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .effectiveTime

availableEndTime

0..1

There are no (further) constraints on this element

Element id

HealthcareService.availableTime.availableEndTime

Short description

Closing time of day (ignored if allDay = true)

Definition

The closing time of day. Note: If the AllDay flag is set, then this time is ignored.

Comments

The time zone is expected to be for where this HealthcareService is provided at.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .effectiveTime

notAvailable

0..*

There are no (further) constraints on this element

Element id

HealthcareService.notAvailable

Short description

Not available during this time due to provided reason

Definition

The HealthcareService is not available during this period of time due to the provided reason.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .effectiveTime

0..1

There are no (further) constraints on this element

Element id

HealthcareService.notAvailable.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

HealthcareService.notAvailable.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

HealthcareService.notAvailable.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

description

1..1

There are no (further) constraints on this element

Element id

HealthcareService.notAvailable.description

Short description

Reason presented to the user explaining why time not available

Definition

The reason that can be presented to the user as to why this time is not available.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

during

0..1

There are no (further) constraints on this element

Element id

HealthcareService.notAvailable.during

Short description

Service not available from this date

Definition

Service is not available (seasonally or for a public holiday) from this date.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .effectiveTime

availabilityExceptions

0..1

There are no (further) constraints on this element

Element id

HealthcareService.availabilityExceptions

Short description

Description of availability exceptions

Definition

A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .effectiveTime

endpoint

0..*

Reference(OmiAiEndpoint)

Element id

HealthcareService.endpoint

Short description

Technical endpoints providing access to electronic services operated for the healthcare service

Definition

Technical endpoints providing access to services operated for the specific healthcare services defined at this resource.

Data type

Reference(OmiAiEndpoint)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

Example

Device

id : GbmAlgorithm

meta

profile : http://omi.de/fhir/registry/StructureDefinition/algorithm-device

extension

url : hash

value : b7edda3172c39fe8754d607f2182047479b05d31406009cdcf1183970f5397a4

extension

url : type

value

coding

code : SHA-256

system : http://terminology.hl7.org/CodeSystem/v3-IntegrityCheckAlgorithm

display : secure hash algorithm - 256

url : http://omi.de/fhir/registry/StructureDefinition/build-hash-extension

extension

url : http://omi.de/fhir/registry/StructureDefinition/deidentification-extension

value

reference : Parameters/GbmDeidentification

extension

url : http://omi.de/fhir/registry/StructureDefinition/input-parameter-extension

value : http://omi.de/fhir/registry/StructureDefinition/GbmServiceInputParameters

extension

url : http://omi.de/fhir/registry/StructureDefinition/output-parameter-extension

value : http://omi.de/fhir/registry/StructureDefinition/GbmServiceOutputParameters

extension

value

value : 1

url : resolutionx

extension

value

value : 1.25

url : resolutiony

extension

value

value : 1.75

url : resolutionz

extension

url : qualifier

value

code : C25570

system : http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl

display : Minimum

url : minres

url : http://omi.de/fhir/registry/StructureDefinition/mrt-resolution-requirement-extension

identifier

system : http://omi.de/fhir/registry/sid/device

value : 3b6bed46-442d-4f28-bdf6-ab01ea005a59

version

value : 0.1.0 (da9a697)

deviceName

type : user-friendly-name

name : Glioblastoma

deviceName

type : model-name

name : Glioblastoma

property

valueCode

coding

code : CT

system : http://dicom.nema.org/resources/ontology/DCM

display : Computed Tomography

type

coding

code : 360037004

system : http://snomed.info/sct

property

valueCode

coding

code : diagnostics

system : http://omi.de/fhir/registry/CodeSystem/ai-service-type-codesystem

display : Diagnostics

type

coding

code : 410656007

system : http://snomed.info/sct

property

valueCode

coding

code : LVL3

system : http://omi.de/fhir/registry/CodeSystem/maturity-level-codesystem

display : LEVEL 3

type

coding

code : 246102003

system : http://snomed.info/sct

status : active

owner

reference : Organization/ShipAI

Heartbeat - FHIR Model

HeartbeatObservationProfile (Observation)

Observation

There are no (further) constraints on this element

Element id

Observation

Short description

Measurements and simple assertions

Alternate names

Vital Signs, Measurement, Results, Tests

Definition

Measurements and simple assertions made about a patient, device or other subject.

Comments

Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc.

Data type

Observation

Constraints

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()
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
dataAbsentReason.empty() or value.empty()
obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()

Mappings

rim: Entity. Role, or Act
workflow: Event
sct-concept: < 363787002 |Observable entity|
v2: OBX
rim: Observation[classCode=OBS, moodCode=EVN]

0..1

There are no (further) constraints on this element

Element id

Observation.id

Short description

Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

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.

Data type

meta

0..1

There are no (further) constraints on this element

Element id

Observation.meta

Short description

Metadata about the resource

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.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

implicitRules

Σ ?!

0..1

There are no (further) constraints on this element

Element id

Observation.implicitRules

Short description

A set of rules under which this content was created

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

language

0..1

codeBinding

There are no (further) constraints on this element

Element id

Observation.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Data type

Binding

A human language.

Binding extensions

maxValueSet	AllLanguages

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

text

0..1

There are no (further) constraints on this element

Element id

Observation.text

Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: Act.text?

contained

0..*

There are no (further) constraints on this element

Element id

Observation.contained

Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

Comments

Data type

Mappings

rim: N/A

extension

0..*

Element id

Observation.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

http://omi.de/fhir/registry/StructureDefinition/build-hash-extension

Slicing

Unordered, Open, by url(Value)

Constraints

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()

Mappings

rim: N/A

buildHashExtension

S C

0..1

Extension(Complex)

Element id

Observation.extension:buildHashExtension

Short description

Build Hash Extension

Alternate names

extensions, user content

Definition

Extension holding a hash value and some information about the hash type.

Comments

Data type

Extension(Complex)

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: N/A
rim: n/a

modifierExtension

?! C

0..*

There are no (further) constraints on this element

Element id

Observation.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

identifier

0..*

There are no (further) constraints on this element

Element id

Observation.identifier

Short description

Business Identifier for observation

Definition

A unique identifier assigned to this observation.

Requirements

Allows observations to be distinguished and referenced.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Event.identifier
w5: FiveWs.identifier
v2: OBX.21 For OBX segments from systems without OBX-21 support a combination of ORC/OBR and OBX must be negotiated between trading partners to uniquely identify the OBX segment. Depending on how V2 has been implemented each of these may be an option: 1) OBR-3 + OBX-3 + OBX-4 or 2) OBR-3 + OBR-4 + OBX-3 + OBX-4 or 2) some other way to uniquely ID the OBR/ORC + OBX-3 + OBX-4.
rim: id

basedOn

0..*

There are no (further) constraints on this element

Element id

Observation.basedOn

Short description

Fulfills plan, proposal or order

Alternate names

Fulfills

Definition

A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.

Requirements

Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Event.basedOn
v2: ORC
rim: .inboundRelationship[typeCode=COMP].source[moodCode=EVN]

partOf

0..*

There are no (further) constraints on this element

Element id

Observation.partOf

Short description

Part of referenced event

Alternate names

Container

Definition

A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.

Comments

To link an Observation to an Encounter use encounter. See the Notes below for guidance on referencing another Observation.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Event.partOf
v2: Varies by domain
rim: .outboundRelationship[typeCode=FLFS].target

status

Σ ?!

1..1

codeBinding

There are no (further) constraints on this element

Element id

Observation.status

Short description

registered | preliminary | final | amended +

Definition

The status of the result value.

Requirements

Need to track the status of individual results. Some results are finalized before the whole report is finalized.

Comments

This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

Data type

Binding

Codes providing the status of an observation.

ObservationStatus (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Event.status
w5: FiveWs.status
sct-concept: < 445584004 |Report by finality status|
v2: OBX-11
rim: status Amended & Final are differentiated by whether it is the subject of a ControlAct event with a type of "revise"

category

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.category

Short description

Classification of type of observation

Definition

A code that classifies the general type of observation being made.

Requirements

Used for filtering what observations are retrieved and displayed.

Comments

In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set.

Data type

Binding

Codes for high level observation categories.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.class
rim: .outboundRelationship[typeCode="COMP].target[classCode="LIST", moodCode="EVN"].code

code

1..1

CodeableConceptPattern

Element id

Observation.code

Short description

Type of observation (code / type)

Alternate names

Name

Definition

Describes what was observed. Sometimes this is called the observation "name".

Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and, if present, component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Data type

Binding

Codes identifying names of simple observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl",
      "code": "C0449438",
      "display": "Status"
    }
  ]
}

Mappings

workflow: Event.code
w5: FiveWs.what[x]
sct-concept: < 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|
v2: OBX-3
rim: code
sct-attr: 116680003 |Is a|

subject

0..1

There are no (further) constraints on this element

Element id

Observation.subject

Short description

Who and/or what the observation is about

Definition

The patient, or group of patients, location, or device this observation is about and into whose record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the focus element or the code itself specifies the actual focus of the observation.

Requirements

Observations have no value if you don't know who or what they're about.

Comments

One would expect this element to be a cardinality of 1..1. The only circumstance in which the subject can be missing is when the observation is made by a device that does not know the patient. In this case, the observation SHALL be matched to a patient through some context/channel matching technique, and at this point, the observation should be updated.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Event.subject
w5: FiveWs.subject[x]
v2: PID-3
rim: participation[typeCode=RTGT]
w5: FiveWs.subject

focus

0..*

There are no (further) constraints on this element

Element id

Observation.focus

Short description

What the observation is about, when it is not about the subject of record

Definition

The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus.

Comments

Typically, an observation is made about the subject - a patient, or group of patients, location, or device - and the distinction between the subject and what is directly measured for an observation is specified in the observation code itself ( e.g., "Blood Glucose") and does not need to be represented separately using this element. Use specimen if a reference to a specimen is required. If a code is required instead of a resource use either bodysite for bodysites or the standard extension focusCode.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.subject[x]
v2: OBX-3
rim: participation[typeCode=SBJ]
w5: FiveWs.subject

encounter

0..1

There are no (further) constraints on this element

Element id

Observation.encounter

Short description

Healthcare event during which this observation is made

Alternate names

Context

Definition

The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.

Requirements

For some observations it may be important to know the link between an observation and a particular encounter.

Comments

This will typically be the encounter the event occurred within, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission laboratory tests).

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Event.context
w5: FiveWs.context
v2: PV1
rim: inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]

effective[x]

0..1

There are no (further) constraints on this element

Element id

Observation.effective[x]

Short description

Clinically relevant time/time-period for observation

Alternate names

Occurrence

Definition

The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the "physiologically relevant time". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.

Requirements

Knowing when an observation was deemed true is important to its relevance as well as determining trends.

Comments

At least a date should be present unless this observation is a historical report. For recording imprecise or "fuzzy" times (For example, a blood glucose measurement taken "after breakfast") use the Timing datatype which allow the measurement to be tied to regular life events.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Event.occurrence[x]
w5: FiveWs.done[x]
v2: OBX-14, and/or OBX-19 after v2.4 (depends on who observation made)
rim: effectiveTime

effectiveDateTime

There are no (further) constraints on this element

Data type

effectivePeriod

There are no (further) constraints on this element

Data type

effectiveTiming

There are no (further) constraints on this element

Data type

effectiveInstant

There are no (further) constraints on this element

Data type

issued

0..1

There are no (further) constraints on this element

Element id

Observation.issued

Short description

Date/Time this version was made available

Definition

The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.

Comments

For Observations that don’t require review and verification, it may be the same as the lastUpdated time of the resource itself. For Observations that do require review and verification for certain updates, it might not be the same as the lastUpdated time of the resource itself due to a non-clinically significant update that doesn’t require the new version to be reviewed and verified again.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.recorded
v2: OBR.22 (or MSH.7), or perhaps OBX-19 (depends on who observation made)
rim: participation[typeCode=AUT].time

performer

0..*

There are no (further) constraints on this element

Element id

Observation.performer

Short description

Who is responsible for the observation

Definition

Who was responsible for asserting the observed value as "true".

Requirements

May give a degree of confidence in the observation and also indicates where follow-up questions should be directed.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Event.performer.actor
w5: FiveWs.actor
v2: OBX.15 / (Practitioner) OBX-16, PRT-5:PRT-4='RO' / (Device) OBX-18 , PRT-10:PRT-4='EQUIP' / (Organization) OBX-23, PRT-8:PRT-4='PO'
rim: participation[typeCode=PRF]

value[x]

Σ C

0..1

There are no (further) constraints on this element

Element id

Observation.value[x]

Short description

Actual result

Definition

The information determined as a result of making the observation, if the information has a simple value.

Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

An observation may have; 1) a single value here, 2) both a value and a set of related or component values, or 3) only a set of related or component values. If a value is present, the datatype for this element should be determined by Observation.code. A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the Observation.code defines a coded value. For additional guidance, see the Notes section below.

Conditions

The cardinality or value of this element may be affected by these constraints: obs-7

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|

valueQuantity

There are no (further) constraints on this element

Data type

valueCodeableConcept

There are no (further) constraints on this element

Data type

valueString

There are no (further) constraints on this element

Data type

valueBoolean

There are no (further) constraints on this element

Data type

valueInteger

There are no (further) constraints on this element

Data type

valueRange

There are no (further) constraints on this element

Data type

valueRatio

There are no (further) constraints on this element

Data type

valueSampledData

There are no (further) constraints on this element

Data type

valueTime

There are no (further) constraints on this element

Data type

valueDateTime

There are no (further) constraints on this element

Data type

valuePeriod

There are no (further) constraints on this element

Data type

dataAbsentReason

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.dataAbsentReason

Short description

Why the result is missing

Definition

Provides a reason why the expected value in the element Observation.value[x] is missing.

Requirements

For many results it is necessary to handle exceptional values in measurements.

Comments

Null or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "specimen unsatisfactory".

The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code "error" could be used when the measurement was not completed. Note that an observation may only be reported if there are values to report. For example differential cell counts values may be reported only when > 0. Because of these options, use-case agreements are required to interpret general observations for null or exceptional values.

Data type

Binding

Codes specifying why the result (Observation.value[x]) is missing.

Conditions

The cardinality or value of this element may be affected by these constraints: obs-6

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: value.nullFlavor

interpretation

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.interpretation

Short description

High, low, normal, etc.

Alternate names

Abnormal Flag

Definition

A categorical assessment of an observation value. For example, high, low, normal.

Requirements

For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.

Comments

Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result.

Data type

Binding

Codes identifying interpretations of observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: < 260245000 |Findings values|
v2: OBX-8
rim: interpretationCode
sct-attr: 363713009 |Has interpretation|

note

0..*

There are no (further) constraints on this element

Element id

Observation.note

Short description

Comments about the observation

Definition

Comments about the observation or the results.

Requirements

Need to be able to provide free text additional information.

Comments

May include general statements about the observation, or statements about significant, unexpected or unreliable results values, or information about its source when relevant to its interpretation.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: NTE.3 (partner NTE to OBX, or sometimes another (child?) OBX)
rim: subjectOf.observationEvent[code="annotation"].value

bodySite

0..1

There are no (further) constraints on this element

Element id

Observation.bodySite

Short description

Observed body part

Definition

Indicates the site on the subject's body where the observation was made (i.e. the target site).

Comments

Only used if not implicit in code found in Observation.code. In many systems, this may be represented as a related observation instead of an inline component.

If the use case requires BodySite to be handled as a separate resource (e.g. to identify and track separately) then use the standard extension bodySite.

Data type

SNOMEDCTBodyStructures (example)

Binding

Codes describing anatomical locations. May include laterality.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: < 123037004 |Body structure|
v2: OBX-20
rim: targetSiteCode
sct-attr: 718497002 |Inherent location|

method

0..1

There are no (further) constraints on this element

Element id

Observation.method

Short description

How it was done

Definition

Indicates the mechanism used to perform the observation.

Requirements

In some cases, method can impact results and is thus used for determining whether results can be compared or determining significance of results.

Comments

Only used if not implicit in code for Observation.code.

Data type

Binding

Methods for simple observations.

ObservationMethods (example)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: OBX-17
rim: methodCode

specimen

0..1

There are no (further) constraints on this element

Element id

Observation.specimen

Short description

Specimen used for this observation

Definition

The specimen that was used when this observation was made.

Comments

Should only be used if not implicit in code found in Observation.code. Observations are not made on specimens themselves; they are made on a subject, but in many cases by the means of a specimen. Note that although specimens are often involved, they are not always tracked and reported explicitly. Also note that observation resources may be used in contexts that track the specimen explicitly (e.g. Diagnostic Report).

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: < 123038009 |Specimen|
v2: SPM segment
rim: participation[typeCode=SPC].specimen
sct-attr: 704319004 |Inherent in|

device

0..1

There are no (further) constraints on this element

Element id

Observation.device

Short description

(Measurement) Device

Definition

The device used to generate the observation data.

Comments

Note that this is not meant to represent a device involved in the transmission of the result, e.g., a gateway. Such devices may be documented using the Provenance resource where relevant.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: < 49062001 |Device|
v2: OBX-17 / PRT -10
rim: participation[typeCode=DEV]
sct-attr: 424226004 |Using device|

referenceRange

0..*

There are no (further) constraints on this element

Element id

Observation.referenceRange

Short description

Provides guide for interpretation

Definition

Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two referenceRange elements would be used.

Requirements

Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.

Comments

Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
obs-3: Must have at least a low or a high or text
low.exists() or high.exists() or text.exists()

Mappings

v2: OBX.7
rim: outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]

0..1

There are no (further) constraints on this element

Element id

Observation.referenceRange.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Observation.referenceRange.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Observation.referenceRange.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

low

0..1

There are no (further) constraints on this element

Element id

Observation.referenceRange.low

Short description

Low Range, if relevant

Definition

The value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is <=2.3).

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: obs-3

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: OBX-7
rim: value:IVL_PQ.low

high

0..1

There are no (further) constraints on this element

Element id

Observation.referenceRange.high

Short description

High Range, if relevant

Definition

The value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3).

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: obs-3

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: OBX-7
rim: value:IVL_PQ.high

type

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.referenceRange.type

Short description

Reference range qualifier

Definition

Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.

Requirements

Need to be able to say what kind of reference range this is - normal, recommended, therapeutic, etc., - for proper interpretation.

Comments

This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed.

Data type

ObservationReferenceRangeMeaningCodes (preferred)

Binding

Code for the meaning of a reference range.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: < 260245000 |Findings values| OR < 365860008 |General clinical state finding| OR < 250171008 |Clinical history or observation findings| OR < 415229000 |Racial group| OR < 365400002 |Finding of puberty stage| OR < 443938003 |Procedure carried out on subject|
v2: OBX-10
rim: interpretationCode

appliesTo

0..*

There are no (further) constraints on this element

Element id

Observation.referenceRange.appliesTo

Short description

Reference range population

Definition

Codes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race. Multiple appliesTo are interpreted as an "AND" of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used.

Requirements

Need to be able to identify the target population for proper interpretation.

Comments

This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed.

Data type

ObservationReferenceRangeAppliesToCodes (example)

Binding

Codes identifying the population the reference range applies to.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: < 260245000 |Findings values| OR < 365860008 |General clinical state finding| OR < 250171008 |Clinical history or observation findings| OR < 415229000 |Racial group| OR < 365400002 |Finding of puberty stage| OR < 443938003 |Procedure carried out on subject|
v2: OBX-10
rim: interpretationCode

age

0..1

There are no (further) constraints on this element

Element id

Observation.referenceRange.age

Short description

Applicable age range, if relevant

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.

Requirements

Some analytes vary greatly over age.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: outboundRelationship[typeCode=PRCN].targetObservationCriterion[code="age"].value

text

0..1

There are no (further) constraints on this element

Element id

Observation.referenceRange.text

Short description

Text based reference range in an observation

Definition

Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of "Negative" or a list or table of "normals".

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: OBX-7
rim: value:ST

hasMember

0..*

Reference(Observation | QuestionnaireResponse | MolecularSequence)

There are no (further) constraints on this element

Element id

Observation.hasMember

Short description

Related resource that belongs to the Observation group

Definition

This observation is 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.

Comments

When using this element, an observation will typically have either a value or a set of related resources, although both may be present in some cases. For a discussion on the ways Observations can assembled in groups together, see Notes below. Note that a system may calculate results from QuestionnaireResponse into a final score and represent the score as an Observation.

Data type

Reference(Observation | QuestionnaireResponse | MolecularSequence)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: Relationships established by OBX-4 usage
rim: outBoundRelationship

derivedFrom

0..*

There are no (further) constraints on this element

Element id

Observation.derivedFrom

Short description

Related measurements the observation is made from

Definition

The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image.

Comments

All the reference choices that are listed in this element can represent clinical observations and other measurements that may be the source for a derived value. The most common reference will be another Observation. For a discussion on the ways Observations can assembled in groups together, see Notes below.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: Relationships established by OBX-4 usage
rim: .targetObservation

component

0..*

Element id

Observation.component

Short description

Component results

Definition

Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations.

Requirements

Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation.

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

Data type

Slicing

Unordered, Open, by code(Pattern)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: containment by OBX-4?
rim: outBoundRelationship[typeCode=COMP]

(All Slices)

The requirements in this element apply to all slices

0..1

There are no (further) constraints on this element

Element id

Observation.component.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Observation.component.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Observation.component.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

code

1..1

There are no (further) constraints on this element

Element id

Observation.component.code

Short description

Type of component observation (code / type)

Definition

Describes what was observed. Sometimes this is called the observation "code".

Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Data type

Binding

Codes identifying names of simple observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.what[x]
sct-concept: < 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|
v2: OBX-3
rim: code

value[x]

0..1

There are no (further) constraints on this element

Element id

Observation.component.value[x]

Short description

Actual component result

Definition

The information determined as a result of making the observation, if the information has a simple value.

Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was derived). If a value is present, the datatype for this element should be determined by Observation.code. A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the Observation.code defines a coded value. For additional guidance, see the Notes section below.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|

valueQuantity

There are no (further) constraints on this element

Data type

valueCodeableConcept

There are no (further) constraints on this element

Data type

valueString

There are no (further) constraints on this element

Data type

valueBoolean

There are no (further) constraints on this element

Data type

valueInteger

There are no (further) constraints on this element

Data type

valueRange

There are no (further) constraints on this element

Data type

valueRatio

There are no (further) constraints on this element

Data type

valueSampledData

There are no (further) constraints on this element

Data type

valueTime

There are no (further) constraints on this element

Data type

valueDateTime

There are no (further) constraints on this element

Data type

valuePeriod

There are no (further) constraints on this element

Data type

dataAbsentReason

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component.dataAbsentReason

Short description

Why the component result is missing

Definition

Provides a reason why the expected value in the element Observation.component.value[x] is missing.

Requirements

For many results it is necessary to handle exceptional values in measurements.

Comments

"Null" or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "test not done".

Data type

Binding

Codes specifying why the result (Observation.value[x]) is missing.

Conditions

The cardinality or value of this element may be affected by these constraints: obs-6

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: value.nullFlavor

interpretation

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component.interpretation

Short description

High, low, normal, etc.

Alternate names

Abnormal Flag

Definition

A categorical assessment of an observation value. For example, high, low, normal.

Requirements

For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.

Comments

Data type

Binding

Codes identifying interpretations of observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: < 260245000 |Findings values|
v2: OBX-8
rim: interpretationCode
sct-attr: 363713009 |Has interpretation|

referenceRange

0..*

There are no (further) constraints on this element

Element id

Observation.component.referenceRange

Short description

Provides guide for interpretation of component result

Definition

Guidance on how to interpret the value by comparison to a normal or recommended range.

Requirements

Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: OBX.7
rim: outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]

statuscode

0..1

There are no (further) constraints on this element

Element id

Observation.component:statuscode

Short description

Component results

Definition

Requirements

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: containment by OBX-4?
rim: outBoundRelationship[typeCode=COMP]

0..1

There are no (further) constraints on this element

Element id

Observation.component:statuscode.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Observation.component:statuscode.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Observation.component:statuscode.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

code

1..1

CodeableConceptPattern

Element id

Observation.component:statuscode.code

Short description

Type of component observation (code / type)

Definition

Describes what was observed. Sometimes this is called the observation "code".

Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Data type

Binding

Codes identifying names of simple observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://omi.de/fhir/registry/sid/component-codes",
      "code": "statuscode"
    }
  ]
}

Mappings

w5: FiveWs.what[x]
sct-concept: < 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|
v2: OBX-3
rim: code

value[x]

1..1

Element id

Observation.component:statuscode.value[x]

Short description

Actual component result

Definition

The information determined as a result of making the observation, if the information has a simple value.

Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Slicing

Unordered, Open, by $this(Type)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|

valueQuantity

There are no (further) constraints on this element

Data type

valueString

There are no (further) constraints on this element

Data type

valueBoolean

There are no (further) constraints on this element

Data type

valueInteger

There are no (further) constraints on this element

Data type

valueRange

There are no (further) constraints on this element

Data type

valueRatio

There are no (further) constraints on this element

Data type

valueSampledData

There are no (further) constraints on this element

Data type

valueTime

There are no (further) constraints on this element

Data type

valueDateTime

There are no (further) constraints on this element

Data type

valuePeriod

There are no (further) constraints on this element

Data type

valueCodeableConcept

1..1

CodeableConceptBinding

Element id

Observation.component:statuscode.value[x]:valueCodeableConcept

Short description

Actual component result

Definition

The information determined as a result of making the observation, if the information has a simple value.

Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Data type

AiServiceStatusCodesVS (required)

Binding

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|

dataAbsentReason

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:statuscode.dataAbsentReason

Short description

Why the component result is missing

Definition

Provides a reason why the expected value in the element Observation.component.value[x] is missing.

Requirements

For many results it is necessary to handle exceptional values in measurements.

Comments

Data type

Binding

Codes specifying why the result (Observation.value[x]) is missing.

Conditions

The cardinality or value of this element may be affected by these constraints: obs-6

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: value.nullFlavor

interpretation

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:statuscode.interpretation

Short description

High, low, normal, etc.

Alternate names

Abnormal Flag

Definition

A categorical assessment of an observation value. For example, high, low, normal.

Requirements

For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.

Comments

Data type

Binding

Codes identifying interpretations of observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: < 260245000 |Findings values|
v2: OBX-8
rim: interpretationCode
sct-attr: 363713009 |Has interpretation|

referenceRange

0..*

There are no (further) constraints on this element

Element id

Observation.component:statuscode.referenceRange

Short description

Provides guide for interpretation of component result

Definition

Guidance on how to interpret the value by comparison to a normal or recommended range.

Requirements

Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: OBX.7
rim: outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]

queue-length

0..1

There are no (further) constraints on this element

Element id

Observation.component:queue-length

Short description

Component results

Definition

Requirements

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: containment by OBX-4?
rim: outBoundRelationship[typeCode=COMP]

0..1

There are no (further) constraints on this element

Element id

Observation.component:queue-length.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Observation.component:queue-length.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Observation.component:queue-length.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

code

1..1

CodeableConceptPattern

Element id

Observation.component:queue-length.code

Short description

Type of component observation (code / type)

Definition

Describes what was observed. Sometimes this is called the observation "code".

Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Data type

Binding

Codes identifying names of simple observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://omi.de/fhir/registry/sid/component-codes",
      "code": "queue-length"
    }
  ]
}

Mappings

w5: FiveWs.what[x]
sct-concept: < 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|
v2: OBX-3
rim: code

value[x]

1..1

Element id

Observation.component:queue-length.value[x]

Short description

Actual component result

Definition

The information determined as a result of making the observation, if the information has a simple value.

Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Slicing

Unordered, Open, by $this(Type)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|

valueQuantity

There are no (further) constraints on this element

Data type

valueCodeableConcept

There are no (further) constraints on this element

Data type

valueString

There are no (further) constraints on this element

Data type

valueBoolean

There are no (further) constraints on this element

Data type

valueRange

There are no (further) constraints on this element

Data type

valueRatio

There are no (further) constraints on this element

Data type

valueSampledData

There are no (further) constraints on this element

Data type

valueTime

There are no (further) constraints on this element

Data type

valueDateTime

There are no (further) constraints on this element

Data type

valuePeriod

There are no (further) constraints on this element

Data type

valueInteger

1..1

Element id

Observation.component:queue-length.value[x]:valueInteger

Short description

Actual component result

Definition

The information determined as a result of making the observation, if the information has a simple value.

Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|

dataAbsentReason

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:queue-length.dataAbsentReason

Short description

Why the component result is missing

Definition

Provides a reason why the expected value in the element Observation.component.value[x] is missing.

Requirements

For many results it is necessary to handle exceptional values in measurements.

Comments

Data type

Binding

Codes specifying why the result (Observation.value[x]) is missing.

Conditions

The cardinality or value of this element may be affected by these constraints: obs-6

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: value.nullFlavor

interpretation

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:queue-length.interpretation

Short description

High, low, normal, etc.

Alternate names

Abnormal Flag

Definition

A categorical assessment of an observation value. For example, high, low, normal.

Requirements

For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.

Comments

Data type

Binding

Codes identifying interpretations of observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: < 260245000 |Findings values|
v2: OBX-8
rim: interpretationCode
sct-attr: 363713009 |Has interpretation|

referenceRange

0..*

There are no (further) constraints on this element

Element id

Observation.component:queue-length.referenceRange

Short description

Provides guide for interpretation of component result

Definition

Guidance on how to interpret the value by comparison to a normal or recommended range.

Requirements

Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: OBX.7
rim: outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]

estimated-waiting-time

0..1

There are no (further) constraints on this element

Element id

Observation.component:estimated-waiting-time

Short description

Component results

Definition

Requirements

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: containment by OBX-4?
rim: outBoundRelationship[typeCode=COMP]

0..1

There are no (further) constraints on this element

Element id

Observation.component:estimated-waiting-time.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Observation.component:estimated-waiting-time.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Observation.component:estimated-waiting-time.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

code

1..1

CodeableConceptPattern

Element id

Observation.component:estimated-waiting-time.code

Short description

Type of component observation (code / type)

Definition

Describes what was observed. Sometimes this is called the observation "code".

Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Data type

Binding

Codes identifying names of simple observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://omi.de/fhir/registry/sid/component-codes",
      "code": "estimated-waiting-time"
    }
  ]
}

Mappings

w5: FiveWs.what[x]
sct-concept: < 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|
v2: OBX-3
rim: code

value[x]

1..1

Element id

Observation.component:estimated-waiting-time.value[x]

Short description

Actual component result

Definition

The information determined as a result of making the observation, if the information has a simple value.

Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Slicing

Unordered, Open, by $this(Type)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|

valueCodeableConcept

There are no (further) constraints on this element

Data type

valueString

There are no (further) constraints on this element

Data type

valueBoolean

There are no (further) constraints on this element

Data type

valueInteger

There are no (further) constraints on this element

Data type

valueRange

There are no (further) constraints on this element

Data type

valueRatio

There are no (further) constraints on this element

Data type

valueSampledData

There are no (further) constraints on this element

Data type

valueTime

There are no (further) constraints on this element

Data type

valueDateTime

There are no (further) constraints on this element

Data type

valuePeriod

There are no (further) constraints on this element

Data type

valueQuantity

1..1

Element id

Observation.component:estimated-waiting-time.value[x]:valueQuantity

Short description

Actual component result

Definition

The information determined as a result of making the observation, if the information has a simple value.

Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|

0..1

There are no (further) constraints on this element

Element id

Observation.component:estimated-waiting-time.value[x]:valueQuantity.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Observation.component:estimated-waiting-time.value[x]:valueQuantity.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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()

Mappings

rim: n/a

value

0..1

There are no (further) constraints on this element

Element id

Observation.component:estimated-waiting-time.value[x]:valueQuantity.value

Short description

Numerical value (with implicit precision)

Definition

The value of the measured amount. The value includes an implicit precision in the presentation of the value.

Requirements

Precision is handled implicitly in almost all cases of measurement.

Comments

The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: SN.2 / CQ - N/A
rim: PQ.value, CO.value, MO.value, IVL.high or IVL.low depending on the value

comparator

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

Observation.component:estimated-waiting-time.value[x]:valueQuantity.comparator

Short description

< | <= | >= | > - how to understand the value

Definition

How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.

Requirements

Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.

Meaning when missing

If there is no comparator, then there is no modification of the value

Data type

Binding

How the Quantity should be understood and represented.

QuantityComparator (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: SN.1 / CQ.1
rim: IVL properties

unit

0..1

There are no (further) constraints on this element

Element id

Observation.component:estimated-waiting-time.value[x]:valueQuantity.unit

Short description

Unit representation

Definition

A human-readable form of the unit.

Requirements

There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: (see OBX.6 etc.) / CQ.2
rim: PQ.unit

system

Σ C

0..1

uriPattern

Element id

Observation.component:estimated-waiting-time.value[x]:valueQuantity.system

Short description

System that defines coded unit form

Definition

The identification of the system that provides the coded form of the unit.

Requirements

Need to know the system that defines the coded form of the unit.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: qty-3

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

http://unitsofmeasure.org

Mappings

v2: (see OBX.6 etc.) / CQ.2
rim: CO.codeSystem, PQ.translation.codeSystem

code

0..1

codeBinding

Element id

Observation.component:estimated-waiting-time.value[x]:valueQuantity.code

Short description

Coded form of the unit

Definition

A computer processable form of the unit in some unit representation system.

Requirements

Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.

Comments

The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.

Data type

Binding

UCUMTimeUnitsVS (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: (see OBX.6 etc.) / CQ.2
rim: PQ.code, MO.currency, PQ.translation.code

dataAbsentReason

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:estimated-waiting-time.dataAbsentReason

Short description

Why the component result is missing

Definition

Provides a reason why the expected value in the element Observation.component.value[x] is missing.

Requirements

For many results it is necessary to handle exceptional values in measurements.

Comments

Data type

Binding

Codes specifying why the result (Observation.value[x]) is missing.

Conditions

The cardinality or value of this element may be affected by these constraints: obs-6

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: value.nullFlavor

interpretation

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:estimated-waiting-time.interpretation

Short description

High, low, normal, etc.

Alternate names

Abnormal Flag

Definition

A categorical assessment of an observation value. For example, high, low, normal.

Requirements

For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.

Comments

Data type

Binding

Codes identifying interpretations of observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: < 260245000 |Findings values|
v2: OBX-8
rim: interpretationCode
sct-attr: 363713009 |Has interpretation|

referenceRange

0..*

There are no (further) constraints on this element

Element id

Observation.component:estimated-waiting-time.referenceRange

Short description

Provides guide for interpretation of component result

Definition

Guidance on how to interpret the value by comparison to a normal or recommended range.

Requirements

Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: OBX.7
rim: outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]

inference-price

0..1

There are no (further) constraints on this element

Element id

Observation.component:inference-price

Short description

Component results

Definition

Requirements

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: containment by OBX-4?
rim: outBoundRelationship[typeCode=COMP]

0..1

There are no (further) constraints on this element

Element id

Observation.component:inference-price.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Observation.component:inference-price.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Observation.component:inference-price.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

code

1..1

CodeableConceptPattern

Element id

Observation.component:inference-price.code

Short description

Type of component observation (code / type)

Definition

Describes what was observed. Sometimes this is called the observation "code".

Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Data type

Binding

Codes identifying names of simple observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://omi.de/fhir/registry/sid/component-codes",
      "code": "inference-price"
    }
  ]
}

Mappings

w5: FiveWs.what[x]
sct-concept: < 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|
v2: OBX-3
rim: code

value[x]

1..1

Element id

Observation.component:inference-price.value[x]

Short description

Actual component result

Definition

The information determined as a result of making the observation, if the information has a simple value.

Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Slicing

Unordered, Open, by $this(Type)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|

valueCodeableConcept

There are no (further) constraints on this element

Data type

valueString

There are no (further) constraints on this element

Data type

valueBoolean

There are no (further) constraints on this element

Data type

valueInteger

There are no (further) constraints on this element

Data type

valueRange

There are no (further) constraints on this element

Data type

valueRatio

There are no (further) constraints on this element

Data type

valueSampledData

There are no (further) constraints on this element

Data type

valueTime

There are no (further) constraints on this element

Data type

valueDateTime

There are no (further) constraints on this element

Data type

valuePeriod

There are no (further) constraints on this element

Data type

valueQuantity

1..1

Element id

Observation.component:inference-price.value[x]:valueQuantity

Short description

Actual component result

Definition

The information determined as a result of making the observation, if the information has a simple value.

Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|

0..1

There are no (further) constraints on this element

Element id

Observation.component:inference-price.value[x]:valueQuantity.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Observation.component:inference-price.value[x]:valueQuantity.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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()

Mappings

rim: n/a

value

0..1

There are no (further) constraints on this element

Element id

Observation.component:inference-price.value[x]:valueQuantity.value

Short description

Numerical value (with implicit precision)

Definition

The value of the measured amount. The value includes an implicit precision in the presentation of the value.

Requirements

Precision is handled implicitly in almost all cases of measurement.

Comments

The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: SN.2 / CQ - N/A
rim: PQ.value, CO.value, MO.value, IVL.high or IVL.low depending on the value

comparator

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

Observation.component:inference-price.value[x]:valueQuantity.comparator

Short description

< | <= | >= | > - how to understand the value

Definition

Requirements

Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.

Meaning when missing

If there is no comparator, then there is no modification of the value

Data type

Binding

How the Quantity should be understood and represented.

QuantityComparator (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: SN.1 / CQ.1
rim: IVL properties

unit

0..1

There are no (further) constraints on this element

Element id

Observation.component:inference-price.value[x]:valueQuantity.unit

Short description

Unit representation

Definition

A human-readable form of the unit.

Requirements

There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: (see OBX.6 etc.) / CQ.2
rim: PQ.unit

system

Σ C

0..1

uriPattern

Element id

Observation.component:inference-price.value[x]:valueQuantity.system

Short description

System that defines coded unit form

Definition

The identification of the system that provides the coded form of the unit.

Requirements

Need to know the system that defines the coded form of the unit.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: qty-3

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

urn:iso:std:iso:4217

Mappings

v2: (see OBX.6 etc.) / CQ.2
rim: CO.codeSystem, PQ.translation.codeSystem

code

0..1

codePattern

Element id

Observation.component:inference-price.value[x]:valueQuantity.code

Short description

Coded form of the unit

Definition

A computer processable form of the unit in some unit representation system.

Requirements

Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.

Comments

The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

EUR

Mappings

v2: (see OBX.6 etc.) / CQ.2
rim: PQ.code, MO.currency, PQ.translation.code

dataAbsentReason

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:inference-price.dataAbsentReason

Short description

Why the component result is missing

Definition

Provides a reason why the expected value in the element Observation.component.value[x] is missing.

Requirements

For many results it is necessary to handle exceptional values in measurements.

Comments

Data type

Binding

Codes specifying why the result (Observation.value[x]) is missing.

Conditions

The cardinality or value of this element may be affected by these constraints: obs-6

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: value.nullFlavor

interpretation

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:inference-price.interpretation

Short description

High, low, normal, etc.

Alternate names

Abnormal Flag

Definition

A categorical assessment of an observation value. For example, high, low, normal.

Requirements

For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.

Comments

Data type

Binding

Codes identifying interpretations of observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: < 260245000 |Findings values|
v2: OBX-8
rim: interpretationCode
sct-attr: 363713009 |Has interpretation|

referenceRange

0..*

OmiServiceInputParameters

There are no (further) constraints on this element

Element id

Observation.component:inference-price.referenceRange

Short description

Provides guide for interpretation of component result

Definition

Guidance on how to interpret the value by comparison to a normal or recommended range.

Requirements

Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: OBX.7
rim: outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]

Example

Observation

id : GbmHeartbeatObservationExample

meta

profile : http://omi.de/fhir/registry/StructureDefinition/HeartbeatObservationProfile

extension

url : hash

value : b7edda3172c39fe8754d607f2182047479b05d31406009cdcf1183970f5397a4

extension

url : type

value

coding

code : SHA-256

system : http://terminology.hl7.org/CodeSystem/v3-IntegrityCheckAlgorithm

display : secure hash algorithm - 256

url : http://omi.de/fhir/registry/StructureDefinition/build-hash-extension

component

code

coding

code : statuscode

system : http://omi.de/fhir/registry/sid/component-codes

display : Service Status

value

coding

code : inference-ready

system : http://omi.de/fhir/registry/CodeSystem/AiServiceStatusCodesCS

display : Service is available and ready to apply inference

component

code

coding

code : queue-length

system : http://omi.de/fhir/registry/sid/component-codes

display : Queue Length

value : 8

component

value

value : 20

unit : minutes

system : http://unitsofmeasure.org

code : min

code

coding

code : estimated-waiting-time

system : http://omi.de/fhir/registry/sid/component-codes

display : Estimated Waiting Time

component

value

value : 8

system : urn:iso:std:iso:4217

code : EUR

code

coding

code : inference-price

system : http://omi.de/fhir/registry/sid/component-codes

display : Inference Price

code

coding

code : C0449438

system : http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl

display : Status

status : amended

Input Parameters

Description

Inputs for the GBM algorithm contain an image (Binary resource) and optional structured metainformation (ImagingStudy resource).

Profile

GbmServiceInputParameters (Parameters)

There are no (further) constraints on this element

Element id

Parameters

Short description

Operation Request or Response

Definition

This resource is a non-persisted resource used to pass information into and back from an operation. It has no other use, and there is no RESTful endpoint associated with it.

Comments

The parameters that may be used are defined by the OperationDefinition resource.

Data type

OmiServiceInputParameters

Mappings

rim: Entity. Role, or Act
v2: n/a
rim: n/a

0..1

There are no (further) constraints on this element

Element id

Parameters.id

Short description

Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

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.

Data type

meta

0..1

There are no (further) constraints on this element

Element id

Parameters.meta

Short description

Metadata about the resource

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.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

implicitRules

Σ ?!

0..1

There are no (further) constraints on this element

Element id

Parameters.implicitRules

Short description

A set of rules under which this content was created

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

language

0..1

codeBinding

There are no (further) constraints on this element

Element id

Parameters.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Data type

Binding

A human language.

Binding extensions

maxValueSet	AllLanguages

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

parameter

S Σ C

1..*

There are no (further) constraints on this element

Element id

Parameters.parameter

Short description

Operation Parameter

Definition

A parameter passed to or received from the operation.

Data type

Slicing

Unordered, Open, by name(Pattern)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
inv-1: A parameter must have one and only one of (value, resource, part)
(part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))

(All Slices)

The requirements in this element apply to all slices

0..1

There are no (further) constraints on this element

Element id

Parameters.parameter.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

S C

0..*

There are no (further) constraints on this element

Element id

Parameters.parameter.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

http://omi.de/fhir/registry/StructureDefinition/input-parameter-query-extension

Slicing

Unordered, Open, by url(Value)

Constraints

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()

Mappings

rim: n/a

parameterQueryExtension

S C

0..1

Extension(Complex)

There are no (further) constraints on this element

Element id

Parameters.parameter.extension:parameterQueryExtension

Short description

Service Input Parameter Query Extension

Alternate names

extensions, user content

Definition

Extension to document how to get the value for a certain parameter.

Comments

Data type

Extension(Complex)

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Parameters.parameter.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

name

S Σ

1..1

There are no (further) constraints on this element

Element id

Parameters.parameter.name

Short description

Name from the definition

Definition

The name of the parameter (reference to the operation definition).

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

value[x]

S Σ C

0..1

There are no (further) constraints on this element

Element id

Parameters.parameter.value[x]

Short description

If parameter is a data type

Definition

If the parameter is a data type.

Conditions

The cardinality or value of this element may be affected by these constraints: inv-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

valueBase64Binary

There are no (further) constraints on this element

Data type

valueBoolean

There are no (further) constraints on this element

Data type

valueCanonical

There are no (further) constraints on this element

Data type

valueCode

There are no (further) constraints on this element

Data type

valueDate

There are no (further) constraints on this element

Data type

valueDateTime

There are no (further) constraints on this element

Data type

valueDecimal

There are no (further) constraints on this element

Data type

valueId

There are no (further) constraints on this element

Data type

valueInstant

There are no (further) constraints on this element

Data type

valueInteger

There are no (further) constraints on this element

Data type

valueMarkdown

There are no (further) constraints on this element

Data type

valueOid

There are no (further) constraints on this element

Data type

valuePositiveInt

There are no (further) constraints on this element

Data type

valueString

There are no (further) constraints on this element

Data type

valueTime

There are no (further) constraints on this element

Data type

valueUnsignedInt

There are no (further) constraints on this element

Data type

valueUri

There are no (further) constraints on this element

Data type

valueUrl

There are no (further) constraints on this element

Data type

valueUuid

There are no (further) constraints on this element

Data type

valueAddress

There are no (further) constraints on this element

Data type

valueAge

There are no (further) constraints on this element

Data type

valueAnnotation

There are no (further) constraints on this element

Data type

valueAttachment

There are no (further) constraints on this element

Data type

valueCodeableConcept

There are no (further) constraints on this element

Data type

valueCoding

There are no (further) constraints on this element

Data type

valueContactPoint

There are no (further) constraints on this element

Data type

valueCount

There are no (further) constraints on this element

Data type

valueDistance

There are no (further) constraints on this element

Data type

valueDuration

There are no (further) constraints on this element

Data type

valueHumanName

There are no (further) constraints on this element

Data type

valueIdentifier

There are no (further) constraints on this element

Data type

valueMoney

There are no (further) constraints on this element

Data type

valuePeriod

There are no (further) constraints on this element

Data type

valueQuantity

There are no (further) constraints on this element

Data type

valueRange

There are no (further) constraints on this element

Data type

valueRatio

There are no (further) constraints on this element

Data type

valueSampledData

There are no (further) constraints on this element

Data type

valueSignature

There are no (further) constraints on this element

Data type

valueTiming

There are no (further) constraints on this element

Data type

valueContactDetail

There are no (further) constraints on this element

Data type

valueContributor

There are no (further) constraints on this element

Data type

valueDataRequirement

There are no (further) constraints on this element

Data type

valueExpression

There are no (further) constraints on this element

Data type

valueParameterDefinition

There are no (further) constraints on this element

Data type

valueRelatedArtifact

There are no (further) constraints on this element

Data type

valueTriggerDefinition

There are no (further) constraints on this element

Data type

valueUsageContext

There are no (further) constraints on this element

Data type

valueDosage

There are no (further) constraints on this element

Data type

valueMeta

There are no (further) constraints on this element

Data type

valueReference

There are no (further) constraints on this element

Data type

resource

S Σ C

0..1

There are no (further) constraints on this element

Element id

Parameters.parameter.resource

Short description

If parameter is a whole resource

Definition

If the parameter is a whole resource.

Comments

When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: inv-1

part

S Σ

0..*

There are no (further) constraints on this element

Element id

Parameters.parameter.part

Short description

Named part of a multi-part parameter

Definition

A named part of a multi-part parameter.

Comments

Only one level of nested parameters is allowed.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

There are no (further) constraints on this element

Element id

Parameters.parameter.part.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

S C

0..*

There are no (further) constraints on this element

Element id

Parameters.parameter.part.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

http://omi.de/fhir/registry/StructureDefinition/input-parameter-query-extension

Slicing

Unordered, Open, by url(Value)

Constraints

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()

Mappings

rim: n/a

parameterQueryExtension

S C

0..1

Extension(Complex)

There are no (further) constraints on this element

Element id

Parameters.parameter.part.extension:parameterQueryExtension

Short description

Service Input Parameter Query Extension

Alternate names

extensions, user content

Definition

Extension to document how to get the value for a certain parameter.

Comments

Data type

Extension(Complex)

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Parameters.parameter.part.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

name

S Σ

1..1

There are no (further) constraints on this element

Element id

Parameters.parameter.part.name

Short description

Name from the definition

Definition

The name of the parameter (reference to the operation definition).

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

value[x]

S Σ C

0..1

There are no (further) constraints on this element

Element id

Parameters.parameter.part.value[x]

Short description

If parameter is a data type

Definition

If the parameter is a data type.

Conditions

The cardinality or value of this element may be affected by these constraints: inv-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

valueBase64Binary

There are no (further) constraints on this element

Data type

valueBoolean

There are no (further) constraints on this element

Data type

valueCanonical

There are no (further) constraints on this element

Data type

valueCode

There are no (further) constraints on this element

Data type

valueDate

There are no (further) constraints on this element

Data type

valueDateTime

There are no (further) constraints on this element

Data type

valueDecimal

There are no (further) constraints on this element

Data type

valueId

There are no (further) constraints on this element

Data type

valueInstant

There are no (further) constraints on this element

Data type

valueInteger

There are no (further) constraints on this element

Data type

valueMarkdown

There are no (further) constraints on this element

Data type

valueOid

There are no (further) constraints on this element

Data type

valuePositiveInt

There are no (further) constraints on this element

Data type

valueString

There are no (further) constraints on this element

Data type

valueTime

There are no (further) constraints on this element

Data type

valueUnsignedInt

There are no (further) constraints on this element

Data type

valueUri

There are no (further) constraints on this element

Data type

valueUrl

There are no (further) constraints on this element

Data type

valueUuid

There are no (further) constraints on this element

Data type

valueAddress

There are no (further) constraints on this element

Data type

valueAge

There are no (further) constraints on this element

Data type

valueAnnotation

There are no (further) constraints on this element

Data type

valueAttachment

There are no (further) constraints on this element

Data type

valueCodeableConcept

There are no (further) constraints on this element

Data type

valueCoding

There are no (further) constraints on this element

Data type

valueContactPoint

There are no (further) constraints on this element

Data type

valueCount

There are no (further) constraints on this element

Data type

valueDistance

There are no (further) constraints on this element

Data type

valueDuration

There are no (further) constraints on this element

Data type

valueHumanName

There are no (further) constraints on this element

Data type

valueIdentifier

There are no (further) constraints on this element

Data type

valueMoney

There are no (further) constraints on this element

Data type

valuePeriod

There are no (further) constraints on this element

Data type

valueQuantity

There are no (further) constraints on this element

Data type

valueRange

There are no (further) constraints on this element

Data type

valueRatio

There are no (further) constraints on this element

Data type

valueSampledData

There are no (further) constraints on this element

Data type

valueSignature

There are no (further) constraints on this element

Data type

valueTiming

There are no (further) constraints on this element

Data type

valueContactDetail

There are no (further) constraints on this element

Data type

valueContributor

There are no (further) constraints on this element

Data type

valueDataRequirement

There are no (further) constraints on this element

Data type

valueExpression

There are no (further) constraints on this element

Data type

valueParameterDefinition

There are no (further) constraints on this element

Data type

valueRelatedArtifact

There are no (further) constraints on this element

Data type

valueTriggerDefinition

There are no (further) constraints on this element

Data type

valueUsageContext

There are no (further) constraints on this element

Data type

valueDosage

There are no (further) constraints on this element

Data type

valueMeta

There are no (further) constraints on this element

Data type

valueReference

There are no (further) constraints on this element

Data type

resource

S Σ C

0..1

There are no (further) constraints on this element

Element id

Parameters.parameter.part.resource

Short description

If parameter is a whole resource

Definition

If the parameter is a whole resource.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: inv-1

part

0..*

see (parameter)

There are no (further) constraints on this element

Element id

Parameters.parameter.part.part

Short description

Named part of a multi-part parameter

Definition

A named part of a multi-part parameter.

Comments

Only one level of nested parameters is allowed.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

image

S Σ C

0..*

There are no (further) constraints on this element

Element id

Parameters.parameter:image

Short description

Operation Parameter

Definition

A parameter passed to or received from the operation.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
inv-1: A parameter must have one and only one of (value, resource, part)
(part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))

0..1

There are no (further) constraints on this element

Element id

Parameters.parameter:image.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Parameters.parameter:image.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

http://omi.de/fhir/registry/StructureDefinition/input-parameter-query-extension

Slicing

Unordered, Open, by url(Value)

Constraints

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()

Mappings

rim: n/a

parameterQueryExtension

S C

0..1

Extension(Complex)

There are no (further) constraints on this element

Element id

Parameters.parameter:image.extension:parameterQueryExtension

Short description

Service Input Parameter Query Extension

Alternate names

extensions, user content

Definition

Extension to document how to get the value for a certain parameter.

Comments

Data type

Extension(Complex)

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Parameters.parameter:image.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

name

1..1

stringPattern

There are no (further) constraints on this element

Element id

Parameters.parameter:image.name

Short description

Name from the definition

Definition

The name of the parameter (reference to the operation definition).

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

image

value[x]

Σ C

0..1

There are no (further) constraints on this element

Element id

Parameters.parameter:image.value[x]

Short description

If parameter is a data type

Definition

If the parameter is a data type.

Conditions

The cardinality or value of this element may be affected by these constraints: inv-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

valueBase64Binary

There are no (further) constraints on this element

Data type

valueBoolean

There are no (further) constraints on this element

Data type

valueCanonical

There are no (further) constraints on this element

Data type

valueCode

There are no (further) constraints on this element

Data type

valueDate

There are no (further) constraints on this element

Data type

valueDateTime

There are no (further) constraints on this element

Data type

valueDecimal

There are no (further) constraints on this element

Data type

valueId

There are no (further) constraints on this element

Data type

valueInstant

There are no (further) constraints on this element

Data type

valueInteger

There are no (further) constraints on this element

Data type

valueMarkdown

There are no (further) constraints on this element

Data type

valueOid

There are no (further) constraints on this element

Data type

valuePositiveInt

There are no (further) constraints on this element

Data type

valueString

There are no (further) constraints on this element

Data type

valueTime

There are no (further) constraints on this element

Data type

valueUnsignedInt

There are no (further) constraints on this element

Data type

valueUri

There are no (further) constraints on this element

Data type

valueUrl

There are no (further) constraints on this element

Data type

valueUuid

There are no (further) constraints on this element

Data type

valueAddress

There are no (further) constraints on this element

Data type

valueAge

There are no (further) constraints on this element

Data type

valueAnnotation

There are no (further) constraints on this element

Data type

valueAttachment

There are no (further) constraints on this element

Data type

valueCodeableConcept

There are no (further) constraints on this element

Data type

valueCoding

There are no (further) constraints on this element

Data type

valueContactPoint

There are no (further) constraints on this element

Data type

valueCount

There are no (further) constraints on this element

Data type

valueDistance

There are no (further) constraints on this element

Data type

valueDuration

There are no (further) constraints on this element

Data type

valueHumanName

There are no (further) constraints on this element

Data type

valueIdentifier

There are no (further) constraints on this element

Data type

valueMoney

There are no (further) constraints on this element

Data type

valuePeriod

There are no (further) constraints on this element

Data type

valueQuantity

There are no (further) constraints on this element

Data type

valueRange

There are no (further) constraints on this element

Data type

valueRatio

There are no (further) constraints on this element

Data type

valueSampledData

There are no (further) constraints on this element

Data type

valueSignature

There are no (further) constraints on this element

Data type

valueTiming

There are no (further) constraints on this element

Data type

valueContactDetail

There are no (further) constraints on this element

Data type

valueContributor

There are no (further) constraints on this element

Data type

valueDataRequirement

There are no (further) constraints on this element

Data type

valueExpression

There are no (further) constraints on this element

Data type

valueParameterDefinition

There are no (further) constraints on this element

Data type

valueRelatedArtifact

There are no (further) constraints on this element

Data type

valueTriggerDefinition

There are no (further) constraints on this element

Data type

valueUsageContext

There are no (further) constraints on this element

Data type

valueDosage

There are no (further) constraints on this element

Data type

valueMeta

There are no (further) constraints on this element

Data type

valueReference

There are no (further) constraints on this element

Data type

resource

1..1

There are no (further) constraints on this element

Element id

Parameters.parameter:image.resource

Short description

A reference to a document

Definition

A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a document is any seralized object with a mime-type, so includes formal patient centric documents (CDA), cliical notes, scanned paper, and non-patient specific documents like policy text.

Comments

Usually, this is used for documents other than those defined by FHIR.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: inv-1

Constraints

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()

Mappings

rim: Entity. Role, or Act
workflow: Event
fhircomposition: when describing a Composition
rim: Document[classCode="DOC" and moodCode="EVN"]
cda: when describing a CDA

part

0..*

see (parameter)

There are no (further) constraints on this element

Element id

Parameters.parameter:image.part

Short description

Named part of a multi-part parameter

Definition

A named part of a multi-part parameter.

Comments

Only one level of nested parameters is allowed.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

There are no (further) constraints on this element

Element id

Parameters.parameter:image.part.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Parameters.parameter:image.part.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

http://omi.de/fhir/registry/StructureDefinition/input-parameter-query-extension

Slicing

Unordered, Open, by url(Value)

Constraints

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()

Mappings

rim: n/a

parameterQueryExtension

S C

0..1

Extension(Complex)

There are no (further) constraints on this element

Element id

Parameters.parameter:image.part.extension:parameterQueryExtension

Short description

Service Input Parameter Query Extension

Alternate names

extensions, user content

Definition

Extension to document how to get the value for a certain parameter.

Comments

Data type

Extension(Complex)

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Parameters.parameter:image.part.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

name

1..1

There are no (further) constraints on this element

Element id

Parameters.parameter:image.part.name

Short description

Name from the definition

Definition

The name of the parameter (reference to the operation definition).

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

value[x]

Σ C

0..1

There are no (further) constraints on this element

Element id

Parameters.parameter:image.part.value[x]

Short description

If parameter is a data type

Definition

If the parameter is a data type.

Conditions

The cardinality or value of this element may be affected by these constraints: inv-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

valueBase64Binary

There are no (further) constraints on this element

Data type

valueBoolean

There are no (further) constraints on this element

Data type

valueCanonical

There are no (further) constraints on this element

Data type

valueCode

There are no (further) constraints on this element

Data type

valueDate

There are no (further) constraints on this element

Data type

valueDateTime

There are no (further) constraints on this element

Data type

valueDecimal

There are no (further) constraints on this element

Data type

valueId

There are no (further) constraints on this element

Data type

valueInstant

There are no (further) constraints on this element

Data type

valueInteger

There are no (further) constraints on this element

Data type

valueMarkdown

There are no (further) constraints on this element

Data type

valueOid

There are no (further) constraints on this element

Data type

valuePositiveInt

There are no (further) constraints on this element

Data type

valueString

There are no (further) constraints on this element

Data type

valueTime

There are no (further) constraints on this element

Data type

valueUnsignedInt

There are no (further) constraints on this element

Data type

valueUri

There are no (further) constraints on this element

Data type

valueUrl

There are no (further) constraints on this element

Data type

valueUuid

There are no (further) constraints on this element

Data type

valueAddress

There are no (further) constraints on this element

Data type

valueAge

There are no (further) constraints on this element

Data type

valueAnnotation

There are no (further) constraints on this element

Data type

valueAttachment

There are no (further) constraints on this element

Data type

valueCodeableConcept

There are no (further) constraints on this element

Data type

valueCoding

There are no (further) constraints on this element

Data type

valueContactPoint

There are no (further) constraints on this element

Data type

valueCount

There are no (further) constraints on this element

Data type

valueDistance

There are no (further) constraints on this element

Data type

valueDuration

There are no (further) constraints on this element

Data type

valueHumanName

There are no (further) constraints on this element

Data type

valueIdentifier

There are no (further) constraints on this element

Data type

valueMoney

There are no (further) constraints on this element

Data type

valuePeriod

There are no (further) constraints on this element

Data type

valueQuantity

There are no (further) constraints on this element

Data type

valueRange

There are no (further) constraints on this element

Data type

valueRatio

There are no (further) constraints on this element

Data type

valueSampledData

There are no (further) constraints on this element

Data type

valueSignature

There are no (further) constraints on this element

Data type

valueTiming

There are no (further) constraints on this element

Data type

valueContactDetail

There are no (further) constraints on this element

Data type

valueContributor

There are no (further) constraints on this element

Data type

valueDataRequirement

There are no (further) constraints on this element

Data type

valueExpression

There are no (further) constraints on this element

Data type

valueParameterDefinition

There are no (further) constraints on this element

Data type

valueRelatedArtifact

There are no (further) constraints on this element

Data type

valueTriggerDefinition

There are no (further) constraints on this element

Data type

valueUsageContext

There are no (further) constraints on this element

Data type

valueDosage

There are no (further) constraints on this element

Data type

valueMeta

There are no (further) constraints on this element

Data type

valueReference

There are no (further) constraints on this element

Data type

resource

Σ C

0..1

There are no (further) constraints on this element

Element id

Parameters.parameter:image.part.resource

Short description

If parameter is a whole resource

Definition

If the parameter is a whole resource.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: inv-1

part

0..*

see (parameter)

There are no (further) constraints on this element

Element id

Parameters.parameter:image.part.part

Short description

Named part of a multi-part parameter

Definition

A named part of a multi-part parameter.

Comments

Only one level of nested parameters is allowed.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

imagingStudy

S Σ C

0..*

There are no (further) constraints on this element

Element id

Parameters.parameter:imagingStudy

Short description

Operation Parameter

Definition

A parameter passed to or received from the operation.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
inv-1: A parameter must have one and only one of (value, resource, part)
(part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))

0..1

There are no (further) constraints on this element

Element id

Parameters.parameter:imagingStudy.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Parameters.parameter:imagingStudy.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

http://omi.de/fhir/registry/StructureDefinition/input-parameter-query-extension

Slicing

Unordered, Open, by url(Value)

Constraints

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()

Mappings

rim: n/a

parameterQueryExtension

S C

0..1

Extension(Complex)

There are no (further) constraints on this element

Element id

Parameters.parameter:imagingStudy.extension:parameterQueryExtension

Short description

Service Input Parameter Query Extension

Alternate names

extensions, user content

Definition

Extension to document how to get the value for a certain parameter.

Comments

Data type

Extension(Complex)

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Parameters.parameter:imagingStudy.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

name

1..1

stringPattern

There are no (further) constraints on this element

Element id

Parameters.parameter:imagingStudy.name

Short description

Name from the definition

Definition

The name of the parameter (reference to the operation definition).

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

imagingStudy

value[x]

Σ C

0..1

There are no (further) constraints on this element

Element id

Parameters.parameter:imagingStudy.value[x]

Short description

If parameter is a data type

Definition

If the parameter is a data type.

Conditions

The cardinality or value of this element may be affected by these constraints: inv-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

valueBase64Binary

There are no (further) constraints on this element

Data type

valueBoolean

There are no (further) constraints on this element

Data type

valueCanonical

There are no (further) constraints on this element

Data type

valueCode

There are no (further) constraints on this element

Data type

valueDate

There are no (further) constraints on this element

Data type

valueDateTime

There are no (further) constraints on this element

Data type

valueDecimal

There are no (further) constraints on this element

Data type

valueId

There are no (further) constraints on this element

Data type

valueInstant

There are no (further) constraints on this element

Data type

valueInteger

There are no (further) constraints on this element

Data type

valueMarkdown

There are no (further) constraints on this element

Data type

valueOid

There are no (further) constraints on this element

Data type

valuePositiveInt

There are no (further) constraints on this element

Data type

valueString

There are no (further) constraints on this element

Data type

valueTime

There are no (further) constraints on this element

Data type

valueUnsignedInt

There are no (further) constraints on this element

Data type

valueUri

There are no (further) constraints on this element

Data type

valueUrl

There are no (further) constraints on this element

Data type

valueUuid

There are no (further) constraints on this element

Data type

valueAddress

There are no (further) constraints on this element

Data type

valueAge

There are no (further) constraints on this element

Data type

valueAnnotation

There are no (further) constraints on this element

Data type

valueAttachment

There are no (further) constraints on this element

Data type

valueCodeableConcept

There are no (further) constraints on this element

Data type

valueCoding

There are no (further) constraints on this element

Data type

valueContactPoint

There are no (further) constraints on this element

Data type

valueCount

There are no (further) constraints on this element

Data type

valueDistance

There are no (further) constraints on this element

Data type

valueDuration

There are no (further) constraints on this element

Data type

valueHumanName

There are no (further) constraints on this element

Data type

valueIdentifier

There are no (further) constraints on this element

Data type

valueMoney

There are no (further) constraints on this element

Data type

valuePeriod

There are no (further) constraints on this element

Data type

valueQuantity

There are no (further) constraints on this element

Data type

valueRange

There are no (further) constraints on this element

Data type

valueRatio

There are no (further) constraints on this element

Data type

valueSampledData

There are no (further) constraints on this element

Data type

valueSignature

There are no (further) constraints on this element

Data type

valueTiming

There are no (further) constraints on this element

Data type

valueContactDetail

There are no (further) constraints on this element

Data type

valueContributor

There are no (further) constraints on this element

Data type

valueDataRequirement

There are no (further) constraints on this element

Data type

valueExpression

There are no (further) constraints on this element

Data type

valueParameterDefinition

There are no (further) constraints on this element

Data type

valueRelatedArtifact

There are no (further) constraints on this element

Data type

valueTriggerDefinition

There are no (further) constraints on this element

Data type

valueUsageContext

There are no (further) constraints on this element

Data type

valueDosage

There are no (further) constraints on this element

Data type

valueMeta

There are no (further) constraints on this element

Data type

valueReference

There are no (further) constraints on this element

Data type

MII_PR_Bildgebung_Bildgebungsstudie

resource

1..1

There are no (further) constraints on this element

Element id

Parameters.parameter:imagingStudy.resource

Short description

A set of images produced in single study (one or more series of references images)

Definition

Representation of the content produced in a DICOM imaging study. A study comprises a set of series, each of which includes a set of Service-Object Pair Instances (SOP Instances - images or other data) acquired or produced in a common context. A series is of only one modality (e.g. X-ray, CT, MR, ultrasound), but a study may have multiple series of different modalities.

Comments

Data type

MII_PR_Bildgebung_Bildgebungsstudie

Conditions

The cardinality or value of this element may be affected by these constraints: inv-1

Constraints

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()

Mappings

rim: Entity. Role, or Act
workflow: Event
rim: Act[classCode=COMPOSITION, moodCode=EVN]
dicom: Reference IHE radiology TF vol 2 table 4.14-1

part

0..*

see (parameter)

There are no (further) constraints on this element

Element id

Parameters.parameter:imagingStudy.part

Short description

Named part of a multi-part parameter

Definition

A named part of a multi-part parameter.

Comments

Only one level of nested parameters is allowed.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

There are no (further) constraints on this element

Element id

Parameters.parameter:imagingStudy.part.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Parameters.parameter:imagingStudy.part.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

http://omi.de/fhir/registry/StructureDefinition/input-parameter-query-extension

Slicing

Unordered, Open, by url(Value)

Constraints

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()

Mappings

rim: n/a

parameterQueryExtension

S C

0..1

Extension(Complex)

There are no (further) constraints on this element

Element id

Parameters.parameter:imagingStudy.part.extension:parameterQueryExtension

Short description

Service Input Parameter Query Extension

Alternate names

extensions, user content

Definition

Extension to document how to get the value for a certain parameter.

Comments

Data type

Extension(Complex)

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Parameters.parameter:imagingStudy.part.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

name

1..1

There are no (further) constraints on this element

Element id

Parameters.parameter:imagingStudy.part.name

Short description

Name from the definition

Definition

The name of the parameter (reference to the operation definition).

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

value[x]

Σ C

0..1

There are no (further) constraints on this element

Element id

Parameters.parameter:imagingStudy.part.value[x]

Short description

If parameter is a data type

Definition

If the parameter is a data type.

Conditions

The cardinality or value of this element may be affected by these constraints: inv-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

valueBase64Binary

There are no (further) constraints on this element

Data type

valueBoolean

There are no (further) constraints on this element

Data type

valueCanonical

There are no (further) constraints on this element

Data type

valueCode

There are no (further) constraints on this element

Data type

valueDate

There are no (further) constraints on this element

Data type

valueDateTime

There are no (further) constraints on this element

Data type

valueDecimal

There are no (further) constraints on this element

Data type

valueId

There are no (further) constraints on this element

Data type

valueInstant

There are no (further) constraints on this element

Data type

valueInteger

There are no (further) constraints on this element

Data type

valueMarkdown

There are no (further) constraints on this element

Data type

valueOid

There are no (further) constraints on this element

Data type

valuePositiveInt

There are no (further) constraints on this element

Data type

valueString

There are no (further) constraints on this element

Data type

valueTime

There are no (further) constraints on this element

Data type

valueUnsignedInt

There are no (further) constraints on this element

Data type

valueUri

There are no (further) constraints on this element

Data type

valueUrl

There are no (further) constraints on this element

Data type

valueUuid

There are no (further) constraints on this element

Data type

valueAddress

There are no (further) constraints on this element

Data type

valueAge

There are no (further) constraints on this element

Data type

valueAnnotation

There are no (further) constraints on this element

Data type

valueAttachment

There are no (further) constraints on this element

Data type

valueCodeableConcept

There are no (further) constraints on this element

Data type

valueCoding

There are no (further) constraints on this element

Data type

valueContactPoint

There are no (further) constraints on this element

Data type

valueCount

There are no (further) constraints on this element

Data type

valueDistance

There are no (further) constraints on this element

Data type

valueDuration

There are no (further) constraints on this element

Data type

valueHumanName

There are no (further) constraints on this element

Data type

valueIdentifier

There are no (further) constraints on this element

Data type

valueMoney

There are no (further) constraints on this element

Data type

valuePeriod

There are no (further) constraints on this element

Data type

valueQuantity

There are no (further) constraints on this element

Data type

valueRange

There are no (further) constraints on this element

Data type

valueRatio

There are no (further) constraints on this element

Data type

valueSampledData

There are no (further) constraints on this element

Data type

valueSignature

There are no (further) constraints on this element

Data type

valueTiming

There are no (further) constraints on this element

Data type

valueContactDetail

There are no (further) constraints on this element

Data type

valueContributor

There are no (further) constraints on this element

Data type

valueDataRequirement

There are no (further) constraints on this element

Data type

valueExpression

There are no (further) constraints on this element

Data type

valueParameterDefinition

There are no (further) constraints on this element

Data type

valueRelatedArtifact

There are no (further) constraints on this element

Data type

valueTriggerDefinition

There are no (further) constraints on this element

Data type

valueUsageContext

There are no (further) constraints on this element

Data type

valueDosage

There are no (further) constraints on this element

Data type

valueMeta

There are no (further) constraints on this element

Data type

valueReference

There are no (further) constraints on this element

Data type

resource

Σ C

0..1

There are no (further) constraints on this element

Element id

Parameters.parameter:imagingStudy.part.resource

Short description

If parameter is a whole resource

Definition

If the parameter is a whole resource.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: inv-1

part

0..*

see (parameter)

There are no (further) constraints on this element

Element id

Parameters.parameter:imagingStudy.part.part

Short description

Named part of a multi-part parameter

Definition

A named part of a multi-part parameter.

Comments

Only one level of nested parameters is allowed.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

image-binary

S Σ C

0..*

There are no (further) constraints on this element

Element id

Parameters.parameter:image-binary

Short description

Operation Parameter

Definition

A parameter passed to or received from the operation.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
inv-1: A parameter must have one and only one of (value, resource, part)
(part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))

0..1

There are no (further) constraints on this element

Element id

Parameters.parameter:image-binary.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Parameters.parameter:image-binary.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

http://omi.de/fhir/registry/StructureDefinition/input-parameter-query-extension

Slicing

Unordered, Open, by url(Value)

Constraints

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()

Mappings

rim: n/a

parameterQueryExtension

S C

0..1

Extension(Complex)

There are no (further) constraints on this element

Element id

Parameters.parameter:image-binary.extension:parameterQueryExtension

Short description

Service Input Parameter Query Extension

Alternate names

extensions, user content

Definition

Extension to document how to get the value for a certain parameter.

Comments

Data type

Extension(Complex)

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Parameters.parameter:image-binary.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

name

1..1

stringPattern

There are no (further) constraints on this element

Element id

Parameters.parameter:image-binary.name

Short description

Name from the definition

Definition

The name of the parameter (reference to the operation definition).

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

image-binary

value[x]

Σ C

0..1

There are no (further) constraints on this element

Element id

Parameters.parameter:image-binary.value[x]

Short description

If parameter is a data type

Definition

If the parameter is a data type.

Conditions

The cardinality or value of this element may be affected by these constraints: inv-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

valueBase64Binary

There are no (further) constraints on this element

Data type

valueBoolean

There are no (further) constraints on this element

Data type

valueCanonical

There are no (further) constraints on this element

Data type

valueCode

There are no (further) constraints on this element

Data type

valueDate

There are no (further) constraints on this element

Data type

valueDateTime

There are no (further) constraints on this element

Data type

valueDecimal

There are no (further) constraints on this element

Data type

valueId

There are no (further) constraints on this element

Data type

valueInstant

There are no (further) constraints on this element

Data type

valueInteger

There are no (further) constraints on this element

Data type

valueMarkdown

There are no (further) constraints on this element

Data type

valueOid

There are no (further) constraints on this element

Data type

valuePositiveInt

There are no (further) constraints on this element

Data type

valueString

There are no (further) constraints on this element

Data type

valueTime

There are no (further) constraints on this element

Data type

valueUnsignedInt

There are no (further) constraints on this element

Data type

valueUri

There are no (further) constraints on this element

Data type

valueUrl

There are no (further) constraints on this element

Data type

valueUuid

There are no (further) constraints on this element

Data type

valueAddress

There are no (further) constraints on this element

Data type

valueAge

There are no (further) constraints on this element

Data type

valueAnnotation

There are no (further) constraints on this element

Data type

valueAttachment

There are no (further) constraints on this element

Data type

valueCodeableConcept

There are no (further) constraints on this element

Data type

valueCoding

There are no (further) constraints on this element

Data type

valueContactPoint

There are no (further) constraints on this element

Data type

valueCount

There are no (further) constraints on this element

Data type

valueDistance

There are no (further) constraints on this element

Data type

valueDuration

There are no (further) constraints on this element

Data type

valueHumanName

There are no (further) constraints on this element

Data type

valueIdentifier

There are no (further) constraints on this element

Data type

valueMoney

There are no (further) constraints on this element

Data type

valuePeriod

There are no (further) constraints on this element

Data type

valueQuantity

There are no (further) constraints on this element

Data type

valueRange

There are no (further) constraints on this element

Data type

valueRatio

There are no (further) constraints on this element

Data type

valueSampledData

There are no (further) constraints on this element

Data type

valueSignature

There are no (further) constraints on this element

Data type

valueTiming

There are no (further) constraints on this element

Data type

valueContactDetail

There are no (further) constraints on this element

Data type

valueContributor

There are no (further) constraints on this element

Data type

valueDataRequirement

There are no (further) constraints on this element

Data type

valueExpression

There are no (further) constraints on this element

Data type

valueParameterDefinition

There are no (further) constraints on this element

Data type

valueRelatedArtifact

There are no (further) constraints on this element

Data type

valueTriggerDefinition

There are no (further) constraints on this element

Data type

valueUsageContext

There are no (further) constraints on this element

Data type

valueDosage

There are no (further) constraints on this element

Data type

valueMeta

There are no (further) constraints on this element

Data type

valueReference

There are no (further) constraints on this element

Data type

resource

Σ C

1..1

Binary

There are no (further) constraints on this element

Element id

Parameters.parameter:image-binary.resource

Short description

If parameter is a whole resource

Definition

If the parameter is a whole resource.

Comments

Data type

Binary

Conditions

The cardinality or value of this element may be affected by these constraints: inv-1

part

0..*

see (parameter)

There are no (further) constraints on this element

Element id

Parameters.parameter:image-binary.part

Short description

Named part of a multi-part parameter

Definition

A named part of a multi-part parameter.

Comments

Only one level of nested parameters is allowed.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

There are no (further) constraints on this element

Element id

Parameters.parameter:image-binary.part.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Parameters.parameter:image-binary.part.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

http://omi.de/fhir/registry/StructureDefinition/input-parameter-query-extension

Slicing

Unordered, Open, by url(Value)

Constraints

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()

Mappings

rim: n/a

parameterQueryExtension

S C

0..1

Extension(Complex)

There are no (further) constraints on this element

Element id

Parameters.parameter:image-binary.part.extension:parameterQueryExtension

Short description

Service Input Parameter Query Extension

Alternate names

extensions, user content

Definition

Extension to document how to get the value for a certain parameter.

Comments

Data type

Extension(Complex)

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Parameters.parameter:image-binary.part.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

name

1..1

There are no (further) constraints on this element

Element id

Parameters.parameter:image-binary.part.name

Short description

Name from the definition

Definition

The name of the parameter (reference to the operation definition).

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

value[x]

Σ C

0..1

There are no (further) constraints on this element

Element id

Parameters.parameter:image-binary.part.value[x]

Short description

If parameter is a data type

Definition

If the parameter is a data type.

Conditions

The cardinality or value of this element may be affected by these constraints: inv-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

valueBase64Binary

There are no (further) constraints on this element

Data type

valueBoolean

There are no (further) constraints on this element

Data type

valueCanonical

There are no (further) constraints on this element

Data type

valueCode

There are no (further) constraints on this element

Data type

valueDate

There are no (further) constraints on this element

Data type

valueDateTime

There are no (further) constraints on this element

Data type

valueDecimal

There are no (further) constraints on this element

Data type

valueId

There are no (further) constraints on this element

Data type

valueInstant

There are no (further) constraints on this element

Data type

valueInteger

There are no (further) constraints on this element

Data type

valueMarkdown

There are no (further) constraints on this element

Data type

valueOid

There are no (further) constraints on this element

Data type

valuePositiveInt

There are no (further) constraints on this element

Data type

valueString

There are no (further) constraints on this element

Data type

valueTime

There are no (further) constraints on this element

Data type

valueUnsignedInt

There are no (further) constraints on this element

Data type

valueUri

There are no (further) constraints on this element

Data type

valueUrl

There are no (further) constraints on this element

Data type

valueUuid

There are no (further) constraints on this element

Data type

valueAddress

There are no (further) constraints on this element

Data type

valueAge

There are no (further) constraints on this element

Data type

valueAnnotation

There are no (further) constraints on this element

Data type

valueAttachment

There are no (further) constraints on this element

Data type

valueCodeableConcept

There are no (further) constraints on this element

Data type

valueCoding

There are no (further) constraints on this element

Data type

valueContactPoint

There are no (further) constraints on this element

Data type

valueCount

There are no (further) constraints on this element

Data type

valueDistance

There are no (further) constraints on this element

Data type

valueDuration

There are no (further) constraints on this element

Data type

valueHumanName

There are no (further) constraints on this element

Data type

valueIdentifier

There are no (further) constraints on this element

Data type

valueMoney

There are no (further) constraints on this element

Data type

valuePeriod

There are no (further) constraints on this element

Data type

valueQuantity

There are no (further) constraints on this element

Data type

valueRange

There are no (further) constraints on this element

Data type

valueRatio

There are no (further) constraints on this element

Data type

valueSampledData

There are no (further) constraints on this element

Data type

valueSignature

There are no (further) constraints on this element

Data type

valueTiming

There are no (further) constraints on this element

Data type

valueContactDetail

There are no (further) constraints on this element

Data type

valueContributor

There are no (further) constraints on this element

Data type

valueDataRequirement

There are no (further) constraints on this element

Data type

valueExpression

There are no (further) constraints on this element

Data type

valueParameterDefinition

There are no (further) constraints on this element

Data type

valueRelatedArtifact

There are no (further) constraints on this element

Data type

valueTriggerDefinition

There are no (further) constraints on this element

Data type

valueUsageContext

There are no (further) constraints on this element

Data type

valueDosage

There are no (further) constraints on this element

Data type

valueMeta

There are no (further) constraints on this element

Data type

valueReference

There are no (further) constraints on this element

Data type

resource

Σ C

0..1

There are no (further) constraints on this element

Element id

Parameters.parameter:image-binary.part.resource

Short description

If parameter is a whole resource

Definition

If the parameter is a whole resource.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: inv-1

part

0..*

see (parameter)

There are no (further) constraints on this element

Element id

Parameters.parameter:image-binary.part.part

Short description

Named part of a multi-part parameter

Definition

A named part of a multi-part parameter.

Comments

Only one level of nested parameters is allowed.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

mri-image

S Σ C

1..1

There are no (further) constraints on this element

Element id

Parameters.parameter:mri-image

Short description

Operation Parameter

Definition

A parameter passed to or received from the operation.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
inv-1: A parameter must have one and only one of (value, resource, part)
(part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))

0..1

There are no (further) constraints on this element

Element id

Parameters.parameter:mri-image.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

S C

0..*

There are no (further) constraints on this element

Element id

Parameters.parameter:mri-image.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

http://omi.de/fhir/registry/StructureDefinition/input-parameter-query-extension

Slicing

Unordered, Open, by url(Value)

Constraints

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()

Mappings

rim: n/a

parameterQueryExtension

S C

0..1

Extension(Complex)

There are no (further) constraints on this element

Element id

Parameters.parameter:mri-image.extension:parameterQueryExtension

Short description

Service Input Parameter Query Extension

Alternate names

extensions, user content

Definition

Extension to document how to get the value for a certain parameter.

Comments

Data type

Extension(Complex)

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Parameters.parameter:mri-image.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

name

S Σ

1..1

stringPattern

Element id

Parameters.parameter:mri-image.name

Short description

Name from the definition

Definition

The name of the parameter (reference to the operation definition).

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

mri-image

value[x]

S Σ C

0..1

There are no (further) constraints on this element

Element id

Parameters.parameter:mri-image.value[x]

Short description

If parameter is a data type

Definition

If the parameter is a data type.

Conditions

The cardinality or value of this element may be affected by these constraints: inv-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

valueBase64Binary

There are no (further) constraints on this element

Data type

valueBoolean

There are no (further) constraints on this element

Data type

valueCanonical

There are no (further) constraints on this element

Data type

valueCode

There are no (further) constraints on this element

Data type

valueDate

There are no (further) constraints on this element

Data type

valueDateTime

There are no (further) constraints on this element

Data type

valueDecimal

There are no (further) constraints on this element

Data type

valueId

There are no (further) constraints on this element

Data type

valueInstant

There are no (further) constraints on this element

Data type

valueInteger

There are no (further) constraints on this element

Data type

valueMarkdown

There are no (further) constraints on this element

Data type

valueOid

There are no (further) constraints on this element

Data type

valuePositiveInt

There are no (further) constraints on this element

Data type

valueString

There are no (further) constraints on this element

Data type

valueTime

There are no (further) constraints on this element

Data type

valueUnsignedInt

There are no (further) constraints on this element

Data type

valueUri

There are no (further) constraints on this element

Data type

valueUrl

There are no (further) constraints on this element

Data type

valueUuid

There are no (further) constraints on this element

Data type

valueAddress

There are no (further) constraints on this element

Data type

valueAge

There are no (further) constraints on this element

Data type

valueAnnotation

There are no (further) constraints on this element

Data type

valueAttachment

There are no (further) constraints on this element

Data type

valueCodeableConcept

There are no (further) constraints on this element

Data type

valueCoding

There are no (further) constraints on this element

Data type

valueContactPoint

There are no (further) constraints on this element

Data type

valueCount

There are no (further) constraints on this element

Data type

valueDistance

There are no (further) constraints on this element

Data type

valueDuration

There are no (further) constraints on this element

Data type

valueHumanName

There are no (further) constraints on this element

Data type

valueIdentifier

There are no (further) constraints on this element

Data type

valueMoney

There are no (further) constraints on this element

Data type

valuePeriod

There are no (further) constraints on this element

Data type

valueQuantity

There are no (further) constraints on this element

Data type

valueRange

There are no (further) constraints on this element

Data type

valueRatio

There are no (further) constraints on this element

Data type

valueSampledData

There are no (further) constraints on this element

Data type

valueSignature

There are no (further) constraints on this element

Data type

valueTiming

There are no (further) constraints on this element

Data type

valueContactDetail

There are no (further) constraints on this element

Data type

valueContributor

There are no (further) constraints on this element

Data type

valueDataRequirement

There are no (further) constraints on this element

Data type

valueExpression

There are no (further) constraints on this element

Data type

valueParameterDefinition

There are no (further) constraints on this element

Data type

valueRelatedArtifact

There are no (further) constraints on this element

Data type

valueTriggerDefinition

There are no (further) constraints on this element

Data type

valueUsageContext

There are no (further) constraints on this element

Data type

valueDosage

There are no (further) constraints on this element

Data type

valueMeta

There are no (further) constraints on this element

Data type

valueReference

There are no (further) constraints on this element

Data type

resource

S C

1..1

Element id

Parameters.parameter:mri-image.resource

Short description

A reference to a document

Definition

Comments

Usually, this is used for documents other than those defined by FHIR.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: inv-1

Constraints

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()

Mappings

rim: Entity. Role, or Act
workflow: Event
fhircomposition: when describing a Composition
rim: Document[classCode="DOC" and moodCode="EVN"]
cda: when describing a CDA

part

S Σ

0..*

There are no (further) constraints on this element

Element id

Parameters.parameter:mri-image.part

Short description

Named part of a multi-part parameter

Definition

A named part of a multi-part parameter.

Comments

Only one level of nested parameters is allowed.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

There are no (further) constraints on this element

Element id

Parameters.parameter:mri-image.part.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

S C

0..*

There are no (further) constraints on this element

Element id

Parameters.parameter:mri-image.part.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

http://omi.de/fhir/registry/StructureDefinition/input-parameter-query-extension

Slicing

Unordered, Open, by url(Value)

Constraints

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()

Mappings

rim: n/a

parameterQueryExtension

S C

0..1

Extension(Complex)

There are no (further) constraints on this element

Element id

Parameters.parameter:mri-image.part.extension:parameterQueryExtension

Short description

Service Input Parameter Query Extension

Alternate names

extensions, user content

Definition

Extension to document how to get the value for a certain parameter.

Comments

Data type

Extension(Complex)

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Parameters.parameter:mri-image.part.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

name

S Σ

1..1

There are no (further) constraints on this element

Element id

Parameters.parameter:mri-image.part.name

Short description

Name from the definition

Definition

The name of the parameter (reference to the operation definition).

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

value[x]

S Σ C

0..1

There are no (further) constraints on this element

Element id

Parameters.parameter:mri-image.part.value[x]

Short description

If parameter is a data type

Definition

If the parameter is a data type.

Conditions

The cardinality or value of this element may be affected by these constraints: inv-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

valueBase64Binary

There are no (further) constraints on this element

Data type

valueBoolean

There are no (further) constraints on this element

Data type

valueCanonical

There are no (further) constraints on this element

Data type

valueCode

There are no (further) constraints on this element

Data type

valueDate

There are no (further) constraints on this element

Data type

valueDateTime

There are no (further) constraints on this element

Data type

valueDecimal

There are no (further) constraints on this element

Data type

valueId

There are no (further) constraints on this element

Data type

valueInstant

There are no (further) constraints on this element

Data type

valueInteger

There are no (further) constraints on this element

Data type

valueMarkdown

There are no (further) constraints on this element

Data type

valueOid

There are no (further) constraints on this element

Data type

valuePositiveInt

There are no (further) constraints on this element

Data type

valueString

There are no (further) constraints on this element

Data type

valueTime

There are no (further) constraints on this element

Data type

valueUnsignedInt

There are no (further) constraints on this element

Data type

valueUri

There are no (further) constraints on this element

Data type

valueUrl

There are no (further) constraints on this element

Data type

valueUuid

There are no (further) constraints on this element

Data type

valueAddress

There are no (further) constraints on this element

Data type

valueAge

There are no (further) constraints on this element

Data type

valueAnnotation

There are no (further) constraints on this element

Data type

valueAttachment

There are no (further) constraints on this element

Data type

valueCodeableConcept

There are no (further) constraints on this element

Data type

valueCoding

There are no (further) constraints on this element

Data type

valueContactPoint

There are no (further) constraints on this element

Data type

valueCount

There are no (further) constraints on this element

Data type

valueDistance

There are no (further) constraints on this element

Data type

valueDuration

There are no (further) constraints on this element

Data type

valueHumanName

There are no (further) constraints on this element

Data type

valueIdentifier

There are no (further) constraints on this element

Data type

valueMoney

There are no (further) constraints on this element

Data type

valuePeriod

There are no (further) constraints on this element

Data type

valueQuantity

There are no (further) constraints on this element

Data type

valueRange

There are no (further) constraints on this element

Data type

valueRatio

There are no (further) constraints on this element

Data type

valueSampledData

There are no (further) constraints on this element

Data type

valueSignature

There are no (further) constraints on this element

Data type

valueTiming

There are no (further) constraints on this element

Data type

valueContactDetail

There are no (further) constraints on this element

Data type

valueContributor

There are no (further) constraints on this element

Data type

valueDataRequirement

There are no (further) constraints on this element

Data type

valueExpression

There are no (further) constraints on this element

Data type

valueParameterDefinition

There are no (further) constraints on this element

Data type

valueRelatedArtifact

There are no (further) constraints on this element

Data type

valueTriggerDefinition

There are no (further) constraints on this element

Data type

valueUsageContext

There are no (further) constraints on this element

Data type

valueDosage

There are no (further) constraints on this element

Data type

valueMeta

There are no (further) constraints on this element

Data type

valueReference

There are no (further) constraints on this element

Data type

resource

S Σ C

0..1

There are no (further) constraints on this element

Element id

Parameters.parameter:mri-image.part.resource

Short description

If parameter is a whole resource

Definition

If the parameter is a whole resource.

Comments

Data type

OmiServiceOutputParameters

Conditions

The cardinality or value of this element may be affected by these constraints: inv-1

part

0..*

see (parameter)

There are no (further) constraints on this element

Element id

Parameters.parameter:mri-image.part.part

Short description

Named part of a multi-part parameter

Definition

A named part of a multi-part parameter.

Comments

Only one level of nested parameters is allowed.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Example

Parameters

id : GbmServiceInputParametersExample

meta

profile : http://omi.de/fhir/registry/StructureDefinition/GbmServiceInputParameters

parameter

name : mri-image

resource

id : WholeBodyMriDocumentReference

meta

profile : http://omi.de/fhir/registry/StructureDefinition/omi-document-reference

content

attachment

url : https://omi.de/fhir/Binary/123

contentType : application/dicom

status : current

type

coding

code : 46358-8

system : http://loinc.org

display : MR Whole body

Output Parameters

Description

Outputs for the GBM algorithm include a annotated image in DICOM format. Additionally structured output could be provided.

Profiles

GbmServiceOutputParameters (Parameters)

There are no (further) constraints on this element

Element id

Parameters

Short description

Operation Request or Response

Definition

This resource is a non-persisted resource used to pass information into and back from an operation. It has no other use, and there is no RESTful endpoint associated with it.

Comments

The parameters that may be used are defined by the OperationDefinition resource.

Data type

OmiServiceOutputParameters

Mappings

rim: Entity. Role, or Act
v2: n/a
rim: n/a

0..1

There are no (further) constraints on this element

Element id

Parameters.id

Short description

Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

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.

Data type

meta

0..1

There are no (further) constraints on this element

Element id

Parameters.meta

Short description

Metadata about the resource

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.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

implicitRules

Σ ?!

0..1

There are no (further) constraints on this element

Element id

Parameters.implicitRules

Short description

A set of rules under which this content was created

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

language

0..1

codeBinding

There are no (further) constraints on this element

Element id

Parameters.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Data type

Binding

A human language.

Binding extensions

maxValueSet	AllLanguages

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

parameter

S Σ C

1..*

There are no (further) constraints on this element

Element id

Parameters.parameter

Short description

Operation Parameter

Definition

A parameter passed to or received from the operation.

Data type

Slicing

Unordered, Open, by name(Pattern)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
inv-1: A parameter must have one and only one of (value, resource, part)
(part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))

(All Slices)

The requirements in this element apply to all slices

0..1

There are no (further) constraints on this element

Element id

Parameters.parameter.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Parameters.parameter.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Parameters.parameter.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

name

S Σ

1..1

There are no (further) constraints on this element

Element id

Parameters.parameter.name

Short description

Name from the definition

Definition

The name of the parameter (reference to the operation definition).

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

value[x]

S Σ C

0..1

There are no (further) constraints on this element

Element id

Parameters.parameter.value[x]

Short description

If parameter is a data type

Definition

If the parameter is a data type.

Conditions

The cardinality or value of this element may be affected by these constraints: inv-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

valueBase64Binary

There are no (further) constraints on this element

Data type

valueBoolean

There are no (further) constraints on this element

Data type

valueCanonical

There are no (further) constraints on this element

Data type

valueCode

There are no (further) constraints on this element

Data type

valueDate

There are no (further) constraints on this element

Data type

valueDateTime

There are no (further) constraints on this element

Data type

valueDecimal

There are no (further) constraints on this element

Data type

valueId

There are no (further) constraints on this element

Data type

valueInstant

There are no (further) constraints on this element

Data type

valueInteger

There are no (further) constraints on this element

Data type

valueMarkdown

There are no (further) constraints on this element

Data type

valueOid

There are no (further) constraints on this element

Data type

valuePositiveInt

There are no (further) constraints on this element

Data type

valueString

There are no (further) constraints on this element

Data type

valueTime

There are no (further) constraints on this element

Data type

valueUnsignedInt

There are no (further) constraints on this element

Data type

valueUri

There are no (further) constraints on this element

Data type

valueUrl

There are no (further) constraints on this element

Data type

valueUuid

There are no (further) constraints on this element

Data type

valueAddress

There are no (further) constraints on this element

Data type

valueAge

There are no (further) constraints on this element

Data type

valueAnnotation

There are no (further) constraints on this element

Data type

valueAttachment

There are no (further) constraints on this element

Data type

valueCodeableConcept

There are no (further) constraints on this element

Data type

valueCoding

There are no (further) constraints on this element

Data type

valueContactPoint

There are no (further) constraints on this element

Data type

valueCount

There are no (further) constraints on this element

Data type

valueDistance

There are no (further) constraints on this element

Data type

valueDuration

There are no (further) constraints on this element

Data type

valueHumanName

There are no (further) constraints on this element

Data type

valueIdentifier

There are no (further) constraints on this element

Data type

valueMoney

There are no (further) constraints on this element

Data type

valuePeriod

There are no (further) constraints on this element

Data type

valueQuantity

There are no (further) constraints on this element

Data type

valueRange

There are no (further) constraints on this element

Data type

valueRatio

There are no (further) constraints on this element

Data type

valueSampledData

There are no (further) constraints on this element

Data type

valueSignature

There are no (further) constraints on this element

Data type

valueTiming

There are no (further) constraints on this element

Data type

valueContactDetail

There are no (further) constraints on this element

Data type

valueContributor

There are no (further) constraints on this element

Data type

valueDataRequirement

There are no (further) constraints on this element

Data type

valueExpression

There are no (further) constraints on this element

Data type

valueParameterDefinition

There are no (further) constraints on this element

Data type

valueRelatedArtifact

There are no (further) constraints on this element

Data type

valueTriggerDefinition

There are no (further) constraints on this element

Data type

valueUsageContext

There are no (further) constraints on this element

Data type

valueDosage

There are no (further) constraints on this element

Data type

valueMeta

There are no (further) constraints on this element

Data type

valueReference

There are no (further) constraints on this element

Data type

resource

S Σ C

0..1

There are no (further) constraints on this element

Element id

Parameters.parameter.resource

Short description

If parameter is a whole resource

Definition

If the parameter is a whole resource.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: inv-1

part

S Σ

0..*

There are no (further) constraints on this element

Element id

Parameters.parameter.part

Short description

Named part of a multi-part parameter

Definition

A named part of a multi-part parameter.

Comments

Only one level of nested parameters is allowed.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

There are no (further) constraints on this element

Element id

Parameters.parameter.part.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Parameters.parameter.part.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Parameters.parameter.part.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

name

S Σ

1..1

There are no (further) constraints on this element

Element id

Parameters.parameter.part.name

Short description

Name from the definition

Definition

The name of the parameter (reference to the operation definition).

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

value[x]

S Σ C

0..1

There are no (further) constraints on this element

Element id

Parameters.parameter.part.value[x]

Short description

If parameter is a data type

Definition

If the parameter is a data type.

Conditions

The cardinality or value of this element may be affected by these constraints: inv-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

valueBase64Binary

There are no (further) constraints on this element

Data type

valueBoolean

There are no (further) constraints on this element

Data type

valueCanonical

There are no (further) constraints on this element

Data type

valueCode

There are no (further) constraints on this element

Data type

valueDate

There are no (further) constraints on this element

Data type

valueDateTime

There are no (further) constraints on this element

Data type

valueDecimal

There are no (further) constraints on this element

Data type

valueId

There are no (further) constraints on this element

Data type

valueInstant

There are no (further) constraints on this element

Data type

valueInteger

There are no (further) constraints on this element

Data type

valueMarkdown

There are no (further) constraints on this element

Data type

valueOid

There are no (further) constraints on this element

Data type

valuePositiveInt

There are no (further) constraints on this element

Data type

valueString

There are no (further) constraints on this element

Data type

valueTime

There are no (further) constraints on this element

Data type

valueUnsignedInt

There are no (further) constraints on this element

Data type

valueUri

There are no (further) constraints on this element

Data type

valueUrl

There are no (further) constraints on this element

Data type

valueUuid

There are no (further) constraints on this element

Data type

valueAddress

There are no (further) constraints on this element

Data type

valueAge

There are no (further) constraints on this element

Data type

valueAnnotation

There are no (further) constraints on this element

Data type

valueAttachment

There are no (further) constraints on this element

Data type

valueCodeableConcept

There are no (further) constraints on this element

Data type

valueCoding

There are no (further) constraints on this element

Data type

valueContactPoint

There are no (further) constraints on this element

Data type

valueCount

There are no (further) constraints on this element

Data type

valueDistance

There are no (further) constraints on this element

Data type

valueDuration

There are no (further) constraints on this element

Data type

valueHumanName

There are no (further) constraints on this element

Data type

valueIdentifier

There are no (further) constraints on this element

Data type

valueMoney

There are no (further) constraints on this element

Data type

valuePeriod

There are no (further) constraints on this element

Data type

valueQuantity

There are no (further) constraints on this element

Data type

valueRange

There are no (further) constraints on this element

Data type

valueRatio

There are no (further) constraints on this element

Data type

valueSampledData

There are no (further) constraints on this element

Data type

valueSignature

There are no (further) constraints on this element

Data type

valueTiming

There are no (further) constraints on this element

Data type

valueContactDetail

There are no (further) constraints on this element

Data type

valueContributor

There are no (further) constraints on this element

Data type

valueDataRequirement

There are no (further) constraints on this element

Data type

valueExpression

There are no (further) constraints on this element

Data type

valueParameterDefinition

There are no (further) constraints on this element

Data type

valueRelatedArtifact

There are no (further) constraints on this element

Data type

valueTriggerDefinition

There are no (further) constraints on this element

Data type

valueUsageContext

There are no (further) constraints on this element

Data type

valueDosage

There are no (further) constraints on this element

Data type

valueMeta

There are no (further) constraints on this element

Data type

valueReference

There are no (further) constraints on this element

Data type

resource

S Σ C

0..1

There are no (further) constraints on this element

Element id

Parameters.parameter.part.resource

Short description

If parameter is a whole resource

Definition

If the parameter is a whole resource.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: inv-1

part

0..*

see (parameter)

There are no (further) constraints on this element

Element id

Parameters.parameter.part.part

Short description

Named part of a multi-part parameter

Definition

A named part of a multi-part parameter.

Comments

Only one level of nested parameters is allowed.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

pdfReport

S Σ C

0..1

There are no (further) constraints on this element

Element id

Parameters.parameter:pdfReport

Short description

Operation Parameter

Definition

A parameter passed to or received from the operation.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
inv-1: A parameter must have one and only one of (value, resource, part)
(part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))

0..1

There are no (further) constraints on this element

Element id

Parameters.parameter:pdfReport.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Parameters.parameter:pdfReport.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Parameters.parameter:pdfReport.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

name

1..1

stringPattern

There are no (further) constraints on this element

Element id

Parameters.parameter:pdfReport.name

Short description

Name from the definition

Definition

The name of the parameter (reference to the operation definition).

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

pdfReport

value[x]

Σ C

0..1

There are no (further) constraints on this element

Element id

Parameters.parameter:pdfReport.value[x]

Short description

If parameter is a data type

Definition

If the parameter is a data type.

Conditions

The cardinality or value of this element may be affected by these constraints: inv-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

valueBase64Binary

There are no (further) constraints on this element

Data type

valueBoolean

There are no (further) constraints on this element

Data type

valueCanonical

There are no (further) constraints on this element

Data type

valueCode

There are no (further) constraints on this element

Data type

valueDate

There are no (further) constraints on this element

Data type

valueDateTime

There are no (further) constraints on this element

Data type

valueDecimal

There are no (further) constraints on this element

Data type

valueId

There are no (further) constraints on this element

Data type

valueInstant

There are no (further) constraints on this element

Data type

valueInteger

There are no (further) constraints on this element

Data type

valueMarkdown

There are no (further) constraints on this element

Data type

valueOid

There are no (further) constraints on this element

Data type

valuePositiveInt

There are no (further) constraints on this element

Data type

valueString

There are no (further) constraints on this element

Data type

valueTime

There are no (further) constraints on this element

Data type

valueUnsignedInt

There are no (further) constraints on this element

Data type

valueUri

There are no (further) constraints on this element

Data type

valueUrl

There are no (further) constraints on this element

Data type

valueUuid

There are no (further) constraints on this element

Data type

valueAddress

There are no (further) constraints on this element

Data type

valueAge

There are no (further) constraints on this element

Data type

valueAnnotation

There are no (further) constraints on this element

Data type

valueAttachment

There are no (further) constraints on this element

Data type

valueCodeableConcept

There are no (further) constraints on this element

Data type

valueCoding

There are no (further) constraints on this element

Data type

valueContactPoint

There are no (further) constraints on this element

Data type

valueCount

There are no (further) constraints on this element

Data type

valueDistance

There are no (further) constraints on this element

Data type

valueDuration

There are no (further) constraints on this element

Data type

valueHumanName

There are no (further) constraints on this element

Data type

valueIdentifier

There are no (further) constraints on this element

Data type

valueMoney

There are no (further) constraints on this element

Data type

valuePeriod

There are no (further) constraints on this element

Data type

valueQuantity

There are no (further) constraints on this element

Data type

valueRange

There are no (further) constraints on this element

Data type

valueRatio

There are no (further) constraints on this element

Data type

valueSampledData

There are no (further) constraints on this element

Data type

valueSignature

There are no (further) constraints on this element

Data type

valueTiming

There are no (further) constraints on this element

Data type

valueContactDetail

There are no (further) constraints on this element

Data type

valueContributor

There are no (further) constraints on this element

Data type

valueDataRequirement

There are no (further) constraints on this element

Data type

valueExpression

There are no (further) constraints on this element

Data type

valueParameterDefinition

There are no (further) constraints on this element

Data type

valueRelatedArtifact

There are no (further) constraints on this element

Data type

valueTriggerDefinition

There are no (further) constraints on this element

Data type

valueUsageContext

There are no (further) constraints on this element

Data type

valueDosage

There are no (further) constraints on this element

Data type

valueMeta

There are no (further) constraints on this element

Data type

valueReference

There are no (further) constraints on this element

Data type

resource

1..1

There are no (further) constraints on this element

Element id

Parameters.parameter:pdfReport.resource

Short description

A reference to a document

Definition

Comments

Usually, this is used for documents other than those defined by FHIR.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: inv-1

Constraints

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()

Mappings

rim: Entity. Role, or Act
workflow: Event
fhircomposition: when describing a Composition
rim: Document[classCode="DOC" and moodCode="EVN"]
cda: when describing a CDA

part

0..*

see (parameter)

There are no (further) constraints on this element

Element id

Parameters.parameter:pdfReport.part

Short description

Named part of a multi-part parameter

Definition

A named part of a multi-part parameter.

Comments

Only one level of nested parameters is allowed.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

image

S Σ C

0..*

There are no (further) constraints on this element

Element id

Parameters.parameter:image

Short description

Operation Parameter

Definition

A parameter passed to or received from the operation.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
inv-1: A parameter must have one and only one of (value, resource, part)
(part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))

0..1

There are no (further) constraints on this element

Element id

Parameters.parameter:image.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Parameters.parameter:image.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Parameters.parameter:image.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

name

1..1

stringPattern

There are no (further) constraints on this element

Element id

Parameters.parameter:image.name

Short description

Name from the definition

Definition

The name of the parameter (reference to the operation definition).

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

image

value[x]

Σ C

0..1

There are no (further) constraints on this element

Element id

Parameters.parameter:image.value[x]

Short description

If parameter is a data type

Definition

If the parameter is a data type.

Conditions

The cardinality or value of this element may be affected by these constraints: inv-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

valueBase64Binary

There are no (further) constraints on this element

Data type

valueBoolean

There are no (further) constraints on this element

Data type

valueCanonical

There are no (further) constraints on this element

Data type

valueCode

There are no (further) constraints on this element

Data type

valueDate

There are no (further) constraints on this element

Data type

valueDateTime

There are no (further) constraints on this element

Data type

valueDecimal

There are no (further) constraints on this element

Data type

valueId

There are no (further) constraints on this element

Data type

valueInstant

There are no (further) constraints on this element

Data type

valueInteger

There are no (further) constraints on this element

Data type

valueMarkdown

There are no (further) constraints on this element

Data type

valueOid

There are no (further) constraints on this element

Data type

valuePositiveInt

There are no (further) constraints on this element

Data type

valueString

There are no (further) constraints on this element

Data type

valueTime

There are no (further) constraints on this element

Data type

valueUnsignedInt

There are no (further) constraints on this element

Data type

valueUri

There are no (further) constraints on this element

Data type

valueUrl

There are no (further) constraints on this element

Data type

valueUuid

There are no (further) constraints on this element

Data type

valueAddress

There are no (further) constraints on this element

Data type

valueAge

There are no (further) constraints on this element

Data type

valueAnnotation

There are no (further) constraints on this element

Data type

valueAttachment

There are no (further) constraints on this element

Data type

valueCodeableConcept

There are no (further) constraints on this element

Data type

valueCoding

There are no (further) constraints on this element

Data type

valueContactPoint

There are no (further) constraints on this element

Data type

valueCount

There are no (further) constraints on this element

Data type

valueDistance

There are no (further) constraints on this element

Data type

valueDuration

There are no (further) constraints on this element

Data type

valueHumanName

There are no (further) constraints on this element

Data type

valueIdentifier

There are no (further) constraints on this element

Data type

valueMoney

There are no (further) constraints on this element

Data type

valuePeriod

There are no (further) constraints on this element

Data type

valueQuantity

There are no (further) constraints on this element

Data type

valueRange

There are no (further) constraints on this element

Data type

valueRatio

There are no (further) constraints on this element

Data type

valueSampledData

There are no (further) constraints on this element

Data type

valueSignature

There are no (further) constraints on this element

Data type

valueTiming

There are no (further) constraints on this element

Data type

valueContactDetail

There are no (further) constraints on this element

Data type

valueContributor

There are no (further) constraints on this element

Data type

valueDataRequirement

There are no (further) constraints on this element

Data type

valueExpression

There are no (further) constraints on this element

Data type

valueParameterDefinition

There are no (further) constraints on this element

Data type

valueRelatedArtifact

There are no (further) constraints on this element

Data type

valueTriggerDefinition

There are no (further) constraints on this element

Data type

valueUsageContext

There are no (further) constraints on this element

Data type

valueDosage

There are no (further) constraints on this element

Data type

valueMeta

There are no (further) constraints on this element

Data type

valueReference

There are no (further) constraints on this element

Data type

resource

1..1

There are no (further) constraints on this element

Element id

Parameters.parameter:image.resource

Short description

A reference to a document

Definition

Comments

Usually, this is used for documents other than those defined by FHIR.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: inv-1

Constraints

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()

Mappings

rim: Entity. Role, or Act
workflow: Event
fhircomposition: when describing a Composition
rim: Document[classCode="DOC" and moodCode="EVN"]
cda: when describing a CDA

part

0..*

see (parameter)

There are no (further) constraints on this element

Element id

Parameters.parameter:image.part

Short description

Named part of a multi-part parameter

Definition

A named part of a multi-part parameter.

Comments

Only one level of nested parameters is allowed.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

observations

S Σ C

0..*

There are no (further) constraints on this element

Element id

Parameters.parameter:observations

Short description

Operation Parameter

Definition

A parameter passed to or received from the operation.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
inv-1: A parameter must have one and only one of (value, resource, part)
(part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))

0..1

There are no (further) constraints on this element

Element id

Parameters.parameter:observations.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Parameters.parameter:observations.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Parameters.parameter:observations.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

name

1..1

stringPattern

There are no (further) constraints on this element

Element id

Parameters.parameter:observations.name

Short description

Name from the definition

Definition

The name of the parameter (reference to the operation definition).

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

observations

value[x]

Σ C

0..1

There are no (further) constraints on this element

Element id

Parameters.parameter:observations.value[x]

Short description

If parameter is a data type

Definition

If the parameter is a data type.

Conditions

The cardinality or value of this element may be affected by these constraints: inv-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

valueBase64Binary

There are no (further) constraints on this element

Data type

valueBoolean

There are no (further) constraints on this element

Data type

valueCanonical

There are no (further) constraints on this element

Data type

valueCode

There are no (further) constraints on this element

Data type

valueDate

There are no (further) constraints on this element

Data type

valueDateTime

There are no (further) constraints on this element

Data type

valueDecimal

There are no (further) constraints on this element

Data type

valueId

There are no (further) constraints on this element

Data type

valueInstant

There are no (further) constraints on this element

Data type

valueInteger

There are no (further) constraints on this element

Data type

valueMarkdown

There are no (further) constraints on this element

Data type

valueOid

There are no (further) constraints on this element

Data type

valuePositiveInt

There are no (further) constraints on this element

Data type

valueString

There are no (further) constraints on this element

Data type

valueTime

There are no (further) constraints on this element

Data type

valueUnsignedInt

There are no (further) constraints on this element

Data type

valueUri

There are no (further) constraints on this element

Data type

valueUrl

There are no (further) constraints on this element

Data type

valueUuid

There are no (further) constraints on this element

Data type

valueAddress

There are no (further) constraints on this element

Data type

valueAge

There are no (further) constraints on this element

Data type

valueAnnotation

There are no (further) constraints on this element

Data type

valueAttachment

There are no (further) constraints on this element

Data type

valueCodeableConcept

There are no (further) constraints on this element

Data type

valueCoding

There are no (further) constraints on this element

Data type

valueContactPoint

There are no (further) constraints on this element

Data type

valueCount

There are no (further) constraints on this element

Data type

valueDistance

There are no (further) constraints on this element

Data type

valueDuration

There are no (further) constraints on this element

Data type

valueHumanName

There are no (further) constraints on this element

Data type

valueIdentifier

There are no (further) constraints on this element

Data type

valueMoney

There are no (further) constraints on this element

Data type

valuePeriod

There are no (further) constraints on this element

Data type

valueQuantity

There are no (further) constraints on this element

Data type

valueRange

There are no (further) constraints on this element

Data type

valueRatio

There are no (further) constraints on this element

Data type

valueSampledData

There are no (further) constraints on this element

Data type

valueSignature

There are no (further) constraints on this element

Data type

valueTiming

There are no (further) constraints on this element

Data type

valueContactDetail

There are no (further) constraints on this element

Data type

valueContributor

There are no (further) constraints on this element

Data type

valueDataRequirement

There are no (further) constraints on this element

Data type

valueExpression

There are no (further) constraints on this element

Data type

valueParameterDefinition

There are no (further) constraints on this element

Data type

valueRelatedArtifact

There are no (further) constraints on this element

Data type

valueTriggerDefinition

There are no (further) constraints on this element

Data type

valueUsageContext

There are no (further) constraints on this element

Data type

valueDosage

There are no (further) constraints on this element

Data type

valueMeta

There are no (further) constraints on this element

Data type

valueReference

There are no (further) constraints on this element

Data type

resource

1..1

There are no (further) constraints on this element

Element id

Parameters.parameter:observations.resource

Short description

Measurements and simple assertions

Alternate names

Vital Signs, Measurement, Results, Tests

Definition

Measurements and simple assertions made about a patient, device or other subject.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: inv-1

Constraints

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()
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
dataAbsentReason.empty() or value.empty()
obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()

Mappings

rim: Entity. Role, or Act
workflow: Event
sct-concept: < 363787002 |Observable entity|
v2: OBX
rim: Observation[classCode=OBS, moodCode=EVN]

part

0..*

see (parameter)

There are no (further) constraints on this element

Element id

Parameters.parameter:observations.part

Short description

Named part of a multi-part parameter

Definition

A named part of a multi-part parameter.

Comments

Only one level of nested parameters is allowed.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

mri-image

S Σ C

1..1

There are no (further) constraints on this element

Element id

Parameters.parameter:mri-image

Short description

Operation Parameter

Definition

A parameter passed to or received from the operation.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
inv-1: A parameter must have one and only one of (value, resource, part)
(part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))

0..1

There are no (further) constraints on this element

Element id

Parameters.parameter:mri-image.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Parameters.parameter:mri-image.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Parameters.parameter:mri-image.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

name

S Σ

1..1

stringPattern

Element id

Parameters.parameter:mri-image.name

Short description

Name from the definition

Definition

The name of the parameter (reference to the operation definition).

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

mri-image

value[x]

S Σ C

0..1

There are no (further) constraints on this element

Element id

Parameters.parameter:mri-image.value[x]

Short description

If parameter is a data type

Definition

If the parameter is a data type.

Conditions

The cardinality or value of this element may be affected by these constraints: inv-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

valueBase64Binary

There are no (further) constraints on this element

Data type

valueBoolean

There are no (further) constraints on this element

Data type

valueCanonical

There are no (further) constraints on this element

Data type

valueCode

There are no (further) constraints on this element

Data type

valueDate

There are no (further) constraints on this element

Data type

valueDateTime

There are no (further) constraints on this element

Data type

valueDecimal

There are no (further) constraints on this element

Data type

valueId

There are no (further) constraints on this element

Data type

valueInstant

There are no (further) constraints on this element

Data type

valueInteger

There are no (further) constraints on this element

Data type

valueMarkdown

There are no (further) constraints on this element

Data type

valueOid

There are no (further) constraints on this element

Data type

valuePositiveInt

There are no (further) constraints on this element

Data type

valueString

There are no (further) constraints on this element

Data type

valueTime

There are no (further) constraints on this element

Data type

valueUnsignedInt

There are no (further) constraints on this element

Data type

valueUri

There are no (further) constraints on this element

Data type

valueUrl

There are no (further) constraints on this element

Data type

valueUuid

There are no (further) constraints on this element

Data type

valueAddress

There are no (further) constraints on this element

Data type

valueAge

There are no (further) constraints on this element

Data type

valueAnnotation

There are no (further) constraints on this element

Data type

valueAttachment

There are no (further) constraints on this element

Data type

valueCodeableConcept

There are no (further) constraints on this element

Data type

valueCoding

There are no (further) constraints on this element

Data type

valueContactPoint

There are no (further) constraints on this element

Data type

valueCount

There are no (further) constraints on this element

Data type

valueDistance

There are no (further) constraints on this element

Data type

valueDuration

There are no (further) constraints on this element

Data type

valueHumanName

There are no (further) constraints on this element

Data type

valueIdentifier

There are no (further) constraints on this element

Data type

valueMoney

There are no (further) constraints on this element

Data type

valuePeriod

There are no (further) constraints on this element

Data type

valueQuantity

There are no (further) constraints on this element

Data type

valueRange

There are no (further) constraints on this element

Data type

valueRatio

There are no (further) constraints on this element

Data type

valueSampledData

There are no (further) constraints on this element

Data type

valueSignature

There are no (further) constraints on this element

Data type

valueTiming

There are no (further) constraints on this element

Data type

valueContactDetail

There are no (further) constraints on this element

Data type

valueContributor

There are no (further) constraints on this element

Data type

valueDataRequirement

There are no (further) constraints on this element

Data type

valueExpression

There are no (further) constraints on this element

Data type

valueParameterDefinition

There are no (further) constraints on this element

Data type

valueRelatedArtifact

There are no (further) constraints on this element

Data type

valueTriggerDefinition

There are no (further) constraints on this element

Data type

valueUsageContext

There are no (further) constraints on this element

Data type

valueDosage

There are no (further) constraints on this element

Data type

valueMeta

There are no (further) constraints on this element

Data type

valueReference

There are no (further) constraints on this element

Data type

resource

S C

1..1

Element id

Parameters.parameter:mri-image.resource

Short description

A reference to a document

Definition

Comments

Usually, this is used for documents other than those defined by FHIR.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: inv-1

Constraints

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()

Mappings

rim: Entity. Role, or Act
workflow: Event
fhircomposition: when describing a Composition
rim: Document[classCode="DOC" and moodCode="EVN"]
cda: when describing a CDA

part

S Σ

0..*

There are no (further) constraints on this element

Element id

Parameters.parameter:mri-image.part

Short description

Named part of a multi-part parameter

Definition

A named part of a multi-part parameter.

Comments

Only one level of nested parameters is allowed.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

There are no (further) constraints on this element

Element id

Parameters.parameter:mri-image.part.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Parameters.parameter:mri-image.part.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Parameters.parameter:mri-image.part.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

name

S Σ

1..1

There are no (further) constraints on this element

Element id

Parameters.parameter:mri-image.part.name

Short description

Name from the definition

Definition

The name of the parameter (reference to the operation definition).

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

value[x]

S Σ C

0..1

There are no (further) constraints on this element

Element id

Parameters.parameter:mri-image.part.value[x]

Short description

If parameter is a data type

Definition

If the parameter is a data type.

Conditions

The cardinality or value of this element may be affected by these constraints: inv-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

valueBase64Binary

There are no (further) constraints on this element

Data type

valueBoolean

There are no (further) constraints on this element

Data type

valueCanonical

There are no (further) constraints on this element

Data type

valueCode

There are no (further) constraints on this element

Data type

valueDate

There are no (further) constraints on this element

Data type

valueDateTime

There are no (further) constraints on this element

Data type

valueDecimal

There are no (further) constraints on this element

Data type

valueId

There are no (further) constraints on this element

Data type

valueInstant

There are no (further) constraints on this element

Data type

valueInteger

There are no (further) constraints on this element

Data type

valueMarkdown

There are no (further) constraints on this element

Data type

valueOid

There are no (further) constraints on this element

Data type

valuePositiveInt

There are no (further) constraints on this element

Data type

valueString

There are no (further) constraints on this element

Data type

valueTime

There are no (further) constraints on this element

Data type

valueUnsignedInt

There are no (further) constraints on this element

Data type

valueUri

There are no (further) constraints on this element

Data type

valueUrl

There are no (further) constraints on this element

Data type

valueUuid

There are no (further) constraints on this element

Data type

valueAddress

There are no (further) constraints on this element

Data type

valueAge

There are no (further) constraints on this element

Data type

valueAnnotation

There are no (further) constraints on this element

Data type

valueAttachment

There are no (further) constraints on this element

Data type

valueCodeableConcept

There are no (further) constraints on this element

Data type

valueCoding

There are no (further) constraints on this element

Data type

valueContactPoint

There are no (further) constraints on this element

Data type

valueCount

There are no (further) constraints on this element

Data type

valueDistance

There are no (further) constraints on this element

Data type

valueDuration

There are no (further) constraints on this element

Data type

valueHumanName

There are no (further) constraints on this element

Data type

valueIdentifier

There are no (further) constraints on this element

Data type

valueMoney

There are no (further) constraints on this element

Data type

valuePeriod

There are no (further) constraints on this element

Data type

valueQuantity

There are no (further) constraints on this element

Data type

valueRange

There are no (further) constraints on this element

Data type

valueRatio

There are no (further) constraints on this element

Data type

valueSampledData

There are no (further) constraints on this element

Data type

valueSignature

There are no (further) constraints on this element

Data type

valueTiming

There are no (further) constraints on this element

Data type

valueContactDetail

There are no (further) constraints on this element

Data type

valueContributor

There are no (further) constraints on this element

Data type

valueDataRequirement

There are no (further) constraints on this element

Data type

valueExpression

There are no (further) constraints on this element

Data type

valueParameterDefinition

There are no (further) constraints on this element

Data type

valueRelatedArtifact

There are no (further) constraints on this element

Data type

valueTriggerDefinition

There are no (further) constraints on this element

Data type

valueUsageContext

There are no (further) constraints on this element

Data type

valueDosage

There are no (further) constraints on this element

Data type

valueMeta

There are no (further) constraints on this element

Data type

valueReference

There are no (further) constraints on this element

Data type

resource

S Σ C

0..1

There are no (further) constraints on this element

Element id

Parameters.parameter:mri-image.part.resource

Short description

If parameter is a whole resource

Definition

If the parameter is a whole resource.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: inv-1

part

0..*

see (parameter)

There are no (further) constraints on this element

Element id

Parameters.parameter:mri-image.part.part

Short description

Named part of a multi-part parameter

Definition

A named part of a multi-part parameter.

Comments

Only one level of nested parameters is allowed.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Instance

Parameters

id : GbmServiceOutputParametersExample

meta

profile : http://omi.de/fhir/registry/StructureDefinition/GbmServiceOutputParameters

parameter

name : mri-image

resource

id : WholeBodyMriDocumentReference

meta

profile : http://omi.de/fhir/registry/StructureDefinition/omi-document-reference

content

attachment

url : https://omi.de/fhir/Binary/123

contentType : application/dicom

status : current

type

coding

code : 46358-8

system : http://loinc.org

display : MR Whole body

Structured Output

GbmSummaryOutputObservation (Observation)

There are no (further) constraints on this element

Element id

Observation

Short description

Measurements and simple assertions

Alternate names

Vital Signs, Measurement, Results, Tests

Definition

Measurements and simple assertions made about a patient, device or other subject.

Comments

Data type

Constraints

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()
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
dataAbsentReason.empty() or value.empty()
obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()

Mappings

rim: Entity. Role, or Act
workflow: Event
sct-concept: < 363787002 |Observable entity|
v2: OBX
rim: Observation[classCode=OBS, moodCode=EVN]

0..1

There are no (further) constraints on this element

Element id

Observation.id

Short description

Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

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.

Data type

meta

0..1

There are no (further) constraints on this element

Element id

Observation.meta

Short description

Metadata about the resource

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.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

implicitRules

Σ ?!

0..1

There are no (further) constraints on this element

Element id

Observation.implicitRules

Short description

A set of rules under which this content was created

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

language

0..1

codeBinding

There are no (further) constraints on this element

Element id

Observation.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Data type

Binding

A human language.

Binding extensions

maxValueSet	AllLanguages

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

text

0..1

There are no (further) constraints on this element

Element id

Observation.text

Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: Act.text?

contained

0..*

There are no (further) constraints on this element

Element id

Observation.contained

Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

Comments

Data type

Mappings

rim: N/A

extension

0..*

There are no (further) constraints on this element

Element id

Observation.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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()

Mappings

rim: N/A

modifierExtension

?! C

0..*

There are no (further) constraints on this element

Element id

Observation.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

identifier

0..*

There are no (further) constraints on this element

Element id

Observation.identifier

Short description

Business Identifier for observation

Definition

A unique identifier assigned to this observation.

Requirements

Allows observations to be distinguished and referenced.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Event.identifier
w5: FiveWs.identifier
v2: OBX.21 For OBX segments from systems without OBX-21 support a combination of ORC/OBR and OBX must be negotiated between trading partners to uniquely identify the OBX segment. Depending on how V2 has been implemented each of these may be an option: 1) OBR-3 + OBX-3 + OBX-4 or 2) OBR-3 + OBR-4 + OBX-3 + OBX-4 or 2) some other way to uniquely ID the OBR/ORC + OBX-3 + OBX-4.
rim: id

basedOn

0..*

There are no (further) constraints on this element

Element id

Observation.basedOn

Short description

Fulfills plan, proposal or order

Alternate names

Fulfills

Definition

A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.

Requirements

Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Event.basedOn
v2: ORC
rim: .inboundRelationship[typeCode=COMP].source[moodCode=EVN]

partOf

0..*

There are no (further) constraints on this element

Element id

Observation.partOf

Short description

Part of referenced event

Alternate names

Container

Definition

A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.

Comments

To link an Observation to an Encounter use encounter. See the Notes below for guidance on referencing another Observation.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Event.partOf
v2: Varies by domain
rim: .outboundRelationship[typeCode=FLFS].target

status

S Σ ?!

1..1

codeBinding

There are no (further) constraints on this element

Element id

Observation.status

Short description

registered | preliminary | final | amended +

Definition

The status of the result value.

Requirements

Need to track the status of individual results. Some results are finalized before the whole report is finalized.

Comments

This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

Data type

Binding

Codes providing the status of an observation.

ObservationStatus (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Event.status
w5: FiveWs.status
sct-concept: < 445584004 |Report by finality status|
v2: OBX-11
rim: status Amended & Final are differentiated by whether it is the subject of a ControlAct event with a type of "revise"

category

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.category

Short description

Classification of type of observation

Definition

A code that classifies the general type of observation being made.

Requirements

Used for filtering what observations are retrieved and displayed.

Comments

Data type

Binding

Codes for high level observation categories.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.class
rim: .outboundRelationship[typeCode="COMP].target[classCode="LIST", moodCode="EVN"].code

code

S Σ

1..1

There are no (further) constraints on this element

Element id

Observation.code

Short description

Type of observation (code / type)

Alternate names

Name

Definition

Describes what was observed. Sometimes this is called the observation "name".

Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and, if present, component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Data type

Binding

Codes identifying names of simple observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Event.code
w5: FiveWs.what[x]
sct-concept: < 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|
v2: OBX-3
rim: code
sct-attr: 116680003 |Is a|

subject

0..1

There are no (further) constraints on this element

Element id

Observation.subject

Short description

Who and/or what the observation is about

Definition

Requirements

Observations have no value if you don't know who or what they're about.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Event.subject
w5: FiveWs.subject[x]
v2: PID-3
rim: participation[typeCode=RTGT]
w5: FiveWs.subject

focus

0..*

There are no (further) constraints on this element

Element id

Observation.focus

Short description

What the observation is about, when it is not about the subject of record

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.subject[x]
v2: OBX-3
rim: participation[typeCode=SBJ]
w5: FiveWs.subject

encounter

0..1

There are no (further) constraints on this element

Element id

Observation.encounter

Short description

Healthcare event during which this observation is made

Alternate names

Context

Definition

The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.

Requirements

For some observations it may be important to know the link between an observation and a particular encounter.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Event.context
w5: FiveWs.context
v2: PV1
rim: inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]

effective[x]

0..1

There are no (further) constraints on this element

Element id

Observation.effective[x]

Short description

Clinically relevant time/time-period for observation

Alternate names

Occurrence

Definition

Requirements

Knowing when an observation was deemed true is important to its relevance as well as determining trends.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Event.occurrence[x]
w5: FiveWs.done[x]
v2: OBX-14, and/or OBX-19 after v2.4 (depends on who observation made)
rim: effectiveTime

effectiveDateTime

There are no (further) constraints on this element

Data type

effectivePeriod

There are no (further) constraints on this element

Data type

effectiveTiming

There are no (further) constraints on this element

Data type

effectiveInstant

There are no (further) constraints on this element

Data type

issued

0..1

There are no (further) constraints on this element

Element id

Observation.issued

Short description

Date/Time this version was made available

Definition

The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.recorded
v2: OBR.22 (or MSH.7), or perhaps OBX-19 (depends on who observation made)
rim: participation[typeCode=AUT].time

performer

0..*

There are no (further) constraints on this element

Element id

Observation.performer

Short description

Who is responsible for the observation

Definition

Who was responsible for asserting the observed value as "true".

Requirements

May give a degree of confidence in the observation and also indicates where follow-up questions should be directed.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Event.performer.actor
w5: FiveWs.actor
v2: OBX.15 / (Practitioner) OBX-16, PRT-5:PRT-4='RO' / (Device) OBX-18 , PRT-10:PRT-4='EQUIP' / (Organization) OBX-23, PRT-8:PRT-4='PO'
rim: participation[typeCode=PRF]

value[x]

S Σ C

0..1

There are no (further) constraints on this element

Element id

Observation.value[x]

Short description

Actual result

Definition

The information determined as a result of making the observation, if the information has a simple value.

Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Conditions

The cardinality or value of this element may be affected by these constraints: obs-7

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|

valueQuantity

There are no (further) constraints on this element

Data type

valueCodeableConcept

There are no (further) constraints on this element

Data type

valueString

There are no (further) constraints on this element

Data type

valueBoolean

There are no (further) constraints on this element

Data type

valueInteger

There are no (further) constraints on this element

Data type

valueRange

There are no (further) constraints on this element

Data type

valueRatio

There are no (further) constraints on this element

Data type

valueSampledData

There are no (further) constraints on this element

Data type

valueTime

There are no (further) constraints on this element

Data type

valueDateTime

There are no (further) constraints on this element

Data type

valuePeriod

There are no (further) constraints on this element

Data type

dataAbsentReason

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.dataAbsentReason

Short description

Why the result is missing

Definition

Provides a reason why the expected value in the element Observation.value[x] is missing.

Requirements

For many results it is necessary to handle exceptional values in measurements.

Comments

Data type

Binding

Codes specifying why the result (Observation.value[x]) is missing.

Conditions

The cardinality or value of this element may be affected by these constraints: obs-6

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: value.nullFlavor

interpretation

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.interpretation

Short description

High, low, normal, etc.

Alternate names

Abnormal Flag

Definition

A categorical assessment of an observation value. For example, high, low, normal.

Requirements

For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.

Comments

Data type

Binding

Codes identifying interpretations of observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: < 260245000 |Findings values|
v2: OBX-8
rim: interpretationCode
sct-attr: 363713009 |Has interpretation|

note

0..*

There are no (further) constraints on this element

Element id

Observation.note

Short description

Comments about the observation

Definition

Comments about the observation or the results.

Requirements

Need to be able to provide free text additional information.

Comments

May include general statements about the observation, or statements about significant, unexpected or unreliable results values, or information about its source when relevant to its interpretation.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: NTE.3 (partner NTE to OBX, or sometimes another (child?) OBX)
rim: subjectOf.observationEvent[code="annotation"].value

bodySite

0..1

There are no (further) constraints on this element

Element id

Observation.bodySite

Short description

Observed body part

Definition

Indicates the site on the subject's body where the observation was made (i.e. the target site).

Comments

Only used if not implicit in code found in Observation.code. In many systems, this may be represented as a related observation instead of an inline component.

If the use case requires BodySite to be handled as a separate resource (e.g. to identify and track separately) then use the standard extension bodySite.

Data type

SNOMEDCTBodyStructures (example)

Binding

Codes describing anatomical locations. May include laterality.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: < 123037004 |Body structure|
v2: OBX-20
rim: targetSiteCode
sct-attr: 718497002 |Inherent location|

method

0..1

There are no (further) constraints on this element

Element id

Observation.method

Short description

How it was done

Definition

Indicates the mechanism used to perform the observation.

Requirements

In some cases, method can impact results and is thus used for determining whether results can be compared or determining significance of results.

Comments

Only used if not implicit in code for Observation.code.

Data type

Binding

Methods for simple observations.

ObservationMethods (example)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: OBX-17
rim: methodCode

specimen

0..1

There are no (further) constraints on this element

Element id

Observation.specimen

Short description

Specimen used for this observation

Definition

The specimen that was used when this observation was made.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: < 123038009 |Specimen|
v2: SPM segment
rim: participation[typeCode=SPC].specimen
sct-attr: 704319004 |Inherent in|

device

0..1

There are no (further) constraints on this element

Element id

Observation.device

Short description

(Measurement) Device

Definition

The device used to generate the observation data.

Comments

Note that this is not meant to represent a device involved in the transmission of the result, e.g., a gateway. Such devices may be documented using the Provenance resource where relevant.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: < 49062001 |Device|
v2: OBX-17 / PRT -10
rim: participation[typeCode=DEV]
sct-attr: 424226004 |Using device|

referenceRange

0..*

There are no (further) constraints on this element

Element id

Observation.referenceRange

Short description

Provides guide for interpretation

Definition

Requirements

Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
obs-3: Must have at least a low or a high or text
low.exists() or high.exists() or text.exists()

Mappings

v2: OBX.7
rim: outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]

0..1

There are no (further) constraints on this element

Element id

Observation.referenceRange.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Observation.referenceRange.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Observation.referenceRange.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

low

0..1

There are no (further) constraints on this element

Element id

Observation.referenceRange.low

Short description

Low Range, if relevant

Definition

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: obs-3

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: OBX-7
rim: value:IVL_PQ.low

high

0..1

There are no (further) constraints on this element

Element id

Observation.referenceRange.high

Short description

High Range, if relevant

Definition

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: obs-3

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: OBX-7
rim: value:IVL_PQ.high

type

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.referenceRange.type

Short description

Reference range qualifier

Definition

Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.

Requirements

Need to be able to say what kind of reference range this is - normal, recommended, therapeutic, etc., - for proper interpretation.

Comments

This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed.

Data type

ObservationReferenceRangeMeaningCodes (preferred)

Binding

Code for the meaning of a reference range.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: < 260245000 |Findings values| OR < 365860008 |General clinical state finding| OR < 250171008 |Clinical history or observation findings| OR < 415229000 |Racial group| OR < 365400002 |Finding of puberty stage| OR < 443938003 |Procedure carried out on subject|
v2: OBX-10
rim: interpretationCode

appliesTo

0..*

There are no (further) constraints on this element

Element id

Observation.referenceRange.appliesTo

Short description

Reference range population

Definition

Requirements

Need to be able to identify the target population for proper interpretation.

Comments

This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed.

Data type

ObservationReferenceRangeAppliesToCodes (example)

Binding

Codes identifying the population the reference range applies to.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: < 260245000 |Findings values| OR < 365860008 |General clinical state finding| OR < 250171008 |Clinical history or observation findings| OR < 415229000 |Racial group| OR < 365400002 |Finding of puberty stage| OR < 443938003 |Procedure carried out on subject|
v2: OBX-10
rim: interpretationCode

age

0..1

There are no (further) constraints on this element

Element id

Observation.referenceRange.age

Short description

Applicable age range, if relevant

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.

Requirements

Some analytes vary greatly over age.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: outboundRelationship[typeCode=PRCN].targetObservationCriterion[code="age"].value

text

0..1

There are no (further) constraints on this element

Element id

Observation.referenceRange.text

Short description

Text based reference range in an observation

Definition

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: OBX-7
rim: value:ST

hasMember

0..*

Reference(Observation | QuestionnaireResponse | MolecularSequence)

There are no (further) constraints on this element

Element id

Observation.hasMember

Short description

Related resource that belongs to the Observation group

Definition

This observation is 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.

Comments

Data type

Reference(Observation | QuestionnaireResponse | MolecularSequence)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: Relationships established by OBX-4 usage
rim: outBoundRelationship

derivedFrom

0..*

There are no (further) constraints on this element

Element id

Observation.derivedFrom

Short description

Related measurements the observation is made from

Definition

The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: Relationships established by OBX-4 usage
rim: .targetObservation

component

S Σ

0..*

Element id

Observation.component

Short description

Component results

Definition

Requirements

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

Data type

Slicing

Unordered, Open, by code(Pattern)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: containment by OBX-4?
rim: outBoundRelationship[typeCode=COMP]

(All Slices)

The requirements in this element apply to all slices

0..1

There are no (further) constraints on this element

Element id

Observation.component.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Observation.component.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Observation.component.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

code

S Σ

1..1

There are no (further) constraints on this element

Element id

Observation.component.code

Short description

Type of component observation (code / type)

Definition

Describes what was observed. Sometimes this is called the observation "code".

Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Data type

Binding

Codes identifying names of simple observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.what[x]
sct-concept: < 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|
v2: OBX-3
rim: code

value[x]

S Σ

0..1

There are no (further) constraints on this element

Element id

Observation.component.value[x]

Short description

Actual component result

Definition

The information determined as a result of making the observation, if the information has a simple value.

Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|

valueQuantity

There are no (further) constraints on this element

Data type

valueCodeableConcept

There are no (further) constraints on this element

Data type

valueString

There are no (further) constraints on this element

Data type

valueBoolean

There are no (further) constraints on this element

Data type

valueInteger

There are no (further) constraints on this element

Data type

valueRange

There are no (further) constraints on this element

Data type

valueRatio

There are no (further) constraints on this element

Data type

valueSampledData

There are no (further) constraints on this element

Data type

valueTime

There are no (further) constraints on this element

Data type

valueDateTime

There are no (further) constraints on this element

Data type

valuePeriod

There are no (further) constraints on this element

Data type

dataAbsentReason

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component.dataAbsentReason

Short description

Why the component result is missing

Definition

Provides a reason why the expected value in the element Observation.component.value[x] is missing.

Requirements

For many results it is necessary to handle exceptional values in measurements.

Comments

Data type

Binding

Codes specifying why the result (Observation.value[x]) is missing.

Conditions

The cardinality or value of this element may be affected by these constraints: obs-6

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: value.nullFlavor

interpretation

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component.interpretation

Short description

High, low, normal, etc.

Alternate names

Abnormal Flag

Definition

A categorical assessment of an observation value. For example, high, low, normal.

Requirements

For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.

Comments

Data type

Binding

Codes identifying interpretations of observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: < 260245000 |Findings values|
v2: OBX-8
rim: interpretationCode
sct-attr: 363713009 |Has interpretation|

referenceRange

0..*

There are no (further) constraints on this element

Element id

Observation.component.referenceRange

Short description

Provides guide for interpretation of component result

Definition

Guidance on how to interpret the value by comparison to a normal or recommended range.

Requirements

Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: OBX.7
rim: outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]

total

S Σ

0..1

There are no (further) constraints on this element

Element id

Observation.component:total

Short description

Component results

Definition

Requirements

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: containment by OBX-4?
rim: outBoundRelationship[typeCode=COMP]

0..1

There are no (further) constraints on this element

Element id

Observation.component:total.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Observation.component:total.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Observation.component:total.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

code

S Σ

1..1

CodeableConceptPattern

Element id

Observation.component:total.code

Short description

Type of component observation (code / type)

Definition

Describes what was observed. Sometimes this is called the observation "code".

Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Data type

Binding

Codes identifying names of simple observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://snomed.info/sct",
      "code": "258261001",
      "display": "Tumor volume (observable entity)"
    }
  ]
}

Mappings

w5: FiveWs.what[x]
sct-concept: < 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|
v2: OBX-3
rim: code

value[x]

S Σ

1..1

Pattern

Element id

Observation.component:total.value[x]

Short description

Actual component result

Definition

The information determined as a result of making the observation, if the information has a simple value.

Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "unit": "mL",
  "system": "http://unitsofmeasure.org",
  "code": "ml"
}

Mappings

sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|

valueQuantity

Data type

dataAbsentReason

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:total.dataAbsentReason

Short description

Why the component result is missing

Definition

Provides a reason why the expected value in the element Observation.component.value[x] is missing.

Requirements

For many results it is necessary to handle exceptional values in measurements.

Comments

Data type

Binding

Codes specifying why the result (Observation.value[x]) is missing.

Conditions

The cardinality or value of this element may be affected by these constraints: obs-6

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: value.nullFlavor

interpretation

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:total.interpretation

Short description

High, low, normal, etc.

Alternate names

Abnormal Flag

Definition

A categorical assessment of an observation value. For example, high, low, normal.

Requirements

For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.

Comments

Data type

Binding

Codes identifying interpretations of observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: < 260245000 |Findings values|
v2: OBX-8
rim: interpretationCode
sct-attr: 363713009 |Has interpretation|

referenceRange

0..*

There are no (further) constraints on this element

Element id

Observation.component:total.referenceRange

Short description

Provides guide for interpretation of component result

Definition

Guidance on how to interpret the value by comparison to a normal or recommended range.

Requirements

Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: OBX.7
rim: outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]

peritumoralEdema

S Σ

0..1

There are no (further) constraints on this element

Element id

Observation.component:peritumoralEdema

Short description

Component results

Definition

Requirements

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: containment by OBX-4?
rim: outBoundRelationship[typeCode=COMP]

0..1

There are no (further) constraints on this element

Element id

Observation.component:peritumoralEdema.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Observation.component:peritumoralEdema.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Observation.component:peritumoralEdema.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

code

S Σ

1..1

CodeableConceptPattern

Element id

Observation.component:peritumoralEdema.code

Short description

Type of component observation (code / type)

Definition

Describes what was observed. Sometimes this is called the observation "code".

Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Data type

Binding

Codes identifying names of simple observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl",
      "code": "C121674",
      "display": "Peritumoral Edema"
    }
  ]
}

Mappings

w5: FiveWs.what[x]
sct-concept: < 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|
v2: OBX-3
rim: code

value[x]

S Σ

1..1

Pattern

Element id

Observation.component:peritumoralEdema.value[x]

Short description

Actual component result

Definition

The information determined as a result of making the observation, if the information has a simple value.

Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "unit": "mL",
  "system": "http://unitsofmeasure.org",
  "code": "ml"
}

Mappings

sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|

valueQuantity

Data type

dataAbsentReason

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:peritumoralEdema.dataAbsentReason

Short description

Why the component result is missing

Definition

Provides a reason why the expected value in the element Observation.component.value[x] is missing.

Requirements

For many results it is necessary to handle exceptional values in measurements.

Comments

Data type

Binding

Codes specifying why the result (Observation.value[x]) is missing.

Conditions

The cardinality or value of this element may be affected by these constraints: obs-6

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: value.nullFlavor

interpretation

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:peritumoralEdema.interpretation

Short description

High, low, normal, etc.

Alternate names

Abnormal Flag

Definition

A categorical assessment of an observation value. For example, high, low, normal.

Requirements

For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.

Comments

Data type

Binding

Codes identifying interpretations of observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: < 260245000 |Findings values|
v2: OBX-8
rim: interpretationCode
sct-attr: 363713009 |Has interpretation|

referenceRange

0..*

There are no (further) constraints on this element

Element id

Observation.component:peritumoralEdema.referenceRange

Short description

Provides guide for interpretation of component result

Definition

Guidance on how to interpret the value by comparison to a normal or recommended range.

Requirements

Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: OBX.7
rim: outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]

enhancingTumor

S Σ

0..1

There are no (further) constraints on this element

Element id

Observation.component:enhancingTumor

Short description

Component results

Definition

Requirements

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: containment by OBX-4?
rim: outBoundRelationship[typeCode=COMP]

0..1

There are no (further) constraints on this element

Element id

Observation.component:enhancingTumor.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Observation.component:enhancingTumor.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Observation.component:enhancingTumor.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

code

S Σ

1..1

CodeableConceptPattern

Element id

Observation.component:enhancingTumor.code

Short description

Type of component observation (code / type)

Definition

Describes what was observed. Sometimes this is called the observation "code".

Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Data type

Binding

Codes identifying names of simple observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://omi.de/fhir/registry/CodeSystem/TodoCodesCS",
      "code": "enhancingTumor",
      "display": "Enhancing Tumor"
    }
  ]
}

Mappings

w5: FiveWs.what[x]
sct-concept: < 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|
v2: OBX-3
rim: code

value[x]

S Σ

1..1

Pattern

Element id

Observation.component:enhancingTumor.value[x]

Short description

Actual component result

Definition

The information determined as a result of making the observation, if the information has a simple value.

Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "unit": "mL",
  "system": "http://unitsofmeasure.org",
  "code": "ml"
}

Mappings

sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|

valueQuantity

Data type

dataAbsentReason

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:enhancingTumor.dataAbsentReason

Short description

Why the component result is missing

Definition

Provides a reason why the expected value in the element Observation.component.value[x] is missing.

Requirements

For many results it is necessary to handle exceptional values in measurements.

Comments

Data type

Binding

Codes specifying why the result (Observation.value[x]) is missing.

Conditions

The cardinality or value of this element may be affected by these constraints: obs-6

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: value.nullFlavor

interpretation

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:enhancingTumor.interpretation

Short description

High, low, normal, etc.

Alternate names

Abnormal Flag

Definition

A categorical assessment of an observation value. For example, high, low, normal.

Requirements

For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.

Comments

Data type

Binding

Codes identifying interpretations of observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: < 260245000 |Findings values|
v2: OBX-8
rim: interpretationCode
sct-attr: 363713009 |Has interpretation|

referenceRange

0..*

There are no (further) constraints on this element

Element id

Observation.component:enhancingTumor.referenceRange

Short description

Provides guide for interpretation of component result

Definition

Guidance on how to interpret the value by comparison to a normal or recommended range.

Requirements

Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: OBX.7
rim: outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]

necroticAndNonEnhancingTumor

S Σ

0..1

There are no (further) constraints on this element

Element id

Observation.component:necroticAndNonEnhancingTumor

Short description

Component results

Definition

Requirements

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: containment by OBX-4?
rim: outBoundRelationship[typeCode=COMP]

0..1

There are no (further) constraints on this element

Element id

Observation.component:necroticAndNonEnhancingTumor.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Observation.component:necroticAndNonEnhancingTumor.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Observation.component:necroticAndNonEnhancingTumor.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

code

S Σ

1..1

CodeableConceptPattern

Element id

Observation.component:necroticAndNonEnhancingTumor.code

Short description

Type of component observation (code / type)

Definition

Describes what was observed. Sometimes this is called the observation "code".

Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Data type

Binding

Codes identifying names of simple observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://omi.de/fhir/registry/CodeSystem/TodoCodesCS",
      "code": "necroticAndNonEnhancingTumor",
      "display": "Necrotic and Non-Enhancing Tumor"
    }
  ]
}

Mappings

w5: FiveWs.what[x]
sct-concept: < 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|
v2: OBX-3
rim: code

value[x]

S Σ

1..1

Pattern

Element id

Observation.component:necroticAndNonEnhancingTumor.value[x]

Short description

Actual component result

Definition

The information determined as a result of making the observation, if the information has a simple value.

Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "unit": "mL",
  "system": "http://unitsofmeasure.org",
  "code": "ml"
}

Mappings

sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|

valueQuantity

Data type

dataAbsentReason

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:necroticAndNonEnhancingTumor.dataAbsentReason

Short description

Why the component result is missing

Definition

Provides a reason why the expected value in the element Observation.component.value[x] is missing.

Requirements

For many results it is necessary to handle exceptional values in measurements.

Comments

Data type

Binding

Codes specifying why the result (Observation.value[x]) is missing.

Conditions

The cardinality or value of this element may be affected by these constraints: obs-6

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: value.nullFlavor

interpretation

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:necroticAndNonEnhancingTumor.interpretation

Short description

High, low, normal, etc.

Alternate names

Abnormal Flag

Definition

A categorical assessment of an observation value. For example, high, low, normal.

Requirements

For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.

Comments

Data type

Binding

Codes identifying interpretations of observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: < 260245000 |Findings values|
v2: OBX-8
rim: interpretationCode
sct-attr: 363713009 |Has interpretation|

referenceRange

0..*

There are no (further) constraints on this element

Element id

Observation.component:necroticAndNonEnhancingTumor.referenceRange

Short description

Provides guide for interpretation of component result

Definition

Guidance on how to interpret the value by comparison to a normal or recommended range.

Requirements

Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: OBX.7
rim: outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]

Variants / Biomarkers

GBMBiomarkerVariant (Observation)

Variant

There are no (further) constraints on this element

Element id

Observation

Short description

Variant

Alternate names

Vital Signs, Measurement, Results, Tests

Definition

Measurements and simple assertions made about a patient, device or other subject.

Comments

Data type

Variant

Constraints

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()
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
dataAbsentReason.empty() or value.empty()
obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()

Mappings

rim: Entity. Role, or Act
workflow: Event
sct-concept: < 363787002 |Observable entity|
v2: OBX
rim: Observation[classCode=OBS, moodCode=EVN]

0..1

There are no (further) constraints on this element

Element id

Observation.id

Short description

Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

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.

Data type

meta

0..1

There are no (further) constraints on this element

Element id

Observation.meta

Short description

Metadata about the resource

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.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

implicitRules

Σ ?!

0..1

There are no (further) constraints on this element

Element id

Observation.implicitRules

Short description

A set of rules under which this content was created

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

language

0..1

codeBinding

There are no (further) constraints on this element

Element id

Observation.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Data type

Binding

A human language.

Binding extensions

maxValueSet	AllLanguages

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

text

0..1

There are no (further) constraints on this element

Element id

Observation.text

Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: Act.text?

contained

0..*

There are no (further) constraints on this element

Element id

Observation.contained

Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

Comments

Data type

Mappings

rim: N/A

extension

0..*

There are no (further) constraints on this element

Element id

Observation.extension

Short description

Extension

Definition

An Extension

Data type

Slicing

Unordered, Open, by url(Value)

Constraints

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()

secondary-finding

0..1

There are no (further) constraints on this element

Element id

Observation.extension:secondary-finding

Short description

Secondary findings are genetic test results that provide information about variants in a gene unrelated to the primary purpose for the testing, most often discovered when [Whole Exome Sequencing (WES)](https://en.wikipedia.org/wiki/Exome_sequencing) or [Whole Genome Sequencing (WGS)](https://en.wikipedia.org/wiki/Whole_genome_sequencing) is performed. This extension should be used to denote when a genetic finding is being shared as a secondary finding, and ideally refer to a corresponding guideline or policy statement. For more detail, please see: https://ghr.nlm.nih.gov/primer/testing/secondaryfindings

Definition

Secondary findings are genetic test results that provide information about variants in a gene unrelated to the primary purpose for the testing, most often discovered when Whole Exome Sequencing (WES) or Whole Genome Sequencing (WGS) is performed. This extension should be used to denote when a genetic finding is being shared as a secondary finding, and ideally refer to a corresponding guideline or policy statement.

For more detail, please see: https://ghr.nlm.nih.gov/primer/testing/secondaryfindings.

Data type

http://hl7.org/fhir/StructureDefinition/observation-secondaryFinding

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

body-structure

0..1

Extension(Reference(BodyStructure))

There are no (further) constraints on this element

Element id

Observation.extension:body-structure

Short description

Target anatomic location or structure

Definition

Record details about the anatomical location of a specimen or body part. This resource may be used when a coded concept does not provide the necessary detail needed for the use case.

Data type

Extension(Reference(BodyStructure))

Extension URL

http://hl7.org/fhir/StructureDefinition/bodySite

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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()

modifierExtension

?! C

0..*

There are no (further) constraints on this element

Element id

Observation.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

identifier

0..*

There are no (further) constraints on this element

Element id

Observation.identifier

Short description

Business Identifier for observation

Definition

A unique identifier assigned to this observation.

Requirements

Allows observations to be distinguished and referenced.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Event.identifier
w5: FiveWs.identifier
v2: OBX.21 For OBX segments from systems without OBX-21 support a combination of ORC/OBR and OBX must be negotiated between trading partners to uniquely identify the OBX segment. Depending on how V2 has been implemented each of these may be an option: 1) OBR-3 + OBX-3 + OBX-4 or 2) OBR-3 + OBR-4 + OBX-3 + OBX-4 or 2) some other way to uniquely ID the OBR/ORC + OBX-3 + OBX-4.
rim: id

basedOn

0..*

There are no (further) constraints on this element

Element id

Observation.basedOn

Short description

Fulfills plan, proposal or order

Alternate names

Fulfills

Definition

A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.

Requirements

Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Event.basedOn
v2: ORC
rim: .inboundRelationship[typeCode=COMP].source[moodCode=EVN]

partOf

0..*

There are no (further) constraints on this element

Element id

Observation.partOf

Short description

Part of referenced event

Alternate names

Container

Definition

A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.

Comments

To link an Observation to an Encounter use encounter. See the Notes below for guidance on referencing another Observation.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Event.partOf
v2: Varies by domain
rim: .outboundRelationship[typeCode=FLFS].target

status

Σ ?!

1..1

codeBinding

There are no (further) constraints on this element

Element id

Observation.status

Short description

registered | preliminary | final | amended +

Definition

The status of the result value.

Requirements

Need to track the status of individual results. Some results are finalized before the whole report is finalized.

Comments

This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

Data type

Binding

Codes providing the status of an observation.

ObservationStatus (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Event.status
w5: FiveWs.status
sct-concept: < 445584004 |Report by finality status|
v2: OBX-11
rim: status Amended & Final are differentiated by whether it is the subject of a ControlAct event with a type of "revise"

category

1..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.category

Short description

Classification of type of observation

Definition

A code that classifies the general type of observation being made.

Requirements

Used for filtering what observations are retrieved and displayed.

Comments

Data type

Slicing

Unordered, Open, by coding(Value)

Slice based on the category.code pattern

Binding

Codes for high level observation categories.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.class
rim: .outboundRelationship[typeCode="COMP].target[classCode="LIST", moodCode="EVN"].code

labCategory

1..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.category:labCategory

Short description

Classification of type of observation

Definition

A code that classifies the general type of observation being made.

Requirements

Used for filtering what observations are retrieved and displayed.

Comments

Data type

Binding

Codes for high level observation categories.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.class
rim: .outboundRelationship[typeCode="COMP].target[classCode="LIST", moodCode="EVN"].code

0..1

There are no (further) constraints on this element

Element id

Observation.category:labCategory.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Observation.category:labCategory.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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()

Mappings

rim: n/a

coding

1..*

CodingPattern

There are no (further) constraints on this element

Element id

Observation.category:labCategory.coding

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

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.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "system": "http://terminology.hl7.org/CodeSystem/observation-category",
  "code": "laboratory"
}

Mappings

v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

text

0..1

There are no (further) constraints on this element

Element id

Observation.category:labCategory.text

Short description

Plain text representation of the concept

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.

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.

Comments

Very often the text is the same as a displayName of one of the codings.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.9. But note many systems use C*E.2 for this
rim: ./originalText[mediaType/code="text/plain"]/data
orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

code

1..1

CodeableConceptPattern

There are no (further) constraints on this element

Element id

Observation.code

Short description

69548-6

Alternate names

Name

Definition

Describes what was observed. Sometimes this is called the observation "name".

Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and, if present, component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Data type

Binding

Codes identifying names of simple observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "69548-6"
    }
  ]
}

Mappings

workflow: Event.code
w5: FiveWs.what[x]
sct-concept: < 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|
v2: OBX-3
rim: code
sct-attr: 116680003 |Is a|

subject

0..1

There are no (further) constraints on this element

Element id

Observation.subject

Short description

Who and/or what the observation is about

Definition

Requirements

Observations have no value if you don't know who or what they're about.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Event.subject
w5: FiveWs.subject[x]
v2: PID-3
rim: participation[typeCode=RTGT]
w5: FiveWs.subject

focus

0..*

There are no (further) constraints on this element

Element id

Observation.focus

Short description

What the observation is about, when it is not about the subject of record

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.subject[x]
v2: OBX-3
rim: participation[typeCode=SBJ]
w5: FiveWs.subject

encounter

0..1

There are no (further) constraints on this element

Element id

Observation.encounter

Short description

Healthcare event during which this observation is made

Alternate names

Context

Definition

The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.

Requirements

For some observations it may be important to know the link between an observation and a particular encounter.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Event.context
w5: FiveWs.context
v2: PV1
rim: inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]

effective[x]

0..1

There are no (further) constraints on this element

Element id

Observation.effective[x]

Short description

Clinically relevant time/time-period for observation

Alternate names

Occurrence

Definition

Requirements

Knowing when an observation was deemed true is important to its relevance as well as determining trends.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Event.occurrence[x]
w5: FiveWs.done[x]
v2: OBX-14, and/or OBX-19 after v2.4 (depends on who observation made)
rim: effectiveTime

effectiveDateTime

There are no (further) constraints on this element

Data type

effectivePeriod

There are no (further) constraints on this element

Data type

effectiveTiming

There are no (further) constraints on this element

Data type

effectiveInstant

There are no (further) constraints on this element

Data type

issued

0..1

There are no (further) constraints on this element

Element id

Observation.issued

Short description

Date/Time this version was made available

Definition

The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.recorded
v2: OBR.22 (or MSH.7), or perhaps OBX-19 (depends on who observation made)
rim: participation[typeCode=AUT].time

performer

0..*

There are no (further) constraints on this element

Element id

Observation.performer

Short description

Who is responsible for the observation

Definition

Who was responsible for asserting the observed value as "true".

Requirements

May give a degree of confidence in the observation and also indicates where follow-up questions should be directed.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Event.performer.actor
w5: FiveWs.actor
v2: OBX.15 / (Practitioner) OBX-16, PRT-5:PRT-4='RO' / (Device) OBX-18 , PRT-10:PRT-4='EQUIP' / (Organization) OBX-23, PRT-8:PRT-4='PO'
rim: participation[typeCode=PRF]

value[x]

Σ C

0..1

Element id

Observation.value[x]

Short description

Actual result

Definition

The information determined as a result of making the observation, if the information has a simple value.

Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Slicing

Unordered, Open, by $this(Type)

Conditions

The cardinality or value of this element may be affected by these constraints: obs-7

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|

valueCodeableConcept

Σ C

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept

Short description

Indeterminate | No call | Present | Absent.

Definition

The presence or absence of the variant described in the components. If not searching for specific variations and merely reporting what's found, the profile's value should be set to 'Present'.

Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Data type

http://loinc.org/vs/LL1971-2 (required)

Binding

Conditions

The cardinality or value of this element may be affected by these constraints: obs-7

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|

dataAbsentReason

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.dataAbsentReason

Short description

Why the result is missing

Definition

Provides a reason why the expected value in the element Observation.value[x] is missing.

Requirements

For many results it is necessary to handle exceptional values in measurements.

Comments

Data type

Binding

Codes specifying why the result (Observation.value[x]) is missing.

Conditions

The cardinality or value of this element may be affected by these constraints: obs-6

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: value.nullFlavor

interpretation

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.interpretation

Short description

High, low, normal, etc.

Alternate names

Abnormal Flag

Definition

A categorical assessment of an observation value. For example, high, low, normal.

Requirements

For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.

Comments

Data type

Binding

Codes identifying interpretations of observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: < 260245000 |Findings values|
v2: OBX-8
rim: interpretationCode
sct-attr: 363713009 |Has interpretation|

note

0..*

CodedAnnotation

There are no (further) constraints on this element

Element id

Observation.note

Short description

Comments about the Observation that also contain a coded type

Definition

A text note which also contains information about who made the statement and when.

Requirements

Need to be able to provide free text additional information. Notes SHALL NOT contain information which can be captured in a structured way.

Comments

May include general statements about the observation, or statements about significant, unexpected or unreliable results values, or information about its source when relevant to its interpretation. The CodedAnnotation data type, while not allowing for or intending to make the content computable, does allow the author to indicate the type of note. This does not replace the use of interpretation, value, or component values. One important note is that Annotation is a FHIR data type, this is NOT about annotations in the genomic context.

Data type

CodedAnnotation

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: N/A
rim: Act

bodySite

0..1

There are no (further) constraints on this element

Element id

Observation.bodySite

Short description

Observed body part

Definition

Indicates the site on the subject's body where the observation was made (i.e. the target site).

Comments

Only used if not implicit in code found in Observation.code. In many systems, this may be represented as a related observation instead of an inline component.

If the use case requires BodySite to be handled as a separate resource (e.g. to identify and track separately) then use the standard extension bodySite.

Data type

SNOMEDCTBodyStructures (example)

Binding

Codes describing anatomical locations. May include laterality.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: < 123037004 |Body structure|
v2: OBX-20
rim: targetSiteCode
sct-attr: 718497002 |Inherent location|

method

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.method

Short description

Sequencing | SNP array | PCR | Computational analysis | ...

Definition

Indicates the mechanism used to perform the observation.

Requirements

In some cases, method can impact results and is thus used for determining whether results can be compared or determining significance of results.

Comments

Only used if not implicit in code for Observation.code.

Data type

http://loinc.org/vs/LL4048-6 (extensible)

Binding

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: OBX-17
rim: methodCode

specimen

0..1

There are no (further) constraints on this element

Element id

Observation.specimen

Short description

Specimen used for this observation

Definition

The specimen that was used when this observation was made.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: < 123038009 |Specimen|
v2: SPM segment
rim: participation[typeCode=SPC].specimen
sct-attr: 704319004 |Inherent in|

device

0..1

There are no (further) constraints on this element

Element id

Observation.device

Short description

(Measurement) Device

Definition

The device used to generate the observation data.

Comments

Note that this is not meant to represent a device involved in the transmission of the result, e.g., a gateway. Such devices may be documented using the Provenance resource where relevant.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: < 49062001 |Device|
v2: OBX-17 / PRT -10
rim: participation[typeCode=DEV]
sct-attr: 424226004 |Using device|

referenceRange

0..*

There are no (further) constraints on this element

Element id

Observation.referenceRange

Short description

Provides guide for interpretation

Definition

Requirements

Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
obs-3: Must have at least a low or a high or text
low.exists() or high.exists() or text.exists()

Mappings

v2: OBX.7
rim: outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]

0..1

There are no (further) constraints on this element

Element id

Observation.referenceRange.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Observation.referenceRange.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Observation.referenceRange.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

low

0..1

There are no (further) constraints on this element

Element id

Observation.referenceRange.low

Short description

Low Range, if relevant

Definition

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: obs-3

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: OBX-7
rim: value:IVL_PQ.low

high

0..1

There are no (further) constraints on this element

Element id

Observation.referenceRange.high

Short description

High Range, if relevant

Definition

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: obs-3

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: OBX-7
rim: value:IVL_PQ.high

type

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.referenceRange.type

Short description

Reference range qualifier

Definition

Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.

Requirements

Need to be able to say what kind of reference range this is - normal, recommended, therapeutic, etc., - for proper interpretation.

Comments

This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed.

Data type

ObservationReferenceRangeMeaningCodes (preferred)

Binding

Code for the meaning of a reference range.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: < 260245000 |Findings values| OR < 365860008 |General clinical state finding| OR < 250171008 |Clinical history or observation findings| OR < 415229000 |Racial group| OR < 365400002 |Finding of puberty stage| OR < 443938003 |Procedure carried out on subject|
v2: OBX-10
rim: interpretationCode

appliesTo

0..*

There are no (further) constraints on this element

Element id

Observation.referenceRange.appliesTo

Short description

Reference range population

Definition

Requirements

Need to be able to identify the target population for proper interpretation.

Comments

This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed.

Data type

ObservationReferenceRangeAppliesToCodes (example)

Binding

Codes identifying the population the reference range applies to.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: < 260245000 |Findings values| OR < 365860008 |General clinical state finding| OR < 250171008 |Clinical history or observation findings| OR < 415229000 |Racial group| OR < 365400002 |Finding of puberty stage| OR < 443938003 |Procedure carried out on subject|
v2: OBX-10
rim: interpretationCode

age

0..1

There are no (further) constraints on this element

Element id

Observation.referenceRange.age

Short description

Applicable age range, if relevant

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.

Requirements

Some analytes vary greatly over age.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: outboundRelationship[typeCode=PRCN].targetObservationCriterion[code="age"].value

text

0..1

There are no (further) constraints on this element

Element id

Observation.referenceRange.text

Short description

Text based reference range in an observation

Definition

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: OBX-7
rim: value:ST

hasMember

0..*

Reference(Observation | QuestionnaireResponse | MolecularSequence)

There are no (further) constraints on this element

Element id

Observation.hasMember

Short description

Related resource that belongs to the Observation group

Definition

This observation is 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.

Comments

Data type

Reference(Observation | QuestionnaireResponse | MolecularSequence)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: Relationships established by OBX-4 usage
rim: outBoundRelationship

derivedFrom

0..*

There are no (further) constraints on this element

Element id

Observation.derivedFrom

Short description

Related measurements the observation is made from

Definition

The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: Relationships established by OBX-4 usage
rim: .targetObservation

component

0..*

There are no (further) constraints on this element

Element id

Observation.component

Short description

Component results

Definition

Requirements

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

Data type

Slicing

Unordered, Open, by code(Pattern)

Slice based on the component.code pattern

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: containment by OBX-4?
rim: outBoundRelationship[typeCode=COMP]

(All Slices)

The requirements in this element apply to all slices

0..1

There are no (further) constraints on this element

Element id

Observation.component.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Observation.component.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Observation.component.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

code

1..1

There are no (further) constraints on this element

Element id

Observation.component.code

Short description

Type of component observation (code / type)

Definition

Describes what was observed. Sometimes this is called the observation "code".

Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Data type

Binding

Codes identifying names of simple observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.what[x]
sct-concept: < 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|
v2: OBX-3
rim: code

value[x]

0..1

There are no (further) constraints on this element

Element id

Observation.component.value[x]

Short description

Actual component result

Definition

The information determined as a result of making the observation, if the information has a simple value.

Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|

valueQuantity

There are no (further) constraints on this element

Data type

valueCodeableConcept

There are no (further) constraints on this element

Data type

valueString

There are no (further) constraints on this element

Data type

valueBoolean

There are no (further) constraints on this element

Data type

valueInteger

There are no (further) constraints on this element

Data type

valueRange

There are no (further) constraints on this element

Data type

valueRatio

There are no (further) constraints on this element

Data type

valueSampledData

There are no (further) constraints on this element

Data type

valueTime

There are no (further) constraints on this element

Data type

valueDateTime

There are no (further) constraints on this element

Data type

valuePeriod

There are no (further) constraints on this element

Data type

dataAbsentReason

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component.dataAbsentReason

Short description

Why the component result is missing

Definition

Provides a reason why the expected value in the element Observation.component.value[x] is missing.

Requirements

For many results it is necessary to handle exceptional values in measurements.

Comments

Data type

Binding

Codes specifying why the result (Observation.value[x]) is missing.

Conditions

The cardinality or value of this element may be affected by these constraints: obs-6

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: value.nullFlavor

interpretation

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component.interpretation

Short description

High, low, normal, etc.

Alternate names

Abnormal Flag

Definition

A categorical assessment of an observation value. For example, high, low, normal.

Requirements

For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.

Comments

Data type

Binding

Codes identifying interpretations of observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: < 260245000 |Findings values|
v2: OBX-8
rim: interpretationCode
sct-attr: 363713009 |Has interpretation|

referenceRange

0..*

There are no (further) constraints on this element

Element id

Observation.component.referenceRange

Short description

Provides guide for interpretation of component result

Definition

Guidance on how to interpret the value by comparison to a normal or recommended range.

Requirements

Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: OBX.7
rim: outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]

conclusion-string

0..1

There are no (further) constraints on this element

Element id

Observation.component:conclusion-string

Short description

Clinical Conclusion

Definition

Concise and clinically contextualized summary conclusion (interpretation/impression) of the observation

Requirements

Need to be able to provide a conclusion that is not lost among the basic result data.

Comments

An example would be the interpretative information, typically canned, about a variant identified in the patient.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: containment by OBX-4?
rim: outBoundRelationship[typeCode=COMP]

0..1

There are no (further) constraints on this element

Element id

Observation.component:conclusion-string.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Observation.component:conclusion-string.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Observation.component:conclusion-string.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

code

1..1

CodeableConceptPattern

There are no (further) constraints on this element

Element id

Observation.component:conclusion-string.code

Short description

conclusion-string

Definition

Describes what was observed. Sometimes this is called the observation "code".

Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Data type

Binding

Codes identifying names of simple observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://hl7.org/fhir/uv/genomics-reporting/CodeSystem/tbd-codes-cs",
      "code": "conclusion-string"
    }
  ]
}

Mappings

w5: FiveWs.what[x]
sct-concept: < 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|
v2: OBX-3
rim: code

value[x]

0..1

There are no (further) constraints on this element

Element id

Observation.component:conclusion-string.value[x]

Short description

Summary conclusion (interpretation/impression)

Definition

The information determined as a result of making the observation, if the information has a simple value.

Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|

valueString

There are no (further) constraints on this element

Data type

dataAbsentReason

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:conclusion-string.dataAbsentReason

Short description

Why the component result is missing

Definition

Provides a reason why the expected value in the element Observation.component.value[x] is missing.

Requirements

For many results it is necessary to handle exceptional values in measurements.

Comments

Data type

Binding

Codes specifying why the result (Observation.value[x]) is missing.

Conditions

The cardinality or value of this element may be affected by these constraints: obs-6

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: value.nullFlavor

interpretation

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:conclusion-string.interpretation

Short description

High, low, normal, etc.

Alternate names

Abnormal Flag

Definition

A categorical assessment of an observation value. For example, high, low, normal.

Requirements

For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.

Comments

Data type

Binding

Codes identifying interpretations of observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: < 260245000 |Findings values|
v2: OBX-8
rim: interpretationCode
sct-attr: 363713009 |Has interpretation|

referenceRange

0..*

There are no (further) constraints on this element

Element id

Observation.component:conclusion-string.referenceRange

Short description

Provides guide for interpretation of component result

Definition

Guidance on how to interpret the value by comparison to a normal or recommended range.

Requirements

Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: OBX.7
rim: outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]

gene-studied

0..*

There are no (further) constraints on this element

Element id

Observation.component:gene-studied

Short description

Gene Studied

Definition

The gene(s) on which the variant is located.

Requirements

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: containment by OBX-4?
rim: outBoundRelationship[typeCode=COMP]

0..1

There are no (further) constraints on this element

Element id

Observation.component:gene-studied.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Observation.component:gene-studied.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Observation.component:gene-studied.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

code

1..1

CodeableConceptPattern

There are no (further) constraints on this element

Element id

Observation.component:gene-studied.code

Short description

48018-6

Definition

Describes what was observed. Sometimes this is called the observation "code".

Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Data type

Binding

Codes identifying names of simple observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "48018-6"
    }
  ]
}

Mappings

w5: FiveWs.what[x]
sct-concept: < 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|
v2: OBX-3
rim: code

value[x]

1..1

Binding

There are no (further) constraints on this element

Element id

Observation.component:gene-studied.value[x]

Short description

The HGNC gene symbol is to be used as display text and the HGNC gene ID used as the code. If no HGNC code issued for this gene yet, NCBI gene IDs SHALL be used.

Definition

The information determined as a result of making the observation, if the information has a simple value.

Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Binding

HGNCVS (extensible)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|

valueCodeableConcept

There are no (further) constraints on this element

Data type

dataAbsentReason

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:gene-studied.dataAbsentReason

Short description

Why the component result is missing

Definition

Provides a reason why the expected value in the element Observation.component.value[x] is missing.

Requirements

For many results it is necessary to handle exceptional values in measurements.

Comments

Data type

Binding

Codes specifying why the result (Observation.value[x]) is missing.

Conditions

The cardinality or value of this element may be affected by these constraints: obs-6

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: value.nullFlavor

interpretation

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:gene-studied.interpretation

Short description

High, low, normal, etc.

Alternate names

Abnormal Flag

Definition

A categorical assessment of an observation value. For example, high, low, normal.

Requirements

For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.

Comments

Data type

Binding

Codes identifying interpretations of observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: < 260245000 |Findings values|
v2: OBX-8
rim: interpretationCode
sct-attr: 363713009 |Has interpretation|

referenceRange

0..*

There are no (further) constraints on this element

Element id

Observation.component:gene-studied.referenceRange

Short description

Provides guide for interpretation of component result

Definition

Guidance on how to interpret the value by comparison to a normal or recommended range.

Requirements

Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: OBX.7
rim: outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]

cytogenetic-location

0..*

There are no (further) constraints on this element

Element id

Observation.component:cytogenetic-location

Short description

Cytogenetic (Chromosome) Location

Definition

The relevant chromosomal region. The combination of numbers and letters provide a genetic 'address'.

Requirements

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: containment by OBX-4?
rim: outBoundRelationship[typeCode=COMP]

0..1

There are no (further) constraints on this element

Element id

Observation.component:cytogenetic-location.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Observation.component:cytogenetic-location.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Observation.component:cytogenetic-location.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

code

1..1

CodeableConceptPattern

There are no (further) constraints on this element

Element id

Observation.component:cytogenetic-location.code

Short description

48001-2

Definition

Describes what was observed. Sometimes this is called the observation "code".

Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Data type

Binding

Codes identifying names of simple observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "48001-2"
    }
  ]
}

Mappings

w5: FiveWs.what[x]
sct-concept: < 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|
v2: OBX-3
rim: code

value[x]

1..1

There are no (further) constraints on this element

Element id

Observation.component:cytogenetic-location.value[x]

Short description

Example: 1q21.1

Definition

The information determined as a result of making the observation, if the information has a simple value.

Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|

valueCodeableConcept

There are no (further) constraints on this element

Data type

dataAbsentReason

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:cytogenetic-location.dataAbsentReason

Short description

Why the component result is missing

Definition

Provides a reason why the expected value in the element Observation.component.value[x] is missing.

Requirements

For many results it is necessary to handle exceptional values in measurements.

Comments

Data type

Binding

Codes specifying why the result (Observation.value[x]) is missing.

Conditions

The cardinality or value of this element may be affected by these constraints: obs-6

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: value.nullFlavor

interpretation

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:cytogenetic-location.interpretation

Short description

High, low, normal, etc.

Alternate names

Abnormal Flag

Definition

A categorical assessment of an observation value. For example, high, low, normal.

Requirements

For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.

Comments

Data type

Binding

Codes identifying interpretations of observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: < 260245000 |Findings values|
v2: OBX-8
rim: interpretationCode
sct-attr: 363713009 |Has interpretation|

referenceRange

0..*

There are no (further) constraints on this element

Element id

Observation.component:cytogenetic-location.referenceRange

Short description

Provides guide for interpretation of component result

Definition

Guidance on how to interpret the value by comparison to a normal or recommended range.

Requirements

Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: OBX.7
rim: outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]

reference-sequence-assembly

0..*

There are no (further) constraints on this element

Element id

Observation.component:reference-sequence-assembly

Short description

Human Reference Sequence Assembly

Definition

The reference genome/assembly used in this analysis.

Requirements

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: containment by OBX-4?
rim: outBoundRelationship[typeCode=COMP]

0..1

There are no (further) constraints on this element

Element id

Observation.component:reference-sequence-assembly.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Observation.component:reference-sequence-assembly.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Observation.component:reference-sequence-assembly.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

code

1..1

CodeableConceptPattern

There are no (further) constraints on this element

Element id

Observation.component:reference-sequence-assembly.code

Short description

62374-4

Definition

Describes what was observed. Sometimes this is called the observation "code".

Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Data type

Binding

Codes identifying names of simple observations.

http://loinc.org/vs/LL1040-6 (extensible)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "62374-4"
    }
  ]
}

Mappings

w5: FiveWs.what[x]
sct-concept: < 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|
v2: OBX-3
rim: code

value[x]

1..1

Binding

There are no (further) constraints on this element

Element id

Observation.component:reference-sequence-assembly.value[x]

Short description

GRCh37 | GRCh38 | ...

Definition

The information determined as a result of making the observation, if the information has a simple value.

Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Binding

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|

valueCodeableConcept

There are no (further) constraints on this element

Data type

dataAbsentReason

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:reference-sequence-assembly.dataAbsentReason

Short description

Why the component result is missing

Definition

Provides a reason why the expected value in the element Observation.component.value[x] is missing.

Requirements

For many results it is necessary to handle exceptional values in measurements.

Comments

Data type

Binding

Codes specifying why the result (Observation.value[x]) is missing.

Conditions

The cardinality or value of this element may be affected by these constraints: obs-6

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: value.nullFlavor

interpretation

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:reference-sequence-assembly.interpretation

Short description

High, low, normal, etc.

Alternate names

Abnormal Flag

Definition

A categorical assessment of an observation value. For example, high, low, normal.

Requirements

For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.

Comments

Data type

Binding

Codes identifying interpretations of observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: < 260245000 |Findings values|
v2: OBX-8
rim: interpretationCode
sct-attr: 363713009 |Has interpretation|

referenceRange

0..*

There are no (further) constraints on this element

Element id

Observation.component:reference-sequence-assembly.referenceRange

Short description

Provides guide for interpretation of component result

Definition

Guidance on how to interpret the value by comparison to a normal or recommended range.

Requirements

Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: OBX.7
rim: outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]

coding-hgvs

0..1

There are no (further) constraints on this element

Element id

Observation.component:coding-hgvs

Short description

Coding (cDNA) Change - cHGVS

Definition

Description of the coding (cDNA) sequence change using a valid HGVS-formatted string.

Requirements

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: containment by OBX-4?
rim: outBoundRelationship[typeCode=COMP]

0..1

There are no (further) constraints on this element

Element id

Observation.component:coding-hgvs.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Observation.component:coding-hgvs.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Observation.component:coding-hgvs.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

code

1..1

CodeableConceptPattern

There are no (further) constraints on this element

Element id

Observation.component:coding-hgvs.code

Short description

48004-6

Definition

Describes what was observed. Sometimes this is called the observation "code".

Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Data type

Binding

Codes identifying names of simple observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "48004-6"
    }
  ]
}

Mappings

w5: FiveWs.what[x]
sct-concept: < 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|
v2: OBX-3
rim: code

value[x]

1..1

Binding

There are no (further) constraints on this element

Element id

Observation.component:coding-hgvs.value[x]

Short description

A valid HGVS-formatted 'c.' string, e.g. NM_005228.5:c.2369C>T.

Definition

The information determined as a result of making the observation, if the information has a simple value.

Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Binding

HGVSVS (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|

valueCodeableConcept

There are no (further) constraints on this element

Data type

dataAbsentReason

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:coding-hgvs.dataAbsentReason

Short description

Why the component result is missing

Definition

Provides a reason why the expected value in the element Observation.component.value[x] is missing.

Requirements

For many results it is necessary to handle exceptional values in measurements.

Comments

Data type

Binding

Codes specifying why the result (Observation.value[x]) is missing.

Conditions

The cardinality or value of this element may be affected by these constraints: obs-6

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: value.nullFlavor

interpretation

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:coding-hgvs.interpretation

Short description

High, low, normal, etc.

Alternate names

Abnormal Flag

Definition

A categorical assessment of an observation value. For example, high, low, normal.

Requirements

For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.

Comments

Data type

Binding

Codes identifying interpretations of observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: < 260245000 |Findings values|
v2: OBX-8
rim: interpretationCode
sct-attr: 363713009 |Has interpretation|

referenceRange

0..*

There are no (further) constraints on this element

Element id

Observation.component:coding-hgvs.referenceRange

Short description

Provides guide for interpretation of component result

Definition

Guidance on how to interpret the value by comparison to a normal or recommended range.

Requirements

Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: OBX.7
rim: outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]

genomic-hgvs

0..1

There are no (further) constraints on this element

Element id

Observation.component:genomic-hgvs

Short description

Genomic (gDNA) Change - gHGVS

Definition

Description of the genomic (gDNA) sequence change using a valid HGVS-formatted string.

Requirements

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: containment by OBX-4?
rim: outBoundRelationship[typeCode=COMP]

0..1

There are no (further) constraints on this element

Element id

Observation.component:genomic-hgvs.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Observation.component:genomic-hgvs.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Observation.component:genomic-hgvs.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

code

1..1

CodeableConceptPattern

There are no (further) constraints on this element

Element id

Observation.component:genomic-hgvs.code

Short description

81290-9

Definition

Describes what was observed. Sometimes this is called the observation "code".

Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Data type

Binding

Codes identifying names of simple observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "81290-9"
    }
  ]
}

Mappings

w5: FiveWs.what[x]
sct-concept: < 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|
v2: OBX-3
rim: code

value[x]

1..1

Binding

There are no (further) constraints on this element

Element id

Observation.component:genomic-hgvs.value[x]

Short description

A valid HGVS-formatted 'g.' string, e.g. NC_000016.9:g.2124200_2138612dup

Definition

The information determined as a result of making the observation, if the information has a simple value.

Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Binding

HGVSVS (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|

valueCodeableConcept

There are no (further) constraints on this element

Data type

dataAbsentReason

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:genomic-hgvs.dataAbsentReason

Short description

Why the component result is missing

Definition

Provides a reason why the expected value in the element Observation.component.value[x] is missing.

Requirements

For many results it is necessary to handle exceptional values in measurements.

Comments

Data type

Binding

Codes specifying why the result (Observation.value[x]) is missing.

Conditions

The cardinality or value of this element may be affected by these constraints: obs-6

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: value.nullFlavor

interpretation

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:genomic-hgvs.interpretation

Short description

High, low, normal, etc.

Alternate names

Abnormal Flag

Definition

A categorical assessment of an observation value. For example, high, low, normal.

Requirements

For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.

Comments

Data type

Binding

Codes identifying interpretations of observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: < 260245000 |Findings values|
v2: OBX-8
rim: interpretationCode
sct-attr: 363713009 |Has interpretation|

referenceRange

0..*

There are no (further) constraints on this element

Element id

Observation.component:genomic-hgvs.referenceRange

Short description

Provides guide for interpretation of component result

Definition

Guidance on how to interpret the value by comparison to a normal or recommended range.

Requirements

Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: OBX.7
rim: outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]

cytogenomic-nomenclature

0..1

There are no (further) constraints on this element

Element id

Observation.component:cytogenomic-nomenclature

Short description

Cytogenomic Nomenclature (ISCN)

Definition

Fully describes a variant with a single code. Typically a large variant such as a mosaic, abnormal chromosome numbers, etc.

Requirements

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: containment by OBX-4?
rim: outBoundRelationship[typeCode=COMP]

0..1

There are no (further) constraints on this element

Element id

Observation.component:cytogenomic-nomenclature.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Observation.component:cytogenomic-nomenclature.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Observation.component:cytogenomic-nomenclature.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

code

1..1

CodeableConceptPattern

There are no (further) constraints on this element

Element id

Observation.component:cytogenomic-nomenclature.code

Short description

81291-7

Definition

Describes what was observed. Sometimes this is called the observation "code".

Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Data type

Binding

Codes identifying names of simple observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "81291-7"
    }
  ]
}

Mappings

w5: FiveWs.what[x]
sct-concept: < 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|
v2: OBX-3
rim: code

value[x]

1..1

There are no (further) constraints on this element

Element id

Observation.component:cytogenomic-nomenclature.value[x]

Short description

Actual component result

Definition

The information determined as a result of making the observation, if the information has a simple value.

Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Binding

Binding not yet defined

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|

valueCodeableConcept

There are no (further) constraints on this element

Data type

dataAbsentReason

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:cytogenomic-nomenclature.dataAbsentReason

Short description

Why the component result is missing

Definition

Provides a reason why the expected value in the element Observation.component.value[x] is missing.

Requirements

For many results it is necessary to handle exceptional values in measurements.

Comments

Data type

Binding

Codes specifying why the result (Observation.value[x]) is missing.

Conditions

The cardinality or value of this element may be affected by these constraints: obs-6

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: value.nullFlavor

interpretation

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:cytogenomic-nomenclature.interpretation

Short description

High, low, normal, etc.

Alternate names

Abnormal Flag

Definition

A categorical assessment of an observation value. For example, high, low, normal.

Requirements

For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.

Comments

Data type

Binding

Codes identifying interpretations of observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: < 260245000 |Findings values|
v2: OBX-8
rim: interpretationCode
sct-attr: 363713009 |Has interpretation|

referenceRange

0..*

There are no (further) constraints on this element

Element id

Observation.component:cytogenomic-nomenclature.referenceRange

Short description

Provides guide for interpretation of component result

Definition

Guidance on how to interpret the value by comparison to a normal or recommended range.

Requirements

Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: OBX.7
rim: outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]

genomic-ref-seq

0..1

There are no (further) constraints on this element

Element id

Observation.component:genomic-ref-seq

Short description

Genomic Reference Sequence

Definition

ID of the genomic reference sequence, which includes transcribed and non transcribed stretches

Requirements

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: containment by OBX-4?
rim: outBoundRelationship[typeCode=COMP]

0..1

There are no (further) constraints on this element

Element id

Observation.component:genomic-ref-seq.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Observation.component:genomic-ref-seq.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Observation.component:genomic-ref-seq.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

code

1..1

CodeableConceptPattern

There are no (further) constraints on this element

Element id

Observation.component:genomic-ref-seq.code

Short description

48013-7

Definition

Describes what was observed. Sometimes this is called the observation "code".

Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Data type

Binding

Codes identifying names of simple observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "48013-7"
    }
  ]
}

Mappings

w5: FiveWs.what[x]
sct-concept: < 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|
v2: OBX-3
rim: code

value[x]

1..1

There are no (further) constraints on this element

Element id

Observation.component:genomic-ref-seq.value[x]

Short description

Versioned genomic reference sequence identifier

Definition

The information determined as a result of making the observation, if the information has a simple value.

Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Binding

Multiple bindings acceptable (NCBI or LRG)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|

valueCodeableConcept

There are no (further) constraints on this element

Data type

dataAbsentReason

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:genomic-ref-seq.dataAbsentReason

Short description

Why the component result is missing

Definition

Provides a reason why the expected value in the element Observation.component.value[x] is missing.

Requirements

For many results it is necessary to handle exceptional values in measurements.

Comments

Data type

Binding

Codes specifying why the result (Observation.value[x]) is missing.

Conditions

The cardinality or value of this element may be affected by these constraints: obs-6

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: value.nullFlavor

interpretation

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:genomic-ref-seq.interpretation

Short description

High, low, normal, etc.

Alternate names

Abnormal Flag

Definition

A categorical assessment of an observation value. For example, high, low, normal.

Requirements

For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.

Comments

Data type

Binding

Codes identifying interpretations of observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: < 260245000 |Findings values|
v2: OBX-8
rim: interpretationCode
sct-attr: 363713009 |Has interpretation|

referenceRange

0..*

There are no (further) constraints on this element

Element id

Observation.component:genomic-ref-seq.referenceRange

Short description

Provides guide for interpretation of component result

Definition

Guidance on how to interpret the value by comparison to a normal or recommended range.

Requirements

Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: OBX.7
rim: outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]

transcript-ref-seq

0..1

There are no (further) constraints on this element

Element id

Observation.component:transcript-ref-seq

Short description

Reference Transcript

Definition

NCBI's RefSeq ('NM_...'), Ensembl ('ENST...'), and LRG ('LRG...' plus 't1' to indicate transcript)

Requirements

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: containment by OBX-4?
rim: outBoundRelationship[typeCode=COMP]

0..1

There are no (further) constraints on this element

Element id

Observation.component:transcript-ref-seq.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Observation.component:transcript-ref-seq.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Observation.component:transcript-ref-seq.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

code

1..1

CodeableConceptPattern

There are no (further) constraints on this element

Element id

Observation.component:transcript-ref-seq.code

Short description

51958-7

Definition

Describes what was observed. Sometimes this is called the observation "code".

Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Data type

Binding

Codes identifying names of simple observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "51958-7"
    }
  ]
}

Mappings

w5: FiveWs.what[x]
sct-concept: < 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|
v2: OBX-3
rim: code

value[x]

1..1

There are no (further) constraints on this element

Element id

Observation.component:transcript-ref-seq.value[x]

Short description

Versioned transcript reference sequence identifier

Definition

The information determined as a result of making the observation, if the information has a simple value.

Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Binding

Multiple bindings acceptable (NCBI or LRG)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|

valueCodeableConcept

There are no (further) constraints on this element

Data type

dataAbsentReason

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:transcript-ref-seq.dataAbsentReason

Short description

Why the component result is missing

Definition

Provides a reason why the expected value in the element Observation.component.value[x] is missing.

Requirements

For many results it is necessary to handle exceptional values in measurements.

Comments

Data type

Binding

Codes specifying why the result (Observation.value[x]) is missing.

Conditions

The cardinality or value of this element may be affected by these constraints: obs-6

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: value.nullFlavor

interpretation

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:transcript-ref-seq.interpretation

Short description

High, low, normal, etc.

Alternate names

Abnormal Flag

Definition

A categorical assessment of an observation value. For example, high, low, normal.

Requirements

For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.

Comments

Data type

Binding

Codes identifying interpretations of observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: < 260245000 |Findings values|
v2: OBX-8
rim: interpretationCode
sct-attr: 363713009 |Has interpretation|

referenceRange

0..*

There are no (further) constraints on this element

Element id

Observation.component:transcript-ref-seq.referenceRange

Short description

Provides guide for interpretation of component result

Definition

Guidance on how to interpret the value by comparison to a normal or recommended range.

Requirements

Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: OBX.7
rim: outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]

exact-start-end

0..1

There are no (further) constraints on this element

Element id

Observation.component:exact-start-end

Short description

Exact Start-End

Definition

The exact integer-based genomic coordinates of the start and end of the variant region.

Requirements

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: containment by OBX-4?
rim: outBoundRelationship[typeCode=COMP]

0..1

There are no (further) constraints on this element

Element id

Observation.component:exact-start-end.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Observation.component:exact-start-end.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Observation.component:exact-start-end.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

code

1..1

CodeableConceptPattern

There are no (further) constraints on this element

Element id

Observation.component:exact-start-end.code

Short description

81254-5

Definition

Describes what was observed. Sometimes this is called the observation "code".

Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Data type

Binding

Codes identifying names of simple observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "81254-5"
    }
  ]
}

Mappings

w5: FiveWs.what[x]
sct-concept: < 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|
v2: OBX-3
rim: code

value[x]

0..1

There are no (further) constraints on this element

Element id

Observation.component:exact-start-end.value[x]

Short description

Range in question. 'High' can be omitted for single nucleotide variants.

Definition

The information determined as a result of making the observation, if the information has a simple value.

Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|

valueRange

There are no (further) constraints on this element

Data type

dataAbsentReason

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:exact-start-end.dataAbsentReason

Short description

Why the component result is missing

Definition

Provides a reason why the expected value in the element Observation.component.value[x] is missing.

Requirements

For many results it is necessary to handle exceptional values in measurements.

Comments

Data type

Binding

Codes specifying why the result (Observation.value[x]) is missing.

Conditions

The cardinality or value of this element may be affected by these constraints: obs-6

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: value.nullFlavor

interpretation

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:exact-start-end.interpretation

Short description

High, low, normal, etc.

Alternate names

Abnormal Flag

Definition

A categorical assessment of an observation value. For example, high, low, normal.

Requirements

For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.

Comments

Data type

Binding

Codes identifying interpretations of observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: < 260245000 |Findings values|
v2: OBX-8
rim: interpretationCode
sct-attr: 363713009 |Has interpretation|

referenceRange

0..*

There are no (further) constraints on this element

Element id

Observation.component:exact-start-end.referenceRange

Short description

Provides guide for interpretation of component result

Definition

Guidance on how to interpret the value by comparison to a normal or recommended range.

Requirements

Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: OBX.7
rim: outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]

inner-start-end

0..1

There are no (further) constraints on this element

Element id

Observation.component:inner-start-end

Short description

Inner Start-End

Definition

The genomic coordinates of the narrowest genomic range in which the variant might reside. Used when the exact boundaries of the variant are not clear.

Requirements

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: containment by OBX-4?
rim: outBoundRelationship[typeCode=COMP]

0..1

There are no (further) constraints on this element

Element id

Observation.component:inner-start-end.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Observation.component:inner-start-end.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Observation.component:inner-start-end.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

code

1..1

CodeableConceptPattern

There are no (further) constraints on this element

Element id

Observation.component:inner-start-end.code

Short description

81302-2

Definition

Describes what was observed. Sometimes this is called the observation "code".

Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Data type

Binding

Codes identifying names of simple observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "81302-2"
    }
  ]
}

Mappings

w5: FiveWs.what[x]
sct-concept: < 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|
v2: OBX-3
rim: code

value[x]

0..1

There are no (further) constraints on this element

Element id

Observation.component:inner-start-end.value[x]

Short description

Imprecise variant inner-bounding range

Definition

The information determined as a result of making the observation, if the information has a simple value.

Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|

valueRange

There are no (further) constraints on this element

Data type

dataAbsentReason

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:inner-start-end.dataAbsentReason

Short description

Why the component result is missing

Definition

Provides a reason why the expected value in the element Observation.component.value[x] is missing.

Requirements

For many results it is necessary to handle exceptional values in measurements.

Comments

Data type

Binding

Codes specifying why the result (Observation.value[x]) is missing.

Conditions

The cardinality or value of this element may be affected by these constraints: obs-6

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: value.nullFlavor

interpretation

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:inner-start-end.interpretation

Short description

High, low, normal, etc.

Alternate names

Abnormal Flag

Definition

A categorical assessment of an observation value. For example, high, low, normal.

Requirements

For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.

Comments

Data type

Binding

Codes identifying interpretations of observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: < 260245000 |Findings values|
v2: OBX-8
rim: interpretationCode
sct-attr: 363713009 |Has interpretation|

referenceRange

0..*

There are no (further) constraints on this element

Element id

Observation.component:inner-start-end.referenceRange

Short description

Provides guide for interpretation of component result

Definition

Guidance on how to interpret the value by comparison to a normal or recommended range.

Requirements

Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: OBX.7
rim: outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]

outer-start-end

0..1

There are no (further) constraints on this element

Element id

Observation.component:outer-start-end

Short description

Outer Start-End

Definition

The genomic coordinates of the widest genomic range in which the variant might reside. Used when the exact boundaries of the variant are not clear.

Requirements

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: containment by OBX-4?
rim: outBoundRelationship[typeCode=COMP]

0..1

There are no (further) constraints on this element

Element id

Observation.component:outer-start-end.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Observation.component:outer-start-end.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Observation.component:outer-start-end.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

code

1..1

CodeableConceptPattern

There are no (further) constraints on this element

Element id

Observation.component:outer-start-end.code

Short description

81301-4

Definition

Describes what was observed. Sometimes this is called the observation "code".

Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Data type

Binding

Codes identifying names of simple observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "81301-4"
    }
  ]
}

Mappings

w5: FiveWs.what[x]
sct-concept: < 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|
v2: OBX-3
rim: code

value[x]

0..1

There are no (further) constraints on this element

Element id

Observation.component:outer-start-end.value[x]

Short description

Imprecise variant outer-bounding range

Definition

The information determined as a result of making the observation, if the information has a simple value.

Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|

valueRange

There are no (further) constraints on this element

Data type

dataAbsentReason

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:outer-start-end.dataAbsentReason

Short description

Why the component result is missing

Definition

Provides a reason why the expected value in the element Observation.component.value[x] is missing.

Requirements

For many results it is necessary to handle exceptional values in measurements.

Comments

Data type

Binding

Codes specifying why the result (Observation.value[x]) is missing.

Conditions

The cardinality or value of this element may be affected by these constraints: obs-6

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: value.nullFlavor

interpretation

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:outer-start-end.interpretation

Short description

High, low, normal, etc.

Alternate names

Abnormal Flag

Definition

A categorical assessment of an observation value. For example, high, low, normal.

Requirements

For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.

Comments

Data type

Binding

Codes identifying interpretations of observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: < 260245000 |Findings values|
v2: OBX-8
rim: interpretationCode
sct-attr: 363713009 |Has interpretation|

referenceRange

0..*

There are no (further) constraints on this element

Element id

Observation.component:outer-start-end.referenceRange

Short description

Provides guide for interpretation of component result

Definition

Guidance on how to interpret the value by comparison to a normal or recommended range.

Requirements

Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: OBX.7
rim: outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]

coordinate-system

0..1

There are no (further) constraints on this element

Element id

Observation.component:coordinate-system

Short description

Coordinate System

Definition

These are different ways of identifying nucleotides or amino acids within a sequence. In the 1-based system, the first unit of the polymer (e.g. the first nucleotide) is counted as number 1. In the 0-based system, the number 0 designates the location before the first nucleotide. Different databases and file types may use different systems.

Requirements

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: containment by OBX-4?
rim: outBoundRelationship[typeCode=COMP]

0..1

There are no (further) constraints on this element

Element id

Observation.component:coordinate-system.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Observation.component:coordinate-system.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Observation.component:coordinate-system.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

code

1..1

CodeableConceptPattern

There are no (further) constraints on this element

Element id

Observation.component:coordinate-system.code

Short description

92822-6

Definition

Describes what was observed. Sometimes this is called the observation "code".

Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Data type

Binding

Codes identifying names of simple observations.

http://loinc.org/vs/LL5323-2 (extensible)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "92822-6"
    }
  ]
}

Mappings

w5: FiveWs.what[x]
sct-concept: < 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|
v2: OBX-3
rim: code

value[x]

1..1

Binding

There are no (further) constraints on this element

Element id

Observation.component:coordinate-system.value[x]

Short description

0-based interval counting | 0-based character counting | 1-based character counting

Definition

The information determined as a result of making the observation, if the information has a simple value.

Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Binding

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|

valueCodeableConcept

There are no (further) constraints on this element

Data type

dataAbsentReason

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:coordinate-system.dataAbsentReason

Short description

Why the component result is missing

Definition

Provides a reason why the expected value in the element Observation.component.value[x] is missing.

Requirements

For many results it is necessary to handle exceptional values in measurements.

Comments

Data type

Binding

Codes specifying why the result (Observation.value[x]) is missing.

Conditions

The cardinality or value of this element may be affected by these constraints: obs-6

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: value.nullFlavor

interpretation

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:coordinate-system.interpretation

Short description

High, low, normal, etc.

Alternate names

Abnormal Flag

Definition

A categorical assessment of an observation value. For example, high, low, normal.

Requirements

For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.

Comments

Data type

Binding

Codes identifying interpretations of observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: < 260245000 |Findings values|
v2: OBX-8
rim: interpretationCode
sct-attr: 363713009 |Has interpretation|

referenceRange

0..*

There are no (further) constraints on this element

Element id

Observation.component:coordinate-system.referenceRange

Short description

Provides guide for interpretation of component result

Definition

Guidance on how to interpret the value by comparison to a normal or recommended range.

Requirements

Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: OBX.7
rim: outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]

ref-allele

0..1

There are no (further) constraints on this element

Element id

Observation.component:ref-allele

Short description

Genomic Ref Allele

Definition

Reference values ('normal') examined within the Reference Sequence.

Requirements

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: containment by OBX-4?
rim: outBoundRelationship[typeCode=COMP]

0..1

There are no (further) constraints on this element

Element id

Observation.component:ref-allele.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Observation.component:ref-allele.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Observation.component:ref-allele.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

code

1..1

CodeableConceptPattern

There are no (further) constraints on this element

Element id

Observation.component:ref-allele.code

Short description

69547-8

Definition

Describes what was observed. Sometimes this is called the observation "code".

Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Data type

Binding

Codes identifying names of simple observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "69547-8"
    }
  ]
}

Mappings

w5: FiveWs.what[x]
sct-concept: < 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|
v2: OBX-3
rim: code

value[x]

0..1

There are no (further) constraints on this element

Element id

Observation.component:ref-allele.value[x]

Short description

Normalized string per the VCF format.

Definition

The information determined as a result of making the observation, if the information has a simple value.

Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|

valueString

There are no (further) constraints on this element

Data type

dataAbsentReason

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:ref-allele.dataAbsentReason

Short description

Why the component result is missing

Definition

Provides a reason why the expected value in the element Observation.component.value[x] is missing.

Requirements

For many results it is necessary to handle exceptional values in measurements.

Comments

Data type

Binding

Codes specifying why the result (Observation.value[x]) is missing.

Conditions

The cardinality or value of this element may be affected by these constraints: obs-6

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: value.nullFlavor

interpretation

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:ref-allele.interpretation

Short description

High, low, normal, etc.

Alternate names

Abnormal Flag

Definition

A categorical assessment of an observation value. For example, high, low, normal.

Requirements

For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.

Comments

Data type

Binding

Codes identifying interpretations of observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: < 260245000 |Findings values|
v2: OBX-8
rim: interpretationCode
sct-attr: 363713009 |Has interpretation|

referenceRange

0..*

There are no (further) constraints on this element

Element id

Observation.component:ref-allele.referenceRange

Short description

Provides guide for interpretation of component result

Definition

Guidance on how to interpret the value by comparison to a normal or recommended range.

Requirements

Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: OBX.7
rim: outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]

alt-allele

0..1

There are no (further) constraints on this element

Element id

Observation.component:alt-allele

Short description

Genomic Alt Allele

Definition

The genomic alternate allele is the contiguous segment of DNA in the test sample that differs from the reference allele at the same location and thus defines a variant.

Requirements

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: containment by OBX-4?
rim: outBoundRelationship[typeCode=COMP]

0..1

There are no (further) constraints on this element

Element id

Observation.component:alt-allele.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Observation.component:alt-allele.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Observation.component:alt-allele.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

code

1..1

CodeableConceptPattern

There are no (further) constraints on this element

Element id

Observation.component:alt-allele.code

Short description

69551-0

Definition

Describes what was observed. Sometimes this is called the observation "code".

Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Data type

Binding

Codes identifying names of simple observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "69551-0"
    }
  ]
}

Mappings

w5: FiveWs.what[x]
sct-concept: < 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|
v2: OBX-3
rim: code

value[x]

0..1

There are no (further) constraints on this element

Element id

Observation.component:alt-allele.value[x]

Short description

Normalized string per the VCF format.

Definition

The information determined as a result of making the observation, if the information has a simple value.

Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|

valueString

There are no (further) constraints on this element

Data type

dataAbsentReason

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:alt-allele.dataAbsentReason

Short description

Why the component result is missing

Definition

Provides a reason why the expected value in the element Observation.component.value[x] is missing.

Requirements

For many results it is necessary to handle exceptional values in measurements.

Comments

Data type

Binding

Codes specifying why the result (Observation.value[x]) is missing.

Conditions

The cardinality or value of this element may be affected by these constraints: obs-6

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: value.nullFlavor

interpretation

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:alt-allele.interpretation

Short description

High, low, normal, etc.

Alternate names

Abnormal Flag

Definition

A categorical assessment of an observation value. For example, high, low, normal.

Requirements

For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.

Comments

Data type

Binding

Codes identifying interpretations of observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: < 260245000 |Findings values|
v2: OBX-8
rim: interpretationCode
sct-attr: 363713009 |Has interpretation|

referenceRange

0..*

There are no (further) constraints on this element

Element id

Observation.component:alt-allele.referenceRange

Short description

Provides guide for interpretation of component result

Definition

Guidance on how to interpret the value by comparison to a normal or recommended range.

Requirements

Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: OBX.7
rim: outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]

coding-change-type

0..1

There are no (further) constraints on this element

Element id

Observation.component:coding-change-type

Short description

Coding DNA Change Type

Definition

Type of DNA change observed. Convenience property for variants with exact breakpoints, required otherwise.

Requirements

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: containment by OBX-4?
rim: outBoundRelationship[typeCode=COMP]

0..1

There are no (further) constraints on this element

Element id

Observation.component:coding-change-type.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Observation.component:coding-change-type.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Observation.component:coding-change-type.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

code

1..1

CodeableConceptPattern

There are no (further) constraints on this element

Element id

Observation.component:coding-change-type.code

Short description

48019-4

Definition

Describes what was observed. Sometimes this is called the observation "code".

Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Data type

Binding

Codes identifying names of simple observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "48019-4"
    }
  ]
}

Mappings

w5: FiveWs.what[x]
sct-concept: < 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|
v2: OBX-3
rim: code

value[x]

1..1

Binding

There are no (further) constraints on this element

Element id

Observation.component:coding-change-type.value[x]

Short description

Definition

The information determined as a result of making the observation, if the information has a simple value.

Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Binding

Concepts in sequence ontology under SO:0002072

DNAChangeTypeVS (extensible)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|

valueCodeableConcept

There are no (further) constraints on this element

Data type

dataAbsentReason

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:coding-change-type.dataAbsentReason

Short description

Why the component result is missing

Definition

Provides a reason why the expected value in the element Observation.component.value[x] is missing.

Requirements

For many results it is necessary to handle exceptional values in measurements.

Comments

Data type

Binding

Codes specifying why the result (Observation.value[x]) is missing.

Conditions

The cardinality or value of this element may be affected by these constraints: obs-6

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: value.nullFlavor

interpretation

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:coding-change-type.interpretation

Short description

High, low, normal, etc.

Alternate names

Abnormal Flag

Definition

A categorical assessment of an observation value. For example, high, low, normal.

Requirements

For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.

Comments

Data type

Binding

Codes identifying interpretations of observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: < 260245000 |Findings values|
v2: OBX-8
rim: interpretationCode
sct-attr: 363713009 |Has interpretation|

referenceRange

0..*

There are no (further) constraints on this element

Element id

Observation.component:coding-change-type.referenceRange

Short description

Provides guide for interpretation of component result

Definition

Guidance on how to interpret the value by comparison to a normal or recommended range.

Requirements

Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: OBX.7
rim: outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]

genomic-source-class

0..1

There are no (further) constraints on this element

Element id

Observation.component:genomic-source-class

Short description

Genomic Source Class

Definition

The genomic class of the specimen being analyzed: Germline for inherited genome, somatic for cancer genome, and prenatal for fetal genome.

Requirements

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: containment by OBX-4?
rim: outBoundRelationship[typeCode=COMP]

0..1

There are no (further) constraints on this element

Element id

Observation.component:genomic-source-class.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Observation.component:genomic-source-class.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Observation.component:genomic-source-class.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

code

1..1

CodeableConceptPattern

There are no (further) constraints on this element

Element id

Observation.component:genomic-source-class.code

Short description

48002-0

Definition

Describes what was observed. Sometimes this is called the observation "code".

Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Data type

Binding

Codes identifying names of simple observations.

http://loinc.org/vs/LL378-1 (extensible)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "48002-0"
    }
  ]
}

Mappings

w5: FiveWs.what[x]
sct-concept: < 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|
v2: OBX-3
rim: code

value[x]

1..1

Binding

There are no (further) constraints on this element

Element id

Observation.component:genomic-source-class.value[x]

Short description

Definition

The information determined as a result of making the observation, if the information has a simple value.

Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Binding

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|

valueCodeableConcept

There are no (further) constraints on this element

Data type

dataAbsentReason

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:genomic-source-class.dataAbsentReason

Short description

Why the component result is missing

Definition

Provides a reason why the expected value in the element Observation.component.value[x] is missing.

Requirements

For many results it is necessary to handle exceptional values in measurements.

Comments

Data type

Binding

Codes specifying why the result (Observation.value[x]) is missing.

Conditions

The cardinality or value of this element may be affected by these constraints: obs-6

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: value.nullFlavor

interpretation

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:genomic-source-class.interpretation

Short description

High, low, normal, etc.

Alternate names

Abnormal Flag

Definition

A categorical assessment of an observation value. For example, high, low, normal.

Requirements

For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.

Comments

Data type

Binding

Codes identifying interpretations of observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: < 260245000 |Findings values|
v2: OBX-8
rim: interpretationCode
sct-attr: 363713009 |Has interpretation|

referenceRange

0..*

There are no (further) constraints on this element

Element id

Observation.component:genomic-source-class.referenceRange

Short description

Provides guide for interpretation of component result

Definition

Guidance on how to interpret the value by comparison to a normal or recommended range.

Requirements

Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: OBX.7
rim: outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]

sample-allelic-frequency

0..1

There are no (further) constraints on this element

Element id

Observation.component:sample-allelic-frequency

Short description

Sample Allelic Frequency

Definition

The relative frequency of the allele at a given locus in the sample.

Requirements

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: containment by OBX-4?
rim: outBoundRelationship[typeCode=COMP]

0..1

There are no (further) constraints on this element

Element id

Observation.component:sample-allelic-frequency.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Observation.component:sample-allelic-frequency.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Observation.component:sample-allelic-frequency.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

code

1..1

CodeableConceptPattern

There are no (further) constraints on this element

Element id

Observation.component:sample-allelic-frequency.code

Short description

81258-6

Definition

Describes what was observed. Sometimes this is called the observation "code".

Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Data type

Binding

Codes identifying names of simple observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "81258-6"
    }
  ]
}

Mappings

w5: FiveWs.what[x]
sct-concept: < 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|
v2: OBX-3
rim: code

value[x]

0..1

There are no (further) constraints on this element

Element id

Observation.component:sample-allelic-frequency.value[x]

Short description

Relative frequency in the sample

Definition

The information determined as a result of making the observation, if the information has a simple value.

Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|

valueQuantity

There are no (further) constraints on this element

Data type

0..1

There are no (further) constraints on this element

Element id

Observation.component:sample-allelic-frequency.value[x].id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Observation.component:sample-allelic-frequency.value[x].extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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()

Mappings

rim: n/a

value

0..1

There are no (further) constraints on this element

Element id

Observation.component:sample-allelic-frequency.value[x].value

Short description

Numerical value (with implicit precision)

Definition

The value of the measured amount. The value includes an implicit precision in the presentation of the value.

Requirements

Precision is handled implicitly in almost all cases of measurement.

Comments

The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: SN.2 / CQ - N/A
rim: PQ.value, CO.value, MO.value, IVL.high or IVL.low depending on the value

comparator

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

Observation.component:sample-allelic-frequency.value[x].comparator

Short description

< | <= | >= | > - how to understand the value

Definition

Requirements

Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.

Meaning when missing

If there is no comparator, then there is no modification of the value

Data type

Binding

How the Quantity should be understood and represented.

QuantityComparator (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: SN.1 / CQ.1
rim: IVL properties

unit

0..1

There are no (further) constraints on this element

Element id

Observation.component:sample-allelic-frequency.value[x].unit

Short description

Unit representation

Definition

A human-readable form of the unit.

Requirements

There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: (see OBX.6 etc.) / CQ.2
rim: PQ.unit

system

Σ C

0..1

uriPattern

There are no (further) constraints on this element

Element id

Observation.component:sample-allelic-frequency.value[x].system

Short description

System that defines coded unit form

Definition

The identification of the system that provides the coded form of the unit.

Requirements

Need to know the system that defines the coded form of the unit.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: qty-3

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

http://unitsofmeasure.org

Mappings

v2: (see OBX.6 etc.) / CQ.2
rim: CO.codeSystem, PQ.translation.codeSystem

code

0..1

There are no (further) constraints on this element

Element id

Observation.component:sample-allelic-frequency.value[x].code

Short description

Coded form of the unit

Definition

A computer processable form of the unit in some unit representation system.

Requirements

Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.

Comments

The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: (see OBX.6 etc.) / CQ.2
rim: PQ.code, MO.currency, PQ.translation.code

dataAbsentReason

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:sample-allelic-frequency.dataAbsentReason

Short description

Why the component result is missing

Definition

Provides a reason why the expected value in the element Observation.component.value[x] is missing.

Requirements

For many results it is necessary to handle exceptional values in measurements.

Comments

Data type

Binding

Codes specifying why the result (Observation.value[x]) is missing.

Conditions

The cardinality or value of this element may be affected by these constraints: obs-6

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: value.nullFlavor

interpretation

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:sample-allelic-frequency.interpretation

Short description

High, low, normal, etc.

Alternate names

Abnormal Flag

Definition

A categorical assessment of an observation value. For example, high, low, normal.

Requirements

For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.

Comments

Data type

Binding

Codes identifying interpretations of observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: < 260245000 |Findings values|
v2: OBX-8
rim: interpretationCode
sct-attr: 363713009 |Has interpretation|

referenceRange

0..*

There are no (further) constraints on this element

Element id

Observation.component:sample-allelic-frequency.referenceRange

Short description

Provides guide for interpretation of component result

Definition

Guidance on how to interpret the value by comparison to a normal or recommended range.

Requirements

Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: OBX.7
rim: outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]

allelic-read-depth

0..1

There are no (further) constraints on this element

Element id

Observation.component:allelic-read-depth

Short description

Allelic Read Depth

Definition

Specifies the number of reads that identified the allele in question whether it consists of one or a small sequence of contiguous nucleotides. Different methods and purposes require different numbers of reads to be acceptable. Often >400, sometimes as few as 2-4.

Requirements

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: containment by OBX-4?
rim: outBoundRelationship[typeCode=COMP]

0..1

There are no (further) constraints on this element

Element id

Observation.component:allelic-read-depth.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Observation.component:allelic-read-depth.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Observation.component:allelic-read-depth.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

code

1..1

CodeableConceptPattern

There are no (further) constraints on this element

Element id

Observation.component:allelic-read-depth.code

Short description

82121-5

Definition

Describes what was observed. Sometimes this is called the observation "code".

Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Data type

Binding

Codes identifying names of simple observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "82121-5"
    }
  ]
}

Mappings

w5: FiveWs.what[x]
sct-concept: < 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|
v2: OBX-3
rim: code

value[x]

0..1

There are no (further) constraints on this element

Element id

Observation.component:allelic-read-depth.value[x]

Short description

Unfiltered count of supporting reads

Definition

The information determined as a result of making the observation, if the information has a simple value.

Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|

valueQuantity

There are no (further) constraints on this element

Data type

dataAbsentReason

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:allelic-read-depth.dataAbsentReason

Short description

Why the component result is missing

Definition

Provides a reason why the expected value in the element Observation.component.value[x] is missing.

Requirements

For many results it is necessary to handle exceptional values in measurements.

Comments

Data type

Binding

Codes specifying why the result (Observation.value[x]) is missing.

Conditions

The cardinality or value of this element may be affected by these constraints: obs-6

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: value.nullFlavor

interpretation

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:allelic-read-depth.interpretation

Short description

High, low, normal, etc.

Alternate names

Abnormal Flag

Definition

A categorical assessment of an observation value. For example, high, low, normal.

Requirements

For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.

Comments

Data type

Binding

Codes identifying interpretations of observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: < 260245000 |Findings values|
v2: OBX-8
rim: interpretationCode
sct-attr: 363713009 |Has interpretation|

referenceRange

0..*

There are no (further) constraints on this element

Element id

Observation.component:allelic-read-depth.referenceRange

Short description

Provides guide for interpretation of component result

Definition

Guidance on how to interpret the value by comparison to a normal or recommended range.

Requirements

Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: OBX.7
rim: outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]

allelic-state

0..1

There are no (further) constraints on this element

Element id

Observation.component:allelic-state

Short description

Allelic State

Definition

The observed level of occurrence of the variant in the set of chromosomes.

Requirements

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: containment by OBX-4?
rim: outBoundRelationship[typeCode=COMP]

0..1

There are no (further) constraints on this element

Element id

Observation.component:allelic-state.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Observation.component:allelic-state.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Observation.component:allelic-state.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

code

1..1

CodeableConceptPattern

There are no (further) constraints on this element

Element id

Observation.component:allelic-state.code

Short description

53034-5

Definition

Describes what was observed. Sometimes this is called the observation "code".

Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Data type

Binding

Codes identifying names of simple observations.

http://loinc.org/vs/LL381-5 (extensible)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "53034-5"
    }
  ]
}

Mappings

w5: FiveWs.what[x]
sct-concept: < 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|
v2: OBX-3
rim: code

value[x]

1..1

Binding

There are no (further) constraints on this element

Element id

Observation.component:allelic-state.value[x]

Short description

Heteroplasmic | Homoplasmic | Homozygous | Heterozygous | Hemizygous

Definition

The information determined as a result of making the observation, if the information has a simple value.

Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Binding

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|

valueCodeableConcept

There are no (further) constraints on this element

Data type

dataAbsentReason

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:allelic-state.dataAbsentReason

Short description

Why the component result is missing

Definition

Provides a reason why the expected value in the element Observation.component.value[x] is missing.

Requirements

For many results it is necessary to handle exceptional values in measurements.

Comments

Data type

Binding

Codes specifying why the result (Observation.value[x]) is missing.

Conditions

The cardinality or value of this element may be affected by these constraints: obs-6

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: value.nullFlavor

interpretation

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:allelic-state.interpretation

Short description

High, low, normal, etc.

Alternate names

Abnormal Flag

Definition

A categorical assessment of an observation value. For example, high, low, normal.

Requirements

For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.

Comments

Data type

Binding

Codes identifying interpretations of observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: < 260245000 |Findings values|
v2: OBX-8
rim: interpretationCode
sct-attr: 363713009 |Has interpretation|

referenceRange

0..*

There are no (further) constraints on this element

Element id

Observation.component:allelic-state.referenceRange

Short description

Provides guide for interpretation of component result

Definition

Guidance on how to interpret the value by comparison to a normal or recommended range.

Requirements

Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: OBX.7
rim: outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]

variant-inheritance

0..1

There are no (further) constraints on this element

Element id

Observation.component:variant-inheritance

Short description

Variant Inheritance

Definition

By which parent the variant was inherited in the patient, if known.

Requirements

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: containment by OBX-4?
rim: outBoundRelationship[typeCode=COMP]

0..1

There are no (further) constraints on this element

Element id

Observation.component:variant-inheritance.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Observation.component:variant-inheritance.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Observation.component:variant-inheritance.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

code

1..1

CodeableConceptPattern

There are no (further) constraints on this element

Element id

Observation.component:variant-inheritance.code

Short description

variant-inheritance

Definition

Describes what was observed. Sometimes this is called the observation "code".

Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Data type

Binding

Codes identifying names of simple observations.

VariantInheritanceVS (extensible)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://hl7.org/fhir/uv/genomics-reporting/CodeSystem/tbd-codes-cs",
      "code": "variant-inheritance"
    }
  ]
}

Mappings

w5: FiveWs.what[x]
sct-concept: < 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|
v2: OBX-3
rim: code

value[x]

1..1

Binding

There are no (further) constraints on this element

Element id

Observation.component:variant-inheritance.value[x]

Short description

Maternal | Paternal | Unknown

Definition

The information determined as a result of making the observation, if the information has a simple value.

Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Binding

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|

valueCodeableConcept

There are no (further) constraints on this element

Data type

dataAbsentReason

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:variant-inheritance.dataAbsentReason

Short description

Why the component result is missing

Definition

Provides a reason why the expected value in the element Observation.component.value[x] is missing.

Requirements

For many results it is necessary to handle exceptional values in measurements.

Comments

Data type

Binding

Codes specifying why the result (Observation.value[x]) is missing.

Conditions

The cardinality or value of this element may be affected by these constraints: obs-6

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: value.nullFlavor

interpretation

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:variant-inheritance.interpretation

Short description

High, low, normal, etc.

Alternate names

Abnormal Flag

Definition

A categorical assessment of an observation value. For example, high, low, normal.

Requirements

For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.

Comments

Data type

Binding

Codes identifying interpretations of observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: < 260245000 |Findings values|
v2: OBX-8
rim: interpretationCode
sct-attr: 363713009 |Has interpretation|

referenceRange

0..*

There are no (further) constraints on this element

Element id

Observation.component:variant-inheritance.referenceRange

Short description

Provides guide for interpretation of component result

Definition

Guidance on how to interpret the value by comparison to a normal or recommended range.

Requirements

Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: OBX.7
rim: outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]

variation-code

0..*

There are no (further) constraints on this element

Element id

Observation.component:variation-code

Short description

Variation Code

Definition

Accession number in a variant database such as ClinVar, given for cross-reference.

Requirements

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: containment by OBX-4?
rim: outBoundRelationship[typeCode=COMP]

0..1

There are no (further) constraints on this element

Element id

Observation.component:variation-code.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Observation.component:variation-code.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Observation.component:variation-code.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

code

1..1

CodeableConceptPattern

There are no (further) constraints on this element

Element id

Observation.component:variation-code.code

Short description

81252-9

Definition

Describes what was observed. Sometimes this is called the observation "code".

Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Data type

Binding

Codes identifying names of simple observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "81252-9"
    }
  ]
}

Mappings

w5: FiveWs.what[x]
sct-concept: < 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|
v2: OBX-3
rim: code

value[x]

1..1

There are no (further) constraints on this element

Element id

Observation.component:variation-code.value[x]

Short description

ClinVar ID or similar

Definition

The information determined as a result of making the observation, if the information has a simple value.

Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Binding

Multiple bindings acceptable

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|

valueCodeableConcept

There are no (further) constraints on this element

Data type

dataAbsentReason

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:variation-code.dataAbsentReason

Short description

Why the component result is missing

Definition

Provides a reason why the expected value in the element Observation.component.value[x] is missing.

Requirements

For many results it is necessary to handle exceptional values in measurements.

Comments

Data type

Binding

Codes specifying why the result (Observation.value[x]) is missing.

Conditions

The cardinality or value of this element may be affected by these constraints: obs-6

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: value.nullFlavor

interpretation

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:variation-code.interpretation

Short description

High, low, normal, etc.

Alternate names

Abnormal Flag

Definition

A categorical assessment of an observation value. For example, high, low, normal.

Requirements

For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.

Comments

Data type

Binding

Codes identifying interpretations of observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: < 260245000 |Findings values|
v2: OBX-8
rim: interpretationCode
sct-attr: 363713009 |Has interpretation|

referenceRange

0..*

There are no (further) constraints on this element

Element id

Observation.component:variation-code.referenceRange

Short description

Provides guide for interpretation of component result

Definition

Guidance on how to interpret the value by comparison to a normal or recommended range.

Requirements

Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: OBX.7
rim: outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]

chromosome-identifier

0..*

There are no (further) constraints on this element

Element id

Observation.component:chromosome-identifier

Short description

Chromosome Identifier

Definition

An indicator, enumerated in humans by numbers 1-22, X, and Y, representing the chromosome on which the variant is located.

Requirements

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: containment by OBX-4?
rim: outBoundRelationship[typeCode=COMP]

0..1

There are no (further) constraints on this element

Element id

Observation.component:chromosome-identifier.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Observation.component:chromosome-identifier.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Observation.component:chromosome-identifier.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

code

1..1

CodeableConceptPattern

There are no (further) constraints on this element

Element id

Observation.component:chromosome-identifier.code

Short description

48000-4

Definition

Describes what was observed. Sometimes this is called the observation "code".

Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Data type

Binding

Codes identifying names of simple observations.

http://loinc.org/vs/LL2938-0 (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "48000-4"
    }
  ]
}

Mappings

w5: FiveWs.what[x]
sct-concept: < 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|
v2: OBX-3
rim: code

value[x]

1..1

Binding

There are no (further) constraints on this element

Element id

Observation.component:chromosome-identifier.value[x]

Short description

Definition

The information determined as a result of making the observation, if the information has a simple value.

Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Binding

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|

valueCodeableConcept

There are no (further) constraints on this element

Data type

dataAbsentReason

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:chromosome-identifier.dataAbsentReason

Short description

Why the component result is missing

Definition

Provides a reason why the expected value in the element Observation.component.value[x] is missing.

Requirements

For many results it is necessary to handle exceptional values in measurements.

Comments

Data type

Binding

Codes specifying why the result (Observation.value[x]) is missing.

Conditions

The cardinality or value of this element may be affected by these constraints: obs-6

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: value.nullFlavor

interpretation

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:chromosome-identifier.interpretation

Short description

High, low, normal, etc.

Alternate names

Abnormal Flag

Definition

A categorical assessment of an observation value. For example, high, low, normal.

Requirements

For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.

Comments

Data type

Binding

Codes identifying interpretations of observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: < 260245000 |Findings values|
v2: OBX-8
rim: interpretationCode
sct-attr: 363713009 |Has interpretation|

referenceRange

0..*

There are no (further) constraints on this element

Element id

Observation.component:chromosome-identifier.referenceRange

Short description

Provides guide for interpretation of component result

Definition

Guidance on how to interpret the value by comparison to a normal or recommended range.

Requirements

Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: OBX.7
rim: outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]

protein-hgvs

0..1

There are no (further) constraints on this element

Element id

Observation.component:protein-hgvs

Short description

Protein (Amino Acid) Change - pHGVS

Definition

Description of the protein (amino acid) sequence change using a valid HGVS-formatted string. The description of the variant is surrounded in parentheses if it is calculated rather than directly observed.

Requirements

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: containment by OBX-4?
rim: outBoundRelationship[typeCode=COMP]

0..1

There are no (further) constraints on this element

Element id

Observation.component:protein-hgvs.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Observation.component:protein-hgvs.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Observation.component:protein-hgvs.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

code

1..1

CodeableConceptPattern

There are no (further) constraints on this element

Element id

Observation.component:protein-hgvs.code

Short description

48005-3

Definition

Describes what was observed. Sometimes this is called the observation "code".

Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Data type

Binding

Codes identifying names of simple observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "48005-3"
    }
  ]
}

Mappings

w5: FiveWs.what[x]
sct-concept: < 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|
v2: OBX-3
rim: code

value[x]

1..1

Binding

There are no (further) constraints on this element

Element id

Observation.component:protein-hgvs.value[x]

Short description

A valid HGVS-formatted 'p.' string, e.g. NP_000050.2:p.(Asn1836Lys)

Definition

The information determined as a result of making the observation, if the information has a simple value.

Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Binding

HGVSVS (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|

valueCodeableConcept

There are no (further) constraints on this element

Data type

dataAbsentReason

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:protein-hgvs.dataAbsentReason

Short description

Why the component result is missing

Definition

Provides a reason why the expected value in the element Observation.component.value[x] is missing.

Requirements

For many results it is necessary to handle exceptional values in measurements.

Comments

Data type

Binding

Codes specifying why the result (Observation.value[x]) is missing.

Conditions

The cardinality or value of this element may be affected by these constraints: obs-6

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: value.nullFlavor

interpretation

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:protein-hgvs.interpretation

Short description

High, low, normal, etc.

Alternate names

Abnormal Flag

Definition

A categorical assessment of an observation value. For example, high, low, normal.

Requirements

For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.

Comments

Data type

Binding

Codes identifying interpretations of observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: < 260245000 |Findings values|
v2: OBX-8
rim: interpretationCode
sct-attr: 363713009 |Has interpretation|

referenceRange

0..*

There are no (further) constraints on this element

Element id

Observation.component:protein-hgvs.referenceRange

Short description

Provides guide for interpretation of component result

Definition

Guidance on how to interpret the value by comparison to a normal or recommended range.

Requirements

Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: OBX.7
rim: outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]

amino-acid-change-type

0..1

There are no (further) constraints on this element

Element id

Observation.component:amino-acid-change-type

Short description

Amino Acid Change Type

Definition

Codified type for associated Amino Acid Marker, for convenience.

Requirements

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: containment by OBX-4?
rim: outBoundRelationship[typeCode=COMP]

0..1

There are no (further) constraints on this element

Element id

Observation.component:amino-acid-change-type.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Observation.component:amino-acid-change-type.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Observation.component:amino-acid-change-type.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

code

1..1

CodeableConceptPattern

There are no (further) constraints on this element

Element id

Observation.component:amino-acid-change-type.code

Short description

48006-1

Definition

Describes what was observed. Sometimes this is called the observation "code".

Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Data type

Binding

Codes identifying names of simple observations.

http://loinc.org/vs/LL380-7 (extensible)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "48006-1"
    }
  ]
}

Mappings

w5: FiveWs.what[x]
sct-concept: < 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|
v2: OBX-3
rim: code

value[x]

1..1

Binding

There are no (further) constraints on this element

Element id

Observation.component:amino-acid-change-type.value[x]

Short description

Definition

The information determined as a result of making the observation, if the information has a simple value.

Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Binding

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|

valueCodeableConcept

There are no (further) constraints on this element

Data type

dataAbsentReason

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:amino-acid-change-type.dataAbsentReason

Short description

Why the component result is missing

Definition

Provides a reason why the expected value in the element Observation.component.value[x] is missing.

Requirements

For many results it is necessary to handle exceptional values in measurements.

Comments

Data type

Binding

Codes specifying why the result (Observation.value[x]) is missing.

Conditions

The cardinality or value of this element may be affected by these constraints: obs-6

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: value.nullFlavor

interpretation

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:amino-acid-change-type.interpretation

Short description

High, low, normal, etc.

Alternate names

Abnormal Flag

Definition

A categorical assessment of an observation value. For example, high, low, normal.

Requirements

For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.

Comments

Data type

Binding

Codes identifying interpretations of observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: < 260245000 |Findings values|
v2: OBX-8
rim: interpretationCode
sct-attr: 363713009 |Has interpretation|

referenceRange

0..*

There are no (further) constraints on this element

Element id

Observation.component:amino-acid-change-type.referenceRange

Short description

Provides guide for interpretation of component result

Definition

Guidance on how to interpret the value by comparison to a normal or recommended range.

Requirements

Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: OBX.7
rim: outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]

molecular-consequence

0..1

There are no (further) constraints on this element

Element id

Observation.component:molecular-consequence

Short description

Molecular Consequence

Definition

The calculated or observed effect of a variant on its downstream transcript and, if applicable, ensuing protein sequence.

Requirements

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: containment by OBX-4?
rim: outBoundRelationship[typeCode=COMP]

0..1

There are no (further) constraints on this element

Element id

Observation.component:molecular-consequence.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Observation.component:molecular-consequence.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Observation.component:molecular-consequence.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

code

1..1

CodeableConceptPattern

There are no (further) constraints on this element

Element id

Observation.component:molecular-consequence.code

Short description

molecular-consequence

Definition

Describes what was observed. Sometimes this is called the observation "code".

Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Data type

Binding

Codes identifying names of simple observations.

MolecularConsequenceVS (extensible)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://hl7.org/fhir/uv/genomics-reporting/CodeSystem/tbd-codes-cs",
      "code": "molecular-consequence"
    }
  ]
}

Mappings

w5: FiveWs.what[x]
sct-concept: < 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|
v2: OBX-3
rim: code

value[x]

1..1

Binding

There are no (further) constraints on this element

Element id

Observation.component:molecular-consequence.value[x]

Short description

stop_lost | stop_gained | inframe_insertion | frameshift_variant | ... (many)

Definition

The information determined as a result of making the observation, if the information has a simple value.

Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Binding

Concepts in sequence ontology under SO:0001537.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|

valueCodeableConcept

There are no (further) constraints on this element

Data type

dataAbsentReason

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:molecular-consequence.dataAbsentReason

Short description

Why the component result is missing

Definition

Provides a reason why the expected value in the element Observation.component.value[x] is missing.

Requirements

For many results it is necessary to handle exceptional values in measurements.

Comments

Data type

Binding

Codes specifying why the result (Observation.value[x]) is missing.

Conditions

The cardinality or value of this element may be affected by these constraints: obs-6

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: value.nullFlavor

interpretation

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:molecular-consequence.interpretation

Short description

High, low, normal, etc.

Alternate names

Abnormal Flag

Definition

A categorical assessment of an observation value. For example, high, low, normal.

Requirements

For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.

Comments

Data type

Binding

Codes identifying interpretations of observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: < 260245000 |Findings values|
v2: OBX-8
rim: interpretationCode
sct-attr: 363713009 |Has interpretation|

referenceRange

0..*

There are no (further) constraints on this element

Element id

Observation.component:molecular-consequence.referenceRange

Short description

Provides guide for interpretation of component result

Definition

Guidance on how to interpret the value by comparison to a normal or recommended range.

Requirements

Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: OBX.7
rim: outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]

copy-number

0..1

There are no (further) constraints on this element

Element id

Observation.component:copy-number

Short description

Genomic Structural Variant Copy Number

Definition

The copy number of the large variant. In HGVS, this is the numeric value following the “X”. It is a unit-less value. Note that a copy number of 1 can imply a deletion.

Requirements

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: containment by OBX-4?
rim: outBoundRelationship[typeCode=COMP]

0..1

There are no (further) constraints on this element

Element id

Observation.component:copy-number.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Observation.component:copy-number.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Observation.component:copy-number.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

code

1..1

CodeableConceptPattern

There are no (further) constraints on this element

Element id

Observation.component:copy-number.code

Short description

82155-3

Definition

Describes what was observed. Sometimes this is called the observation "code".

Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Data type

Binding

Codes identifying names of simple observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "82155-3"
    }
  ]
}

Mappings

w5: FiveWs.what[x]
sct-concept: < 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|
v2: OBX-3
rim: code

value[x]

Σ C

0..1

There are no (further) constraints on this element

Element id

Observation.component:copy-number.value[x]

Short description

Actual component result

Definition

The information determined as a result of making the observation, if the information has a simple value.

Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
cnt-3: There SHALL be a code with a value of '1' if there is a value. If system is present, it SHALL be UCUM. If present, the value SHALL be a whole number.
(code.exists() or value.empty()) and (system.empty() or system = %ucum) and (code.empty() or code = '1') and (value.empty() or value.hasValue().not() or value.toString().contains('.').not())

Mappings

sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|

valueQuantity

There are no (further) constraints on this element

Data type

dataAbsentReason

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:copy-number.dataAbsentReason

Short description

Why the component result is missing

Definition

Provides a reason why the expected value in the element Observation.component.value[x] is missing.

Requirements

For many results it is necessary to handle exceptional values in measurements.

Comments

Data type

Binding

Codes specifying why the result (Observation.value[x]) is missing.

Conditions

The cardinality or value of this element may be affected by these constraints: obs-6

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: value.nullFlavor

interpretation

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:copy-number.interpretation

Short description

High, low, normal, etc.

Alternate names

Abnormal Flag

Definition

A categorical assessment of an observation value. For example, high, low, normal.

Requirements

For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.

Comments

Data type

Binding

Codes identifying interpretations of observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: < 260245000 |Findings values|
v2: OBX-8
rim: interpretationCode
sct-attr: 363713009 |Has interpretation|

referenceRange

0..*

There are no (further) constraints on this element

Element id

Observation.component:copy-number.referenceRange

Short description

Provides guide for interpretation of component result

Definition

Guidance on how to interpret the value by comparison to a normal or recommended range.

Requirements

Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: OBX.7
rim: outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]

variant-confidence-status

0..1

There are no (further) constraints on this element

Element id

Observation.component:variant-confidence-status

Short description

Variant Confidence Status

Definition

A code that represents the confidence of a true positive variant call.

Requirements

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: containment by OBX-4?
rim: outBoundRelationship[typeCode=COMP]

0..1

There are no (further) constraints on this element

Element id

Observation.component:variant-confidence-status.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Observation.component:variant-confidence-status.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Observation.component:variant-confidence-status.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

code

1..1

CodeableConceptPattern

There are no (further) constraints on this element

Element id

Observation.component:variant-confidence-status.code

Short description

variant-confidence-status

Definition

Describes what was observed. Sometimes this is called the observation "code".

Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Data type

Binding

Codes identifying names of simple observations.

VariantConfidenceStatusVS (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://hl7.org/fhir/uv/genomics-reporting/CodeSystem/tbd-codes-cs",
      "code": "variant-confidence-status"
    }
  ]
}

Mappings

w5: FiveWs.what[x]
sct-concept: < 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|
v2: OBX-3
rim: code

value[x]

1..1

Binding

There are no (further) constraints on this element

Element id

Observation.component:variant-confidence-status.value[x]

Short description

High | Intermediate | Low

Definition

The information determined as a result of making the observation, if the information has a simple value.

Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Binding

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|

valueCodeableConcept

There are no (further) constraints on this element

Data type

dataAbsentReason

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:variant-confidence-status.dataAbsentReason

Short description

Why the component result is missing

Definition

Provides a reason why the expected value in the element Observation.component.value[x] is missing.

Requirements

For many results it is necessary to handle exceptional values in measurements.

Comments

Data type

Binding

Codes specifying why the result (Observation.value[x]) is missing.

Conditions

The cardinality or value of this element may be affected by these constraints: obs-6

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: value.nullFlavor

interpretation

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:variant-confidence-status.interpretation

Short description

High, low, normal, etc.

Alternate names

Abnormal Flag

Definition

A categorical assessment of an observation value. For example, high, low, normal.

Requirements

For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.

Comments

Data type

Binding

Codes identifying interpretations of observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: < 260245000 |Findings values|
v2: OBX-8
rim: interpretationCode
sct-attr: 363713009 |Has interpretation|

referenceRange

0..*

There are no (further) constraints on this element

Element id

Observation.component:variant-confidence-status.referenceRange

Short description

Provides guide for interpretation of component result

Definition

Guidance on how to interpret the value by comparison to a normal or recommended range.

Requirements

Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: OBX.7
rim: outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]

class

0..1

There are no (further) constraints on this element

Element id

Observation.component:class

Short description

Component results

Definition

Requirements

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: containment by OBX-4?
rim: outBoundRelationship[typeCode=COMP]

0..1

There are no (further) constraints on this element

Element id

Observation.component:class.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Observation.component:class.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Observation.component:class.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

code

1..1

CodeableConceptPattern

Element id

Observation.component:class.code

Short description

Type of component observation (code / type)

Definition

Describes what was observed. Sometimes this is called the observation "code".

Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Data type

Binding

Codes identifying names of simple observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://snomed.info/sct",
      "code": "277046005",
      "display": "Class"
    }
  ]
}

Mappings

w5: FiveWs.what[x]
sct-concept: < 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|
v2: OBX-3
rim: code

value[x]

1..1

There are no (further) constraints on this element

Element id

Observation.component:class.value[x]

Short description

Actual component result

Definition

The information determined as a result of making the observation, if the information has a simple value.

Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|

valueQuantity

There are no (further) constraints on this element

Data type

valueCodeableConcept

There are no (further) constraints on this element

Data type

valueString

There are no (further) constraints on this element

Data type

valueBoolean

There are no (further) constraints on this element

Data type

valueInteger

There are no (further) constraints on this element

Data type

valueRange

There are no (further) constraints on this element

Data type

valueRatio

There are no (further) constraints on this element

Data type

valueSampledData

There are no (further) constraints on this element

Data type

valueTime

There are no (further) constraints on this element

Data type

valueDateTime

There are no (further) constraints on this element

Data type

valuePeriod

There are no (further) constraints on this element

Data type

dataAbsentReason

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:class.dataAbsentReason

Short description

Why the component result is missing

Definition

Provides a reason why the expected value in the element Observation.component.value[x] is missing.

Requirements

For many results it is necessary to handle exceptional values in measurements.

Comments

Data type

Binding

Codes specifying why the result (Observation.value[x]) is missing.

Conditions

The cardinality or value of this element may be affected by these constraints: obs-6

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: value.nullFlavor

interpretation

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:class.interpretation

Short description

High, low, normal, etc.

Alternate names

Abnormal Flag

Definition

A categorical assessment of an observation value. For example, high, low, normal.

Requirements

For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.

Comments

Data type

Binding

Codes identifying interpretations of observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: < 260245000 |Findings values|
v2: OBX-8
rim: interpretationCode
sct-attr: 363713009 |Has interpretation|

referenceRange

0..*

There are no (further) constraints on this element

Element id

Observation.component:class.referenceRange

Short description

Provides guide for interpretation of component result

Definition

Guidance on how to interpret the value by comparison to a normal or recommended range.

Requirements

Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: OBX.7
rim: outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]

probability

0..1

There are no (further) constraints on this element

Element id

Observation.component:probability

Short description

Component results

Definition

Requirements

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: containment by OBX-4?
rim: outBoundRelationship[typeCode=COMP]

0..1

There are no (further) constraints on this element

Element id

Observation.component:probability.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Observation.component:probability.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Observation.component:probability.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

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()

Mappings

rim: N/A

code

1..1

CodeableConceptPattern

Element id

Observation.component:probability.code

Short description

Type of component observation (code / type)

Definition

Describes what was observed. Sometimes this is called the observation "code".

Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Comments

All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Data type

Binding

Codes identifying names of simple observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl",
      "code": "C54154",
      "display": "Probability"
    }
  ]
}

Mappings

w5: FiveWs.what[x]
sct-concept: < 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|
v2: OBX-3
rim: code

value[x]

1..1

There are no (further) constraints on this element

Element id

Observation.component:probability.value[x]

Short description

Actual component result

Definition

The information determined as a result of making the observation, if the information has a simple value.

Requirements

An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|

valueQuantity

There are no (further) constraints on this element

Data type

valueCodeableConcept

There are no (further) constraints on this element

Data type

valueString

There are no (further) constraints on this element

Data type

valueBoolean

There are no (further) constraints on this element

Data type

valueInteger

There are no (further) constraints on this element

Data type

valueRange

There are no (further) constraints on this element

Data type

valueRatio

There are no (further) constraints on this element

Data type

valueSampledData

There are no (further) constraints on this element

Data type

valueTime

There are no (further) constraints on this element

Data type

valueDateTime

There are no (further) constraints on this element

Data type

valuePeriod

There are no (further) constraints on this element

Data type

dataAbsentReason

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:probability.dataAbsentReason

Short description

Why the component result is missing

Definition

Provides a reason why the expected value in the element Observation.component.value[x] is missing.

Requirements

For many results it is necessary to handle exceptional values in measurements.

Comments

Data type

Binding

Codes specifying why the result (Observation.value[x]) is missing.

Conditions

The cardinality or value of this element may be affected by these constraints: obs-6

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: value.nullFlavor

interpretation

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.component:probability.interpretation

Short description

High, low, normal, etc.

Alternate names

Abnormal Flag

Definition

A categorical assessment of an observation value. For example, high, low, normal.

Requirements

For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.

Comments

Data type

Binding

Codes identifying interpretations of observations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

sct-concept: < 260245000 |Findings values|
v2: OBX-8
rim: interpretationCode
sct-attr: 363713009 |Has interpretation|

referenceRange

0..*