Release 5 Draft Ballot

This page is part of the FHIR Specification (v4.6.0: R5 Draft Ballot). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Extension: activityStatusDate

Vocabulary Work Group

Maturity Level: 1

Informative

Use Context: Any

URL for this extension:

http://hl7.org/fhir/StructureDefinition/valueset-status-activityStatusDate

Status: draft. Extension maintained by: HL7

The date when the associated Value Set Definition Version activity status is in effect.

Comment:

When the Activity Status is set to “Active”, the Activity Status Date defines the Effective Date which is the date-time the Value Set Definition Version becomes active. When the Activity Status is set to “Inactive”, the Activity Status Date is the date-time when the Value Set Definition version becomes Inactive. This cycle may happen multiple times. The specified time is expected to be one second after midnight UTC of the Activity Status Date. The date may be in the future.

It is strongly encouraged that the Activity Status be set such that no more than one Value Set Definition Version for a single Value Set Identifier can have an Activity Status of ACTIVE at the same time within a single realm. In cases where this is not true, evaluation of the alignment of a Value Set Expansion Code Set to a specific Value Set Definition, as referenced in a CD, will be problematic.

Changes to this element should never result in a new Value Set Definition Version.

Context of Use: Use on Element ID ValueSet

Summary

Name	Flags	Card.	Type	Description & Constraints
activityStatusDate		0..1	date	URL = http://hl7.org/fhir/StructureDefinition/valueset-status-activityStatusDate activityStatusDate: The date when the associated Value Set Definition Version activity status is in effect. Use on Element ID ValueSet
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/valueset-status-activityStatusDate activityStatusDate: The date when the associated Value Set Definition Version activity status is in effect. Use on Element ID ValueSet
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/valueset-status-activityStatusDate"
value[x]	1..1	date	Value of extension
Documentation for this format

XML Template

<!-- activityStatusDate -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/valueset-status-activityStatusDate" >
  <!-- from Element: extension -->
 <valueDate value="[date]"/><!--  1..1 Value of extension -->
</extension>

JSON Template

{ // activityStatusDate
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/valueset-status-activityStatusDate", // R! 
    "valueDate" : "<date>" // C? R! Value of extension
  }

Summary

Name	Flags	Card.	Type	Description & Constraints
activityStatusDate		0..1	date	URL = http://hl7.org/fhir/StructureDefinition/valueset-status-activityStatusDate activityStatusDate: The date when the associated Value Set Definition Version activity status is in effect. Use on Element ID ValueSet
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/valueset-status-activityStatusDate activityStatusDate: The date when the associated Value Set Definition Version activity status is in effect. Use on Element ID ValueSet
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/valueset-status-activityStatusDate"
value[x]	1..1	date	Value of extension
Documentation for this format

XML Template

<!-- activityStatusDate -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/valueset-status-activityStatusDate" >
  <!-- from Element: extension -->
 <valueDate value="[date]"/><!--  1..1 Value of extension -->
</extension>

JSON Template

{ // activityStatusDate
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/valueset-status-activityStatusDate", // R! 
    "valueDate" : "<date>" // C? R! Value of extension
  }

Constraints

ele-1: All FHIR elements must have a @value or children (xpath: @value|f:*|h:div)
ext-1: Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]))
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div)
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
ele-1: On Extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.value[x]: @value|f:*|h:div)