ODSAPI-ActivePeriod-1

Canonical_URL	Status
https://fhir.nhs.uk/STU3/StructureDefinition/ODSAPI-ActivePeriod-1	active

HTML View

ODSAPI-ActivePeriod-1 (Period)	C		Period	There are no (further) constraints on this element Element id Period Short description Time range defined by start and end date/time Definition A time period defined by a start and end date and optionally time. Comments This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval\|Duration. Data type Period Conditions The cardinality or value of this element may be affected by these constraints: ele-1 Constraints ele-1: All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` per-1: If present, start SHALL have a lower value than end `start.empty() or end.empty() or (start <= end)` Mappings rim: n/a v2: DR rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
id		0..1	string	There are no (further) constraints on this element Element id Period.id Short description xml:id (or equivalent in JSON) Definition unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Comments Note that FHIR strings may not exceed 1MB in size Data type string Conditions The cardinality or value of this element may be affected by these constraints: ele-1 Constraints ele-1: All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Mappings rim: n/a
extension	C	0..*	Extension	There are no (further) constraints on this element Element id Period.extension Short description Additional Content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments 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. Data type Extension Slicing Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Conditions The cardinality or value of this element may be affected by these constraints: ele-1 Constraints ele-1: All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
dateType	C	1..1	Extension(string)	There are no (further) constraints on this element Element id Period.extension:dateType Short description Optional Extensions Element Alternate names extensions, user content Definition Optional Extension Element - found in all resources. Comments 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. Data type Extension(string) Extension URL https://fhir.nhs.uk/STU3/StructureDefinition/Extension-ODSAPI-DateType-1 Conditions The cardinality or value of this element may be affected by these constraints: ele-1 Constraints ele-1: All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
start	Σ C	1..1	dateTime	There are no (further) constraints on this element Element id Period.start Short description Starting time with inclusive boundary Definition The start of the period. The boundary is inclusive. Comments If the low element is missing, the meaning is that the low boundary is not known. Data type dateTime Conditions The cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints ele-1: All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Mappings rim: n/a v2: DR.1 rim: ./low
end	Σ C	0..1	dateTime	There are no (further) constraints on this element Element id Period.end Short description End time with inclusive boundary, if not ongoing Definition The end of the period. If the end of the period is missing, it means that the period is ongoing. 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. Comments The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03. Meaning when missing If the end of the period is missing, it means that the period is ongoing Data type dateTime Conditions The cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints ele-1: All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Mappings rim: n/a v2: DR.2 rim: ./high

Table View

Period		0..*
Period.id	string	0..1
Period.extension	Extension	0..*
Period.extension:dateType	Extension	1..1
Period.start	dateTime	1..1
Period.end	dateTime	0..1

XML View

<meta>
<lastUpdated value="2018-04-17T11:58:01.01+01:00" />
</meta>
<url value="https://fhir.nhs.uk/STU3/StructureDefinition/ODSAPI-ActivePeriod-1" />
<version value="1.0.0" />
<name value="ODSAPI-ActivePeriod-1" />
<status value="active" />
<date value="2017-06-22T09:52:41.5848904+01:00" />
<publisher value="NHS Digital" />
<contact>
<name value="Interoperability Team" />
<telecom>
<system value="email" />
<value value="interoperabilityteam@nhs.net" />
<use value="work" />
</telecom>
</contact>
<description value="A Period Type extended to carry the date type for an Organization." />
<copyright value="Copyright © 2017 Health and Social Care Information Centre. NHS Digital is the trading name of the Health and Social Care Information Centre." />
<fhirVersion value="3.0.1" />
<kind value="complex-type" />
<abstract value="false" />
<type value="Period" />
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/Period" />
<derivation value="constraint" />
<snapshot>
<element id="Period">
<path value="Period" />
<short value="Time range defined by start and end date/time" />
<definition value="A time period defined by a start and end date and optionally time." />
<comment value="This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration." />
<min value="0" />
<max value="*" />
<base>
<path value="Element" />
<min value="0" />
<max value="*" />
</base>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() | (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
</constraint>
<constraint>
<key value="per-1" />
<severity value="error" />
<human value="If present, start SHALL have a lower value than end" />
<expression value="start.empty() or end.empty() or (start <= end)" />
<xpath value="not(exists(f:start)) or not(exists(f:end)) or (f:start/@value <= f:end/@value)" />
</constraint>
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="v2" />
<map value="DR" />
</mapping>
<mapping>
<identity value="rim" />
<map value="IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]" />
</mapping>
</element>
<element id="Period.id">
<path value="Period.id" />
<representation value="xmlAttr" />
<short value="xml:id (or equivalent in JSON)" />
<definition value="unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." />
<comment value="Note that FHIR strings may not exceed 1MB in size" />
<min value="0" />
<max value="1" />
<base>
<path value="Element.id" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="string" />
</type>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() | (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
</constraint>
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
</element>
<element id="Period.extension">
<path value="Period.extension" />
<slicing>
<discriminator>
<type value="value" />
<path value="url" />
</discriminator>
<description value="Extensions are always sliced by (at least) url" />
<rules value="open" />
</slicing>
<short value="Additional Content defined by implementations" />
<definition value="May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension." />
<comment value="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 value="extensions" />
<alias value="user content" />
<min value="0" />
<max value="*" />
<base>
<path value="Element.extension" />
<min value="0" />
<max value="*" />
</base>
<type>
<code value="Extension" />
</type>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() | (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
</constraint>
<constraint>
<key value="ext-1" />
<severity value="error" />
<human value="Must have either extensions or value[x], not both" />
<expression value="extension.exists() != value.exists()" />
<xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" />
</constraint>
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
<element id="Period.extension:dateType">
<path value="Period.extension" />
<sliceName value="dateType" />
<short value="Optional Extensions Element" />
<definition value="Optional Extension Element - found in all resources." />
<comment value="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 value="extensions" />
<alias value="user content" />
<min value="1" />
<max value="1" />
<base>
<path value="Element.extension" />
<min value="0" />
<max value="*" />
</base>
<type>
<code value="Extension" />
<profile value="https://fhir.nhs.uk/STU3/StructureDefinition/Extension-ODSAPI-DateType-1" />
</type>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() | (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
</constraint>
<constraint>
<key value="ext-1" />
<severity value="error" />
<human value="Must have either extensions or value[x], not both" />
<expression value="extension.exists() != value.exists()" />
<xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" />
</constraint>
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
<element id="Period.start">
<path value="Period.start" />
<short value="Starting time with inclusive boundary" />
<definition value="The start of the period. The boundary is inclusive." />
<comment value="If the low element is missing, the meaning is that the low boundary is not known." />
<min value="1" />
<max value="1" />
<base>
<path value="Period.start" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="dateTime" />
</type>
<condition value="ele-1" />
<condition value="per-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() | (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
</constraint>
<isSummary value="true" />
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="v2" />
<map value="DR.1" />
</mapping>
<mapping>
<identity value="rim" />
<map value="./low" />
</mapping>
</element>
<element id="Period.end">
<path value="Period.end" />
<short value="End time with inclusive boundary, if not ongoing" />
<definition value="The end of the period. If the end of the period is missing, it means that the period is ongoing. 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 value="The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03." />
<min value="0" />
<max value="1" />
<base>
<path value="Period.end" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="dateTime" />
</type>
<meaningWhenMissing value="If the end of the period is missing, it means that the period is ongoing" />
<condition value="ele-1" />
<condition value="per-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() | (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
</constraint>
<isSummary value="true" />
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="v2" />
<map value="DR.2" />
</mapping>
<mapping>
<identity value="rim" />
<map value="./high" />
</mapping>
</element>
</snapshot>
<differential>
<element id="Period.extension">
<path value="Period.extension" />
<slicing>
<discriminator>
<type value="value" />
<path value="url" />
</discriminator>
<rules value="open" />
</slicing>
</element>
<element id="Period.extension:dateType">
<path value="Period.extension" />
<sliceName value="dateType" />
<short value="Optional Extensions Element" />
<type>
<code value="Extension" />
<profile value="https://fhir.nhs.uk/STU3/StructureDefinition/Extension-ODSAPI-DateType-1" />
</type>
</element>
<element id="Period.start">
<path value="Period.start" />
<min value="1" />
</element>
</differential>

</StructureDefinition>

JSON View

{

"resourceType": "StructureDefinition",
"meta": {
"lastUpdated": "2018-04-17T11:58:01.01+01:00"
},
"url": "https://fhir.nhs.uk/STU3/StructureDefinition/ODSAPI-ActivePeriod-1",
"version": "1.0.0",
"name": "ODSAPI-ActivePeriod-1",
"status": "active",
"date": "2017-06-22T09:52:41.5848904+01:00",
"publisher": "NHS Digital",
"contact": [
{
"name": "Interoperability Team",
"telecom": [
{
"system": "email",
"value": "interoperabilityteam@nhs.net",
"use": "work"
}
]
}
],
"description": "A Period Type extended to carry the date type for an Organization.",
"copyright": "Copyright © 2017 Health and Social Care Information Centre. NHS Digital is the trading name of the Health and Social Care Information Centre.",
"fhirVersion": "3.0.1",
"kind": "complex-type",
"abstract": false,
"type": "Period",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Period",
"derivation": "constraint",
"snapshot": {
"element": [
{
"id": "Period",
"path": "Period",
"short": "Time range defined by start and end date/time",
"definition": "A time period defined by a start and end date and optionally time.",
"comment": "This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. \"the patient was an inpatient of the hospital for this time range\") or one value from the range applies (e.g. \"give to the patient between these two times\"). If duration is required, specify the type as Interval|Duration.",
"min": 0,
"max": "*",
"base": {
"path": "Element",
"min": 0,
"max": "*"
},
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div"
},
{
"key": "per-1",
"severity": "error",
"human": "If present, start SHALL have a lower value than end",
"expression": "start.empty() or end.empty() or (start <= end)",
"xpath": "not(exists(f:start)) or not(exists(f:end)) or (f:start/@value <= f:end/@value)"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "DR"
},
{
"identity": "rim",
"map": "IVL<TS>[lowClosed=\"true\" and highClosed=\"true\"] or URG<TS>[lowClosed=\"true\" and highClosed=\"true\"]"
}
]
},
{
"id": "Period.id",
"path": "Period.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"comment": "Note that FHIR strings may not exceed 1MB in size",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Period.extension",
"path": "Period.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. In order 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 is allowed to 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"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div"
},
{
"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')])"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Period.extension:dateType",
"path": "Period.extension",
"sliceName": "dateType",
"short": "Optional Extensions Element",
"definition": "Optional Extension Element - found in all resources.",
"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": 1,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-ODSAPI-DateType-1"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div"
},
{
"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')])"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Period.start",
"path": "Period.start",
"short": "Starting time with inclusive boundary",
"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": 1,
"max": "1",
"base": {
"path": "Period.start",
"min": 0,
"max": "1"
},
"type": [
{
"code": "dateTime"
}
],
"condition": [
"ele-1",
"per-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "DR.1"
},
{
"identity": "rim",
"map": "./low"
}
]
},
{
"id": "Period.end",
"path": "Period.end",
"short": "End time with inclusive boundary, if not ongoing",
"definition": "The end of the period. If the end of the period is missing, it means that the period is ongoing. 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 a 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": [
"ele-1",
"per-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "DR.2"
},
{
"identity": "rim",
"map": "./high"
}
]
}
]
},
"differential": {
"element": [
{
"id": "Period.extension",
"path": "Period.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"rules": "open"
}
},
{
"id": "Period.extension:dateType",
"path": "Period.extension",
"sliceName": "dateType",
"short": "Optional Extensions Element",
"type": [
{
"code": "Extension",
"profile": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-ODSAPI-DateType-1"
}
]
},
{
"id": "Period.start",
"path": "Period.start",
"min": 1
}
]
}

}

---

NHS Digital STU3 FHIR Assets

v1.0.0-pre-release

ODSAPI-ActivePeriod-1

HTML View

Table View

XML View

JSON View