ext-TimeInterval.Period
type: StructureDefinition
node role: treeRoot
id:
  v: ext-TimeInterval.Period
text:
  status:
    v: extensions
  div: Name Flags Card. Type Description & Constraints Extension 0..* Extension Extension url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/ext-TimeInterval.Period" value[x] 0..1 ZibTimeInterval TimeInterval Documentation for this format
url:
  v: http://nictiz.nl/fhir/StructureDefinition/ext-TimeInterval.Period
version:
  v: 0.9.0
name:
  v: ExtTimeIntervalPeriod
title:
  v: ext TimeInterval.Period
status:
  v: draft
date:
  v: 2023-10-17T18:06:34+02:00
publisher:
  v: HL7NL
contact:
  name:
    v: HL7NL
  telecom:
    system:
      v: url
    value:
      v: https://hl7.nl
description:
  v: An extension to provide all concepts of zib TimeInterval, to be used in resources where none of these concepts are natively supported.
purpose:
  v: This extension 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)). This 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: * [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 isn't normally available. This extension should not be used in isolation, but only via one of the two resources described below! * [zib-TimeInterval](http://nictiz.nl/fhir/StructureDefinition/zib-TimeInterval): 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. * [ext-TimeInterval.Period](http://nictiz.nl/fhir/StructureDefinition/ext-TimeInterval.Period) (this extension): 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_ nor _Duration_, this extension should be used. *Note*: In hindsight the name of this extension is confusing, 'ext-TimeInterval' would have been better suited. * *Note*: when the resource type natively supports elements of datatype _Period_ and _Duration_, the zib should be mapped onto these elements directly.
copyright:
  v: 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.
fhir version:
  v: 4.0.1
mapping:
  identity:
    v: rim
  uri:
    v: http://hl7.org/v3
  name:
    v: RIM Mapping
kind:
  v: complex-type
abstract:
  v: false
context:
  type:
    v: element
  expression:
    v: MedicationRequest
context:
  type:
    v: element
  expression:
    v: MedicationDispense
type:
  v: Extension
base definition:
  v: http://hl7.org/fhir/StructureDefinition/Extension
  link: http://hl7.org/fhir/StructureDefinition/Extension
derivation:
  v: constraint
snapshot:
  element:
    id:
      v: Extension
    path:
      v: Extension
    short:
      v: Extension
    definition:
      v: An Extension
    min:
      v: 0
    max:
      v: *
    base:
      path:
        v: Extension
      min:
        v: 0
      max:
        v: *
    condition:
      v: ele-1
    constraint:
      key:
        v: ele-1
      severity:
        v: error
      human:
        v: All FHIR elements must have a @value or children
      expression:
        v: hasValue() or (children().count() > id.count())
      xpath:
        v: @value|f:*|h:div
      source:
        v: http://hl7.org/fhir/StructureDefinition/Element
        link: http://hl7.org/fhir/StructureDefinition/Element
    constraint:
      key:
        v: ext-1
      severity:
        v: error
      human:
        v: Must have either extensions or value[x], not both
      expression:
        v: extension.exists() != value.exists()
      xpath:
        v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
      source:
        v: http://hl7.org/fhir/StructureDefinition/Extension
        link: http://hl7.org/fhir/StructureDefinition/Extension
    is modifier:
      v: false
  element:
    id:
      v: Extension.id
    path:
      v: Extension.id
    representation:
      v: xmlAttr
    short:
      v: Unique id for inter-element referencing
    definition:
      v: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
    min:
      v: 0
    max:
      v: 1
    base:
      path:
        v: Element.id
      min:
        v: 0
      max:
        v: 1
    type:
      code:
        v: http://hl7.org/fhirpath/System.String
    is modifier:
      v: false
    is summary:
      v: false
    mapping:
      identity:
        v: rim
      map:
        v: n/a
  element:
    id:
      v: Extension.extension
    path:
      v: Extension.extension
    slicing:
      description:
        v: Extensions are always sliced by (at least) url
      rules:
        v: open
    short:
      v: Additional content defined by implementations
    definition:
      v: 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:
      v: 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:
      v: extensions
    alias:
      v: user content
    min:
      v: 0
    max:
      v: *
    base:
      path:
        v: Element.extension
      min:
        v: 0
      max:
        v: *
    type:
      code:
        v: Extension
    constraint:
      key:
        v: ele-1
      severity:
        v: error
      human:
        v: All FHIR elements must have a @value or children
      expression:
        v: hasValue() or (children().count() > id.count())
      xpath:
        v: @value|f:*|h:div
      source:
        v: http://hl7.org/fhir/StructureDefinition/Element
        link: http://hl7.org/fhir/StructureDefinition/Element
    constraint:
      key:
        v: ext-1

v: string

v: value

v: url

v: error

v: Must have either extensions or value[x], not both

v: extension.exists() != value.exists()

v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])

v: false

v: false

identity:
  v: rim
map:
  v: n/a

id:
  v: Extension.url
path:
  v: Extension.url
representation:
  v: xmlAttr
short:
  v: identifies the meaning of the extension
definition:
  v: Source of the definition for the extension code - a logical name or a URL.
comment:
  v: The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Extension.url
  min:
    v: 1
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
    value:
      v: uri
  code:
    v: http://hl7.org/fhirpath/System.String
fixed:
  v: http://nictiz.nl/fhir/StructureDefinition/ext-TimeInterval.Period
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Extension.value[x]
path:
  v: Extension.value[x]
short:
  v: TimeInterval
definition:
  v: A time period defined by a start and end date and optionally time.
comment:
  v: 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"). Period is not used for a duration (a measure of elapsed time). See [Duration](http://hl7.org/fhir/R4/datatypes.html#Duration).
alias:
  v: TijdsInterval
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Extension.value[x]
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Period
  profile:
    v: http://nictiz.nl/fhir/StructureDefinition/zib-TimeInterval
    link: http://nictiz.nl/fhir/StructureDefinition/zib-TimeInterval
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: per-1
  severity:
    v: error
  human:
    v: If present, start SHALL have a lower value than end
  expression:
    v: start.hasValue().not() or end.hasValue().not() or (start <= end)
  xpath:
    v: not(exists(f:start/@value)) or not(exists(f:end/@value)) or (xs:dateTime(f:start/@value) <= xs:dateTime(f:end/@value))
  source:
    v: http://hl7.org/fhir/StructureDefinition/Period
    link: http://hl7.org/fhir/StructureDefinition/Period
is modifier:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: v2
  map:
    v: DR
mapping:
  identity:
    v: rim
  map:
    v: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
mapping:
  identity:
    v: zib-timeinterval-v1.0-2020EN
  map:
    v: NL-CM:20.3.1
  comment:
    v: TimeInterval

element:
  id:
    v: Extension
  path:
    v: Extension
element:
  id:
    v: Extension.url
  path:
    v: Extension.url
  fixed:
    v: http://nictiz.nl/fhir/StructureDefinition/ext-TimeInterval.Period
element:
  id:
    v: Extension.value[x]
  path:
    v: Extension.value[x]
  type:
    code:
      v: Period
    profile:
      v: http://nictiz.nl/fhir/StructureDefinition/zib-TimeInterval
      link: http://nictiz.nl/fhir/StructureDefinition/zib-TimeInterval