FHIR © HL7.org  |  FHIRsmith 4.0.1  |  Server Home  |  XIG Home  |  XIG Stats  | 

FHIR IG analytics

Packageopenehr.base
Resource TypeStructureDefinition
IdStructureDefinition-INTERVAL-EVENT.json
FHIR VersionR5
Sourcehttp://fhir.org/guides/openehr/base/0.1.0-snapshot/StructureDefinition-INTERVAL-EVENT.html
URLhttp://openehr.org/fhir/StructureDefinition/INTERVAL-EVENT
Version0.1.0-snapshot
Statusactive
Date2025-09-06T15:35:39+10:00
NameINTERVAL_EVENT
TitleINTERVAL_EVENT
Realmuv
Authorityhl7
DescriptionDefines a single interval event in a series.
Typehttp://openehr.org/fhir/StructureDefinition/INTERVAL_EVENT
Kindlogical

Resources that use this resource

No resources found


Resources that this resource uses

StructureDefinition
openehr.base#0.1.0-snapshotDV-CODED-TEXTDV_CODED_TEXT
openehr.base#0.1.0-snapshotDV-DURATIONDV_DURATION
openehr.base#0.1.0-snapshotEVENTEVENT

Narrative

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

Generated Narrative: StructureDefinition INTERVAL-EVENT

NameFlagsCard.TypeDescription & Constraintsdoco
.. INTERVAL_EVENT<T : Any> C0..*EVENTDefines a single interval event in a series.

Elements defined in Ancestors:name, archetype_node_id, uid, links, archetype_details, feeder_audit, time, state, data
Constraints: Math_function_validity, Interval_start_time_valid
... width<T : Any> 1..1DV_DURATIONDuration of the time interval during which the values recorded under `data` are true and, if set, the values recorded under `state` are true.
... sample_count<T : Any> 0..1integerOptional count of original samples to which this event corresponds.
... math_function<T : Any> 1..1DV_CODED_TEXTMathematical function of the data of this event, e.

doco Documentation for this format

Source1

{
  "resourceType": "StructureDefinition",
  "id": "INTERVAL-EVENT",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "contained": [
    {
      "resourceType": "OperationDefinition",
      "id": "interval_start_time",
      "name": "interval_start_time",
      "title": "interval_start_time",
      "status": "active",
      "kind": "operation",
      "description": "Start time of the interval of this event.",
      "code": "interval_start_time",
      "system": false,
      "instance": true,
      "parameter": [
        {
          "name": "return",
          "use": "out",
          "min": 1,
          "max": "1",
          "type": "dateTime"
        }
      ]
    }
  ],
  "extension": [
    {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/web-source",
      "valueUrl": "https://specifications.openehr.org/releases/RM/Release-1.1.0/data_structures.html#_interval_event_class"
    },
    {
      "extension": [
        {
          "url": "name",
          "valueCode": "T"
        },
        {
          "url": "type",
          "valueUri": "http://openehr.org/fhir/StructureDefinition/Any"
        }
      ],
      "url": "http://hl7.org/fhir/tools/StructureDefinition/type-parameter"
    },
    {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/type-operation",
      "valueCanonical": "#interval_start_time"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "fhir"
    },
    {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/view-hint",
      "valueCode": "element-view-replace-cardinality"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger": 3,
      "_valueInteger": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical": "http://openehr.org/fhir/ImplementationGuide/openehr.base"
          }
        ]
      }
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode": "informative",
      "_valueCode": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical": "http://openehr.org/fhir/ImplementationGuide/openehr.base"
          }
        ]
      }
    }
  ],
  "url": "http://openehr.org/fhir/StructureDefinition/INTERVAL-EVENT",
  "version": "0.1.0-snapshot",
  "name": "INTERVAL_EVENT",
  "title": "INTERVAL_EVENT",
  "status": "active",
  "experimental": false,
  "date": "2025-09-06T15:35:39+10:00",
  "publisher": "openEHR + HL7",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://www.openehr.org"
        }
      ]
    }
  ],
  "description": "Defines a single interval event in a series. ",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code": "001"
        }
      ]
    }
  ],
  "fhirVersion": "5.0.0",
  "mapping": [
    {
      "identity": "rim",
      "uri": "http://hl7.org/v3",
      "name": "RIM Mapping"
    }
  ],
  "kind": "logical",
  "abstract": false,
  "type": "http://openehr.org/fhir/StructureDefinition/INTERVAL_EVENT",
  "baseDefinition": "http://openehr.org/fhir/StructureDefinition/EVENT",
  "derivation": "specialization",
  "snapshot": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
        "valueString": "0.1.0-snapshot"
      }
    ],
    "element": [
      {
        "id": "INTERVAL_EVENT",
        "path": "INTERVAL_EVENT",
        "short": "Defines a single interval event in a series.",
        "definition": "Defines a single interval event in a series. ",
        "min": 0,
        "max": "*",
        "base": {
          "path": "Base",
          "min": 0,
          "max": "*"
        },
        "constraint": [
          {
            "key": "Links_valid",
            "severity": "error",
            "human": "Links valid must be present",
            "expression": "links.exists() implies links.empty().not()",
            "source": "http://openehr.org/fhir/StructureDefinition/LOCATABLE"
          },
          {
            "key": "Archetyped_valid",
            "severity": "error",
            "human": "Archetyped valid must satisfy exclusive conditions",
            "expression": "is_archetype_root() xor archetype_details .empty()",
            "source": "http://openehr.org/fhir/StructureDefinition/LOCATABLE"
          },
          {
            "key": "Archetype_node_id_valid",
            "severity": "error",
            "human": "Archetype node id valid must not be empty",
            "expression": "archetype_node_id.empty().not()",
            "source": "http://openehr.org/fhir/StructureDefinition/LOCATABLE"
          },
          {
            "key": "Offset_validity",
            "severity": "error",
            "human": "Offset validity",
            "expression": "null # TODO: manual translation needed",
            "source": "http://openehr.org/fhir/StructureDefinition/EVENT"
          },
          {
            "key": "Offset_validity1",
            "severity": "error",
            "human": "Offset validity1 must be present",
            "expression": "offset().exists() and then offset() = time.diff (parent().origin)",
            "source": "http://openehr.org/fhir/StructureDefinition/EVENT"
          },
          {
            "key": "Math_function_validity",
            "severity": "error",
            "human": "Math function validity",
            "expression": "null # TODO: manual translation needed"
          },
          {
            "key": "Interval_start_time_valid",
            "severity": "error",
            "human": "Interval start time valid",
            "expression": "interval_start_time() = time - width"
          }
        ],
        "isModifier": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "INTERVAL_EVENT.name",
        "path": "INTERVAL_EVENT.name",
        "short": "Runtime name of this fragment, used to build runtime paths.",
        "definition": "Runtime name of this fragment, used to build runtime paths. This is the term provided via a clinical application or batch process to name this EHR construct: its retention in the EHR faithfully preserves the original label by which this entry was known to end users.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "LOCATABLE.name",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/DV-TEXT"
          }
        ],
        "isModifier": false
      },
      {
        "id": "INTERVAL_EVENT.archetype-node-id",
        "path": "INTERVAL_EVENT.archetype_node_id",
        "short": "Design-time archetype identifier of this node taken from its generating archetype; used to build archetype paths.",
        "definition": "Design-time archetype identifier of this node taken from its generating archetype; used to build archetype paths. Always in the form of an at-code, e.g.  `at0005`. This value enables a 'standardised' name for this node to be generated, by referring to the generating archetype local terminology. \n\nAt an archetype root point, the value of this attribute is always the stringified form of the `_archetype_id_` found in the `_archetype_details_` object.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "LOCATABLE.archetype_node_id",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "string"
          }
        ],
        "isModifier": false
      },
      {
        "id": "INTERVAL_EVENT.uid",
        "path": "INTERVAL_EVENT.uid",
        "short": "Optional globally unique object identifier for root points of archetyped structures.",
        "definition": "Optional globally unique object identifier for root points of archetyped structures.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "LOCATABLE.uid",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/UID-BASED-ID"
          }
        ],
        "isModifier": false
      },
      {
        "id": "INTERVAL_EVENT.links",
        "path": "INTERVAL_EVENT.links",
        "short": "Links to other archetyped structures (data whose root object inherits from `ARCHETYPED`, such as `ENTRY`, `SECTION` and so on).",
        "definition": "Links to other archetyped structures (data whose root object inherits from `ARCHETYPED`, such as `ENTRY`, `SECTION` and so on). Links may be to structures in other compositions.",
        "min": 0,
        "max": "*",
        "base": {
          "path": "LOCATABLE.links",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/LINK"
          }
        ],
        "isModifier": false
      },
      {
        "id": "INTERVAL_EVENT.archetype-details",
        "path": "INTERVAL_EVENT.archetype_details",
        "short": "Details of archetyping used on this node.",
        "definition": "Details of archetyping used on this node.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "LOCATABLE.archetype_details",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/ARCHETYPED"
          }
        ],
        "isModifier": false
      },
      {
        "id": "INTERVAL_EVENT.feeder-audit",
        "path": "INTERVAL_EVENT.feeder_audit",
        "short": "Audit trail from non-openEHR system of original commit of information forming the content of this node, or from a conversion gateway which has synthesised this node.",
        "definition": "Audit trail from non-openEHR system of original commit of information forming the content of this node, or from a conversion gateway which has synthesised this node.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "LOCATABLE.feeder_audit",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/FEEDER-AUDIT"
          }
        ],
        "isModifier": false
      },
      {
        "id": "INTERVAL_EVENT.time",
        "path": "INTERVAL_EVENT.time",
        "short": "Time of this event.",
        "definition": "Time of this event. If the width is non-zero, it is the time point of the trailing edge of the event.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "EVENT.time",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/DV-DATE-TIME"
          }
        ],
        "isModifier": false
      },
      {
        "id": "INTERVAL_EVENT.state",
        "extension": [
          {
            "extension": [
              {
                "url": "name",
                "valueCode": "element-view-group"
              },
              {
                "url": "value",
                "valueString": "State"
              }
            ],
            "url": "http://hl7.org/fhir/tools/StructureDefinition/view-hint"
          },
          {
            "extension": [
              {
                "url": "name",
                "valueCode": "element-view-order"
              },
              {
                "url": "value",
                "valueInteger": 8
              }
            ],
            "url": "http://hl7.org/fhir/tools/StructureDefinition/view-hint"
          }
        ],
        "path": "INTERVAL_EVENT.state",
        "short": "Optional state data for this event.",
        "definition": "Optional state data for this event.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "EVENT.state",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE"
          }
        ],
        "isModifier": false
      },
      {
        "id": "INTERVAL_EVENT.data",
        "extension": [
          {
            "extension": [
              {
                "url": "name",
                "valueCode": "element-view-group"
              },
              {
                "url": "value",
                "valueString": "Event Data"
              }
            ],
            "url": "http://hl7.org/fhir/tools/StructureDefinition/view-hint"
          },
          {
            "extension": [
              {
                "url": "name",
                "valueCode": "element-view-order"
              },
              {
                "url": "value",
                "valueInteger": 10
              }
            ],
            "url": "http://hl7.org/fhir/tools/StructureDefinition/view-hint"
          }
        ],
        "path": "INTERVAL_EVENT.data",
        "short": "The data of this event.",
        "definition": "The data of this event.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "EVENT.data",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/T"
          }
        ],
        "isModifier": false
      },
      {
        "id": "INTERVAL_EVENT.width",
        "path": "INTERVAL_EVENT.width",
        "short": "Duration of the time interval during which the values recorded under `data` are true and, if set, the values recorded under `state` are true.",
        "definition": "Duration of the time interval during which the values recorded under `data` are true and, if set, the values recorded under `state` are true. Void if an instantaneous event.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "INTERVAL_EVENT.width",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/DV-DURATION"
          }
        ],
        "isModifier": false
      },
      {
        "id": "INTERVAL_EVENT.sample-count",
        "path": "INTERVAL_EVENT.sample_count",
        "short": "Optional count of original samples to which this event corresponds.",
        "definition": "Optional count of original samples to which this event corresponds.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "INTERVAL_EVENT.sample_count",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "integer"
          }
        ],
        "isModifier": false
      },
      {
        "id": "INTERVAL_EVENT.math-function",
        "path": "INTERVAL_EVENT.math_function",
        "short": "Mathematical function of the data of this event, e.",
        "definition": "Mathematical function of the data of this event, e.g.  maximum, mean etc. Coded using https://github.com/openEHR/terminology/blob/master/openEHR_RM/en/openehr_terminology.xml[openEHR vocabulary `event math function`]. Default value `640|actual|`, meaning 'actual value'.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "INTERVAL_EVENT.math_function",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/DV-CODED-TEXT"
          }
        ],
        "isModifier": false
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "INTERVAL_EVENT",
        "path": "INTERVAL_EVENT",
        "short": "Defines a single interval event in a series.",
        "definition": "Defines a single interval event in a series. ",
        "min": 0,
        "max": "*",
        "constraint": [
          {
            "key": "Math_function_validity",
            "severity": "error",
            "human": "Math function validity",
            "expression": "null # TODO: manual translation needed"
          },
          {
            "key": "Interval_start_time_valid",
            "severity": "error",
            "human": "Interval start time valid",
            "expression": "interval_start_time() = time - width"
          }
        ],
        "isModifier": false
      },
      {
        "id": "INTERVAL_EVENT.width",
        "path": "INTERVAL_EVENT.width",
        "short": "Duration of the time interval during which the values recorded under `data` are true and, if set, the values recorded under `state` are true.",
        "definition": "Duration of the time interval during which the values recorded under `data` are true and, if set, the values recorded under `state` are true. Void if an instantaneous event.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/DV-DURATION"
          }
        ],
        "isModifier": false
      },
      {
        "id": "INTERVAL_EVENT.sample-count",
        "path": "INTERVAL_EVENT.sample_count",
        "short": "Optional count of original samples to which this event corresponds.",
        "definition": "Optional count of original samples to which this event corresponds.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "integer"
          }
        ],
        "isModifier": false
      },
      {
        "id": "INTERVAL_EVENT.math-function",
        "path": "INTERVAL_EVENT.math_function",
        "short": "Mathematical function of the data of this event, e.",
        "definition": "Mathematical function of the data of this event, e.g.  maximum, mean etc. Coded using https://github.com/openEHR/terminology/blob/master/openEHR_RM/en/openehr_terminology.xml[openEHR vocabulary `event math function`]. Default value `640|actual|`, meaning 'actual value'.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/DV-CODED-TEXT"
          }
        ],
        "isModifier": false
      }
    ]
  }
}