FHIR IG Statistics: StructureDefinition/45bf97f3-1d45-4434-baf1-713d8c592604

Resources that use this resource

Resources that this resource uses

Narrative

No narrative content found in resource

Source

{
  "resourceType": "StructureDefinition",
  "id": "45bf97f3-1d45-4434-baf1-713d8c592604",
  "meta": {
    "lastUpdated": "2023-08-03T16:06:55.2022329+00:00"
  },
  "url": "http://ehealthontario.ca/fhir/StructureDefinition/ca-on-lab-profile-Observation",
  "version": "2.0.0",
  "name": "Observation",
  "status": "active",
  "date": "2023-08-03T16:07:49.318199+00:00",
  "fhirVersion": "4.0.1",
  "mapping": [
    {
      "identity": "OLIS-HL7-V2",
      "uri": "http://ontariohealth.ca",
      "name": "OLIS HL7 v2 Mapping"
    }
  ],
  "kind": "resource",
  "abstract": false,
  "type": "Observation",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Observation",
  "derivation": "constraint",
  "differential": {
    "element": [
      {
        "id": "Observation.id",
        "path": "Observation.id",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "Observation.meta",
        "path": "Observation.meta",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "Observation.meta.profile",
        "path": "Observation.meta.profile",
        "min": 1,
        "max": "1",
        "fixedCanonical": "http://ehealthontario.ca/fhir/StructureDefinition/ca-on-lab-profile-Observation|2.0.0",
        "mustSupport": true
      },
      {
        "id": "Observation.extension",
        "path": "Observation.extension",
        "slicing": {
          "discriminator": [
            {
              "type": "value",
              "path": "url"
            }
          ],
          "rules": "open"
        },
        "min": 0
      },
      {
        "id": "Observation.extension:ext-ObservationSortKey",
        "path": "Observation.extension",
        "sliceName": "ext-ObservationSortKey",
        "min": 0,
        "type": [
          {
            "code": "Extension",
            "profile": [
              "http://ehealthontario.ca/fhir/StructureDefinition/ca-on-lab-ext-sort-key"
            ]
          }
        ],
        "mustSupport": true
      },
      {
        "id": "Observation.extension:ext-ObservationSortKey.value[x]",
        "path": "Observation.extension.value[x]",
        "slicing": {
          "rules": "open"
        },
        "mustSupport": true,
        "mapping": [
          {
            "identity": "OLIS-HL7-V2",
            "map": "ZBX.2"
          }
        ]
      },
      {
        "id": "Observation.extension:ObservationValueAttachment",
        "path": "Observation.extension",
        "sliceName": "ObservationValueAttachment",
        "short": "Base64encoded observation data such as PDF, etc",
        "definition": "This inter-version extension supports observation data in base64encoded format. The type of data is specified in \"contentType\". The binary data is stored in \"data\".",
        "requirements": "R4 removed Attachment in Observation.value[x]. This extension is necessary to support observations with binary values.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "http://hl7.org/fhir/3.0/StructureDefinition/extension-Observation.value"
            ]
          }
        ],
        "constraint": [
          {
            "key": "obs-valueAttachment-1",
            "severity": "error",
            "human": "If ObservationValueAttachment is present and has value, Observation.value[x] SHALL not be present."
          }
        ],
        "mustSupport": true
      },
      {
        "id": "Observation.extension:ObservationValueAttachment.url",
        "path": "Observation.extension.url",
        "fixedUri": "http://hl7.org/fhir/3.0/StructureDefinition/extension-Observation.value"
      },
      {
        "id": "Observation.identifier",
        "path": "Observation.identifier",
        "min": 1,
        "max": "1",
        "mustSupport": true
      },
      {
        "id": "Observation.identifier.system",
        "path": "Observation.identifier.system",
        "definition": "OLIS will use org specific URIs for system. See examples below and notes in the profile page.",
        "min": 1,
        "example": [
          {
            "label": "Observation Identifier generated by laboratory",
            "valueUri": "http://ehealthontario.ca/fhir/NamingSystem/lab/filler-id-[type]-license-[id]"
          },
          {
            "label": "Observation Identifier generated by specimen collector center",
            "valueUri": "http://ehealthontario.ca/fhir/NamingSystem/lab/filler-id-[type]-license-[id]"
          },
          {
            "label": "Ancillary Observatoin identifier generated by laboratory",
            "valueUri": "http://ehealthontario.ca/fhir/NamingSystem/lab/test-request-id-[type]-license-[id]"
          }
        ],
        "mustSupport": true,
        "mapping": [
          {
            "identity": "OLIS-HL7-V2",
            "map": "OBR.3.3",
            "comment": "system value contains a type and license number which will be mapped from OID and license value from OBR.3.3"
          }
        ]
      },
      {
        "id": "Observation.identifier.value",
        "path": "Observation.identifier.value",
        "min": 1,
        "mustSupport": true,
        "mapping": [
          {
            "identity": "OLIS-HL7-V2",
            "map": "OBR-3.1/OBR-2.1 + \"~\" + OBX.3.1 + \"~\" + OBX.4 + \"~\" + ZBX.1",
            "comment": "For ancillary result, use OBR-2.1 instead of OBR-3.1"
          }
        ]
      },
      {
        "id": "Observation.identifier.assigner",
        "path": "Observation.identifier.assigner",
        "min": 1,
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://ehealthontario.ca/fhir/StructureDefinition/ca-on-lab-profile-Organization"
            ]
          }
        ],
        "mustSupport": true,
        "mapping": [
          {
            "identity": "OLIS-HL7-V2",
            "map": "OBR.3.3",
            "comment": "This will be a reference to an organization resource in the bundle. The organization resource is created from OBR.3.3 that has the org type and license number."
          }
        ]
      },
      {
        "id": "Observation.identifier.assigner.reference",
        "path": "Observation.identifier.assigner.reference",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "Observation.basedOn",
        "path": "Observation.basedOn",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://ehealthontario.ca/fhir/StructureDefinition/ca-on-lab-profile-ServiceRequest"
            ]
          }
        ],
        "mustSupport": true
      },
      {
        "id": "Observation.basedOn.reference",
        "path": "Observation.basedOn.reference",
        "mustSupport": true
      },
      {
        "id": "Observation.status",
        "path": "Observation.status",
        "mustSupport": true,
        "binding": {
          "strength": "required",
          "valueSet": "http://ehealthontario.ca/fhir/ValueSet/ca-on-lab-observation-status"
        },
        "mapping": [
          {
            "identity": "OLIS-HL7-V2",
            "map": "OBX.11"
          }
        ]
      },
      {
        "id": "Observation.category",
        "path": "Observation.category",
        "mustSupport": true,
        "binding": {
          "strength": "required",
          "description": "Observation category codes supported by OLIS",
          "valueSet": "http://ehealthontario.ca/fhir/ValueSet/ca-on-lab-observation-category"
        },
        "mapping": [
          {
            "identity": "OLIS-HL7-V2",
            "map": "OBX.11",
            "comment": "if OBX.11 = \"Z\", Observation.category = \"exam\". otherwise Observation.category = \"laboratory\""
          }
        ]
      },
      {
        "id": "Observation.category.coding",
        "path": "Observation.category.coding",
        "min": 1,
        "max": "1",
        "mustSupport": true
      },
      {
        "id": "Observation.category.coding.system",
        "path": "Observation.category.coding.system",
        "min": 1,
        "fixedUri": "http://terminology.hl7.org/CodeSystem/observation-category",
        "mustSupport": true
      },
      {
        "id": "Observation.category.coding.code",
        "path": "Observation.category.coding.code",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "Observation.code",
        "path": "Observation.code",
        "mustSupport": true,
        "binding": {
          "strength": "required",
          "description": "Observation codes supported by OLIS.",
          "valueSet": "http://ehealthontario.ca/fhir/ValueSet/ca-on-lab-observation-codes"
        }
      },
      {
        "id": "Observation.code.coding",
        "path": "Observation.code.coding",
        "min": 1,
        "max": "1",
        "mustSupport": true
      },
      {
        "id": "Observation.code.coding.system",
        "path": "Observation.code.coding.system",
        "min": 1,
        "mustSupport": true,
        "mapping": [
          {
            "identity": "OLIS-HL7-V2",
            "map": "OBX.3.3"
          }
        ]
      },
      {
        "id": "Observation.code.coding.code",
        "path": "Observation.code.coding.code",
        "min": 1,
        "mustSupport": true,
        "mapping": [
          {
            "identity": "OLIS-HL7-V2",
            "map": "OBX.3.1"
          }
        ]
      },
      {
        "id": "Observation.code.coding.display",
        "path": "Observation.code.coding.display",
        "min": 1,
        "mustSupport": true,
        "mapping": [
          {
            "identity": "OLIS-HL7-V2",
            "map": "OBX.3.2"
          }
        ]
      },
      {
        "id": "Observation.code.text",
        "path": "Observation.code.text",
        "definition": "Contains the \"alternate name\" of the test result",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "Observation.subject",
        "path": "Observation.subject",
        "min": 1,
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://ehealthontario.ca/fhir/StructureDefinition/ca-on-lab-profile-Patient"
            ]
          }
        ],
        "mustSupport": true
      },
      {
        "id": "Observation.effective[x]",
        "path": "Observation.effective[x]",
        "min": 1,
        "type": [
          {
            "code": "dateTime"
          }
        ],
        "mustSupport": true,
        "mapping": [
          {
            "identity": "OLIS-HL7-V2",
            "map": "OBR.7, OBX.14.1",
            "comment": "maps to OBR.7 for non-ancillary results. For ancillary results, this field maps to OBX.14.1"
          }
        ]
      },
      {
        "id": "Observation.issued",
        "path": "Observation.issued",
        "min": 1,
        "mustSupport": true,
        "mapping": [
          {
            "identity": "OLIS-HL7-V2",
            "map": "ZBX.1"
          }
        ]
      },
      {
        "id": "Observation.performer",
        "path": "Observation.performer",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://ehealthontario.ca/fhir/StructureDefinition/ca-on-lab-profile-Practitioner",
              "http://ehealthontario.ca/fhir/StructureDefinition/ca-on-lab-profile-Organization"
            ]
          }
        ],
        "mustSupport": true,
        "mapping": [
          {
            "identity": "OLIS-HL7-V2",
            "map": "ZBR.6 - ZBR.7 (Performing Lab)"
          }
        ]
      },
      {
        "id": "Observation.performer.reference",
        "path": "Observation.performer.reference",
        "definition": "Contains the resource id of the reference to a Practitioner or Organization resource",
        "min": 1
      },
      {
        "id": "Observation.value[x]",
        "path": "Observation.value[x]",
        "slicing": {
          "discriminator": [
            {
              "type": "type",
              "path": "$this"
            }
          ],
          "rules": "open"
        },
        "comment": "An observation may have a single value such as quantity or string. If value[x] is empty, the observation value may be an encapsulated data that can be found in Observation.extension:ObservationValueAttachment",
        "type": [
          {
            "code": "Quantity",
            "profile": [
              "http://ehealthontario.ca/fhir/StructureDefinition/ObservationValueQuantity"
            ]
          },
          {
            "code": "CodeableConcept"
          },
          {
            "code": "string"
          },
          {
            "code": "boolean"
          },
          {
            "code": "integer"
          },
          {
            "code": "Range"
          },
          {
            "code": "Ratio"
          },
          {
            "code": "SampledData"
          },
          {
            "code": "time"
          },
          {
            "code": "dateTime"
          },
          {
            "code": "Period"
          }
        ],
        "constraint": [
          {
            "key": "obs-value-1",
            "severity": "error",
            "human": "if value[x] is present, Observation.extension:ObservationValueAttachment SHALL be blank"
          }
        ],
        "mustSupport": true,
        "mapping": [
          {
            "identity": "OLIS-HL7-V2",
            "map": "OBX.5, OBX.2",
            "comment": "Value[x].value maps to OBX.5. Type of value[x] maps to OBX.2. OBX.2=NM maps to valueQuantity, OBX.2=CE maps to valueCodeableConcept, OBX.2=ST maps to valueString, OBX.2=FT, ST or TX maps to valueString, OBX.2=SN maps to valueQuantity (if OBX.5.1 contains a comparator), or valueRange (if OBX.5.3 is '-'') or valueRatio (if OBX.5.3 is ':' and OBX.5.1 is empty), or map to valueString with all OBX.5 subfields concatenated if OBX.5.3 is not \"-\".  OBX.2=TM maps to valueTime, OBX.2=DT or TS maps to valueDateTime, OBX.2=ED maps to valueAttachment"
          },
          {
            "identity": "OLIS-HL7-V2",
            "map": "OBX.6",
            "comment": "If OBX.2=NM, map OBX.6 to valueQuantity.unit. If OBX.2=FT, ST or TX, Observation.valueString=OBX.5. If OBX.2=SN,  map OBX.6 to to valueQuantity.unit (if OBX.5.1 is not empty and not \"-\"), or valueRange.low.unit and valueRange.high.unit (if OBX.5.1 is '-'') or valueRatio.numerator.unit and valueRatio.denominator.unit (if OBX.5.1 is ':'), for other OBX.2 type value, do not map OBX.6 to Observation.value"
          }
        ]
      },
      {
        "id": "Observation.value[x]:valueCodeableConcept",
        "path": "Observation.value[x]",
        "sliceName": "valueCodeableConcept",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "binding": {
          "strength": "required",
          "description": "List of micro organsim codes supported in OLIS",
          "valueSet": "http://ehealthontario.ca/fhir/ValueSet/ca-on-lab-microorganism-codes"
        }
      },
      {
        "id": "Observation.interpretation",
        "path": "Observation.interpretation",
        "max": "1",
        "mustSupport": true,
        "binding": {
          "strength": "required",
          "description": "Abnormal observation flags supported by OLIS",
          "valueSet": "http://ehealthontario.ca/fhir/ValueSet/ca-on-lab-observation-interpretation"
        }
      },
      {
        "id": "Observation.interpretation.coding",
        "path": "Observation.interpretation.coding",
        "min": 1,
        "max": "1",
        "mustSupport": true
      },
      {
        "id": "Observation.interpretation.coding.system",
        "path": "Observation.interpretation.coding.system",
        "min": 1,
        "fixedUri": "http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation",
        "mustSupport": true
      },
      {
        "id": "Observation.interpretation.coding.code",
        "path": "Observation.interpretation.coding.code",
        "min": 1,
        "mustSupport": true,
        "mapping": [
          {
            "identity": "OLIS-HL7-V2",
            "map": "OBX.8"
          }
        ]
      },
      {
        "id": "Observation.interpretation.coding.display",
        "path": "Observation.interpretation.coding.display",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "Observation.note",
        "path": "Observation.note",
        "mustSupport": true,
        "mapping": [
          {
            "identity": "OLIS-HL7-V2",
            "map": "NTE-ZNT"
          }
        ]
      },
      {
        "id": "Observation.note.extension",
        "path": "Observation.note.extension",
        "slicing": {
          "discriminator": [
            {
              "type": "value",
              "path": "url"
            }
          ],
          "rules": "open"
        },
        "min": 1
      },
      {
        "id": "Observation.note.extension:source-of-comment",
        "path": "Observation.note.extension",
        "sliceName": "source-of-comment",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "http://ehealthontario.ca/fhir/StructureDefinition/ca-on-lab-ext-note-source"
            ]
          }
        ]
      },
      {
        "id": "Observation.note.extension:source-of-comment.value[x].coding.code",
        "path": "Observation.note.extension.value[x].coding.code",
        "mapping": [
          {
            "identity": "OLIS-HL7-V2",
            "map": "NTE.2",
            "comment": "valueCodeableConcept.coding.code will be \"L\", \"P\", or \"O\""
          }
        ]
      },
      {
        "id": "Observation.note.author[x]",
        "path": "Observation.note.author[x]",
        "min": 1,
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://ehealthontario.ca/fhir/StructureDefinition/ca-on-lab-profile-Organization"
            ]
          }
        ],
        "mustSupport": true,
        "mapping": [
          {
            "identity": "OLIS-HL7-V2",
            "map": "ZNT.1 (Source Organization)",
            "comment": "Reference value SHALL point to an organization identified by the license in the bundle"
          }
        ]
      },
      {
        "id": "Observation.note.author[x].reference",
        "path": "Observation.note.author[x].reference",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "Observation.note.text",
        "path": "Observation.note.text",
        "mustSupport": true,
        "mapping": [
          {
            "identity": "OLIS-HL7-V2",
            "map": "NTE.3"
          }
        ]
      },
      {
        "id": "Observation.method",
        "path": "Observation.method",
        "mustSupport": true
      },
      {
        "id": "Observation.method.text",
        "path": "Observation.method.text",
        "min": 1,
        "mustSupport": true,
        "mapping": [
          {
            "identity": "OLIS-HL7-V2",
            "map": "OBX.17"
          }
        ]
      },
      {
        "id": "Observation.specimen",
        "path": "Observation.specimen",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://ehealthontario.ca/fhir/StructureDefinition/ca-on-lab-profile-Specimen"
            ]
          }
        ],
        "mustSupport": true
      },
      {
        "id": "Observation.specimen.reference",
        "path": "Observation.specimen.reference",
        "mustSupport": true
      },
      {
        "id": "Observation.referenceRange",
        "path": "Observation.referenceRange",
        "mustSupport": true,
        "mapping": [
          {
            "identity": "OLIS-HL7-V2",
            "map": "OBX.6, OBX.7",
            "comment": "If OBX.2 is ED, TM, TS, or DT, do not map OBX.6 and follow ReferenceRange.low.value and Referencerange.high.value mapping. For any OBX.2 type, if OBX.6 is present and OBX.7 is blank, map OBX.6 to ReferenceRange.low.unit and ReferenceRange.high.unit. No other fields in ReferenceRange will be populated."
          }
        ]
      },
      {
        "id": "Observation.referenceRange.low",
        "path": "Observation.referenceRange.low",
        "mustSupport": true
      },
      {
        "id": "Observation.referenceRange.low.value",
        "path": "Observation.referenceRange.low.value",
        "mustSupport": true,
        "mapping": [
          {
            "identity": "OLIS-HL7-V2",
            "map": "OBX.7",
            "comment": "If OBX.2 = NM, SN, and if OBX.7 does not contain a comparator, leave this blank and map OBX.6 to unit. For numeric values, map to lower limit (when both lower and upper limits are defined, e.g. for Potassium 3.5-4.5) or >lower limit (if no upper limit, e.g. >15)"
          },
          {
            "identity": "OLIS-HL7-V2",
            "map": "OBX.7",
            "comment": "If OBX.2 = TX, ST, or FT, and if OBX.7 does not contain a comparator, leave this blank and map OBX.6 to unit. For numeric values, map to lower limit (when both lower and upper limits are defined, e.g. for Potassium 3.5-4.5) or >lower limit (if no upper limit, e.g. >15)"
          },
          {
            "identity": "OLIS-HL7-V2",
            "map": "OBX.7",
            "comment": "If OBX.2 = CE,DT,TS,TM or ED, and if OBX.7 does not contain a comparator, leave this blank. For numeric values, map to lower limit (when both lower and upper limits are defined, e.g. for Potassium 3.5-4.5) or >lower limit (if no upper limit, e.g. >15)"
          }
        ]
      },
      {
        "id": "Observation.referenceRange.low.unit",
        "path": "Observation.referenceRange.low.unit",
        "mustSupport": true,
        "mapping": [
          {
            "identity": "OLIS-HL7-V2",
            "map": "OBX.6",
            "comment": "skip if OBX.2 = CE, DT, TM, TS or ED"
          }
        ]
      },
      {
        "id": "Observation.referenceRange.high",
        "path": "Observation.referenceRange.high",
        "mustSupport": true
      },
      {
        "id": "Observation.referenceRange.high.value",
        "path": "Observation.referenceRange.high.value",
        "mustSupport": true,
        "mapping": [
          {
            "identity": "OLIS-HL7-V2",
            "map": "OBX.7",
            "comment": "If OBX.2=NM or SN, and if OBX.7 does not contain a comparator, leave this blank and map OBX.6 to unit.  For numeric values, map to upper limit (when both lower and upper limits are defined, e.g. for Potassium 3.5-4.5) or < upper limit (if no lower limit, e.g. <15)"
          },
          {
            "identity": "OLIS-HL7-V2",
            "map": "OBX.7",
            "comment": "If OBX.2 = TX,ST or FT, and if OBX.7 does not contain a comparator, leave this blank and map OBX.6 to unit.  For numeric values, map to upper limit (when both lower and upper limits are defined, e.g. for Potassium 3.5-4.5) or < upper limit (if no lower limit, e.g. <15)"
          },
          {
            "identity": "OLIS-HL7-V2",
            "map": "OBX.7",
            "comment": "If OBX.2=CE,DT,TS,TM or ED, and if OBX.7 does not contain a comparator, leave this blank.  For numeric values, map to upper limit (when both lower and upper limits are defined, e.g. for Potassium 3.5-4.5) or < upper limit (if no lower limit, e.g. <15)"
          }
        ]
      },
      {
        "id": "Observation.referenceRange.high.unit",
        "path": "Observation.referenceRange.high.unit",
        "mustSupport": true,
        "mapping": [
          {
            "identity": "OLIS-HL7-V2",
            "map": "OBX.6",
            "comment": "skip if OBX.2 = CE, DT, TM, TS or ED"
          }
        ]
      },
      {
        "id": "Observation.referenceRange.appliesTo",
        "path": "Observation.referenceRange.appliesTo",
        "comment": "Not populated if",
        "max": "2",
        "mustSupport": true,
        "binding": {
          "strength": "required",
          "valueSet": "http://ehealthontario.ca/fhir/ValueSet/ca-on-lab-observation-abnormal-nature"
        }
      },
      {
        "id": "Observation.referenceRange.appliesTo.coding",
        "path": "Observation.referenceRange.appliesTo.coding",
        "min": 1,
        "max": "1",
        "mustSupport": true
      },
      {
        "id": "Observation.referenceRange.appliesTo.coding.system",
        "path": "Observation.referenceRange.appliesTo.coding.system",
        "min": 1,
        "fixedUri": "http://terminology.hl7.org/CodeSystem/v2-0080",
        "mustSupport": true
      },
      {
        "id": "Observation.referenceRange.appliesTo.coding.code",
        "path": "Observation.referenceRange.appliesTo.coding.code",
        "min": 1,
        "mustSupport": true,
        "mapping": [
          {
            "identity": "OLIS-HL7-V2",
            "map": "OBX.10"
          }
        ]
      },
      {
        "id": "Observation.referenceRange.appliesTo.coding.display",
        "path": "Observation.referenceRange.appliesTo.coding.display",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "Observation.referenceRange.text",
        "path": "Observation.referenceRange.text",
        "mustSupport": true,
        "mapping": [
          {
            "identity": "OLIS-HL7-V2",
            "map": "OBX.7",
            "comment": "Always mapped to OBX.7 value"
          }
        ]
      }
    ]
  }
}