{
"description": "Base StructureDefinition for Period Type",
"_filename": "StructureDefinition-Period.json",
"package_name": "hl7.fhir.r2.core",
"date": "2015-10-24T07:41:03+11:00",
"meta": {
"lastUpdated": "2015-10-24T07:41:03.495+11:00"
},
"publisher": "HL7 FHIR Standard",
"fhirVersion": "1.0.2",
"name": "Period",
"mapping": [ {
"uri": "http://hl7.org/v2",
"name": "HL7 v2",
"identity": "v2"
}, {
"uri": "http://hl7.org/v3",
"name": "RIM",
"identity": "rim"
} ],
"abstract": false,
"type": null,
"experimental": null,
"resourceType": "StructureDefinition",
"title": null,
"package_version": "1.0.2",
"snapshot": {
"element": [ {
"constraint": [ {
"key": "per-1",
"human": "If present, start SHALL have a lower value than end",
"xpath": "not(exists(f:start)) or not(exists(f:end)) or (f:start/@value <= f:end/@value)",
"severity": "error"
} ],
"path": "Period",
"min": 0,
"definition": "A time period defined by a start and end date and optionally time.",
"short": "Time range defined by start and end date/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.",
"mapping": [ {
"map": "DR",
"identity": "v2"
}, {
"map": "IVL[lowClosed=\"true\" and highClosed=\"true\"] or URG[lowClosed=\"true\" and highClosed=\"true\"]",
"identity": "rim"
} ],
"type": [ {
"code": "Element"
} ],
"max": "*",
"isSummary": true
}, {
"max": "1",
"min": 0,
"path": "Period.id",
"type": [ {
"code": "id"
} ],
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"definition": "unique id for the element within a resource (for internal references).",
"representation": [ "xmlAttr" ]
}, {
"path": "Period.extension",
"min": 0,
"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.",
"short": "Additional Content defined by implementations",
"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.",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*"
}, {
"path": "Period.start",
"min": 0,
"definition": "The start of the period. The boundary is inclusive.",
"short": "Starting time with inclusive boundary",
"comments": "If the low element is missing, the meaning is that the low boundary is not known.",
"mapping": [ {
"map": "DR.1",
"identity": "v2"
}, {
"map": "./low",
"identity": "rim"
} ],
"type": [ {
"code": "dateTime"
} ],
"max": "1",
"condition": [ "per-1" ],
"isSummary": true
}, {
"path": "Period.end",
"min": 0,
"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.",
"short": "End time with inclusive boundary, if not ongoing",
"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.",
"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",
"condition": [ "per-1" ],
"isSummary": true
} ]
},
"status": "draft",
"id": "44873395-f7ae-4318-80ac-f50925a7f00b",
"kind": "datatype",
"url": "http://hl7.org/fhir/StructureDefinition/Period",
"base": "http://hl7.org/fhir/StructureDefinition/Element",
"version": null,
"differential": {
"element": [ {
"constraint": [ {
"key": "per-1",
"human": "If present, start SHALL have a lower value than end",
"xpath": "not(exists(f:start)) or not(exists(f:end)) or (f:start/@value <= f:end/@value)",
"severity": "error"
} ],
"path": "Period",
"min": 0,
"definition": "A time period defined by a start and end date and optionally time.",
"short": "Time range defined by start and end date/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.",
"mapping": [ {
"map": "DR",
"identity": "v2"
}, {
"map": "IVL[lowClosed=\"true\" and highClosed=\"true\"] or URG[lowClosed=\"true\" and highClosed=\"true\"]",
"identity": "rim"
} ],
"type": [ {
"code": "Element"
} ],
"max": "*",
"isSummary": true
}, {
"path": "Period.start",
"min": 0,
"definition": "The start of the period. The boundary is inclusive.",
"short": "Starting time with inclusive boundary",
"comments": "If the low element is missing, the meaning is that the low boundary is not known.",
"mapping": [ {
"map": "DR.1",
"identity": "v2"
}, {
"map": "./low",
"identity": "rim"
} ],
"type": [ {
"code": "dateTime"
} ],
"max": "1",
"condition": [ "per-1" ],
"isSummary": true
}, {
"path": "Period.end",
"min": 0,
"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.",
"short": "End time with inclusive boundary, if not ongoing",
"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.",
"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",
"condition": [ "per-1" ],
"isSummary": true
} ]
},
"contact": [ {
"telecom": [ {
"value": "http://hl7.org/fhir",
"system": "other"
} ]
} ]
}