FHIR IG analytics

Resources that use this resource

Resources that this resource uses

Narrative

Note: links and images are rebased to the (stated) source

Source1

{
  "resourceType": "StructureDefinition",
  "id": "zib-TimeInterval",
  "text": {
    "status": "empty",
    "div": "<!-- snip (see above) -->"
  },
  "url": "http://nictiz.nl/fhir/StructureDefinition/zib-TimeInterval",
  "name": "ZibTimeInterval",
  "title": "zib TimeInterval",
  "status": "draft",
  "publisher": "Nictiz",
  "contact": [
    {
      "name": "Nictiz",
      "telecom": [
        {
          "system": "url",
          "value": "https://www.nictiz.nl",
          "use": "work"
        }
      ]
    }
  ],
  "description": "A time interval indicates the time between two moments in time. Interval can be defined by a start time and end time, start time and duration or duration and end time.",
  "purpose": "This Period datatype profile is one of the three StructureDefinitions that can be used to represent the Dutch (partial) [zib ('Zorginformatiebouwsteen', i.e. Health and Care Information Model) TimeInterval v1.0 (2020)](https://zibs.nl/wiki/TimeInterval-v1.0(2020EN)). \r\n\r\nThis zib is represented in FHIR by a combination of two datatypes: _Period_ and _Duration_. To support this zib across different FHIR resource types, three related StructureDefinitions are provided:\r\n\r\n* [ext-TimeInterval.Duration](http://nictiz.nl/fhir/StructureDefinition/ext-TimeInterval.Duration): extension to provide the _Duration_ datatype to resource types where no element with this datatype is normally available. This exentions should not be used in isolation, but only via one of the two resources described below!\r\n* [zib-TimeInterval](http://nictiz.nl/fhir/StructureDefinition/zib-TimeInterval) (this profile): profile on the _Period_ datatype that defines mappings to zib TimeInterval and brings in the ext-TimeInterval.Duration extension mentioned above. For resource types that natively support an element of the _Period_ datatype but not of the _Duration_ datatype, this profile should be used.\r\n* [ext-TimeInterval.Period](http://nictiz.nl/fhir/StructureDefinition/ext-TimeInterval.Period): extension to provide the _Period_ datatype plus the _Duration_ extension mentioned above, with mappings to zib TimeInterval. For resource types that support neither elements of datatype _Period_ or _Duration_, this extension should be used. *Note*: In hindsight the name of this extension is confusing, 'ext-TimeInterval' would have been better suited.\r\n* *Note*: when the resource type natively supports elements of datatype _Period_ and _Duration_, the zib should be mapped onto these elements directly.",
  "copyright": "Copyright and related rights waived via CC0, https://creativecommons.org/publicdomain/zero/1.0/. This does not apply to information from third parties, for example a medical terminology system. The implementer alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize third party IP in connection with the specification or otherwise.",
  "fhirVersion": "4.0.1",
  "mapping": [
    {
      "identity": "zib-timeinterval-v1.0-2020EN",
      "uri": "https://zibs.nl/wiki/TimeInterval-v1.0(2020EN)",
      "name": "zib TimeInterval-v1.0(2020EN)"
    }
  ],
  "kind": "complex-type",
  "abstract": true,
  "type": "Period",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Period",
  "derivation": "constraint",
  "snapshot": {
    "element": [
      {
        "id": "Period",
        "path": "Period",
        "short": "TimeInterval",
        "definition": "A time period defined by a start and end date and optionally time.",
        "comment": "A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. \"the patient was an inpatient of the hospital for this time range\") or one value from the range applies (e.g. \"give to the patient between these two times\").\n\nPeriod is not used for a duration (a measure of elapsed time). See [Duration](datatypes.html#Duration).",
        "alias": [
          "TijdsInterval"
        ],
        "min": 0,
        "max": "*",
        "base": {
          "path": "Period",
          "min": 0,
          "max": "*"
        },
        "condition": [
          "ele-1"
        ],
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() or (children().count() > id.count())",
            "xpath": "@value|f:*|h:div",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          },
          {
            "key": "per-1",
            "severity": "error",
            "human": "If present, start SHALL have a lower value than end",
            "expression": "start.hasValue().not() or end.hasValue().not() or (start <= end)",
            "xpath": "not(exists(f:start/@value)) or not(exists(f:end/@value)) or (xs:dateTime(f:start/@value) <= xs:dateTime(f:end/@value))",
            "source": "http://hl7.org/fhir/StructureDefinition/Period"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          },
          {
            "identity": "v2",
            "map": "DR"
          },
          {
            "identity": "rim",
            "map": "IVL<TS>[lowClosed=\"true\" and highClosed=\"true\"] or URG<TS>[lowClosed=\"true\" and highClosed=\"true\"]"
          },
          {
            "identity": "zib-timeinterval-v1.0-2020EN",
            "map": "NL-CM:20.3.1",
            "comment": "TimeInterval"
          }
        ]
      },
      {
        "id": "Period.id",
        "path": "Period.id",
        "representation": [
          "xmlAttr"
        ],
        "short": "Unique id for inter-element referencing",
        "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Element.id",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
                "valueUrl": "string"
              }
            ],
            "code": "http://hl7.org/fhirpath/System.String"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "Period.extension",
        "path": "Period.extension",
        "slicing": {
          "discriminator": [
            {
              "type": "value",
              "path": "url"
            }
          ],
          "description": "Extensions are always sliced by (at least) url",
          "rules": "open"
        },
        "short": "Additional content defined by implementations",
        "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance  applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
        "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
        "alias": [
          "extensions",
          "user content"
        ],
        "min": 0,
        "max": "*",
        "base": {
          "path": "Element.extension",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "Extension"
          }
        ],
        "condition": [
          "ele-1"
        ],
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() or (children().count() > id.count())",
            "xpath": "@value|f:*|h:div",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          },
          {
            "key": "ext-1",
            "severity": "error",
            "human": "Must have either extensions or value[x], not both",
            "expression": "extension.exists() != value.exists()",
            "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
            "source": "http://hl7.org/fhir/StructureDefinition/Extension"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          },
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      },
      {
        "id": "Period.extension:duration",
        "path": "Period.extension",
        "sliceName": "duration",
        "short": "Optional Extensions Element",
        "definition": "Optional Extension Element - found in all resources.",
        "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
        "alias": [
          "extensions",
          "user content"
        ],
        "min": 0,
        "max": "1",
        "base": {
          "path": "Element.extension",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "Extension",
            "profile": [
              "http://nictiz.nl/fhir/StructureDefinition/ext-TimeInterval.Duration"
            ]
          }
        ],
        "condition": [
          "ele-1"
        ],
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() or (children().count() > id.count())",
            "xpath": "@value|f:*|h:div",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          },
          {
            "key": "ext-1",
            "severity": "error",
            "human": "Must have either extensions or value[x], not both",
            "expression": "extension.exists() != value.exists()",
            "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
            "source": "http://hl7.org/fhir/StructureDefinition/Extension"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          },
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      },
      {
        "id": "Period.start",
        "path": "Period.start",
        "short": "startDateTime",
        "definition": "The start date and time of the interval.",
        "comment": "If the low element is missing, the meaning is that the low boundary is not known.",
        "alias": [
          "startDatumTijd"
        ],
        "min": 0,
        "max": "1",
        "base": {
          "path": "Period.start",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "dateTime"
          }
        ],
        "condition": [
          "ele-1",
          "per-1"
        ],
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() or (children().count() > id.count())",
            "xpath": "@value|f:*|h:div",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          },
          {
            "identity": "v2",
            "map": "DR.1"
          },
          {
            "identity": "rim",
            "map": "./low"
          },
          {
            "identity": "zib-timeinterval-v1.0-2020EN",
            "map": "NL-CM:20.3.2",
            "comment": "startDateTime"
          }
        ]
      },
      {
        "id": "Period.end",
        "path": "Period.end",
        "short": "endDateTime",
        "definition": "The end date and time of the interval.",
        "comment": "The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.",
        "alias": [
          "eindDatumTijd"
        ],
        "min": 0,
        "max": "1",
        "base": {
          "path": "Period.end",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "dateTime"
          }
        ],
        "meaningWhenMissing": "If the end of the period is missing, it means that the period is ongoing",
        "condition": [
          "ele-1",
          "per-1"
        ],
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() or (children().count() > id.count())",
            "xpath": "@value|f:*|h:div",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          },
          {
            "identity": "v2",
            "map": "DR.2"
          },
          {
            "identity": "rim",
            "map": "./high"
          },
          {
            "identity": "zib-timeinterval-v1.0-2020EN",
            "map": "NL-CM:20.3.3",
            "comment": "endDateTime"
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "Period",
        "path": "Period",
        "short": "TimeInterval",
        "alias": [
          "TijdsInterval"
        ],
        "mapping": [
          {
            "identity": "zib-timeinterval-v1.0-2020EN",
            "map": "NL-CM:20.3.1",
            "comment": "TimeInterval"
          }
        ]
      },
      {
        "id": "Period.extension:duration",
        "path": "Period.extension",
        "sliceName": "duration",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "http://nictiz.nl/fhir/StructureDefinition/ext-TimeInterval.Duration"
            ]
          }
        ]
      },
      {
        "id": "Period.start",
        "path": "Period.start",
        "short": "startDateTime",
        "definition": "The start date and time of the interval.",
        "alias": [
          "startDatumTijd"
        ],
        "mapping": [
          {
            "identity": "zib-timeinterval-v1.0-2020EN",
            "map": "NL-CM:20.3.2",
            "comment": "startDateTime"
          }
        ]
      },
      {
        "id": "Period.end",
        "path": "Period.end",
        "short": "endDateTime",
        "definition": "The end date and time of the interval.",
        "alias": [
          "eindDatumTijd"
        ],
        "mapping": [
          {
            "identity": "zib-timeinterval-v1.0-2020EN",
            "map": "NL-CM:20.3.3",
            "comment": "endDateTime"
          }
        ]
      }
    ]
  }
}