| Package | hl7.fhir.uv.extensions |
| Resource Type | StructureDefinition |
| Id | artifact-effectivePeriod |
| FHIR Version | R5 |
| Source | http://hl7.org/fhir/extensions/https://build.fhir.org/ig/HL7/fhir-extensions/StructureDefinition-artifact-effectivePeriod.html |
| URL | http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod |
| Version | 5.3.0-ballot |
| Status | active |
| Date | 2023-01-09T13:31:32-07:00 |
| Name | ArtifactEffectivePeriod |
| Title | Artifact Effective Period |
| Realm | uv |
| Authority | hl7 |
| Description | When the artifact is expected to be used. |
| Purpose | To provide an effective period for an artifact when the artifact is represented using a FHIR resource that does not declare the effectivePeriod element. For resources where this element was added in R5, the cross-version extension should be used rather than this extension (CodeSystem,ConceptMap,NamingSystem,ObservationDefinition,SpecimenDefinition,SubscriptionTopic,ValueSet). |
| Type | Extension |
| Kind | complex-type |
No resources found
No resources found
| Resource | Version |
|---|---|
| Composition/179699 | R5 |
| ImplementationGuide/publishable-example | R4 |
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition artifact-effectivePeriod
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Extension | 0..1 | Extension | When the artifact is expected to be used | |
  url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod" | |
  value[x] | 1..1 | Period | Value of extension | |
| Documentation for this format | ||||
FHIR{
"resourceType": "StructureDefinition",
"id": "artifact-effectivePeriod",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 1
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "cds"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
"valueCode": "can-bind"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod",
"identifier": [
{
"system": "urn:ietf:rfc:3986",
"value": "urn:oid:2.16.840.1.113883.4.642.5.1737"
}
],
"version": "5.3.0-ballot",
"name": "ArtifactEffectivePeriod",
"title": "Artifact Effective Period",
"status": "active",
"experimental": false,
"date": "2023-01-09T13:31:32-07:00",
"publisher": "HL7 International / Clinical Decision Support",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/dss"
}
]
}
],
"description": "When the artifact is expected to be used.",
"jurisdiction": [
{
"coding": [
{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001"
}
]
}
],
"purpose": "To provide an effective period for an artifact when the artifact is represented using a FHIR resource that does not declare the effectivePeriod element. For resources where this element was added in R5, the cross-version extension should be used rather than this extension (CodeSystem,ConceptMap,NamingSystem,ObservationDefinition,SpecimenDefinition,SubscriptionTopic,ValueSet).",
"fhirVersion": "5.0.0",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "complex-type",
"abstract": false,
"context": [
{
"type": "element",
"expression": "CapabilityStatement"
},
{
"type": "element",
"expression": "ClinicalUseDefinition"
},
{
"type": "element",
"expression": "CodeSystem"
},
{
"type": "element",
"expression": "CompartmentDefinition"
},
{
"type": "element",
"expression": "ConditionDefinition"
},
{
"type": "element",
"expression": "ConceptMap"
},
{
"type": "element",
"expression": "DeviceDefinition"
},
{
"type": "element",
"expression": "ExampleScenario"
},
{
"type": "element",
"expression": "GraphDefinition"
},
{
"type": "element",
"expression": "Group"
},
{
"type": "element",
"expression": "ImplementationGuide"
},
{
"type": "element",
"expression": "Medication"
},
{
"type": "element",
"expression": "MedicationKnowledge"
},
{
"type": "element",
"expression": "MessageDefinition"
},
{
"type": "element",
"expression": "NamingSystem"
},
{
"type": "element",
"expression": "ObservationDefinition"
},
{
"type": "element",
"expression": "OperationDefinition"
},
{
"type": "element",
"expression": "SearchParameter"
},
{
"type": "element",
"expression": "SpecimenDefinition"
},
{
"type": "element",
"expression": "Substance"
},
{
"type": "element",
"expression": "SubstanceDefinition"
},
{
"type": "element",
"expression": "SubscriptionTopic"
},
{
"type": "element",
"expression": "StructureDefinition"
},
{
"type": "element",
"expression": "StructureMap"
},
{
"type": "element",
"expression": "TerminologyCapabilities"
},
{
"type": "element",
"expression": "ValueSet"
}
],
"type": "Extension",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
"derivation": "constraint",
"snapshot": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "5.0.0"
}
],
"element": [
{
"id": "Extension",
"path": "Extension",
"short": "When the artifact is expected to be used",
"definition": "The period during which the artifact content was or is planned to be in active use.",
"comment": "The effective period for an artifact determines when the content is applicable for usage and is independent of publication and review dates. For example, an artifact intended to be used for the year 2016 might be published in 2015.",
"min": 0,
"max": "1",
"base": {
"path": "Extension",
"min": 0,
"max": "*"
},
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"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()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false
},
{
"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": "id"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"condition": [
"ele-1"
],
"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 managable, 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())",
"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()",
"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": [
{
"code": "uri"
}
],
"fixedUri": "http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod",
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension.value[x]",
"path": "Extension.value[x]",
"short": "Value of extension",
"definition": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R5/extensibility.html) for a list).",
"requirements": "Allows establishing a transition before an artifact comes into effect and also allows for a sunsetting process when new versions of the artifact are or are expected to be used instead.",
"min": 1,
"max": "1",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Period"
}
],
"condition": [
"ext-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
]
},
"differential": {
"element": [
{
"id": "Extension",
"path": "Extension",
"short": "When the artifact is expected to be used",
"definition": "The period during which the artifact content was or is planned to be in active use.",
"comment": "The effective period for an artifact determines when the content is applicable for usage and is independent of publication and review dates. For example, an artifact intended to be used for the year 2016 might be published in 2015.",
"min": 0,
"max": "1"
},
{
"id": "Extension.url",
"path": "Extension.url",
"type": [
{
"code": "uri"
}
],
"fixedUri": "http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod"
},
{
"id": "Extension.value[x]",
"path": "Extension.value[x]",
"requirements": "Allows establishing a transition before an artifact comes into effect and also allows for a sunsetting process when new versions of the artifact are or are expected to be used instead.",
"min": 1,
"type": [
{
"code": "Period"
}
]
}
]
}
}