Clinical Document Architecture
2.0.0-sd - release

Clinical Document Architecture, published by Health Level 7. This guide is not an authorized publication; it is the continuous build for version 2.0.0-sd built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/CDA-core-sd/ and changes regularly. See the Directory of published versions

Logical Model: PIVL_TS - JSON Profile

Active as of 2024-10-25

JSON representation of the PIVL-TS logical model.

Raw json | Download

{
  "resourceType" : "StructureDefinition",
  "id" : "PIVL-TS",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n      <p>An interval of time that recurs periodically. Periodic intervals have two properties, phase and period. The phase specifies the &quot;interval prototype&quot; that is repeated every period.</p>\n    </div>"
  },
  "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/cda/stds/core/StructureDefinition/PIVL-TS",
  "version" : "2.0.0-sd",
  "name" : "PIVL_TS",
  "title" : "PIVL_TS: PeriodicIntervalOfTime (V3 Data Type)",
  "status" : "active",
  "experimental" : false,
  "date" : "2024-10-25T20:25:09+00:00",
  "publisher" : "Health Level 7",
  "contact" : [
    {
      "name" : "HL7 International - Structured Documents",
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/structure"
        },
        {
          "system" : "email",
          "value" : "structdog@lists.HL7.org"
        }
      ]
    }
  ],
  "description" : "An interval of time that recurs periodically. Periodic intervals have two properties, phase and period. The phase specifies the \"interval prototype\" that is repeated every period.",
  "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/PIVL_TS",
  "baseDefinition" : "http://hl7.org/cda/stds/core/StructureDefinition/SXCM-TS",
  "derivation" : "specialization",
  "snapshot" : {
    "element" : [
      {
        "id" : "PIVL_TS",
        "path" : "PIVL_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" : "*"
        },
        "isModifier" : false,
        "mapping" : [
          {
            "identity" : "rim",
            "map" : "n/a"
          }
        ]
      },
      {
        "id" : "PIVL_TS.nullFlavor",
        "path" : "PIVL_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" : "PIVL_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" : "PIVL_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" : "0",
        "base" : {
          "path" : "TS.value",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "dateTime",
            "profile" : [
              🔗 "http://hl7.org/cda/stds/core/StructureDefinition/ts-simple"
            ]
          }
        ]
      },
      {
        "id" : "PIVL_TS.operator",
        "path" : "PIVL_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" : "PIVL_TS.phase",
        "path" : "PIVL_TS.phase",
        "label" : "Phase",
        "definition" : "A prototype of the repeating interval, specifying the duration of each occurrence and anchors the periodic interval sequence at a certain point in time.",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "PIVL_TS.phase",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS"
          }
        ]
      },
      {
        "id" : "PIVL_TS.period",
        "path" : "PIVL_TS.period",
        "label" : "Period",
        "definition" : "A time duration specifying as a reciprocal measure of the frequency at which the periodic interval repeats.",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "PIVL_TS.period",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "http://hl7.org/cda/stds/core/StructureDefinition/PQ"
          }
        ]
      },
      {
        "id" : "PIVL_TS.alignment",
        "path" : "PIVL_TS.alignment",
        "representation" : [
          "xmlAttr"
        ],
        "label" : "Alignment to the Calendar",
        "definition" : "Specifies if and how the repetitions are aligned to the cycles of the underlying calendar (e.g., to distinguish every 30 days from \"the 5th of every month\".) A non-aligned periodic interval recurs independently from the calendar. An aligned periodic interval is synchronized with the calendar.",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "PIVL_TS.alignment",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "code",
            "profile" : [
              🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
            ]
          }
        ]
      },
      {
        "id" : "PIVL_TS.institutionSpecified",
        "path" : "PIVL_TS.institutionSpecified",
        "representation" : [
          "xmlAttr"
        ],
        "label" : "Institution Specified Timing",
        "definition" : "Indicates whether the exact timing is up to the party executing the schedule (e.g., to distinguish \"every 8 hours\" from \"3 times a day\".)",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "PIVL_TS.institutionSpecified",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "boolean",
            "profile" : [
              🔗 "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
            ]
          }
        ]
      }
    ]
  },
  "differential" : {
    "element" : [
      {
        "id" : "PIVL_TS",
        "path" : "PIVL_TS",
        "min" : 1,
        "max" : "*"
      },
      {
        "id" : "PIVL_TS.value",
        "path" : "PIVL_TS.value",
        "representation" : [
          "xmlAttr"
        ],
        "min" : 0,
        "max" : "0"
      },
      {
        "id" : "PIVL_TS.phase",
        "path" : "PIVL_TS.phase",
        "label" : "Phase",
        "definition" : "A prototype of the repeating interval, specifying the duration of each occurrence and anchors the periodic interval sequence at a certain point in time.",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS"
          }
        ]
      },
      {
        "id" : "PIVL_TS.period",
        "path" : "PIVL_TS.period",
        "label" : "Period",
        "definition" : "A time duration specifying as a reciprocal measure of the frequency at which the periodic interval repeats.",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "http://hl7.org/cda/stds/core/StructureDefinition/PQ"
          }
        ]
      },
      {
        "id" : "PIVL_TS.alignment",
        "path" : "PIVL_TS.alignment",
        "representation" : [
          "xmlAttr"
        ],
        "label" : "Alignment to the Calendar",
        "definition" : "Specifies if and how the repetitions are aligned to the cycles of the underlying calendar (e.g., to distinguish every 30 days from \"the 5th of every month\".) A non-aligned periodic interval recurs independently from the calendar. An aligned periodic interval is synchronized with the calendar.",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "code",
            "profile" : [
              🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
            ]
          }
        ]
      },
      {
        "id" : "PIVL_TS.institutionSpecified",
        "path" : "PIVL_TS.institutionSpecified",
        "representation" : [
          "xmlAttr"
        ],
        "label" : "Institution Specified Timing",
        "definition" : "Indicates whether the exact timing is up to the party executing the schedule (e.g., to distinguish \"every 8 hours\" from \"3 times a day\".)",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "boolean",
            "profile" : [
              🔗 "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
            ]
          }
        ]
      }
    ]
  }
}