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

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

Resource Profile: Profile_R5_DeviceAssociation_R3_Device - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 0

Definitions for the profile-DeviceAssociation-for-Device resource profile.

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

0. Device
Definition

This resource identifies an instance or a type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device. Medical devices include durable (reusable) medical equipment, implantable devices, as well as disposable equipment used for diagnostic, treatment, and research for healthcare and public health. Non-medical devices may include items such as a machine, cellphone, computer, application, etc.

ShortItem used in healthcare
Control0..*
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty())
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty())
2. Device.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element.

This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

Control0..1
Typeuri
Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
4. Device.extension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the resource. 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.

ShortExtensionAdditional 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.

Control20..*
TypeExtension
Alternate Namesextensions, user content
SlicingThis element introduces a set of slices on Device.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 6. Device.extension:device
    Slice Namedevice
    Definition

    R5: DeviceAssociation.device (new:Reference(Device))

    ShortR5: Reference to the devices associated with the patient or group (new)
    Comments

    Element DeviceAssociation.device has a context of Device based on following the parent source element upwards and mapping to Device. Element DeviceAssociation.device has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

    Control1..1
    This element is affected by the following invariants: ele-1
    TypeExtension(R5: Reference to the devices associated with the patient or group (new)) (Extension Type: Reference(Cross-version Profile for R5.Device for use in FHIR STU3, Device))
    Is Modifierfalse
    Invariantsele-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())
    8. Device.extension:category
    Slice Namecategory
    Definition

    R5: DeviceAssociation.category (new:CodeableConcept)

    ShortR5: Describes the relationship between the device and subject (new)
    Comments

    Element DeviceAssociation.category has a context of Device based on following the parent source element upwards and mapping to Device. Element DeviceAssociation.category has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

    Control0..*
    This element is affected by the following invariants: ele-1
    TypeExtension(R5: Describes the relationship between the device and subject (new)) (Extension Type: CodeableConcept)
    Is Modifierfalse
    Invariantsele-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())
    10. Device.extension:status
    Slice Namestatus
    Definition

    R5: DeviceAssociation.status (new:CodeableConcept)

    ShortR5: implanted | explanted | attached | entered-in-error | unknown (new)
    Comments

    Element DeviceAssociation.status has a context of Device based on following the parent source element upwards and mapping to Device. Element DeviceAssociation.status has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

    Control1..1
    This element is affected by the following invariants: ele-1
    TypeExtension(R5: implanted | explanted | attached | entered-in-error | unknown (new)) (Extension Type: CodeableConcept)
    Is Modifierfalse
    Invariantsele-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())
    12. Device.extension:statusReason
    Slice NamestatusReason
    Definition

    R5: DeviceAssociation.statusReason (new:CodeableConcept)

    ShortR5: The reasons given for the current association status (new)
    Comments

    Element DeviceAssociation.statusReason has a context of Device based on following the parent source element upwards and mapping to Device. Element DeviceAssociation.statusReason has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

    Control0..*
    This element is affected by the following invariants: ele-1
    TypeExtension(R5: The reasons given for the current association status (new)) (Extension Type: CodeableConcept)
    Is Modifierfalse
    Invariantsele-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())
    14. Device.extension:bodyStructure
    Slice NamebodyStructure
    Definition

    R5: DeviceAssociation.bodyStructure (new:Reference(BodyStructure))

    ShortR5: Current anatomical location of the device in/on subject (new)
    Comments

    Element DeviceAssociation.bodyStructure has a context of Device based on following the parent source element upwards and mapping to Device. Element DeviceAssociation.bodyStructure has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(R5: Current anatomical location of the device in/on subject (new)) (Extension Type: Reference(Cross-version Profile for R5.BodyStructure for use in FHIR STU3, BodySite))
    Is Modifierfalse
    Invariantsele-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())
    16. Device.extension:period
    Slice Nameperiod
    Definition

    R5: DeviceAssociation.period (new:Period)

    ShortR5: Begin and end dates and times for the device association (new)
    Comments

    Element DeviceAssociation.period has a context of Device based on following the parent source element upwards and mapping to Device. Element DeviceAssociation.period has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(R5: Begin and end dates and times for the device association (new)) (Extension Type: Period)
    Is Modifierfalse
    Invariantsele-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())
    18. Device.extension:operation
    Slice Nameoperation
    Definition

    R5: DeviceAssociation.operation (new:BackboneElement)

    ShortR5: The details about the device when it is in use to describe its operation (new)
    Comments

    Element DeviceAssociation.operation has a context of Device based on following the parent source element upwards and mapping to Device. Element DeviceAssociation.operation has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

    Control0..*
    This element is affected by the following invariants: ele-1
    TypeExtension(R5: The details about the device when it is in use to describe its operation (new)) (Complex Extension)
    Is Modifierfalse
    Invariantsele-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())
    20. Device.modifierExtension
    Definition

    May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.

    ShortExtensions that cannot be ignored
    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 Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
    Alternate Namesextensions, user content
    22. Device.status
    Definition

    Status of the Device availability.

    Shortactive | inactive | entered-in-error | unknown
    Comments

    This element is labeled as a modifier because the status contains the codes inactive and entered-in-error that mark the device (record)as not currently valid.

    Control0..1
    BindingThe codes SHALL be taken from FHIRDeviceStatushttp://hl7.org/fhir/ValueSet/device-status|3.0.2
    (required to http://hl7.org/fhir/ValueSet/device-status|3.0.2)

    The availability status of the device.

    Typecode
    Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue

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

    0. Device
    2. Device.extension
    Control2..*
    SlicingThis element introduces a set of slices on Device.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 4. Device.extension:device
      Slice Namedevice
      Definition

      R5: DeviceAssociation.device (new:Reference(Device))

      ShortR5: Reference to the devices associated with the patient or group (new)
      Comments

      Element DeviceAssociation.device has a context of Device based on following the parent source element upwards and mapping to Device. Element DeviceAssociation.device has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

      Control1..1
      TypeExtension(R5: Reference to the devices associated with the patient or group (new)) (Extension Type: Reference(Cross-version Profile for R5.Device for use in FHIR STU3, Device))
      6. Device.extension:category
      Slice Namecategory
      Definition

      R5: DeviceAssociation.category (new:CodeableConcept)

      ShortR5: Describes the relationship between the device and subject (new)
      Comments

      Element DeviceAssociation.category has a context of Device based on following the parent source element upwards and mapping to Device. Element DeviceAssociation.category has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

      Control0..*
      TypeExtension(R5: Describes the relationship between the device and subject (new)) (Extension Type: CodeableConcept)
      8. Device.extension:status
      Slice Namestatus
      Definition

      R5: DeviceAssociation.status (new:CodeableConcept)

      ShortR5: implanted | explanted | attached | entered-in-error | unknown (new)
      Comments

      Element DeviceAssociation.status has a context of Device based on following the parent source element upwards and mapping to Device. Element DeviceAssociation.status has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

      Control1..1
      TypeExtension(R5: implanted | explanted | attached | entered-in-error | unknown (new)) (Extension Type: CodeableConcept)
      10. Device.extension:statusReason
      Slice NamestatusReason
      Definition

      R5: DeviceAssociation.statusReason (new:CodeableConcept)

      ShortR5: The reasons given for the current association status (new)
      Comments

      Element DeviceAssociation.statusReason has a context of Device based on following the parent source element upwards and mapping to Device. Element DeviceAssociation.statusReason has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

      Control0..*
      TypeExtension(R5: The reasons given for the current association status (new)) (Extension Type: CodeableConcept)
      12. Device.extension:bodyStructure
      Slice NamebodyStructure
      Definition

      R5: DeviceAssociation.bodyStructure (new:Reference(BodyStructure))

      ShortR5: Current anatomical location of the device in/on subject (new)
      Comments

      Element DeviceAssociation.bodyStructure has a context of Device based on following the parent source element upwards and mapping to Device. Element DeviceAssociation.bodyStructure has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

      Control0..1
      TypeExtension(R5: Current anatomical location of the device in/on subject (new)) (Extension Type: Reference(Cross-version Profile for R5.BodyStructure for use in FHIR STU3, BodySite))
      14. Device.extension:period
      Slice Nameperiod
      Definition

      R5: DeviceAssociation.period (new:Period)

      ShortR5: Begin and end dates and times for the device association (new)
      Comments

      Element DeviceAssociation.period has a context of Device based on following the parent source element upwards and mapping to Device. Element DeviceAssociation.period has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

      Control0..1
      TypeExtension(R5: Begin and end dates and times for the device association (new)) (Extension Type: Period)
      16. Device.extension:operation
      Slice Nameoperation
      Definition

      R5: DeviceAssociation.operation (new:BackboneElement)

      ShortR5: The details about the device when it is in use to describe its operation (new)
      Comments

      Element DeviceAssociation.operation has a context of Device based on following the parent source element upwards and mapping to Device. Element DeviceAssociation.operation has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

      Control0..*
      TypeExtension(R5: The details about the device when it is in use to describe its operation (new)) (Complex Extension)
      18. Device.patient
      20. Device.patient.extension
      Control0..*
      SlicingThis element introduces a set of slices on Device.patient.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 22. Device.patient.extension:subject
        Slice Namesubject
        Definition

        R5: DeviceAssociation.subject

        ShortR5: The individual, group of individuals or device that the device is on or associated with
        Comments

        Element DeviceAssociation.subject is mapped to FHIR STU3 element Device.patient as SourceIsBroaderThanTarget. The standard extension alternate-reference has been mapped as the representation of FHIR R5 element DeviceAssociation.subject with unmapped reference targets: Device, Group, Patient, Practitioner, RelatedPerson.

        Control0..1
        TypeExtension(http://hl7.org/fhir/StructureDefinition/alternate-reference)

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

        0. Device
        Definition

        This resource identifies an instance or a type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device. Medical devices include durable (reusable) medical equipment, implantable devices, as well as disposable equipment used for diagnostic, treatment, and research for healthcare and public health. Non-medical devices may include items such as a machine, cellphone, computer, application, etc.

        ShortItem used in healthcare
        Control0..*
        Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
        dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.empty())
        dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
        dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty())
        2. Device.id
        Definition

        The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

        ShortLogical id of this artifact
        Comments

        The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

        Control0..1
        Typeid
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        4. Device.meta
        Definition

        The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.

        ShortMetadata about the resource
        Control0..1
        TypeMeta
        Summarytrue
        6. Device.implicitRules
        Definition

        A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

        ShortA set of rules under which this content was created
        Comments

        Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element.

        This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

        Control0..1
        Typeuri
        Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        8. Device.language
        Definition

        The base language in which the resource is written.

        ShortLanguage of the resource content
        Comments

        Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

        Control0..1
        BindingUnless not suitable, these codes SHALL be taken from Common Languages .
        (extensible to http://hl7.org/fhir/ValueSet/languages|3.0.2)

        A human language.

        Additional BindingsPurpose
        All LanguagesMax Binding
        Typecode
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        10. Device.text
        Definition

        A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

        ShortText summary of the resource, for human interpretation
        Comments

        Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.

        Control0..1
        This element is affected by the following invariants: dom-1
        TypeNarrative
        Alternate Namesnarrative, html, xhtml, display
        12. Device.contained
        Definition

        These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

        ShortContained, inline Resources
        Comments

        This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.

        Control0..*
        TypeResource
        Alternate Namesinline resources, anonymous resources, contained resources
        14. Device.extension
        Definition

        An Extension

        ShortExtension
        Control2..*
        TypeExtension
        SlicingThis element introduces a set of slices on Device.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 16. Device.extension:device
          Slice Namedevice
          Definition

          R5: DeviceAssociation.device (new:Reference(Device))

          ShortR5: Reference to the devices associated with the patient or group (new)
          Comments

          Element DeviceAssociation.device has a context of Device based on following the parent source element upwards and mapping to Device. Element DeviceAssociation.device has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

          Control1..1
          This element is affected by the following invariants: ele-1
          TypeExtension(R5: Reference to the devices associated with the patient or group (new)) (Extension Type: Reference(Cross-version Profile for R5.Device for use in FHIR STU3, Device))
          Is Modifierfalse
          Invariantsele-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())
          18. Device.extension:category
          Slice Namecategory
          Definition

          R5: DeviceAssociation.category (new:CodeableConcept)

          ShortR5: Describes the relationship between the device and subject (new)
          Comments

          Element DeviceAssociation.category has a context of Device based on following the parent source element upwards and mapping to Device. Element DeviceAssociation.category has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

          Control0..*
          This element is affected by the following invariants: ele-1
          TypeExtension(R5: Describes the relationship between the device and subject (new)) (Extension Type: CodeableConcept)
          Is Modifierfalse
          Invariantsele-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())
          20. Device.extension:status
          Slice Namestatus
          Definition

          R5: DeviceAssociation.status (new:CodeableConcept)

          ShortR5: implanted | explanted | attached | entered-in-error | unknown (new)
          Comments

          Element DeviceAssociation.status has a context of Device based on following the parent source element upwards and mapping to Device. Element DeviceAssociation.status has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

          Control1..1
          This element is affected by the following invariants: ele-1
          TypeExtension(R5: implanted | explanted | attached | entered-in-error | unknown (new)) (Extension Type: CodeableConcept)
          Is Modifierfalse
          Invariantsele-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())
          22. Device.extension:statusReason
          Slice NamestatusReason
          Definition

          R5: DeviceAssociation.statusReason (new:CodeableConcept)

          ShortR5: The reasons given for the current association status (new)
          Comments

          Element DeviceAssociation.statusReason has a context of Device based on following the parent source element upwards and mapping to Device. Element DeviceAssociation.statusReason has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

          Control0..*
          This element is affected by the following invariants: ele-1
          TypeExtension(R5: The reasons given for the current association status (new)) (Extension Type: CodeableConcept)
          Is Modifierfalse
          Invariantsele-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())
          24. Device.extension:bodyStructure
          Slice NamebodyStructure
          Definition

          R5: DeviceAssociation.bodyStructure (new:Reference(BodyStructure))

          ShortR5: Current anatomical location of the device in/on subject (new)
          Comments

          Element DeviceAssociation.bodyStructure has a context of Device based on following the parent source element upwards and mapping to Device. Element DeviceAssociation.bodyStructure has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

          Control0..1
          This element is affected by the following invariants: ele-1
          TypeExtension(R5: Current anatomical location of the device in/on subject (new)) (Extension Type: Reference(Cross-version Profile for R5.BodyStructure for use in FHIR STU3, BodySite))
          Is Modifierfalse
          Invariantsele-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())
          26. Device.extension:period
          Slice Nameperiod
          Definition

          R5: DeviceAssociation.period (new:Period)

          ShortR5: Begin and end dates and times for the device association (new)
          Comments

          Element DeviceAssociation.period has a context of Device based on following the parent source element upwards and mapping to Device. Element DeviceAssociation.period has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

          Control0..1
          This element is affected by the following invariants: ele-1
          TypeExtension(R5: Begin and end dates and times for the device association (new)) (Extension Type: Period)
          Is Modifierfalse
          Invariantsele-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())
          28. Device.extension:operation
          Slice Nameoperation
          Definition

          R5: DeviceAssociation.operation (new:BackboneElement)

          ShortR5: The details about the device when it is in use to describe its operation (new)
          Comments

          Element DeviceAssociation.operation has a context of Device based on following the parent source element upwards and mapping to Device. Element DeviceAssociation.operation has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

          Control0..*
          This element is affected by the following invariants: ele-1
          TypeExtension(R5: The details about the device when it is in use to describe its operation (new)) (Complex Extension)
          Is Modifierfalse
          Invariantsele-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())
          30. Device.modifierExtension
          Definition

          May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.

          ShortExtensions that cannot be ignored
          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 Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
          Alternate Namesextensions, user content
          32. Device.identifier
          Definition

          Unique instance identifiers assigned to a device by manufacturers other organizations or owners.

          ShortInstance identifier
          Comments

          The barcode string from a barcode present on a device label or package may identify the instance, include names given to the device in local usage, or may identify the type of device. If the identifier identifies the type of device, Device.type element should be used. For UDI, this element corresponds to the variable portion of the UDI that identifies the serial number of a specific device. See UDI mappings for a complete mapping of UDI parts to Device.

          NoteThis is a business identifier, not a resource identifier (see discussion)
          Control0..*
          TypeIdentifier
          Alternate NamesSerial Number
          34. Device.udi
          Definition

          Unique device identifier (UDI) assigned to device label or package.

          ShortUnique Device Identifier (UDI) Barcode string
          Comments

          UDI may identify an unique instance of a device, or it may only identify the type of the device. See UDI mappings for a complete mapping of UDI parts to Device.

          Control0..1
          TypeBackboneElement
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
          36. Device.udi.id
          Definition

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

          Shortxml:id (or equivalent in JSON)
          Control0..1
          Typestring
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          38. Device.udi.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.

          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
          Alternate Namesextensions, user content
          40. Device.udi.modifierExtension
          Definition

          May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.

          ShortExtensions that cannot be ignored
          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 Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
          Summarytrue
          Alternate Namesextensions, user content, modifiers
          42. Device.udi.deviceIdentifier
          Definition

          The device identifier (DI) is a mandatory, fixed portion of a UDI that identifies the labeler and the specific version or model of a device.

          ShortMandatory fixed portion of UDI
          Control0..1
          Typestring
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Alternate NamesDI
          44. Device.udi.name
          Definition

          Name of device as used in labeling or catalog.

          ShortDevice Name as appears on UDI label
          Comments

          Use the Device.type for a generic type or kind of device name. Note the GUDID lists the name as the 'Brand Name'.

          Control0..1
          Typestring
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Alternate NamesBrand Name
          46. Device.udi.jurisdiction
          Definition

          The identity of the authoritative source for UDI generation within a jurisdiction. All UDIs are globally unique within a single namespace. with the appropriate repository uri as the system. For example, UDIs of devices managed in the U.S. by the FDA, the value is http://hl7.org/fhir/NamingSystem/fda-udi.

          ShortRegional UDI authority
          Control0..1
          Typeuri
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Requirements

          Allows a recipient of a UDI to know which database will contain the UDI-associated metadata.

          48. Device.udi.carrierHRF
          Definition

          The full UDI carrier as the human readable form (HRF) representation of the barcode string as printed on the packaging of the device.

          ShortUDI Human Readable Barcode String
          Comments

          If separate barcodes for DI and PI are present, concatenate the string with DI first and in order of human readable expression on label.

          Control0..1
          Typestring
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Alternate NamesHuman Readable Form
          50. Device.udi.carrierAIDC
          Definition

          The full UDI carrier of the Automatic Identification and Data Capture (AIDC) technology representation of the barcode string as printed on the packaging of the device - E.g a barcode or RFID. Because of limitations on character sets in XML and the need to round-trip JSON data through XML, AIDC Formats SHALL be base64 encoded.

          ShortUDI Machine Readable Barcode String
          Comments

          The AIDC form of UDIs should be scanned or otherwise used for the identification of the device whenever possible to minimize errors in records resulting from manual transcriptions. If separate barcodes for DI and PI are present, concatenate the string with DI first and in order of human readable expression on label.

          Control0..1
          Typebase64Binary
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Alternate NamesAutomatic Identification and Data Capture
          52. Device.udi.issuer
          Definition

          Organization that is charged with issuing UDIs for devices. For example, the US FDA issuers include : 1) GS1: http://hl7.org/fhir/NamingSystem/gs1-di, 2) HIBCC: http://hl7.org/fhir/NamingSystem/hibcc-dI, 3) ICCBBA for blood containers: http://hl7.org/fhir/NamingSystem/iccbba-blood-di, 4) ICCBA for other devices: http://hl7.org/fhir/NamingSystem/iccbba-other-di.

          ShortUDI Issuing Organization
          Control0..1
          Typeuri
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Alternate NamesBarcode System
          54. Device.udi.entryType
          Definition

          A coded entry to indicate how the data was entered.

          Shortbarcode | rfid | manual +
          Control0..1
          BindingThe codes SHALL be taken from UDIEntryType .
          (required to http://hl7.org/fhir/ValueSet/udi-entry-type|3.0.2)

          Codes to identify how UDI data was entered

          Typecode
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Requirements

          Supports a way to distinguish hand entered from machine read data.

          56. Device.status
          Definition

          Status of the Device availability.

          Shortactive | inactive | entered-in-error | unknown
          Comments

          This element is labeled as a modifier because the status contains the codes inactive and entered-in-error that mark the device (record)as not currently valid.

          Control0..1
          BindingThe codes SHALL be taken from FHIRDeviceStatus
          (required to http://hl7.org/fhir/ValueSet/device-status|3.0.2)

          The availability status of the device.

          Typecode
          Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          58. Device.type
          Definition

          Code or identifier to identify a kind of device.

          ShortWhat kind of device this is
          Control0..1
          BindingFor example codes, see FHIR Device Types
          (example to http://hl7.org/fhir/ValueSet/device-kind|3.0.2)

          Codes to identify medical devices

          TypeCodeableConcept
          60. Device.lotNumber
          Definition

          Lot number assigned by the manufacturer.

          ShortLot number of manufacture
          Control0..1
          Typestring
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          62. Device.manufacturer
          Definition

          A name of the manufacturer.

          ShortName of device manufacturer
          Control0..1
          Typestring
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          64. Device.manufactureDate
          Definition

          The date and time when the device was manufactured.

          ShortDate when the device was made
          Control0..1
          TypedateTime
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          66. Device.expirationDate
          Definition

          The date and time beyond which this device is no longer valid or should not be used (if applicable).

          ShortDate and time of expiry of this device (if applicable)
          Control0..1
          TypedateTime
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          68. Device.model
          Definition

          The "model" is an identifier assigned by the manufacturer to identify the product by its type. This number is shared by the all devices sold as the same type.

          ShortModel id assigned by the manufacturer
          Control0..1
          Typestring
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          70. Device.version
          Definition

          The version of the device, if the device has multiple releases under the same model, or if the device is software or carries firmware.

          ShortVersion number (i.e. software)
          NoteThis is a business version Id, not a resource version Id (see discussion)
          Control0..1
          Typestring
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          72. Device.patient
          Definition

          Patient information, If the device is affixed to a person.

          ShortPatient to whom Device is affixed
          Control0..1
          TypeReference(Patient)
          Requirements

          If the device is implanted in a patient, then need to associate the device to the patient.

          74. Device.patient.id
          Definition

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

          Shortxml:id (or equivalent in JSON)
          Control0..1
          Typestring
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          76. Device.patient.extension
          Definition

          An Extension

          ShortExtension
          Control0..*
          TypeExtension
          SlicingThis element introduces a set of slices on Device.patient.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 78. Device.patient.extension:subject
            Slice Namesubject
            Definition

            R5: DeviceAssociation.subject

            ShortR5: The individual, group of individuals or device that the device is on or associated with
            Comments

            Element DeviceAssociation.subject is mapped to FHIR STU3 element Device.patient as SourceIsBroaderThanTarget. The standard extension alternate-reference has been mapped as the representation of FHIR R5 element DeviceAssociation.subject with unmapped reference targets: Device, Group, Patient, Practitioner, RelatedPerson.

            Control0..1
            TypeExtension(http://hl7.org/fhir/StructureDefinition/alternate-reference)
            80. Device.patient.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.

            ShortLiteral reference, Relative, internal or absolute URL
            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.

            Control0..1
            This element is affected by the following invariants: ref-1
            Typestring
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            82. Device.patient.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.

            ShortLogical reference, when literal reference is not known
            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.

            NoteThis is a business identifier, not a resource identifier (see discussion)
            Control0..1
            TypeIdentifier
            Summarytrue
            84. Device.patient.display
            Definition

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

            ShortText alternative for the resource
            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.

            Control0..1
            Typestring
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            86. Device.owner
            Definition

            An organization that is responsible for the provision and ongoing maintenance of the device.

            ShortOrganization responsible for device
            Control0..1
            TypeReference(Organization)
            88. Device.contact
            Definition

            Contact details for an organization or a particular human that is responsible for the device.

            ShortDetails for human/organization for support
            Comments

            used for troubleshooting etc.

            Control0..*
            TypeContactPoint
            90. Device.location
            Definition

            The place where the device can be found.

            ShortWhere the resource is found
            Control0..1
            TypeReference(Location)
            Requirements

            Device.location can be used to track device location.

            92. Device.url
            Definition

            A network address on which the device may be contacted directly.

            ShortNetwork address to contact device
            Comments

            If the device is running a FHIR server, the network address should be the Base URL from which a conformance statement may be retrieved.

            Control0..1
            Typeuri
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            94. Device.note
            Definition

            Descriptive information, usage information or implantation information that is not captured in an existing element.

            ShortDevice notes and comments
            Control0..*
            TypeAnnotation
            96. Device.safety
            Definition

            Provides additional safety characteristics about a medical device. For example devices containing latex.

            ShortSafety Characteristics of Device
            Control0..*
            BindingFor example codes, see DeviceSafety
            (example to http://hl7.org/fhir/ValueSet/device-safety|3.0.2)

            Codes used to identify medical devices safety characterics. These codes are derived in part from the United States Food and Drug Administration recommendations and are provided here as a suggestive example.

            TypeCodeableConcept
            Summarytrue