HL7 Version 2 to FHIR
1.0.0-ballot - ballot International flag

This page is part of the HL7 Version 2 to FHIR (v1.0.0-ballot: STU1 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. . For a full list of available versions, see the Directory of published versions

: Segment OBR to Specimen Map - JSON Representation

Active as of 2023-12-19

Raw json | Download


{
  "resourceType" : "ConceptMap",
  "id" : "segment-obr-to-specimen",
  "text" : {
    "status" : "extensions",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p>Mapping from OBR to <a href=\"http://hl7.org/fhir/R4/specimen.html\">Specimen</a></p><p>ACTIVE (not intended for production usage). Published on 2023-12-19 by HL7 International / Orders and Observations (HL7 Orders and Observations Workgroup: <a href=\"http://www.hl7.org/Special/committees/orders\">http://www.hl7.org/Special/com...</a>, Keith W. Boone: <a href=\"mailto:kboone@ainq.com\">kboone@ainq.com</a>, Rob Hausam: <a href=\"mailto:rrhausam@gmail.com\">rrhausam@gmail.com</a>). Copyright (c) 2020, HL7 International, Inc., All Rights Reserved.</p><div><p>This ConceptMap represents a mapping from the HL7 V2 Segment OBR to the FHIR Specimen Resource.</p>\n</div><br/><p><b>Group 1</b>Mapping from <code>unspecified code system</code> to <code>unspecified code system</code></p><table class=\"grid\"><tr><td colspan=\"3\"><b>Source Concept Details</b></td><td><b>Relationship</b></td><td colspan=\"4\"><b>Target Concept Details</b></td><td colspan=\"4\"><b>Properties</b></td></tr><tr><td colspan=\"2\"><b>Codes</b> from </td><td><b>datatypemap</b></td><td/><td colspan=\"2\"><b>Codes</b> from </td><td><b>narrative</b></td><td><b>antlr</b></td></tr><tr><td style=\"border-right-width: 0px\">OBR-2</td><td style=\"border-left-width: 0px\">Placer Order Number</td><td>CX[Identifier]</td><td><a href=\"http://hl7.org/fhir/R4/codesystem-concept-map-equivalence.html#equivalent\" title=\"equivalent\">is equivalent to</a></td><td style=\"border-right-width: 0px\">accessionIdentifier</td><td style=\"border-left-width: 0px\">accessionIdentifier</td><td>If the placer number is also the accession identifier.</td><td/></tr><tr><td style=\"border-right-width: 0px\">OBR-7</td><td style=\"border-left-width: 0px\">Observation Date/Time</td><td/><td><a href=\"http://hl7.org/fhir/R4/codesystem-concept-map-equivalence.html#equivalent\" title=\"equivalent\">is equivalent to</a></td><td style=\"border-right-width: 0px\">collection.collectedDateTime</td><td style=\"border-left-width: 0px\">collection.collectedDateTime</td><td/><td>IF OBR-8 NOT VALUED</td></tr><tr><td style=\"border-right-width: 0px\">OBR-7</td><td style=\"border-left-width: 0px\">Observation Date/Time</td><td/><td><a href=\"http://hl7.org/fhir/R4/codesystem-concept-map-equivalence.html#equivalent\" title=\"equivalent\">is equivalent to</a></td><td style=\"border-right-width: 0px\">collection.collectedPeriod.start</td><td style=\"border-left-width: 0px\">collection.collectedPeriod.start</td><td/><td>IF OBR-8 VALUED</td></tr><tr><td style=\"border-right-width: 0px\">OBR-8</td><td style=\"border-left-width: 0px\">Observation End Date/Time</td><td/><td><a href=\"http://hl7.org/fhir/R4/codesystem-concept-map-equivalence.html#equivalent\" title=\"equivalent\">is equivalent to</a></td><td style=\"border-right-width: 0px\">collection.collectedPeriod.end</td><td style=\"border-left-width: 0px\">collection.collectedPeriod.end</td><td/><td/></tr><tr><td style=\"border-right-width: 0px\">OBR-9</td><td style=\"border-left-width: 0px\">Collection Volume</td><td>CQ[Quantity]</td><td><a href=\"http://hl7.org/fhir/R4/codesystem-concept-map-equivalence.html#equivalent\" title=\"equivalent\">is equivalent to</a></td><td style=\"border-right-width: 0px\">collection.quantity</td><td style=\"border-left-width: 0px\">collection.quantity</td><td/><td/></tr><tr><td style=\"border-right-width: 0px\">OBR-10</td><td style=\"border-left-width: 0px\">Collector Identifier</td><td>XCN[Practitioner]</td><td><a href=\"http://hl7.org/fhir/R4/codesystem-concept-map-equivalence.html#equivalent\" title=\"equivalent\">is equivalent to</a></td><td style=\"border-right-width: 0px\">collection.collector(Practitioner)</td><td style=\"border-left-width: 0px\">collection.collector(Practitioner)</td><td/><td/></tr><tr><td style=\"border-right-width: 0px\">OBR-13</td><td style=\"border-left-width: 0px\">Relevant Clinical Information</td><td/><td><a href=\"http://hl7.org/fhir/R4/codesystem-concept-map-equivalence.html#equivalent\" title=\"equivalent\">is equivalent to</a></td><td style=\"border-right-width: 0px\">collection.fastingStatusCodeableConcept</td><td style=\"border-left-width: 0px\">collection.fastingStatusCodeableConcept</td><td>If information represents fasting status</td><td/></tr><tr><td style=\"border-right-width: 0px\">OBR-13</td><td style=\"border-left-width: 0px\">Relevant Clinical Information</td><td/><td><a href=\"http://hl7.org/fhir/R4/codesystem-concept-map-equivalence.html#equivalent\" title=\"equivalent\">is equivalent to</a></td><td style=\"border-right-width: 0px\">collection.fastingStatusDuration</td><td style=\"border-left-width: 0px\">collection.fastingStatusDuration</td><td>If information represents fasting duration</td><td/></tr><tr><td style=\"border-right-width: 0px\">OBR-14</td><td style=\"border-left-width: 0px\">Specimen Received Date/Time *</td><td/><td><a href=\"http://hl7.org/fhir/R4/codesystem-concept-map-equivalence.html#equivalent\" title=\"equivalent\">is equivalent to</a></td><td style=\"border-right-width: 0px\">receivedTime</td><td style=\"border-left-width: 0px\">receivedTime</td><td/><td/></tr><tr><td style=\"border-right-width: 0px\">OBR-15</td><td style=\"border-left-width: 0px\">Specimen Source</td><td>CM[Specimen-Source]</td><td><a href=\"http://hl7.org/fhir/R4/codesystem-concept-map-equivalence.html#equivalent\" title=\"equivalent\">is equivalent to</a></td><td style=\"border-right-width: 0px\">$this</td><td style=\"border-left-width: 0px\">$this</td><td/><td/></tr><tr><td style=\"border-right-width: 0px\">OBR-39</td><td style=\"border-left-width: 0px\">Collector's Comment *</td><td/><td><a href=\"http://hl7.org/fhir/R4/codesystem-concept-map-equivalence.html#equivalent\" title=\"equivalent\">is equivalent to</a></td><td style=\"border-right-width: 0px\">note</td><td style=\"border-left-width: 0px\">note</td><td/><td/></tr></table></div>"
  },
  "extension" : [
    {
      "extension" : [
        {
          "url" : "type",
          "valueCode" : "derived-from"
        },
        {
          "url" : "label",
          "valueString" : "Segment OBR to Specimen.fsh"
        },
        {
          "url" : "url",
          "valueUri" : "https://docs.google.com/spreadsheets/d/1BWxCsh7UjOJwv1_ARyLJe4cvU_gybW5MdSXTBcTa44c/edit#gid=0"
        }
      ],
      "url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/RelatedArtifact"
    },
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode" : "oo"
    }
  ],
  "url" : "http://hl7.org/fhir/uv/v2mappings/segment-obr-to-specimen",
  "version" : "1.0.0-ballot",
  "name" : "SegmentOBRToSpecimen",
  "title" : "Segment OBR to Specimen Map",
  "status" : "active",
  "experimental" : true,
  "date" : "2023-12-19",
  "publisher" : "HL7 International / Orders and Observations",
  "contact" : [
    {
      "name" : "HL7 Orders and Observations Workgroup",
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/orders"
        }
      ]
    },
    {
      "name" : "Keith W. Boone",
      "telecom" : [
        {
          "system" : "email",
          "value" : "kboone@ainq.com"
        }
      ]
    },
    {
      "name" : "Rob Hausam",
      "telecom" : [
        {
          "system" : "email",
          "value" : "rrhausam@gmail.com"
        }
      ]
    }
  ],
  "description" : "This ConceptMap represents a mapping from the HL7 V2 Segment OBR to the FHIR Specimen Resource.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code" : "001"
        }
      ]
    }
  ],
  "copyright" : "Copyright (c) 2020, HL7 International, Inc., All Rights Reserved.",
  "sourceUri" : "OBR",
  "targetUri" : "Specimen",
  "group" : [
    {
      "element" : [
        {
          "extension" : [
            {
              "extension" : [
                {
                  "url" : "type",
                  "valueCode" : "EI"
                },
                {
                  "url" : "cardinalityMin",
                  "valueInteger" : 1
                },
                {
                  "url" : "cardinalityMax",
                  "valueInteger" : 1
                }
              ],
              "url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
            }
          ],
          "code" : "OBR-2",
          "display" : "Placer Order Number",
          "target" : [
            {
              "extension" : [
                {
                  "extension" : [
                    {
                      "url" : "type",
                      "valueCode" : "Identifier"
                    },
                    {
                      "url" : "cardinalityMin",
                      "valueInteger" : 0
                    },
                    {
                      "url" : "cardinalityMax",
                      "valueInteger" : 1
                    }
                  ],
                  "url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
                }
              ],
              "modifierExtension" : [
                {
                  "url" : "http://hl7.org/fhir/1.0/StructureDefinition/extension-ConceptMap.element.target.equivalence",
                  "valueCode" : "equivalent"
                }
              ],
              "code" : "accessionIdentifier",
              "display" : "accessionIdentifier",
              "equivalence" : "equivalent",
              "dependsOn" : [
                {
                  "property" : "data-type-map",
                  "value" : "CX[Identifier]"
                }
              ],
              "product" : [
                {
                  "property" : "narrative",
                  "value" : "If the placer number is also the accession identifier."
                }
              ]
            }
          ]
        },
        {
          "extension" : [
            {
              "extension" : [
                {
                  "url" : "type",
                  "valueCode" : "DTM"
                },
                {
                  "url" : "cardinalityMin",
                  "valueInteger" : 1
                },
                {
                  "url" : "cardinalityMax",
                  "valueInteger" : 1
                }
              ],
              "url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
            }
          ],
          "code" : "OBR-7",
          "display" : "Observation Date/Time",
          "target" : [
            {
              "extension" : [
                {
                  "extension" : [
                    {
                      "url" : "type",
                      "valueCode" : "dateTime"
                    },
                    {
                      "url" : "cardinalityMin",
                      "valueInteger" : 0
                    },
                    {
                      "url" : "cardinalityMax",
                      "valueInteger" : 1
                    }
                  ],
                  "url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
                }
              ],
              "modifierExtension" : [
                {
                  "url" : "http://hl7.org/fhir/1.0/StructureDefinition/extension-ConceptMap.element.target.equivalence",
                  "valueCode" : "equivalent"
                }
              ],
              "code" : "collection.collectedDateTime",
              "display" : "collection.collectedDateTime",
              "equivalence" : "equivalent",
              "product" : [
                {
                  "property" : "antlr",
                  "value" : "IF OBR-8 NOT VALUED"
                }
              ]
            }
          ]
        },
        {
          "extension" : [
            {
              "extension" : [
                {
                  "url" : "type",
                  "valueCode" : "DTM"
                },
                {
                  "url" : "cardinalityMin",
                  "valueInteger" : 1
                },
                {
                  "url" : "cardinalityMax",
                  "valueInteger" : 1
                }
              ],
              "url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
            }
          ],
          "code" : "OBR-7",
          "display" : "Observation Date/Time",
          "target" : [
            {
              "extension" : [
                {
                  "extension" : [
                    {
                      "url" : "type",
                      "valueCode" : "dateTime"
                    },
                    {
                      "url" : "cardinalityMin",
                      "valueInteger" : 0
                    },
                    {
                      "url" : "cardinalityMax",
                      "valueInteger" : 1
                    }
                  ],
                  "url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
                }
              ],
              "modifierExtension" : [
                {
                  "url" : "http://hl7.org/fhir/1.0/StructureDefinition/extension-ConceptMap.element.target.equivalence",
                  "valueCode" : "equivalent"
                }
              ],
              "code" : "collection.collectedPeriod.start",
              "display" : "collection.collectedPeriod.start",
              "equivalence" : "equivalent",
              "product" : [
                {
                  "property" : "antlr",
                  "value" : "IF OBR-8 VALUED"
                }
              ]
            }
          ]
        },
        {
          "extension" : [
            {
              "extension" : [
                {
                  "url" : "type",
                  "valueCode" : "DTM"
                },
                {
                  "url" : "cardinalityMin",
                  "valueInteger" : 1
                },
                {
                  "url" : "cardinalityMax",
                  "valueInteger" : 1
                }
              ],
              "url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
            }
          ],
          "code" : "OBR-8",
          "display" : "Observation End Date/Time",
          "target" : [
            {
              "extension" : [
                {
                  "extension" : [
                    {
                      "url" : "type",
                      "valueCode" : "dateTime"
                    },
                    {
                      "url" : "cardinalityMin",
                      "valueInteger" : 0
                    },
                    {
                      "url" : "cardinalityMax",
                      "valueInteger" : 1
                    }
                  ],
                  "url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
                }
              ],
              "modifierExtension" : [
                {
                  "url" : "http://hl7.org/fhir/1.0/StructureDefinition/extension-ConceptMap.element.target.equivalence",
                  "valueCode" : "equivalent"
                }
              ],
              "code" : "collection.collectedPeriod.end",
              "display" : "collection.collectedPeriod.end",
              "equivalence" : "equivalent"
            }
          ]
        },
        {
          "extension" : [
            {
              "extension" : [
                {
                  "url" : "type",
                  "valueCode" : "CQ"
                },
                {
                  "url" : "cardinalityMin",
                  "valueInteger" : 1
                },
                {
                  "url" : "cardinalityMax",
                  "valueInteger" : 1
                }
              ],
              "url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
            }
          ],
          "code" : "OBR-9",
          "display" : "Collection Volume",
          "target" : [
            {
              "extension" : [
                {
                  "extension" : [
                    {
                      "url" : "type",
                      "valueCode" : "SimpleQuantity"
                    },
                    {
                      "url" : "cardinalityMin",
                      "valueInteger" : 0
                    },
                    {
                      "url" : "cardinalityMax",
                      "valueInteger" : 1
                    }
                  ],
                  "url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
                }
              ],
              "modifierExtension" : [
                {
                  "url" : "http://hl7.org/fhir/1.0/StructureDefinition/extension-ConceptMap.element.target.equivalence",
                  "valueCode" : "equivalent"
                }
              ],
              "code" : "collection.quantity",
              "display" : "collection.quantity",
              "equivalence" : "equivalent",
              "dependsOn" : [
                {
                  "property" : "data-type-map",
                  "value" : "CQ[Quantity]"
                }
              ]
            }
          ]
        },
        {
          "extension" : [
            {
              "extension" : [
                {
                  "url" : "type",
                  "valueCode" : "XCN"
                },
                {
                  "url" : "cardinalityMin",
                  "valueInteger" : -1
                },
                {
                  "url" : "cardinalityMax",
                  "valueInteger" : -1
                }
              ],
              "url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
            }
          ],
          "code" : "OBR-10",
          "display" : "Collector Identifier",
          "target" : [
            {
              "extension" : [
                {
                  "extension" : [
                    {
                      "url" : "type",
                      "valueCode" : "Reference(Practitioner)"
                    },
                    {
                      "url" : "cardinalityMin",
                      "valueInteger" : 0
                    },
                    {
                      "url" : "cardinalityMax",
                      "valueInteger" : 1
                    }
                  ],
                  "url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
                }
              ],
              "modifierExtension" : [
                {
                  "url" : "http://hl7.org/fhir/1.0/StructureDefinition/extension-ConceptMap.element.target.equivalence",
                  "valueCode" : "equivalent"
                }
              ],
              "code" : "collection.collector(Practitioner)",
              "display" : "collection.collector(Practitioner)",
              "equivalence" : "equivalent",
              "dependsOn" : [
                {
                  "property" : "data-type-map",
                  "value" : "XCN[Practitioner]"
                }
              ]
            }
          ]
        },
        {
          "extension" : [
            {
              "extension" : [
                {
                  "url" : "type",
                  "valueCode" : "CWE"
                },
                {
                  "url" : "cardinalityMin",
                  "valueInteger" : -1
                },
                {
                  "url" : "cardinalityMax",
                  "valueInteger" : -1
                }
              ],
              "url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
            }
          ],
          "code" : "OBR-13",
          "display" : "Relevant Clinical Information",
          "target" : [
            {
              "modifierExtension" : [
                {
                  "url" : "http://hl7.org/fhir/1.0/StructureDefinition/extension-ConceptMap.element.target.equivalence",
                  "valueCode" : "equivalent"
                }
              ],
              "code" : "collection.fastingStatusCodeableConcept",
              "display" : "collection.fastingStatusCodeableConcept",
              "equivalence" : "equivalent",
              "product" : [
                {
                  "property" : "narrative",
                  "value" : "If information represents fasting status"
                }
              ]
            }
          ]
        },
        {
          "extension" : [
            {
              "extension" : [
                {
                  "url" : "type",
                  "valueCode" : "CWE"
                },
                {
                  "url" : "cardinalityMin",
                  "valueInteger" : -1
                },
                {
                  "url" : "cardinalityMax",
                  "valueInteger" : -1
                }
              ],
              "url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
            }
          ],
          "code" : "OBR-13",
          "display" : "Relevant Clinical Information",
          "target" : [
            {
              "modifierExtension" : [
                {
                  "url" : "http://hl7.org/fhir/1.0/StructureDefinition/extension-ConceptMap.element.target.equivalence",
                  "valueCode" : "equivalent"
                }
              ],
              "code" : "collection.fastingStatusDuration",
              "display" : "collection.fastingStatusDuration",
              "equivalence" : "equivalent",
              "product" : [
                {
                  "property" : "narrative",
                  "value" : "If information represents fasting duration"
                }
              ]
            }
          ]
        },
        {
          "extension" : [
            {
              "extension" : [
                {
                  "url" : "type",
                  "valueCode" : "TS"
                },
                {
                  "url" : "cardinalityMin",
                  "valueInteger" : 1
                },
                {
                  "url" : "cardinalityMax",
                  "valueInteger" : 1
                }
              ],
              "url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
            }
          ],
          "code" : "OBR-14",
          "display" : "Specimen Received Date/Time *",
          "target" : [
            {
              "extension" : [
                {
                  "extension" : [
                    {
                      "url" : "type",
                      "valueCode" : "dateTime"
                    },
                    {
                      "url" : "cardinalityMin",
                      "valueInteger" : 0
                    },
                    {
                      "url" : "cardinalityMax",
                      "valueInteger" : 1
                    }
                  ],
                  "url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
                }
              ],
              "modifierExtension" : [
                {
                  "url" : "http://hl7.org/fhir/1.0/StructureDefinition/extension-ConceptMap.element.target.equivalence",
                  "valueCode" : "equivalent"
                }
              ],
              "code" : "receivedTime",
              "display" : "receivedTime",
              "equivalence" : "equivalent"
            }
          ]
        },
        {
          "extension" : [
            {
              "extension" : [
                {
                  "url" : "type",
                  "valueCode" : "CM"
                },
                {
                  "url" : "cardinalityMin",
                  "valueInteger" : 1
                },
                {
                  "url" : "cardinalityMax",
                  "valueInteger" : 1
                }
              ],
              "url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
            }
          ],
          "code" : "OBR-15",
          "display" : "Specimen Source",
          "target" : [
            {
              "modifierExtension" : [
                {
                  "url" : "http://hl7.org/fhir/1.0/StructureDefinition/extension-ConceptMap.element.target.equivalence",
                  "valueCode" : "equivalent"
                }
              ],
              "code" : "$this",
              "display" : "$this",
              "equivalence" : "equivalent",
              "dependsOn" : [
                {
                  "property" : "data-type-map",
                  "value" : "CM[Specimen-Source]"
                }
              ]
            }
          ]
        },
        {
          "extension" : [
            {
              "extension" : [
                {
                  "url" : "type",
                  "valueCode" : "CWE"
                },
                {
                  "url" : "cardinalityMin",
                  "valueInteger" : -1
                },
                {
                  "url" : "cardinalityMax",
                  "valueInteger" : -1
                }
              ],
              "url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
            }
          ],
          "code" : "OBR-39",
          "display" : "Collector's Comment *",
          "target" : [
            {
              "extension" : [
                {
                  "extension" : [
                    {
                      "url" : "type",
                      "valueCode" : "Annotation"
                    },
                    {
                      "url" : "cardinalityMin",
                      "valueInteger" : 0
                    },
                    {
                      "url" : "cardinalityMax",
                      "valueInteger" : -1
                    }
                  ],
                  "url" : "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/TypeInfo"
                }
              ],
              "modifierExtension" : [
                {
                  "url" : "http://hl7.org/fhir/1.0/StructureDefinition/extension-ConceptMap.element.target.equivalence",
                  "valueCode" : "equivalent"
                }
              ],
              "code" : "note",
              "display" : "note",
              "equivalence" : "equivalent"
            }
          ]
        }
      ]
    }
  ]
}