{
"description": "When the artifact is expected to be used.",
"_filename": "StructureDefinition-artifact-effectivePeriod.json",
"package_name": "hl7.fhir.uv.extensions.r3",
"date": "2023-01-09T13:31:32-07:00",
"derivation": "constraint",
"publisher": "HL7 International / Clinical Decision Support",
"fhirVersion": "3.0.2",
"jurisdiction": [ {
"coding": [ {
"code": "001",
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm"
} ]
} ],
"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).",
"name": "ArtifactEffectivePeriod",
"mapping": [ {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
} ],
"abstract": false,
"type": "Extension",
"experimental": "false",
"resourceType": "StructureDefinition",
"title": "Artifact Effective Period",
"package_version": "5.3.0-ballot",
"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": "draft"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
"valueCode": "can-bind"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status-reason",
"valueCode": "Extensions that have been modified for R3 are still draft while real-world experience is collected"
} ],
"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() | (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",
"min": 0,
"definition": "The period during which the artifact content was or is planned to be in active use.",
"short": "When the artifact is expected to be used",
"max": "1",
"id": "Extension",
"condition": [ "ele-1" ],
"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.",
"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.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Extension.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Extension.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",
"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.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"
}
}, {
"path": "Extension.url",
"min": 1,
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"short": "identifies the meaning of the extension",
"fixedUri": "http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "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"
}
}, {
"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,
"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).",
"short": "Value of extension",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Period"
} ],
"max": "1",
"id": "Extension.value[x]",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
} ]
},
"status": "active",
"id": "f5ccd50f-26d8-4e95-bb7f-92fe73d41a33",
"kind": "complex-type",
"url": "http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod",
"identifier": [ {
"value": "urn:oid:2.16.840.1.113883.4.642.5.1737",
"system": "urn:ietf:rfc:3986"
} ],
"context": [ "Basic", "CapabilityStatement", "Basic", "CodeSystem", "CompartmentDefinition", "Basic", "ConceptMap", "Basic", "Basic", "GraphDefinition", "Group", "ImplementationGuide", "Medication", "Basic", "MessageDefinition", "NamingSystem", "Basic", "OperationDefinition", "SearchParameter", "Basic", "Substance", "Basic", "Basic", "StructureDefinition", "StructureMap", "Basic", "TestScript", "ValueSet" ],
"version": "5.3.0-ballot",
"differential": {
"element": [ {
"id": "Extension",
"max": "1",
"min": 0,
"path": "Extension",
"short": "When the artifact is expected to be used",
"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.",
"definition": "The period during which the artifact content was or is planned to be in active use."
}, {
"id": "Extension.url",
"path": "Extension.url",
"type": [ {
"code": "uri"
} ],
"fixedUri": "http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod"
}, {
"id": "Extension.value[x]",
"min": 1,
"path": "Extension.value[x]",
"type": [ {
"code": "Period"
} ],
"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."
} ]
},
"contact": [ {
"telecom": [ {
"value": "http://www.hl7.org/Special/committees/dss",
"system": "url"
} ]
} ],
"contextType": "resource",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension"
}