RDC Interoperability Guide
1.0.0

rdc-DeviceAssociation

Official URL: https://roche.com/fhir/iop/StructureDefinition/rdc-DeviceAssociation Version: 1.0.0
Parent:

http://hl7.org/fhir/StructureDefinition/DeviceAssociation

Computable Name:

RdcDeviceAssociation

RDC DeviceAssociation profile to record of association or dissociation of a device with a patient.

Formal Views of Profile Content

idΣ0..1id
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
textI0..1Narrative
containedI0..*Resource
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
identifierΣ0..0Identifier
deviceΣ1..1Reference(Device)
categoryΣ0..0CodeableConcept
statusΣ1..1CodeableConceptBinding
statusReasonΣ0..0CodeableConceptBinding
subjectΣ0..1Reference(Patient | Group | Practitioner | RelatedPerson | Device)
bodyStructureΣ0..0Reference(BodyStructure)
periodΣ0..1Period

DeviceAssociation
DefinitionA record of association or dissociation of a device with a patient.
Cardinality0...*
Invariants
  • dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
    contained.contained.empty()
  • dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
    contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).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-5: If a resource is contained in another resource, it SHALL NOT have a security label
    contained.meta.security.empty()
  • dom-6: A resource should have narrative for robust management
    text.`div`.exists()
Mappings
  • rim: Entity, Role, or Act
  • w5: administrative.device
DeviceAssociation.id
DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Cardinality0...1
Typeid
SummaryTrue
Comments

Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

DeviceAssociation.meta
DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Cardinality0...1
TypeMeta
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
DeviceAssociation.implicitRules
DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Cardinality0...1
Typeuri
ModifierTrue
SummaryTrue
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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
DeviceAssociation.language
DefinitionThe base language in which the resource is written.
Cardinality0...1
Typecode
Binding

IETF language tag for a human language

AllLanguages (required)
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).

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
DeviceAssociation.text
DefinitionA human-readable narrative that contains a summary of the resource and can 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.
Cardinality0...1
TypeNarrative
Aliasnarrative, html, xhtml, display
Comments

Contained resources do not have a 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 information is added later.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: Act.text?
DeviceAssociation.contained
DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.
Cardinality0...*
TypeResource
Aliasinline resources, anonymous resources, contained 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. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.

Mappings
  • rim: N/A
DeviceAssociation.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

Invariants
  • 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()
Mappings
  • rim: N/A
DeviceAssociation.modifierExtension
DefinitionMay 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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

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.

Invariants
  • 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()
Mappings
  • rim: N/A
DeviceAssociation.identifier
DefinitionInstance identifier.
Cardinality0...0
TypeIdentifier
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
DeviceAssociation.device
DefinitionReference to the devices associated with the patient or group.
Cardinality1...1
TypeReference(Device)
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
DeviceAssociation.category
DefinitionDescribes the relationship between the device and subject.
Cardinality0...0
TypeCodeableConcept
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
DeviceAssociation.status
DefinitionIndicates the state of the Device association.
Cardinality1...1
TypeCodeableConcept
Binding

Describes the lifecycle of the association.

DeviceAssociationCodes (required)
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
DeviceAssociation.statusReason
DefinitionThe reasons given for the current association status.
Cardinality0...0
TypeCodeableConcept
Binding

Describes the reason for changing the status of the association.

DeviceAssociationCodes (required)
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
DeviceAssociation.subject
DefinitionThe individual, group of individuals or device that the device is on or associated with.
Cardinality0...1
TypeReference(Patient | Group | Practitioner | RelatedPerson | Device)
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
DeviceAssociation.bodyStructure
DefinitionCurrent anatomical location of the device in/on subject.
Cardinality0...0
TypeReference(BodyStructure)
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
DeviceAssociation.period
DefinitionBegin and end dates and times for the device association.
Cardinality0...1
TypePeriod
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
DeviceAssociation.operation
DefinitionThe details about the device when it is in use to describe its operation.
Cardinality0...0
TypeBackboneElement
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
DeviceAssociation.operation.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
DeviceAssociation.operation.extension
DefinitionMay 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 managable, 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

Invariants
  • 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()
Mappings
  • rim: n/a
DeviceAssociation.operation.modifierExtension
DefinitionMay 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

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.

Invariants
  • 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()
Mappings
  • rim: N/A
DeviceAssociation.operation.status
DefinitionDevice operational condition corresponding to the association.
Cardinality1...1
TypeCodeableConcept
Binding

Describes the the status of the association operation.

FHIRDeviceAssociationOperationStatus (example)
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
DeviceAssociation.operation.operator
DefinitionThe individual performing the action enabled by the device.
Cardinality0...*
TypeReference(Patient | Practitioner | RelatedPerson)
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
DeviceAssociation.operation.period
DefinitionBegin and end dates and times for the device's operation.
Cardinality0...1
TypePeriod
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • TODO
  • <StructureDefinition xmlns="http://hl7.org/fhir">
        <id value="rdc-DeviceAssociation" />
        <url value="https://roche.com/fhir/iop/StructureDefinition/rdc-DeviceAssociation" />
        <name value="RdcDeviceAssociation" />
        <title value="RDC DeviceAssociation" />
        <status value="draft" />
        <experimental value="true" />
        <publisher value="F. Hoffmann-La Roche AG" />
        <description value="RDC DeviceAssociation profile to record of association or dissociation of a device with a patient." />
        <copyright value="Copyright and related rights waived via CC0, https://creativecommons.org/publicdomain/zero/1.0/. This does not apply to information from third parties, for example a medical terminology system. The implementer alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize third party IP in connection with the specification or otherwise." />
        <fhirVersion value="5.0.0" />
        <kind value="resource" />
        <abstract value="false" />
        <type value="DeviceAssociation" />
        <baseDefinition value="http://hl7.org/fhir/StructureDefinition/DeviceAssociation" />
        <derivation value="constraint" />
        <differential>
            <element id="DeviceAssociation.identifier">
                <path value="DeviceAssociation.identifier" />
                <max value="0" />
            </element>
            <element id="DeviceAssociation.category">
                <path value="DeviceAssociation.category" />
                <max value="0" />
            </element>
            <element id="DeviceAssociation.statusReason">
                <path value="DeviceAssociation.statusReason" />
                <max value="0" />
            </element>
            <element id="DeviceAssociation.bodyStructure">
                <path value="DeviceAssociation.bodyStructure" />
                <max value="0" />
            </element>
            <element id="DeviceAssociation.operation">
                <path value="DeviceAssociation.operation" />
                <max value="0" />
            </element>
        </differential>
    </StructureDefinition>
    
    {
        "resourceType": "StructureDefinition",
        "id": "rdc-DeviceAssociation",
        "url": "https://roche.com/fhir/iop/StructureDefinition/rdc-DeviceAssociation",
        "name": "RdcDeviceAssociation",
        "title": "RDC DeviceAssociation",
        "status": "draft",
        "experimental": true,
        "publisher": "F. Hoffmann-La Roche AG",
        "description": "RDC DeviceAssociation profile to record of association or dissociation of a device with a patient.",
        "copyright": "Copyright and related rights waived via CC0, https://creativecommons.org/publicdomain/zero/1.0/. This does not apply to information from third parties, for example a medical terminology system. The implementer alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize third party IP in connection with the specification or otherwise.",
        "fhirVersion": "5.0.0",
        "kind": "resource",
        "abstract": false,
        "type": "DeviceAssociation",
        "baseDefinition": "http://hl7.org/fhir/StructureDefinition/DeviceAssociation",
        "derivation": "constraint",
        "differential": {
            "element":  [
                {
                    "id": "DeviceAssociation.identifier",
                    "path": "DeviceAssociation.identifier",
                    "max": "0"
                },
                {
                    "id": "DeviceAssociation.category",
                    "path": "DeviceAssociation.category",
                    "max": "0"
                },
                {
                    "id": "DeviceAssociation.statusReason",
                    "path": "DeviceAssociation.statusReason",
                    "max": "0"
                },
                {
                    "id": "DeviceAssociation.bodyStructure",
                    "path": "DeviceAssociation.bodyStructure",
                    "max": "0"
                },
                {
                    "id": "DeviceAssociation.operation",
                    "path": "DeviceAssociation.operation",
                    "max": "0"
                }
            ]
        }
    }