Generated Narrative: StructureDefinition HiisDeviceDataRecorderDefinition Name Flags Card. Type Description & Constraints<img src="[binary]" alt="doco" style="background-color: inherit"/> DeviceDefinition S 0..* DeviceDefinition Medical Aid Interface #xD; Slices for extension S 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:endpoint S 0..* Reference(HiisDeviceDataRecorderEndpoint) Endpoints URL: https://fhir.bfarm.de/StructureDefinition/HiisDeviceDataRecorderEndpointLink #xD; extension:link S 0..* (Complex) Supported Medical Aids URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DeviceDefinition.link #xD; extension S 2..* Extension Extension #xD; Slices for extension Content/Rules for all slices #xD; extension:relation S 1..1 Extension Extension #xD; extension 0..0 Extension #xD; value[x] S 0..1 Coding The type indicates the relationship of the related device to the device instance Binding: ValueSet for HiisDeviceDefinitionRelationType (required) #xD; extension:relatedDevice S 1..1 Extension Extension #xD; extension S 0..* Extension Extension #xD; Slices for extension Content/Rules for all slices #xD; extension:reference S 0..1 Extension Extension #xD; extension 0..0 Extension #xD; value[x] S 0..1 Reference(HiisPersonalHealthDeviceDefinition) Reference to a resource (by instance) #xD; value[x] 0..0 Value of extension #xD; value[x] 0..0 Value of extension #xD; extension:mivSet S 0..* (Complex) MIV Set URL: https://fhir.bfarm.de/StructureDefinition/HiisDeviceDefinitionMivSet #xD; Slices for identifier S 0..* Identifier Identifiers Slice: Unordered, Open by value:system #xD; identifier:hiisId S 0..1 Identifier HIIS ID #xD; system S 1..1 uri The namespace for the identifier value Fixed Value: https://fhir.bfarm.de/Identifier/HiisId #xD; value S 1..1 string The value that is unique #xD; Slices for manufacturer[x] S 0..1 string, Reference(Organization) Name of device manufacturer Slice: Unordered, Open by type:$this #xD; manufacturer[x]:manufacturerReference S 0..1 Reference(HiisManufacturer) Manufacturer #xD; reference S 1..1 string Literal reference, Relative, internal or absolute URL #xD; display S 0..1 string Text alternative for the resource #xD; Slices for deviceName S 0..* BackboneElement Device Name Slice: Unordered, Open by value:type #xD; deviceName:userFriendlyName S 0..1 BackboneElement Interface Name #xD; name S 1..1 string The name of the device #xD; type 1..1 code udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other Fixed Value: user-friendly-name #xD; version S 0..* string Version #xD; value S 1..1 string Interface Version #xD; <img src="[binary]" alt="doco" style="background-color: inherit"/> Documentation for this format
Definition of an interface (DeviceDataRecorder) for a medical aid or implant in the HIIS catalog.
Represents an interface for medical aids or implants for data recording.
For the initial scope, this DeviceDefinition resource is only applicable to describe a single node in the containment tree that is produced by the context scanner in any medical device that implements or derives from the ISO/IEEE 11073 standard and that does not represent a metric. Examples for such a node are MDS, VMD, or Channel.
If the resource is contained in another resource, it SHALL NOT contain nested Resources
not(parent::f:contained and f:contained)
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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))
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()
not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
If a resource is contained in another resource, it SHALL NOT have a security label
When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time.
A resource should have narrative for robust management
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
The 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.
All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
A set of rules under which this content was created
A 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.
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 it's narrative along with other profiles, value sets, etc.
This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
The base language in which the resource is written.
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).
Text summary of the resource, for human interpretation
A 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.
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 information is added later.
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.
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.
Must have either extensions or value[x], not both
exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
Endpoints of the medical aid interface for communication.
exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
Reference to supported medical aids or implants (HiisPersonalHealthDeviceDefinition).
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Extensions are always sliced by (at least) url
Source of the definition for the extension code - a logical name or a URL.
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.
The type indicates the relationship of the related device to the device instance
This cross-version extension represents DeviceDefinition.link.relation from http://hl7.org/fhir/StructureDefinition/DeviceDefinition|5.0.0 for use in FHIR R4.
A reference to a concept - e.g. the information is identified by its general class to the degree of precision found in the terminology.
Additional content defined by implementations
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.
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.
A reference to a resource the provides exact details about the information being referenced.
Data type name for DeviceDefinition.link.relatedDevice from FHIR R5
Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R5/extensibility.html) for a list).
Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R4/extensibility.html) for a list).
Contains information about a supported MIV Set including time parameters for interfaces.
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 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 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).
Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Contains characteristics for unique identification of the medical aid interface.
The unique HIIS ID from the HIIS catalog.
usual | official | temp | secondary | old (If known)
Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Identifies the purpose for this identifier, if known .
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
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.
Allows users to make use of identifiers when the identifier system is not known.
A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Identifier.system is always case sensitive.
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.
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
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](http://hl7.org/fhir/R4/extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
Time period when id is/was valid for use
Time period during which identifier is/was valid for use.
Role.effectiveTime or implied by context
Organization that issued id (may be just text)
Organization that issued/manages the identifier.
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.
II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
Unique Device Identifier (UDI) Barcode string
Unique device identifier (UDI) assigned to device label or package. Note that the Device may include multiple udiCarriers as it either may include just the udiCarrier for the jurisdiction it is sold, or for multiple jurisdictions it could have been sold.
Extensions that cannot be ignored even if unrecognized
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 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 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. 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).
Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
The identifier that is to be associated with every Device that references this DeviceDefintiion for the issuer and jurisdication porvided in the DeviceDefinition.udiDeviceIdentifier
The identifier that is to be associated with every Device that references this DeviceDefintiion for the issuer and jurisdication porvided in the DeviceDefinition.udiDeviceIdentifier.
The organization that assigns the identifier algorithm
The organization that assigns the identifier algorithm.
The jurisdiction to which the deviceIdentifier applies
The jurisdiction to which the deviceIdentifier applies.
The reference to the manufacturer of the medical aid interface.
Literal reference, Relative, internal or absolute URL
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.
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.
Type the reference refers to (e.g. "Patient")
The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.
Aa resource (or, for logical models, the URI of the logical model).
Logical reference, when literal reference is not known
An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.
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. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
Plain text narrative that identifies the resource in addition to the resource reference.
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.
The name designation of the medical aid interface.
udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other
The type of deviceName. UDILabelName | UserFriendlyName | PatientReportedName | ManufactureDeviceName | ModelName.
The type of name the device is referred by.
A name given to the device to identify it.
What kind of device or device system this is
What kind of device or device system this is.
Type of device e.g. according to official classification.
The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication
The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication.
The standard that is used to operate and communicate
The standard that is used to operate and communicate.
The version of the standard that is used to operate and communicate
The version of the standard that is used to operate and communicate.
unique id for the element within a resource (for internal references)
May 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 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.
Language code for the human-readable text strings produced by the device (all supported)
Language code for the human-readable text strings produced by the device (all supported).
The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties
The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties.
Code that specifies the property DeviceDefinitionPropetyCode (Extensible)
Code that specifies the property DeviceDefinitionPropetyCode (Extensible).
Property value as a code, e.g., NTP4 (synced to NTP)
Property value as a code, e.g., NTP4 (synced to NTP).
An organization that is responsible for the provision and ongoing maintenance of the device.
Details for human/organization for support
Contact details for an organization or a particular human that is responsible for the device.
A network address on which the device may be contacted directly.
If the device is running a FHIR server, the network address should be the Base URL from which a conformance statement may be retrieved.
Access to on-line information about the device.
Descriptive information, usage information or implantation information that is not captured in an existing element.
The quantity of the device present in the packaging (e.g. the number of devices present in a pack, or the number of devices in the same package of the medicinal product)
The quantity of the device present in the packaging (e.g. the number of devices present in a pack, or the number of devices in the same package of the medicinal product).
A substance used to create the material(s) of which the device is made
A substance used to create the material(s) of which the device is made.
Indicates an alternative material of the device
Indicates an alternative material of the device.
Whether the substance is a known or suspected allergen
Whether the substance is a known or suspected allergen.