2nd DSTU Draft For Comment

This page is part of the FHIR Specification (v0.4.0: DSTU 2 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 . Page versions: R5 R4B R4 R3 R2

Element-definition Extensions for use by FHIR Implementers (Conformance Package)

Scope and Usage

This profile defines extensions that can be used to describe the additional characteristics that must be held by a data element.

Data elements can be defined in several places. The extensions defined within this profile may apply to most or all of these:

  • DataElement - defining the characteristics that must hold for an element to be an instance of a particular Data Element
  • Profile.structure.element.definition - defining the characteristics of the data element when used according to the profile
  • Profile.extensionDefn.definition - defining the characteristics of the extension, regardless of where it is used
  • Questionnaire.group.question - defining the characteristics of permitted answers

Note: Implementations are not required to reject invalid data. However, transmitting data that violates one of these extensions would be considered invalid against the resource that declared the extension.

The extensions provided here fall into several categories:

Extensions:
minLengthAt least this many characters :

The minimum number of characters that must be present in the simple data type to be considered a "valid" instance.

maxLengthNo more than this many characters :

The maximum number of characters that must be present in the simple data type to be considered a "valid" instance.

regexRegular expression pattern :

A regular expression that defines the syntax for the data element to be considered valid.

entryFormatUser prompt for format :

A syntax intended for display to the user to guide their input (i.e. a human readable version of a regular expression). For example "nnn-nnn-nnn".

minValueMust be >= this value :

The inclusive lower bound on the range of allowed values for the data element.

maxValueMust be <= this value :

The inclusive upper bound on the range of allowed values for the data element.

maxDecimalPlacesMaximum digits after decimal :

Identifies the maximum number of decimal places that may be specified for the data element.

mimeTypeType of attachment :

Identifies the kind(s) of attacj,emt allowed to be sent for an element.

maxSizeMax size in MB :

For attachment answers, indicates the maximum size an attachment can be.

identifierExternal Identifier associated with this element :

External Identifiers associated with this element - these are identifiers that are associated with the concept this element represents.