FHIR © HL7.org  |  Server Home  |  XIG Home  |  Server Source  |  FHIR  

FHIR IG Statistics: StructureDefinition/IVL-TS

Packageau.digitalhealth.cda.schema
TypeStructureDefinition
IdIVL-TS
FHIR VersionR5
Sourcehttp://ns.electronichealth.net.au/cda/https://build.fhir.org/ig/AuDigitalHealth/cda-au-schema/StructureDefinition-IVL-TS.html
URLhttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
Version1.0.0
Statusactive
Date2025-07-21T22:05:27+00:00
NameIVL_TS
TitleIVL_TS: Interval (V3 Data Type)
Realmau
Authoritynational
DescriptionA set of consecutive values of an ordered base data type.
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL_TS
Kindlogical

Resources that use this resource

StructureDefinition
ADAD: PostalAddress (V3 Data Type)
ActAct (CDA Class)
AlternateIdentificationAlternateIdentification (CDA Class)
CriterionCriterion (CDA Class)
ENEN: EntityName (V3 Data Type)
EncompassingEncounterEncompassingEncounter (CDA Class)
EncounterEncounter (CDA Class)
EncounterParticipantEncounterParticipant (CDA Class)
MaintainedEntityMaintainedEntity (CDA Class)
ObservationObservation (CDA Class)
ObservationRangeObservationRange (CDA Class)
OrganizationPartOfOrganizationPartOf (CDA Class)
OrganizerOrganizer (CDA Class)
PIVL-TSPIVL_TS: PeriodicIntervalOfTime (V3 Data Type)
Participant1Participant1 (CDA Class)
Participant2Participant2 (CDA Class)
Performer1Performer1 (CDA Class)
Performer2Performer2 (CDA Class)
ProcedureProcedure (CDA Class)
RelatedEntityRelatedEntity (CDA Class)
SXPR-TSSXPR_TS: Component part of GTS (V3 Data Type)
ServiceEventServiceEvent (CDA Class)
SubstanceAdministrationSubstanceAdministration (CDA Class)
SupplySupply (CDA Class)
TELTEL: TelecommunicationAddress (V3 Data Type)
addraddr AD: PostalAddress (V3 Data Type)
au-ActADHA Act (CDA Class)
au-AddressADHA AD: PostalAddress (V3 Data Type)
au-EncompassingEncounterADHA EncompassingEncounter (CDA Class)
au-EncounterADHA Encounter (CDA Class)
au-EncounterParticipantADHA EncounterParticipant (CDA Class)
au-EntityNameADHA EN: EntityName (V3 Data Type)
au-ObservationADHA Observation (CDA Class)
au-ObservationRangeADHA ObservationRange (CDA Class)
au-OrganizationPartOfADHA OrganizationPartOf (CDA Class)
au-OrganizerADHA Organizer (CDA Class)
au-Participant1ADHA Participant1 (CDA Class)
au-Participant2ADHA Participant2 (CDA Class)
au-Performer2ADHA Performer2 (CDA Class)
au-ProcedureADHA Procedure (CDA Class)
au-SubstanceAdministrationADHA SubstanceAdministration (CDA Class)
au-SupplyADHA Supply (CDA Class)
au-TelecomADHA TEL: TelecommunicationAddress (V3 Data Type)
controlActADHA extension controlAct
entitlementADHA extension entitlement
telecomADHA extension TEL: TelecommunicationAddress (V3 Data Type)
CareTeamMemberScheduleObservationCare Team Member Schedule Observation
MedicationActivityMedication Activity
MedicationSupplyOrderMedication Supply Order
NonMedicinalSupplyActivityNon-Medicinal Supply Activity
NoteActivityNote Activity
PlannedMedicationActivityPlanned Medication Activity
ProcedureActivityProcedureProcedure Activity Procedure
SectionTimeRangeObservationSection Time Range Observation
USRealmDateTimeIntervalUS Realm Date and Time - Interval
USRealmHeaderUS Realm Header
2.16.840.1.113883.10.22.4.37--20200508162154IPS Advance Directive Observation

Resources that this resource uses

StructureDefinition
IVXB-TSIVXB_TS: Interval Boundary PointInTime (V3 Data Type)
PQPQ: PhysicalQuantity (V3 Data Type)
SXCM-TSSXCM_TS: GeneralTimingSpecification (V3 Data Type)
TSTS: PointInTime (V3 Data Type)

Narrative

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

Generated Narrative: StructureDefinition IVL-TS

NameFlagsCard.TypeDescription & Constraintsdoco
.. IVL_TS C1..*SXCM_TSXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, @value, @operator
Base for all types and resources
Logical Container: ClinicalDocument (CDA Class)
Constraints: ivl-ts-center
... low 0..1IVXB_TS
... center 0..1TS
... width 0..1PQ
... high 0..1IVXB_TS

doco Documentation for this format

Source

{
  "resourceType": "StructureDefinition",
  "id": "IVL-TS",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/logical-target",
      "_valueBoolean": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
            "valueCode": "not-applicable"
          }
        ]
      }
    },
    {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
      "valueUri": "urn:hl7-org:v3"
    },
    {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/logical-container",
      "valueUri": "http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger": 1,
      "_valueInteger": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical": "http://ns.electronichealth.net.au/cda/ImplementationGuide/au.digitalhealth.cda.schema"
          }
        ]
      }
    }
  ],
  "url": "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS",
  "version": "1.0.0",
  "name": "IVL_TS",
  "title": "IVL_TS: Interval (V3 Data Type)",
  "status": "active",
  "experimental": false,
  "date": "2025-07-21T22:05:27+00:00",
  "publisher": "HL7",
  "description": "A set of consecutive values of an ordered base data type.",
  "fhirVersion": "5.0.0",
  "mapping": [
    {
      "identity": "rim",
      "uri": "http://hl7.org/v3",
      "name": "RIM Mapping"
    }
  ],
  "kind": "logical",
  "abstract": false,
  "type": "http://hl7.org/cda/stds/core/StructureDefinition/IVL_TS",
  "baseDefinition": "http://hl7.org/cda/stds/core/StructureDefinition/SXCM-TS",
  "derivation": "specialization",
  "snapshot": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
        "valueString": "1.0.0"
      }
    ],
    "element": [
      {
        "id": "IVL_TS",
        "path": "IVL_TS",
        "short": "Base for all types and resources",
        "definition": "A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.",
        "min": 1,
        "max": "*",
        "base": {
          "path": "Base",
          "min": 0,
          "max": "*"
        },
        "constraint": [
          {
            "key": "ivl-ts-center",
            "severity": "error",
            "human": "Center cannot co-exist with low or high",
            "expression": "center.empty() or (low.empty() and high.empty())"
          }
        ],
        "isModifier": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "IVL_TS.nullFlavor",
        "path": "IVL_TS.nullFlavor",
        "representation": [
          "xmlAttr"
        ],
        "label": "Exceptional Value Detail",
        "definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "ANY.nullFlavor",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "code",
            "profile": [
              "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
            ]
          }
        ],
        "binding": {
          "strength": "required",
          "valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
        }
      },
      {
        "id": "IVL_TS.value",
        "extension": [
          {
            "url": "http://hl7.org/fhir/tools/StructureDefinition/elementdefinition-date-format",
            "valueString": "YYYYMMDDHHMMSS.UUUU[+|-ZZzz]"
          },
          {
            "url": "http://hl7.org/fhir/tools/StructureDefinition/elementdefinition-date-rules",
            "valueString": "year-valid"
          }
        ],
        "path": "IVL_TS.value",
        "representation": [
          "xmlAttr"
        ],
        "definition": "A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "TS.value",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "dateTime",
            "profile": [
              "http://hl7.org/cda/stds/core/StructureDefinition/ts-simple"
            ]
          }
        ]
      },
      {
        "id": "IVL_TS.operator",
        "path": "IVL_TS.operator",
        "representation": [
          "xmlAttr"
        ],
        "definition": "A code specifying whether the set component is included (union) or excluded (set-difference) from the set, or other set operations with the current set component and the set as constructed from the representation stream up to the current point.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "SXCM_TS.operator",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "code",
            "profile": [
              "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
            ]
          }
        ],
        "defaultValueCode": "I",
        "binding": {
          "strength": "required",
          "valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDASetOperator"
        }
      },
      {
        "id": "IVL_TS.low",
        "path": "IVL_TS.low",
        "label": "Low Boundary",
        "definition": "This is the low limit of the interval.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "IVL_TS.low",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS"
          }
        ]
      },
      {
        "id": "IVL_TS.center",
        "path": "IVL_TS.center",
        "label": "Central Value",
        "definition": "The arithmetic mean of the interval (low plus high divided by 2). The purpose of distinguishing the center as a semantic property is for conversions of intervals from and to point values.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "IVL_TS.center",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/TS"
          }
        ]
      },
      {
        "id": "IVL_TS.width",
        "path": "IVL_TS.width",
        "label": "Width",
        "definition": "The difference between high and low boundary. The purpose of distinguishing a width property is to handle all cases of incomplete information symmetrically. In any interval representation only two of the three properties high, low, and width need to be stated and the third can be derived.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "IVL_TS.width",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/PQ"
          }
        ]
      },
      {
        "id": "IVL_TS.high",
        "path": "IVL_TS.high",
        "label": "High Boundary",
        "definition": "This is the high limit of the interval.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "IVL_TS.high",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS"
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "IVL_TS",
        "path": "IVL_TS",
        "min": 1,
        "max": "*",
        "constraint": [
          {
            "key": "ivl-ts-center",
            "severity": "error",
            "human": "Center cannot co-exist with low or high",
            "expression": "center.empty() or (low.empty() and high.empty())"
          }
        ]
      },
      {
        "id": "IVL_TS.low",
        "path": "IVL_TS.low",
        "label": "Low Boundary",
        "definition": "This is the low limit of the interval.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS"
          }
        ]
      },
      {
        "id": "IVL_TS.center",
        "path": "IVL_TS.center",
        "label": "Central Value",
        "definition": "The arithmetic mean of the interval (low plus high divided by 2). The purpose of distinguishing the center as a semantic property is for conversions of intervals from and to point values.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/TS"
          }
        ]
      },
      {
        "id": "IVL_TS.width",
        "path": "IVL_TS.width",
        "label": "Width",
        "definition": "The difference between high and low boundary. The purpose of distinguishing a width property is to handle all cases of incomplete information symmetrically. In any interval representation only two of the three properties high, low, and width need to be stated and the third can be derived.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/PQ"
          }
        ]
      },
      {
        "id": "IVL_TS.high",
        "path": "IVL_TS.high",
        "label": "High Boundary",
        "definition": "This is the high limit of the interval.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS"
          }
        ]
      }
    ]
  }
}