Extensions for Using Data Elements from FHIR R5 in FHIR R4
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR R5 in FHIR R4 - Downloaded Version null See the Directory of published versions

Extension: ExtensionDeviceUsage_Status - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 0

Definitions for the ext-R5-DeviceUsage.status extension.

Guidance on how to interpret the contents of this table can be foundhere

0. Extension
Definition

R5: DeviceUsage.status


Optional Extension Element - found in all resources.

ShortR5: active | completed | not-done | entered-in-error +Optional Extensions Element
Comments

Element DeviceUsage.status is mapped to FHIR R4 element DeviceUseStatement.status as SourceIsBroaderThanTarget. The target context DeviceUseStatement.status is a modifier element, so this extension does not need to be defined as a modifier. DeviceUseStatment is a statement at a point in time. The status is only representative at the point when it was asserted. The value set for contains codes that assert the status of the use by the patient (for example, stopped or on hold) as well as codes that assert the status of the resource itself (for example, entered in error).

This element is labeled as a modifier because the status contains the codes that mark the statement as not currently valid.

Control10..1*
This element is affected by the following invariants: ele-1
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2. Extension.url
Definition

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

Shortidentifies the meaning of the extension
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.

Control1..1
Typeuri
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Valuehttp://hl7.org/fhir/5.0/StructureDefinition/extension-DeviceUsage.status
4. Extension.value[x]
Definition

A code representing the patient or other source's judgment about the state of the device used that this statement is about. Generally this will be active or completed.


Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Shortactive | completed | not-done | entered-in-error +Value of extension
Comments

DeviceUseStatment is a statement at a point in time. The status is only representative at the point when it was asserted. The value set for contains codes that assert the status of the use by the patient (for example, stopped or on hold) as well as codes that assert the status of the resource itself (for example, entered in error).

This element is labeled as a modifier because the status contains the codes that mark the statement as not currently valid.

Control10..1
BindingThe codes SHALL be taken from For codes, see R5DeviceusageStatusForR4DeviceStatementStatus (0.1.0)
(required to http://hl7.org/fhir/uv/xver/ValueSet/R5-deviceusage-status-for-R4-device-statement-status|0.1.0)

A coded concept indicating the current status of the Device Usage.

Typecode, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be foundhere

0. Extension
Definition

R5: DeviceUsage.status

ShortR5: active | completed | not-done | entered-in-error +
Comments

Element DeviceUsage.status is mapped to FHIR R4 element DeviceUseStatement.status as SourceIsBroaderThanTarget. The target context DeviceUseStatement.status is a modifier element, so this extension does not need to be defined as a modifier. DeviceUseStatment is a statement at a point in time. The status is only representative at the point when it was asserted. The value set for contains codes that assert the status of the use by the patient (for example, stopped or on hold) as well as codes that assert the status of the resource itself (for example, entered in error).

This element is labeled as a modifier because the status contains the codes that mark the statement as not currently valid.

Control1..1
Is Modifierfalse
2. Extension.url
Control1..1
Fixed Valuehttp://hl7.org/fhir/5.0/StructureDefinition/extension-DeviceUsage.status
4. Extension.value[x]
Definition

A code representing the patient or other source's judgment about the state of the device used that this statement is about. Generally this will be active or completed.

Shortactive | completed | not-done | entered-in-error +
Comments

DeviceUseStatment is a statement at a point in time. The status is only representative at the point when it was asserted. The value set for contains codes that assert the status of the use by the patient (for example, stopped or on hold) as well as codes that assert the status of the resource itself (for example, entered in error).

This element is labeled as a modifier because the status contains the codes that mark the statement as not currently valid.

Control1..1
BindingThe codes SHALL be taken from R5DeviceusageStatusForR4DeviceStatementStatus (0.1.0)
(required to http://hl7.org/fhir/uv/xver/ValueSet/R5-deviceusage-status-for-R4-device-statement-status|0.1.0)

A coded concept indicating the current status of the Device Usage.

Typecode, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

Guidance on how to interpret the contents of this table can be foundhere

0. Extension
Definition

R5: DeviceUsage.status

ShortR5: active | completed | not-done | entered-in-error +
Comments

Element DeviceUsage.status is mapped to FHIR R4 element DeviceUseStatement.status as SourceIsBroaderThanTarget. The target context DeviceUseStatement.status is a modifier element, so this extension does not need to be defined as a modifier. DeviceUseStatment is a statement at a point in time. The status is only representative at the point when it was asserted. The value set for contains codes that assert the status of the use by the patient (for example, stopped or on hold) as well as codes that assert the status of the resource itself (for example, entered in error).

This element is labeled as a modifier because the status contains the codes that mark the statement as not currently valid.

Control1..1
This element is affected by the following invariants: ele-1
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2. 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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
4. Extension.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
    • 6. Extension.url
    Definition

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

    Shortidentifies the meaning of the extension
    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.

    Control1..1
    Typeuri
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    Fixed Valuehttp://hl7.org/fhir/5.0/StructureDefinition/extension-DeviceUsage.status
    8. Extension.value[x]
    Definition

    A code representing the patient or other source's judgment about the state of the device used that this statement is about. Generally this will be active or completed.

    Shortactive | completed | not-done | entered-in-error +
    Comments

    DeviceUseStatment is a statement at a point in time. The status is only representative at the point when it was asserted. The value set for contains codes that assert the status of the use by the patient (for example, stopped or on hold) as well as codes that assert the status of the resource itself (for example, entered in error).

    This element is labeled as a modifier because the status contains the codes that mark the statement as not currently valid.

    Control1..1
    BindingThe codes SHALL be taken from R5DeviceusageStatusForR4DeviceStatementStatus (0.1.0)
    (required to http://hl7.org/fhir/uv/xver/ValueSet/R5-deviceusage-status-for-R4-device-statement-status|0.1.0)

    A coded concept indicating the current status of the Device Usage.

    Typecode
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))