This page is part of the FHIR Specification (v1.8.0: STU 3 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
. Page versions: R4B R4 R3
The effective date range for the resource
{
"resourceType": "StructureDefinition",
"id": "resource-effectivePeriod",
"url": "http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod",
"name": "The effective date range for the resource",
"title": "Effective Period",
"status": "draft",
"publisher": "HL7",
"date": "2016-12-06T12:22:34+11:00",
"description": "The period during which the resource content was or is planned to be effective.",
"fhirVersion": "1.8.0",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "complex-type",
"abstract": false,
"contextType": "resource",
"context": [
"StructureDefinition",
"StructureMap",
"DataElement",
"CapabilityStatement",
"OperationDefinition",
"SearchParameter",
"CompartmentDefinition",
"ImplementationGuide",
"CodeSystem",
"ValueSet",
"ConceptMap",
"ExpansionProfile",
"NamingSystem"
],
"type": "Extension",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
"derivation": "constraint",
"snapshot": {
"element": [
{
"id": "Extension:theeffectivedaterangefortheresource",
"path": "Extension",
"short": "The effective date range for the resource",
"definition": "The period during which the resource content was or is planned to be effective.",
"comments": "The effective period for a resource determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 would be published in 2015.",
"min": 0,
"max": "1",
"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": "children().count() > id.count()",
"xpath": "@value|f:*|h:div",
"source": "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": "Extension"
}
]
},
{
"id": "Extension:theeffectivedaterangefortheresource.id",
"path": "Extension.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.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Extension:theeffectivedaterangefortheresource.extension:extension",
"path": "Extension.extension",
"sliceName": "extension",
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "0",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "Extension:theeffectivedaterangefortheresource.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.",
"comments": "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": [
{
"code": "uri"
}
],
"fixedUri": "http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod",
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension:theeffectivedaterangefortheresource.valuePeriod",
"path": "Extension.valuePeriod",
"short": "Value of extension",
"definition": "Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).",
"min": 1,
"max": "1",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Period"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
]
},
"differential": {
"element": [
{
"id": "Extension:theeffectivedaterangefortheresource",
"path": "Extension",
"short": "The effective date range for the resource",
"definition": "The period during which the resource content was or is planned to be effective.",
"comments": "The effective period for a resource determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 would be published in 2015.",
"min": 0,
"max": "1"
},
{
"id": "Extension:theeffectivedaterangefortheresource.extension:extension",
"path": "Extension.extension",
"sliceName": "extension",
"max": "0"
},
{
"id": "Extension:theeffectivedaterangefortheresource.url",
"path": "Extension.url",
"type": [
{
"code": "uri"
}
],
"fixedUri": "http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod"
},
{
"id": "Extension:theeffectivedaterangefortheresource.value[x]",
"path": "Extension.value[x]",
"min": 1,
"type": [
{
"code": "Period"
}
]
}
]
}
}
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.