{
"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.",
"_filename": "StructureDefinition-Extension-SpireCore-ValidityPeriod.json",
"package_name": "spire-healthcare.prod",
"date": null,
"derivation": "constraint",
"meta": {
"lastUpdated": "2026-10-06T20:47:47.897+00:00"
},
"publisher": "Spire Healthcare",
"fhirVersion": "4.0.1",
"jurisdiction": [ {
"coding": [ {
"code": "GB",
"system": "urn:iso:std:iso:3166"
} ]
} ],
"purpose": "Carry RDS StartDate and EndDate for Location and Organization records without overloading status or active.",
"name": "SpireCoreValidityPeriod",
"mapping": [ {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
} ],
"abstract": false,
"type": "Extension",
"experimental": null,
"resourceType": "StructureDefinition",
"title": "SpireCore Validity Period",
"package_version": "1.3.0-beta",
"snapshot": {
"element": [ {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Extension",
"min": 0,
"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.",
"isModifier": false,
"short": "SpireCore Validity Period",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"max": "*",
"id": "Extension",
"condition": [ "ele-1" ],
"base": {
"max": "*",
"min": 0,
"path": "Extension"
}
}, {
"path": "Extension.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Extension.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Extension.extension",
"min": 0,
"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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "0",
"id": "Extension.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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"path": "Extension.url",
"min": 1,
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"isModifier": false,
"short": "identifies the meaning of the extension",
"fixedUri": "https://www.spirehealthcare.com/fhir/StructureDefinition/Extension-SpireCore-ValidityPeriod",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "uri"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Extension.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.",
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "spire-vp-1",
"human": "A validity period must carry a start, an end, or both.",
"source": "https://www.spirehealthcare.com/fhir/StructureDefinition/Extension-SpireCore-ValidityPeriod",
"severity": "error",
"expression": "start.exists() or end.exists()"
} ],
"path": "Extension.value[x]",
"min": 1,
"definition": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
"isModifier": false,
"short": "StartDate / EndDate from the RDS",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Period"
} ],
"mustSupport": true,
"max": "1",
"id": "Extension.value[x]",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
},
"isSummary": false
}, {
"path": "Extension.value[x].id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Extension.value[x].id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Extension.value[x].extension",
"min": 0,
"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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Extension.value[x].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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Extension.value[x].start",
"min": 0,
"definition": "The start of the period. The boundary is inclusive.",
"isModifier": false,
"short": "RDS StartDate (day precision)",
"mapping": [ {
"map": "DR.1",
"identity": "v2"
}, {
"map": "./low",
"identity": "rim"
} ],
"type": [ {
"code": "dateTime"
} ],
"max": "1",
"id": "Extension.value[x].start",
"condition": [ "per-1" ],
"comment": "If the low element is missing, the meaning is that the low boundary is not known.",
"base": {
"max": "1",
"min": 0,
"path": "Period.start"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Extension.value[x].end",
"min": 0,
"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.",
"isModifier": false,
"short": "RDS EndDate (day precision); absent while the record is open-ended",
"mapping": [ {
"map": "DR.2",
"identity": "v2"
}, {
"map": "./high",
"identity": "rim"
} ],
"type": [ {
"code": "dateTime"
} ],
"meaningWhenMissing": "If the end of the period is missing, it means that the period is ongoing",
"max": "1",
"id": "Extension.value[x].end",
"condition": [ "per-1" ],
"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.",
"base": {
"max": "1",
"min": 0,
"path": "Period.end"
},
"isSummary": true
} ]
},
"status": "draft",
"id": "5b6dedf5-5cfa-4587-b37a-70d8e7aa5078",
"kind": "complex-type",
"url": "https://www.spirehealthcare.com/fhir/StructureDefinition/Extension-SpireCore-ValidityPeriod",
"context": [ {
"type": "element",
"expression": "Location"
}, {
"type": "element",
"expression": "Organization"
} ],
"version": "0.1.0",
"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",
"max": "0",
"path": "Extension.extension"
}, {
"id": "Extension.url",
"path": "Extension.url",
"fixedUri": "https://www.spirehealthcare.com/fhir/StructureDefinition/Extension-SpireCore-ValidityPeriod"
}, {
"id": "Extension.value[x]",
"min": 1,
"path": "Extension.value[x]",
"type": [ {
"code": "Period"
} ],
"short": "StartDate / EndDate from the RDS",
"constraint": [ {
"key": "spire-vp-1",
"human": "A validity period must carry a start, an end, or both.",
"source": "https://www.spirehealthcare.com/fhir/StructureDefinition/Extension-SpireCore-ValidityPeriod",
"severity": "error",
"expression": "start.exists() or end.exists()"
} ],
"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"
} ]
},
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension"
}