FHIR Release 3 (STU) R4 Ballot #2 (Mixed Normative/Trial use)

This page is part of the FHIR Specification (v3.0.2: STU 3). (v3.5.0: R4 Ballot #2). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see the Directory of published versions . Page versions: R4B R4 R3

Extension: PhaseSet

Orders and Observations Work Group   Maturity Level : 1 Informative Use Context : Any

URL for this extension: 


http://hl7.org/fhir/StructureDefinition/observation-geneticsPhaseSet

Status: draft. Extension maintained by: Health Level Seven International (Clinical Genomics)

Chromosomal phase Phase set identifier (UUID/OID). All sequences with the same PhaseSet identifier are asserted to be on the same chromosome (cis). information.

Context of Use: Use on element: Element ID Observation

usage info: insert a list of places where this extension is used

Extension Content

Summary

Name Flags Card. Type Description & Constraints doco
. . PhaseSet 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/observation-geneticsPhaseSet
PhaseSet: Phase set information.


Use on Element ID Observation
.. . extension Id 0..1 uri URL = http://hl7.org/fhir/StructureDefinition/observation-geneticsPhaseSet This is a globally unique phaseSet id.
PhaseSet: Chromosomal
. . . Sequence 1..* Reference ( Sequence ) Sequence pointed to phase set identifier (UUID/OID). All sequences with the same PhaseSet identifier are asserted to be on the same chromosome (cis). (from: https://www.hl7.org/fhir/STU3/extension-observation-geneticssequence.html).

Use on element: Observation

doco Documentation for this format

Full Structure

Name Flags Card. Type Description & Constraints doco
. . extension 0..1 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/observation-geneticsPhaseSet
PhaseSet: Chromosomal phase Phase set identifier (UUID/OID). All sequences with the same PhaseSet identifier are asserted to be on the same chromosome (cis). information.


Use on element: Element ID Observation
. . . extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
. . . extension 0..1 Extension Phase set ID
.... extension 0..0
... . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/observation-geneticsPhaseSet" "Id"
. . . . valueUri 0..1 uri Value of extension
. . . extension 1..* Extension Phase set sequence
.... extension 0..0
.... url 1..1 uri "Sequence"
.... valueReference 0..1 Reference ( Sequence ) Value of extension
... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/observation-geneticsPhaseSet"
... value[x] 0 .. 0

doco Documentation for this format

XML Template 

<!-- PhaseSet -->doco

< xmlns="http://hl7.org/fhir"

<extension xmlns="http://hl7.org/fhir"

     url="http://hl7.org/fhir/StructureDefinition/observation-geneticsPhaseSet" >
  <!-- from Element: 
 <

 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="Id"> 0..1 Extension  <!-- 0..1 Phase set ID -->
  <valueUri value="[uri]"/><!-- 0..1 Value of extension -->
 </extension>
 <extension url="Sequence"> 1..* Extension  <!-- 1..* Phase set sequence -->
  <valueReference><!-- 0..1 Reference(Sequence) 
      Value of extension --></valueReference>
 </extension>

</extension>

JSON Template 

{ // PhaseSet
  // from Element: 
    "

    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // Phase set ID //
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "Id", // R! 
        "valueUri" : "<uri>" //Value of extension
      },
      { // Phase set sequence // R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "Sequence", // R! 
        "valueReference" : { Reference(Sequence) } //Value of extension
      }

    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/observation-geneticsPhaseSet", // R! 
    "

// value[x]: Value of extension. One of these 49:
  }

Summary

Name Flags Card. Type Description & Constraints doco
. . PhaseSet 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/observation-geneticsPhaseSet
PhaseSet: Phase set information.


Use on Element ID Observation
. . . extension Id 0..1 uri URL = http://hl7.org/fhir/StructureDefinition/observation-geneticsPhaseSet This is a globally unique phaseSet id.
PhaseSet: Chromosomal
. . . Sequence 1..* Reference ( Sequence ) Sequence pointed to phase set identifier (UUID/OID). All sequences with the same PhaseSet identifier are asserted to be on the same chromosome (cis). (from: https://www.hl7.org/fhir/STU3/extension-observation-geneticssequence.html).

Use on element: Observation

doco Documentation for this format

Full Structure

Name Flags Card. Type Description & Constraints doco
. . extension 0..1 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/observation-geneticsPhaseSet
PhaseSet: Chromosomal phase Phase set identifier (UUID/OID). All sequences with the same PhaseSet identifier are asserted to be on the same chromosome (cis). information.


Use on element: Element ID Observation
. . . extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... extension 0..1 Extension Phase set ID
.... extension 0..0
... . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/observation-geneticsPhaseSet" "Id"
. . . . valueUri 0..1 uri Value of extension
. . . extension 1..* Extension Phase set sequence
.... extension 0..0
.... url 1..1 uri "Sequence"
.... valueReference 0..1 Reference ( Sequence ) Value of extension
... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/observation-geneticsPhaseSet"
... value[x] 0 .. 0

doco Documentation for this format

XML Template 

<!-- PhaseSet -->doco

< xmlns="http://hl7.org/fhir"

<extension xmlns="http://hl7.org/fhir"

     url="http://hl7.org/fhir/StructureDefinition/observation-geneticsPhaseSet" >
  <!-- from Element: 
 <

 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="Id"> 0..1 Extension  <!-- 0..1 Phase set ID -->
  <valueUri value="[uri]"/><!-- 0..1 Value of extension -->
 </extension>
 <extension url="Sequence"> 1..* Extension  <!-- 1..* Phase set sequence -->
  <valueReference><!-- 0..1 Reference(Sequence) 
      Value of extension --></valueReference>
 </extension>

</extension>

JSON Template 

{ // PhaseSet
  // from Element: 
    "

    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // Phase set ID //
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "Id", // R! 
        "valueUri" : "<uri>" //Value of extension
      },
      { // Phase set sequence // R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "Sequence", // R! 
        "valueReference" : { Reference(Sequence) } //Value of extension
      }

    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/observation-geneticsPhaseSet", // R! 
    "

// value[x]: Value of extension. One of these 49:
  }

 

Constraints

  • ele-1 : All FHIR elements must have a @value or children (xpath: @value|f:*|h:div )
  • ext-1 : Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) )