FHIR Release 3 (STU)

This page is part of the FHIR Specification (v3.0.2: STU 3). 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: R3 R2

Extension: validityPeriod

Pharmacy Work Group Maturity Level: 1InformativeUse Context: Any

URL for this extension: 

http://hl7.org/fhir/StructureDefinition/medicationdispense-validityPeriod

Status: draft. Extension maintained by: Health Level Seven, Inc. - FHIR WG

The time interval when the medication must be administered. The start and end times must be expressed as dateTimes, not times relative to the dispensing time (e.g. use within 24 hours).

Context of Use: Use on element: MedicationDispense

usage info: insert a list of places where this extension is used

Extension Content

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1PeriodURL = http://hl7.org/fhir/StructureDefinition/medicationdispense-validityPeriod
validityPeriod: The time interval when the medication must be administered. The start and end times must be expressed as dateTimes, not times relative to the dispensing time (e.g. use within 24 hours).
Use on element: MedicationDispense

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/medicationdispense-validityPeriod
validityPeriod: The time interval when the medication must be administered. The start and end times must be expressed as dateTimes, not times relative to the dispensing time (e.g. use within 24 hours).
Use on element: MedicationDispense
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/medicationdispense-validityPeriod"
... valuePeriod 0..1PeriodValue of extension

doco Documentation for this format

XML Template

<!-- validityPeriod -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/medicationdispense-validityPeriod" >
  <!-- from Element: extension -->
 <valuePeriod><!-- 0..1 Period Value of extension --></valuePeriod>
</extension>

JSON Template

{ // validityPeriod
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified orderOpen
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/medicationdispense-validityPeriod", // R! 
    "valuePeriod" : { Period } //Value of extension
  }

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1PeriodURL = http://hl7.org/fhir/StructureDefinition/medicationdispense-validityPeriod
validityPeriod: The time interval when the medication must be administered. The start and end times must be expressed as dateTimes, not times relative to the dispensing time (e.g. use within 24 hours).
Use on element: MedicationDispense

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/medicationdispense-validityPeriod
validityPeriod: The time interval when the medication must be administered. The start and end times must be expressed as dateTimes, not times relative to the dispensing time (e.g. use within 24 hours).
Use on element: MedicationDispense
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/medicationdispense-validityPeriod"
... valuePeriod 0..1PeriodValue of extension

doco Documentation for this format

XML Template

<!-- validityPeriod -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/medicationdispense-validityPeriod" >
  <!-- from Element: extension -->
 <valuePeriod><!-- 0..1 Period Value of extension --></valuePeriod>
</extension>

JSON Template

{ // validityPeriod
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified orderOpen
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/medicationdispense-validityPeriod", // R! 
    "valuePeriod" : { Period } //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')]))