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 . Page versions: R4B R4

Extension: applicable-version

FHIR Infrastructure Work Group

Maturity Level: 1

Informative

Use Context: Any

URL for this extension:

http://hl7.org/fhir/StructureDefinition/structuredefinition-applicable-version

Status: draft. Extension maintained by: Health Level Seven, Inc. - [WG Name] WG

An additional version that this profile apples to, other than the version explicitly stated in StructureDefinition.fhirVersion.

Comment:

This is typically only used where derivation = constraint. As the underlying resources become more stable, profiles on one version become applicable to other versions as well. It's possible to calculate automatically with the strutural features of a profile apply to a given version, but just because it's structurally ok doesn't mean that the meaning is correct. This extension allows a positive statement that the profile applies.

Context of Use: Use on Element ID StructureDefinition

Summary

Name	Flags	Card.	Type	Description & Constraints
applicable-version		0..*	code	URL = http://hl7.org/fhir/StructureDefinition/structuredefinition-applicable-version applicable-version: An additional version that this profile apples to, other than the version explicitly stated in StructureDefinition.fhirVersion. Binding: FHIRVersion (required): All published FHIR Versions. Use on Element ID StructureDefinition
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/structuredefinition-applicable-version applicable-version: An additional version that this profile apples to, other than the version explicitly stated in StructureDefinition.fhirVersion. Use on Element ID StructureDefinition
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/structuredefinition-applicable-version"
value[x]	1..1	code	Value of extension Binding: FHIRVersion (required): All published FHIR Versions.
Documentation for this format

XML Template

<!-- applicable-version -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/structuredefinition-applicable-version" >
  <!-- from Element: extension -->
 <valueCode value="[code]"/><!--  1..1 Value of extension -->
</extension>

JSON Template

{ // applicable-version
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-applicable-version", // R! 
    "valueCode" : "<code>" // C? R! Value of extension
  }

Summary

Name	Flags	Card.	Type	Description & Constraints
applicable-version		0..*	code	URL = http://hl7.org/fhir/StructureDefinition/structuredefinition-applicable-version applicable-version: An additional version that this profile apples to, other than the version explicitly stated in StructureDefinition.fhirVersion. Binding: FHIRVersion (required): All published FHIR Versions. Use on Element ID StructureDefinition
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/structuredefinition-applicable-version applicable-version: An additional version that this profile apples to, other than the version explicitly stated in StructureDefinition.fhirVersion. Use on Element ID StructureDefinition
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/structuredefinition-applicable-version"
value[x]	1..1	code	Value of extension Binding: FHIRVersion (required): All published FHIR Versions.
Documentation for this format

XML Template

<!-- applicable-version -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/structuredefinition-applicable-version" >
  <!-- from Element: extension -->
 <valueCode value="[code]"/><!--  1..1 Value of extension -->
</extension>

JSON Template

{ // applicable-version
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-applicable-version", // R! 
    "valueCode" : "<code>" // 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)