Search FHIR

FHIR Osiris Implementation Guide
1.1.0 - trial-implementation

This page is part of the OSIRIS FHIR Implementation Guide (v1.1.0: Release) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: BiologicalSample - Mappings

Draft as of 2025-04-03

Mappings for the onco-biological-sample resource profile.

Mappings for Fhir-osiris to osiris (Patient)

BiologicalSample
SpecimenBiologicalSample

Biological sample description

   extension
   extension (BiologicalSampleOrigin)
      value[x] (valueCodeableConcept)OSIRIS_pivot_BiologicalSample.BiologicalSample_Origin
   extension (BasedOnCondition)
      value[x] (valueReference)OSIRIS_pivot_BiologicalSample.TumorPathologyEvent_Ref
   identifierOSIRIS_pivot_BiologicalSample.BiologicalSample_ExternalAccession
   typeOSIRIS_pivot_BiologicalSample.BiologicalSample_Nature
   subjectOSIRIS_pivot_BiologicalSample.Patient_Id
   parentOSIRIS_pivot_BiologicalSample.BiologicalSample_ParentExternalAccession
   collection
      collected[x] (collectedDateTime)OSIRIS_pivot_BiologicalSample.BiologicalSample_CollectDate
      quantity
         valueOSIRIS_pivot_BiologicalSample.BiologicalSample_TumorCellularity
      bodySiteOSIRIS_pivot_BiologicalSample.BiologicalSample_TopographyCode
   conditionOSIRIS_pivot_BiologicalSample.BiologicalSample_StorageTemperature

Mappings for RIM Mapping (http://hl7.org/v3)

BiologicalSample
SpecimenEntity. Role, or Act, Role[classCode=SPEC]
   textAct.text?
   containedN/A
   extension
   extension (BiologicalSampleOrigin)
      idn/a
      urlN/A
      value[x]N/A
      value[x] (valueCodeableConcept)N/A
         idn/a
         extensionn/a
         codingunion(., ./translation)
         text./originalText[mediaType/code="text/plain"]/data
   extension (BasedOnCondition)
      idn/a
      urlN/A
      value[x]N/A
      value[x] (valueReference)N/A
   modifierExtensionN/A
   identifier.id
   accessionIdentifier.participation[typeCode=SBJ].act[classCode=ACSN, moodCode=EVN].id
   statusstatus
   type.code
   subject.scoper or .scoper.playsRole
   receivedTime.participation[typeCode=SBJ].act[code=SPCREC, moodCode=EVN].effectiveTime
   parent.scoper (if parent) .player.scopesRole[classCode=SPEC].player (if child)
   requestoutboundRelationship[typeCode=FLFS].target
   collection.participation[typeCode=SBJ].act[classCode=SPECCOLLECT, moodCode=EVN]
      idn/a
      extensionn/a
      modifierExtensionN/A
      collector.participation[typeCode=PFM].role
      collected[x].effectiveTime
      collected[x] (collectedDateTime).effectiveTime
      quantity.participation[typeCode=SBJ].role[classCode=SPEC].player.quantity
         idn/a
         extensionn/a
         valuePQ.value, CO.value, MO.value, IVL.high or IVL.low depending on the value
         unitPQ.unit
         systemCO.codeSystem, PQ.translation.codeSystem
         codePQ.code, MO.currency, PQ.translation.code
      method.methodCode
      bodySite.targetSiteCode
   processing.participation[typeCode=SBJ].act[code=SPCTRT, moodCode=EVN]
      idn/a
      extensionn/a
      modifierExtensionN/A
      description.text
      procedure.code
      additive.participation[typeCode=CSM].role[classCode=ADTV].code
      time[x].effectiveTime
   container.player.scopingRole[classCode=CONT].scoper
      idn/a
      extensionn/a
      modifierExtensionN/A
      identifier.id
      description.desc
      type.code
      capacity.quantity
      specimenQuantity.playedRole[classCode=CONT].quantity
      additive[x].scopesRole[classCode=ADTV].player
   condition
      idn/a
      extensionn/a
      codingunion(., ./translation)
      text./originalText[mediaType/code="text/plain"]/data
   note.inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code="annotation"].value

Mappings for FiveWs Pattern Mapping (http://hl7.org/fhir/fivews)

BiologicalSample
Specimen
   identifierFiveWs.identifier
   accessionIdentifierFiveWs.identifier
   statusFiveWs.status
   typeFiveWs.what[x]
   subjectFiveWs.subject[x], FiveWs.subject
   receivedTimeFiveWs.done[x]
   requestFiveWs.why[x]
   collection
      collectorFiveWs.actor
      collected[x]FiveWs.init
      collected[x] (collectedDateTime)FiveWs.init
      durationFiveWs.init

Mappings for HL7 v2 Mapping (http://hl7.org/v2)

BiologicalSample
Specimen
   extension
   extension (BiologicalSampleOrigin)
      value[x]
      value[x] (valueCodeableConcept)
         codingC*E.1-8, C*E.10-22
         textC*E.9. But note many systems use C*E.2 for this
   identifierSPM-2
   accessionIdentifierSPM-30 (v2.7+)
   statusSPM-20
   typeSPM-4 and possibly SPM-5
   receivedTimeSPM-18
   requestORC? OBR-2/3?
   collectionSPM-14
      collectorPRT
      collected[x]SPM-17
      collected[x] (collectedDateTime)SPM-17
      quantitySPM-12
         valueSN.2 / CQ - N/A
         unit(see OBX.6 etc.) / CQ.2
         system(see OBX.6 etc.) / CQ.2
         code(see OBX.6 etc.) / CQ.2
      methodSPM-7
      bodySiteSPM-8 and SPM-9
      fastingStatus[x]OBR-
   processing
      additiveSPM-6
   container
      identifierSAC-3
      typeSPM-27
      capacityone of: SAC 16, SAC17 and SAC 20, or SAC 21 and SAC 20
      specimenQuantitySAC-23 (value) SAC-24 (units
      additive[x]SAC-27
   conditionSPM-24
      codingC*E.1-8, C*E.10-22
      textC*E.9. But note many systems use C*E.2 for this
   noteOBX