FHIR Extensions Pack
5.1.0 - 5.1.0 (April 2024) International flag

This page is part of the FHIR Core Extensions Registry (v5.1.0: Release 5.1) based on FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Extension: Observation V2 Sub-Id

Official URL: http://hl7.org/fhir/StructureDefinition/observation-v2-subid Version: 5.1.0
Standards status: Trial-use Maturity Level: 0 Responsible: HL7 International / Orders and Observations Computable Name: ObsV2SubId
Other Identifiers: OID:2.16.840.1.113883.4.642.5.1776

A complex extension matching the structure of the V2 OG data type. This is used in the v2-to-fhir mapping IG to capture and preserve the OBX-4 Sub-Id details.

Context of Use

This extension may be used on the following element(s):

  • Element ID Observation

Usage info

Usage:

  • This Extension is not used by any profiles in this Implementation Guide

Changes since version 1.0.0:

  • No changes

    • Formal Views of Extension Content

    Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

    This structure is derived from Extension

    Summary

    Complex Extension: A complex extension matching the structure of the V2 OG data type. This is used in the v2-to-fhir mapping IG to capture and preserve the OBX-4 Sub-Id details.

    • original-sub-identifier: string: The Original Sub-Identifier component represents the original data type used in OBX4 to enable backwards compatibility to continue use of the original format to provide OBX segment grouping.
    • group: decimal: The Group component indicates the group and its sequence within the OBR segment that the OBX segment is a part of.
    • sequence: decimal: The Sequence component indicates the sequence within the group as defined in OG-2.
    • identifier: string: The Identifier component enables assignment of an identifier to a result component, for example an isolate in a microbiology message.

    Maturity: 0

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..1 Extension Observation Grouper
    ... Slices for extension Content/Rules for all slices
    .... extension:original-sub-identifier 0..1 Extension Original Sub-Identifier
    ..... extension 0..0
    ..... url 1..1 uri "original-sub-identifier"
    ..... value[x] 1..1 string Value of extension
    .... extension:group 0..1 Extension Group
    ..... extension 0..0
    ..... url 1..1 uri "group"
    ..... value[x] 1..1 decimal Value of extension
    .... extension:sequence 0..1 Extension Sequence
    ..... extension 0..0
    ..... url 1..1 uri "sequence"
    ..... value[x] 1..1 decimal Value of extension
    .... extension:identifier 0..1 Extension Identifier
    ..... extension 0..0
    ..... url 1..1 uri "identifier"
    ..... value[x] 1..1 string Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/observation-v2-subid"
    ... value[x] 0..0

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..1 Extension Observation Grouper
    ... id 0..1 id Unique id for inter-element referencing
    ... Slices for extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    .... extension:original-sub-identifier 0..1 Extension Original Sub-Identifier
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "original-sub-identifier"
    ..... value[x] 1..1 string Value of extension
    .... extension:group 0..1 Extension Group
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "group"
    ..... value[x] 1..1 decimal Value of extension
    .... extension:sequence 0..1 Extension Sequence
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "sequence"
    ..... value[x] 1..1 decimal Value of extension
    .... extension:identifier 0..1 Extension Identifier
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "identifier"
    ..... value[x] 1..1 string Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/observation-v2-subid"

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Complex Extension: A complex extension matching the structure of the V2 OG data type. This is used in the v2-to-fhir mapping IG to capture and preserve the OBX-4 Sub-Id details.

    • original-sub-identifier: string: The Original Sub-Identifier component represents the original data type used in OBX4 to enable backwards compatibility to continue use of the original format to provide OBX segment grouping.
    • group: decimal: The Group component indicates the group and its sequence within the OBR segment that the OBX segment is a part of.
    • sequence: decimal: The Sequence component indicates the sequence within the group as defined in OG-2.
    • identifier: string: The Identifier component enables assignment of an identifier to a result component, for example an isolate in a microbiology message.

    Maturity: 0

    Differential View

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..1 Extension Observation Grouper
    ... Slices for extension Content/Rules for all slices
    .... extension:original-sub-identifier 0..1 Extension Original Sub-Identifier
    ..... extension 0..0
    ..... url 1..1 uri "original-sub-identifier"
    ..... value[x] 1..1 string Value of extension
    .... extension:group 0..1 Extension Group
    ..... extension 0..0
    ..... url 1..1 uri "group"
    ..... value[x] 1..1 decimal Value of extension
    .... extension:sequence 0..1 Extension Sequence
    ..... extension 0..0
    ..... url 1..1 uri "sequence"
    ..... value[x] 1..1 decimal Value of extension
    .... extension:identifier 0..1 Extension Identifier
    ..... extension 0..0
    ..... url 1..1 uri "identifier"
    ..... value[x] 1..1 string Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/observation-v2-subid"
    ... value[x] 0..0

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..1 Extension Observation Grouper
    ... id 0..1 id Unique id for inter-element referencing
    ... Slices for extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    .... extension:original-sub-identifier 0..1 Extension Original Sub-Identifier
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "original-sub-identifier"
    ..... value[x] 1..1 string Value of extension
    .... extension:group 0..1 Extension Group
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "group"
    ..... value[x] 1..1 decimal Value of extension
    .... extension:sequence 0..1 Extension Sequence
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "sequence"
    ..... value[x] 1..1 decimal Value of extension
    .... extension:identifier 0..1 Extension Identifier
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "identifier"
    ..... value[x] 1..1 string Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/observation-v2-subid"

    doco Documentation for this format

     

    Other representations of profile: CSV, Excel, Schematron

    Constraints

    IdGradePath(s)DetailsRequirements
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    ext-1error**ALL** extensionsMust have either extensions or value[x], not both
    : extension.exists() != value.exists()

    Search Parameters for this Extension

    (none found)