STU3 Candidate

This page is part of the FHIR Specification (v1.8.0: STU 3 Draft). 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: An additional example value

(No assigned work group)

Maturity Level: 0

Context: Any

URL for this extension:

http://hl7.org/fhir/StructureDefinition/structuredefinition-example

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

An additional example value.

Context of Use: Use on data type: ElementDefinition

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

Summary

Name	Card.	Type	Description & Constraints
extension	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/structuredefinition-example An additional example value: An additional example value. Use on data type: ElementDefinition
index	1..1	string	Key for this example.
exValue	0..1	base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, Meta	Value of the example.
Documentation for this format

Fulle Structure

Name	Card.	Type	Description & Constraints
extension	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/structuredefinition-example An additional example value: An additional example value. Use on data type: ElementDefinition
extension	1..1	Extension	Key for this example
extension	0..0
url	1..1	uri	"index"
valueString	1..1	string	Value of extension
extension	0..1	Extension	Value of the example
extension	0..0
url	1..1	uri	"exValue"
value[x]	1..1	base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, Meta	Value of extension
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/structuredefinition-example"
valueString	0..1	string	Value of extension
Documentation for this format

XML Template

<!-- An additional example value -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/structuredefinition-example" >
 <-- extension sliced by url  in the specified orderOpen-->
 <extension url="index"> 1..1 Extension  <!-- 1..1 Key for this example -->
  <valueString value="[string]"/><!-- 1..1 Value of extension -->
 </extension>
 <extension url="exValue"> 0..1 Extension  <!-- 0..1 Value of the example -->
  <value[x]><!-- 1..1 base64Binary|boolean|code|date|
    dateTime|decimal|id|instant|integer|markdown|oid|positiveInt|string|time|
    unsignedInt|uri|Address|Age|Annotation|Attachment|CodeableConcept|Coding|
    ContactPoint|Count|Distance|Duration|HumanName|Identifier|Money|Period|
    Quantity|Range|Ratio|Reference|SampledData|Signature|Timing|Meta 
      Value of extension --></value[x]>
 </extension>
 <valueString value="[string]"/><!-- 0..1 Value of extension -->
</extension>

JSON Template

{ // An additional example value
    "extension" : [ //  sliced by url  in the specified orderOpen
      { // Key for this example // R! 
        // from Element: extension
        "url" : "index", // R! 
        "valueString" : "<string>" // R! Value of extension
      },
      { // Value of the example //
        // from Element: extension
        "url" : "exValue", // R! 
// value[x]: Value of extension. One of these 38:
        "valueBase64Binary" : "<base64Binary>" // R! Value of extension
        "valueBoolean" : <boolean>, // R! Value of extension
        "valueCode" : "<code>", // R! Value of extension
        "valueDate" : "<date>", // R! Value of extension
        "valueDateTime" : "<dateTime>", // R! Value of extension
        "valueDecimal" : <decimal>, // R! Value of extension
        "valueId" : "<id>", // R! Value of extension
        "valueInstant" : "<instant>", // R! Value of extension
        "valueInteger" : <integer>, // R! Value of extension
        "valueMarkdown" : "<markdown>", // R! Value of extension
        "valueOid" : "<oid>", // R! Value of extension
        "valuePositiveInt" : "<positiveInt>", // R! Value of extension
        "valueString" : "<string>", // R! Value of extension
        "valueTime" : "<time>", // R! Value of extension
        "valueUnsignedInt" : "<unsignedInt>", // R! Value of extension
        "valueUri" : "<uri>", // R! Value of extension
        "valueAddress" : { Address }, // R! Value of extension
        "valueAge" : { Age }, // R! Value of extension
        "valueAnnotation" : { Annotation }, // R! Value of extension
        "valueAttachment" : { Attachment }, // R! Value of extension
        "valueCodeableConcept" : { CodeableConcept }, // R! Value of extension
        "valueCoding" : { Coding }, // R! Value of extension
        "valueContactPoint" : { ContactPoint }, // R! Value of extension
        "valueCount" : { Count }, // R! Value of extension
        "valueDistance" : { Distance }, // R! Value of extension
        "valueDuration" : { Duration }, // R! Value of extension
        "valueHumanName" : { HumanName }, // R! Value of extension
        "valueIdentifier" : { Identifier }, // R! Value of extension
        "valueMoney" : { Money }, // R! Value of extension
        "valuePeriod" : { Period }, // R! Value of extension
        "valueQuantity" : { Quantity }, // R! Value of extension
        "valueRange" : { Range }, // R! Value of extension
        "valueRatio" : { Ratio }, // R! Value of extension
        "valueReference" : { Reference }, // R! Value of extension
        "valueSampledData" : { SampledData }, // R! Value of extension
        "valueSignature" : { Signature }, // R! Value of extension
        "valueTiming" : { Timing }, // R! Value of extension
        "valueMeta" : { Meta }, // R! Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-example", // R! 
    "valueString" : "<string>", //Value of extension
  }

Summary

Name	Card.	Type	Description & Constraints
extension	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/structuredefinition-example An additional example value: An additional example value. Use on data type: ElementDefinition
index	1..1	string	Key for this example.
exValue	0..1	base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, Meta	Value of the example.
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/structuredefinition-example An additional example value: An additional example value. Use on data type: ElementDefinition
extension	1..1	Extension	Key for this example
extension	0..0
url	1..1	uri	"index"
valueString	1..1	string	Value of extension
extension	0..1	Extension	Value of the example
extension	0..0
url	1..1	uri	"exValue"
value[x]	1..1	base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, Meta	Value of extension
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/structuredefinition-example"
valueString	0..1	string	Value of extension
Documentation for this format

XML Template

<!-- An additional example value -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/structuredefinition-example" >
 <-- extension sliced by url  in the specified orderOpen-->
 <extension url="index"> 1..1 Extension  <!-- 1..1 Key for this example -->
  <valueString value="[string]"/><!-- 1..1 Value of extension -->
 </extension>
 <extension url="exValue"> 0..1 Extension  <!-- 0..1 Value of the example -->
  <value[x]><!-- 1..1 base64Binary|boolean|code|date|
    dateTime|decimal|id|instant|integer|markdown|oid|positiveInt|string|time|
    unsignedInt|uri|Address|Age|Annotation|Attachment|CodeableConcept|Coding|
    ContactPoint|Count|Distance|Duration|HumanName|Identifier|Money|Period|
    Quantity|Range|Ratio|Reference|SampledData|Signature|Timing|Meta 
      Value of extension --></value[x]>
 </extension>
 <valueString value="[string]"/><!-- 0..1 Value of extension -->
</extension>

JSON Template

{ // An additional example value
    "extension" : [ //  sliced by url  in the specified orderOpen
      { // Key for this example // R! 
        // from Element: extension
        "url" : "index", // R! 
        "valueString" : "<string>" // R! Value of extension
      },
      { // Value of the example //
        // from Element: extension
        "url" : "exValue", // R! 
// value[x]: Value of extension. One of these 38:
        "valueBase64Binary" : "<base64Binary>" // R! Value of extension
        "valueBoolean" : <boolean>, // R! Value of extension
        "valueCode" : "<code>", // R! Value of extension
        "valueDate" : "<date>", // R! Value of extension
        "valueDateTime" : "<dateTime>", // R! Value of extension
        "valueDecimal" : <decimal>, // R! Value of extension
        "valueId" : "<id>", // R! Value of extension
        "valueInstant" : "<instant>", // R! Value of extension
        "valueInteger" : <integer>, // R! Value of extension
        "valueMarkdown" : "<markdown>", // R! Value of extension
        "valueOid" : "<oid>", // R! Value of extension
        "valuePositiveInt" : "<positiveInt>", // R! Value of extension
        "valueString" : "<string>", // R! Value of extension
        "valueTime" : "<time>", // R! Value of extension
        "valueUnsignedInt" : "<unsignedInt>", // R! Value of extension
        "valueUri" : "<uri>", // R! Value of extension
        "valueAddress" : { Address }, // R! Value of extension
        "valueAge" : { Age }, // R! Value of extension
        "valueAnnotation" : { Annotation }, // R! Value of extension
        "valueAttachment" : { Attachment }, // R! Value of extension
        "valueCodeableConcept" : { CodeableConcept }, // R! Value of extension
        "valueCoding" : { Coding }, // R! Value of extension
        "valueContactPoint" : { ContactPoint }, // R! Value of extension
        "valueCount" : { Count }, // R! Value of extension
        "valueDistance" : { Distance }, // R! Value of extension
        "valueDuration" : { Duration }, // R! Value of extension
        "valueHumanName" : { HumanName }, // R! Value of extension
        "valueIdentifier" : { Identifier }, // R! Value of extension
        "valueMoney" : { Money }, // R! Value of extension
        "valuePeriod" : { Period }, // R! Value of extension
        "valueQuantity" : { Quantity }, // R! Value of extension
        "valueRange" : { Range }, // R! Value of extension
        "valueRatio" : { Ratio }, // R! Value of extension
        "valueReference" : { Reference }, // R! Value of extension
        "valueSampledData" : { SampledData }, // R! Value of extension
        "valueSignature" : { Signature }, // R! Value of extension
        "valueTiming" : { Timing }, // R! Value of extension
        "valueMeta" : { Meta }, // R! Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-example", // R! 
    "valueString" : "<string>", //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')]))