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

FHIR IG analytics

Packagespire-healthcare.prod
Resource TypeStructureDefinition
IdStructureDefinition-Extension-SpireCore-ValidityPeriod.json
FHIR VersionR4
Sourcehttps://simplifier.net/resolve?scope=spire-healthcare.prod@1.3.0-beta&canonical=https://www.spirehealthcare.com/fhir/StructureDefinition/Extension-SpireCore-ValidityPeriod
URLhttps://www.spirehealthcare.com/fhir/StructureDefinition/Extension-SpireCore-ValidityPeriod
Version0.1.0
Statusdraft
NameSpireCoreValidityPeriod
TitleSpireCore Validity Period
Realmuk
DescriptionThe period during which a Spire hospital, site or organisation record is valid for use. This carries the RDS StartDate and EndDate columns, which have no home in FHIR R4 because neither Location nor Organization defines a period element. Dates in the RDS are stored at day precision (YYYYMMDD), so populate start and end as dates without a time component. The period is informational: the resource's status (Location) or active flag (Organization) remains the authoritative lifecycle marker, and the RDS load derives it from these dates (active when StartDate is on or before today and EndDate is empty or on or after today). A future-dated start means the record exists but is not yet bookable, which the booking channel must respect.
PurposeCarry RDS StartDate and EndDate for Location and Organization records without overloading status or active.
TypeExtension
Kindcomplex-type

Resources that use this resource

StructureDefinition
spire-healthcare.prod#1.3.0-betaSpireCore-HospitalLocationSpireCore Hospital Location
spire-healthcare.prod#1.3.0-betaSpireCore-OrganizationSpireCore Organization
spire-healthcare.prod#1.3.0-betaSpireCore-SiteLocationSpireCore Site Location

Resources that this resource uses

No resources found


Examples of Use for Extension

No extension usage examples found


Narrative

No narrative content found in resource


Source1

{
  "resourceType": "StructureDefinition",
  "id": "Extension-SpireCore-ValidityPeriod",
  "meta": {
    "lastUpdated": "2026-10-06T20:47:47.897+00:00"
  },
  "url": "https://www.spirehealthcare.com/fhir/StructureDefinition/Extension-SpireCore-ValidityPeriod",
  "version": "0.1.0",
  "name": "SpireCoreValidityPeriod",
  "title": "SpireCore Validity Period",
  "status": "draft",
  "publisher": "Spire Healthcare",
  "description": "The period during which a Spire hospital, site or organisation record is valid for use. This carries the RDS StartDate and EndDate columns, which have no home in FHIR R4 because neither Location nor Organization defines a period element. Dates in the RDS are stored at day precision (YYYYMMDD), so populate start and end as dates without a time component. The period is informational: the resource's status (Location) or active flag (Organization) remains the authoritative lifecycle marker, and the RDS load derives it from these dates (active when StartDate is on or before today and EndDate is empty or on or after today). A future-dated start means the record exists but is not yet bookable, which the booking channel must respect.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "urn:iso:std:iso:3166",
          "code": "GB"
        }
      ]
    }
  ],
  "purpose": "Carry RDS StartDate and EndDate for Location and Organization records without overloading status or active.",
  "fhirVersion": "4.0.1",
  "mapping": [
    {
      "identity": "rim",
      "uri": "http://hl7.org/v3",
      "name": "RIM Mapping"
    }
  ],
  "kind": "complex-type",
  "abstract": false,
  "context": [
    {
      "type": "element",
      "expression": "Location"
    },
    {
      "type": "element",
      "expression": "Organization"
    }
  ],
  "type": "Extension",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
  "derivation": "constraint",
  "snapshot": {
    "element": [
      {
        "id": "Extension",
        "path": "Extension",
        "short": "SpireCore Validity Period",
        "definition": "The period during which a Spire hospital, site or organisation record is valid for use. This carries the RDS StartDate and EndDate columns, which have no home in FHIR R4 because neither Location nor Organization defines a period element. Dates in the RDS are stored at day precision (YYYYMMDD), so populate start and end as dates without a time component. The period is informational: the resource's status (Location) or active flag (Organization) remains the authoritative lifecycle marker, and the RDS load derives it from these dates (active when StartDate is on or before today and EndDate is empty or on or after today). A future-dated start means the record exists but is not yet bookable, which the booking channel must respect.",
        "min": 0,
        "max": "*",
        "base": {
          "path": "Extension",
          "min": 0,
          "max": "*"
        },
        "condition": [
          "ele-1"
        ],
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() or (children().count() > id.count())",
            "xpath": "@value|f:*|h:div",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          },
          {
            "key": "ext-1",
            "severity": "error",
            "human": "Must have either extensions or value[x], not both",
            "expression": "extension.exists() != value.exists()",
            "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"
          }
        ],
        "isModifier": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          },
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      },
      {
        "id": "Extension.id",
        "path": "Extension.id",
        "representation": [
          "xmlAttr"
        ],
        "short": "Unique id for inter-element referencing",
        "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Element.id",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
                "valueUrl": "string"
              }
            ],
            "code": "http://hl7.org/fhirpath/System.String"
          }
        ],
        "isModifier": false,
        "isSummary": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "Extension.extension",
        "path": "Extension.extension",
        "slicing": {
          "discriminator": [
            {
              "type": "value",
              "path": "url"
            }
          ],
          "description": "Extensions are always sliced by (at least) url",
          "rules": "open"
        },
        "short": "Additional content defined by implementations",
        "definition": "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": "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": [
          "extensions",
          "user content"
        ],
        "min": 0,
        "max": "0",
        "base": {
          "path": "Element.extension",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "Extension"
          }
        ],
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() or (children().count() > id.count())",
            "xpath": "@value|f:*|h:div",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          },
          {
            "key": "ext-1",
            "severity": "error",
            "human": "Must have either extensions or value[x], not both",
            "expression": "extension.exists() != value.exists()",
            "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
            "source": "http://hl7.org/fhir/StructureDefinition/Extension"
          }
        ],
        "isModifier": false,
        "isSummary": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "Extension.url",
        "path": "Extension.url",
        "representation": [
          "xmlAttr"
        ],
        "short": "identifies the meaning of the extension",
        "definition": "Source of the definition for the extension code - a logical name or a URL.",
        "comment": "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": 1,
        "max": "1",
        "base": {
          "path": "Extension.url",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
                "valueUrl": "uri"
              }
            ],
            "code": "http://hl7.org/fhirpath/System.String"
          }
        ],
        "fixedUri": "https://www.spirehealthcare.com/fhir/StructureDefinition/Extension-SpireCore-ValidityPeriod",
        "isModifier": false,
        "isSummary": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      },
      {
        "id": "Extension.value[x]",
        "path": "Extension.value[x]",
        "short": "StartDate / EndDate from the RDS",
        "definition": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
        "min": 1,
        "max": "1",
        "base": {
          "path": "Extension.value[x]",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "Period"
          }
        ],
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() or (children().count() > id.count())",
            "xpath": "@value|f:*|h:div",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          },
          {
            "key": "spire-vp-1",
            "severity": "error",
            "human": "A validity period must carry a start, an end, or both.",
            "expression": "start.exists() or end.exists()",
            "source": "https://www.spirehealthcare.com/fhir/StructureDefinition/Extension-SpireCore-ValidityPeriod"
          }
        ],
        "mustSupport": true,
        "isModifier": false,
        "isSummary": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      },
      {
        "id": "Extension.value[x].id",
        "path": "Extension.value[x].id",
        "representation": [
          "xmlAttr"
        ],
        "short": "Unique id for inter-element referencing",
        "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Element.id",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
                "valueUrl": "string"
              }
            ],
            "code": "http://hl7.org/fhirpath/System.String"
          }
        ],
        "isModifier": false,
        "isSummary": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "Extension.value[x].extension",
        "path": "Extension.value[x].extension",
        "slicing": {
          "discriminator": [
            {
              "type": "value",
              "path": "url"
            }
          ],
          "description": "Extensions are always sliced by (at least) url",
          "rules": "open"
        },
        "short": "Additional content defined by implementations",
        "definition": "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": "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": [
          "extensions",
          "user content"
        ],
        "min": 0,
        "max": "*",
        "base": {
          "path": "Element.extension",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "Extension"
          }
        ],
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() or (children().count() > id.count())",
            "xpath": "@value|f:*|h:div",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          },
          {
            "key": "ext-1",
            "severity": "error",
            "human": "Must have either extensions or value[x], not both",
            "expression": "extension.exists() != value.exists()",
            "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
            "source": "http://hl7.org/fhir/StructureDefinition/Extension"
          }
        ],
        "isModifier": false,
        "isSummary": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "Extension.value[x].start",
        "path": "Extension.value[x].start",
        "short": "RDS StartDate (day precision)",
        "definition": "The start of the period. The boundary is inclusive.",
        "comment": "If the low element is missing, the meaning is that the low boundary is not known.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Period.start",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "dateTime"
          }
        ],
        "condition": [
          "per-1"
        ],
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() or (children().count() > id.count())",
            "xpath": "@value|f:*|h:div",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          }
        ],
        "isModifier": false,
        "isSummary": true,
        "mapping": [
          {
            "identity": "v2",
            "map": "DR.1"
          },
          {
            "identity": "rim",
            "map": "./low"
          }
        ]
      },
      {
        "id": "Extension.value[x].end",
        "path": "Extension.value[x].end",
        "short": "RDS EndDate (day precision); absent while the record is open-ended",
        "definition": "The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.",
        "comment": "The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Period.end",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "dateTime"
          }
        ],
        "meaningWhenMissing": "If the end of the period is missing, it means that the period is ongoing",
        "condition": [
          "per-1"
        ],
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() or (children().count() > id.count())",
            "xpath": "@value|f:*|h:div",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          }
        ],
        "isModifier": false,
        "isSummary": true,
        "mapping": [
          {
            "identity": "v2",
            "map": "DR.2"
          },
          {
            "identity": "rim",
            "map": "./high"
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "Extension",
        "path": "Extension",
        "short": "SpireCore Validity Period",
        "definition": "The period during which a Spire hospital, site or organisation record is valid for use. This carries the RDS StartDate and EndDate columns, which have no home in FHIR R4 because neither Location nor Organization defines a period element. Dates in the RDS are stored at day precision (YYYYMMDD), so populate start and end as dates without a time component. The period is informational: the resource's status (Location) or active flag (Organization) remains the authoritative lifecycle marker, and the RDS load derives it from these dates (active when StartDate is on or before today and EndDate is empty or on or after today). A future-dated start means the record exists but is not yet bookable, which the booking channel must respect."
      },
      {
        "id": "Extension.extension",
        "path": "Extension.extension",
        "max": "0"
      },
      {
        "id": "Extension.url",
        "path": "Extension.url",
        "fixedUri": "https://www.spirehealthcare.com/fhir/StructureDefinition/Extension-SpireCore-ValidityPeriod"
      },
      {
        "id": "Extension.value[x]",
        "path": "Extension.value[x]",
        "short": "StartDate / EndDate from the RDS",
        "min": 1,
        "type": [
          {
            "code": "Period"
          }
        ],
        "constraint": [
          {
            "key": "spire-vp-1",
            "severity": "error",
            "human": "A validity period must carry a start, an end, or both.",
            "expression": "start.exists() or end.exists()",
            "source": "https://www.spirehealthcare.com/fhir/StructureDefinition/Extension-SpireCore-ValidityPeriod"
          }
        ],
        "mustSupport": true
      },
      {
        "id": "Extension.value[x].start",
        "path": "Extension.value[x].start",
        "short": "RDS StartDate (day precision)"
      },
      {
        "id": "Extension.value[x].end",
        "path": "Extension.value[x].end",
        "short": "RDS EndDate (day precision); absent while the record is open-ended"
      }
    ]
  }
}