Blue Button 2.0 Implementation Guide

D.4.1.4 StructureDefinition: - Detailed Descriptions

Definitions for the StructureDefinition-bluebutton-dme-suplrnum-extension Profile.

Extension
Definition

Optional Extension Element - found in all resources.

Control1..1 This element is affected by the following invariants: ele-1
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Extension.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control1..1 This element is affected by the following invariants: ele-1
Typestring
Comments

Note that FHIR strings may not exceed 1MB in size

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
Extension.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..* This element is affected by the following invariants: ele-1
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1 This element is affected by the following invariants: ele-1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttps://bluebutton.cms.gov/assets/ig/StructureDefinition-bluebutton-dme-suplrnum-extension
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
Extension.valueIdentifier(valueIdentifier)
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control1..1 This element is affected by the following invariants: ele-1
TypeIdentifier
Comments

A stream of bytes, base64 encoded

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
Extension.valueIdentifier.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..0 This element is affected by the following invariants: ele-1
Typestring
Comments

Note that FHIR strings may not exceed 1MB in size

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
Extension.valueIdentifier.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..* This element is affected by the following invariants: ele-1
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Extension.valueIdentifier.use
Definition

The purpose of this identifier.

Control0..0 This element is affected by the following invariants: ele-1
BindingIdentifies the purpose for this identifier, if known .
The codes SHALL be taken from IdentifierUse
Typecode
Is Modifiertrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
Extension.valueIdentifier.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Control0..0 This element is affected by the following invariants: ele-1
BindingA coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
The codes SHALL be taken from Identifier Type Codes; other codes may be used where these codes are not suitable
TypeCodeableConcept
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage.

Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
Extension.valueIdentifier.type.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1 This element is affected by the following invariants: ele-1
Typestring
Comments

Note that FHIR strings may not exceed 1MB in size

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
Extension.valueIdentifier.type.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..* This element is affected by the following invariants: ele-1
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Extension.valueIdentifier.type.coding
Definition

A reference to a code defined by a terminology system.

Control0..* This element is affected by the following invariants: ele-1
TypeCoding
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
Extension.valueIdentifier.type.coding.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1 This element is affected by the following invariants: ele-1
Typestring
Comments

Note that FHIR strings may not exceed 1MB in size

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
Extension.valueIdentifier.type.coding.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..* This element is affected by the following invariants: ele-1
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Extension.valueIdentifier.type.coding.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Control0..1 This element is affected by the following invariants: ele-1
Typeuri
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
Extension.valueIdentifier.type.coding.version
Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1 This element is affected by the following invariants: ele-1
Typestring
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
Extension.valueIdentifier.type.coding.code
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Control0..1 This element is affected by the following invariants: ele-1
Typecode
Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings may not exceed 1MB in size

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
Extension.valueIdentifier.type.coding.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Control0..1 This element is affected by the following invariants: ele-1
Typestring
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings may not exceed 1MB in size

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
Extension.valueIdentifier.type.coding.userSelected
Definition

Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).

Control0..1 This element is affected by the following invariants: ele-1
Typeboolean
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
Extension.valueIdentifier.type.text
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Control0..1 This element is affected by the following invariants: ele-1
Typestring
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Very often the text is the same as a displayName of one of the codings.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
Extension.valueIdentifier.system
Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Control1..1 This element is affected by the following invariants: ele-1
Typeuri
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

see http://en.wikipedia.org/wiki/Uniformresourceidentifier

Example
General:http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
Extension.valueIdentifier.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Control1..1 This element is affected by the following invariants: ele-1
Typestring
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension.

Example
General:123456
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
Extension.valueIdentifier.period
Definition

Time period during which identifier is/was valid for use.

Control0..0 This element is affected by the following invariants: ele-1
TypePeriod
Comments

This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
per-1: If present, start SHALL have a lower value than end (: start.empty() or end.empty() or (start <= end))
Extension.valueIdentifier.period.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1 This element is affected by the following invariants: ele-1
Typestring
Comments

Note that FHIR strings may not exceed 1MB in size

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
Extension.valueIdentifier.period.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..* This element is affected by the following invariants: ele-1
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Extension.valueIdentifier.period.start
Definition

The start of the period. The boundary is inclusive.

Control0..1 This element is affected by the following invariants: ele-1, per-1
TypedateTime
Comments

If the low element is missing, the meaning is that the low boundary is not known.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
Extension.valueIdentifier.period.end
Definition

The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

Control0..1 This element is affected by the following invariants: ele-1, per-1
TypedateTime
Comments

The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03.

Meaning if MissingIf the end of the period is missing, it means that the period is ongoing
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
Extension.valueIdentifier.assigner
Definition

Organization that issued/manages the identifier.

Control0..0 This element is affected by the following invariants: ele-1
TypeReference(Organization)
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ref-1: SHALL have a contained resource if a local reference is provided (: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids')))
Extension.valueIdentifier.assigner.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1 This element is affected by the following invariants: ele-1
Typestring
Comments

Note that FHIR strings may not exceed 1MB in size

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
Extension.valueIdentifier.assigner.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..* This element is affected by the following invariants: ele-1
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Extension.valueIdentifier.assigner.reference
Definition

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

Control0..1 This element is affected by the following invariants: ele-1, ref-1
Typestring
Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
Extension.valueIdentifier.assigner.identifier
Definition

An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

NoteThis is a business identifer, not a resource identifier (see discussion)
Control0..1 This element is affected by the following invariants: ele-1
TypeIdentifier
Comments

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
Extension.valueIdentifier.assigner.display
Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Control0..1 This element is affected by the following invariants: ele-1
Typestring
Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))