Pathology FHIR Implementation Guide

Notice: This guidance is under active development by NHS England and content may be added or updated on a regular basis.

England-Observation-Lab-Pathology (Test Result)

Summary

A Pathology specific profile derived from the UK Core and EU-Lab Observation profiles to allow for the use of Pathology Bounded Coded List (PBCL) and Pathology and Laboratory Medicine (PaLM) SNOMED reference sets.

This page details how the profile is used to represent an individual test result. The test result may be for a single test or it may form part of a test group such as a Full Blood Count.

For a description of how the profile is used to represent test groups, refer to England-Observation-Lab-Pathology (Test Group).

Resource and Profile Links

R4 Resource (Base): Observation
Profile: England-Observation-Lab-Pathology

Profile Views

Refer to Profile Descriptions for a definition of the different profile view formats.

EnglandObservationLabPathology (Observation)

ObservationResultsLaboratoryEu

There are no (further) constraints on this element

Element id

Observation

Short description

Laboratory result for a simple test or for a panel/study

Alternate names

Vital Signs, Measurement, Results, Tests

Definition

This observation may represent the result of a simple laboratory test such as hematocrit or it may group the set of results produced by a multi-test study or panel such as a complete blood count, a dynamic function test, a urine specimen study. In the latter case, the observation carries the overall conclusion of the study and references the atomic results of the study as "has-member" child observations

Comments

Represents either a lab simple observation or the group of observations produced by a laboratory study.

Data type

ObservationResultsLaboratoryEu

Constraints

dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.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-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-6: A resource should have narrative for robust management
text.`div`.exists()
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.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()
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
dataAbsentReason.empty() or value.empty()
eu-lab-1: If observation status is other then "registered" or "cancelled", at least one of these Observation elements shall be provided: "value", "dataAbsentReason", "hasMember" or "component"
(status in ('registered'|'cancelled')) or value.exists() or hasMember.exists() or component.exists() or dataAbsentReason.exists()
eu-lab-2: If observation has components and observation status is other then "registered" or "cancelled", at least one of these Observation.component elements shall be provided: "value" or "dataAbsentReason"
component.exists() implies (status in ('registered'|'cancelled')) or component.value.exists() or component.dataAbsentReason.exists()

Mappings

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

0..1

string

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

string

Meta

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

Meta

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
rim: N/A

implicitRules

Σ ?!

0..1

uri

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

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

uri

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

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

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

code

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

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

text

0..1

Narrative

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

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

Narrative

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
rim: N/A
rim: Act.text?

contained

0..*

Resource

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

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

Resource

Mappings

rim: Entity. Role, or Act
rim: N/A

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.extension

Short description

Laboratory Test Kit

Alternate names

extensions, user content

Definition

The laboratory test kit used for this test.

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

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

supportingInfo

0..*

Extension(Reference(Resource))

There are no (further) constraints on this element

Element id

Observation.extension:supportingInfo

Short description

Other information that may be relevant to this event.

Alternate names

extensions, user content

Definition

Other resources from the patient record that may be relevant to the event. The information from these resources was either used to create the instance or is provided to help with its interpretation. This extension should not be used if more specific inline elements or extensions are available. For example, use Observation.hasMember instead of supportingInformation for representing the members of an Observation panel.

Comments

Data type

Extension(Reference(Resource))

Extension URL

http://hl7.org/fhir/StructureDefinition/workflow-supportingInfo

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

triggeredBy-r5

0..*

Extension(Complex)

There are no (further) constraints on this element

Element id

Observation.extension:triggeredBy-r5

Short description

Triggering observation(s)

Alternate names

extensions, user content

Definition

Identifies the observation(s) that triggered the performance of this observation.

Comments

Data type

Extension(Complex)

Extension URL

http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.extension:triggeredBy-r5.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

string

Mappings

rim: n/a

extension

2..*

Extension

There are no (further) constraints on this element

Element id

Observation.extension:triggeredBy-r5.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

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

observation

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.extension:triggeredBy-r5.extension:observation

Short description

Triggering observation.

Alternate names

extensions, user content

Definition

Reference to the triggering observation.

Comments

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.extension:triggeredBy-r5.extension:observation.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.extension:triggeredBy-r5.extension:observation.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.extension:triggeredBy-r5.extension:observation.url

Short description

identifies the meaning of the extension

Definition

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

Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Data type

uri

Fixed value

observation

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Observation.extension:triggeredBy-r5.extension:observation.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

valueReference

Reference(Observation)

There are no (further) constraints on this element

Data type

Reference(Observation)

type

1..1

ExtensionBinding

There are no (further) constraints on this element

Element id

Observation.extension:triggeredBy-r5.extension:type

Short description

The type of trigger

Alternate names

extensions, user content

Definition

The type of trigger. Reflex | Repeat | Re-run.

Comments

Data type

Extension

Binding

http://hl7.org/fhir/ValueSet/observation-triggeredbytype (required)

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.extension:triggeredBy-r5.extension: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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.extension:triggeredBy-r5.extension:type.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.extension:triggeredBy-r5.extension:type.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

type

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Observation.extension:triggeredBy-r5.extension:type.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

valueCode

code

There are no (further) constraints on this element

Data type

code

reason

0..1

Extension

There are no (further) constraints on this element

Element id

Observation.extension:triggeredBy-r5.extension:reason

Short description

Reason that the observation was triggered

Alternate names

extensions, user content

Definition

Provides the reason why this observation was performed as a result of the observation(s) referenced.

Comments

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.extension:triggeredBy-r5.extension:reason.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.extension:triggeredBy-r5.extension:reason.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.extension:triggeredBy-r5.extension:reason.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

reason

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Observation.extension:triggeredBy-r5.extension:reason.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

valueString

string

There are no (further) constraints on this element

Data type

string

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.extension:triggeredBy-r5.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy

Mappings

rim: N/A

value[x]

0..0

There are no (further) constraints on this element

Element id

Observation.extension:triggeredBy-r5.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

certifiedRefMaterialCodeable

0..*

Extension(CodeableConcept)

There are no (further) constraints on this element

Element id

Observation.extension:certifiedRefMaterialCodeable

Short description

Certified Reference Material: CodeableConcept

Alternate names

extensions, user content

Definition

This extension links this observation with the certified reference material used for the calibration. The certified reference material is identified by using a CodeableConcept. This extension should be used when the unit is UCUM [IU].

Comments

Data type

Extension(CodeableConcept)

Extension URL

http://hl7.eu/fhir/laboratory/StructureDefinition/observation-certifiedRefMaterialCodeable

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

certifiedRefMaterialIdentifer

0..*

Extension(Identifier)

There are no (further) constraints on this element

Element id

Observation.extension:certifiedRefMaterialIdentifer

Short description

Certified Reference Material: Identifier

Alternate names

extensions, user content

Definition

This extension links this observation with the certified reference material used for the calibration. The certified reference material is identified by using an Identifier. This extension should be used when the unit is UCUM [IU].

Comments

Data type

Extension(Identifier)

Extension URL

http://hl7.eu/fhir/laboratory/StructureDefinition/observation-certifiedRefMaterialIdentifer

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

labTestKit

0..*

Extension(Reference(Device))

There are no (further) constraints on this element

Element id

Observation.extension:labTestKit

Short description

Device Laboratory Test Kit

Alternate names

extensions, user content

Definition

This extension links this observation with the laboratory test kit used for this test. Usually only one laboratory test kit is referred

Comments

Data type

Extension(Reference(Device))

Extension URL

http://hl7.eu/fhir/laboratory/StructureDefinition/observation-deviceLabTestKit

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

extensionorganizer-r6

0..1

Extension(boolean)

Element id

Observation.extension:extensionorganizer-r6

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

Data type

Extension(boolean)

Extension URL

http://hl7.org/fhir/6.0/StructureDefinition/extension-Observation.organizer

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

Extension

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

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

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

identifier

0..*

Identifier

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

Identifier

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: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
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

Σ C

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.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

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())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Event.basedOn
v2: ORC
rim: .inboundRelationship[typeCode=COMP].source[moodCode=EVN]

partOf

Σ C

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

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())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
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

Status of this observation (e.g. preliminary, final,...)

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

code

Binding

Codes providing the status of an observation.

ObservationStatus (required)

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

CodeableConceptIPSBinding

There are no (further) constraints on this element

Element id

Observation.category

Short description

Concept - reference to a terminology or just text

Definition

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

Requirements

Used for filtering what observations are retrieved and displayed.

Comments

"laboratory" includes laboratory medicine and pathology

Data type

CodeableConceptIPS

Slicing

Unordered, Open, by $this(Pattern)

Binding

Codes for high level observation categories.

ObservationCategoryCodes (preferred)

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: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
w5: FiveWs.class
rim: .outboundRelationship[typeCode="COMP].target[classCode="LIST", moodCode="EVN"].code

(All Slices)

The requirements in this element apply to all slices

0..1

string

There are no (further) constraints on this element

Element id

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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.category.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

coding

SO Σ

0..*

CodingIPS

There are no (further) constraints on this element

Element id

Observation.category.coding

Short description

A reference to a 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.

Data type

CodingIPS

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: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

0..1

string

There are no (further) constraints on this element

Element id

Observation.category.coding.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.category.coding.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

system

SO Σ

0..1

uri

There are no (further) constraints on this element

Element id

Observation.category.coding.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

Data type

uri

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: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

version

0..1

string

There are no (further) constraints on this element

Element id

Observation.category.coding.version

Short description

Version of the system - if relevant

Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

Data type

string

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: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

SO Σ

0..1

code

There are no (further) constraints on this element

Element id

Observation.category.coding.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

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: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

display

0..1

string

There are no (further) constraints on this element

Element id

Observation.category.coding.display

Short description

Text representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

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: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

0..1

string

There are no (further) constraints on this element

Element id

Observation.category.coding.display.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.category.coding.display.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

translation

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.category.coding.display.extension:translation

Short description

Language Translation (Localization)

Alternate names

extensions, user content

Definition

Language translation from base language of resource to another language.

Comments

Data type

Extension

Extension URL

http://hl7.org/fhir/StructureDefinition/translation|5.3.0-ballot-tc1

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
rim: ST.translation

0..1

string

There are no (further) constraints on this element

Element id

Observation.category.coding.display.extension:translation.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

string

Mappings

rim: n/a

extension

2..*

Extension

There are no (further) constraints on this element

Element id

Observation.category.coding.display.extension:translation.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

lang

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.category.coding.display.extension:translation.extension:lang

Short description

Code for Language

Alternate names

extensions, user content

Definition

Code for Language.

Comments

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.category.coding.display.extension:translation.extension:lang.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.category.coding.display.extension:translation.extension:lang.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.category.coding.display.extension:translation.extension:lang.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

lang

Mappings

rim: N/A

value[x]

1..1

Binding

There are no (further) constraints on this element

Element id

Observation.category.coding.display.extension:translation.extension:lang.value[x]

Short description

Value of extension

Definition

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

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

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
rim: N/A

valueCode

code

There are no (further) constraints on this element

Data type

code

content

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.category.coding.display.extension:translation.extension:content

Short description

Content in other Language

Alternate names

extensions, user content

Definition

Content in other Language.

Comments

The type (string or markdown) must match the context in which it is used.

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.category.coding.display.extension:translation.extension:content.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.category.coding.display.extension:translation.extension:content.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.category.coding.display.extension:translation.extension:content.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

content

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Observation.category.coding.display.extension:translation.extension:content.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

valueMarkdown

markdown

There are no (further) constraints on this element

Data type

markdown

valueString

string

There are no (further) constraints on this element

Data type

string

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.category.coding.display.extension:translation.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

http://hl7.org/fhir/StructureDefinition/translation

Mappings

rim: N/A

value[x]

0..0

There are no (further) constraints on this element

Element id

Observation.category.coding.display.extension:translation.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

value

0..1

System.String

There are no (further) constraints on this element

Element id

Observation.category.coding.display.value

Short description

Primitive value for string

Definition

Primitive value for string

Data type

System.String

Maximum string length

1048576

userSelected

0..1

boolean

There are no (further) constraints on this element

Element id

Observation.category.coding.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

Data type

boolean

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: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

text

SO Σ

0..1

string

There are no (further) constraints on this element

Element id

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

string

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

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

0..1

string

There are no (further) constraints on this element

Element id

Observation.category.text.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.category.text.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

translation

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.category.text.extension:translation

Short description

Language Translation (Localization)

Alternate names

extensions, user content

Definition

Language translation from base language of resource to another language.

Comments

Data type

Extension

Extension URL

http://hl7.org/fhir/StructureDefinition/translation|5.3.0-ballot-tc1

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
rim: ST.translation

0..1

string

There are no (further) constraints on this element

Element id

Observation.category.text.extension:translation.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

string

Mappings

rim: n/a

extension

2..*

Extension

There are no (further) constraints on this element

Element id

Observation.category.text.extension:translation.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

lang

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.category.text.extension:translation.extension:lang

Short description

Code for Language

Alternate names

extensions, user content

Definition

Code for Language.

Comments

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.category.text.extension:translation.extension:lang.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.category.text.extension:translation.extension:lang.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.category.text.extension:translation.extension:lang.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

lang

Mappings

rim: N/A

value[x]

1..1

Binding

There are no (further) constraints on this element

Element id

Observation.category.text.extension:translation.extension:lang.value[x]

Short description

Value of extension

Definition

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

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

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
rim: N/A

valueCode

code

There are no (further) constraints on this element

Data type

code

content

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.category.text.extension:translation.extension:content

Short description

Content in other Language

Alternate names

extensions, user content

Definition

Content in other Language.

Comments

The type (string or markdown) must match the context in which it is used.

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.category.text.extension:translation.extension:content.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.category.text.extension:translation.extension:content.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.category.text.extension:translation.extension:content.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

content

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Observation.category.text.extension:translation.extension:content.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

valueMarkdown

markdown

There are no (further) constraints on this element

Data type

markdown

valueString

string

There are no (further) constraints on this element

Data type

string

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.category.text.extension:translation.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

http://hl7.org/fhir/StructureDefinition/translation

Mappings

rim: N/A

value[x]

0..0

There are no (further) constraints on this element

Element id

Observation.category.text.extension:translation.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

value

0..1

System.String

There are no (further) constraints on this element

Element id

Observation.category.text.value

Short description

Primitive value for string

Definition

Primitive value for string

Data type

System.String

Maximum string length

1048576

laboratory

1..1

CodeableConceptBindingPattern

There are no (further) constraints on this element

Element id

Observation.category:laboratory

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

CodeableConcept

Binding

Codes for high level observation categories.

ObservationCategoryCodes (preferred)

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

Pattern

{
  "coding": [
    {
      "system": "http://terminology.hl7.org/CodeSystem/observation-category",
      "code": "laboratory"
    }
  ]
}

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
w5: FiveWs.class
rim: .outboundRelationship[typeCode="COMP].target[classCode="LIST", moodCode="EVN"].code

studyType

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.category:studyType

Short description

The way of grouping of the test results into clinically meaningful domains (e.g. hematology study, microbiology study, etc.)

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

CodeableConcept

Binding

Codes for high level observation categories.

LabStudyTypesEuVs (required)

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: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
w5: FiveWs.class
rim: .outboundRelationship[typeCode="COMP].target[classCode="LIST", moodCode="EVN"].code

specialty

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.category:specialty

Short description

The clinical domain of the laboratory performing the observation (e.g. microbiology, toxicology, chemistry)

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

CodeableConcept

Binding

Codes for high level observation categories.

LabSpecialtyEuVs (required)

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: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
w5: FiveWs.class
rim: .outboundRelationship[typeCode="COMP].target[classCode="LIST", moodCode="EVN"].code

code

1..1

CodeableConceptIPSBinding

There are no (further) constraints on this element

Element id

Observation.code

Short description

Concept - reference to a terminology or just text

Alternate names

Name

Definition

Describes what was observed. Sometimes this is called the observation "name". In this profile this code represents either a simple laboratory test or a laboratory study with multiple child observations

Requirements

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

Comments

In the context of this Observation-laboratory profile, when the observation plays the role of a grouper of member sub-observations, the code represent the group (for instance a panel code). In case no code is available, at least a text shall be provided.

Data type

CodeableConceptIPS

Binding

Codes identifying names of simple observations.

LaboratoryResultStandardEuVs (preferred)

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: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
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|

0..1

string

There are no (further) constraints on this element

Element id

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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.code.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

coding

SO Σ

0..*

CodingIPS

Element id

Observation.code.coding

Short description

A reference to a 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.

Data type

CodingIPS

Slicing

Unordered, Open, by

Slicing for Pathology to differentiate between the SNOMED CT ValueSets, PaLM and PCBL

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: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

(All Slices)

The requirements in this element apply to all slices

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.coding.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

reference

0..1

Extension(uri)

Element id

Observation.code.coding.extension:reference

Short description

Url of Value set the code was chosen from

Alternate names

extensions, user content

Definition

A logical reference (e.g. a reference to ValueSet.url) that identifies the value set/version that identifies the set of possible coded values this coding was chosen from or constrained by.

Comments

If this extension is used with an extensible binding, and the concept comes from outside the bound valueset, the value set SHALL be different from the bound valueset.

Data type

Extension(uri)

Extension URL

http://hl7.org/fhir/StructureDefinition/valueset-reference

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
v2: CWE.
rim: CD.valueSet/CD.valueSetVersion

system

SO Σ

0..1

uri

There are no (further) constraints on this element

Element id

Observation.code.coding.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

uri

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: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

version

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.coding.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

string

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: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

SO Σ

0..1

code

There are no (further) constraints on this element

Element id

Observation.code.coding.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

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: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

display

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.coding.display

Short description

Text representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

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: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.coding.display.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding.display.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

translation

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding.display.extension:translation

Short description

Language Translation (Localization)

Alternate names

extensions, user content

Definition

Language translation from base language of resource to another language.

Comments

Data type

Extension

Extension URL

http://hl7.org/fhir/StructureDefinition/translation|5.3.0-ballot-tc1

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
rim: ST.translation

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.coding.display.extension:translation.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

string

Mappings

rim: n/a

extension

2..*

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding.display.extension:translation.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

lang

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding.display.extension:translation.extension:lang

Short description

Code for Language

Alternate names

extensions, user content

Definition

Code for Language.

Comments

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.coding.display.extension:translation.extension:lang.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding.display.extension:translation.extension:lang.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.code.coding.display.extension:translation.extension:lang.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

lang

Mappings

rim: N/A

value[x]

1..1

Binding

There are no (further) constraints on this element

Element id

Observation.code.coding.display.extension:translation.extension:lang.value[x]

Short description

Value of extension

Definition

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

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

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
rim: N/A

valueCode

code

There are no (further) constraints on this element

Data type

code

content

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding.display.extension:translation.extension:content

Short description

Content in other Language

Alternate names

extensions, user content

Definition

Content in other Language.

Comments

The type (string or markdown) must match the context in which it is used.

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.coding.display.extension:translation.extension:content.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding.display.extension:translation.extension:content.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.code.coding.display.extension:translation.extension:content.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

content

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Observation.code.coding.display.extension:translation.extension:content.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

valueMarkdown

markdown

There are no (further) constraints on this element

Data type

markdown

valueString

string

There are no (further) constraints on this element

Data type

string

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.code.coding.display.extension:translation.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

http://hl7.org/fhir/StructureDefinition/translation

Mappings

rim: N/A

value[x]

0..0

There are no (further) constraints on this element

Element id

Observation.code.coding.display.extension:translation.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

value

0..1

System.String

There are no (further) constraints on this element

Element id

Observation.code.coding.display.value

Short description

Primitive value for string

Definition

Primitive value for string

Data type

System.String

Maximum string length

1048576

userSelected

0..1

boolean

There are no (further) constraints on this element

Element id

Observation.code.coding.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

boolean

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: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

pathology-PaLM

SO Σ

0..*

CodingIPSBinding

Element id

Observation.code.coding:pathology-PaLM

Short description

A reference to a 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.

Data type

CodingIPS

Binding

This slice is to denote the code comes from the Pathology and laboratory medicine observable entity simple reference set

EnglandPathologyAndLaboratoryMedicineObservables (extensible)

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: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

reference-palm-observables

0..1

Extension(uri)

Element id

Observation.code.coding:pathology-PaLM.extension:reference-palm-observables

Short description

Url of Value set the code was chosen from

Alternate names

extensions, user content

Definition

A logical reference (e.g. a reference to ValueSet.url) that identifies the value set/version that identifies the set of possible coded values this coding was chosen from or constrained by.

Comments

If this extension is used with an extensible binding, and the concept comes from outside the bound valueset, the value set SHALL be different from the bound valueset.

Data type

Extension(uri)

Extension URL

http://hl7.org/fhir/StructureDefinition/valueset-reference

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
v2: CWE.
rim: CD.valueSet/CD.valueSetVersion

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.extension:reference-palm-observables.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.extension:reference-palm-observables.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.extension:reference-palm-observables.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

http://hl7.org/fhir/StructureDefinition/valueset-reference

Mappings

rim: N/A

value[x]

1..1

Fixed Value

Element id

Observation.code.coding:pathology-PaLM.extension:reference-palm-observables.value[x]

Short description

Value of extension

Definition

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

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

Fixed value

https://fhir.nhs.uk/England/ValueSet/England-PathologyAndLaboratoryMedicineObservables

Mappings

rim: n/a
rim: N/A

valueUri

uri

There are no (further) constraints on this element

Data type

uri

system

SO Σ

0..1

uri

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

uri

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: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

version

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

string

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: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

SO Σ

0..1

code

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

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: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

display

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.display

Short description

Text representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

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: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.display.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.display.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

translation

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.display.extension:translation

Short description

Language Translation (Localization)

Alternate names

extensions, user content

Definition

Language translation from base language of resource to another language.

Comments

Data type

Extension

Extension URL

http://hl7.org/fhir/StructureDefinition/translation|5.3.0-ballot-tc1

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
rim: ST.translation

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.display.extension:translation.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

string

Mappings

rim: n/a

extension

2..*

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.display.extension:translation.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

lang

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.display.extension:translation.extension:lang

Short description

Code for Language

Alternate names

extensions, user content

Definition

Code for Language.

Comments

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.display.extension:translation.extension:lang.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.display.extension:translation.extension:lang.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.display.extension:translation.extension:lang.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

lang

Mappings

rim: N/A

value[x]

1..1

Binding

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.display.extension:translation.extension:lang.value[x]

Short description

Value of extension

Definition

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

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

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
rim: N/A

valueCode

code

There are no (further) constraints on this element

Data type

code

content

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.display.extension:translation.extension:content

Short description

Content in other Language

Alternate names

extensions, user content

Definition

Content in other Language.

Comments

The type (string or markdown) must match the context in which it is used.

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.display.extension:translation.extension:content.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.display.extension:translation.extension:content.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.display.extension:translation.extension:content.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

content

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.display.extension:translation.extension:content.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

valueMarkdown

markdown

There are no (further) constraints on this element

Data type

markdown

valueString

string

There are no (further) constraints on this element

Data type

string

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.display.extension:translation.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

http://hl7.org/fhir/StructureDefinition/translation

Mappings

rim: N/A

value[x]

0..0

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.display.extension:translation.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

value

0..1

System.String

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.display.value

Short description

Primitive value for string

Definition

Primitive value for string

Data type

System.String

Maximum string length

1048576

userSelected

0..1

boolean

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

boolean

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: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

pathology-PBCL

SO Σ

0..*

CodingIPSBinding

Element id

Observation.code.coding:pathology-PBCL

Short description

A reference to a 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.

Data type

CodingIPS

Binding

This slice is to denote the code comes from the Pathology Bounded Code List observables simple reference set

EnglandPathologyBoundedCodeListObservables (extensible)

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: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

reference-pbcl-observables

0..1

Extension(uri)

Element id

Observation.code.coding:pathology-PBCL.extension:reference-pbcl-observables

Short description

Url of Value set the code was chosen from

Alternate names

extensions, user content

Definition

A logical reference (e.g. a reference to ValueSet.url) that identifies the value set/version that identifies the set of possible coded values this coding was chosen from or constrained by.

Comments

If this extension is used with an extensible binding, and the concept comes from outside the bound valueset, the value set SHALL be different from the bound valueset.

Data type

Extension(uri)

Extension URL

http://hl7.org/fhir/StructureDefinition/valueset-reference

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
v2: CWE.
rim: CD.valueSet/CD.valueSetVersion

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.extension:reference-pbcl-observables.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.extension:reference-pbcl-observables.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.extension:reference-pbcl-observables.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

http://hl7.org/fhir/StructureDefinition/valueset-reference

Mappings

rim: N/A

value[x]

1..1

Fixed Value

Element id

Observation.code.coding:pathology-PBCL.extension:reference-pbcl-observables.value[x]

Short description

Value of extension

Definition

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

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

Fixed value

https://fhir.nhs.uk/England/ValueSet/England-PathologyBoundedCodeListObservables

Mappings

rim: n/a
rim: N/A

valueUri

uri

There are no (further) constraints on this element

Data type

uri

system

SO Σ

0..1

uri

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

uri

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: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

version

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

string

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: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

SO Σ

0..1

code

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

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: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

display

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.display

Short description

Text representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

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: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.display.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.display.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

translation

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.display.extension:translation

Short description

Language Translation (Localization)

Alternate names

extensions, user content

Definition

Language translation from base language of resource to another language.

Comments

Data type

Extension

Extension URL

http://hl7.org/fhir/StructureDefinition/translation|5.3.0-ballot-tc1

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
rim: ST.translation

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.display.extension:translation.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

string

Mappings

rim: n/a

extension

2..*

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.display.extension:translation.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

lang

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.display.extension:translation.extension:lang

Short description

Code for Language

Alternate names

extensions, user content

Definition

Code for Language.

Comments

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.display.extension:translation.extension:lang.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.display.extension:translation.extension:lang.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.display.extension:translation.extension:lang.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

lang

Mappings

rim: N/A

value[x]

1..1

Binding

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.display.extension:translation.extension:lang.value[x]

Short description

Value of extension

Definition

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

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

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
rim: N/A

valueCode

code

There are no (further) constraints on this element

Data type

code

content

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.display.extension:translation.extension:content

Short description

Content in other Language

Alternate names

extensions, user content

Definition

Content in other Language.

Comments

The type (string or markdown) must match the context in which it is used.

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.display.extension:translation.extension:content.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.display.extension:translation.extension:content.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.display.extension:translation.extension:content.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

content

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.display.extension:translation.extension:content.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

valueMarkdown

markdown

There are no (further) constraints on this element

Data type

markdown

valueString

string

There are no (further) constraints on this element

Data type

string

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.display.extension:translation.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

http://hl7.org/fhir/StructureDefinition/translation

Mappings

rim: N/A

value[x]

0..0

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.display.extension:translation.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

value

0..1

System.String

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.display.value

Short description

Primitive value for string

Definition

Primitive value for string

Data type

System.String

Maximum string length

1048576

userSelected

0..1

boolean

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

boolean

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: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

text

SO Σ

0..1

string

There are no (further) constraints on this element

Element id

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

Comments

Very often the text is the same as a displayName of one of the codings.

Data type

string

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

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.text.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.code.text.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

translation

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.code.text.extension:translation

Short description

Language Translation (Localization)

Alternate names

extensions, user content

Definition

Language translation from base language of resource to another language.

Comments

Data type

Extension

Extension URL

http://hl7.org/fhir/StructureDefinition/translation|5.3.0-ballot-tc1

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
rim: ST.translation

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.text.extension:translation.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

string

Mappings

rim: n/a

extension

2..*

Extension

There are no (further) constraints on this element

Element id

Observation.code.text.extension:translation.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

lang

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.code.text.extension:translation.extension:lang

Short description

Code for Language

Alternate names

extensions, user content

Definition

Code for Language.

Comments

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.text.extension:translation.extension:lang.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.code.text.extension:translation.extension:lang.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.code.text.extension:translation.extension:lang.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

lang

Mappings

rim: N/A

value[x]

1..1

Binding

There are no (further) constraints on this element

Element id

Observation.code.text.extension:translation.extension:lang.value[x]

Short description

Value of extension

Definition

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

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

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
rim: N/A

valueCode

code

There are no (further) constraints on this element

Data type

code

content

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.code.text.extension:translation.extension:content

Short description

Content in other Language

Alternate names

extensions, user content

Definition

Content in other Language.

Comments

The type (string or markdown) must match the context in which it is used.

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.text.extension:translation.extension:content.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.code.text.extension:translation.extension:content.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.code.text.extension:translation.extension:content.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

content

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Observation.code.text.extension:translation.extension:content.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

valueMarkdown

markdown

There are no (further) constraints on this element

Data type

markdown

valueString

string

There are no (further) constraints on this element

Data type

string

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.code.text.extension:translation.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

http://hl7.org/fhir/StructureDefinition/translation

Mappings

rim: N/A

value[x]

0..0

There are no (further) constraints on this element

Element id

Observation.code.text.extension:translation.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

value

0..1

System.String

There are no (further) constraints on this element

Element id

Observation.code.text.value

Short description

Primitive value for string

Definition

Primitive value for string

Data type

System.String

Maximum string length

1048576

subject

Σ C

1..1

Reference(PatientEuCore | PatientAnimalEu | Device | Group | Location)

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

Reference(PatientEuCore | PatientAnimalEu | Device | Group | Location)

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())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Event.subject
w5: FiveWs.subject[x]
v2: PID-3
rim: participation[typeCode=RTGT]
w5: FiveWs.subject

focus

Σ C

0..*

Reference(Resource)

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

Reference(Resource)

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())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.subject[x]
v2: OBX-3
rim: participation[typeCode=SBJ]
w5: FiveWs.subject

encounter

Σ C

0..1

Reference(Encounter)

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

Reference(Encounter)

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())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Event.context
w5: FiveWs.context
v2: PV1
rim: inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]

effective[x]

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

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

dateTime

There are no (further) constraints on this element

Data type

dateTime

effectiveInstant

instant

There are no (further) constraints on this element

Data type

instant

effectivePeriod

Period

There are no (further) constraints on this element

Data type

Period

effectiveTiming

Timing

There are no (further) constraints on this element

Data type

Timing

issued

0..1

instant

There are no (further) constraints on this element

Element id

Observation.issued

Short description

Date/Time this result 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

instant

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

performer

Σ C

1..*

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.

Comments

Data type

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())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
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]

0..1

string

There are no (further) constraints on this element

Element id

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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.performer.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

performerFunction

0..1

Extension(CodeableConcept)

There are no (further) constraints on this element

Element id

Observation.performer.extension:performerFunction

Short description

Type of performance

Alternate names

extensions, user content

Definition

Distinguishes the type of involvement of the performer in the event. For example, 'author', 'verifier' or 'responsible party'.

Comments

Data type

Extension(CodeableConcept)

Extension URL

http://hl7.org/fhir/StructureDefinition/event-performerFunction

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
workflow: Event.performer.function

reference

Σ C

0..1

string

There are no (further) constraints on this element

Element id

Observation.performer.reference

Short description

Literal reference, Relative, internal or absolute URL

Definition

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

Data type

string

Conditions

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

Constraints

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

Mappings

rim: n/a
rim: N/A

type

0..1

uriBinding

There are no (further) constraints on this element

Element id

Observation.performer.type

Short description

Type the reference refers to (e.g. "Patient")

Definition

The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

Comments

This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

Data type

uri

Binding

Aa resource (or, for logical models, the URI of the logical model).

ResourceType (extensible)

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
rim: N/A

identifier

0..1

Identifier

There are no (further) constraints on this element

Element id

Observation.performer.identifier

Short description

Logical reference, when literal reference is not known

Definition

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

Comments

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

Data type

Identifier

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: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
rim: .identifier

display

0..1

string

There are no (further) constraints on this element

Element id

Observation.performer.display

Short description

Text alternative for the resource

Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Data type

string

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
rim: N/A

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.

Slicing

Unordered, Closed, by $this(Type)

Conditions

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

Constraints

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

Mappings

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

valueBoolean

boolean

There are no (further) constraints on this element

Data type

boolean

valueInteger

integer

There are no (further) constraints on this element

Data type

integer

valueSampledData

SampledData

There are no (further) constraints on this element

Data type

SampledData

valueString

Σ C

0..1

string

There are no (further) constraints on this element

Element id

Observation.value[x]:valueString

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

Data type

string

Conditions

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

Constraints

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

Mappings

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

valueRange

Σ C

0..1

RangeEuLab

There are no (further) constraints on this element

Element id

Observation.value[x]:valueRange

Short description

A measured range using UCUM

Definition

A measured range (or a range that can potentially be measured) and uncertainty of the measurement. This profile imposes that the code system for units be UCUM.

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

The stated low and high value are assumed to have arbitrarily high precision when it comes to determining which values are in the range. I.e. 1.99 is not in the range 2 -> 3.

Data type

RangeEuLab

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
rng-2: If present, low SHALL have a lower value than high
low.empty() or high.empty() or (low <= high)

Mappings

rim: n/a
sct-concept: < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|
v2: NR and also possibly SN (but see also quantity)
rim: IVL<QTY[not(type="TS")]> [lowClosed="true" and highClosed="true"]or URG<QTY[not(type="TS")]>

valueRatio

Σ C

0..1

RatioEuLab

There are no (further) constraints on this element

Element id

Observation.value[x]:valueRatio

Short description

A measured ratio using UCUM

Definition

A measured ratio (or a ratio that can potentially be measured) and uncertainty of the measurement. This profile imposes that the code system for units be UCUM.

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

The Ratio datatype should only be used to express a relationship of two numbers if the relationship cannot be suitably expressed using a Quantity and a common unit. Where the denominator value is known to be fixed to "1", Quantity should be used instead of Ratio.

Data type

RatioEuLab

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present
(numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists())

Mappings

rim: n/a
sct-concept: < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|
v2: N/A
rim: RTO

valueTime

Σ C

0..1

time

There are no (further) constraints on this element

Element id

Observation.value[x]:valueTime

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

Data type

time

Conditions

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

Constraints

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

Mappings

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

valueDateTime

Σ C

0..1

dateTime

There are no (further) constraints on this element

Element id

Observation.value[x]:valueDateTime

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

Data type

dateTime

Conditions

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

Constraints

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

Mappings

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

valuePeriod

Σ C

0..1

Period

There are no (further) constraints on this element

Element id

Observation.value[x]:valuePeriod

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

Data type

Period

Conditions

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

Constraints

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

Mappings

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

valueQuantity

Σ C

0..1

QuantityEuLab

There are no (further) constraints on this element

Element id

Observation.value[x]:valueQuantity

Short description

A measured amount using UCUM

Definition

A measured amount (or an amount that can potentially be measured) and uncertainty of the measurement. Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies. This profile imposes that the code system for units be UCUM.

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

The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.

Data type

QuantityEuLab

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
qty-3: If a code for the unit is present, the system SHALL also be present
code.empty() or system.exists()

Mappings

rim: n/a
sct-concept: < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|
v2: SN (see also Range) or CQ
rim: PQ, IVL<PQ>, MO, CO, depending on the values

valueCodeableConcept

Σ C

0..1

CodeableConceptIPSBinding

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept

Short description

Concept - reference to a terminology or just text

Definition

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

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

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Data type

CodeableConceptIPS

Binding

ResultsCodedValuesLaboratoryPathologyUvIps (preferred)

Additional bindings

http://hl7.org/fhir/uv/ips/ValueSet/results-blood-group-snomed-ct-ips-free-set (candidate)
Additional conformance binding to a blood group findings value set for laboratory result values from the SNOMED CT IPS free set for use globally (in SNOMED member and non-member jurisdictions).
http://hl7.org/fhir/uv/ips/ValueSet/results-presence-absence-snomed-ct-ips-free-set (candidate)
Additional conformance binding to a presence and absence findings (qualifier values) value set for laboratory result values from the SNOMED CT IPS free set for use globally (in SNOMED member and non-member jurisdictions).
http://hl7.org/fhir/uv/ips/ValueSet/results-microorganism-snomed-ct-ips-free-set (candidate)
Additional conformance binding to a microorganisms value set for laboratory result values from the SNOMED CT IPS free set for use globally (in SNOMED member and non-member jurisdictions).

Conditions

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

Constraints

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

Mappings

rim: n/a
sct-concept: < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD

0..1

string

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

coding

SO Σ

0..*

CodingIPS

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding

Short description

A reference to a 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.

Data type

CodingIPS

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: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

0..1

string

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

system

SO Σ

0..1

uri

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

uri

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: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

version

0..1

string

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

string

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: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

SO Σ

0..1

code

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

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: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

display

0..1

string

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.display

Short description

Text representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

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: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

0..1

string

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.display.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.display.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

translation

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.display.extension:translation

Short description

Language Translation (Localization)

Alternate names

extensions, user content

Definition

Language translation from base language of resource to another language.

Comments

Data type

Extension

Extension URL

http://hl7.org/fhir/StructureDefinition/translation|5.3.0-ballot-tc1

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
rim: ST.translation

0..1

string

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.display.extension:translation.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

string

Mappings

rim: n/a

extension

2..*

Extension

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.display.extension:translation.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

lang

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.display.extension:translation.extension:lang

Short description

Code for Language

Alternate names

extensions, user content

Definition

Code for Language.

Comments

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.display.extension:translation.extension:lang.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.display.extension:translation.extension:lang.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.display.extension:translation.extension:lang.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

lang

Mappings

rim: N/A

value[x]

1..1

Binding

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.display.extension:translation.extension:lang.value[x]

Short description

Value of extension

Definition

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

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

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
rim: N/A

valueCode

code

There are no (further) constraints on this element

Data type

code

content

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.display.extension:translation.extension:content

Short description

Content in other Language

Alternate names

extensions, user content

Definition

Content in other Language.

Comments

The type (string or markdown) must match the context in which it is used.

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.display.extension:translation.extension:content.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.display.extension:translation.extension:content.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.display.extension:translation.extension:content.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

content

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.display.extension:translation.extension:content.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

valueMarkdown

markdown

There are no (further) constraints on this element

Data type

markdown

valueString

string

There are no (further) constraints on this element

Data type

string

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.display.extension:translation.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

http://hl7.org/fhir/StructureDefinition/translation

Mappings

rim: N/A

value[x]

0..0

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.display.extension:translation.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

value

0..1

System.String

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.display.value

Short description

Primitive value for string

Definition

Primitive value for string

Data type

System.String

Maximum string length

1048576

userSelected

0..1

boolean

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

boolean

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: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

text

SO Σ

0..1

string

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.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

Comments

Very often the text is the same as a displayName of one of the codings.

Data type

string

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

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

0..1

string

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.text.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.text.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

translation

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.text.extension:translation

Short description

Language Translation (Localization)

Alternate names

extensions, user content

Definition

Language translation from base language of resource to another language.

Comments

Data type

Extension

Extension URL

http://hl7.org/fhir/StructureDefinition/translation|5.3.0-ballot-tc1

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
rim: ST.translation

0..1

string

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.text.extension:translation.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

string

Mappings

rim: n/a

extension

2..*

Extension

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.text.extension:translation.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

lang

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.text.extension:translation.extension:lang

Short description

Code for Language

Alternate names

extensions, user content

Definition

Code for Language.

Comments

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.text.extension:translation.extension:lang.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.text.extension:translation.extension:lang.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.text.extension:translation.extension:lang.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

lang

Mappings

rim: N/A

value[x]

1..1

Binding

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.text.extension:translation.extension:lang.value[x]

Short description

Value of extension

Definition

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

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

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
rim: N/A

valueCode

code

There are no (further) constraints on this element

Data type

code

content

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.text.extension:translation.extension:content

Short description

Content in other Language

Alternate names

extensions, user content

Definition

Content in other Language.

Comments

The type (string or markdown) must match the context in which it is used.

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.text.extension:translation.extension:content.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.text.extension:translation.extension:content.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.text.extension:translation.extension:content.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

content

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.text.extension:translation.extension:content.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

valueMarkdown

markdown

There are no (further) constraints on this element

Data type

markdown

valueString

string

There are no (further) constraints on this element

Data type

string

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.text.extension:translation.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

http://hl7.org/fhir/StructureDefinition/translation

Mappings

rim: N/A

value[x]

0..0

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.text.extension:translation.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

value

0..1

System.String

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.text.value

Short description

Primitive value for string

Definition

Primitive value for string

Data type

System.String

Maximum string length

1048576

dataAbsentReason

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.dataAbsentReason

Short description

Provides a reason why the expected value 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

CodeableConcept

Binding

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

DataAbsentReason (extensible)

Conditions

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

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: N/A
rim: value.nullFlavor

interpretation

0..*

CodeableConceptIPSBinding

Element id

Observation.interpretation

Short description

Concept - reference to a terminology or just text

Alternate names

Abnormal Flag

Definition

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

Requirements

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

Comments

Data type

CodeableConceptIPS

Binding

Codes identifying interpretations of observations.

EnglandDeviatingResultIndicator (extensible)

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: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
sct-concept: < 260245000 |Findings values|
v2: OBX-8
rim: interpretationCode
sct-attr: 363713009 |Has interpretation|

0..1

string

There are no (further) constraints on this element

Element id

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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.interpretation.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

coding

SO Σ

0..*

CodingIPS

There are no (further) constraints on this element

Element id

Observation.interpretation.coding

Short description

A reference to a 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.

Data type

CodingIPS

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: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

0..1

string

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

system

SO Σ

0..1

uri

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

uri

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: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

version

0..1

string

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

string

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: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

SO Σ

0..1

code

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

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: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

display

0..1

string

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.display

Short description

Text representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

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: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

0..1

string

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.display.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.display.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

translation

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.display.extension:translation

Short description

Language Translation (Localization)

Alternate names

extensions, user content

Definition

Language translation from base language of resource to another language.

Comments

Data type

Extension

Extension URL

http://hl7.org/fhir/StructureDefinition/translation|5.3.0-ballot-tc1

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
rim: ST.translation

0..1

string

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.display.extension:translation.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

string

Mappings

rim: n/a

extension

2..*

Extension

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.display.extension:translation.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

lang

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.display.extension:translation.extension:lang

Short description

Code for Language

Alternate names

extensions, user content

Definition

Code for Language.

Comments

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.display.extension:translation.extension:lang.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.display.extension:translation.extension:lang.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.display.extension:translation.extension:lang.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

lang

Mappings

rim: N/A

value[x]

1..1

Binding

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.display.extension:translation.extension:lang.value[x]

Short description

Value of extension

Definition

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

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

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
rim: N/A

valueCode

code

There are no (further) constraints on this element

Data type

code

content

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.display.extension:translation.extension:content

Short description

Content in other Language

Alternate names

extensions, user content

Definition

Content in other Language.

Comments

The type (string or markdown) must match the context in which it is used.

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.display.extension:translation.extension:content.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.display.extension:translation.extension:content.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.display.extension:translation.extension:content.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

content

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.display.extension:translation.extension:content.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

valueMarkdown

markdown

There are no (further) constraints on this element

Data type

markdown

valueString

string

There are no (further) constraints on this element

Data type

string

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.display.extension:translation.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

http://hl7.org/fhir/StructureDefinition/translation

Mappings

rim: N/A

value[x]

0..0

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.display.extension:translation.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

value

0..1

System.String

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.display.value

Short description

Primitive value for string

Definition

Primitive value for string

Data type

System.String

Maximum string length

1048576

userSelected

0..1

boolean

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

boolean

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: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

text

SO Σ

0..1

string

There are no (further) constraints on this element

Element id

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

Comments

Very often the text is the same as a displayName of one of the codings.

Data type

string

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

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

0..1

string

There are no (further) constraints on this element

Element id

Observation.interpretation.text.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.interpretation.text.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

translation

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.interpretation.text.extension:translation

Short description

Language Translation (Localization)

Alternate names

extensions, user content

Definition

Language translation from base language of resource to another language.

Comments

Data type

Extension

Extension URL

http://hl7.org/fhir/StructureDefinition/translation|5.3.0-ballot-tc1

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
rim: ST.translation

0..1

string

There are no (further) constraints on this element

Element id

Observation.interpretation.text.extension:translation.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

string

Mappings

rim: n/a

extension

2..*

Extension

There are no (further) constraints on this element

Element id

Observation.interpretation.text.extension:translation.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

lang

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.interpretation.text.extension:translation.extension:lang

Short description

Code for Language

Alternate names

extensions, user content

Definition

Code for Language.

Comments

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.interpretation.text.extension:translation.extension:lang.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.interpretation.text.extension:translation.extension:lang.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.interpretation.text.extension:translation.extension:lang.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

lang

Mappings

rim: N/A

value[x]

1..1

Binding

There are no (further) constraints on this element

Element id

Observation.interpretation.text.extension:translation.extension:lang.value[x]

Short description

Value of extension

Definition

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

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

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
rim: N/A

valueCode

code

There are no (further) constraints on this element

Data type

code

content

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.interpretation.text.extension:translation.extension:content

Short description

Content in other Language

Alternate names

extensions, user content

Definition

Content in other Language.

Comments

The type (string or markdown) must match the context in which it is used.

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.interpretation.text.extension:translation.extension:content.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.interpretation.text.extension:translation.extension:content.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.interpretation.text.extension:translation.extension:content.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

content

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Observation.interpretation.text.extension:translation.extension:content.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

valueMarkdown

markdown

There are no (further) constraints on this element

Data type

markdown

valueString

string

There are no (further) constraints on this element

Data type

string

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.interpretation.text.extension:translation.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

http://hl7.org/fhir/StructureDefinition/translation

Mappings

rim: N/A

value[x]

0..0

There are no (further) constraints on this element

Element id

Observation.interpretation.text.extension:translation.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

value

0..1

System.String

There are no (further) constraints on this element

Element id

Observation.interpretation.text.value

Short description

Primitive value for string

Definition

Primitive value for string

Data type

System.String

Maximum string length

1048576

note

0..*

Annotation

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

Annotation

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
v2: NTE.3 (partner NTE to OBX, or sometimes another (child?) OBX)
rim: subjectOf.observationEvent[code="annotation"].value

bodySite

0..1

CodeableConcept

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

CodeableConcept

Binding

Codes describing anatomical locations. May include laterality.

SNOMEDCTBodyStructures (example)

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: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
sct-concept: < 123037004 |Body structure|
v2: OBX-20
rim: targetSiteCode
sct-attr: 718497002 |Inherent location|

method

0..1

CodeableConceptIPSBinding

There are no (further) constraints on this element

Element id

Observation.method

Short description

Concept - reference to a terminology or just text

Definition

Laboratory technigue that has been used

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

Laboratory technique (method of measurement) are integral parts of the test specification of some laboratory test coding systems (e.g. NPU), in LOINC hovewer measurement principle is not always present in the test definition. In some cases however knowledge of the used measurment techique is important for proper interpretation of the test result. That's why it is important to explicitly include informaiton about measurement method is such cases.

Data type

CodeableConceptIPS

Binding

Methods for simple observations.

LabTechniqueEuVs (preferred)

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: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: OBX-17
rim: methodCode

0..1

string

There are no (further) constraints on this element

Element id

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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.method.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

coding

SO Σ

0..*

CodingIPS

There are no (further) constraints on this element

Element id

Observation.method.coding

Short description

A reference to a 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.

Data type

CodingIPS

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: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

0..1

string

There are no (further) constraints on this element

Element id

Observation.method.coding.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.method.coding.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

system

SO Σ

0..1

uri

There are no (further) constraints on this element

Element id

Observation.method.coding.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

uri

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: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

version

0..1

string

There are no (further) constraints on this element

Element id

Observation.method.coding.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

string

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: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

SO Σ

0..1

code

There are no (further) constraints on this element

Element id

Observation.method.coding.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

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: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

display

0..1

string

There are no (further) constraints on this element

Element id

Observation.method.coding.display

Short description

Text representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

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: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

0..1

string

There are no (further) constraints on this element

Element id

Observation.method.coding.display.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.method.coding.display.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

translation

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.method.coding.display.extension:translation

Short description

Language Translation (Localization)

Alternate names

extensions, user content

Definition

Language translation from base language of resource to another language.

Comments

Data type

Extension

Extension URL

http://hl7.org/fhir/StructureDefinition/translation|5.3.0-ballot-tc1

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
rim: ST.translation

0..1

string

There are no (further) constraints on this element

Element id

Observation.method.coding.display.extension:translation.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

string

Mappings

rim: n/a

extension

2..*

Extension

There are no (further) constraints on this element

Element id

Observation.method.coding.display.extension:translation.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

lang

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.method.coding.display.extension:translation.extension:lang

Short description

Code for Language

Alternate names

extensions, user content

Definition

Code for Language.

Comments

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.method.coding.display.extension:translation.extension:lang.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.method.coding.display.extension:translation.extension:lang.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.method.coding.display.extension:translation.extension:lang.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

lang

Mappings

rim: N/A

value[x]

1..1

Binding

There are no (further) constraints on this element

Element id

Observation.method.coding.display.extension:translation.extension:lang.value[x]

Short description

Value of extension

Definition

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

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

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
rim: N/A

valueCode

code

There are no (further) constraints on this element

Data type

code

content

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.method.coding.display.extension:translation.extension:content

Short description

Content in other Language

Alternate names

extensions, user content

Definition

Content in other Language.

Comments

The type (string or markdown) must match the context in which it is used.

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.method.coding.display.extension:translation.extension:content.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.method.coding.display.extension:translation.extension:content.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.method.coding.display.extension:translation.extension:content.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

content

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Observation.method.coding.display.extension:translation.extension:content.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

valueMarkdown

markdown

There are no (further) constraints on this element

Data type

markdown

valueString

string

There are no (further) constraints on this element

Data type

string

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.method.coding.display.extension:translation.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

http://hl7.org/fhir/StructureDefinition/translation

Mappings

rim: N/A

value[x]

0..0

There are no (further) constraints on this element

Element id

Observation.method.coding.display.extension:translation.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

value

0..1

System.String

There are no (further) constraints on this element

Element id

Observation.method.coding.display.value

Short description

Primitive value for string

Definition

Primitive value for string

Data type

System.String

Maximum string length

1048576

userSelected

0..1

boolean

There are no (further) constraints on this element

Element id

Observation.method.coding.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

boolean

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: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

text

SO Σ

0..1

string

There are no (further) constraints on this element

Element id

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

Comments

Very often the text is the same as a displayName of one of the codings.

Data type

string

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

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

0..1

string

There are no (further) constraints on this element

Element id

Observation.method.text.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.method.text.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

translation

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.method.text.extension:translation

Short description

Language Translation (Localization)

Alternate names

extensions, user content

Definition

Language translation from base language of resource to another language.

Comments

Data type

Extension

Extension URL

http://hl7.org/fhir/StructureDefinition/translation|5.3.0-ballot-tc1

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
rim: ST.translation

0..1

string

There are no (further) constraints on this element

Element id

Observation.method.text.extension:translation.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

string

Mappings

rim: n/a

extension

2..*

Extension

There are no (further) constraints on this element

Element id

Observation.method.text.extension:translation.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

lang

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.method.text.extension:translation.extension:lang

Short description

Code for Language

Alternate names

extensions, user content

Definition

Code for Language.

Comments

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.method.text.extension:translation.extension:lang.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.method.text.extension:translation.extension:lang.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.method.text.extension:translation.extension:lang.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

lang

Mappings

rim: N/A

value[x]

1..1

Binding

There are no (further) constraints on this element

Element id

Observation.method.text.extension:translation.extension:lang.value[x]

Short description

Value of extension

Definition

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

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

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
rim: N/A

valueCode

code

There are no (further) constraints on this element

Data type

code

content

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.method.text.extension:translation.extension:content

Short description

Content in other Language

Alternate names

extensions, user content

Definition

Content in other Language.

Comments

The type (string or markdown) must match the context in which it is used.

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.method.text.extension:translation.extension:content.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.method.text.extension:translation.extension:content.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.method.text.extension:translation.extension:content.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

content

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Observation.method.text.extension:translation.extension:content.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

valueMarkdown

markdown

There are no (further) constraints on this element

Data type

markdown

valueString

string

There are no (further) constraints on this element

Data type

string

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.method.text.extension:translation.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

http://hl7.org/fhir/StructureDefinition/translation

Mappings

rim: N/A

value[x]

0..0

There are no (further) constraints on this element

Element id

Observation.method.text.extension:translation.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

value

0..1

System.String

There are no (further) constraints on this element

Element id

Observation.method.text.value

Short description

Primitive value for string

Definition

Primitive value for string

Data type

System.String

Maximum string length

1048576

specimen

0..1

Reference(SpecimenEu)

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

When the specimen is applicable and known it shall be documented

Data type

Reference(SpecimenEu)

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())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
sct-concept: < 123038009 |Specimen|
v2: SPM segment
rim: participation[typeCode=SPC].specimen
sct-attr: 704319004 |Inherent in|

device

0..1

Reference(Device | DeviceMetric)

There are no (further) constraints on this element

Element id

Observation.device

Short description

Measuring instrument

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

Reference(Device | DeviceMetric)

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())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
sct-concept: < 49062001 |Device|
v2: OBX-17 / PRT -10
rim: participation[typeCode=DEV]
sct-attr: 424226004 |Using device|

referenceRange

0..*

BackboneElement

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

BackboneElement

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())
obs-3: Must have at least a low or a high or text
low.exists() or high.exists() or text.exists()

Mappings

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

0..1

string

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

string

Mappings

rim: n/a

extension

0..*

Extension

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

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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..*

Extension

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

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

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

low

0..1

SimpleQuantity

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

Comments

The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.

Data type

SimpleQuantity

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
qty-3: If a code for the unit is present, the system SHALL also be present
code.empty() or system.exists()
sqty-1: The comparator is not used on a SimpleQuantity
comparator.empty()

Mappings

rim: n/a
v2: SN (see also Range) or CQ
rim: PQ, IVL<PQ>, MO, CO, depending on the values
v2: OBX-7
rim: value:IVL_PQ.low

high

0..1

SimpleQuantity

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

Comments

The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.

Data type

SimpleQuantity

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
qty-3: If a code for the unit is present, the system SHALL also be present
code.empty() or system.exists()
sqty-1: The comparator is not used on a SimpleQuantity
comparator.empty()

Mappings

rim: n/a
v2: SN (see also Range) or CQ
rim: PQ, IVL<PQ>, MO, CO, depending on the values
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

CodeableConcept

Binding

Code for the meaning of a reference range.

ObservationReferenceRangeMeaningCodes (preferred)

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: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
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..*

CodeableConcept

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

CodeableConcept

Binding

Codes identifying the population the reference range applies to.

ObservationReferenceRangeAppliesToCodes (example)

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: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
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

Range

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.

Comments

The stated low and high value are assumed to have arbitrarily high precision when it comes to determining which values are in the range. I.e. 1.99 is not in the range 2 -> 3.

Data type

Range

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())
rng-2: If present, low SHALL have a lower value than high
low.empty() or high.empty() or (low <= high)

Mappings

rim: n/a
v2: NR and also possibly SN (but see also quantity)
rim: IVL<QTY[not(type="TS")]> [lowClosed="true" and highClosed="true"]or URG<QTY[not(type="TS")]>
rim: outboundRelationship[typeCode=PRCN].targetObservationCriterion[code="age"].value

text

0..1

string

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

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

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: OBX-7
rim: value:ST

hasMember

Σ C

0..*

Reference(ObservationResultsLaboratoryEu)

There are no (further) constraints on this element

Element id

Observation.hasMember

Short description

Related resource that belongs to the Observation group

Definition

A reference to another Observation profiled by Observation-results-laboratory-uv-ips. The target observation (for instance an individual test member of a panel) is considered as a sub-observation of the current one, which plays the role of a grouper.

Comments

This element is used in the context of international patient summary when there is a need to group a collection of observations, because they belong to the same panel, or because they share a common interpretation comment, or a common media attachment (illustrative image or graph). In these cases, the current observation is the grouper, and its set of sub-observations are related observations using the type "has-member". For a discussion on the ways Observations can be assembled in groups together see Observation Grouping.

Data type

Reference(ObservationResultsLaboratoryEu)

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())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: Relationships established by OBX-4 usage
rim: outBoundRelationship

derivedFrom

Σ C

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

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())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: Relationships established by OBX-4 usage
rim: .targetObservation

component

0..*

BackboneElement

There are no (further) constraints on this element

Element id

Observation.component

Short description

Laboratory result

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

BackboneElement

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: containment by OBX-4?
rim: outBoundRelationship[typeCode=COMP]

0..1

string

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

string

Mappings

rim: n/a

extension

0..*

Extension

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

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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..*

Extension

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

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

code

1..1

CodeableConceptIPSBinding

There are no (further) constraints on this element

Element id

Observation.component.code

Short description

Concept - reference to a terminology or just text

Definition

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

Requirements

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

Comments

Data type

CodeableConceptIPS

Binding

Codes identifying names of simple observations.

ResultsLaboratoryPathologyObservationUvIps (preferred)

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: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
w5: FiveWs.what[x]
sct-concept: < 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|
v2: OBX-3
rim: code

0..1

string

There are no (further) constraints on this element

Element id

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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.component.code.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

coding

SO Σ

0..*

CodingIPS

There are no (further) constraints on this element

Element id

Observation.component.code.coding

Short description

A reference to a 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.

Data type

CodingIPS

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: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.code.coding.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.component.code.coding.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

system

SO Σ

0..1

uri

There are no (further) constraints on this element

Element id

Observation.component.code.coding.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

uri

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: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

version

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.code.coding.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

string

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: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

SO Σ

0..1

code

There are no (further) constraints on this element

Element id

Observation.component.code.coding.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

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: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

display

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.code.coding.display

Short description

Text representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

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: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.code.coding.display.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.component.code.coding.display.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

translation

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.component.code.coding.display.extension:translation

Short description

Language Translation (Localization)

Alternate names

extensions, user content

Definition

Language translation from base language of resource to another language.

Comments

Data type

Extension

Extension URL

http://hl7.org/fhir/StructureDefinition/translation|5.3.0-ballot-tc1

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
rim: ST.translation

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.code.coding.display.extension:translation.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

string

Mappings

rim: n/a

extension

2..*

Extension

There are no (further) constraints on this element

Element id

Observation.component.code.coding.display.extension:translation.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

lang

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.component.code.coding.display.extension:translation.extension:lang

Short description

Code for Language

Alternate names

extensions, user content

Definition

Code for Language.

Comments

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.code.coding.display.extension:translation.extension:lang.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.component.code.coding.display.extension:translation.extension:lang.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.component.code.coding.display.extension:translation.extension:lang.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

lang

Mappings

rim: N/A

value[x]

1..1

Binding

There are no (further) constraints on this element

Element id

Observation.component.code.coding.display.extension:translation.extension:lang.value[x]

Short description

Value of extension

Definition

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

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

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
rim: N/A

valueCode

code

There are no (further) constraints on this element

Data type

code

content

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.component.code.coding.display.extension:translation.extension:content

Short description

Content in other Language

Alternate names

extensions, user content

Definition

Content in other Language.

Comments

The type (string or markdown) must match the context in which it is used.

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.code.coding.display.extension:translation.extension:content.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.component.code.coding.display.extension:translation.extension:content.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.component.code.coding.display.extension:translation.extension:content.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

content

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Observation.component.code.coding.display.extension:translation.extension:content.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

valueMarkdown

markdown

There are no (further) constraints on this element

Data type

markdown

valueString

string

There are no (further) constraints on this element

Data type

string

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.component.code.coding.display.extension:translation.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

http://hl7.org/fhir/StructureDefinition/translation

Mappings

rim: N/A

value[x]

0..0

There are no (further) constraints on this element

Element id

Observation.component.code.coding.display.extension:translation.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

value

0..1

System.String

There are no (further) constraints on this element

Element id

Observation.component.code.coding.display.value

Short description

Primitive value for string

Definition

Primitive value for string

Data type

System.String

Maximum string length

1048576

userSelected

0..1

boolean

There are no (further) constraints on this element

Element id

Observation.component.code.coding.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

boolean

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: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

text

SO Σ

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.code.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

Comments

Very often the text is the same as a displayName of one of the codings.

Data type

string

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

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.code.text.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.component.code.text.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

translation

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.component.code.text.extension:translation

Short description

Language Translation (Localization)

Alternate names

extensions, user content

Definition

Language translation from base language of resource to another language.

Comments

Data type

Extension

Extension URL

http://hl7.org/fhir/StructureDefinition/translation|5.3.0-ballot-tc1

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
rim: ST.translation

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.code.text.extension:translation.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

string

Mappings

rim: n/a

extension

2..*

Extension

There are no (further) constraints on this element

Element id

Observation.component.code.text.extension:translation.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

lang

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.component.code.text.extension:translation.extension:lang

Short description

Code for Language

Alternate names

extensions, user content

Definition

Code for Language.

Comments

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.code.text.extension:translation.extension:lang.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.component.code.text.extension:translation.extension:lang.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.component.code.text.extension:translation.extension:lang.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

lang

Mappings

rim: N/A

value[x]

1..1

Binding

There are no (further) constraints on this element

Element id

Observation.component.code.text.extension:translation.extension:lang.value[x]

Short description

Value of extension

Definition

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

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

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
rim: N/A

valueCode

code

There are no (further) constraints on this element

Data type

code

content

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.component.code.text.extension:translation.extension:content

Short description

Content in other Language

Alternate names

extensions, user content

Definition

Content in other Language.

Comments

The type (string or markdown) must match the context in which it is used.

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.code.text.extension:translation.extension:content.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.component.code.text.extension:translation.extension:content.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.component.code.text.extension:translation.extension:content.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

content

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Observation.component.code.text.extension:translation.extension:content.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

valueMarkdown

markdown

There are no (further) constraints on this element

Data type

markdown

valueString

string

There are no (further) constraints on this element

Data type

string

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.component.code.text.extension:translation.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

http://hl7.org/fhir/StructureDefinition/translation

Mappings

rim: N/A

value[x]

0..0

There are no (further) constraints on this element

Element id

Observation.component.code.text.extension:translation.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

value

0..1

System.String

There are no (further) constraints on this element

Element id

Observation.component.code.text.value

Short description

Primitive value for string

Definition

Primitive value for string

Data type

System.String

Maximum string length

1048576

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.

Slicing

Unordered, Closed, by $this(Type)

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

valueBoolean

boolean

There are no (further) constraints on this element

Data type

boolean

valueInteger

integer

There are no (further) constraints on this element

Data type

integer

valueSampledData

SampledData

There are no (further) constraints on this element

Data type

SampledData

valueString

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueString

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

string

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

valueRange

Σ C

0..1

RangeEuLab

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueRange

Short description

A measured range using UCUM

Definition

A measured range (or a range that can potentially be measured) and uncertainty of the measurement. This profile imposes that the code system for units be UCUM.

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

The stated low and high value are assumed to have arbitrarily high precision when it comes to determining which values are in the range. I.e. 1.99 is not in the range 2 -> 3.

Data type

RangeEuLab

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())
rng-2: If present, low SHALL have a lower value than high
low.empty() or high.empty() or (low <= high)

Mappings

rim: n/a
sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|
v2: NR and also possibly SN (but see also quantity)
rim: IVL<QTY[not(type="TS")]> [lowClosed="true" and highClosed="true"]or URG<QTY[not(type="TS")]>

valueRatio

Σ C

0..1

RatioEuLab

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueRatio

Short description

A measured ratio using UCUM

Definition

A measured ratio (or a ratio that can potentially be measured) and uncertainty of the measurement. This profile imposes that the code system for units be UCUM.

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

RatioEuLab

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())
rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present
(numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists())

Mappings

rim: n/a
sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|
v2: N/A
rim: RTO

valueTime

0..1

time

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueTime

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

time

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

valueDateTime

0..1

dateTime

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueDateTime

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

dateTime

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

valuePeriod

0..1

Period

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valuePeriod

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

Period

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

valueQuantity

Σ C

0..1

QuantityEuLab

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueQuantity

Short description

A measured amount using UCUM

Definition

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

The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.

Data type

QuantityEuLab

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())
qty-3: If a code for the unit is present, the system SHALL also be present
code.empty() or system.exists()

Mappings

rim: n/a
sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|
v2: SN (see also Range) or CQ
rim: PQ, IVL<PQ>, MO, CO, depending on the values

valueCodeableConcept

0..1

CodeableConceptIPSBinding

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept

Short description

Concept - reference to a terminology or just text

Definition

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

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

CodeableConceptIPS

Binding

ResultsCodedValuesLaboratoryPathologyUvIps (preferred)

Additional bindings

http://hl7.org/fhir/uv/ips/ValueSet/results-blood-group-snomed-ct-ips-free-set (candidate)
Additional conformance binding to a blood group findings value set for laboratory result values from the SNOMED CT IPS free set for use globally (in SNOMED member and non-member jurisdictions).
http://hl7.org/fhir/uv/ips/ValueSet/results-presence-absence-snomed-ct-ips-free-set (candidate)
Additional conformance binding to a presence and absence findings (qualifier values) value set for laboratory result values from the SNOMED CT IPS free set for use globally (in SNOMED member and non-member jurisdictions).
http://hl7.org/fhir/uv/ips/ValueSet/results-microorganism-snomed-ct-ips-free-set (candidate)
Additional conformance binding to a microorganisms value set for laboratory result values from the SNOMED CT IPS free set for use globally (in SNOMED member and non-member jurisdictions).

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
sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

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

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

coding

SO Σ

0..*

CodingIPS

There are no (further) constraints on this element

Element id

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

Short description

A reference to a 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.

Data type

CodingIPS

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: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

system

SO Σ

0..1

uri

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

uri

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: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

version

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

string

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: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

SO Σ

0..1

code

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

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: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

display

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.display

Short description

Text representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

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: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.display.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.display.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

translation

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.display.extension:translation

Short description

Language Translation (Localization)

Alternate names

extensions, user content

Definition

Language translation from base language of resource to another language.

Comments

Data type

Extension

Extension URL

http://hl7.org/fhir/StructureDefinition/translation|5.3.0-ballot-tc1

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
rim: ST.translation

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.display.extension:translation.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

string

Mappings

rim: n/a

extension

2..*

Extension

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.display.extension:translation.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

lang

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.display.extension:translation.extension:lang

Short description

Code for Language

Alternate names

extensions, user content

Definition

Code for Language.

Comments

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.display.extension:translation.extension:lang.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.display.extension:translation.extension:lang.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.display.extension:translation.extension:lang.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

lang

Mappings

rim: N/A

value[x]

1..1

Binding

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.display.extension:translation.extension:lang.value[x]

Short description

Value of extension

Definition

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

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

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
rim: N/A

valueCode

code

There are no (further) constraints on this element

Data type

code

content

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.display.extension:translation.extension:content

Short description

Content in other Language

Alternate names

extensions, user content

Definition

Content in other Language.

Comments

The type (string or markdown) must match the context in which it is used.

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.display.extension:translation.extension:content.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.display.extension:translation.extension:content.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.display.extension:translation.extension:content.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

content

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.display.extension:translation.extension:content.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

valueMarkdown

markdown

There are no (further) constraints on this element

Data type

markdown

valueString

string

There are no (further) constraints on this element

Data type

string

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.display.extension:translation.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

http://hl7.org/fhir/StructureDefinition/translation

Mappings

rim: N/A

value[x]

0..0

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.display.extension:translation.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

value

0..1

System.String

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.display.value

Short description

Primitive value for string

Definition

Primitive value for string

Data type

System.String

Maximum string length

1048576

userSelected

0..1

boolean

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

boolean

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: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

text

SO Σ

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.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

Comments

Very often the text is the same as a displayName of one of the codings.

Data type

string

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

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.text.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.text.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

translation

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.text.extension:translation

Short description

Language Translation (Localization)

Alternate names

extensions, user content

Definition

Language translation from base language of resource to another language.

Comments

Data type

Extension

Extension URL

http://hl7.org/fhir/StructureDefinition/translation|5.3.0-ballot-tc1

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
rim: ST.translation

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.text.extension:translation.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

string

Mappings

rim: n/a

extension

2..*

Extension

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.text.extension:translation.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

lang

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.text.extension:translation.extension:lang

Short description

Code for Language

Alternate names

extensions, user content

Definition

Code for Language.

Comments

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.text.extension:translation.extension:lang.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.text.extension:translation.extension:lang.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.text.extension:translation.extension:lang.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

lang

Mappings

rim: N/A

value[x]

1..1

Binding

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.text.extension:translation.extension:lang.value[x]

Short description

Value of extension

Definition

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

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

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
rim: N/A

valueCode

code

There are no (further) constraints on this element

Data type

code

content

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.text.extension:translation.extension:content

Short description

Content in other Language

Alternate names

extensions, user content

Definition

Content in other Language.

Comments

The type (string or markdown) must match the context in which it is used.

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.text.extension:translation.extension:content.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.text.extension:translation.extension:content.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.text.extension:translation.extension:content.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

content

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.text.extension:translation.extension:content.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

valueMarkdown

markdown

There are no (further) constraints on this element

Data type

markdown

valueString

string

There are no (further) constraints on this element

Data type

string

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.text.extension:translation.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

http://hl7.org/fhir/StructureDefinition/translation

Mappings

rim: N/A

value[x]

0..0

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.text.extension:translation.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

value

0..1

System.String

There are no (further) constraints on this element

Element id

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

Short description

Primitive value for string

Definition

Primitive value for string

Data type

System.String

Maximum string length

1048576

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

CodeableConcept

Binding

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

DataAbsentReason (extensible)

Conditions

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

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
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

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

CodeableConcept

Binding

Codes identifying interpretations of observations.

ObservationInterpretationCodes (extensible)

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: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
sct-concept: < 260245000 |Findings values|
v2: OBX-8
rim: interpretationCode
sct-attr: 363713009 |Has interpretation|

referenceRange

0..*

see (referenceRange)

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

Mappings

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

EnglandObservationLabPathology (Observation)

ObservationResultsLaboratoryEu

There are no (further) constraints on this element

Element id

Observation

Short description

Laboratory result for a simple test or for a panel/study

Alternate names

Vital Signs, Measurement, Results, Tests

Definition

Comments

Represents either a lab simple observation or the group of observations produced by a laboratory study.

Data type

ObservationResultsLaboratoryEu

Constraints

dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.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-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-6: A resource should have narrative for robust management
text.`div`.exists()
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.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()
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
dataAbsentReason.empty() or value.empty()
eu-lab-1: If observation status is other then "registered" or "cancelled", at least one of these Observation elements shall be provided: "value", "dataAbsentReason", "hasMember" or "component"
(status in ('registered'|'cancelled')) or value.exists() or hasMember.exists() or component.exists() or dataAbsentReason.exists()
eu-lab-2: If observation has components and observation status is other then "registered" or "cancelled", at least one of these Observation.component elements shall be provided: "value" or "dataAbsentReason"
component.exists() implies (status in ('registered'|'cancelled')) or component.value.exists() or component.dataAbsentReason.exists()

Mappings

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

0..1

string

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

string

Meta

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

Meta

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
rim: N/A

implicitRules

Σ ?!

0..1

uri

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

uri

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

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

code

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

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

text

0..1

Narrative

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

Narrative

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
rim: N/A
rim: Act.text?

contained

0..*

Resource

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

Resource

Mappings

rim: Entity. Role, or Act
rim: N/A

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.extension

Short description

Laboratory Test Kit

Alternate names

extensions, user content

Definition

The laboratory test kit used for this test.

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

supportingInfo

0..*

Extension(Reference(Resource))

There are no (further) constraints on this element

Element id

Observation.extension:supportingInfo

Short description

Other information that may be relevant to this event.

Alternate names

extensions, user content

Definition

Comments

Data type

Extension(Reference(Resource))

Extension URL

http://hl7.org/fhir/StructureDefinition/workflow-supportingInfo

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

triggeredBy-r5

0..*

Extension(Complex)

There are no (further) constraints on this element

Element id

Observation.extension:triggeredBy-r5

Short description

Triggering observation(s)

Alternate names

extensions, user content

Definition

Identifies the observation(s) that triggered the performance of this observation.

Comments

Data type

Extension(Complex)

Extension URL

http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.extension:triggeredBy-r5.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

string

Mappings

rim: n/a

extension

2..*

Extension

There are no (further) constraints on this element

Element id

Observation.extension:triggeredBy-r5.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

observation

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.extension:triggeredBy-r5.extension:observation

Short description

Triggering observation.

Alternate names

extensions, user content

Definition

Reference to the triggering observation.

Comments

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.extension:triggeredBy-r5.extension:observation.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.extension:triggeredBy-r5.extension:observation.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.extension:triggeredBy-r5.extension:observation.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

observation

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Observation.extension:triggeredBy-r5.extension:observation.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

valueReference

Reference(Observation)

There are no (further) constraints on this element

Data type

Reference(Observation)

type

1..1

ExtensionBinding

There are no (further) constraints on this element

Element id

Observation.extension:triggeredBy-r5.extension:type

Short description

The type of trigger

Alternate names

extensions, user content

Definition

The type of trigger. Reflex | Repeat | Re-run.

Comments

Data type

Extension

Binding

http://hl7.org/fhir/ValueSet/observation-triggeredbytype (required)

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.extension:triggeredBy-r5.extension: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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.extension:triggeredBy-r5.extension:type.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.extension:triggeredBy-r5.extension:type.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

type

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Observation.extension:triggeredBy-r5.extension:type.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

valueCode

code

There are no (further) constraints on this element

Data type

code

reason

0..1

Extension

There are no (further) constraints on this element

Element id

Observation.extension:triggeredBy-r5.extension:reason

Short description

Reason that the observation was triggered

Alternate names

extensions, user content

Definition

Provides the reason why this observation was performed as a result of the observation(s) referenced.

Comments

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.extension:triggeredBy-r5.extension:reason.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.extension:triggeredBy-r5.extension:reason.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.extension:triggeredBy-r5.extension:reason.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

reason

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Observation.extension:triggeredBy-r5.extension:reason.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

valueString

string

There are no (further) constraints on this element

Data type

string

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.extension:triggeredBy-r5.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy

Mappings

rim: N/A

value[x]

0..0

There are no (further) constraints on this element

Element id

Observation.extension:triggeredBy-r5.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

certifiedRefMaterialCodeable

0..*

Extension(CodeableConcept)

There are no (further) constraints on this element

Element id

Observation.extension:certifiedRefMaterialCodeable

Short description

Certified Reference Material: CodeableConcept

Alternate names

extensions, user content

Definition

Comments

Data type

Extension(CodeableConcept)

Extension URL

http://hl7.eu/fhir/laboratory/StructureDefinition/observation-certifiedRefMaterialCodeable

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

certifiedRefMaterialIdentifer

0..*

Extension(Identifier)

There are no (further) constraints on this element

Element id

Observation.extension:certifiedRefMaterialIdentifer

Short description

Certified Reference Material: Identifier

Alternate names

extensions, user content

Definition

Comments

Data type

Extension(Identifier)

Extension URL

http://hl7.eu/fhir/laboratory/StructureDefinition/observation-certifiedRefMaterialIdentifer

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

labTestKit

0..*

Extension(Reference(Device))

There are no (further) constraints on this element

Element id

Observation.extension:labTestKit

Short description

Device Laboratory Test Kit

Alternate names

extensions, user content

Definition

This extension links this observation with the laboratory test kit used for this test. Usually only one laboratory test kit is referred

Comments

Data type

Extension(Reference(Device))

Extension URL

http://hl7.eu/fhir/laboratory/StructureDefinition/observation-deviceLabTestKit

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

extensionorganizer-r6

0..1

Extension(boolean)

Element id

Observation.extension:extensionorganizer-r6

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

Data type

Extension(boolean)

Extension URL

http://hl7.org/fhir/6.0/StructureDefinition/extension-Observation.organizer

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

Extension

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

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

identifier

0..*

Identifier

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

Identifier

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: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
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

Σ C

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.

Comments

Data type

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())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Event.basedOn
v2: ORC
rim: .inboundRelationship[typeCode=COMP].source[moodCode=EVN]

partOf

Σ C

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

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())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
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

Status of this observation (e.g. preliminary, final,...)

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

code

Binding

Codes providing the status of an observation.

ObservationStatus (required)

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

CodeableConceptIPSBinding

There are no (further) constraints on this element

Element id

Observation.category

Short description

Concept - reference to a terminology or just text

Definition

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

Requirements

Used for filtering what observations are retrieved and displayed.

Comments

"laboratory" includes laboratory medicine and pathology

Data type

CodeableConceptIPS

Slicing

Unordered, Open, by $this(Pattern)

Binding

Codes for high level observation categories.

ObservationCategoryCodes (preferred)

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: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
w5: FiveWs.class
rim: .outboundRelationship[typeCode="COMP].target[classCode="LIST", moodCode="EVN"].code

(All Slices)

The requirements in this element apply to all slices

0..1

string

There are no (further) constraints on this element

Element id

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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.category.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

coding

SO Σ

0..*

CodingIPS

There are no (further) constraints on this element

Element id

Observation.category.coding

Short description

A reference to a 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.

Data type

CodingIPS

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: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

0..1

string

There are no (further) constraints on this element

Element id

Observation.category.coding.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.category.coding.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

system

SO Σ

0..1

uri

There are no (further) constraints on this element

Element id

Observation.category.coding.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

uri

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: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

version

0..1

string

There are no (further) constraints on this element

Element id

Observation.category.coding.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

string

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: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

SO Σ

0..1

code

There are no (further) constraints on this element

Element id

Observation.category.coding.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

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: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

display

0..1

string

There are no (further) constraints on this element

Element id

Observation.category.coding.display

Short description

Text representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

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: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

0..1

string

There are no (further) constraints on this element

Element id

Observation.category.coding.display.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.category.coding.display.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

translation

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.category.coding.display.extension:translation

Short description

Language Translation (Localization)

Alternate names

extensions, user content

Definition

Language translation from base language of resource to another language.

Comments

Data type

Extension

Extension URL

http://hl7.org/fhir/StructureDefinition/translation|5.3.0-ballot-tc1

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
rim: ST.translation

0..1

string

There are no (further) constraints on this element

Element id

Observation.category.coding.display.extension:translation.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

string

Mappings

rim: n/a

extension

2..*

Extension

There are no (further) constraints on this element

Element id

Observation.category.coding.display.extension:translation.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

lang

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.category.coding.display.extension:translation.extension:lang

Short description

Code for Language

Alternate names

extensions, user content

Definition

Code for Language.

Comments

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.category.coding.display.extension:translation.extension:lang.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.category.coding.display.extension:translation.extension:lang.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.category.coding.display.extension:translation.extension:lang.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

lang

Mappings

rim: N/A

value[x]

1..1

Binding

There are no (further) constraints on this element

Element id

Observation.category.coding.display.extension:translation.extension:lang.value[x]

Short description

Value of extension

Definition

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

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

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
rim: N/A

valueCode

code

There are no (further) constraints on this element

Data type

code

content

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.category.coding.display.extension:translation.extension:content

Short description

Content in other Language

Alternate names

extensions, user content

Definition

Content in other Language.

Comments

The type (string or markdown) must match the context in which it is used.

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.category.coding.display.extension:translation.extension:content.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.category.coding.display.extension:translation.extension:content.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.category.coding.display.extension:translation.extension:content.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

content

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Observation.category.coding.display.extension:translation.extension:content.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

valueMarkdown

markdown

There are no (further) constraints on this element

Data type

markdown

valueString

string

There are no (further) constraints on this element

Data type

string

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.category.coding.display.extension:translation.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

http://hl7.org/fhir/StructureDefinition/translation

Mappings

rim: N/A

value[x]

0..0

There are no (further) constraints on this element

Element id

Observation.category.coding.display.extension:translation.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

value

0..1

System.String

There are no (further) constraints on this element

Element id

Observation.category.coding.display.value

Short description

Primitive value for string

Definition

Primitive value for string

Data type

System.String

Maximum string length

1048576

userSelected

0..1

boolean

There are no (further) constraints on this element

Element id

Observation.category.coding.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

boolean

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: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

text

SO Σ

0..1

string

There are no (further) constraints on this element

Element id

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

Comments

Very often the text is the same as a displayName of one of the codings.

Data type

string

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

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

0..1

string

There are no (further) constraints on this element

Element id

Observation.category.text.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.category.text.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

translation

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.category.text.extension:translation

Short description

Language Translation (Localization)

Alternate names

extensions, user content

Definition

Language translation from base language of resource to another language.

Comments

Data type

Extension

Extension URL

http://hl7.org/fhir/StructureDefinition/translation|5.3.0-ballot-tc1

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
rim: ST.translation

0..1

string

There are no (further) constraints on this element

Element id

Observation.category.text.extension:translation.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

string

Mappings

rim: n/a

extension

2..*

Extension

There are no (further) constraints on this element

Element id

Observation.category.text.extension:translation.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

lang

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.category.text.extension:translation.extension:lang

Short description

Code for Language

Alternate names

extensions, user content

Definition

Code for Language.

Comments

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.category.text.extension:translation.extension:lang.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.category.text.extension:translation.extension:lang.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.category.text.extension:translation.extension:lang.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

lang

Mappings

rim: N/A

value[x]

1..1

Binding

There are no (further) constraints on this element

Element id

Observation.category.text.extension:translation.extension:lang.value[x]

Short description

Value of extension

Definition

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

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

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
rim: N/A

valueCode

code

There are no (further) constraints on this element

Data type

code

content

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.category.text.extension:translation.extension:content

Short description

Content in other Language

Alternate names

extensions, user content

Definition

Content in other Language.

Comments

The type (string or markdown) must match the context in which it is used.

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.category.text.extension:translation.extension:content.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.category.text.extension:translation.extension:content.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.category.text.extension:translation.extension:content.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

content

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Observation.category.text.extension:translation.extension:content.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

valueMarkdown

markdown

There are no (further) constraints on this element

Data type

markdown

valueString

string

There are no (further) constraints on this element

Data type

string

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.category.text.extension:translation.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

http://hl7.org/fhir/StructureDefinition/translation

Mappings

rim: N/A

value[x]

0..0

There are no (further) constraints on this element

Element id

Observation.category.text.extension:translation.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

value

0..1

System.String

There are no (further) constraints on this element

Element id

Observation.category.text.value

Short description

Primitive value for string

Definition

Primitive value for string

Data type

System.String

Maximum string length

1048576

laboratory

1..1

CodeableConceptBindingPattern

There are no (further) constraints on this element

Element id

Observation.category:laboratory

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

CodeableConcept

Binding

Codes for high level observation categories.

ObservationCategoryCodes (preferred)

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

Pattern

{
  "coding": [
    {
      "system": "http://terminology.hl7.org/CodeSystem/observation-category",
      "code": "laboratory"
    }
  ]
}

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
w5: FiveWs.class
rim: .outboundRelationship[typeCode="COMP].target[classCode="LIST", moodCode="EVN"].code

studyType

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.category:studyType

Short description

The way of grouping of the test results into clinically meaningful domains (e.g. hematology study, microbiology study, etc.)

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

CodeableConcept

Binding

Codes for high level observation categories.

LabStudyTypesEuVs (required)

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: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
w5: FiveWs.class
rim: .outboundRelationship[typeCode="COMP].target[classCode="LIST", moodCode="EVN"].code

specialty

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.category:specialty

Short description

The clinical domain of the laboratory performing the observation (e.g. microbiology, toxicology, chemistry)

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

CodeableConcept

Binding

Codes for high level observation categories.

LabSpecialtyEuVs (required)

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: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
w5: FiveWs.class
rim: .outboundRelationship[typeCode="COMP].target[classCode="LIST", moodCode="EVN"].code

code

1..1

CodeableConceptIPSBinding

There are no (further) constraints on this element

Element id

Observation.code

Short description

Concept - reference to a terminology or just text

Alternate names

Name

Definition

Requirements

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

Comments

Data type

CodeableConceptIPS

Binding

Codes identifying names of simple observations.

LaboratoryResultStandardEuVs (preferred)

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: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
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|

0..1

string

There are no (further) constraints on this element

Element id

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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.code.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

coding

SO Σ

0..*

CodingIPS

Element id

Observation.code.coding

Short description

A reference to a 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.

Data type

CodingIPS

Slicing

Unordered, Open, by

Slicing for Pathology to differentiate between the SNOMED CT ValueSets, PaLM and PCBL

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: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

(All Slices)

The requirements in this element apply to all slices

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.coding.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

reference

0..1

Extension(uri)

Element id

Observation.code.coding.extension:reference

Short description

Url of Value set the code was chosen from

Alternate names

extensions, user content

Definition

A logical reference (e.g. a reference to ValueSet.url) that identifies the value set/version that identifies the set of possible coded values this coding was chosen from or constrained by.

Comments

If this extension is used with an extensible binding, and the concept comes from outside the bound valueset, the value set SHALL be different from the bound valueset.

Data type

Extension(uri)

Extension URL

http://hl7.org/fhir/StructureDefinition/valueset-reference

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
v2: CWE.
rim: CD.valueSet/CD.valueSetVersion

system

SO Σ

0..1

uri

There are no (further) constraints on this element

Element id

Observation.code.coding.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

uri

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: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

version

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.coding.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

string

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: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

SO Σ

0..1

code

There are no (further) constraints on this element

Element id

Observation.code.coding.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

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: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

display

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.coding.display

Short description

Text representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

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: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.coding.display.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding.display.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

translation

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding.display.extension:translation

Short description

Language Translation (Localization)

Alternate names

extensions, user content

Definition

Language translation from base language of resource to another language.

Comments

Data type

Extension

Extension URL

http://hl7.org/fhir/StructureDefinition/translation|5.3.0-ballot-tc1

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
rim: ST.translation

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.coding.display.extension:translation.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

string

Mappings

rim: n/a

extension

2..*

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding.display.extension:translation.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

lang

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding.display.extension:translation.extension:lang

Short description

Code for Language

Alternate names

extensions, user content

Definition

Code for Language.

Comments

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.coding.display.extension:translation.extension:lang.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding.display.extension:translation.extension:lang.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.code.coding.display.extension:translation.extension:lang.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

lang

Mappings

rim: N/A

value[x]

1..1

Binding

There are no (further) constraints on this element

Element id

Observation.code.coding.display.extension:translation.extension:lang.value[x]

Short description

Value of extension

Definition

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

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

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
rim: N/A

valueCode

code

There are no (further) constraints on this element

Data type

code

content

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding.display.extension:translation.extension:content

Short description

Content in other Language

Alternate names

extensions, user content

Definition

Content in other Language.

Comments

The type (string or markdown) must match the context in which it is used.

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.coding.display.extension:translation.extension:content.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding.display.extension:translation.extension:content.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.code.coding.display.extension:translation.extension:content.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

content

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Observation.code.coding.display.extension:translation.extension:content.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

valueMarkdown

markdown

There are no (further) constraints on this element

Data type

markdown

valueString

string

There are no (further) constraints on this element

Data type

string

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.code.coding.display.extension:translation.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

http://hl7.org/fhir/StructureDefinition/translation

Mappings

rim: N/A

value[x]

0..0

There are no (further) constraints on this element

Element id

Observation.code.coding.display.extension:translation.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

value

0..1

System.String

There are no (further) constraints on this element

Element id

Observation.code.coding.display.value

Short description

Primitive value for string

Definition

Primitive value for string

Data type

System.String

Maximum string length

1048576

userSelected

0..1

boolean

There are no (further) constraints on this element

Element id

Observation.code.coding.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

boolean

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: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

pathology-PaLM

SO Σ

0..*

CodingIPSBinding

Element id

Observation.code.coding:pathology-PaLM

Short description

A reference to a 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.

Data type

CodingIPS

Binding

This slice is to denote the code comes from the Pathology and laboratory medicine observable entity simple reference set

EnglandPathologyAndLaboratoryMedicineObservables (extensible)

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: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

reference-palm-observables

0..1

Extension(uri)

Element id

Observation.code.coding:pathology-PaLM.extension:reference-palm-observables

Short description

Url of Value set the code was chosen from

Alternate names

extensions, user content

Definition

A logical reference (e.g. a reference to ValueSet.url) that identifies the value set/version that identifies the set of possible coded values this coding was chosen from or constrained by.

Comments

If this extension is used with an extensible binding, and the concept comes from outside the bound valueset, the value set SHALL be different from the bound valueset.

Data type

Extension(uri)

Extension URL

http://hl7.org/fhir/StructureDefinition/valueset-reference

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
v2: CWE.
rim: CD.valueSet/CD.valueSetVersion

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.extension:reference-palm-observables.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.extension:reference-palm-observables.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.extension:reference-palm-observables.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

http://hl7.org/fhir/StructureDefinition/valueset-reference

Mappings

rim: N/A

value[x]

1..1

Fixed Value

Element id

Observation.code.coding:pathology-PaLM.extension:reference-palm-observables.value[x]

Short description

Value of extension

Definition

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

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

Fixed value

https://fhir.nhs.uk/England/ValueSet/England-PathologyAndLaboratoryMedicineObservables

Mappings

rim: n/a
rim: N/A

valueUri

uri

There are no (further) constraints on this element

Data type

uri

system

SO Σ

0..1

uri

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

uri

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: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

version

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

string

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: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

SO Σ

0..1

code

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

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: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

display

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.display

Short description

Text representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

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: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.display.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.display.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

translation

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.display.extension:translation

Short description

Language Translation (Localization)

Alternate names

extensions, user content

Definition

Language translation from base language of resource to another language.

Comments

Data type

Extension

Extension URL

http://hl7.org/fhir/StructureDefinition/translation|5.3.0-ballot-tc1

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
rim: ST.translation

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.display.extension:translation.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

string

Mappings

rim: n/a

extension

2..*

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.display.extension:translation.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

lang

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.display.extension:translation.extension:lang

Short description

Code for Language

Alternate names

extensions, user content

Definition

Code for Language.

Comments

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.display.extension:translation.extension:lang.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.display.extension:translation.extension:lang.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.display.extension:translation.extension:lang.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

lang

Mappings

rim: N/A

value[x]

1..1

Binding

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.display.extension:translation.extension:lang.value[x]

Short description

Value of extension

Definition

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

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

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
rim: N/A

valueCode

code

There are no (further) constraints on this element

Data type

code

content

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.display.extension:translation.extension:content

Short description

Content in other Language

Alternate names

extensions, user content

Definition

Content in other Language.

Comments

The type (string or markdown) must match the context in which it is used.

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.display.extension:translation.extension:content.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.display.extension:translation.extension:content.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.display.extension:translation.extension:content.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

content

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.display.extension:translation.extension:content.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

valueMarkdown

markdown

There are no (further) constraints on this element

Data type

markdown

valueString

string

There are no (further) constraints on this element

Data type

string

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.display.extension:translation.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

http://hl7.org/fhir/StructureDefinition/translation

Mappings

rim: N/A

value[x]

0..0

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.display.extension:translation.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

value

0..1

System.String

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.display.value

Short description

Primitive value for string

Definition

Primitive value for string

Data type

System.String

Maximum string length

1048576

userSelected

0..1

boolean

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

boolean

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: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

pathology-PBCL

SO Σ

0..*

CodingIPSBinding

Element id

Observation.code.coding:pathology-PBCL

Short description

A reference to a 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.

Data type

CodingIPS

Binding

This slice is to denote the code comes from the Pathology Bounded Code List observables simple reference set

EnglandPathologyBoundedCodeListObservables (extensible)

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: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

reference-pbcl-observables

0..1

Extension(uri)

Element id

Observation.code.coding:pathology-PBCL.extension:reference-pbcl-observables

Short description

Url of Value set the code was chosen from

Alternate names

extensions, user content

Definition

A logical reference (e.g. a reference to ValueSet.url) that identifies the value set/version that identifies the set of possible coded values this coding was chosen from or constrained by.

Comments

If this extension is used with an extensible binding, and the concept comes from outside the bound valueset, the value set SHALL be different from the bound valueset.

Data type

Extension(uri)

Extension URL

http://hl7.org/fhir/StructureDefinition/valueset-reference

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
v2: CWE.
rim: CD.valueSet/CD.valueSetVersion

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.extension:reference-pbcl-observables.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.extension:reference-pbcl-observables.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.extension:reference-pbcl-observables.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

http://hl7.org/fhir/StructureDefinition/valueset-reference

Mappings

rim: N/A

value[x]

1..1

Fixed Value

Element id

Observation.code.coding:pathology-PBCL.extension:reference-pbcl-observables.value[x]

Short description

Value of extension

Definition

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

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

Fixed value

https://fhir.nhs.uk/England/ValueSet/England-PathologyBoundedCodeListObservables

Mappings

rim: n/a
rim: N/A

valueUri

uri

There are no (further) constraints on this element

Data type

uri

system

SO Σ

0..1

uri

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

uri

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: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

version

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

string

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: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

SO Σ

0..1

code

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

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: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

display

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.display

Short description

Text representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

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: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.display.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.display.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

translation

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.display.extension:translation

Short description

Language Translation (Localization)

Alternate names

extensions, user content

Definition

Language translation from base language of resource to another language.

Comments

Data type

Extension

Extension URL

http://hl7.org/fhir/StructureDefinition/translation|5.3.0-ballot-tc1

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
rim: ST.translation

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.display.extension:translation.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

string

Mappings

rim: n/a

extension

2..*

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.display.extension:translation.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

lang

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.display.extension:translation.extension:lang

Short description

Code for Language

Alternate names

extensions, user content

Definition

Code for Language.

Comments

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.display.extension:translation.extension:lang.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.display.extension:translation.extension:lang.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.display.extension:translation.extension:lang.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

lang

Mappings

rim: N/A

value[x]

1..1

Binding

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.display.extension:translation.extension:lang.value[x]

Short description

Value of extension

Definition

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

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

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
rim: N/A

valueCode

code

There are no (further) constraints on this element

Data type

code

content

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.display.extension:translation.extension:content

Short description

Content in other Language

Alternate names

extensions, user content

Definition

Content in other Language.

Comments

The type (string or markdown) must match the context in which it is used.

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.display.extension:translation.extension:content.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.display.extension:translation.extension:content.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.display.extension:translation.extension:content.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

content

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.display.extension:translation.extension:content.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

valueMarkdown

markdown

There are no (further) constraints on this element

Data type

markdown

valueString

string

There are no (further) constraints on this element

Data type

string

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.display.extension:translation.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

http://hl7.org/fhir/StructureDefinition/translation

Mappings

rim: N/A

value[x]

0..0

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.display.extension:translation.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

value

0..1

System.String

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.display.value

Short description

Primitive value for string

Definition

Primitive value for string

Data type

System.String

Maximum string length

1048576

userSelected

0..1

boolean

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

boolean

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: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

text

SO Σ

0..1

string

There are no (further) constraints on this element

Element id

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

Comments

Very often the text is the same as a displayName of one of the codings.

Data type

string

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

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.text.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.code.text.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

translation

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.code.text.extension:translation

Short description

Language Translation (Localization)

Alternate names

extensions, user content

Definition

Language translation from base language of resource to another language.

Comments

Data type

Extension

Extension URL

http://hl7.org/fhir/StructureDefinition/translation|5.3.0-ballot-tc1

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
rim: ST.translation

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.text.extension:translation.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

string

Mappings

rim: n/a

extension

2..*

Extension

There are no (further) constraints on this element

Element id

Observation.code.text.extension:translation.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

lang

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.code.text.extension:translation.extension:lang

Short description

Code for Language

Alternate names

extensions, user content

Definition

Code for Language.

Comments

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.text.extension:translation.extension:lang.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.code.text.extension:translation.extension:lang.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.code.text.extension:translation.extension:lang.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

lang

Mappings

rim: N/A

value[x]

1..1

Binding

There are no (further) constraints on this element

Element id

Observation.code.text.extension:translation.extension:lang.value[x]

Short description

Value of extension

Definition

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

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

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
rim: N/A

valueCode

code

There are no (further) constraints on this element

Data type

code

content

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.code.text.extension:translation.extension:content

Short description

Content in other Language

Alternate names

extensions, user content

Definition

Content in other Language.

Comments

The type (string or markdown) must match the context in which it is used.

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.text.extension:translation.extension:content.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.code.text.extension:translation.extension:content.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.code.text.extension:translation.extension:content.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

content

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Observation.code.text.extension:translation.extension:content.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

valueMarkdown

markdown

There are no (further) constraints on this element

Data type

markdown

valueString

string

There are no (further) constraints on this element

Data type

string

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.code.text.extension:translation.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

http://hl7.org/fhir/StructureDefinition/translation

Mappings

rim: N/A

value[x]

0..0

There are no (further) constraints on this element

Element id

Observation.code.text.extension:translation.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

value

0..1

System.String

There are no (further) constraints on this element

Element id

Observation.code.text.value

Short description

Primitive value for string

Definition

Primitive value for string

Data type

System.String

Maximum string length

1048576

subject

Σ C

1..1

Reference(PatientEuCore | PatientAnimalEu | Device | Group | Location)

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

Reference(PatientEuCore | PatientAnimalEu | Device | Group | Location)

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())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Event.subject
w5: FiveWs.subject[x]
v2: PID-3
rim: participation[typeCode=RTGT]
w5: FiveWs.subject

focus

Σ C

0..*

Reference(Resource)

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

Reference(Resource)

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())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.subject[x]
v2: OBX-3
rim: participation[typeCode=SBJ]
w5: FiveWs.subject

encounter

Σ C

0..1

Reference(Encounter)

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

Reference(Encounter)

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())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Event.context
w5: FiveWs.context
v2: PV1
rim: inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]

effective[x]

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

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

dateTime

There are no (further) constraints on this element

Data type

dateTime

effectiveInstant

instant

There are no (further) constraints on this element

Data type

instant

effectivePeriod

Period

There are no (further) constraints on this element

Data type

Period

effectiveTiming

Timing

There are no (further) constraints on this element

Data type

Timing

issued

0..1

instant

There are no (further) constraints on this element

Element id

Observation.issued

Short description

Date/Time this result 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

instant

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

performer

Σ C

1..*

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.

Comments

Data type

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())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
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]

0..1

string

There are no (further) constraints on this element

Element id

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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.performer.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

performerFunction

0..1

Extension(CodeableConcept)

There are no (further) constraints on this element

Element id

Observation.performer.extension:performerFunction

Short description

Type of performance

Alternate names

extensions, user content

Definition

Distinguishes the type of involvement of the performer in the event. For example, 'author', 'verifier' or 'responsible party'.

Comments

Data type

Extension(CodeableConcept)

Extension URL

http://hl7.org/fhir/StructureDefinition/event-performerFunction

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
workflow: Event.performer.function

reference

Σ C

0..1

string

There are no (further) constraints on this element

Element id

Observation.performer.reference

Short description

Literal reference, Relative, internal or absolute URL

Definition

Comments

Data type

string

Conditions

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

Constraints

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

Mappings

rim: n/a
rim: N/A

type

0..1

uriBinding

There are no (further) constraints on this element

Element id

Observation.performer.type

Short description

Type the reference refers to (e.g. "Patient")

Definition

The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

Comments

Data type

uri

Binding

Aa resource (or, for logical models, the URI of the logical model).

ResourceType (extensible)

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
rim: N/A

identifier

0..1

Identifier

There are no (further) constraints on this element

Element id

Observation.performer.identifier

Short description

Logical reference, when literal reference is not known

Definition

Comments

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Data type

Identifier

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: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
rim: .identifier

display

0..1

string

There are no (further) constraints on this element

Element id

Observation.performer.display

Short description

Text alternative for the resource

Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Data type

string

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
rim: N/A

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

Slicing

Unordered, Closed, by $this(Type)

Conditions

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

Constraints

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

Mappings

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

valueBoolean

boolean

There are no (further) constraints on this element

Data type

boolean

valueInteger

integer

There are no (further) constraints on this element

Data type

integer

valueSampledData

SampledData

There are no (further) constraints on this element

Data type

SampledData

valueString

Σ C

0..1

string

There are no (further) constraints on this element

Element id

Observation.value[x]:valueString

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

Data type

string

Conditions

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

Constraints

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

Mappings

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

valueRange

Σ C

0..1

RangeEuLab

There are no (further) constraints on this element

Element id

Observation.value[x]:valueRange

Short description

A measured range using UCUM

Definition

A measured range (or a range that can potentially be measured) and uncertainty of the measurement. This profile imposes that the code system for units be UCUM.

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

The stated low and high value are assumed to have arbitrarily high precision when it comes to determining which values are in the range. I.e. 1.99 is not in the range 2 -> 3.

Data type

RangeEuLab

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
rng-2: If present, low SHALL have a lower value than high
low.empty() or high.empty() or (low <= high)

Mappings

rim: n/a
sct-concept: < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|
v2: NR and also possibly SN (but see also quantity)
rim: IVL<QTY[not(type="TS")]> [lowClosed="true" and highClosed="true"]or URG<QTY[not(type="TS")]>

valueRatio

Σ C

0..1

RatioEuLab

There are no (further) constraints on this element

Element id

Observation.value[x]:valueRatio

Short description

A measured ratio using UCUM

Definition

A measured ratio (or a ratio that can potentially be measured) and uncertainty of the measurement. This profile imposes that the code system for units be UCUM.

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

RatioEuLab

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present
(numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists())

Mappings

rim: n/a
sct-concept: < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|
v2: N/A
rim: RTO

valueTime

Σ C

0..1

time

There are no (further) constraints on this element

Element id

Observation.value[x]:valueTime

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

Data type

time

Conditions

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

Constraints

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

Mappings

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

valueDateTime

Σ C

0..1

dateTime

There are no (further) constraints on this element

Element id

Observation.value[x]:valueDateTime

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

Data type

dateTime

Conditions

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

Constraints

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

Mappings

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

valuePeriod

Σ C

0..1

Period

There are no (further) constraints on this element

Element id

Observation.value[x]:valuePeriod

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

Data type

Period

Conditions

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

Constraints

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

Mappings

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

valueQuantity

Σ C

0..1

QuantityEuLab

There are no (further) constraints on this element

Element id

Observation.value[x]:valueQuantity

Short description

A measured amount using UCUM

Definition

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

The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.

Data type

QuantityEuLab

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
qty-3: If a code for the unit is present, the system SHALL also be present
code.empty() or system.exists()

Mappings

rim: n/a
sct-concept: < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|
v2: SN (see also Range) or CQ
rim: PQ, IVL<PQ>, MO, CO, depending on the values

valueCodeableConcept

Σ C

0..1

CodeableConceptIPSBinding

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept

Short description

Concept - reference to a terminology or just text

Definition

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

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

CodeableConceptIPS

Binding

ResultsCodedValuesLaboratoryPathologyUvIps (preferred)

Additional bindings

http://hl7.org/fhir/uv/ips/ValueSet/results-blood-group-snomed-ct-ips-free-set (candidate)
Additional conformance binding to a blood group findings value set for laboratory result values from the SNOMED CT IPS free set for use globally (in SNOMED member and non-member jurisdictions).
http://hl7.org/fhir/uv/ips/ValueSet/results-presence-absence-snomed-ct-ips-free-set (candidate)
Additional conformance binding to a presence and absence findings (qualifier values) value set for laboratory result values from the SNOMED CT IPS free set for use globally (in SNOMED member and non-member jurisdictions).
http://hl7.org/fhir/uv/ips/ValueSet/results-microorganism-snomed-ct-ips-free-set (candidate)
Additional conformance binding to a microorganisms value set for laboratory result values from the SNOMED CT IPS free set for use globally (in SNOMED member and non-member jurisdictions).

Conditions

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

Constraints

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

Mappings

rim: n/a
sct-concept: < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD

0..1

string

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

coding

SO Σ

0..*

CodingIPS

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding

Short description

A reference to a 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.

Data type

CodingIPS

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: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

0..1

string

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

system

SO Σ

0..1

uri

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

uri

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: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

version

0..1

string

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

string

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: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

SO Σ

0..1

code

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

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: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

display

0..1

string

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.display

Short description

Text representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

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: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

0..1

string

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.display.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.display.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

translation

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.display.extension:translation

Short description

Language Translation (Localization)

Alternate names

extensions, user content

Definition

Language translation from base language of resource to another language.

Comments

Data type

Extension

Extension URL

http://hl7.org/fhir/StructureDefinition/translation|5.3.0-ballot-tc1

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
rim: ST.translation

0..1

string

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.display.extension:translation.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

string

Mappings

rim: n/a

extension

2..*

Extension

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.display.extension:translation.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

lang

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.display.extension:translation.extension:lang

Short description

Code for Language

Alternate names

extensions, user content

Definition

Code for Language.

Comments

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.display.extension:translation.extension:lang.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.display.extension:translation.extension:lang.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.display.extension:translation.extension:lang.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

lang

Mappings

rim: N/A

value[x]

1..1

Binding

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.display.extension:translation.extension:lang.value[x]

Short description

Value of extension

Definition

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

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

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
rim: N/A

valueCode

code

There are no (further) constraints on this element

Data type

code

content

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.display.extension:translation.extension:content

Short description

Content in other Language

Alternate names

extensions, user content

Definition

Content in other Language.

Comments

The type (string or markdown) must match the context in which it is used.

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.display.extension:translation.extension:content.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.display.extension:translation.extension:content.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.display.extension:translation.extension:content.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

content

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.display.extension:translation.extension:content.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

valueMarkdown

markdown

There are no (further) constraints on this element

Data type

markdown

valueString

string

There are no (further) constraints on this element

Data type

string

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.display.extension:translation.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

http://hl7.org/fhir/StructureDefinition/translation

Mappings

rim: N/A

value[x]

0..0

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.display.extension:translation.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

value

0..1

System.String

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.display.value

Short description

Primitive value for string

Definition

Primitive value for string

Data type

System.String

Maximum string length

1048576

userSelected

0..1

boolean

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

boolean

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: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

text

SO Σ

0..1

string

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.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

Comments

Very often the text is the same as a displayName of one of the codings.

Data type

string

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

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

0..1

string

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.text.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.text.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

translation

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.text.extension:translation

Short description

Language Translation (Localization)

Alternate names

extensions, user content

Definition

Language translation from base language of resource to another language.

Comments

Data type

Extension

Extension URL

http://hl7.org/fhir/StructureDefinition/translation|5.3.0-ballot-tc1

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
rim: ST.translation

0..1

string

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.text.extension:translation.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

string

Mappings

rim: n/a

extension

2..*

Extension

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.text.extension:translation.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

lang

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.text.extension:translation.extension:lang

Short description

Code for Language

Alternate names

extensions, user content

Definition

Code for Language.

Comments

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.text.extension:translation.extension:lang.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.text.extension:translation.extension:lang.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.text.extension:translation.extension:lang.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

lang

Mappings

rim: N/A

value[x]

1..1

Binding

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.text.extension:translation.extension:lang.value[x]

Short description

Value of extension

Definition

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

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

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
rim: N/A

valueCode

code

There are no (further) constraints on this element

Data type

code

content

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.text.extension:translation.extension:content

Short description

Content in other Language

Alternate names

extensions, user content

Definition

Content in other Language.

Comments

The type (string or markdown) must match the context in which it is used.

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.text.extension:translation.extension:content.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.text.extension:translation.extension:content.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.text.extension:translation.extension:content.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

content

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.text.extension:translation.extension:content.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

valueMarkdown

markdown

There are no (further) constraints on this element

Data type

markdown

valueString

string

There are no (further) constraints on this element

Data type

string

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.text.extension:translation.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

http://hl7.org/fhir/StructureDefinition/translation

Mappings

rim: N/A

value[x]

0..0

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.text.extension:translation.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

value

0..1

System.String

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.text.value

Short description

Primitive value for string

Definition

Primitive value for string

Data type

System.String

Maximum string length

1048576

dataAbsentReason

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.dataAbsentReason

Short description

Provides a reason why the expected value 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

CodeableConcept

Binding

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

DataAbsentReason (extensible)

Conditions

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

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: N/A
rim: value.nullFlavor

interpretation

0..*

CodeableConceptIPSBinding

Element id

Observation.interpretation

Short description

Concept - reference to a terminology or just text

Alternate names

Abnormal Flag

Definition

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

Requirements

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

Comments

Data type

CodeableConceptIPS

Binding

Codes identifying interpretations of observations.

EnglandDeviatingResultIndicator (extensible)

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: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
sct-concept: < 260245000 |Findings values|
v2: OBX-8
rim: interpretationCode
sct-attr: 363713009 |Has interpretation|

0..1

string

There are no (further) constraints on this element

Element id

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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.interpretation.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

coding

SO Σ

0..*

CodingIPS

There are no (further) constraints on this element

Element id

Observation.interpretation.coding

Short description

A reference to a 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.

Data type

CodingIPS

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: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

0..1

string

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

system

SO Σ

0..1

uri

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

uri

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: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

version

0..1

string

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

string

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: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

SO Σ

0..1

code

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

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: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

display

0..1

string

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.display

Short description

Text representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

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: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

0..1

string

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.display.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.display.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

translation

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.display.extension:translation

Short description

Language Translation (Localization)

Alternate names

extensions, user content

Definition

Language translation from base language of resource to another language.

Comments

Data type

Extension

Extension URL

http://hl7.org/fhir/StructureDefinition/translation|5.3.0-ballot-tc1

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
rim: ST.translation

0..1

string

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.display.extension:translation.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

string

Mappings

rim: n/a

extension

2..*

Extension

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.display.extension:translation.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

lang

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.display.extension:translation.extension:lang

Short description

Code for Language

Alternate names

extensions, user content

Definition

Code for Language.

Comments

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.display.extension:translation.extension:lang.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.display.extension:translation.extension:lang.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.display.extension:translation.extension:lang.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

lang

Mappings

rim: N/A

value[x]

1..1

Binding

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.display.extension:translation.extension:lang.value[x]

Short description

Value of extension

Definition

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

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

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
rim: N/A

valueCode

code

There are no (further) constraints on this element

Data type

code

content

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.display.extension:translation.extension:content

Short description

Content in other Language

Alternate names

extensions, user content

Definition

Content in other Language.

Comments

The type (string or markdown) must match the context in which it is used.

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.display.extension:translation.extension:content.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.display.extension:translation.extension:content.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.display.extension:translation.extension:content.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

content

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.display.extension:translation.extension:content.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

valueMarkdown

markdown

There are no (further) constraints on this element

Data type

markdown

valueString

string

There are no (further) constraints on this element

Data type

string

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.display.extension:translation.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

http://hl7.org/fhir/StructureDefinition/translation

Mappings

rim: N/A

value[x]

0..0

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.display.extension:translation.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

value

0..1

System.String

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.display.value

Short description

Primitive value for string

Definition

Primitive value for string

Data type

System.String

Maximum string length

1048576

userSelected

0..1

boolean

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

boolean

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: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

text

SO Σ

0..1

string

There are no (further) constraints on this element

Element id

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

Comments

Very often the text is the same as a displayName of one of the codings.

Data type

string

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

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

0..1

string

There are no (further) constraints on this element

Element id

Observation.interpretation.text.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.interpretation.text.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

translation

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.interpretation.text.extension:translation

Short description

Language Translation (Localization)

Alternate names

extensions, user content

Definition

Language translation from base language of resource to another language.

Comments

Data type

Extension

Extension URL

http://hl7.org/fhir/StructureDefinition/translation|5.3.0-ballot-tc1

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
rim: ST.translation

0..1

string

There are no (further) constraints on this element

Element id

Observation.interpretation.text.extension:translation.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

string

Mappings

rim: n/a

extension

2..*

Extension

There are no (further) constraints on this element

Element id

Observation.interpretation.text.extension:translation.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

lang

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.interpretation.text.extension:translation.extension:lang

Short description

Code for Language

Alternate names

extensions, user content

Definition

Code for Language.

Comments

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.interpretation.text.extension:translation.extension:lang.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.interpretation.text.extension:translation.extension:lang.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.interpretation.text.extension:translation.extension:lang.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

lang

Mappings

rim: N/A

value[x]

1..1

Binding

There are no (further) constraints on this element

Element id

Observation.interpretation.text.extension:translation.extension:lang.value[x]

Short description

Value of extension

Definition

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

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

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
rim: N/A

valueCode

code

There are no (further) constraints on this element

Data type

code

content

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.interpretation.text.extension:translation.extension:content

Short description

Content in other Language

Alternate names

extensions, user content

Definition

Content in other Language.

Comments

The type (string or markdown) must match the context in which it is used.

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.interpretation.text.extension:translation.extension:content.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.interpretation.text.extension:translation.extension:content.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.interpretation.text.extension:translation.extension:content.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

content

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Observation.interpretation.text.extension:translation.extension:content.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

valueMarkdown

markdown

There are no (further) constraints on this element

Data type

markdown

valueString

string

There are no (further) constraints on this element

Data type

string

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.interpretation.text.extension:translation.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

http://hl7.org/fhir/StructureDefinition/translation

Mappings

rim: N/A

value[x]

0..0

There are no (further) constraints on this element

Element id

Observation.interpretation.text.extension:translation.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

value

0..1

System.String

There are no (further) constraints on this element

Element id

Observation.interpretation.text.value

Short description

Primitive value for string

Definition

Primitive value for string

Data type

System.String

Maximum string length

1048576

note

0..*

Annotation

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

Annotation

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
v2: NTE.3 (partner NTE to OBX, or sometimes another (child?) OBX)
rim: subjectOf.observationEvent[code="annotation"].value

bodySite

0..1

CodeableConcept

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

CodeableConcept

Binding

Codes describing anatomical locations. May include laterality.

SNOMEDCTBodyStructures (example)

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: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
sct-concept: < 123037004 |Body structure|
v2: OBX-20
rim: targetSiteCode
sct-attr: 718497002 |Inherent location|

method

0..1

CodeableConceptIPSBinding

There are no (further) constraints on this element

Element id

Observation.method

Short description

Concept - reference to a terminology or just text

Definition

Laboratory technigue that has been used

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

Data type

CodeableConceptIPS

Binding

Methods for simple observations.

LabTechniqueEuVs (preferred)

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: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: OBX-17
rim: methodCode

0..1

string

There are no (further) constraints on this element

Element id

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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.method.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

coding

SO Σ

0..*

CodingIPS

There are no (further) constraints on this element

Element id

Observation.method.coding

Short description

A reference to a 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.

Data type

CodingIPS

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: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

0..1

string

There are no (further) constraints on this element

Element id

Observation.method.coding.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.method.coding.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

system

SO Σ

0..1

uri

There are no (further) constraints on this element

Element id

Observation.method.coding.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

uri

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: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

version

0..1

string

There are no (further) constraints on this element

Element id

Observation.method.coding.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

string

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: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

SO Σ

0..1

code

There are no (further) constraints on this element

Element id

Observation.method.coding.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

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: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

display

0..1

string

There are no (further) constraints on this element

Element id

Observation.method.coding.display

Short description

Text representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

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: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

0..1

string

There are no (further) constraints on this element

Element id

Observation.method.coding.display.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.method.coding.display.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

translation

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.method.coding.display.extension:translation

Short description

Language Translation (Localization)

Alternate names

extensions, user content

Definition

Language translation from base language of resource to another language.

Comments

Data type

Extension

Extension URL

http://hl7.org/fhir/StructureDefinition/translation|5.3.0-ballot-tc1

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
rim: ST.translation

0..1

string

There are no (further) constraints on this element

Element id

Observation.method.coding.display.extension:translation.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

string

Mappings

rim: n/a

extension

2..*

Extension

There are no (further) constraints on this element

Element id

Observation.method.coding.display.extension:translation.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

lang

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.method.coding.display.extension:translation.extension:lang

Short description

Code for Language

Alternate names

extensions, user content

Definition

Code for Language.

Comments

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.method.coding.display.extension:translation.extension:lang.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.method.coding.display.extension:translation.extension:lang.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.method.coding.display.extension:translation.extension:lang.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

lang

Mappings

rim: N/A

value[x]

1..1

Binding

There are no (further) constraints on this element

Element id

Observation.method.coding.display.extension:translation.extension:lang.value[x]

Short description

Value of extension

Definition

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

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

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
rim: N/A

valueCode

code

There are no (further) constraints on this element

Data type

code

content

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.method.coding.display.extension:translation.extension:content

Short description

Content in other Language

Alternate names

extensions, user content

Definition

Content in other Language.

Comments

The type (string or markdown) must match the context in which it is used.

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.method.coding.display.extension:translation.extension:content.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.method.coding.display.extension:translation.extension:content.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.method.coding.display.extension:translation.extension:content.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

content

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Observation.method.coding.display.extension:translation.extension:content.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

valueMarkdown

markdown

There are no (further) constraints on this element

Data type

markdown

valueString

string

There are no (further) constraints on this element

Data type

string

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.method.coding.display.extension:translation.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

http://hl7.org/fhir/StructureDefinition/translation

Mappings

rim: N/A

value[x]

0..0

There are no (further) constraints on this element

Element id

Observation.method.coding.display.extension:translation.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

value

0..1

System.String

There are no (further) constraints on this element

Element id

Observation.method.coding.display.value

Short description

Primitive value for string

Definition

Primitive value for string

Data type

System.String

Maximum string length

1048576

userSelected

0..1

boolean

There are no (further) constraints on this element

Element id

Observation.method.coding.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

boolean

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: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

text

SO Σ

0..1

string

There are no (further) constraints on this element

Element id

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

Comments

Very often the text is the same as a displayName of one of the codings.

Data type

string

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

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

0..1

string

There are no (further) constraints on this element

Element id

Observation.method.text.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.method.text.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

translation

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.method.text.extension:translation

Short description

Language Translation (Localization)

Alternate names

extensions, user content

Definition

Language translation from base language of resource to another language.

Comments

Data type

Extension

Extension URL

http://hl7.org/fhir/StructureDefinition/translation|5.3.0-ballot-tc1

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
rim: ST.translation

0..1

string

There are no (further) constraints on this element

Element id

Observation.method.text.extension:translation.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

string

Mappings

rim: n/a

extension

2..*

Extension

There are no (further) constraints on this element

Element id

Observation.method.text.extension:translation.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

lang

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.method.text.extension:translation.extension:lang

Short description

Code for Language

Alternate names

extensions, user content

Definition

Code for Language.

Comments

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.method.text.extension:translation.extension:lang.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.method.text.extension:translation.extension:lang.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.method.text.extension:translation.extension:lang.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

lang

Mappings

rim: N/A

value[x]

1..1

Binding

There are no (further) constraints on this element

Element id

Observation.method.text.extension:translation.extension:lang.value[x]

Short description

Value of extension

Definition

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

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

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
rim: N/A

valueCode

code

There are no (further) constraints on this element

Data type

code

content

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.method.text.extension:translation.extension:content

Short description

Content in other Language

Alternate names

extensions, user content

Definition

Content in other Language.

Comments

The type (string or markdown) must match the context in which it is used.

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.method.text.extension:translation.extension:content.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.method.text.extension:translation.extension:content.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.method.text.extension:translation.extension:content.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

content

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Observation.method.text.extension:translation.extension:content.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

valueMarkdown

markdown

There are no (further) constraints on this element

Data type

markdown

valueString

string

There are no (further) constraints on this element

Data type

string

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.method.text.extension:translation.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

http://hl7.org/fhir/StructureDefinition/translation

Mappings

rim: N/A

value[x]

0..0

There are no (further) constraints on this element

Element id

Observation.method.text.extension:translation.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

value

0..1

System.String

There are no (further) constraints on this element

Element id

Observation.method.text.value

Short description

Primitive value for string

Definition

Primitive value for string

Data type

System.String

Maximum string length

1048576

specimen

0..1

Reference(SpecimenEu)

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

When the specimen is applicable and known it shall be documented

Data type

Reference(SpecimenEu)

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())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
sct-concept: < 123038009 |Specimen|
v2: SPM segment
rim: participation[typeCode=SPC].specimen
sct-attr: 704319004 |Inherent in|

device

0..1

Reference(Device | DeviceMetric)

There are no (further) constraints on this element

Element id

Observation.device

Short description

Measuring instrument

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

Reference(Device | DeviceMetric)

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())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
sct-concept: < 49062001 |Device|
v2: OBX-17 / PRT -10
rim: participation[typeCode=DEV]
sct-attr: 424226004 |Using device|

referenceRange

0..*

BackboneElement

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

BackboneElement

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())
obs-3: Must have at least a low or a high or text
low.exists() or high.exists() or text.exists()

Mappings

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

0..1

string

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

string

Mappings

rim: n/a

extension

0..*

Extension

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

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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..*

Extension

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

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

low

0..1

SimpleQuantity

There are no (further) constraints on this element

Element id

Observation.referenceRange.low

Short description

Low Range, if relevant

Definition

Comments

The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.

Data type

SimpleQuantity

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
qty-3: If a code for the unit is present, the system SHALL also be present
code.empty() or system.exists()
sqty-1: The comparator is not used on a SimpleQuantity
comparator.empty()

Mappings

rim: n/a
v2: SN (see also Range) or CQ
rim: PQ, IVL<PQ>, MO, CO, depending on the values
v2: OBX-7
rim: value:IVL_PQ.low

high

0..1

SimpleQuantity

There are no (further) constraints on this element

Element id

Observation.referenceRange.high

Short description

High Range, if relevant

Definition

Comments

The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.

Data type

SimpleQuantity

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
qty-3: If a code for the unit is present, the system SHALL also be present
code.empty() or system.exists()
sqty-1: The comparator is not used on a SimpleQuantity
comparator.empty()

Mappings

rim: n/a
v2: SN (see also Range) or CQ
rim: PQ, IVL<PQ>, MO, CO, depending on the values
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

CodeableConcept

Binding

Code for the meaning of a reference range.

ObservationReferenceRangeMeaningCodes (preferred)

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: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
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..*

CodeableConcept

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

CodeableConcept

Binding

Codes identifying the population the reference range applies to.

ObservationReferenceRangeAppliesToCodes (example)

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: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
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

Range

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.

Comments

The stated low and high value are assumed to have arbitrarily high precision when it comes to determining which values are in the range. I.e. 1.99 is not in the range 2 -> 3.

Data type

Range

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())
rng-2: If present, low SHALL have a lower value than high
low.empty() or high.empty() or (low <= high)

Mappings

rim: n/a
v2: NR and also possibly SN (but see also quantity)
rim: IVL<QTY[not(type="TS")]> [lowClosed="true" and highClosed="true"]or URG<QTY[not(type="TS")]>
rim: outboundRelationship[typeCode=PRCN].targetObservationCriterion[code="age"].value

text

0..1

string

There are no (further) constraints on this element

Element id

Observation.referenceRange.text

Short description

Text based reference range in an observation

Definition

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

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: OBX-7
rim: value:ST

hasMember

Σ C

0..*

Reference(ObservationResultsLaboratoryEu)

There are no (further) constraints on this element

Element id

Observation.hasMember

Short description

Related resource that belongs to the Observation group

Definition

Comments

Data type

Reference(ObservationResultsLaboratoryEu)

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())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: Relationships established by OBX-4 usage
rim: outBoundRelationship

derivedFrom

Σ C

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

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())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: Relationships established by OBX-4 usage
rim: .targetObservation

component

0..*

BackboneElement

There are no (further) constraints on this element

Element id

Observation.component

Short description

Laboratory result

Definition

Requirements

Comments

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

Data type

BackboneElement

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: containment by OBX-4?
rim: outBoundRelationship[typeCode=COMP]

0..1

string

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

string

Mappings

rim: n/a

extension

0..*

Extension

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

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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..*

Extension

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

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

code

1..1

CodeableConceptIPSBinding

There are no (further) constraints on this element

Element id

Observation.component.code

Short description

Concept - reference to a terminology or just text

Definition

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

Requirements

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

Comments

Data type

CodeableConceptIPS

Binding

Codes identifying names of simple observations.

ResultsLaboratoryPathologyObservationUvIps (preferred)

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: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
w5: FiveWs.what[x]
sct-concept: < 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|
v2: OBX-3
rim: code

0..1

string

There are no (further) constraints on this element

Element id

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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.component.code.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

coding

SO Σ

0..*

CodingIPS

There are no (further) constraints on this element

Element id

Observation.component.code.coding

Short description

A reference to a 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.

Data type

CodingIPS

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: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.code.coding.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.component.code.coding.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

system

SO Σ

0..1

uri

There are no (further) constraints on this element

Element id

Observation.component.code.coding.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

uri

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: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

version

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.code.coding.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

string

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: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

SO Σ

0..1

code

There are no (further) constraints on this element

Element id

Observation.component.code.coding.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

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: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

display

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.code.coding.display

Short description

Text representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

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: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.code.coding.display.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.component.code.coding.display.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

translation

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.component.code.coding.display.extension:translation

Short description

Language Translation (Localization)

Alternate names

extensions, user content

Definition

Language translation from base language of resource to another language.

Comments

Data type

Extension

Extension URL

http://hl7.org/fhir/StructureDefinition/translation|5.3.0-ballot-tc1

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
rim: ST.translation

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.code.coding.display.extension:translation.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

string

Mappings

rim: n/a

extension

2..*

Extension

There are no (further) constraints on this element

Element id

Observation.component.code.coding.display.extension:translation.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

lang

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.component.code.coding.display.extension:translation.extension:lang

Short description

Code for Language

Alternate names

extensions, user content

Definition

Code for Language.

Comments

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.code.coding.display.extension:translation.extension:lang.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.component.code.coding.display.extension:translation.extension:lang.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.component.code.coding.display.extension:translation.extension:lang.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

lang

Mappings

rim: N/A

value[x]

1..1

Binding

There are no (further) constraints on this element

Element id

Observation.component.code.coding.display.extension:translation.extension:lang.value[x]

Short description

Value of extension

Definition

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

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

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
rim: N/A

valueCode

code

There are no (further) constraints on this element

Data type

code

content

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.component.code.coding.display.extension:translation.extension:content

Short description

Content in other Language

Alternate names

extensions, user content

Definition

Content in other Language.

Comments

The type (string or markdown) must match the context in which it is used.

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.code.coding.display.extension:translation.extension:content.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.component.code.coding.display.extension:translation.extension:content.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.component.code.coding.display.extension:translation.extension:content.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

content

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Observation.component.code.coding.display.extension:translation.extension:content.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

valueMarkdown

markdown

There are no (further) constraints on this element

Data type

markdown

valueString

string

There are no (further) constraints on this element

Data type

string

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.component.code.coding.display.extension:translation.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

http://hl7.org/fhir/StructureDefinition/translation

Mappings

rim: N/A

value[x]

0..0

There are no (further) constraints on this element

Element id

Observation.component.code.coding.display.extension:translation.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

value

0..1

System.String

There are no (further) constraints on this element

Element id

Observation.component.code.coding.display.value

Short description

Primitive value for string

Definition

Primitive value for string

Data type

System.String

Maximum string length

1048576

userSelected

0..1

boolean

There are no (further) constraints on this element

Element id

Observation.component.code.coding.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

boolean

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: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

text

SO Σ

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.code.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

Comments

Very often the text is the same as a displayName of one of the codings.

Data type

string

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

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.code.text.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.component.code.text.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

translation

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.component.code.text.extension:translation

Short description

Language Translation (Localization)

Alternate names

extensions, user content

Definition

Language translation from base language of resource to another language.

Comments

Data type

Extension

Extension URL

http://hl7.org/fhir/StructureDefinition/translation|5.3.0-ballot-tc1

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
rim: ST.translation

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.code.text.extension:translation.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

string

Mappings

rim: n/a

extension

2..*

Extension

There are no (further) constraints on this element

Element id

Observation.component.code.text.extension:translation.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

lang

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.component.code.text.extension:translation.extension:lang

Short description

Code for Language

Alternate names

extensions, user content

Definition

Code for Language.

Comments

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.code.text.extension:translation.extension:lang.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.component.code.text.extension:translation.extension:lang.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.component.code.text.extension:translation.extension:lang.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

lang

Mappings

rim: N/A

value[x]

1..1

Binding

There are no (further) constraints on this element

Element id

Observation.component.code.text.extension:translation.extension:lang.value[x]

Short description

Value of extension

Definition

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

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

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
rim: N/A

valueCode

code

There are no (further) constraints on this element

Data type

code

content

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.component.code.text.extension:translation.extension:content

Short description

Content in other Language

Alternate names

extensions, user content

Definition

Content in other Language.

Comments

The type (string or markdown) must match the context in which it is used.

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.code.text.extension:translation.extension:content.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.component.code.text.extension:translation.extension:content.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.component.code.text.extension:translation.extension:content.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

content

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Observation.component.code.text.extension:translation.extension:content.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

valueMarkdown

markdown

There are no (further) constraints on this element

Data type

markdown

valueString

string

There are no (further) constraints on this element

Data type

string

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.component.code.text.extension:translation.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

http://hl7.org/fhir/StructureDefinition/translation

Mappings

rim: N/A

value[x]

0..0

There are no (further) constraints on this element

Element id

Observation.component.code.text.extension:translation.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

value

0..1

System.String

There are no (further) constraints on this element

Element id

Observation.component.code.text.value

Short description

Primitive value for string

Definition

Primitive value for string

Data type

System.String

Maximum string length

1048576

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

Slicing

Unordered, Closed, by $this(Type)

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

valueBoolean

boolean

There are no (further) constraints on this element

Data type

boolean

valueInteger

integer

There are no (further) constraints on this element

Data type

integer

valueSampledData

SampledData

There are no (further) constraints on this element

Data type

SampledData

valueString

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueString

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

string

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

valueRange

Σ C

0..1

RangeEuLab

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueRange

Short description

A measured range using UCUM

Definition

A measured range (or a range that can potentially be measured) and uncertainty of the measurement. This profile imposes that the code system for units be UCUM.

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

The stated low and high value are assumed to have arbitrarily high precision when it comes to determining which values are in the range. I.e. 1.99 is not in the range 2 -> 3.

Data type

RangeEuLab

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())
rng-2: If present, low SHALL have a lower value than high
low.empty() or high.empty() or (low <= high)

Mappings

rim: n/a
sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|
v2: NR and also possibly SN (but see also quantity)
rim: IVL<QTY[not(type="TS")]> [lowClosed="true" and highClosed="true"]or URG<QTY[not(type="TS")]>

valueRatio

Σ C

0..1

RatioEuLab

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueRatio

Short description

A measured ratio using UCUM

Definition

A measured ratio (or a ratio that can potentially be measured) and uncertainty of the measurement. This profile imposes that the code system for units be UCUM.

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

RatioEuLab

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())
rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present
(numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists())

Mappings

rim: n/a
sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|
v2: N/A
rim: RTO

valueTime

0..1

time

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueTime

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

time

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

valueDateTime

0..1

dateTime

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueDateTime

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

dateTime

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

valuePeriod

0..1

Period

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valuePeriod

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

Period

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

valueQuantity

Σ C

0..1

QuantityEuLab

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueQuantity

Short description

A measured amount using UCUM

Definition

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

The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.

Data type

QuantityEuLab

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())
qty-3: If a code for the unit is present, the system SHALL also be present
code.empty() or system.exists()

Mappings

rim: n/a
sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|
v2: SN (see also Range) or CQ
rim: PQ, IVL<PQ>, MO, CO, depending on the values

valueCodeableConcept

0..1

CodeableConceptIPSBinding

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept

Short description

Concept - reference to a terminology or just text

Definition

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

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

CodeableConceptIPS

Binding

ResultsCodedValuesLaboratoryPathologyUvIps (preferred)

Additional bindings

http://hl7.org/fhir/uv/ips/ValueSet/results-blood-group-snomed-ct-ips-free-set (candidate)
Additional conformance binding to a blood group findings value set for laboratory result values from the SNOMED CT IPS free set for use globally (in SNOMED member and non-member jurisdictions).
http://hl7.org/fhir/uv/ips/ValueSet/results-presence-absence-snomed-ct-ips-free-set (candidate)
Additional conformance binding to a presence and absence findings (qualifier values) value set for laboratory result values from the SNOMED CT IPS free set for use globally (in SNOMED member and non-member jurisdictions).
http://hl7.org/fhir/uv/ips/ValueSet/results-microorganism-snomed-ct-ips-free-set (candidate)
Additional conformance binding to a microorganisms value set for laboratory result values from the SNOMED CT IPS free set for use globally (in SNOMED member and non-member jurisdictions).

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
sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

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

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

coding

SO Σ

0..*

CodingIPS

There are no (further) constraints on this element

Element id

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

Short description

A reference to a 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.

Data type

CodingIPS

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: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

system

SO Σ

0..1

uri

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

uri

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: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

version

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

string

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: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

SO Σ

0..1

code

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

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: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

display

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.display

Short description

Text representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

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: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.display.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.display.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

translation

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.display.extension:translation

Short description

Language Translation (Localization)

Alternate names

extensions, user content

Definition

Language translation from base language of resource to another language.

Comments

Data type

Extension

Extension URL

http://hl7.org/fhir/StructureDefinition/translation|5.3.0-ballot-tc1

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
rim: ST.translation

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.display.extension:translation.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

string

Mappings

rim: n/a

extension

2..*

Extension

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.display.extension:translation.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

lang

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.display.extension:translation.extension:lang

Short description

Code for Language

Alternate names

extensions, user content

Definition

Code for Language.

Comments

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.display.extension:translation.extension:lang.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.display.extension:translation.extension:lang.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.display.extension:translation.extension:lang.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

lang

Mappings

rim: N/A

value[x]

1..1

Binding

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.display.extension:translation.extension:lang.value[x]

Short description

Value of extension

Definition

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

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

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
rim: N/A

valueCode

code

There are no (further) constraints on this element

Data type

code

content

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.display.extension:translation.extension:content

Short description

Content in other Language

Alternate names

extensions, user content

Definition

Content in other Language.

Comments

The type (string or markdown) must match the context in which it is used.

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.display.extension:translation.extension:content.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.display.extension:translation.extension:content.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.display.extension:translation.extension:content.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

content

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.display.extension:translation.extension:content.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

valueMarkdown

markdown

There are no (further) constraints on this element

Data type

markdown

valueString

string

There are no (further) constraints on this element

Data type

string

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.display.extension:translation.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

http://hl7.org/fhir/StructureDefinition/translation

Mappings

rim: N/A

value[x]

0..0

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.display.extension:translation.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

value

0..1

System.String

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.display.value

Short description

Primitive value for string

Definition

Primitive value for string

Data type

System.String

Maximum string length

1048576

userSelected

0..1

boolean

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

boolean

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: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

text

SO Σ

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.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

Comments

Very often the text is the same as a displayName of one of the codings.

Data type

string

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

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.text.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.text.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

translation

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.text.extension:translation

Short description

Language Translation (Localization)

Alternate names

extensions, user content

Definition

Language translation from base language of resource to another language.

Comments

Data type

Extension

Extension URL

http://hl7.org/fhir/StructureDefinition/translation|5.3.0-ballot-tc1

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
rim: ST.translation

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.text.extension:translation.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

string

Mappings

rim: n/a

extension

2..*

Extension

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.text.extension:translation.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

lang

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.text.extension:translation.extension:lang

Short description

Code for Language

Alternate names

extensions, user content

Definition

Code for Language.

Comments

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.text.extension:translation.extension:lang.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.text.extension:translation.extension:lang.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.text.extension:translation.extension:lang.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

lang

Mappings

rim: N/A

value[x]

1..1

Binding

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.text.extension:translation.extension:lang.value[x]

Short description

Value of extension

Definition

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

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

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
rim: N/A

valueCode

code

There are no (further) constraints on this element

Data type

code

content

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.text.extension:translation.extension:content

Short description

Content in other Language

Alternate names

extensions, user content

Definition

Content in other Language.

Comments

The type (string or markdown) must match the context in which it is used.

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.text.extension:translation.extension:content.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.text.extension:translation.extension:content.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.text.extension:translation.extension:content.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

content

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.text.extension:translation.extension:content.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

valueMarkdown

markdown

There are no (further) constraints on this element

Data type

markdown

valueString

string

There are no (further) constraints on this element

Data type

string

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.text.extension:translation.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

http://hl7.org/fhir/StructureDefinition/translation

Mappings

rim: N/A

value[x]

0..0

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.text.extension:translation.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

value

0..1

System.String

There are no (further) constraints on this element

Element id

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

Short description

Primitive value for string

Definition

Primitive value for string

Data type

System.String

Maximum string length

1048576

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

CodeableConcept

Binding

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

DataAbsentReason (extensible)

Conditions

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

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
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

CodeableConcept

Binding

Codes identifying interpretations of observations.

ObservationInterpretationCodes (extensible)

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: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
sct-concept: < 260245000 |Findings values|
v2: OBX-8
rim: interpretationCode
sct-attr: 363713009 |Has interpretation|

referenceRange

0..*

see (referenceRange)

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

Mappings

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

EnglandObservationLabPathology (Observation)

ObservationResultsLaboratoryEu

There are no (further) constraints on this element

Element id

Observation

Short description

Laboratory result for a simple test or for a panel/study

Alternate names

Vital Signs, Measurement, Results, Tests

Definition

Comments

Represents either a lab simple observation or the group of observations produced by a laboratory study.

Data type

ObservationResultsLaboratoryEu

Constraints

dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.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-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-6: A resource should have narrative for robust management
text.`div`.exists()
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.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()
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
dataAbsentReason.empty() or value.empty()
eu-lab-1: If observation status is other then "registered" or "cancelled", at least one of these Observation elements shall be provided: "value", "dataAbsentReason", "hasMember" or "component"
(status in ('registered'|'cancelled')) or value.exists() or hasMember.exists() or component.exists() or dataAbsentReason.exists()
eu-lab-2: If observation has components and observation status is other then "registered" or "cancelled", at least one of these Observation.component elements shall be provided: "value" or "dataAbsentReason"
component.exists() implies (status in ('registered'|'cancelled')) or component.value.exists() or component.dataAbsentReason.exists()

Mappings

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

0..1

string

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

string

Meta

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

Meta

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
rim: N/A

implicitRules

Σ ?!

0..1

uri

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

uri

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

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

code

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

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

text

0..1

Narrative

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

Narrative

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
rim: N/A
rim: Act.text?

contained

0..*

Resource

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

Resource

Mappings

rim: Entity. Role, or Act
rim: N/A

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.extension

Short description

Laboratory Test Kit

Alternate names

extensions, user content

Definition

The laboratory test kit used for this test.

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

supportingInfo

0..*

Extension(Reference(Resource))

There are no (further) constraints on this element

Element id

Observation.extension:supportingInfo

Short description

Other information that may be relevant to this event.

Alternate names

extensions, user content

Definition

Comments

Data type

Extension(Reference(Resource))

Extension URL

http://hl7.org/fhir/StructureDefinition/workflow-supportingInfo

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

triggeredBy-r5

0..*

Extension(Complex)

There are no (further) constraints on this element

Element id

Observation.extension:triggeredBy-r5

Short description

Triggering observation(s)

Alternate names

extensions, user content

Definition

Identifies the observation(s) that triggered the performance of this observation.

Comments

Data type

Extension(Complex)

Extension URL

http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.extension:triggeredBy-r5.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

string

Mappings

rim: n/a

extension

2..*

Extension

There are no (further) constraints on this element

Element id

Observation.extension:triggeredBy-r5.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

observation

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.extension:triggeredBy-r5.extension:observation

Short description

Triggering observation.

Alternate names

extensions, user content

Definition

Reference to the triggering observation.

Comments

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.extension:triggeredBy-r5.extension:observation.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.extension:triggeredBy-r5.extension:observation.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.extension:triggeredBy-r5.extension:observation.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

observation

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Observation.extension:triggeredBy-r5.extension:observation.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

valueReference

Reference(Observation)

There are no (further) constraints on this element

Data type

Reference(Observation)

type

1..1

ExtensionBinding

There are no (further) constraints on this element

Element id

Observation.extension:triggeredBy-r5.extension:type

Short description

The type of trigger

Alternate names

extensions, user content

Definition

The type of trigger. Reflex | Repeat | Re-run.

Comments

Data type

Extension

Binding

http://hl7.org/fhir/ValueSet/observation-triggeredbytype (required)

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.extension:triggeredBy-r5.extension: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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.extension:triggeredBy-r5.extension:type.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.extension:triggeredBy-r5.extension:type.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

type

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Observation.extension:triggeredBy-r5.extension:type.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

valueCode

code

There are no (further) constraints on this element

Data type

code

reason

0..1

Extension

There are no (further) constraints on this element

Element id

Observation.extension:triggeredBy-r5.extension:reason

Short description

Reason that the observation was triggered

Alternate names

extensions, user content

Definition

Provides the reason why this observation was performed as a result of the observation(s) referenced.

Comments

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.extension:triggeredBy-r5.extension:reason.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.extension:triggeredBy-r5.extension:reason.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.extension:triggeredBy-r5.extension:reason.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

reason

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Observation.extension:triggeredBy-r5.extension:reason.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

valueString

string

There are no (further) constraints on this element

Data type

string

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.extension:triggeredBy-r5.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy

Mappings

rim: N/A

value[x]

0..0

There are no (further) constraints on this element

Element id

Observation.extension:triggeredBy-r5.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

certifiedRefMaterialCodeable

0..*

Extension(CodeableConcept)

There are no (further) constraints on this element

Element id

Observation.extension:certifiedRefMaterialCodeable

Short description

Certified Reference Material: CodeableConcept

Alternate names

extensions, user content

Definition

Comments

Data type

Extension(CodeableConcept)

Extension URL

http://hl7.eu/fhir/laboratory/StructureDefinition/observation-certifiedRefMaterialCodeable

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

certifiedRefMaterialIdentifer

0..*

Extension(Identifier)

There are no (further) constraints on this element

Element id

Observation.extension:certifiedRefMaterialIdentifer

Short description

Certified Reference Material: Identifier

Alternate names

extensions, user content

Definition

Comments

Data type

Extension(Identifier)

Extension URL

http://hl7.eu/fhir/laboratory/StructureDefinition/observation-certifiedRefMaterialIdentifer

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

labTestKit

0..*

Extension(Reference(Device))

There are no (further) constraints on this element

Element id

Observation.extension:labTestKit

Short description

Device Laboratory Test Kit

Alternate names

extensions, user content

Definition

This extension links this observation with the laboratory test kit used for this test. Usually only one laboratory test kit is referred

Comments

Data type

Extension(Reference(Device))

Extension URL

http://hl7.eu/fhir/laboratory/StructureDefinition/observation-deviceLabTestKit

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

extensionorganizer-r6

0..1

Extension(boolean)

Element id

Observation.extension:extensionorganizer-r6

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

Data type

Extension(boolean)

Extension URL

http://hl7.org/fhir/6.0/StructureDefinition/extension-Observation.organizer

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

Extension

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

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

identifier

0..*

Identifier

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

Identifier

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: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
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

Σ C

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.

Comments

Data type

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())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Event.basedOn
v2: ORC
rim: .inboundRelationship[typeCode=COMP].source[moodCode=EVN]

partOf

Σ C

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

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())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
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

Status of this observation (e.g. preliminary, final,...)

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

code

Binding

Codes providing the status of an observation.

ObservationStatus (required)

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

CodeableConceptIPSBinding

There are no (further) constraints on this element

Element id

Observation.category

Short description

Concept - reference to a terminology or just text

Definition

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

Requirements

Used for filtering what observations are retrieved and displayed.

Comments

"laboratory" includes laboratory medicine and pathology

Data type

CodeableConceptIPS

Slicing

Unordered, Open, by $this(Pattern)

Binding

Codes for high level observation categories.

ObservationCategoryCodes (preferred)

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: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
w5: FiveWs.class
rim: .outboundRelationship[typeCode="COMP].target[classCode="LIST", moodCode="EVN"].code

(All Slices)

The requirements in this element apply to all slices

0..1

string

There are no (further) constraints on this element

Element id

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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.category.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

coding

SO Σ

0..*

CodingIPS

There are no (further) constraints on this element

Element id

Observation.category.coding

Short description

A reference to a 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.

Data type

CodingIPS

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: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

0..1

string

There are no (further) constraints on this element

Element id

Observation.category.coding.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.category.coding.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

system

SO Σ

0..1

uri

There are no (further) constraints on this element

Element id

Observation.category.coding.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

uri

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: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

version

0..1

string

There are no (further) constraints on this element

Element id

Observation.category.coding.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

string

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: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

SO Σ

0..1

code

There are no (further) constraints on this element

Element id

Observation.category.coding.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

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: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

display

0..1

string

There are no (further) constraints on this element

Element id

Observation.category.coding.display

Short description

Text representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

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: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

0..1

string

There are no (further) constraints on this element

Element id

Observation.category.coding.display.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.category.coding.display.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

translation

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.category.coding.display.extension:translation

Short description

Language Translation (Localization)

Alternate names

extensions, user content

Definition

Language translation from base language of resource to another language.

Comments

Data type

Extension

Extension URL

http://hl7.org/fhir/StructureDefinition/translation|5.3.0-ballot-tc1

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
rim: ST.translation

0..1

string

There are no (further) constraints on this element

Element id

Observation.category.coding.display.extension:translation.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

string

Mappings

rim: n/a

extension

2..*

Extension

There are no (further) constraints on this element

Element id

Observation.category.coding.display.extension:translation.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

lang

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.category.coding.display.extension:translation.extension:lang

Short description

Code for Language

Alternate names

extensions, user content

Definition

Code for Language.

Comments

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.category.coding.display.extension:translation.extension:lang.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.category.coding.display.extension:translation.extension:lang.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.category.coding.display.extension:translation.extension:lang.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

lang

Mappings

rim: N/A

value[x]

1..1

Binding

There are no (further) constraints on this element

Element id

Observation.category.coding.display.extension:translation.extension:lang.value[x]

Short description

Value of extension

Definition

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

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

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
rim: N/A

valueCode

code

There are no (further) constraints on this element

Data type

code

content

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.category.coding.display.extension:translation.extension:content

Short description

Content in other Language

Alternate names

extensions, user content

Definition

Content in other Language.

Comments

The type (string or markdown) must match the context in which it is used.

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.category.coding.display.extension:translation.extension:content.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.category.coding.display.extension:translation.extension:content.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.category.coding.display.extension:translation.extension:content.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

content

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Observation.category.coding.display.extension:translation.extension:content.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

valueMarkdown

markdown

There are no (further) constraints on this element

Data type

markdown

valueString

string

There are no (further) constraints on this element

Data type

string

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.category.coding.display.extension:translation.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

http://hl7.org/fhir/StructureDefinition/translation

Mappings

rim: N/A

value[x]

0..0

There are no (further) constraints on this element

Element id

Observation.category.coding.display.extension:translation.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

value

0..1

System.String

There are no (further) constraints on this element

Element id

Observation.category.coding.display.value

Short description

Primitive value for string

Definition

Primitive value for string

Data type

System.String

Maximum string length

1048576

userSelected

0..1

boolean

There are no (further) constraints on this element

Element id

Observation.category.coding.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

boolean

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: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

text

SO Σ

0..1

string

There are no (further) constraints on this element

Element id

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

Comments

Very often the text is the same as a displayName of one of the codings.

Data type

string

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

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

0..1

string

There are no (further) constraints on this element

Element id

Observation.category.text.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.category.text.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

translation

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.category.text.extension:translation

Short description

Language Translation (Localization)

Alternate names

extensions, user content

Definition

Language translation from base language of resource to another language.

Comments

Data type

Extension

Extension URL

http://hl7.org/fhir/StructureDefinition/translation|5.3.0-ballot-tc1

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
rim: ST.translation

0..1

string

There are no (further) constraints on this element

Element id

Observation.category.text.extension:translation.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

string

Mappings

rim: n/a

extension

2..*

Extension

There are no (further) constraints on this element

Element id

Observation.category.text.extension:translation.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

lang

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.category.text.extension:translation.extension:lang

Short description

Code for Language

Alternate names

extensions, user content

Definition

Code for Language.

Comments

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.category.text.extension:translation.extension:lang.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.category.text.extension:translation.extension:lang.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.category.text.extension:translation.extension:lang.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

lang

Mappings

rim: N/A

value[x]

1..1

Binding

There are no (further) constraints on this element

Element id

Observation.category.text.extension:translation.extension:lang.value[x]

Short description

Value of extension

Definition

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

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

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
rim: N/A

valueCode

code

There are no (further) constraints on this element

Data type

code

content

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.category.text.extension:translation.extension:content

Short description

Content in other Language

Alternate names

extensions, user content

Definition

Content in other Language.

Comments

The type (string or markdown) must match the context in which it is used.

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.category.text.extension:translation.extension:content.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.category.text.extension:translation.extension:content.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.category.text.extension:translation.extension:content.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

content

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Observation.category.text.extension:translation.extension:content.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

valueMarkdown

markdown

There are no (further) constraints on this element

Data type

markdown

valueString

string

There are no (further) constraints on this element

Data type

string

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.category.text.extension:translation.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

http://hl7.org/fhir/StructureDefinition/translation

Mappings

rim: N/A

value[x]

0..0

There are no (further) constraints on this element

Element id

Observation.category.text.extension:translation.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

value

0..1

System.String

There are no (further) constraints on this element

Element id

Observation.category.text.value

Short description

Primitive value for string

Definition

Primitive value for string

Data type

System.String

Maximum string length

1048576

laboratory

1..1

CodeableConceptBindingPattern

There are no (further) constraints on this element

Element id

Observation.category:laboratory

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

CodeableConcept

Binding

Codes for high level observation categories.

ObservationCategoryCodes (preferred)

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

Pattern

{
  "coding": [
    {
      "system": "http://terminology.hl7.org/CodeSystem/observation-category",
      "code": "laboratory"
    }
  ]
}

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
w5: FiveWs.class
rim: .outboundRelationship[typeCode="COMP].target[classCode="LIST", moodCode="EVN"].code

studyType

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.category:studyType

Short description

The way of grouping of the test results into clinically meaningful domains (e.g. hematology study, microbiology study, etc.)

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

CodeableConcept

Binding

Codes for high level observation categories.

LabStudyTypesEuVs (required)

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: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
w5: FiveWs.class
rim: .outboundRelationship[typeCode="COMP].target[classCode="LIST", moodCode="EVN"].code

specialty

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.category:specialty

Short description

The clinical domain of the laboratory performing the observation (e.g. microbiology, toxicology, chemistry)

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

CodeableConcept

Binding

Codes for high level observation categories.

LabSpecialtyEuVs (required)

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: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
w5: FiveWs.class
rim: .outboundRelationship[typeCode="COMP].target[classCode="LIST", moodCode="EVN"].code

code

1..1

CodeableConceptIPSBinding

There are no (further) constraints on this element

Element id

Observation.code

Short description

Concept - reference to a terminology or just text

Alternate names

Name

Definition

Requirements

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

Comments

Data type

CodeableConceptIPS

Binding

Codes identifying names of simple observations.

LaboratoryResultStandardEuVs (preferred)

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: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
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|

0..1

string

There are no (further) constraints on this element

Element id

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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.code.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

coding

SO Σ

0..*

CodingIPS

Element id

Observation.code.coding

Short description

A reference to a 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.

Data type

CodingIPS

Slicing

Unordered, Open, by

Slicing for Pathology to differentiate between the SNOMED CT ValueSets, PaLM and PCBL

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: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

(All Slices)

The requirements in this element apply to all slices

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.coding.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

reference

0..1

Extension(uri)

Element id

Observation.code.coding.extension:reference

Short description

Url of Value set the code was chosen from

Alternate names

extensions, user content

Definition

A logical reference (e.g. a reference to ValueSet.url) that identifies the value set/version that identifies the set of possible coded values this coding was chosen from or constrained by.

Comments

If this extension is used with an extensible binding, and the concept comes from outside the bound valueset, the value set SHALL be different from the bound valueset.

Data type

Extension(uri)

Extension URL

http://hl7.org/fhir/StructureDefinition/valueset-reference

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
v2: CWE.
rim: CD.valueSet/CD.valueSetVersion

system

SO Σ

0..1

uri

There are no (further) constraints on this element

Element id

Observation.code.coding.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

uri

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: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

version

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.coding.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

string

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: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

SO Σ

0..1

code

There are no (further) constraints on this element

Element id

Observation.code.coding.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

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: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

display

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.coding.display

Short description

Text representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

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: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.coding.display.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding.display.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

translation

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding.display.extension:translation

Short description

Language Translation (Localization)

Alternate names

extensions, user content

Definition

Language translation from base language of resource to another language.

Comments

Data type

Extension

Extension URL

http://hl7.org/fhir/StructureDefinition/translation|5.3.0-ballot-tc1

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
rim: ST.translation

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.coding.display.extension:translation.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

string

Mappings

rim: n/a

extension

2..*

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding.display.extension:translation.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

lang

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding.display.extension:translation.extension:lang

Short description

Code for Language

Alternate names

extensions, user content

Definition

Code for Language.

Comments

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.coding.display.extension:translation.extension:lang.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding.display.extension:translation.extension:lang.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.code.coding.display.extension:translation.extension:lang.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

lang

Mappings

rim: N/A

value[x]

1..1

Binding

There are no (further) constraints on this element

Element id

Observation.code.coding.display.extension:translation.extension:lang.value[x]

Short description

Value of extension

Definition

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

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

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
rim: N/A

valueCode

code

There are no (further) constraints on this element

Data type

code

content

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding.display.extension:translation.extension:content

Short description

Content in other Language

Alternate names

extensions, user content

Definition

Content in other Language.

Comments

The type (string or markdown) must match the context in which it is used.

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.coding.display.extension:translation.extension:content.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding.display.extension:translation.extension:content.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.code.coding.display.extension:translation.extension:content.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

content

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Observation.code.coding.display.extension:translation.extension:content.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

valueMarkdown

markdown

There are no (further) constraints on this element

Data type

markdown

valueString

string

There are no (further) constraints on this element

Data type

string

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.code.coding.display.extension:translation.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

http://hl7.org/fhir/StructureDefinition/translation

Mappings

rim: N/A

value[x]

0..0

There are no (further) constraints on this element

Element id

Observation.code.coding.display.extension:translation.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

value

0..1

System.String

There are no (further) constraints on this element

Element id

Observation.code.coding.display.value

Short description

Primitive value for string

Definition

Primitive value for string

Data type

System.String

Maximum string length

1048576

userSelected

0..1

boolean

There are no (further) constraints on this element

Element id

Observation.code.coding.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

boolean

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: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

pathology-PaLM

SO Σ

0..*

CodingIPSBinding

Element id

Observation.code.coding:pathology-PaLM

Short description

A reference to a 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.

Data type

CodingIPS

Binding

This slice is to denote the code comes from the Pathology and laboratory medicine observable entity simple reference set

EnglandPathologyAndLaboratoryMedicineObservables (extensible)

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: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

reference-palm-observables

0..1

Extension(uri)

Element id

Observation.code.coding:pathology-PaLM.extension:reference-palm-observables

Short description

Url of Value set the code was chosen from

Alternate names

extensions, user content

Definition

A logical reference (e.g. a reference to ValueSet.url) that identifies the value set/version that identifies the set of possible coded values this coding was chosen from or constrained by.

Comments

If this extension is used with an extensible binding, and the concept comes from outside the bound valueset, the value set SHALL be different from the bound valueset.

Data type

Extension(uri)

Extension URL

http://hl7.org/fhir/StructureDefinition/valueset-reference

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
v2: CWE.
rim: CD.valueSet/CD.valueSetVersion

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.extension:reference-palm-observables.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.extension:reference-palm-observables.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.extension:reference-palm-observables.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

http://hl7.org/fhir/StructureDefinition/valueset-reference

Mappings

rim: N/A

value[x]

1..1

Fixed Value

Element id

Observation.code.coding:pathology-PaLM.extension:reference-palm-observables.value[x]

Short description

Value of extension

Definition

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

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

Fixed value

https://fhir.nhs.uk/England/ValueSet/England-PathologyAndLaboratoryMedicineObservables

Mappings

rim: n/a
rim: N/A

valueUri

uri

There are no (further) constraints on this element

Data type

uri

system

SO Σ

0..1

uri

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

uri

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: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

version

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

string

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: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

SO Σ

0..1

code

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

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: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

display

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.display

Short description

Text representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

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: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.display.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.display.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

translation

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.display.extension:translation

Short description

Language Translation (Localization)

Alternate names

extensions, user content

Definition

Language translation from base language of resource to another language.

Comments

Data type

Extension

Extension URL

http://hl7.org/fhir/StructureDefinition/translation|5.3.0-ballot-tc1

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
rim: ST.translation

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.display.extension:translation.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

string

Mappings

rim: n/a

extension

2..*

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.display.extension:translation.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

lang

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.display.extension:translation.extension:lang

Short description

Code for Language

Alternate names

extensions, user content

Definition

Code for Language.

Comments

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.display.extension:translation.extension:lang.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.display.extension:translation.extension:lang.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.display.extension:translation.extension:lang.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

lang

Mappings

rim: N/A

value[x]

1..1

Binding

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.display.extension:translation.extension:lang.value[x]

Short description

Value of extension

Definition

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

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

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
rim: N/A

valueCode

code

There are no (further) constraints on this element

Data type

code

content

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.display.extension:translation.extension:content

Short description

Content in other Language

Alternate names

extensions, user content

Definition

Content in other Language.

Comments

The type (string or markdown) must match the context in which it is used.

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.display.extension:translation.extension:content.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.display.extension:translation.extension:content.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.display.extension:translation.extension:content.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

content

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.display.extension:translation.extension:content.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

valueMarkdown

markdown

There are no (further) constraints on this element

Data type

markdown

valueString

string

There are no (further) constraints on this element

Data type

string

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.display.extension:translation.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

http://hl7.org/fhir/StructureDefinition/translation

Mappings

rim: N/A

value[x]

0..0

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.display.extension:translation.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

value

0..1

System.String

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.display.value

Short description

Primitive value for string

Definition

Primitive value for string

Data type

System.String

Maximum string length

1048576

userSelected

0..1

boolean

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PaLM.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

boolean

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: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

pathology-PBCL

SO Σ

0..*

CodingIPSBinding

Element id

Observation.code.coding:pathology-PBCL

Short description

A reference to a 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.

Data type

CodingIPS

Binding

This slice is to denote the code comes from the Pathology Bounded Code List observables simple reference set

EnglandPathologyBoundedCodeListObservables (extensible)

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: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

reference-pbcl-observables

0..1

Extension(uri)

Element id

Observation.code.coding:pathology-PBCL.extension:reference-pbcl-observables

Short description

Url of Value set the code was chosen from

Alternate names

extensions, user content

Definition

A logical reference (e.g. a reference to ValueSet.url) that identifies the value set/version that identifies the set of possible coded values this coding was chosen from or constrained by.

Comments

If this extension is used with an extensible binding, and the concept comes from outside the bound valueset, the value set SHALL be different from the bound valueset.

Data type

Extension(uri)

Extension URL

http://hl7.org/fhir/StructureDefinition/valueset-reference

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
v2: CWE.
rim: CD.valueSet/CD.valueSetVersion

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.extension:reference-pbcl-observables.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.extension:reference-pbcl-observables.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.extension:reference-pbcl-observables.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

http://hl7.org/fhir/StructureDefinition/valueset-reference

Mappings

rim: N/A

value[x]

1..1

Fixed Value

Element id

Observation.code.coding:pathology-PBCL.extension:reference-pbcl-observables.value[x]

Short description

Value of extension

Definition

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

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

Fixed value

https://fhir.nhs.uk/England/ValueSet/England-PathologyBoundedCodeListObservables

Mappings

rim: n/a
rim: N/A

valueUri

uri

There are no (further) constraints on this element

Data type

uri

system

SO Σ

0..1

uri

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

uri

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: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

version

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

string

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: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

SO Σ

0..1

code

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

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: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

display

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.display

Short description

Text representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

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: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.display.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.display.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

translation

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.display.extension:translation

Short description

Language Translation (Localization)

Alternate names

extensions, user content

Definition

Language translation from base language of resource to another language.

Comments

Data type

Extension

Extension URL

http://hl7.org/fhir/StructureDefinition/translation|5.3.0-ballot-tc1

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
rim: ST.translation

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.display.extension:translation.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

string

Mappings

rim: n/a

extension

2..*

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.display.extension:translation.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

lang

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.display.extension:translation.extension:lang

Short description

Code for Language

Alternate names

extensions, user content

Definition

Code for Language.

Comments

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.display.extension:translation.extension:lang.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.display.extension:translation.extension:lang.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.display.extension:translation.extension:lang.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

lang

Mappings

rim: N/A

value[x]

1..1

Binding

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.display.extension:translation.extension:lang.value[x]

Short description

Value of extension

Definition

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

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

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
rim: N/A

valueCode

code

There are no (further) constraints on this element

Data type

code

content

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.display.extension:translation.extension:content

Short description

Content in other Language

Alternate names

extensions, user content

Definition

Content in other Language.

Comments

The type (string or markdown) must match the context in which it is used.

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.display.extension:translation.extension:content.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.display.extension:translation.extension:content.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.display.extension:translation.extension:content.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

content

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.display.extension:translation.extension:content.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

valueMarkdown

markdown

There are no (further) constraints on this element

Data type

markdown

valueString

string

There are no (further) constraints on this element

Data type

string

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.display.extension:translation.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

http://hl7.org/fhir/StructureDefinition/translation

Mappings

rim: N/A

value[x]

0..0

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.display.extension:translation.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

value

0..1

System.String

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.display.value

Short description

Primitive value for string

Definition

Primitive value for string

Data type

System.String

Maximum string length

1048576

userSelected

0..1

boolean

There are no (further) constraints on this element

Element id

Observation.code.coding:pathology-PBCL.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

boolean

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: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

text

SO Σ

0..1

string

There are no (further) constraints on this element

Element id

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

Comments

Very often the text is the same as a displayName of one of the codings.

Data type

string

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

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.text.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.code.text.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

translation

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.code.text.extension:translation

Short description

Language Translation (Localization)

Alternate names

extensions, user content

Definition

Language translation from base language of resource to another language.

Comments

Data type

Extension

Extension URL

http://hl7.org/fhir/StructureDefinition/translation|5.3.0-ballot-tc1

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
rim: ST.translation

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.text.extension:translation.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

string

Mappings

rim: n/a

extension

2..*

Extension

There are no (further) constraints on this element

Element id

Observation.code.text.extension:translation.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

lang

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.code.text.extension:translation.extension:lang

Short description

Code for Language

Alternate names

extensions, user content

Definition

Code for Language.

Comments

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.text.extension:translation.extension:lang.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.code.text.extension:translation.extension:lang.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.code.text.extension:translation.extension:lang.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

lang

Mappings

rim: N/A

value[x]

1..1

Binding

There are no (further) constraints on this element

Element id

Observation.code.text.extension:translation.extension:lang.value[x]

Short description

Value of extension

Definition

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

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

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
rim: N/A

valueCode

code

There are no (further) constraints on this element

Data type

code

content

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.code.text.extension:translation.extension:content

Short description

Content in other Language

Alternate names

extensions, user content

Definition

Content in other Language.

Comments

The type (string or markdown) must match the context in which it is used.

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.code.text.extension:translation.extension:content.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.code.text.extension:translation.extension:content.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.code.text.extension:translation.extension:content.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

content

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Observation.code.text.extension:translation.extension:content.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

valueMarkdown

markdown

There are no (further) constraints on this element

Data type

markdown

valueString

string

There are no (further) constraints on this element

Data type

string

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.code.text.extension:translation.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

http://hl7.org/fhir/StructureDefinition/translation

Mappings

rim: N/A

value[x]

0..0

There are no (further) constraints on this element

Element id

Observation.code.text.extension:translation.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

value

0..1

System.String

There are no (further) constraints on this element

Element id

Observation.code.text.value

Short description

Primitive value for string

Definition

Primitive value for string

Data type

System.String

Maximum string length

1048576

subject

Σ C

1..1

Reference(PatientEuCore | PatientAnimalEu | Device | Group | Location)

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

Reference(PatientEuCore | PatientAnimalEu | Device | Group | Location)

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())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Event.subject
w5: FiveWs.subject[x]
v2: PID-3
rim: participation[typeCode=RTGT]
w5: FiveWs.subject

focus

Σ C

0..*

Reference(Resource)

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

Reference(Resource)

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())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.subject[x]
v2: OBX-3
rim: participation[typeCode=SBJ]
w5: FiveWs.subject

encounter

Σ C

0..1

Reference(Encounter)

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

Reference(Encounter)

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())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Event.context
w5: FiveWs.context
v2: PV1
rim: inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]

effective[x]

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

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

dateTime

There are no (further) constraints on this element

Data type

dateTime

effectiveInstant

instant

There are no (further) constraints on this element

Data type

instant

effectivePeriod

Period

There are no (further) constraints on this element

Data type

Period

effectiveTiming

Timing

There are no (further) constraints on this element

Data type

Timing

issued

0..1

instant

There are no (further) constraints on this element

Element id

Observation.issued

Short description

Date/Time this result 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

instant

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

performer

Σ C

1..*

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.

Comments

Data type

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())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
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]

0..1

string

There are no (further) constraints on this element

Element id

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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.performer.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

performerFunction

0..1

Extension(CodeableConcept)

There are no (further) constraints on this element

Element id

Observation.performer.extension:performerFunction

Short description

Type of performance

Alternate names

extensions, user content

Definition

Distinguishes the type of involvement of the performer in the event. For example, 'author', 'verifier' or 'responsible party'.

Comments

Data type

Extension(CodeableConcept)

Extension URL

http://hl7.org/fhir/StructureDefinition/event-performerFunction

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
workflow: Event.performer.function

reference

Σ C

0..1

string

There are no (further) constraints on this element

Element id

Observation.performer.reference

Short description

Literal reference, Relative, internal or absolute URL

Definition

Comments

Data type

string

Conditions

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

Constraints

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

Mappings

rim: n/a
rim: N/A

type

0..1

uriBinding

There are no (further) constraints on this element

Element id

Observation.performer.type

Short description

Type the reference refers to (e.g. "Patient")

Definition

The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

Comments

Data type

uri

Binding

Aa resource (or, for logical models, the URI of the logical model).

ResourceType (extensible)

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
rim: N/A

identifier

0..1

Identifier

There are no (further) constraints on this element

Element id

Observation.performer.identifier

Short description

Logical reference, when literal reference is not known

Definition

Comments

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Data type

Identifier

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: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
rim: .identifier

display

0..1

string

There are no (further) constraints on this element

Element id

Observation.performer.display

Short description

Text alternative for the resource

Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Data type

string

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
rim: N/A

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

Slicing

Unordered, Closed, by $this(Type)

Conditions

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

Constraints

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

Mappings

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

valueBoolean

boolean

There are no (further) constraints on this element

Data type

boolean

valueInteger

integer

There are no (further) constraints on this element

Data type

integer

valueSampledData

SampledData

There are no (further) constraints on this element

Data type

SampledData

valueString

Σ C

0..1

string

There are no (further) constraints on this element

Element id

Observation.value[x]:valueString

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

Data type

string

Conditions

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

Constraints

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

Mappings

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

valueRange

Σ C

0..1

RangeEuLab

There are no (further) constraints on this element

Element id

Observation.value[x]:valueRange

Short description

A measured range using UCUM

Definition

A measured range (or a range that can potentially be measured) and uncertainty of the measurement. This profile imposes that the code system for units be UCUM.

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

The stated low and high value are assumed to have arbitrarily high precision when it comes to determining which values are in the range. I.e. 1.99 is not in the range 2 -> 3.

Data type

RangeEuLab

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
rng-2: If present, low SHALL have a lower value than high
low.empty() or high.empty() or (low <= high)

Mappings

rim: n/a
sct-concept: < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|
v2: NR and also possibly SN (but see also quantity)
rim: IVL<QTY[not(type="TS")]> [lowClosed="true" and highClosed="true"]or URG<QTY[not(type="TS")]>

valueRatio

Σ C

0..1

RatioEuLab

There are no (further) constraints on this element

Element id

Observation.value[x]:valueRatio

Short description

A measured ratio using UCUM

Definition

A measured ratio (or a ratio that can potentially be measured) and uncertainty of the measurement. This profile imposes that the code system for units be UCUM.

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

RatioEuLab

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present
(numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists())

Mappings

rim: n/a
sct-concept: < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|
v2: N/A
rim: RTO

valueTime

Σ C

0..1

time

There are no (further) constraints on this element

Element id

Observation.value[x]:valueTime

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

Data type

time

Conditions

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

Constraints

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

Mappings

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

valueDateTime

Σ C

0..1

dateTime

There are no (further) constraints on this element

Element id

Observation.value[x]:valueDateTime

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

Data type

dateTime

Conditions

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

Constraints

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

Mappings

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

valuePeriod

Σ C

0..1

Period

There are no (further) constraints on this element

Element id

Observation.value[x]:valuePeriod

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

Data type

Period

Conditions

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

Constraints

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

Mappings

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

valueQuantity

Σ C

0..1

QuantityEuLab

There are no (further) constraints on this element

Element id

Observation.value[x]:valueQuantity

Short description

A measured amount using UCUM

Definition

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

The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.

Data type

QuantityEuLab

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
qty-3: If a code for the unit is present, the system SHALL also be present
code.empty() or system.exists()

Mappings

rim: n/a
sct-concept: < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|
v2: SN (see also Range) or CQ
rim: PQ, IVL<PQ>, MO, CO, depending on the values

valueCodeableConcept

Σ C

0..1

CodeableConceptIPSBinding

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept

Short description

Concept - reference to a terminology or just text

Definition

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

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

CodeableConceptIPS

Binding

ResultsCodedValuesLaboratoryPathologyUvIps (preferred)

Additional bindings

http://hl7.org/fhir/uv/ips/ValueSet/results-blood-group-snomed-ct-ips-free-set (candidate)
Additional conformance binding to a blood group findings value set for laboratory result values from the SNOMED CT IPS free set for use globally (in SNOMED member and non-member jurisdictions).
http://hl7.org/fhir/uv/ips/ValueSet/results-presence-absence-snomed-ct-ips-free-set (candidate)
Additional conformance binding to a presence and absence findings (qualifier values) value set for laboratory result values from the SNOMED CT IPS free set for use globally (in SNOMED member and non-member jurisdictions).
http://hl7.org/fhir/uv/ips/ValueSet/results-microorganism-snomed-ct-ips-free-set (candidate)
Additional conformance binding to a microorganisms value set for laboratory result values from the SNOMED CT IPS free set for use globally (in SNOMED member and non-member jurisdictions).

Conditions

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

Constraints

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

Mappings

rim: n/a
sct-concept: < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD

0..1

string

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

coding

SO Σ

0..*

CodingIPS

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding

Short description

A reference to a 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.

Data type

CodingIPS

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: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

0..1

string

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

system

SO Σ

0..1

uri

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

uri

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: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

version

0..1

string

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

string

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: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

SO Σ

0..1

code

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

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: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

display

0..1

string

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.display

Short description

Text representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

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: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

0..1

string

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.display.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.display.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

translation

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.display.extension:translation

Short description

Language Translation (Localization)

Alternate names

extensions, user content

Definition

Language translation from base language of resource to another language.

Comments

Data type

Extension

Extension URL

http://hl7.org/fhir/StructureDefinition/translation|5.3.0-ballot-tc1

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
rim: ST.translation

0..1

string

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.display.extension:translation.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

string

Mappings

rim: n/a

extension

2..*

Extension

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.display.extension:translation.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

lang

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.display.extension:translation.extension:lang

Short description

Code for Language

Alternate names

extensions, user content

Definition

Code for Language.

Comments

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.display.extension:translation.extension:lang.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.display.extension:translation.extension:lang.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.display.extension:translation.extension:lang.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

lang

Mappings

rim: N/A

value[x]

1..1

Binding

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.display.extension:translation.extension:lang.value[x]

Short description

Value of extension

Definition

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

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

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
rim: N/A

valueCode

code

There are no (further) constraints on this element

Data type

code

content

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.display.extension:translation.extension:content

Short description

Content in other Language

Alternate names

extensions, user content

Definition

Content in other Language.

Comments

The type (string or markdown) must match the context in which it is used.

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.display.extension:translation.extension:content.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.display.extension:translation.extension:content.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.display.extension:translation.extension:content.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

content

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.display.extension:translation.extension:content.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

valueMarkdown

markdown

There are no (further) constraints on this element

Data type

markdown

valueString

string

There are no (further) constraints on this element

Data type

string

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.display.extension:translation.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

http://hl7.org/fhir/StructureDefinition/translation

Mappings

rim: N/A

value[x]

0..0

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.display.extension:translation.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

value

0..1

System.String

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.display.value

Short description

Primitive value for string

Definition

Primitive value for string

Data type

System.String

Maximum string length

1048576

userSelected

0..1

boolean

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.coding.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

boolean

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: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

text

SO Σ

0..1

string

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.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

Comments

Very often the text is the same as a displayName of one of the codings.

Data type

string

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

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

0..1

string

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.text.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.text.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

translation

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.text.extension:translation

Short description

Language Translation (Localization)

Alternate names

extensions, user content

Definition

Language translation from base language of resource to another language.

Comments

Data type

Extension

Extension URL

http://hl7.org/fhir/StructureDefinition/translation|5.3.0-ballot-tc1

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
rim: ST.translation

0..1

string

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.text.extension:translation.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

string

Mappings

rim: n/a

extension

2..*

Extension

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.text.extension:translation.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

lang

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.text.extension:translation.extension:lang

Short description

Code for Language

Alternate names

extensions, user content

Definition

Code for Language.

Comments

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.text.extension:translation.extension:lang.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.text.extension:translation.extension:lang.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.text.extension:translation.extension:lang.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

lang

Mappings

rim: N/A

value[x]

1..1

Binding

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.text.extension:translation.extension:lang.value[x]

Short description

Value of extension

Definition

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

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

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
rim: N/A

valueCode

code

There are no (further) constraints on this element

Data type

code

content

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.text.extension:translation.extension:content

Short description

Content in other Language

Alternate names

extensions, user content

Definition

Content in other Language.

Comments

The type (string or markdown) must match the context in which it is used.

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.text.extension:translation.extension:content.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.text.extension:translation.extension:content.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.text.extension:translation.extension:content.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

content

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.text.extension:translation.extension:content.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

valueMarkdown

markdown

There are no (further) constraints on this element

Data type

markdown

valueString

string

There are no (further) constraints on this element

Data type

string

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.text.extension:translation.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

http://hl7.org/fhir/StructureDefinition/translation

Mappings

rim: N/A

value[x]

0..0

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.text.extension:translation.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

value

0..1

System.String

There are no (further) constraints on this element

Element id

Observation.value[x]:valueCodeableConcept.text.value

Short description

Primitive value for string

Definition

Primitive value for string

Data type

System.String

Maximum string length

1048576

dataAbsentReason

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Observation.dataAbsentReason

Short description

Provides a reason why the expected value 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

CodeableConcept

Binding

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

DataAbsentReason (extensible)

Conditions

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

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: N/A
rim: value.nullFlavor

interpretation

0..*

CodeableConceptIPSBinding

Element id

Observation.interpretation

Short description

Concept - reference to a terminology or just text

Alternate names

Abnormal Flag

Definition

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

Requirements

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

Comments

Data type

CodeableConceptIPS

Binding

Codes identifying interpretations of observations.

EnglandDeviatingResultIndicator (extensible)

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: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
sct-concept: < 260245000 |Findings values|
v2: OBX-8
rim: interpretationCode
sct-attr: 363713009 |Has interpretation|

0..1

string

There are no (further) constraints on this element

Element id

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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.interpretation.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

coding

SO Σ

0..*

CodingIPS

There are no (further) constraints on this element

Element id

Observation.interpretation.coding

Short description

A reference to a 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.

Data type

CodingIPS

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: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

0..1

string

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

system

SO Σ

0..1

uri

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

uri

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: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

version

0..1

string

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

string

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: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

SO Σ

0..1

code

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

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: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

display

0..1

string

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.display

Short description

Text representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

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: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

0..1

string

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.display.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.display.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

translation

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.display.extension:translation

Short description

Language Translation (Localization)

Alternate names

extensions, user content

Definition

Language translation from base language of resource to another language.

Comments

Data type

Extension

Extension URL

http://hl7.org/fhir/StructureDefinition/translation|5.3.0-ballot-tc1

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
rim: ST.translation

0..1

string

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.display.extension:translation.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

string

Mappings

rim: n/a

extension

2..*

Extension

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.display.extension:translation.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

lang

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.display.extension:translation.extension:lang

Short description

Code for Language

Alternate names

extensions, user content

Definition

Code for Language.

Comments

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.display.extension:translation.extension:lang.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.display.extension:translation.extension:lang.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.display.extension:translation.extension:lang.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

lang

Mappings

rim: N/A

value[x]

1..1

Binding

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.display.extension:translation.extension:lang.value[x]

Short description

Value of extension

Definition

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

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

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
rim: N/A

valueCode

code

There are no (further) constraints on this element

Data type

code

content

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.display.extension:translation.extension:content

Short description

Content in other Language

Alternate names

extensions, user content

Definition

Content in other Language.

Comments

The type (string or markdown) must match the context in which it is used.

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.display.extension:translation.extension:content.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.display.extension:translation.extension:content.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.display.extension:translation.extension:content.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

content

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.display.extension:translation.extension:content.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

valueMarkdown

markdown

There are no (further) constraints on this element

Data type

markdown

valueString

string

There are no (further) constraints on this element

Data type

string

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.display.extension:translation.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

http://hl7.org/fhir/StructureDefinition/translation

Mappings

rim: N/A

value[x]

0..0

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.display.extension:translation.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

value

0..1

System.String

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.display.value

Short description

Primitive value for string

Definition

Primitive value for string

Data type

System.String

Maximum string length

1048576

userSelected

0..1

boolean

There are no (further) constraints on this element

Element id

Observation.interpretation.coding.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

boolean

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: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

text

SO Σ

0..1

string

There are no (further) constraints on this element

Element id

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

Comments

Very often the text is the same as a displayName of one of the codings.

Data type

string

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

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

0..1

string

There are no (further) constraints on this element

Element id

Observation.interpretation.text.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.interpretation.text.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

translation

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.interpretation.text.extension:translation

Short description

Language Translation (Localization)

Alternate names

extensions, user content

Definition

Language translation from base language of resource to another language.

Comments

Data type

Extension

Extension URL

http://hl7.org/fhir/StructureDefinition/translation|5.3.0-ballot-tc1

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
rim: ST.translation

0..1

string

There are no (further) constraints on this element

Element id

Observation.interpretation.text.extension:translation.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

string

Mappings

rim: n/a

extension

2..*

Extension

There are no (further) constraints on this element

Element id

Observation.interpretation.text.extension:translation.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

lang

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.interpretation.text.extension:translation.extension:lang

Short description

Code for Language

Alternate names

extensions, user content

Definition

Code for Language.

Comments

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.interpretation.text.extension:translation.extension:lang.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.interpretation.text.extension:translation.extension:lang.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.interpretation.text.extension:translation.extension:lang.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

lang

Mappings

rim: N/A

value[x]

1..1

Binding

There are no (further) constraints on this element

Element id

Observation.interpretation.text.extension:translation.extension:lang.value[x]

Short description

Value of extension

Definition

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

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

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
rim: N/A

valueCode

code

There are no (further) constraints on this element

Data type

code

content

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.interpretation.text.extension:translation.extension:content

Short description

Content in other Language

Alternate names

extensions, user content

Definition

Content in other Language.

Comments

The type (string or markdown) must match the context in which it is used.

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.interpretation.text.extension:translation.extension:content.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.interpretation.text.extension:translation.extension:content.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.interpretation.text.extension:translation.extension:content.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

content

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Observation.interpretation.text.extension:translation.extension:content.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

valueMarkdown

markdown

There are no (further) constraints on this element

Data type

markdown

valueString

string

There are no (further) constraints on this element

Data type

string

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.interpretation.text.extension:translation.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

http://hl7.org/fhir/StructureDefinition/translation

Mappings

rim: N/A

value[x]

0..0

There are no (further) constraints on this element

Element id

Observation.interpretation.text.extension:translation.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

value

0..1

System.String

There are no (further) constraints on this element

Element id

Observation.interpretation.text.value

Short description

Primitive value for string

Definition

Primitive value for string

Data type

System.String

Maximum string length

1048576

note

0..*

Annotation

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

Annotation

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
v2: NTE.3 (partner NTE to OBX, or sometimes another (child?) OBX)
rim: subjectOf.observationEvent[code="annotation"].value

bodySite

0..1

CodeableConcept

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

CodeableConcept

Binding

Codes describing anatomical locations. May include laterality.

SNOMEDCTBodyStructures (example)

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: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
sct-concept: < 123037004 |Body structure|
v2: OBX-20
rim: targetSiteCode
sct-attr: 718497002 |Inherent location|

method

0..1

CodeableConceptIPSBinding

There are no (further) constraints on this element

Element id

Observation.method

Short description

Concept - reference to a terminology or just text

Definition

Laboratory technigue that has been used

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

Data type

CodeableConceptIPS

Binding

Methods for simple observations.

LabTechniqueEuVs (preferred)

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: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: OBX-17
rim: methodCode

0..1

string

There are no (further) constraints on this element

Element id

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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.method.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

coding

SO Σ

0..*

CodingIPS

There are no (further) constraints on this element

Element id

Observation.method.coding

Short description

A reference to a 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.

Data type

CodingIPS

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: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

0..1

string

There are no (further) constraints on this element

Element id

Observation.method.coding.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.method.coding.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

system

SO Σ

0..1

uri

There are no (further) constraints on this element

Element id

Observation.method.coding.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

uri

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: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

version

0..1

string

There are no (further) constraints on this element

Element id

Observation.method.coding.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

string

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: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

SO Σ

0..1

code

There are no (further) constraints on this element

Element id

Observation.method.coding.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

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: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

display

0..1

string

There are no (further) constraints on this element

Element id

Observation.method.coding.display

Short description

Text representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

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: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

0..1

string

There are no (further) constraints on this element

Element id

Observation.method.coding.display.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.method.coding.display.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

translation

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.method.coding.display.extension:translation

Short description

Language Translation (Localization)

Alternate names

extensions, user content

Definition

Language translation from base language of resource to another language.

Comments

Data type

Extension

Extension URL

http://hl7.org/fhir/StructureDefinition/translation|5.3.0-ballot-tc1

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
rim: ST.translation

0..1

string

There are no (further) constraints on this element

Element id

Observation.method.coding.display.extension:translation.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

string

Mappings

rim: n/a

extension

2..*

Extension

There are no (further) constraints on this element

Element id

Observation.method.coding.display.extension:translation.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

lang

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.method.coding.display.extension:translation.extension:lang

Short description

Code for Language

Alternate names

extensions, user content

Definition

Code for Language.

Comments

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.method.coding.display.extension:translation.extension:lang.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.method.coding.display.extension:translation.extension:lang.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.method.coding.display.extension:translation.extension:lang.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

lang

Mappings

rim: N/A

value[x]

1..1

Binding

There are no (further) constraints on this element

Element id

Observation.method.coding.display.extension:translation.extension:lang.value[x]

Short description

Value of extension

Definition

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

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

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
rim: N/A

valueCode

code

There are no (further) constraints on this element

Data type

code

content

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.method.coding.display.extension:translation.extension:content

Short description

Content in other Language

Alternate names

extensions, user content

Definition

Content in other Language.

Comments

The type (string or markdown) must match the context in which it is used.

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.method.coding.display.extension:translation.extension:content.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.method.coding.display.extension:translation.extension:content.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.method.coding.display.extension:translation.extension:content.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

content

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Observation.method.coding.display.extension:translation.extension:content.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

valueMarkdown

markdown

There are no (further) constraints on this element

Data type

markdown

valueString

string

There are no (further) constraints on this element

Data type

string

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.method.coding.display.extension:translation.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

http://hl7.org/fhir/StructureDefinition/translation

Mappings

rim: N/A

value[x]

0..0

There are no (further) constraints on this element

Element id

Observation.method.coding.display.extension:translation.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

value

0..1

System.String

There are no (further) constraints on this element

Element id

Observation.method.coding.display.value

Short description

Primitive value for string

Definition

Primitive value for string

Data type

System.String

Maximum string length

1048576

userSelected

0..1

boolean

There are no (further) constraints on this element

Element id

Observation.method.coding.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

boolean

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: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

text

SO Σ

0..1

string

There are no (further) constraints on this element

Element id

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

Comments

Very often the text is the same as a displayName of one of the codings.

Data type

string

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

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

0..1

string

There are no (further) constraints on this element

Element id

Observation.method.text.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.method.text.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

translation

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.method.text.extension:translation

Short description

Language Translation (Localization)

Alternate names

extensions, user content

Definition

Language translation from base language of resource to another language.

Comments

Data type

Extension

Extension URL

http://hl7.org/fhir/StructureDefinition/translation|5.3.0-ballot-tc1

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
rim: ST.translation

0..1

string

There are no (further) constraints on this element

Element id

Observation.method.text.extension:translation.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

string

Mappings

rim: n/a

extension

2..*

Extension

There are no (further) constraints on this element

Element id

Observation.method.text.extension:translation.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

lang

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.method.text.extension:translation.extension:lang

Short description

Code for Language

Alternate names

extensions, user content

Definition

Code for Language.

Comments

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.method.text.extension:translation.extension:lang.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.method.text.extension:translation.extension:lang.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.method.text.extension:translation.extension:lang.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

lang

Mappings

rim: N/A

value[x]

1..1

Binding

There are no (further) constraints on this element

Element id

Observation.method.text.extension:translation.extension:lang.value[x]

Short description

Value of extension

Definition

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

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

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
rim: N/A

valueCode

code

There are no (further) constraints on this element

Data type

code

content

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.method.text.extension:translation.extension:content

Short description

Content in other Language

Alternate names

extensions, user content

Definition

Content in other Language.

Comments

The type (string or markdown) must match the context in which it is used.

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.method.text.extension:translation.extension:content.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.method.text.extension:translation.extension:content.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.method.text.extension:translation.extension:content.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

content

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Observation.method.text.extension:translation.extension:content.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

valueMarkdown

markdown

There are no (further) constraints on this element

Data type

markdown

valueString

string

There are no (further) constraints on this element

Data type

string

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.method.text.extension:translation.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

http://hl7.org/fhir/StructureDefinition/translation

Mappings

rim: N/A

value[x]

0..0

There are no (further) constraints on this element

Element id

Observation.method.text.extension:translation.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

value

0..1

System.String

There are no (further) constraints on this element

Element id

Observation.method.text.value

Short description

Primitive value for string

Definition

Primitive value for string

Data type

System.String

Maximum string length

1048576

specimen

0..1

Reference(SpecimenEu)

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

When the specimen is applicable and known it shall be documented

Data type

Reference(SpecimenEu)

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())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
sct-concept: < 123038009 |Specimen|
v2: SPM segment
rim: participation[typeCode=SPC].specimen
sct-attr: 704319004 |Inherent in|

device

0..1

Reference(Device | DeviceMetric)

There are no (further) constraints on this element

Element id

Observation.device

Short description

Measuring instrument

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

Reference(Device | DeviceMetric)

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())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
sct-concept: < 49062001 |Device|
v2: OBX-17 / PRT -10
rim: participation[typeCode=DEV]
sct-attr: 424226004 |Using device|

referenceRange

0..*

BackboneElement

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

BackboneElement

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())
obs-3: Must have at least a low or a high or text
low.exists() or high.exists() or text.exists()

Mappings

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

0..1

string

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

string

Mappings

rim: n/a

extension

0..*

Extension

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

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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..*

Extension

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

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

low

0..1

SimpleQuantity

There are no (further) constraints on this element

Element id

Observation.referenceRange.low

Short description

Low Range, if relevant

Definition

Comments

The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.

Data type

SimpleQuantity

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
qty-3: If a code for the unit is present, the system SHALL also be present
code.empty() or system.exists()
sqty-1: The comparator is not used on a SimpleQuantity
comparator.empty()

Mappings

rim: n/a
v2: SN (see also Range) or CQ
rim: PQ, IVL<PQ>, MO, CO, depending on the values
v2: OBX-7
rim: value:IVL_PQ.low

high

0..1

SimpleQuantity

There are no (further) constraints on this element

Element id

Observation.referenceRange.high

Short description

High Range, if relevant

Definition

Comments

The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.

Data type

SimpleQuantity

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
qty-3: If a code for the unit is present, the system SHALL also be present
code.empty() or system.exists()
sqty-1: The comparator is not used on a SimpleQuantity
comparator.empty()

Mappings

rim: n/a
v2: SN (see also Range) or CQ
rim: PQ, IVL<PQ>, MO, CO, depending on the values
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

CodeableConcept

Binding

Code for the meaning of a reference range.

ObservationReferenceRangeMeaningCodes (preferred)

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: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
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..*

CodeableConcept

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

CodeableConcept

Binding

Codes identifying the population the reference range applies to.

ObservationReferenceRangeAppliesToCodes (example)

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: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
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

Range

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.

Comments

The stated low and high value are assumed to have arbitrarily high precision when it comes to determining which values are in the range. I.e. 1.99 is not in the range 2 -> 3.

Data type

Range

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())
rng-2: If present, low SHALL have a lower value than high
low.empty() or high.empty() or (low <= high)

Mappings

rim: n/a
v2: NR and also possibly SN (but see also quantity)
rim: IVL<QTY[not(type="TS")]> [lowClosed="true" and highClosed="true"]or URG<QTY[not(type="TS")]>
rim: outboundRelationship[typeCode=PRCN].targetObservationCriterion[code="age"].value

text

0..1

string

There are no (further) constraints on this element

Element id

Observation.referenceRange.text

Short description

Text based reference range in an observation

Definition

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

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: OBX-7
rim: value:ST

hasMember

Σ C

0..*

Reference(ObservationResultsLaboratoryEu)

There are no (further) constraints on this element

Element id

Observation.hasMember

Short description

Related resource that belongs to the Observation group

Definition

Comments

Data type

Reference(ObservationResultsLaboratoryEu)

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())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: Relationships established by OBX-4 usage
rim: outBoundRelationship

derivedFrom

Σ C

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

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())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: Relationships established by OBX-4 usage
rim: .targetObservation

component

0..*

BackboneElement

There are no (further) constraints on this element

Element id

Observation.component

Short description

Laboratory result

Definition

Requirements

Comments

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

Data type

BackboneElement

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: containment by OBX-4?
rim: outBoundRelationship[typeCode=COMP]

0..1

string

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

string

Mappings

rim: n/a

extension

0..*

Extension

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

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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..*

Extension

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

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

code

1..1

CodeableConceptIPSBinding

There are no (further) constraints on this element

Element id

Observation.component.code

Short description

Concept - reference to a terminology or just text

Definition

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

Requirements

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

Comments

Data type

CodeableConceptIPS

Binding

Codes identifying names of simple observations.

ResultsLaboratoryPathologyObservationUvIps (preferred)

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: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
w5: FiveWs.what[x]
sct-concept: < 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|
v2: OBX-3
rim: code

0..1

string

There are no (further) constraints on this element

Element id

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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.component.code.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

coding

SO Σ

0..*

CodingIPS

There are no (further) constraints on this element

Element id

Observation.component.code.coding

Short description

A reference to a 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.

Data type

CodingIPS

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: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.code.coding.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.component.code.coding.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

system

SO Σ

0..1

uri

There are no (further) constraints on this element

Element id

Observation.component.code.coding.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

uri

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: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

version

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.code.coding.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

string

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: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

SO Σ

0..1

code

There are no (further) constraints on this element

Element id

Observation.component.code.coding.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

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: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

display

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.code.coding.display

Short description

Text representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

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: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.code.coding.display.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.component.code.coding.display.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

translation

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.component.code.coding.display.extension:translation

Short description

Language Translation (Localization)

Alternate names

extensions, user content

Definition

Language translation from base language of resource to another language.

Comments

Data type

Extension

Extension URL

http://hl7.org/fhir/StructureDefinition/translation|5.3.0-ballot-tc1

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
rim: ST.translation

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.code.coding.display.extension:translation.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

string

Mappings

rim: n/a

extension

2..*

Extension

There are no (further) constraints on this element

Element id

Observation.component.code.coding.display.extension:translation.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

lang

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.component.code.coding.display.extension:translation.extension:lang

Short description

Code for Language

Alternate names

extensions, user content

Definition

Code for Language.

Comments

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.code.coding.display.extension:translation.extension:lang.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.component.code.coding.display.extension:translation.extension:lang.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.component.code.coding.display.extension:translation.extension:lang.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

lang

Mappings

rim: N/A

value[x]

1..1

Binding

There are no (further) constraints on this element

Element id

Observation.component.code.coding.display.extension:translation.extension:lang.value[x]

Short description

Value of extension

Definition

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

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

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
rim: N/A

valueCode

code

There are no (further) constraints on this element

Data type

code

content

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.component.code.coding.display.extension:translation.extension:content

Short description

Content in other Language

Alternate names

extensions, user content

Definition

Content in other Language.

Comments

The type (string or markdown) must match the context in which it is used.

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.code.coding.display.extension:translation.extension:content.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.component.code.coding.display.extension:translation.extension:content.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.component.code.coding.display.extension:translation.extension:content.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

content

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Observation.component.code.coding.display.extension:translation.extension:content.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

valueMarkdown

markdown

There are no (further) constraints on this element

Data type

markdown

valueString

string

There are no (further) constraints on this element

Data type

string

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.component.code.coding.display.extension:translation.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

http://hl7.org/fhir/StructureDefinition/translation

Mappings

rim: N/A

value[x]

0..0

There are no (further) constraints on this element

Element id

Observation.component.code.coding.display.extension:translation.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

value

0..1

System.String

There are no (further) constraints on this element

Element id

Observation.component.code.coding.display.value

Short description

Primitive value for string

Definition

Primitive value for string

Data type

System.String

Maximum string length

1048576

userSelected

0..1

boolean

There are no (further) constraints on this element

Element id

Observation.component.code.coding.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

boolean

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: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

text

SO Σ

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.code.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

Comments

Very often the text is the same as a displayName of one of the codings.

Data type

string

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

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.code.text.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.component.code.text.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

translation

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.component.code.text.extension:translation

Short description

Language Translation (Localization)

Alternate names

extensions, user content

Definition

Language translation from base language of resource to another language.

Comments

Data type

Extension

Extension URL

http://hl7.org/fhir/StructureDefinition/translation|5.3.0-ballot-tc1

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
rim: ST.translation

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.code.text.extension:translation.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

string

Mappings

rim: n/a

extension

2..*

Extension

There are no (further) constraints on this element

Element id

Observation.component.code.text.extension:translation.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

lang

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.component.code.text.extension:translation.extension:lang

Short description

Code for Language

Alternate names

extensions, user content

Definition

Code for Language.

Comments

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.code.text.extension:translation.extension:lang.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.component.code.text.extension:translation.extension:lang.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.component.code.text.extension:translation.extension:lang.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

lang

Mappings

rim: N/A

value[x]

1..1

Binding

There are no (further) constraints on this element

Element id

Observation.component.code.text.extension:translation.extension:lang.value[x]

Short description

Value of extension

Definition

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

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

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
rim: N/A

valueCode

code

There are no (further) constraints on this element

Data type

code

content

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.component.code.text.extension:translation.extension:content

Short description

Content in other Language

Alternate names

extensions, user content

Definition

Content in other Language.

Comments

The type (string or markdown) must match the context in which it is used.

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.code.text.extension:translation.extension:content.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.component.code.text.extension:translation.extension:content.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.component.code.text.extension:translation.extension:content.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

content

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Observation.component.code.text.extension:translation.extension:content.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

valueMarkdown

markdown

There are no (further) constraints on this element

Data type

markdown

valueString

string

There are no (further) constraints on this element

Data type

string

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.component.code.text.extension:translation.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

http://hl7.org/fhir/StructureDefinition/translation

Mappings

rim: N/A

value[x]

0..0

There are no (further) constraints on this element

Element id

Observation.component.code.text.extension:translation.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

value

0..1

System.String

There are no (further) constraints on this element

Element id

Observation.component.code.text.value

Short description

Primitive value for string

Definition

Primitive value for string

Data type

System.String

Maximum string length

1048576

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

Slicing

Unordered, Closed, by $this(Type)

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

valueBoolean

boolean

There are no (further) constraints on this element

Data type

boolean

valueInteger

integer

There are no (further) constraints on this element

Data type

integer

valueSampledData

SampledData

There are no (further) constraints on this element

Data type

SampledData

valueString

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueString

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

string

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

valueRange

Σ C

0..1

RangeEuLab

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueRange

Short description

A measured range using UCUM

Definition

A measured range (or a range that can potentially be measured) and uncertainty of the measurement. This profile imposes that the code system for units be UCUM.

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

The stated low and high value are assumed to have arbitrarily high precision when it comes to determining which values are in the range. I.e. 1.99 is not in the range 2 -> 3.

Data type

RangeEuLab

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())
rng-2: If present, low SHALL have a lower value than high
low.empty() or high.empty() or (low <= high)

Mappings

rim: n/a
sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|
v2: NR and also possibly SN (but see also quantity)
rim: IVL<QTY[not(type="TS")]> [lowClosed="true" and highClosed="true"]or URG<QTY[not(type="TS")]>

valueRatio

Σ C

0..1

RatioEuLab

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueRatio

Short description

A measured ratio using UCUM

Definition

A measured ratio (or a ratio that can potentially be measured) and uncertainty of the measurement. This profile imposes that the code system for units be UCUM.

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

RatioEuLab

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())
rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present
(numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists())

Mappings

rim: n/a
sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|
v2: N/A
rim: RTO

valueTime

0..1

time

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueTime

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

time

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

valueDateTime

0..1

dateTime

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueDateTime

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

dateTime

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

valuePeriod

0..1

Period

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valuePeriod

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

Period

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

valueQuantity

Σ C

0..1

QuantityEuLab

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueQuantity

Short description

A measured amount using UCUM

Definition

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

The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.

Data type

QuantityEuLab

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())
qty-3: If a code for the unit is present, the system SHALL also be present
code.empty() or system.exists()

Mappings

rim: n/a
sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|
v2: SN (see also Range) or CQ
rim: PQ, IVL<PQ>, MO, CO, depending on the values

valueCodeableConcept

0..1

CodeableConceptIPSBinding

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept

Short description

Concept - reference to a terminology or just text

Definition

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

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

CodeableConceptIPS

Binding

ResultsCodedValuesLaboratoryPathologyUvIps (preferred)

Additional bindings

http://hl7.org/fhir/uv/ips/ValueSet/results-blood-group-snomed-ct-ips-free-set (candidate)
Additional conformance binding to a blood group findings value set for laboratory result values from the SNOMED CT IPS free set for use globally (in SNOMED member and non-member jurisdictions).
http://hl7.org/fhir/uv/ips/ValueSet/results-presence-absence-snomed-ct-ips-free-set (candidate)
Additional conformance binding to a presence and absence findings (qualifier values) value set for laboratory result values from the SNOMED CT IPS free set for use globally (in SNOMED member and non-member jurisdictions).
http://hl7.org/fhir/uv/ips/ValueSet/results-microorganism-snomed-ct-ips-free-set (candidate)
Additional conformance binding to a microorganisms value set for laboratory result values from the SNOMED CT IPS free set for use globally (in SNOMED member and non-member jurisdictions).

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
sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
v2: OBX.2, OBX.5, OBX.6
rim: value
sct-attr: 363714003 |Interprets|
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

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

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

coding

SO Σ

0..*

CodingIPS

There are no (further) constraints on this element

Element id

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

Short description

A reference to a 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.

Data type

CodingIPS

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: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

system

SO Σ

0..1

uri

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

uri

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: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

version

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

string

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: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

SO Σ

0..1

code

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

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: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

display

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.display

Short description

Text representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

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: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.display.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.display.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

translation

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.display.extension:translation

Short description

Language Translation (Localization)

Alternate names

extensions, user content

Definition

Language translation from base language of resource to another language.

Comments

Data type

Extension

Extension URL

http://hl7.org/fhir/StructureDefinition/translation|5.3.0-ballot-tc1

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
rim: ST.translation

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.display.extension:translation.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

string

Mappings

rim: n/a

extension

2..*

Extension

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.display.extension:translation.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

lang

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.display.extension:translation.extension:lang

Short description

Code for Language

Alternate names

extensions, user content

Definition

Code for Language.

Comments

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.display.extension:translation.extension:lang.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.display.extension:translation.extension:lang.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.display.extension:translation.extension:lang.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

lang

Mappings

rim: N/A

value[x]

1..1

Binding

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.display.extension:translation.extension:lang.value[x]

Short description

Value of extension

Definition

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

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

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
rim: N/A

valueCode

code

There are no (further) constraints on this element

Data type

code

content

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.display.extension:translation.extension:content

Short description

Content in other Language

Alternate names

extensions, user content

Definition

Content in other Language.

Comments

The type (string or markdown) must match the context in which it is used.

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.display.extension:translation.extension:content.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.display.extension:translation.extension:content.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.display.extension:translation.extension:content.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

content

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.display.extension:translation.extension:content.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

valueMarkdown

markdown

There are no (further) constraints on this element

Data type

markdown

valueString

string

There are no (further) constraints on this element

Data type

string

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.display.extension:translation.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

http://hl7.org/fhir/StructureDefinition/translation

Mappings

rim: N/A

value[x]

0..0

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.display.extension:translation.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

value

0..1

System.String

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.display.value

Short description

Primitive value for string

Definition

Primitive value for string

Data type

System.String

Maximum string length

1048576

userSelected

0..1

boolean

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.coding.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

boolean

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: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

text

SO Σ

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.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

Comments

Very often the text is the same as a displayName of one of the codings.

Data type

string

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

Obligations

Code	Actor
SHALL:populate-if-known	http://hl7.org/fhir/uv/ips/ActorDefinition/Creator
SHALL:handle	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer
SHOULD:display	http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.text.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

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.text.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

translation

0..*

Extension

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.text.extension:translation

Short description

Language Translation (Localization)

Alternate names

extensions, user content

Definition

Language translation from base language of resource to another language.

Comments

Data type

Extension

Extension URL

http://hl7.org/fhir/StructureDefinition/translation|5.3.0-ballot-tc1

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
rim: ST.translation

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.text.extension:translation.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

string

Mappings

rim: n/a

extension

2..*

Extension

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.text.extension:translation.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

lang

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.text.extension:translation.extension:lang

Short description

Code for Language

Alternate names

extensions, user content

Definition

Code for Language.

Comments

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.text.extension:translation.extension:lang.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.text.extension:translation.extension:lang.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.text.extension:translation.extension:lang.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

lang

Mappings

rim: N/A

value[x]

1..1

Binding

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.text.extension:translation.extension:lang.value[x]

Short description

Value of extension

Definition

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

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

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
rim: N/A

valueCode

code

There are no (further) constraints on this element

Data type

code

content

1..1

Extension

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.text.extension:translation.extension:content

Short description

Content in other Language

Alternate names

extensions, user content

Definition

Content in other Language.

Comments

The type (string or markdown) must match the context in which it is used.

Data type

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

0..1

string

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.text.extension:translation.extension:content.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

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.text.extension:translation.extension:content.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) 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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.text.extension:translation.extension:content.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

content

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.text.extension:translation.extension:content.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

valueMarkdown

markdown

There are no (further) constraints on this element

Data type

markdown

valueString

string

There are no (further) constraints on this element

Data type

string

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.text.extension:translation.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

http://hl7.org/fhir/StructureDefinition/translation

Mappings

rim: N/A

value[x]

0..0

There are no (further) constraints on this element

Element id

Observation.component.value[x]:valueCodeableConcept.text.extension:translation.value[x]

Short description

Value of extension

Definition

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

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
rim: N/A

value

0..1

System.String

There are no (further) constraints on this element

Element id

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

Short description

Primitive value for string

Definition

Primitive value for string

Data type

System.String

Maximum string length

1048576

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

CodeableConcept

Binding

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

DataAbsentReason (extensible)

Conditions

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

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
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

CodeableConcept

Binding

Codes identifying interpretations of observations.

ObservationInterpretationCodes (extensible)

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: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
sct-concept: < 260245000 |Findings values|
v2: OBX-8
rim: interpretationCode
sct-attr: 363713009 |Has interpretation|

referenceRange

0..*

see (referenceRange)

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

Mappings

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

Additional Guidance

meta.profile

This element SHALL be populated with a value of https://fhir.nhs.uk/England/StructureDefinition/England-Observation-Lab-Pathology

extension:ObservationOrganizer

This extension SHALL NOT be populated because, in this context, the Observation represents an individual test result rather than a test group.

identifier

This element SHOULD be populated with a unique, persistent business identifier for the test result Observation.

It is recommended that a UUID is used for identifier.value, with identifier.system set to urn:ietf:rfc:3986, as illustrated below:

"identifier": {
	"system": "urn:ietf:rfc:3986",
	"value": "urn:uuid:f8c185fc-0993-4b80-9d33-4c9ae11c3afe"
}

status

This element SHALL be populated with a value taken from the ObservationStatus ValueSet.

category

This element SHOULD be populated with the following values, taken from the ObservationCategoryCodes and LabSpecialtyEuVs ValueSets respectively:

"category": [
    {
        "coding": [
            {
                "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                "code": "laboratory",
                "display": "Laboratory"
            }
        ]
    },
    {
        "coding": [
            {
                "system": "http://snomed.info/sct",
                "code": "394915009",
                "display": "General pathology (speciality)"
            }
        ]
    }
]

code

The clinical code and name of the test that was performed, for example:

"code": {
    "coding": [
        {
            "extension": [
                {
                    "url": "http://hl7.org/fhir/StructureDefinition/valueset-reference",
                    "valueUri": "https://fhir.nhs.uk/England/ValueSet/England-PathologyBoundedCodeListObservables"
                }
            ],
            "system": "http://snomed.info/sct",
            "code": "1000661000000107",
            "display": "Serum sodium level"
        }
    ]
}

The element has an open slice and SHALL be populated using one of the following:

A SNOMED CT code that is a member of the 999002881000000100 | PBCL (Pathology Bounded Code List) observables simple reference set.
A SNOMED CT code that is a member of the 1853551000000106 | PaLM (Pathology and Laboratory Medicine) observable entity simple reference set.
If a SNOMED CT code from either reference set cannot be identified (for example, where a local reportable has not yet been mapped to SNOMED CT, or if the reportable is not yet represented in SNOMED CT), a local code MAY be used.

The standard FHIR Extension valueset-reference SHALL be used to indicate which reference set a SNOMED CT code is a member of. The relevant URI values for the SNOMED PBCL and SNOMED PaLM reference sets are as follows:

SNOMED PBCL: https://fhir.nhs.uk/England/ValueSet/England-PathologyBoundedCodeListObservables
SNOMED PaLM: https://fhir.nhs.uk/England/ValueSet/England-PathologyAndLaboratoryMedicineObservables

The valueset-reference extension SHALL only be used for SNOMED CT codes that are members of a reference set and SHALL NOT be used for local codes.

Where a SNOMED CT code is a member of both the SNOMED PBCL and SNOMED PaLM reference sets, the valueset-reference extension SHALL indicate SNOMED PBCL membership only. A separate valueset-reference extension to also indicate SNOMED PaLM membership SHALL NOT be provided.

It is possible to convey more than one code as part of the same CodeableConcept, for example a SNOMED PBCL code and an equivalent SNOMED PaLM code. In this scenario, separate Observation.code.coding entries SHALL be provided, each accompanied by a corresponding valueset-reference extension, for example:

"code": {
    "coding": [
        {
            "extension": [
                {
                    "url": "http://hl7.org/fhir/StructureDefinition/valueset-reference",
                    "valueUri": "https://fhir.nhs.uk/England/ValueSet/England-PathologyBoundedCodeListObservables"
                }
            ],
            "system": "http://snomed.info/sct",
            "code": "1000661000000107",
            "display": "Serum sodium level"
        },
        {
            "extension": [
                {
                    "url": "http://hl7.org/fhir/StructureDefinition/valueset-reference",
                    "valueUri": "https://fhir.nhs.uk/England/ValueSet/England-PathologyAndLaboratoryMedicineObservables"
                }
            ],
            "system": "http://snomed.info/sct",
            "code": "1107871000000107",
            "display": "Sodium substance concentration in serum"
        }
    ]
}

subject

Reference to the Patient.

effective[x]

The clinically relevant date and time, or time-period, for the test result. In the context of laboratory reporting, this is typically the date and time, or time-period, that the associated specimen was collected.

The presence of [x] in an element name is used to indicate a choice of data type. The [x] part of the element name is replaced with an appropriate data type, in title-case format e.g. effectiveDateTime.

This element SHALL be populated using one of the following, in order of preference:

Specimen.collection.collected[x]
Specimen.receivedTime
Specimen.processing.time[x]
the Specimen resource creation date and time i.e. the initial value of Specimen.meta.lastUpdated

issued

The date and time the test result was issued.

performer

Reference to the performing Organization.

value[x]

The test result value.

If the result value has an associated unit of measure, the unit element SHALL be populated with a displayable, text based unit that defines what is measured, for example:

"valueQuantity": {
    "value": 200,
    "unit": "mg/L"
}

Coded representations of units of measure (i.e. using UCUM) SHOULD NOT be used. Accordingly, the code and system elements associated with units of measure SHOULD NOT be used.

Semi-quantitative and qualitative results (e.g. ‘Positive’) are currently represented as text in PMIP EDIFACT (NHS003). To facilitate the initial adoption of FHIR and minimise the impact on existing systems and processes, these types of results SHALL continue to be represented as text (using valueString), rather than using SNOMED CT coded concepts.

Refer to the Design Overview section for further information relating to the representation of different types of test results.

dataAbsentReason

The reason a test result value was not provided.

The standard DataAbsentReason ValueSet provides limited value for UK laboratory reporting use cases. It is therefore recommended that if a data absent reason is included, then a text representation SHOULD be used, for example:

"dataAbsentReason": {
    "coding": [
        {
            "system": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
            "code": "as-text"
        }
  ],
  "text": "Specimen unsatisfactory for evaluation"
}

interpretation

A coded, categorical assessment of a test result value, for example:

"interpretation": [
    {
        "coding": [
            {
                "system": "http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation",
                "code": "H",
                "display": "High"
            }
        ]
    }
]

The permitted codes are defined in ValueSet England-DeviatingResultIndicator. Be aware that two codes have been mapped from EDIFACT to FHIR. The FHIR versions of these codes (H and L), SHALL be used.

EDIFACT	FHIR	Display	Code System
HI	H	High	http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation
LO	L	Low	http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation
OR	OR	Outside reference range	https://fhir.nhs.uk/England/CodeSystem/England-DeviatingResultIndicator
PA	PA	Potentially abnormal	https://fhir.nhs.uk/England/CodeSystem/England-DeviatingResultIndicator

note

Comments relating to the test result.

specimen

Reference to the Specimen used during testing.

referenceRange

A range of values considered normal or clinically expected for a given test result, for example:

"referenceRange": [
    {
        "low": {
            "value": 133,
            "unit": "mmol/L",
        },
        "high": {
            "value": 146,
            "unit": "mmol/L",
        }
    }
]

Text based reference ranges SHOULD be conveyed using referenceRange.text.

hasMember

This element SHOULD NOT be populated because, in this context, the profile represents an individual test result rather than a test group.

Where an Observation is used to represent a test group (with Observation.hasMember references to the test results), then England-Observation-Lab-Pathology (Test Group) SHOULD be used instead.