HLA Immunoassay Target Bead Observation

Metadata

These are the details for this resource:

NameDescriptionCanonical_URLStatusVersion
HLAImmunoassayTargetBeadObservation

HLA Immunoassay Target Bead Observation

Extension of US Core lab result observation to capture attributes specific to solid-phase immuno-assay bead test results.

A single bead within a solid phase panel. The bead MUST have a specificity, which may be an allele name or a serological specificity. The bead MUST reference the working-sample specimen The bead MAY be referenced by it's corresponding positive and negative controls.

Elements:


  • bead-info: Structure containing details on the specificity and identifiers of an individual bead
  • raw-data: Structure containing measured MFI or raw data as measured in the assay.
  • converted-data: Structure containing converted MFIs, formulas used, and interpretations of bead-specific results.

bead-info

  • bead-id
  • bead-type: Target bead type
  • HLA-target-type
  • HLA-target-serological-specificity
  • number of beads
  • raw-MFI
  • formula
  • adjusted-MFI
  • bead-interpretation
  • bead-plausible
  • bead-plausible-reason
  • working-sample-id: Reference
https://fhir.nmdp.org/ig/HlaAntibodyReport/StructureDefinition/hla-immunoassay-target-bead-observationdraft0.2.0

Resource content

These are different views on this resource:

This is the tree view:
idΣ0..1id
id0..1string
extensionC0..*Extension
versionIdΣ0..1id
lastUpdatedS Σ0..1instant
sourceΣ0..1uri
profileΣ0..*canonical(StructureDefinition)
securityΣ0..*CodingBinding
tagΣ0..*Coding
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionC0..*Extension
modifierExtension?! C0..*Extension
id0..1string
extensionC0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueS Σ1..1string
periodΣ0..1Period
assignerΣ0..1Reference(Organization)
basedOnΣ0..*Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest)
id0..1string
extensionC0..*Extension
referenceS Σ C1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
statusS Σ ?!1..1codeBinding
us-coreS1..1CodeableConceptBindingPattern
id0..1string
extensionC0..*Extension
id0..1string
extensionC0..*Extension
systemΣ1..1uriBinding
versionΣ0..1string
codeΣ0..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
subjectS Σ1..1Reference(USCorePatientProfile | Group | Device | USCoreLocationProfile)
focusΣ0..0Reference(Resource)
encounterS Σ0..0Reference(USCoreEncounterProfile)
effectiveDateTimedateTime
effectivePeriodPeriod
effectiveTimingTiming
effectiveInstantinstant
issuedΣ0..1instant
performerS Σ0..*Reference(USCorePractitionerProfile | USCoreOrganizationProfile | USCorePatientProfile | PractitionerRole | USCoreCareTeam | USCoreRelatedPersonProfile)
valueIntegerinteger
dataAbsentReasonS C0..1CodeableConceptBinding
id0..1string
extensionC0..*Extension
id0..1string
extensionC0..*Extension
systemΣ0..0uri
versionΣ0..1string
codeΣ0..0code
displayΣ0..1string
userSelectedΣ0..1boolean
textS Σ1..1string
id0..1string
extensionC0..*Extension
id0..1string
extensionC0..*Extension
systemS Σ1..1uriBinding
versionΣ0..1string
codeS Σ1..1codeBinding
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
id0..1string
extensionC0..*Extension
id0..1string
extensionC0..*Extension
systemS Σ1..1uriBinding
versionΣ0..1string
codeS Σ1..1codeBinding
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
id0..1string
extensionC0..*Extension
id0..1string
extensionC0..*Extension
systemS Σ1..1uriBinding
versionΣ0..1string
codeS Σ1..1codeBinding
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
id0..1string
extensionC0..*Extension
id0..1string
extensionC0..*Extension
systemS Σ1..1uriBinding
versionΣ0..1string
codeS Σ1..1codeBinding
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
note0..*Annotation
bodySite0..0CodeableConcept
method0..1CodeableConcept
specimenS0..1Reference(USCoreSpecimenProfile)
device0..1Reference(Device | DeviceMetric)
hasMemberΣ0..*Reference(Observation | QuestionnaireResponse | MolecularSequence)
derivedFromΣ0..*Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence)
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
id0..1string
extensionC0..*Extension
id0..1string
extensionC0..*Extension
systemΣ0..1uri
versionΣ0..1string
codeΣ0..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textS Σ1..1stringFixed Value
valueQuantityQuantity
valueCodeableConceptCodeableConcept
valueStringstring
valueBooleanboolean
valueIntegerinteger
valueRangeRange
valueRatioRatio
valueSampledDataSampledData
valueTimetime
valueDateTimedateTime
valuePeriodPeriod
dataAbsentReasonC0..1CodeableConceptBinding
interpretation0..*CodeableConceptBinding
referenceRange0..*see (referenceRange)
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
id0..1string
extensionC0..*Extension
id0..1string
extensionC0..*Extension
systemΣ0..1uri
versionΣ0..1string
codeΣ0..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textS Σ1..1stringFixed Value
valueStringstring
dataAbsentReasonC0..1CodeableConceptBinding
interpretation0..*CodeableConceptBinding
referenceRange0..*see (referenceRange)
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
id0..1string
extensionC0..*Extension
id0..1string
extensionC0..*Extension
systemΣ0..1uri
versionΣ0..1string
codeΣ0..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textS Σ1..1stringFixed Value
valueStringstring
dataAbsentReasonC0..1CodeableConceptBinding
interpretation0..*CodeableConceptBinding
referenceRange0..*see (referenceRange)
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
id0..1string
extensionC0..*Extension
id0..1string
extensionC0..*Extension
systemS Σ1..1uriBinding
versionΣ0..1string
codeS Σ1..1codeBinding
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ1..1stringFixed Value
valueQuantityQuantity
valueCodeableConceptCodeableConcept
valueStringstring
valueBooleanboolean
valueIntegerinteger
valueRangeRange
valueRatioRatio
valueSampledDataSampledData
valueTimetime
valueDateTimedateTime
valuePeriodPeriod
dataAbsentReasonC0..1CodeableConceptBinding
interpretation0..*CodeableConceptBinding
referenceRange0..*see (referenceRange)
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
id0..1string
extensionC0..*Extension
codingΣ0..1Coding
textS Σ1..1stringFixed Value
valueIntegerinteger
dataAbsentReasonC0..1CodeableConceptBinding
interpretation0..*CodeableConceptBinding
referenceRange0..*see (referenceRange)
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
id0..1string
extensionC0..*Extension
codingΣ0..1Coding
textS Σ1..1stringFixed Value
valueStringstring
dataAbsentReasonC0..1CodeableConceptBinding
interpretation0..*CodeableConceptBinding
referenceRange0..*see (referenceRange)
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
id0..1string
extensionC0..*Extension
codingΣ0..1Coding
textS Σ1..1stringFixed Value
valueIntegerinteger
dataAbsentReasonC0..1CodeableConceptBinding
interpretation0..*CodeableConceptBinding
referenceRange0..*see (referenceRange)
This is the detailed view:
Observation
ShortMeasurements and simple assertions
Definition

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

Cardinality0..*
AliasVital Signs, Measurement, Results, Tests
Comments

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

Constraints
  • dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
    contained.contained.empty()
  • dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
    contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
  • dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
    contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
  • dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
    contained.meta.security.empty()
  • dom-6: A resource should have narrative for robust management
    text.`div`.exists()
  • obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
    dataAbsentReason.empty() or value.empty()
  • obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
    value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
  • us-core-2: If there is no component or hasMember element then either a value[x] or a data absent reason must be present
    (component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists())
Mappings
  • rim: Entity. Role, or Act
  • workflow: Event
  • sct-concept: < 363787002 |Observable entity|
  • v2: OBX
  • rim: Observation[classCode=OBS, moodCode=EVN]
Observation.id
ShortLogical 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.

Cardinality0..1
Typeid
SummaryTrue
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.

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

Cardinality0..1
TypeMeta
Must SupportTrue
SummaryTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Observation.meta.id
ShortUnique id for inter-element referencing
Definition

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

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Observation.meta.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Observation.meta.versionId
ShortVersion specific identifier
Definition

The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.

Cardinality0..1
Typeid
SummaryTrue
Comments

The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Observation.meta.lastUpdated
ShortWhen the resource last changed
Definition

When the resource last changed - e.g. when the version changed.

Cardinality0..1
Typeinstant
Must SupportTrue
SummaryTrue
Comments

This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Observation.meta.source
ShortIdentifies where the resource comes from
Definition

A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.

Cardinality0..1
Typeuri
SummaryTrue
Comments

In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used.

This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Observation.meta.profile
ShortProfiles this resource claims to conform to
Definition

A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

Cardinality0..*
Typecanonical(StructureDefinition)
SummaryTrue
Comments

It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Observation.meta.security
ShortSecurity Labels applied to this resource
Definition

Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

Cardinality0..*
TypeCoding
Binding

Security Labels from the Healthcare Privacy and Security Classification System.

All Security Labels (extensible)

SummaryTrue
Comments

The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Observation.meta.tag
ShortTags applied to this resource
Definition

Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

Cardinality0..*
TypeCoding
Binding

Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".

CommonTags (example)

SummaryTrue
Comments

The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Observation.implicitRules
ShortA 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.

Cardinality0..1
Typeuri
ModifierTrue
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Observation.language
ShortLanguage of the resource content
Definition

The base language in which the resource is written.

Cardinality0..1
Typecode
Binding

A human language.

CommonLanguages (preferred)

Binding extensions
maxValueSetAllLanguages
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).

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Observation.text
ShortText summary of the resource, for human interpretation
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.

Cardinality0..1
TypeNarrative
Aliasnarrative, html, xhtml, display
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: Act.text?
Observation.contained
ShortContained, inline 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.

Cardinality0..*
TypeResource
Aliasinline resources, anonymous resources, contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

Mappings
  • rim: N/A
Observation.extension
ShortAdditional content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
Observation.modifierExtension
ShortExtensions that cannot be ignored
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).

Cardinality0..*
TypeExtension
ModifierTrue
Aliasextensions, user content
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

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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
Observation.identifier
ShortBusiness Identifier for observation
Definition

A unique identifier assigned to this observation.

Cardinality1..1
TypeIdentifier
SummaryTrue
Requirements

Allows observations to be distinguished and referenced.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Event.identifier
  • w5: FiveWs.identifier
  • v2: OBX.21 For OBX segments from systems without OBX-21 support a combination of ORC/OBR and OBX must be negotiated between trading partners to uniquely identify the OBX segment. Depending on how V2 has been implemented each of these may be an option: 1) OBR-3 + OBX-3 + OBX-4 or 2) OBR-3 + OBR-4 + OBX-3 + OBX-4 or 2) some other way to uniquely ID the OBR/ORC + OBX-3 + OBX-4.
  • rim: id
Observation.identifier.id
ShortUnique id for inter-element referencing
Definition

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

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Observation.identifier.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Observation.identifier.use
Shortusual | official | temp | secondary | old (If known)
Definition

The purpose of this identifier.

Cardinality0..1
Typecode
Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)

ModifierTrue
SummaryTrue
Requirements

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

Comments

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: N/A
  • rim: Role.code or implied by context
Observation.identifier.type
ShortDescription of identifier
Definition

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

Cardinality0..1
TypeCodeableConcept
Binding

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

Identifier Type Codes (extensible)

SummaryTrue
Requirements

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

Comments

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: CX.5
  • rim: Role.code or implied by context
Observation.identifier.system
ShortThe namespace for the identifier value
Definition

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

Cardinality0..1
Typeuri
SummaryTrue
Requirements

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

Comments

Identifier.system is always case sensitive.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ExamplesGeneral
http://www.acme.com/identifiers/patient
Mappings
  • v2: CX.4 / EI-2-4
  • rim: II.root or Role.id.root
  • servd: ./IdentifierType
Observation.identifier.value
ShortThe value that is unique
Definition

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

Cardinality1..1
Typestring
Must SupportTrue
SummaryTrue
Comments

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ExamplesGeneral
123456
Mappings
  • v2: CX.1 / EI.1
  • rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
  • servd: ./Value
Observation.identifier.period
ShortTime period when id is/was valid for use
Definition

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

Cardinality0..1
TypePeriod
SummaryTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: CX.7 + CX.8
  • rim: Role.effectiveTime or implied by context
  • servd: ./StartDate and ./EndDate
Observation.identifier.assigner
ShortOrganization that issued id (may be just text)
Definition

Organization that issued/manages the identifier.

Cardinality0..1
TypeReference(Organization)
SummaryTrue
Comments

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: CX.4 / (CX.4,CX.9,CX.10)
  • rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
  • servd: ./IdentifierIssuingAuthority
Observation.basedOn
ShortFulfills plan, proposal or order
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.

Cardinality0..*
TypeReference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest)
SummaryTrue
AliasFulfills
Requirements

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Event.basedOn
  • v2: ORC
  • rim: .inboundRelationship[typeCode=COMP].source[moodCode=EVN]
Observation.partOf
ShortPart of referenced event
Definition

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

Cardinality0..*
TypeReference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy)
SummaryTrue
AliasContainer
Comments

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Event.partOf
  • v2: Varies by domain
  • rim: .outboundRelationship[typeCode=FLFS].target
Observation.partOf.id
ShortUnique id for inter-element referencing
Definition

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

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Observation.partOf.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Observation.partOf.reference
ShortLiteral 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.

Cardinality1..1
Typestring
Must SupportTrue
SummaryTrue
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.

ConditionsThe cardinality or value of this element may be affected by these constraints: ref-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
Observation.partOf.type
ShortType 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).

Cardinality0..1
Typeuri
Binding

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

ResourceType (extensible)

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
Observation.partOf.identifier
ShortLogical 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.

Cardinality0..1
TypeIdentifier
SummaryTrue
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).

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .identifier
Observation.partOf.display
ShortText alternative for the resource
Definition

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

Cardinality0..1
Typestring
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
Observation.status
Shortregistered | preliminary | final | amended +
Definition

The status of the result value.

Cardinality1..1
Typecode
Binding

Codes providing the status of an observation.

ObservationStatus (required)

Must SupportTrue
ModifierTrue
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Event.status
  • w5: FiveWs.status
  • sct-concept: < 445584004 |Report by finality status|
  • v2: OBX-11
  • rim: status Amended & Final are differentiated by whether it is the subject of a ControlAct event with a type of "revise"
Observation.category
ShortClassification of type of observation
Definition

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

Cardinality1..*
TypeCodeableConcept
Binding

Codes for high level observation categories.

ObservationCategoryCodes (preferred)

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

Slicing

Unordered, Open, by $this(Value)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.class
  • rim: .outboundRelationship[typeCode="COMP].target[classCode="LIST", moodCode="EVN"].code
Observation.category:us-core
ShortClassification of type of observation
Definition

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

Cardinality1..1
TypeCodeableConcept
Binding

Note that other codes are permitted, see Required Bindings When Slicing by Value Sets

USCoreClinicalResultObservationCategory (required)

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

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
  • argonaut-dq-dstu2: Observation.category
  • w5: FiveWs.class
  • rim: .outboundRelationship[typeCode="COMP].target[classCode="LIST", moodCode="EVN"].code
Observation.code
ShortLaboratory Test Name
Definition

The name of the clinical test or procedure performed on a patient. A LOINC SHALL be used if the concept is present in LOINC.

Cardinality1..1
TypeCodeableConcept
Binding

Laboratory LOINC Codes

USCoreLaboratoryTestCodes (extensible)

Must SupportTrue
SummaryTrue
AliasName
Requirements

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

Comments

The typical patterns for codes are: 1) a LOINC code either as a translation from a "local" code or as a primary code, or 2) a local code only if no suitable LOINC exists, or 3) both the local and the LOINC translation. Systems SHALL be capable of sending the local code if one exists. When using LOINC , Use either the SHORTNAME or LONG_COMMON_NAME field for the display.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • argonaut-dq-dstu2: Observation.code
  • 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|
Observation.code.id
ShortUnique id for inter-element referencing
Definition

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

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Observation.code.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Observation.code.coding
ShortCode defined by a terminology system
Definition

A reference to a code defined by a terminology system.

Cardinality0..*
TypeCoding
SummaryTrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
Observation.code.coding.id
ShortUnique id for inter-element referencing
Definition

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

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Observation.code.coding.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Observation.code.coding.system
ShortIdentity of the terminology system
Definition

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

Cardinality1..1
Typeuri
Binding

http://fhir.nmdp.org/terminology/HLAImmunoAssay (required)

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
Observation.code.coding.version
ShortVersion 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.

Cardinality0..1
Typestring
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.7
  • rim: ./codeSystemVersion
  • orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
Observation.code.coding.code
ShortSymbol 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).

Cardinality0..1
Typecode
SummaryTrue
Requirements

Need to refer to a particular code in the system.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
Observation.code.coding.display
ShortRepresentation defined by the system
Definition

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

Cardinality0..1
Typestring
SummaryTrue
Requirements

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
Observation.code.coding.userSelected
ShortIf 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).

Cardinality0..1
Typeboolean
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • 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 ]
Observation.code.text
Short𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: The name of the test that was performed.
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.

Cardinality0..1
Typestring
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.9. But note many systems use C*E.2 for this
  • rim: ./originalText[mediaType/code="text/plain"]/data
  • orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
Observation.subject
ShortWho 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.

Cardinality1..1
TypeReference(USCorePatientProfile | Group | Device | USCoreLocationProfile)
Must SupportTrue
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Event.subject
  • w5: FiveWs.subject[x]
  • v2: PID-3
  • rim: participation[typeCode=RTGT]
  • w5: FiveWs.subject
Observation.focus
ShortWhat 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.

Cardinality0..0
TypeReference(Resource)
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.subject[x]
  • v2: OBX-3
  • rim: participation[typeCode=SBJ]
  • w5: FiveWs.subject
Observation.encounter
ShortEncounter associated with Observation
Definition

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

Cardinality0..0
TypeReference(USCoreEncounterProfile)
Must SupportTrue
SummaryTrue
AliasContext
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).

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Event.context
  • w5: FiveWs.context
  • v2: PV1
  • rim: inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]
Observation.effective[x]
ShortClinically relevant time/time-period for observation
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.

Cardinality0..1
TypedateTime, Period, Timing, instant
Must SupportTrue
SummaryTrue
AliasOccurrence
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.

ConditionsThe cardinality or value of this element may be affected by these constraints: us-core-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • us-core-1: Datetime must be at least to day.
    $this is dateTime implies $this.toString().length() >= 10
Mappings
  • workflow: Event.occurrence[x]
  • w5: FiveWs.done[x]
  • v2: OBX-14, and/or OBX-19 after v2.4 (depends on who observation made)
  • rim: effectiveTime
Observation.issued
ShortDate/Time this version was made available
Definition

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

Cardinality0..1
Typeinstant
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.recorded
  • v2: OBR.22 (or MSH.7), or perhaps OBX-19 (depends on who observation made)
  • rim: participation[typeCode=AUT].time
Observation.performer
ShortWho is responsible for the observation
Definition

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

Cardinality0..*
TypeReference(USCorePractitionerProfile | USCoreOrganizationProfile | USCorePatientProfile | PractitionerRole | USCoreCareTeam | USCoreRelatedPersonProfile)
Must SupportTrue
SummaryTrue
Requirements

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Event.performer.actor
  • w5: FiveWs.actor
  • v2: OBX.15 / (Practitioner) OBX-16, PRT-5:PRT-4='RO' / (Device) OBX-18 , PRT-10:PRT-4='EQUIP' / (Organization) OBX-23, PRT-8:PRT-4='PO'
  • rim: participation[typeCode=PRF]
Observation.value[x]
ShortResult Value
Definition

The Laboratory result value. If a coded value, the valueCodeableConcept.code SHOULD be selected from SNOMED CT if the concept exists. If a numeric value, valueQuantity.code SHALL be selected from UCUM. A FHIR UCUM Codes value set that defines all UCUM codes is in the FHIR specification.

Cardinality1..1
Typeinteger
Must SupportTrue
SummaryTrue
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.

ConditionsThe cardinality or value of this element may be affected by these constraints: obs-7, us-core-2, us-core-3, us-core-4
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • us-core-3: SHALL use UCUM for coded quantity units.
    ofType(Quantity).system.empty() or ofType(Quantity).system = 'http://unitsofmeasure.org'
  • us-core-4: SHOULD use Snomed CT for coded Results
    ofType(CodeableConcept).coding.system.empty() or (ofType(CodeableConcept).coding.system contains 'http://snomed.info/sct')
Mappings
  • argonaut-dq-dstu2: Observation.value[x]
  • sct-concept: < 441742003 |Evaluation finding|
  • v2: OBX.2, OBX.5, OBX.6
  • rim: value
  • sct-attr: 363714003 |Interprets|
Observation.dataAbsentReason
ShortWhy the result is missing
Definition

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

Cardinality0..1
TypeCodeableConcept
Binding

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

DataAbsentReason (extensible)

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

ConditionsThe cardinality or value of this element may be affected by these constraints: obs-6, us-core-2
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: N/A
  • rim: value.nullFlavor
Observation.interpretation
ShortResult interpretation
Definition

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

Cardinality1..*
TypeCodeableConcept
Binding

Observation Interpretation Codes

ObservationInterpretationCodes (extensible)

Must SupportTrue
AliasAbnormal Flag
Requirements

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

Comments

Categorical assessment of a laboratory value, often in relation to a test's reference range. Examples include but are not limited to high, low, critical, and normal.

Slicing

Unordered, Open, by $this(Value)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • sct-concept: < 260245000 |Findings values|
  • v2: OBX-8
  • rim: interpretationCode
  • sct-attr: 363713009 |Has interpretation|
Observation.interpretation:bead-interpretation-classification-entity
ShortBead result classification entity
Definition

Bead observation interpretation indicating the person or entity performing the interpretation of the bead result.

Cardinality0..1
TypeCodeableConcept
Binding

Observation Interpretation Codes

ObservationInterpretationCodes (extensible)

Must SupportTrue
AliasAbnormal Flag
Requirements

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

Comments

Categorical assessment of a laboratory value, often in relation to a test's reference range. Examples include but are not limited to high, low, critical, and normal.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • sct-concept: < 260245000 |Findings values|
  • v2: OBX-8
  • rim: interpretationCode
  • sct-attr: 363713009 |Has interpretation|
Observation.interpretation:bead-interpretation-classification-entity.id
ShortUnique id for inter-element referencing
Definition

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

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Observation.interpretation:bead-interpretation-classification-entity.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Observation.interpretation:bead-interpretation-classification-entity.coding
ShortCode defined by a terminology system
Definition

A reference to a code defined by a terminology system.

Cardinality0..*
TypeCoding
SummaryTrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
Observation.interpretation:bead-interpretation-classification-entity.coding.id
ShortUnique id for inter-element referencing
Definition

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

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Observation.interpretation:bead-interpretation-classification-entity.coding.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Observation.interpretation:bead-interpretation-classification-entity.coding.system
ShortIdentity of the terminology system
Definition

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

Cardinality0..0
Typeuri
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
Observation.interpretation:bead-interpretation-classification-entity.coding.version
ShortVersion 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.

Cardinality0..1
Typestring
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.7
  • rim: ./codeSystemVersion
  • orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
Observation.interpretation:bead-interpretation-classification-entity.coding.code
ShortSymbol 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).

Cardinality0..0
Typecode
SummaryTrue
Requirements

Need to refer to a particular code in the system.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
Observation.interpretation:bead-interpretation-classification-entity.coding.display
ShortRepresentation defined by the system
Definition

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

Cardinality0..1
Typestring
SummaryTrue
Requirements

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
Observation.interpretation:bead-interpretation-classification-entity.coding.userSelected
ShortIf 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).

Cardinality0..1
Typeboolean
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • 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 ]
Observation.interpretation:bead-interpretation-classification-entity.text
ShortPlain 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.

Cardinality1..1
Typestring
Must SupportTrue
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.9. But note many systems use C*E.2 for this
  • rim: ./originalText[mediaType/code="text/plain"]/data
  • orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
Observation.interpretation:bead-interpretation-classification
ShortBead result classification
Definition

Bead observation interpretation indicating the classification of the bead result.

Cardinality0..1
TypeCodeableConcept
Binding

Observation Interpretation Codes

ObservationInterpretationCodes (extensible)

Must SupportTrue
AliasAbnormal Flag
Requirements

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

Comments

Categorical assessment of a laboratory value, often in relation to a test's reference range. Examples include but are not limited to high, low, critical, and normal.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • sct-concept: < 260245000 |Findings values|
  • v2: OBX-8
  • rim: interpretationCode
  • sct-attr: 363713009 |Has interpretation|
Observation.interpretation:bead-interpretation-classification.id
ShortUnique id for inter-element referencing
Definition

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

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Observation.interpretation:bead-interpretation-classification.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Observation.interpretation:bead-interpretation-classification.coding
ShortCode defined by a terminology system
Definition

A reference to a code defined by a terminology system.

Cardinality0..*
TypeCoding
SummaryTrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
Observation.interpretation:bead-interpretation-classification.coding.id
ShortUnique id for inter-element referencing
Definition

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

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Observation.interpretation:bead-interpretation-classification.coding.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Observation.interpretation:bead-interpretation-classification.coding.system
ShortIdentity of the terminology system
Definition

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

Cardinality1..1
Typeuri
Binding

http://fhir.nmdp.org/terminology/fhir/CodeSystem/hla-immunoassay-codes (extensible)

Must SupportTrue
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
Observation.interpretation:bead-interpretation-classification.coding.version
ShortVersion 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.

Cardinality0..1
Typestring
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.7
  • rim: ./codeSystemVersion
  • orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
Observation.interpretation:bead-interpretation-classification.coding.code
ShortSymbol 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).

Cardinality1..1
Typecode
Binding

http://fhir.nmdp.org/terminology/hla-antibody-assay/bead-interpretation-classification (extensible)

Must SupportTrue
SummaryTrue
Requirements

Need to refer to a particular code in the system.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
Observation.interpretation:bead-interpretation-classification.coding.display
ShortRepresentation defined by the system
Definition

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

Cardinality0..1
Typestring
SummaryTrue
Requirements

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
Observation.interpretation:bead-interpretation-classification.coding.userSelected
ShortIf 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).

Cardinality0..1
Typeboolean
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • 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 ]
Observation.interpretation:bead-interpretation-classification.text
ShortPlain 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.

Cardinality0..1
Typestring
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.9. But note many systems use C*E.2 for this
  • rim: ./originalText[mediaType/code="text/plain"]/data
  • orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
Observation.interpretation:bead-interpretation-rank
ShortBead result rank
Definition

Bead observation interpretation indicating the rank of the bead result.

Cardinality0..1
TypeCodeableConcept
Binding

Observation Interpretation Codes

ObservationInterpretationCodes (extensible)

Must SupportTrue
AliasAbnormal Flag
Requirements

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

Comments

Categorical assessment of a laboratory value, often in relation to a test's reference range. Examples include but are not limited to high, low, critical, and normal.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • sct-concept: < 260245000 |Findings values|
  • v2: OBX-8
  • rim: interpretationCode
  • sct-attr: 363713009 |Has interpretation|
Observation.interpretation:bead-interpretation-rank.id
ShortUnique id for inter-element referencing
Definition

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

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Observation.interpretation:bead-interpretation-rank.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Observation.interpretation:bead-interpretation-rank.coding
ShortCode defined by a terminology system
Definition

A reference to a code defined by a terminology system.

Cardinality0..*
TypeCoding
SummaryTrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
Observation.interpretation:bead-interpretation-rank.coding.id
ShortUnique id for inter-element referencing
Definition

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

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Observation.interpretation:bead-interpretation-rank.coding.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Observation.interpretation:bead-interpretation-rank.coding.system
ShortIdentity of the terminology system
Definition

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

Cardinality1..1
Typeuri
Binding

http://fhir.nmdp.org/terminology/fhir/CodeSystem/hla-immunoassay-codes (required)

Must SupportTrue
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
Observation.interpretation:bead-interpretation-rank.coding.version
ShortVersion 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.

Cardinality0..1
Typestring
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.7
  • rim: ./codeSystemVersion
  • orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
Observation.interpretation:bead-interpretation-rank.coding.code
ShortSymbol 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).

Cardinality1..1
Typecode
Binding

http://fhir.nmdp.org/terminology/hla-antibody-assay/bead-interpretation-ranking (extensible)

Must SupportTrue
SummaryTrue
Requirements

Need to refer to a particular code in the system.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
Observation.interpretation:bead-interpretation-rank.coding.display
ShortRepresentation defined by the system
Definition

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

Cardinality0..1
Typestring
SummaryTrue
Requirements

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
Observation.interpretation:bead-interpretation-rank.coding.userSelected
ShortIf 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).

Cardinality0..1
Typeboolean
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • 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 ]
Observation.interpretation:bead-interpretation-rank.text
ShortPlain 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.

Cardinality0..1
Typestring
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.9. But note many systems use C*E.2 for this
  • rim: ./originalText[mediaType/code="text/plain"]/data
  • orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
Observation.interpretation:bead-plausible
ShortBead result plausibility
Definition

Bead observation interpretation indicating the plausibility of the bead result.

Cardinality0..1
TypeCodeableConcept
Binding

Observation Interpretation Codes

ObservationInterpretationCodes (extensible)

Must SupportTrue
AliasAbnormal Flag
Requirements

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

Comments

Categorical assessment of a laboratory value.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • sct-concept: < 260245000 |Findings values|
  • v2: OBX-8
  • rim: interpretationCode
  • sct-attr: 363713009 |Has interpretation|
Observation.interpretation:bead-plausible.id
ShortUnique id for inter-element referencing
Definition

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

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Observation.interpretation:bead-plausible.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Observation.interpretation:bead-plausible.coding
ShortCode defined by a terminology system
Definition

A reference to a code defined by a terminology system.

Cardinality0..1
TypeCoding
SummaryTrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
Observation.interpretation:bead-plausible.coding.id
ShortUnique id for inter-element referencing
Definition

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

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Observation.interpretation:bead-plausible.coding.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Observation.interpretation:bead-plausible.coding.system
ShortIdentity of the terminology system
Definition

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

Cardinality1..1
Typeuri
Binding

http://fhir.nmdp.org/terminology/fhir/CodeSystem/hla-immunoassay-codes (extensible)

Must SupportTrue
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
Observation.interpretation:bead-plausible.coding.version
ShortVersion 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.

Cardinality0..1
Typestring
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.7
  • rim: ./codeSystemVersion
  • orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
Observation.interpretation:bead-plausible.coding.code
ShortSymbol 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).

Cardinality1..1
Typecode
Binding

http://fhir.nmdp.org/terminology/fhir/ValueSet/hla-immunoassay-boolean (required)

Must SupportTrue
SummaryTrue
Requirements

Need to refer to a particular code in the system.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
Observation.interpretation:bead-plausible.coding.display
ShortRepresentation defined by the system
Definition

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

Cardinality0..1
Typestring
SummaryTrue
Requirements

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
Observation.interpretation:bead-plausible.coding.userSelected
ShortIf 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).

Cardinality0..1
Typeboolean
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • 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 ]
Observation.interpretation:bead-plausible.text
ShortPlain 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.

Cardinality0..1
Typestring
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.9. But note many systems use C*E.2 for this
  • rim: ./originalText[mediaType/code="text/plain"]/data
  • orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
Observation.interpretation:bead-plausible-reason
ShortBead result plausibility reason
Definition

Bead observation interpretation indicating the reason code for the plausibility assessment of the bead result.

Cardinality0..1
TypeCodeableConcept
Binding

Observation Interpretation Codes

ObservationInterpretationCodes (extensible)

Must SupportTrue
AliasAbnormal Flag
Requirements

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

Comments

Categorical assessment of a laboratory value.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • sct-concept: < 260245000 |Findings values|
  • v2: OBX-8
  • rim: interpretationCode
  • sct-attr: 363713009 |Has interpretation|
Observation.interpretation:bead-plausible-reason.id
ShortUnique id for inter-element referencing
Definition

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

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Observation.interpretation:bead-plausible-reason.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Observation.interpretation:bead-plausible-reason.coding
ShortCode defined by a terminology system
Definition

A reference to a code defined by a terminology system.

Cardinality0..*
TypeCoding
SummaryTrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
Observation.interpretation:bead-plausible-reason.coding.id
ShortUnique id for inter-element referencing
Definition

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

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Observation.interpretation:bead-plausible-reason.coding.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Observation.interpretation:bead-plausible-reason.coding.system
ShortIdentity of the terminology system
Definition

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

Cardinality1..1
Typeuri
Binding

http://fhir.nmdp.org/terminology/fhir/CodeSystem/hla-immunoassay-codes (extensible)

Must SupportTrue
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
Observation.interpretation:bead-plausible-reason.coding.version
ShortVersion 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.

Cardinality0..1
Typestring
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.7
  • rim: ./codeSystemVersion
  • orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
Observation.interpretation:bead-plausible-reason.coding.code
ShortSymbol 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).

Cardinality1..1
Typecode
Binding

http://fhir.nmdp.org/terminology/fhir/ValueSet/hla-immunoassay-bead-plausible-reason (extensible)

Must SupportTrue
SummaryTrue
Requirements

Need to refer to a particular code in the system.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
Observation.interpretation:bead-plausible-reason.coding.display
ShortRepresentation defined by the system
Definition

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

Cardinality0..1
Typestring
SummaryTrue
Requirements

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
Observation.interpretation:bead-plausible-reason.coding.userSelected
ShortIf 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).

Cardinality0..1
Typeboolean
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • 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 ]
Observation.interpretation:bead-plausible-reason.text
ShortPlain 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.

Cardinality0..1
Typestring
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.9. But note many systems use C*E.2 for this
  • rim: ./originalText[mediaType/code="text/plain"]/data
  • orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
Observation.note
ShortComments about the observation
Definition

Comments about the observation or the results.

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: NTE.3 (partner NTE to OBX, or sometimes another (child?) OBX)
  • rim: subjectOf.observationEvent[code="annotation"].value
Observation.bodySite
ShortObserved body part
Definition

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

Cardinality0..0
TypeCodeableConcept
Binding

Codes describing anatomical locations. May include laterality.

SNOMEDCTBodyStructures (example)

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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • sct-concept: < 123037004 |Body structure|
  • v2: OBX-20
  • rim: targetSiteCode
  • sct-attr: 718497002 |Inherent location|
Observation.method
ShortHow it was done
Definition

Indicates the mechanism used to perform the observation.

Cardinality0..1
TypeCodeableConcept
Binding

Methods for simple observations.

ObservationMethods (example)

Requirements

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

Comments

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: OBX-17
  • rim: methodCode
Observation.specimen
ShortSpecimen used for this observation
Definition

The specimen that was used when this observation was made.

Cardinality0..1
TypeReference(USCoreSpecimenProfile)
Must SupportTrue
Comments

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • sct-concept: < 123038009 |Specimen|
  • v2: SPM segment
  • rim: participation[typeCode=SPC].specimen
  • sct-attr: 704319004 |Inherent in|
Observation.device
Short(Measurement) Device
Definition

The device used to generate the observation data.

Cardinality0..1
TypeReference(Device | DeviceMetric)
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • sct-concept: < 49062001 |Device|
  • v2: OBX-17 / PRT -10
  • rim: participation[typeCode=DEV]
  • sct-attr: 424226004 |Using device|
Observation.referenceRange
ShortResult reference range
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.

Cardinality0..0
TypeBackboneElement
Must SupportTrue
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

Upper and lower limit of test values expected for a designated population of individuals. Reference range values may differ by patient characteristics, laboratory test manufacturer and laboratory test performer.

ConditionsThe cardinality or value of this element may be affected by these constraints: us-core-22
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()
  • us-core-22: SHALL use UCUM for coded quantity units.
    (low.system.empty() or low.system = 'http://unitsofmeasure.org') and (high.system.empty() or high.system = 'http://unitsofmeasure.org')
Mappings
  • v2: OBX.7
  • rim: outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]
Observation.referenceRange.id
ShortUnique id for inter-element referencing
Definition

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

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Observation.referenceRange.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Observation.referenceRange.modifierExtension
ShortExtensions that cannot be ignored even if unrecognized
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).

Cardinality0..*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
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

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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
Observation.referenceRange.low
ShortLow 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).

Cardinality0..1
TypeSimpleQuantity
ConditionsThe cardinality or value of this element may be affected by these constraints: obs-3
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: OBX-7
  • rim: value:IVL_PQ.low
Observation.referenceRange.high
ShortHigh 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).

Cardinality0..1
TypeSimpleQuantity
ConditionsThe cardinality or value of this element may be affected by these constraints: obs-3
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: OBX-7
  • rim: value:IVL_PQ.high
Observation.referenceRange.type
ShortReference range qualifier
Definition

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

Cardinality0..1
TypeCodeableConcept
Binding

Code for the meaning of a reference range.

ObservationReferenceRangeMeaningCodes (preferred)

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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • sct-concept: < 260245000 |Findings values| OR < 365860008 |General clinical state finding| OR < 250171008 |Clinical history or observation findings| OR < 415229000 |Racial group| OR < 365400002 |Finding of puberty stage| OR < 443938003 |Procedure carried out on subject|
  • v2: OBX-10
  • rim: interpretationCode
Observation.referenceRange.appliesTo
ShortReference 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.

Cardinality0..*
TypeCodeableConcept
Binding

Codes identifying the population the reference range applies to.

ObservationReferenceRangeAppliesToCodes (example)

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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • sct-concept: < 260245000 |Findings values| OR < 365860008 |General clinical state finding| OR < 250171008 |Clinical history or observation findings| OR < 415229000 |Racial group| OR < 365400002 |Finding of puberty stage| OR < 443938003 |Procedure carried out on subject|
  • v2: OBX-10
  • rim: interpretationCode
Observation.referenceRange.age
ShortApplicable 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.

Cardinality0..1
TypeRange
Requirements

Some analytes vary greatly over age.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: outboundRelationship[typeCode=PRCN].targetObservationCriterion[code="age"].value
Observation.referenceRange.text
ShortText 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".

Cardinality0..1
Typestring
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: OBX-7
  • rim: value:ST
Observation.hasMember
ShortRelated resource that belongs to the Observation group
Definition

This observation is a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group.

Cardinality0..*
TypeReference(Observation | QuestionnaireResponse | MolecularSequence)
SummaryTrue
Comments

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: Relationships established by OBX-4 usage
  • rim: outBoundRelationship
Observation.derivedFrom
ShortRelated 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.

Cardinality0..*
TypeReference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence)
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: Relationships established by OBX-4 usage
  • rim: .targetObservation
Observation.component
ShortComponent results
Definition

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

Cardinality1..*
TypeBackboneElement
Must SupportTrue
SummaryTrue
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.

Slicing

Unordered, Open, by $this(Value)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: containment by OBX-4?
  • rim: outBoundRelationship[typeCode=COMP]
Observation.component.id
ShortUnique id for inter-element referencing
Definition

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

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Observation.component.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Observation.component.modifierExtension
ShortExtensions that cannot be ignored even if unrecognized
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).

Cardinality0..*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
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

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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
Observation.component.code
ShortType of component observation (code / type)
Definition

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

Cardinality1..1
TypeCodeableConcept
Binding

Codes identifying names of simple observations.

LOINCCodes (example)

SummaryTrue
Requirements

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

Comments

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.what[x]
  • sct-concept: < 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|
  • v2: OBX-3
  • rim: code
Observation.component.code.id
ShortUnique id for inter-element referencing
Definition

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

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Observation.component.code.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Observation.component.code.coding
ShortCode defined by a terminology system
Definition

A reference to a code defined by a terminology system.

Cardinality0..1
TypeCoding
SummaryTrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
Observation.component.code.coding.id
ShortUnique id for inter-element referencing
Definition

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

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Observation.component.code.coding.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Observation.component.code.coding.system
ShortIdentity of the terminology system
Definition

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

Cardinality0..1
Typeuri
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
Observation.component.code.coding.version
ShortVersion 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.

Cardinality0..1
Typestring
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.7
  • rim: ./codeSystemVersion
  • orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
Observation.component.code.coding.code
ShortSymbol 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).

Cardinality0..1
Typecode
SummaryTrue
Requirements

Need to refer to a particular code in the system.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
Observation.component.code.coding.display
ShortRepresentation defined by the system
Definition

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

Cardinality0..1
Typestring
SummaryTrue
Requirements

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
Observation.component.code.coding.userSelected
ShortIf 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).

Cardinality0..1
Typeboolean
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • 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 ]
Observation.component.code.text
ShortPlain 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.

Cardinality1..1
Typestring
Must SupportTrue
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed Value
HLA Immuno-assay Bead Information
Mappings
  • v2: C*E.9. But note many systems use C*E.2 for this
  • rim: ./originalText[mediaType/code="text/plain"]/data
  • orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
Observation.component.value[x]
ShortActual component result
Definition

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

Cardinality0..1
TypeQuantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period
SummaryTrue
Requirements

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

Comments

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
  • v2: OBX.2, OBX.5, OBX.6
  • rim: value
  • sct-attr: 363714003 |Interprets|
Observation.component.dataAbsentReason
ShortWhy the component result is missing
Definition

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

Cardinality0..1
TypeCodeableConcept
Binding

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

DataAbsentReason (extensible)

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

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. Because of these options, use-case agreements are required to interpret general observations for exceptional values.

ConditionsThe cardinality or value of this element may be affected by these constraints: obs-6
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: N/A
  • rim: value.nullFlavor
Observation.component.interpretation
ShortHigh, low, normal, etc.
Definition

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

Cardinality0..*
TypeCodeableConcept
Binding

Codes identifying interpretations of observations.

ObservationInterpretationCodes (extensible)

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • sct-concept: < 260245000 |Findings values|
  • v2: OBX-8
  • rim: interpretationCode
  • sct-attr: 363713009 |Has interpretation|
Observation.component.referenceRange
ShortProvides guide for interpretation of component result
Definition

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

Cardinality0..*
Typesee (referenceRange)
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: OBX.7
  • rim: outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]
Observation.component:bead-hla-target-type
ShortComponent results
Definition

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

Cardinality1..1
TypeBackboneElement
Must SupportTrue
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: containment by OBX-4?
  • rim: outBoundRelationship[typeCode=COMP]
Observation.component:bead-hla-target-type.id
ShortUnique id for inter-element referencing
Definition

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

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Observation.component:bead-hla-target-type.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Observation.component:bead-hla-target-type.modifierExtension
ShortExtensions that cannot be ignored even if unrecognized
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).

Cardinality0..*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
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

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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
Observation.component:bead-hla-target-type.code
ShortType of component observation (code / type)
Definition

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

Cardinality1..1
TypeCodeableConcept
Binding

Codes identifying names of simple observations.

LOINCCodes (example)

SummaryTrue
Requirements

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

Comments

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.what[x]
  • sct-concept: < 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|
  • v2: OBX-3
  • rim: code
Observation.component:bead-hla-target-type.code.id
ShortUnique id for inter-element referencing
Definition

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

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Observation.component:bead-hla-target-type.code.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Observation.component:bead-hla-target-type.code.coding
ShortCode defined by a terminology system
Definition

A reference to a code defined by a terminology system.

Cardinality0..1
TypeCoding
SummaryTrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
Observation.component:bead-hla-target-type.code.coding.id
ShortUnique id for inter-element referencing
Definition

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

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Observation.component:bead-hla-target-type.code.coding.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Observation.component:bead-hla-target-type.code.coding.system
ShortIdentity of the terminology system
Definition

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

Cardinality0..1
Typeuri
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
Observation.component:bead-hla-target-type.code.coding.version
ShortVersion 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.

Cardinality0..1
Typestring
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.7
  • rim: ./codeSystemVersion
  • orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
Observation.component:bead-hla-target-type.code.coding.code
ShortSymbol 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).

Cardinality0..1
Typecode
SummaryTrue
Requirements

Need to refer to a particular code in the system.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
Observation.component:bead-hla-target-type.code.coding.display
ShortRepresentation defined by the system
Definition

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

Cardinality0..1
Typestring
SummaryTrue
Requirements

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
Observation.component:bead-hla-target-type.code.coding.userSelected
ShortIf 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).

Cardinality0..1
Typeboolean
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • 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 ]
Observation.component:bead-hla-target-type.code.text
ShortPlain 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.

Cardinality1..1
Typestring
Must SupportTrue
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed Value
HLA Immuno-assay Bead Information
Mappings
  • v2: C*E.9. But note many systems use C*E.2 for this
  • rim: ./originalText[mediaType/code="text/plain"]/data
  • orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
Observation.component:bead-hla-target-type.value[x]
ShortActual component result
Definition

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

Cardinality1..1
Typestring
Binding

http://fhir.nmdp.org/terminology/glstring (required)

SummaryTrue
Requirements

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

Comments

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
  • v2: OBX.2, OBX.5, OBX.6
  • rim: value
  • sct-attr: 363714003 |Interprets|
Observation.component:bead-hla-target-type.dataAbsentReason
ShortWhy the component result is missing
Definition

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

Cardinality0..1
TypeCodeableConcept
Binding

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

DataAbsentReason (extensible)

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

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. Because of these options, use-case agreements are required to interpret general observations for exceptional values.

ConditionsThe cardinality or value of this element may be affected by these constraints: obs-6
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: N/A
  • rim: value.nullFlavor
Observation.component:bead-hla-target-type.interpretation
ShortHigh, low, normal, etc.
Definition

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

Cardinality0..*
TypeCodeableConcept
Binding

Codes identifying interpretations of observations.

ObservationInterpretationCodes (extensible)

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • sct-concept: < 260245000 |Findings values|
  • v2: OBX-8
  • rim: interpretationCode
  • sct-attr: 363713009 |Has interpretation|
Observation.component:bead-hla-target-type.referenceRange
ShortProvides guide for interpretation of component result
Definition

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

Cardinality0..*
Typesee (referenceRange)
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: OBX.7
  • rim: outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]
Observation.component:bead-hla-target-serological-specificity
ShortComponent results
Definition

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

Cardinality1..1
TypeBackboneElement
Must SupportTrue
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: containment by OBX-4?
  • rim: outBoundRelationship[typeCode=COMP]
Observation.component:bead-hla-target-serological-specificity.id
ShortUnique id for inter-element referencing
Definition

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

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Observation.component:bead-hla-target-serological-specificity.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Observation.component:bead-hla-target-serological-specificity.modifierExtension
ShortExtensions that cannot be ignored even if unrecognized
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).

Cardinality0..*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
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

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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
Observation.component:bead-hla-target-serological-specificity.code
ShortType of component observation (code / type)
Definition

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

Cardinality1..1
TypeCodeableConcept
Binding

Codes identifying names of simple observations.

LOINCCodes (example)

SummaryTrue
Requirements

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

Comments

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.what[x]
  • sct-concept: < 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|
  • v2: OBX-3
  • rim: code
Observation.component:bead-hla-target-serological-specificity.code.id
ShortUnique id for inter-element referencing
Definition

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

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Observation.component:bead-hla-target-serological-specificity.code.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Observation.component:bead-hla-target-serological-specificity.code.coding
ShortCode defined by a terminology system
Definition

A reference to a code defined by a terminology system.

Cardinality0..1
TypeCoding
SummaryTrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
Observation.component:bead-hla-target-serological-specificity.code.coding.id
ShortUnique id for inter-element referencing
Definition

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

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Observation.component:bead-hla-target-serological-specificity.code.coding.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Observation.component:bead-hla-target-serological-specificity.code.coding.system
ShortIdentity of the terminology system
Definition

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

Cardinality0..1
Typeuri
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
Observation.component:bead-hla-target-serological-specificity.code.coding.version
ShortVersion 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.

Cardinality0..1
Typestring
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.7
  • rim: ./codeSystemVersion
  • orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
Observation.component:bead-hla-target-serological-specificity.code.coding.code
ShortSymbol 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).

Cardinality0..1
Typecode
SummaryTrue
Requirements

Need to refer to a particular code in the system.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
Observation.component:bead-hla-target-serological-specificity.code.coding.display
ShortRepresentation defined by the system
Definition

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

Cardinality0..1
Typestring
SummaryTrue
Requirements

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
Observation.component:bead-hla-target-serological-specificity.code.coding.userSelected
ShortIf 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).

Cardinality0..1
Typeboolean
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • 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 ]
Observation.component:bead-hla-target-serological-specificity.code.text
ShortPlain 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.

Cardinality1..1
Typestring
Must SupportTrue
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed Value
HLA Immuno-assay Bead Information
Mappings
  • v2: C*E.9. But note many systems use C*E.2 for this
  • rim: ./originalText[mediaType/code="text/plain"]/data
  • orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
Observation.component:bead-hla-target-serological-specificity.value[x]
ShortActual component result
Definition

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

Cardinality1..1
Typestring
Binding

http://fhir.nmdp.org/terminology/glstring (required)

Must SupportTrue
SummaryTrue
Requirements

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

Comments

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
  • v2: OBX.2, OBX.5, OBX.6
  • rim: value
  • sct-attr: 363714003 |Interprets|
Observation.component:bead-hla-target-serological-specificity.dataAbsentReason
ShortWhy the component result is missing
Definition

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

Cardinality0..1
TypeCodeableConcept
Binding

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

DataAbsentReason (extensible)

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

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. Because of these options, use-case agreements are required to interpret general observations for exceptional values.

ConditionsThe cardinality or value of this element may be affected by these constraints: obs-6
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: N/A
  • rim: value.nullFlavor
Observation.component:bead-hla-target-serological-specificity.interpretation
ShortHigh, low, normal, etc.
Definition

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

Cardinality0..*
TypeCodeableConcept
Binding

Codes identifying interpretations of observations.

ObservationInterpretationCodes (extensible)

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • sct-concept: < 260245000 |Findings values|
  • v2: OBX-8
  • rim: interpretationCode
  • sct-attr: 363713009 |Has interpretation|
Observation.component:bead-hla-target-serological-specificity.referenceRange
ShortProvides guide for interpretation of component result
Definition

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

Cardinality0..*
Typesee (referenceRange)
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: OBX.7
  • rim: outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]
Observation.component:bead-type
ShortComponent results
Definition

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

Cardinality1..1
TypeBackboneElement
Must SupportTrue
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: containment by OBX-4?
  • rim: outBoundRelationship[typeCode=COMP]
Observation.component:bead-type.id
ShortUnique id for inter-element referencing
Definition

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

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Observation.component:bead-type.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Observation.component:bead-type.modifierExtension
ShortExtensions that cannot be ignored even if unrecognized
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).

Cardinality0..*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
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

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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
Observation.component:bead-type.code
ShortType of component observation (code / type)
Definition

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

Cardinality1..1
TypeCodeableConcept
Binding

Codes identifying names of simple observations.

LOINCCodes (example)

SummaryTrue
Requirements

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

Comments

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.what[x]
  • sct-concept: < 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|
  • v2: OBX-3
  • rim: code
Observation.component:bead-type.code.id
ShortUnique id for inter-element referencing
Definition

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

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Observation.component:bead-type.code.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Observation.component:bead-type.code.coding
ShortCode defined by a terminology system
Definition

A reference to a code defined by a terminology system.

Cardinality0..1
TypeCoding
SummaryTrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
Observation.component:bead-type.code.coding.id
ShortUnique id for inter-element referencing
Definition

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

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Observation.component:bead-type.code.coding.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Observation.component:bead-type.code.coding.system
ShortIdentity of the terminology system
Definition

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

Cardinality1..1
Typeuri
Binding

http://fhir.nmdp.org/terminology/fhir/CodeSystem/hla-immunoassay-codes (extensible)

Must SupportTrue
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
Observation.component:bead-type.code.coding.version
ShortVersion 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.

Cardinality0..1
Typestring
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.7
  • rim: ./codeSystemVersion
  • orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
Observation.component:bead-type.code.coding.code
ShortSymbol 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).

Cardinality1..1
Typecode
Binding

http://fhir.nmdp.org/terminology/fhir/ValueSet/hla-immunoassay-bead-type (extensible)

Must SupportTrue
SummaryTrue
Requirements

Need to refer to a particular code in the system.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
Observation.component:bead-type.code.coding.display
ShortRepresentation defined by the system
Definition

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

Cardinality0..1
Typestring
SummaryTrue
Requirements

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
Observation.component:bead-type.code.coding.userSelected
ShortIf 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).

Cardinality0..1
Typeboolean
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • 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 ]
Observation.component:bead-type.code.text
ShortPlain 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.

Cardinality1..1
Typestring
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed Value
HLA Immuno-assay Bead Information
Mappings
  • v2: C*E.9. But note many systems use C*E.2 for this
  • rim: ./originalText[mediaType/code="text/plain"]/data
  • orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
Observation.component:bead-type.value[x]
ShortActual component result
Definition

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

Cardinality0..1
TypeQuantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period
SummaryTrue
Requirements

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

Comments

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
  • v2: OBX.2, OBX.5, OBX.6
  • rim: value
  • sct-attr: 363714003 |Interprets|
Observation.component:bead-type.dataAbsentReason
ShortWhy the component result is missing
Definition

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

Cardinality0..1
TypeCodeableConcept
Binding

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

DataAbsentReason (extensible)

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

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. Because of these options, use-case agreements are required to interpret general observations for exceptional values.

ConditionsThe cardinality or value of this element may be affected by these constraints: obs-6
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: N/A
  • rim: value.nullFlavor
Observation.component:bead-type.interpretation
ShortHigh, low, normal, etc.
Definition

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

Cardinality0..*
TypeCodeableConcept
Binding

Codes identifying interpretations of observations.

ObservationInterpretationCodes (extensible)

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • sct-concept: < 260245000 |Findings values|
  • v2: OBX-8
  • rim: interpretationCode
  • sct-attr: 363713009 |Has interpretation|
Observation.component:bead-type.referenceRange
ShortProvides guide for interpretation of component result
Definition

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

Cardinality0..*
Typesee (referenceRange)
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: OBX.7
  • rim: outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]
Observation.component:bead-count
ShortComponent results
Definition

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

Cardinality0..1
TypeBackboneElement
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: containment by OBX-4?
  • rim: outBoundRelationship[typeCode=COMP]
Observation.component:bead-count.id
ShortUnique id for inter-element referencing
Definition

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

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Observation.component:bead-count.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Observation.component:bead-count.modifierExtension
ShortExtensions that cannot be ignored even if unrecognized
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).

Cardinality0..*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
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

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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
Observation.component:bead-count.code
ShortType of component observation (code / type)
Definition

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

Cardinality1..1
TypeCodeableConcept
Binding

Codes identifying names of simple observations.

LOINCCodes (example)

SummaryTrue
Requirements

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

Comments

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.what[x]
  • sct-concept: < 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|
  • v2: OBX-3
  • rim: code
Observation.component:bead-count.code.id
ShortUnique id for inter-element referencing
Definition

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

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Observation.component:bead-count.code.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Observation.component:bead-count.code.coding
ShortCode defined by a terminology system
Definition

A reference to a code defined by a terminology system.

Cardinality0..1
TypeCoding
SummaryTrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
Observation.component:bead-count.code.text
ShortPlain 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.

Cardinality1..1
Typestring
Must SupportTrue
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed Value
HLA Immuno-assay Bead Information
Mappings
  • v2: C*E.9. But note many systems use C*E.2 for this
  • rim: ./originalText[mediaType/code="text/plain"]/data
  • orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
Observation.component:bead-count.value[x]
ShortActual component result
Definition

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

Cardinality1..1
Typeinteger
SummaryTrue
Requirements

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

Comments

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
  • v2: OBX.2, OBX.5, OBX.6
  • rim: value
  • sct-attr: 363714003 |Interprets|
Observation.component:bead-count.dataAbsentReason
ShortWhy the component result is missing
Definition

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

Cardinality0..1
TypeCodeableConcept
Binding

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

DataAbsentReason (extensible)

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

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. Because of these options, use-case agreements are required to interpret general observations for exceptional values.

ConditionsThe cardinality or value of this element may be affected by these constraints: obs-6
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: N/A
  • rim: value.nullFlavor
Observation.component:bead-count.interpretation
ShortHigh, low, normal, etc.
Definition

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

Cardinality0..*
TypeCodeableConcept
Binding

Codes identifying interpretations of observations.

ObservationInterpretationCodes (extensible)

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • sct-concept: < 260245000 |Findings values|
  • v2: OBX-8
  • rim: interpretationCode
  • sct-attr: 363713009 |Has interpretation|
Observation.component:bead-count.referenceRange
ShortProvides guide for interpretation of component result
Definition

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

Cardinality0..*
Typesee (referenceRange)
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: OBX.7
  • rim: outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]
Observation.component:bead-conversion-formula
ShortComponent results
Definition

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

Cardinality0..1
TypeBackboneElement
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: containment by OBX-4?
  • rim: outBoundRelationship[typeCode=COMP]
Observation.component:bead-conversion-formula.id
ShortUnique id for inter-element referencing
Definition

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

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Observation.component:bead-conversion-formula.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Observation.component:bead-conversion-formula.modifierExtension
ShortExtensions that cannot be ignored even if unrecognized
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).

Cardinality0..*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
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

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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
Observation.component:bead-conversion-formula.code
ShortType of component observation (code / type)
Definition

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

Cardinality1..1
TypeCodeableConcept
Binding

Codes identifying names of simple observations.

LOINCCodes (example)

SummaryTrue
Requirements

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

Comments

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.what[x]
  • sct-concept: < 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|
  • v2: OBX-3
  • rim: code
Observation.component:bead-conversion-formula.code.id
ShortUnique id for inter-element referencing
Definition

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

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Observation.component:bead-conversion-formula.code.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Observation.component:bead-conversion-formula.code.coding
ShortCode defined by a terminology system
Definition

A reference to a code defined by a terminology system.

Cardinality0..1
TypeCoding
SummaryTrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
Observation.component:bead-conversion-formula.code.text
ShortPlain 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.

Cardinality1..1
Typestring
Must SupportTrue
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed Value
HLA Immuno-assay Bead Information
Mappings
  • v2: C*E.9. But note many systems use C*E.2 for this
  • rim: ./originalText[mediaType/code="text/plain"]/data
  • orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
Observation.component:bead-conversion-formula.value[x]
ShortActual component result
Definition

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

Cardinality1..1
Typestring
SummaryTrue
Requirements

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

Comments

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
  • v2: OBX.2, OBX.5, OBX.6
  • rim: value
  • sct-attr: 363714003 |Interprets|
Observation.component:bead-conversion-formula.dataAbsentReason
ShortWhy the component result is missing
Definition

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

Cardinality0..1
TypeCodeableConcept
Binding

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

DataAbsentReason (extensible)

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

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. Because of these options, use-case agreements are required to interpret general observations for exceptional values.

ConditionsThe cardinality or value of this element may be affected by these constraints: obs-6
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: N/A
  • rim: value.nullFlavor
Observation.component:bead-conversion-formula.interpretation
ShortHigh, low, normal, etc.
Definition

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

Cardinality0..*
TypeCodeableConcept
Binding

Codes identifying interpretations of observations.

ObservationInterpretationCodes (extensible)

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • sct-concept: < 260245000 |Findings values|
  • v2: OBX-8
  • rim: interpretationCode
  • sct-attr: 363713009 |Has interpretation|
Observation.component:bead-conversion-formula.referenceRange
ShortProvides guide for interpretation of component result
Definition

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

Cardinality0..*
Typesee (referenceRange)
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: OBX.7
  • rim: outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]
Observation.component:bead-converted-mfi
ShortComponent results
Definition

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

Cardinality1..1
TypeBackboneElement
Must SupportTrue
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: containment by OBX-4?
  • rim: outBoundRelationship[typeCode=COMP]
Observation.component:bead-converted-mfi.id
ShortUnique id for inter-element referencing
Definition

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

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Observation.component:bead-converted-mfi.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Observation.component:bead-converted-mfi.modifierExtension
ShortExtensions that cannot be ignored even if unrecognized
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).

Cardinality0..*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
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

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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
Observation.component:bead-converted-mfi.code
ShortType of component observation (code / type)
Definition

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

Cardinality1..1
TypeCodeableConcept
Binding

Codes identifying names of simple observations.

LOINCCodes (example)

SummaryTrue
Requirements

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

Comments

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.what[x]
  • sct-concept: < 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|
  • v2: OBX-3
  • rim: code
Observation.component:bead-converted-mfi.code.id
ShortUnique id for inter-element referencing
Definition

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

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Observation.component:bead-converted-mfi.code.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Observation.component:bead-converted-mfi.code.coding
ShortCode defined by a terminology system
Definition

A reference to a code defined by a terminology system.

Cardinality0..1
TypeCoding
SummaryTrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
Observation.component:bead-converted-mfi.code.text
ShortPlain 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.

Cardinality1..1
Typestring
Must SupportTrue
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed Value
HLA Immuno-assay Bead Information
Mappings
  • v2: C*E.9. But note many systems use C*E.2 for this
  • rim: ./originalText[mediaType/code="text/plain"]/data
  • orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
Observation.component:bead-converted-mfi.value[x]
ShortActual component result
Definition

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

Cardinality1..1
Typeinteger
Must SupportTrue
SummaryTrue
Requirements

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

Comments

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • sct-concept: 363714003 |Interprets| < 441742003 |Evaluation finding|
  • v2: OBX.2, OBX.5, OBX.6
  • rim: value
  • sct-attr: 363714003 |Interprets|
Observation.component:bead-converted-mfi.dataAbsentReason
ShortWhy the component result is missing
Definition

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

Cardinality0..1
TypeCodeableConcept
Binding

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

DataAbsentReason (extensible)

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

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. Because of these options, use-case agreements are required to interpret general observations for exceptional values.

ConditionsThe cardinality or value of this element may be affected by these constraints: obs-6
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: N/A
  • rim: value.nullFlavor
Observation.component:bead-converted-mfi.interpretation
ShortHigh, low, normal, etc.
Definition

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

Cardinality0..*
TypeCodeableConcept
Binding

Codes identifying interpretations of observations.

ObservationInterpretationCodes (extensible)

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • sct-concept: < 260245000 |Findings values|
  • v2: OBX-8
  • rim: interpretationCode
  • sct-attr: 363713009 |Has interpretation|
Observation.component:bead-converted-mfi.referenceRange
ShortProvides guide for interpretation of component result
Definition

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

Cardinality0..*
Typesee (referenceRange)
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: OBX.7
  • rim: outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]
This is the resource in XML:
<StructureDefinition xmlns="http://hl7.org/fhir">
<url value="https://fhir.nmdp.org/ig/HlaAntibodyReport/StructureDefinition/hla-immunoassay-target-bead-observation" />
<version value="0.2.0" />
<name value="HLAImmunoassayTargetBeadObservation" />
<title value="HLA Immunoassay Target Bead Observation" />
<status value="draft" />
<publisher value="NMDP" />
<name value="David Wroe" />
<system value="email" />
<value value="fhir@nmdp.org" />
<use value="work" />
</telecom>
</contact>
<description value="# HLA Immunoassay Target Bead Observation\n\nExtension of US Core lab result observation to capture attributes specific to solid-phase immuno-assay bead test results.\n\nA single bead within a solid phase panel.\nThe bead MUST have a specificity, which may be an allele name or a serological specificity.\nThe bead MUST reference the working-sample specimen\nThe bead MAY be referenced by it's corresponding positive and negative controls.\n\n## Elements:\n----------\n* **bead-info**: Structure containing details on the specificity and identifiers of an individual bead\n* **raw-data**: Structure containing measured MFI or raw data as measured in the assay.\n* **converted-data**: Structure containing converted MFIs, formulas used, and interpretations of bead-specific results.\n\n## bead-info\n* **bead-id**\n* **bead-type**: Target bead type\n* **HLA-target-type**\n* **HLA-target-serological-specificity**\n* **number of beads**\n* **raw-MFI**\n* **formula**\n* **adjusted-MFI**\n* **bead-interpretation**\n* **bead-plausible**\n* **bead-plausible-reason**\n* **working-sample-id**: Reference" />
<purpose value="Part of HLA Antibody Diagnostic Report implementation guide to capture results specifically for immunoassay bead results" />
<fhirVersion value="4.0.1" />
<kind value="resource" />
<abstract value="false" />
<type value="Observation" />
<baseDefinition value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-lab" />
<derivation value="constraint" />
<element id="Observation.identifier">
<path value="Observation.identifier" />
<min value="1" />
<max value="1" />
</element>
<element id="Observation.identifier.value">
<path value="Observation.identifier.value" />
<label value="Bead Identifier" />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="Observation.partOf.reference">
<path value="Observation.partOf.reference" />
<label value="HLA Antibody Diagnostic Report Ref" />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="Observation.code.coding.system">
<path value="Observation.code.coding.system" />
<min value="1" />
<strength value="required" />
<valueSet value="http://fhir.nmdp.org/terminology/HLAImmunoAssay" />
</binding>
</element>
<element id="Observation.focus">
<path value="Observation.focus" />
<max value="0" />
</element>
<element id="Observation.encounter">
<path value="Observation.encounter" />
<max value="0" />
</element>
<element id="Observation.value[x]">
<path value="Observation.value[x]" />
<label value="Raw MFI" />
<min value="1" />
<code value="integer" />
</type>
</element>
<element id="Observation.interpretation">
<path value="Observation.interpretation" />
<type value="value" />
<path value="$this" />
</discriminator>
<rules value="open" />
</slicing>
<min value="1" />
</element>
<element id="Observation.interpretation:bead-interpretation-classification-entity">
<path value="Observation.interpretation" />
<sliceName value="bead-interpretation-classification-entity" />
<short value="Bead result classification entity" />
<definition value="Bead observation interpretation indicating the person or entity performing the interpretation of the bead result." />
<max value="1" />
</element>
<element id="Observation.interpretation:bead-interpretation-classification-entity.coding.system">
<path value="Observation.interpretation.coding.system" />
<max value="0" />
<mustSupport value="false" />
</element>
<element id="Observation.interpretation:bead-interpretation-classification-entity.coding.code">
<path value="Observation.interpretation.coding.code" />
<max value="0" />
<mustSupport value="false" />
</element>
<element id="Observation.interpretation:bead-interpretation-classification-entity.text">
<path value="Observation.interpretation.text" />
<label value="Classification Entity" />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="Observation.interpretation:bead-interpretation-classification">
<path value="Observation.interpretation" />
<sliceName value="bead-interpretation-classification" />
<short value="Bead result classification" />
<definition value="Bead observation interpretation indicating the classification of the bead result." />
<max value="1" />
</element>
<element id="Observation.interpretation:bead-interpretation-classification.coding.system">
<path value="Observation.interpretation.coding.system" />
<min value="1" />
<mustSupport value="true" />
<strength value="extensible" />
<valueSet value="http://fhir.nmdp.org/terminology/fhir/CodeSystem/hla-immunoassay-codes" />
</binding>
</element>
<element id="Observation.interpretation:bead-interpretation-classification.coding.code">
<path value="Observation.interpretation.coding.code" />
<min value="1" />
<mustSupport value="true" />
<strength value="extensible" />
<valueSet value="http://fhir.nmdp.org/terminology/hla-antibody-assay/bead-interpretation-classification" />
</binding>
</element>
<element id="Observation.interpretation:bead-interpretation-rank">
<path value="Observation.interpretation" />
<sliceName value="bead-interpretation-rank" />
<short value="Bead result rank" />
<definition value="Bead observation interpretation indicating the rank of the bead result." />
<max value="1" />
</element>
<element id="Observation.interpretation:bead-interpretation-rank.coding.system">
<path value="Observation.interpretation.coding.system" />
<min value="1" />
<mustSupport value="true" />
<strength value="required" />
<valueSet value="http://fhir.nmdp.org/terminology/fhir/CodeSystem/hla-immunoassay-codes" />
</binding>
</element>
<element id="Observation.interpretation:bead-interpretation-rank.coding.code">
<path value="Observation.interpretation.coding.code" />
<min value="1" />
<mustSupport value="true" />
<strength value="extensible" />
<valueSet value="http://fhir.nmdp.org/terminology/hla-antibody-assay/bead-interpretation-ranking" />
</binding>
</element>
<element id="Observation.interpretation:bead-plausible">
<path value="Observation.interpretation" />
<sliceName value="bead-plausible" />
<short value="Bead result plausibility" />
<definition value="Bead observation interpretation indicating the plausibility of the bead result." />
<comment value="Categorical assessment of a laboratory value." />
<max value="1" />
</element>
<element id="Observation.interpretation:bead-plausible.coding">
<path value="Observation.interpretation.coding" />
<max value="1" />
</element>
<element id="Observation.interpretation:bead-plausible.coding.system">
<path value="Observation.interpretation.coding.system" />
<min value="1" />
<mustSupport value="true" />
<strength value="extensible" />
<valueSet value="http://fhir.nmdp.org/terminology/fhir/CodeSystem/hla-immunoassay-codes" />
</binding>
</element>
<element id="Observation.interpretation:bead-plausible.coding.code">
<path value="Observation.interpretation.coding.code" />
<min value="1" />
<mustSupport value="true" />
<strength value="required" />
<valueSet value="http://fhir.nmdp.org/terminology/fhir/ValueSet/hla-immunoassay-boolean" />
</binding>
</element>
<element id="Observation.interpretation:bead-plausible-reason">
<path value="Observation.interpretation" />
<sliceName value="bead-plausible-reason" />
<short value="Bead result plausibility reason" />
<definition value="Bead observation interpretation indicating the reason code for the plausibility assessment of the bead result." />
<comment value="Categorical assessment of a laboratory value." />
<max value="1" />
</element>
<element id="Observation.interpretation:bead-plausible-reason.coding.system">
<path value="Observation.interpretation.coding.system" />
<min value="1" />
<mustSupport value="true" />
<strength value="extensible" />
<valueSet value="http://fhir.nmdp.org/terminology/fhir/CodeSystem/hla-immunoassay-codes" />
</binding>
</element>
<element id="Observation.interpretation:bead-plausible-reason.coding.code">
<path value="Observation.interpretation.coding.code" />
<min value="1" />
<mustSupport value="true" />
<strength value="extensible" />
<valueSet value="http://fhir.nmdp.org/terminology/fhir/ValueSet/hla-immunoassay-bead-plausible-reason" />
</binding>
</element>
<element id="Observation.bodySite">
<path value="Observation.bodySite" />
<max value="0" />
</element>
<element id="Observation.referenceRange">
<path value="Observation.referenceRange" />
<max value="0" />
</element>
<element id="Observation.component">
<path value="Observation.component" />
<label value="bead-info" />
<type value="value" />
<path value="$this" />
</discriminator>
<ordered value="false" />
<rules value="open" />
</slicing>
<min value="1" />
<mustSupport value="true" />
</element>
<element id="Observation.component.code.coding">
<path value="Observation.component.code.coding" />
<max value="1" />
</element>
<element id="Observation.component.code.coding.system">
<path value="Observation.component.code.coding.system" />
<display value="hla-target-type" />
</code>
</element>
<element id="Observation.component.code.text">
<path value="Observation.component.code.text" />
<min value="1" />
<fixedString value="HLA Immuno-assay Bead Information" />
<mustSupport value="true" />
</element>
<element id="Observation.component:bead-hla-target-type">
<path value="Observation.component" />
<sliceName value="bead-hla-target-type" />
<min value="1" />
<max value="1" />
<mustSupport value="true" />
</element>
<element id="Observation.component:bead-hla-target-type.code.coding.display">
<path value="Observation.component.code.coding.display" />
<label value="hla-target-serological-specificity" />
</element>
<element id="Observation.component:bead-hla-target-type.code.text">
<path value="Observation.component.code.text" />
<label value="hla-target-type" />
<min value="1" />
</element>
<element id="Observation.component:bead-hla-target-type.value[x]">
<path value="Observation.component.value[x]" />
<min value="1" />
<code value="string" />
</type>
<strength value="required" />
<valueSet value="http://fhir.nmdp.org/terminology/glstring" />
</binding>
</element>
<element id="Observation.component:bead-hla-target-serological-specificity">
<path value="Observation.component" />
<sliceName value="bead-hla-target-serological-specificity" />
<label value="hla-target-serological-specificity" />
<min value="1" />
<max value="1" />
<mustSupport value="true" />
</element>
<element id="Observation.component:bead-hla-target-serological-specificity.code.coding.display">
<path value="Observation.component.code.coding.display" />
<mustSupport value="false" />
</element>
<element id="Observation.component:bead-hla-target-serological-specificity.code.text">
<path value="Observation.component.code.text" />
<label value="hla-target-serological-specificity" />
<mustSupport value="true" />
</element>
<element id="Observation.component:bead-hla-target-serological-specificity.value[x]">
<path value="Observation.component.value[x]" />
<min value="1" />
<code value="string" />
</type>
<mustSupport value="true" />
<strength value="required" />
<valueSet value="http://fhir.nmdp.org/terminology/glstring" />
</binding>
</element>
<element id="Observation.component:bead-type">
<path value="Observation.component" />
<sliceName value="bead-type" />
<min value="1" />
<max value="1" />
<mustSupport value="true" />
</element>
<element id="Observation.component:bead-type.code.coding.system">
<path value="Observation.component.code.coding.system" />
<min value="1" />
<mustSupport value="true" />
<strength value="extensible" />
<valueSet value="http://fhir.nmdp.org/terminology/fhir/CodeSystem/hla-immunoassay-codes" />
</binding>
</element>
<element id="Observation.component:bead-type.code.coding.code">
<path value="Observation.component.code.coding.code" />
<min value="1" />
<mustSupport value="true" />
<strength value="extensible" />
<valueSet value="http://fhir.nmdp.org/terminology/fhir/ValueSet/hla-immunoassay-bead-type" />
</binding>
</element>
<element id="Observation.component:bead-type.code.text">
<path value="Observation.component.code.text" />
<mustSupport value="false" />
</element>
<element id="Observation.component:bead-count">
<path value="Observation.component" />
<sliceName value="bead-count" />
<max value="1" />
</element>
<element id="Observation.component:bead-count.code.text">
<path value="Observation.component.code.text" />
<label value="bead-count" />
<min value="1" />
</element>
<element id="Observation.component:bead-count.value[x]">
<path value="Observation.component.value[x]" />
<min value="1" />
<code value="integer" />
</type>
</element>
<element id="Observation.component:bead-conversion-formula">
<path value="Observation.component" />
<sliceName value="bead-conversion-formula" />
<max value="1" />
</element>
<element id="Observation.component:bead-conversion-formula.code.text">
<path value="Observation.component.code.text" />
<label value="bead-conversion-formula" />
<min value="1" />
</element>
<element id="Observation.component:bead-conversion-formula.value[x]">
<path value="Observation.component.value[x]" />
<min value="1" />
<code value="string" />
</type>
</element>
<element id="Observation.component:bead-converted-mfi">
<path value="Observation.component" />
<sliceName value="bead-converted-mfi" />
<min value="1" />
<max value="1" />
<mustSupport value="true" />
</element>
<element id="Observation.component:bead-converted-mfi.code.text">
<path value="Observation.component.code.text" />
<label value="bead-converted-mfi" />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="Observation.component:bead-converted-mfi.value[x]">
<path value="Observation.component.value[x]" />
<min value="1" />
<code value="integer" />
</type>
<mustSupport value="true" />
</element>
</differential>
</StructureDefinition>
This is the resource in JSON:
{
"resourceType": "StructureDefinition",
"url": "https://fhir.nmdp.org/ig/HlaAntibodyReport/StructureDefinition/hla-immunoassay-target-bead-observation",
"version": "0.2.0",
"name": "HLAImmunoassayTargetBeadObservation",
"title": "HLA Immunoassay Target Bead Observation",
"status": "draft",
"publisher": "NMDP",
"contact": [
{
"name": "David Wroe",
"telecom": [
{
"system": "email",
"value": "fhir@nmdp.org",
"use": "work"
}
]
}
],
"description": "# HLA Immunoassay Target Bead Observation\n\nExtension of US Core lab result observation to capture attributes specific to solid-phase immuno-assay bead test results.\n\nA single bead within a solid phase panel.\nThe bead MUST have a specificity, which may be an allele name or a serological specificity.\nThe bead MUST reference the working-sample specimen\nThe bead MAY be referenced by it's corresponding positive and negative controls.\n\n## Elements:\n----------\n* **bead-info**: Structure containing details on the specificity and identifiers of an individual bead\n* **raw-data**: Structure containing measured MFI or raw data as measured in the assay.\n* **converted-data**: Structure containing converted MFIs, formulas used, and interpretations of bead-specific results.\n\n## bead-info\n* **bead-id**\n* **bead-type**: Target bead type\n* **HLA-target-type**\n* **HLA-target-serological-specificity**\n* **number of beads**\n* **raw-MFI**\n* **formula**\n* **adjusted-MFI**\n* **bead-interpretation**\n* **bead-plausible**\n* **bead-plausible-reason**\n* **working-sample-id**: Reference",
"purpose": "Part of HLA Antibody Diagnostic Report implementation guide to capture results specifically for immunoassay bead results",
"fhirVersion": "4.0.1",
"kind": "resource",
"abstract": false,
"type": "Observation",
"baseDefinition": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-lab",
"derivation": "constraint",
"element": [
{
"id": "Observation.identifier",
"path": "Observation.identifier",
"min": 1,
"max": "1"
},
{
"id": "Observation.identifier.value",
"path": "Observation.identifier.value",
"label": "Bead Identifier",
"min": 1,
"mustSupport": true
},
{
"id": "Observation.partOf.reference",
"path": "Observation.partOf.reference",
"label": "HLA Antibody Diagnostic Report Ref",
"min": 1,
"mustSupport": true
},
{
"id": "Observation.code.coding.system",
"path": "Observation.code.coding.system",
"min": 1,
"binding": {
"strength": "required",
"valueSet": "http://fhir.nmdp.org/terminology/HLAImmunoAssay"
}
},
{
"id": "Observation.focus",
"path": "Observation.focus",
"max": "0"
},
{
"id": "Observation.encounter",
"path": "Observation.encounter",
"max": "0"
},
{
"id": "Observation.value[x]",
"path": "Observation.value[x]",
"label": "Raw MFI",
"min": 1,
"type": [
{
"code": "integer"
}
]
},
{
"id": "Observation.interpretation",
"path": "Observation.interpretation",
"slicing": {
{
"type": "value",
"path": "$this"
}
],
"rules": "open"
},
"min": 1
},
{
"id": "Observation.interpretation:bead-interpretation-classification-entity",
"path": "Observation.interpretation",
"sliceName": "bead-interpretation-classification-entity",
"short": "Bead result classification entity",
"definition": "Bead observation interpretation indicating the person or entity performing the interpretation of the bead result.",
"max": "1"
},
{
"id": "Observation.interpretation:bead-interpretation-classification-entity.coding.system",
"path": "Observation.interpretation.coding.system",
"max": "0",
"mustSupport": false
},
{
"id": "Observation.interpretation:bead-interpretation-classification-entity.coding.code",
"path": "Observation.interpretation.coding.code",
"max": "0",
"mustSupport": false
},
{
"id": "Observation.interpretation:bead-interpretation-classification-entity.text",
"path": "Observation.interpretation.text",
"label": "Classification Entity",
"min": 1,
"mustSupport": true
},
{
"id": "Observation.interpretation:bead-interpretation-classification",
"path": "Observation.interpretation",
"sliceName": "bead-interpretation-classification",
"short": "Bead result classification",
"definition": "Bead observation interpretation indicating the classification of the bead result.",
"max": "1"
},
{
"id": "Observation.interpretation:bead-interpretation-classification.coding.system",
"path": "Observation.interpretation.coding.system",
"min": 1,
"mustSupport": true,
"binding": {
"strength": "extensible",
"valueSet": "http://fhir.nmdp.org/terminology/fhir/CodeSystem/hla-immunoassay-codes"
}
},
{
"id": "Observation.interpretation:bead-interpretation-classification.coding.code",
"path": "Observation.interpretation.coding.code",
"min": 1,
"mustSupport": true,
"binding": {
"strength": "extensible",
"valueSet": "http://fhir.nmdp.org/terminology/hla-antibody-assay/bead-interpretation-classification"
}
},
{
"id": "Observation.interpretation:bead-interpretation-rank",
"path": "Observation.interpretation",
"sliceName": "bead-interpretation-rank",
"short": "Bead result rank",
"definition": "Bead observation interpretation indicating the rank of the bead result.",
"max": "1"
},
{
"id": "Observation.interpretation:bead-interpretation-rank.coding.system",
"path": "Observation.interpretation.coding.system",
"min": 1,
"mustSupport": true,
"binding": {
"strength": "required",
"valueSet": "http://fhir.nmdp.org/terminology/fhir/CodeSystem/hla-immunoassay-codes"
}
},
{
"id": "Observation.interpretation:bead-interpretation-rank.coding.code",
"path": "Observation.interpretation.coding.code",
"min": 1,
"mustSupport": true,
"binding": {
"strength": "extensible",
"valueSet": "http://fhir.nmdp.org/terminology/hla-antibody-assay/bead-interpretation-ranking"
}
},
{
"id": "Observation.interpretation:bead-plausible",
"path": "Observation.interpretation",
"sliceName": "bead-plausible",
"short": "Bead result plausibility",
"definition": "Bead observation interpretation indicating the plausibility of the bead result.",
"comment": "Categorical assessment of a laboratory value.",
"max": "1"
},
{
"id": "Observation.interpretation:bead-plausible.coding",
"path": "Observation.interpretation.coding",
"max": "1"
},
{
"id": "Observation.interpretation:bead-plausible.coding.system",
"path": "Observation.interpretation.coding.system",
"min": 1,
"mustSupport": true,
"binding": {
"strength": "extensible",
"valueSet": "http://fhir.nmdp.org/terminology/fhir/CodeSystem/hla-immunoassay-codes"
}
},
{
"id": "Observation.interpretation:bead-plausible.coding.code",
"path": "Observation.interpretation.coding.code",
"min": 1,
"mustSupport": true,
"binding": {
"strength": "required",
"valueSet": "http://fhir.nmdp.org/terminology/fhir/ValueSet/hla-immunoassay-boolean"
}
},
{
"id": "Observation.interpretation:bead-plausible-reason",
"path": "Observation.interpretation",
"sliceName": "bead-plausible-reason",
"short": "Bead result plausibility reason",
"definition": "Bead observation interpretation indicating the reason code for the plausibility assessment of the bead result.",
"comment": "Categorical assessment of a laboratory value.",
"max": "1"
},
{
"id": "Observation.interpretation:bead-plausible-reason.coding.system",
"path": "Observation.interpretation.coding.system",
"min": 1,
"mustSupport": true,
"binding": {
"strength": "extensible",
"valueSet": "http://fhir.nmdp.org/terminology/fhir/CodeSystem/hla-immunoassay-codes"
}
},
{
"id": "Observation.interpretation:bead-plausible-reason.coding.code",
"path": "Observation.interpretation.coding.code",
"min": 1,
"mustSupport": true,
"binding": {
"strength": "extensible",
"valueSet": "http://fhir.nmdp.org/terminology/fhir/ValueSet/hla-immunoassay-bead-plausible-reason"
}
},
{
"id": "Observation.bodySite",
"path": "Observation.bodySite",
"max": "0"
},
{
"id": "Observation.referenceRange",
"path": "Observation.referenceRange",
"max": "0"
},
{
"id": "Observation.component",
"path": "Observation.component",
"label": "bead-info",
"slicing": {
{
"type": "value",
"path": "$this"
}
],
"ordered": false,
"rules": "open"
},
"min": 1,
"mustSupport": true
},
{
"id": "Observation.component.code.coding",
"path": "Observation.component.code.coding",
"max": "1"
},
{
"id": "Observation.component.code.coding.system",
"path": "Observation.component.code.coding.system",
"code": [
{
"display": "hla-target-type"
}
]
},
{
"id": "Observation.component.code.text",
"path": "Observation.component.code.text",
"min": 1,
"fixedString": "HLA Immuno-assay Bead Information",
"mustSupport": true
},
{
"id": "Observation.component:bead-hla-target-type",
"path": "Observation.component",
"sliceName": "bead-hla-target-type",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"id": "Observation.component:bead-hla-target-type.code.coding.display",
"path": "Observation.component.code.coding.display",
"label": "hla-target-serological-specificity"
},
{
"id": "Observation.component:bead-hla-target-type.code.text",
"path": "Observation.component.code.text",
"label": "hla-target-type",
"min": 1
},
{
"id": "Observation.component:bead-hla-target-type.value[x]",
"path": "Observation.component.value[x]",
"min": 1,
"type": [
{
"code": "string"
}
],
"binding": {
"strength": "required",
"valueSet": "http://fhir.nmdp.org/terminology/glstring"
}
},
{
"id": "Observation.component:bead-hla-target-serological-specificity",
"path": "Observation.component",
"sliceName": "bead-hla-target-serological-specificity",
"label": "hla-target-serological-specificity",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"id": "Observation.component:bead-hla-target-serological-specificity.code.coding.display",
"path": "Observation.component.code.coding.display",
"mustSupport": false
},
{
"id": "Observation.component:bead-hla-target-serological-specificity.code.text",
"path": "Observation.component.code.text",
"label": "hla-target-serological-specificity",
"mustSupport": true
},
{
"id": "Observation.component:bead-hla-target-serological-specificity.value[x]",
"path": "Observation.component.value[x]",
"min": 1,
"type": [
{
"code": "string"
}
],
"mustSupport": true,
"binding": {
"strength": "required",
"valueSet": "http://fhir.nmdp.org/terminology/glstring"
}
},
{
"id": "Observation.component:bead-type",
"path": "Observation.component",
"sliceName": "bead-type",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"id": "Observation.component:bead-type.code.coding.system",
"path": "Observation.component.code.coding.system",
"min": 1,
"mustSupport": true,
"binding": {
"strength": "extensible",
"valueSet": "http://fhir.nmdp.org/terminology/fhir/CodeSystem/hla-immunoassay-codes"
}
},
{
"id": "Observation.component:bead-type.code.coding.code",
"path": "Observation.component.code.coding.code",
"min": 1,
"mustSupport": true,
"binding": {
"strength": "extensible",
"valueSet": "http://fhir.nmdp.org/terminology/fhir/ValueSet/hla-immunoassay-bead-type"
}
},
{
"id": "Observation.component:bead-type.code.text",
"path": "Observation.component.code.text",
"mustSupport": false
},
{
"id": "Observation.component:bead-count",
"path": "Observation.component",
"sliceName": "bead-count",
"max": "1"
},
{
"id": "Observation.component:bead-count.code.text",
"path": "Observation.component.code.text",
"label": "bead-count",
"min": 1
},
{
"id": "Observation.component:bead-count.value[x]",
"path": "Observation.component.value[x]",
"min": 1,
"type": [
{
"code": "integer"
}
]
},
{
"id": "Observation.component:bead-conversion-formula",
"path": "Observation.component",
"sliceName": "bead-conversion-formula",
"max": "1"
},
{
"id": "Observation.component:bead-conversion-formula.code.text",
"path": "Observation.component.code.text",
"label": "bead-conversion-formula",
"min": 1
},
{
"id": "Observation.component:bead-conversion-formula.value[x]",
"path": "Observation.component.value[x]",
"min": 1,
"type": [
{
"code": "string"
}
]
},
{
"id": "Observation.component:bead-converted-mfi",
"path": "Observation.component",
"sliceName": "bead-converted-mfi",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"id": "Observation.component:bead-converted-mfi.code.text",
"path": "Observation.component.code.text",
"label": "bead-converted-mfi",
"min": 1,
"mustSupport": true
},
{
"id": "Observation.component:bead-converted-mfi.value[x]",
"path": "Observation.component.value[x]",
"min": 1,
"type": [
{
"code": "integer"
}
],
"mustSupport": true
}
]
}
}

Terminology Bindings

These are the terminology bindings within this resource:

PathConformanceValueSet
Observation.code.coding.systemrequiredhttp://fhir.nmdp.org/terminology/HLAImmunoAssay
Observation.interpretation:bead-interpretation-classification.coding.systemextensiblehttp://fhir.nmdp.org/terminology/fhir/CodeSystem/hla-immunoassay-codes
Observation.interpretation:bead-interpretation-classification.coding.codeextensiblehttp://fhir.nmdp.org/terminology/hla-antibody-assay/bead-interpretation-classification
Observation.interpretation:bead-interpretation-rank.coding.systemrequiredhttp://fhir.nmdp.org/terminology/fhir/CodeSystem/hla-immunoassay-codes
Observation.interpretation:bead-interpretation-rank.coding.codeextensiblehttp://fhir.nmdp.org/terminology/hla-antibody-assay/bead-interpretation-ranking
Observation.interpretation:bead-plausible.coding.systemextensiblehttp://fhir.nmdp.org/terminology/fhir/CodeSystem/hla-immunoassay-codes
Observation.interpretation:bead-plausible.coding.coderequiredhttp://fhir.nmdp.org/terminology/fhir/ValueSet/hla-immunoassay-boolean
Observation.interpretation:bead-plausible-reason.coding.systemextensiblehttp://fhir.nmdp.org/terminology/fhir/CodeSystem/hla-immunoassay-codes
Observation.interpretation:bead-plausible-reason.coding.codeextensiblehttp://fhir.nmdp.org/terminology/fhir/ValueSet/hla-immunoassay-bead-plausible-reason
Observation.component:bead-hla-target-type.value[x]requiredhttp://fhir.nmdp.org/terminology/glstring
Observation.component:bead-hla-target-serological-specificity.value[x]requiredhttp://fhir.nmdp.org/terminology/glstring
Observation.component:bead-type.code.coding.systemextensiblehttp://fhir.nmdp.org/terminology/fhir/CodeSystem/hla-immunoassay-codes
Observation.component:bead-type.code.coding.codeextensiblehttp://fhir.nmdp.org/terminology/fhir/ValueSet/hla-immunoassay-bead-type

Constraints

These are the constraints (invariants) defined within this resource: