Release 5 Preview #1

This page is part of the FHIR Specification (v4.2.0: R5 Preview #1). 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: 1InformativeUse Context: Any

URL for this extension:

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

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

Phase set information.

Context of Use: Use on Element ID Observation

Extension Content

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. PhaseSet0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/observation-geneticsPhaseSet
PhaseSet: Phase set information.


Use on Element ID Observation
... Id0..1uriThis is a globally unique phaseSet id.

... MolecularSequence1..*Reference(MolecularSequence)MolecularSequence pointed to phase set (from: https://www.hl7.org/fhir/STU3/extension-observation-geneticssequence.html).


doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/observation-geneticsPhaseSet
PhaseSet: Phase set information.


Use on Element ID Observation
... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:Id I0..1ExtensionPhase set ID
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..0
.... url 1..1uri"Id"
.... value[x] I1..1uriValue of extension
... extension:MolecularSequence I1..*ExtensionPhase set sequence
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..0
.... url 1..1uri"MolecularSequence"
.... value[x] I1..1Reference(MolecularSequence)Value of extension
... value[x] I0..0
.... valueBase64Binarybase64Binary
.... valueBooleanboolean
.... valueCanonicalcanonical(Any)
.... valueCodecode
.... valueDatedate
.... valueDateTimedateTime
.... valueDecimaldecimal
.... valueIdid
.... valueInstantinstant
.... valueIntegerinteger
.... valueInteger64integer64
.... valueMarkdownmarkdown
.... valueOidoid
.... valuePositiveIntpositiveInt
.... valueStringstring
.... valueTimetime
.... valueUnsignedIntunsignedInt
.... valueUriuri
.... valueUrlurl
.... valueUuiduuid
.... valueAddressAddress
.... valueAgeAge
.... valueAnnotationAnnotation
.... valueAttachmentAttachment
.... valueCodeableConceptCodeableConcept
.... valueCodingCoding
.... valueContactPointContactPoint
.... valueCountCount
.... valueDistanceDistance
.... valueDurationDuration
.... valueHumanNameHumanName
.... valueIdentifierIdentifier
.... valueMoneyMoney
.... valuePeriodPeriod
.... valueQuantityQuantity
.... valueRangeRange
.... valueRatioRatio
.... valueReferenceReference(Any)
.... valueSampledDataSampledData
.... valueSignatureSignature
.... valueTimingTiming
.... valueContactDetailContactDetail
.... valueContributorContributor
.... valueDataRequirementDataRequirement
.... valueExpressionExpression
.... valueParameterDefinitionParameterDefinition
.... valueRelatedArtifactRelatedArtifact
.... valueTriggerDefinitionTriggerDefinition
.... valueUsageContextUsageContext
.... valueDosageDosage
.... valueMetaMeta

doco Documentation for this format

XML Template

<!-- PhaseSet -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/observation-geneticsPhaseSet" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="Id"> ?? 0..1 Extension  <!-- ?? 0..1 Phase set ID -->
  <valueUri value="[uri]"/><!-- ?? 1..1 Value of extension -->
 </extension>
 <extension url="MolecularSequence"> ?? 1..* Extension  <!-- ?? 1..* Phase set sequence -->
  <valueReference><!-- ?? 1..1 Reference(MolecularSequence) Value of extension --></valueReference>
 </extension>
</extension>

JSON Template

{ // PhaseSet
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // Phase set ID // C?
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "Id", // R! 
        "valueUri" : "<uri>" // C? R! Value of extension
      },
      { // Phase set sequence // C? R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "MolecularSequence", // R! 
        "valueReference" : { Reference(MolecularSequence) } // C? R! Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/observation-geneticsPhaseSet", // R! 
// value[x]: Value of extension. One of these 51:
  }

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. PhaseSet0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/observation-geneticsPhaseSet
PhaseSet: Phase set information.


Use on Element ID Observation
... Id0..1uriThis is a globally unique phaseSet id.

... MolecularSequence1..*Reference(MolecularSequence)MolecularSequence pointed to phase set (from: https://www.hl7.org/fhir/STU3/extension-observation-geneticssequence.html).


doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/observation-geneticsPhaseSet
PhaseSet: Phase set information.


Use on Element ID Observation
... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:Id I0..1ExtensionPhase set ID
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..0
.... url 1..1uri"Id"
.... value[x] I1..1uriValue of extension
... extension:MolecularSequence I1..*ExtensionPhase set sequence
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..0
.... url 1..1uri"MolecularSequence"
.... value[x] I1..1Reference(MolecularSequence)Value of extension
... value[x] I0..0
.... valueBase64Binarybase64Binary
.... valueBooleanboolean
.... valueCanonicalcanonical(Any)
.... valueCodecode
.... valueDatedate
.... valueDateTimedateTime
.... valueDecimaldecimal
.... valueIdid
.... valueInstantinstant
.... valueIntegerinteger
.... valueInteger64integer64
.... valueMarkdownmarkdown
.... valueOidoid
.... valuePositiveIntpositiveInt
.... valueStringstring
.... valueTimetime
.... valueUnsignedIntunsignedInt
.... valueUriuri
.... valueUrlurl
.... valueUuiduuid
.... valueAddressAddress
.... valueAgeAge
.... valueAnnotationAnnotation
.... valueAttachmentAttachment
.... valueCodeableConceptCodeableConcept
.... valueCodingCoding
.... valueContactPointContactPoint
.... valueCountCount
.... valueDistanceDistance
.... valueDurationDuration
.... valueHumanNameHumanName
.... valueIdentifierIdentifier
.... valueMoneyMoney
.... valuePeriodPeriod
.... valueQuantityQuantity
.... valueRangeRange
.... valueRatioRatio
.... valueReferenceReference(Any)
.... valueSampledDataSampledData
.... valueSignatureSignature
.... valueTimingTiming
.... valueContactDetailContactDetail
.... valueContributorContributor
.... valueDataRequirementDataRequirement
.... valueExpressionExpression
.... valueParameterDefinitionParameterDefinition
.... valueRelatedArtifactRelatedArtifact
.... valueTriggerDefinitionTriggerDefinition
.... valueUsageContextUsageContext
.... valueDosageDosage
.... valueMetaMeta

doco Documentation for this format

XML Template

<!-- PhaseSet -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/observation-geneticsPhaseSet" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="Id"> ?? 0..1 Extension  <!-- ?? 0..1 Phase set ID -->
  <valueUri value="[uri]"/><!-- ?? 1..1 Value of extension -->
 </extension>
 <extension url="MolecularSequence"> ?? 1..* Extension  <!-- ?? 1..* Phase set sequence -->
  <valueReference><!-- ?? 1..1 Reference(MolecularSequence) Value of extension --></valueReference>
 </extension>
</extension>

JSON Template

{ // PhaseSet
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // Phase set ID // C?
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "Id", // R! 
        "valueUri" : "<uri>" // C? R! Value of extension
      },
      { // Phase set sequence // C? R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "MolecularSequence", // R! 
        "valueReference" : { Reference(MolecularSequence) } // C? R! Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/observation-geneticsPhaseSet", // R! 
// value[x]: Value of extension. One of these 51:
  }

 

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