HL7 FHIR® Implementation Guide: Breast Cancer Data, Release 1 - US Realm (Draft for Comment)

This page is part of the Breast Cancer Data Logical Models and FHIR Profiles (v0.1.0: STU 1 Draft) based on FHIR (HL7® FHIR® Standard) R3. No current official version has been published yet. For a full list of available versions, see the Directory of published versions

RelevantTimeModel

{
  "resourceType" : "StructureDefinition",
  "id" : "cimi-RelevantTime-model",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns="http://www.w3.org/1999/xhtml">
  <p><b>BC RelevantTime Logical Model</b></p>
  <p>The time or time period that the finding addresses.

The clinically relevant time is not necessarily when the information is gathered or when a test is carried out, but for example, when a specimen was collected, or the time period referred to by the question. Use a TimePeriod for a measurement or specimen collection continued over a significant period of time (e.g. 24 hour Urine Sodium).

CIMI Alignment: This attribute has been added, since recorded values must have an associated time. The datatype has been chosen to align with FHIR.</p>
</div>"
  },
  "url" : "http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-RelevantTime-model",
  "identifier" : [
    {
      "system" : "http://hl7.org/fhir/us/breastcancer",
      "value" : "cimi.RelevantTime"
    }
  ],
  "version" : "0.1.0",
  "name" : "RelevantTimeModel",
  "title" : "BC RelevantTime Logical Model",
  "status" : "draft",
  "date" : "2018-04-01T00:00:00+11:00",
  "publisher" : "The HL7 Cancer Interoperability Group sponsored by Clinical Interoperability Council Work Group (CIC)",
  "contact" : [
    {
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://standardhealthrecord.org"
        }
      ]
    }
  ],
  "description" : "The time or time period that the finding addresses.

The clinically relevant time is not necessarily when the information is gathered or when a test is carried out, but for example, when a specimen was collected, or the time period referred to by the question. Use a TimePeriod for a measurement or specimen collection continued over a significant period of time (e.g. 24 hour Urine Sodium).

CIMI Alignment: This attribute has been added, since recorded values must have an associated time. The datatype has been chosen to align with FHIR.",
  "kind" : "logical",
  "abstract" : false,
  "type" : "cimi-RelevantTime-model",
  "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Element",
  "derivation" : "specialization",
  "snapshot" : {
    "element" : [
      {
        "id" : "cimi-RelevantTime-model",
        "path" : "cimi-RelevantTime-model",
        "definition" : "The time or time period that the finding addresses.

The clinically relevant time is not necessarily when the information is gathered or when a test is carried out, but for example, when a specimen was collected, or the time period referred to by the question. Use a TimePeriod for a measurement or specimen collection continued over a significant period of time (e.g. 24 hour Urine Sodium).

CIMI Alignment: This attribute has been added, since recorded values must have an associated time. The datatype has been chosen to align with FHIR.",
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "cimi-RelevantTime-model",
          "min" : 0,
          "max" : "*"
        },
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false
      },
      {
        "id" : "cimi-RelevantTime-model.value[x]",
        "path" : "cimi-RelevantTime-model.value[x]",
        "short" : "DateTime or TimePeriod representing the time or time period that the finding addresses.",
        "definition" : "DateTime or TimePeriod representing the time or time period that the finding addresses.

The clinically relevant time is not necessarily when the information is gathered or when a test is carried out, but for example, when a specimen was collected, or the time period referred to by the question. Use a TimePeriod for a measurement or specimen collection continued over a significant period of time (e.g. 24 hour Urine Sodium).

CIMI Alignment: This attribute has been added, since recorded values must have an associated time. The datatype has been chosen to align with FHIR.",
        "alias" : [
          "dateTime",
          "timePeriod"
        ],
        "min" : 1,
        "max" : "1",
        "base" : {
          "path" : "cimi-RelevantTime-model.value[x]",
          "min" : 1,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "dateTime"
          },
          {
            "code" : "http://hl7.org/fhir/us/breastcancer/StructureDefinition/shr-core-TimePeriod-model"
          }
        ],
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false
      }
    ]
  },
  "differential" : {
    "element" : [
      {
        "id" : "cimi-RelevantTime-model",
        "path" : "cimi-RelevantTime-model",
        "definition" : "The time or time period that the finding addresses.

The clinically relevant time is not necessarily when the information is gathered or when a test is carried out, but for example, when a specimen was collected, or the time period referred to by the question. Use a TimePeriod for a measurement or specimen collection continued over a significant period of time (e.g. 24 hour Urine Sodium).

CIMI Alignment: This attribute has been added, since recorded values must have an associated time. The datatype has been chosen to align with FHIR.",
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "cimi-RelevantTime-model",
          "min" : 0,
          "max" : "*"
        },
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false
      },
      {
        "id" : "cimi-RelevantTime-model.value[x]",
        "path" : "cimi-RelevantTime-model.value[x]",
        "short" : "DateTime or TimePeriod representing the time or time period that the finding addresses.",
        "definition" : "DateTime or TimePeriod representing the time or time period that the finding addresses.

The clinically relevant time is not necessarily when the information is gathered or when a test is carried out, but for example, when a specimen was collected, or the time period referred to by the question. Use a TimePeriod for a measurement or specimen collection continued over a significant period of time (e.g. 24 hour Urine Sodium).

CIMI Alignment: This attribute has been added, since recorded values must have an associated time. The datatype has been chosen to align with FHIR.",
        "alias" : [
          "dateTime",
          "timePeriod"
        ],
        "min" : 1,
        "max" : "1",
        "base" : {
          "path" : "cimi-RelevantTime-model.value[x]",
          "min" : 1,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "dateTime"
          },
          {
            "code" : "http://hl7.org/fhir/us/breastcancer/StructureDefinition/shr-core-TimePeriod-model"
          }
        ],
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false
      }
    ]
  }
}