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

FHIR IG analytics

Packagehl7.cda.uv.core
Resource TypeStructureDefinition
IdStructureDefinition-PIVL-TS.json
FHIR VersionR5

Resources that use this resource

No resources found


Resources that this resource uses

No resources found


Narrative

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

Note: because this type is defined as an extension of SXCM_T, all of the attributes and elements accepted for T are also accepted by this definition. However, they are NOT allowed by the normative description of this type. Unfortunately, we cannot write a general purpose schematron contraints to provide that extra validation, thus applications must be aware that instance (fragments) that pass validation with this might might still not be legal.


Source1

{
  "resourceType": "StructureDefinition",
  "id": "PIVL-TS",
  "text": {
    "status": "generated",
    "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/StructureDefinition/elementdefinition-namespace",
      "valueUri": "urn:hl7-org:v3"
    }
  ],
  "url": "http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS",
  "version": "2.0.1",
  "name": "PIVL_TS",
  "title": "PIVL_TS: PeriodicIntervalOfTime (V3 Data Type)",
  "status": "active",
  "experimental": false,
  "date": "2023-10-03T20:44:04+00:00",
  "publisher": "Health Level 7",
  "contact": [
    {
      "name": "HL7 International - Structured Documents",
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/structdoc"
        },
        {
          "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": "Note: because this type is defined as an extension of SXCM_T, all of the attributes and elements accepted for T are also accepted by this definition. However, they are NOT allowed by the normative description of this type. Unfortunately, we cannot write a general purpose schematron contraints to provide that extra validation, thus applications must be aware that instance (fragments) that pass validation with this might might still not be legal.",
        "min": 1,
        "max": "*",
        "base": {
          "path": "Base",
          "min": 0,
          "max": "*"
        },
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() or (children().count() > id.count())",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          }
        ],
        "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://terminology.hl7.org/ValueSet/v3-NullFlavor"
        }
      },
      {
        "id": "PIVL_TS.value",
        "extension": [
          {
            "url": "http://hl7.org/fhir/tools/StructureDefinition/elementdefinition-date-format",
            "valueString": "YYYYMMDDHHMMSS.UUUU[+|-ZZzz]"
          }
        ],
        "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": "string",
            "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://terminology.hl7.org/ValueSet/v3-SetOperator"
        }
      },
      {
        "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",
        "definition": "Note: because this type is defined as an extension of SXCM_T, all of the attributes and elements accepted for T are also accepted by this definition. However, they are NOT allowed by the normative description of this type. Unfortunately, we cannot write a general purpose schematron contraints to provide that extra validation, thus applications must be aware that instance (fragments) that pass validation with this might might still not be legal.",
        "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"
            ]
          }
        ]
      }
    ]
  }
}