This page is part of the Point-of-care Device FHIR IG (v0.1.0: STU 1 Draft) based on FHIR R3. . For a full list of available versions, see the Directory of published versions 
Enumeration DeviceMetric Profile
Canonical URL
http://devices.fhir.org/StructureDefinition/EnumerationDeviceMetric
Profile Definition
| Name | Flags | Card. | Type | |
|---|---|---|---|---|
| DeviceMetric | 0..* | DeviceMetric | Short description: Measurement, calculation or setting capability of a medical device Definition:Describes a measurement, calculation or setting capability of a medical device. For the initial scope, this DeviceMetric resource is only applicable to describe a single metric 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.
| |
| extension | 0..* | Extension | Short description: Additional Content defined by implementations Alternate names:extensions, user content Definition: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. 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. Unordered, Open, by url(Value) Constraints
| |
| modifierExtension | ?! | 0..* | Extension | Short description: Extensions that cannot be ignored Alternate names:extensions, user content 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. 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. Unordered, Open, by url(Value) Constraints
|
| identifier | Σ | 1..1 | Identifier | Short description: Unique identifier of this DeviceMetric Definition:Describes the unique identification of this metric that has been assigned by the device or gateway software. For example: handle ID. It should be noted that in order to make the identifier unique, the system element of the identifier should be set to the unique identifier of the device.
|
| extension | 0..* | Extension | Short description: Additional Content defined by implementations Alternate names:extensions, user content 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. 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. Unordered, Open, by url(Value) Constraints
| |
| use | Σ ?! | 0..1 | codeBinding | Short description: usual | official | temp | secondary (If known) Definition:The purpose of this identifier. 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. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
|
| type | Σ | 0..1 | CodeableConceptBinding | Short description: Description of identifier Definition:A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. 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.
|
| extension | 0..* | Extension | Short description: Additional Content defined by implementations Alternate names:extensions, user content 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. 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. Unordered, Open, by url(Value) Constraints
| |
| coding | Σ | 0..* | Coding | Short description: Code defined by a terminology system Definition:A reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
| extension | 0..* | Extension | Short description: Additional Content defined by implementations Alternate names:extensions, user content 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. 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. Unordered, Open, by url(Value) Constraints
| |
| system | Σ | 0..1 | uri | Short description: Identity of the terminology system Definition:The identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.
|
| version | Σ | 0..1 | string | Short description: Version of the system - if relevant Definition:The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
| code | Σ | 0..1 | code | Short description: Symbol in syntax defined by the system Definition:A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings may not exceed 1MB in size
|
| display | Σ | 0..1 | string | Short description: Representation defined by the system Definition:A representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings may not exceed 1MB in size
|
| userSelected | Σ | 0..1 | boolean | Short description: If this coding was chosen directly by the user Definition:Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
| text | Σ | 0..1 | string | Short description: Plain text representation of the concept Definition:A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
| system | Σ | 0..1 | uri | Short description: The namespace for the identifier value Definition:Establishes the namespace for the value - that is, a URL that describes a set values that are unique. 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. see http://en.wikipedia.org/wiki/Uniform_resource_identifier
General Mappingshttp://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
|
| value | Σ | 0..1 | string | Short description: The value that is unique Definition: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.
General Mappings123456
|
| period | Σ | 0..1 | Period | Short description: Time period when id is/was valid for use Definition:Time period during which identifier is/was valid for use. This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration.
|
| extension | 0..* | Extension | Short description: Additional Content defined by implementations Alternate names:extensions, user content 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. 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. Unordered, Open, by url(Value) Constraints
| |
| start | Σ | 0..1 | dateTime | Short description: Starting time with inclusive boundary Definition:The start of the period. The boundary is inclusive. If the low element is missing, the meaning is that the low boundary is not known.
|
| end | Σ | 0..1 | dateTime | Short description: End time with inclusive boundary, if not ongoing Definition:The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03.
|
| assigner | Σ | 0..1 | Reference(Organization) | Short description: Organization that issued id (may be just text) Definition: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.
|
| extension | 0..* | Extension | Short description: Additional Content defined by implementations Alternate names:extensions, user content 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. 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. Unordered, Open, by url(Value) Constraints
| |
| reference | Σ | 0..1 | string | Short description: Literal reference, Relative, internal or absolute URL 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. 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.
|
| identifier | Σ | 0..1 | Identifier | Short description: Logical reference, when literal reference is not known 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. 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.
|
| display | Σ | 0..1 | string | Short description: Text alternative for the resource Definition: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.
|
| type | Σ | 1..1 | CodeableConceptBinding | Short description: Enumeration type Definition:DeviceMetric.type shall have a coding from the ISO/IEEE 11073 MDC metrics nomenclature. The Rosetta Terminology Mapping Management System (RTMMS) lists available codes. DeviceMetric.type.coding allows additional coding from other code systems. DeviceMetric.type can be referred to either IEEE 11073-10101 or LOINC.
|
| extension | 0..* | Extension | Short description: Additional Content defined by implementations Alternate names:extensions, user content 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. 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. Unordered, Open, by url(Value) Constraints
| |
| coding | Σ | 1..* | Coding | Short description: Code defined by a terminology system Definition:A reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. Unordered, Open, by system(Value) Constraints
|
| extension | 0..* | Extension | Short description: Additional Content defined by implementations Alternate names:extensions, user content 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. 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. Unordered, Open, by url(Value) Constraints
| |
| system | Σ | 0..1 | uri | Short description: Identity of the terminology system Definition:The identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.
|
| version | Σ | 0..1 | string | Short description: Version of the system - if relevant Definition:The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
| code | Σ | 0..1 | code | Short description: Symbol in syntax defined by the system Definition:A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings may not exceed 1MB in size
|
| display | Σ | 0..1 | string | Short description: Representation defined by the system Definition:A representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings may not exceed 1MB in size
|
| userSelected | Σ | 0..1 | boolean | Short description: If this coding was chosen directly by the user Definition:Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
| 11073MDC | Σ | 1..1 | Coding | Short description: 11073 MDC code Definition:Code defined by the ISO/IEEE 11073-10101 Nomenclature Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
| extension | 0..* | Extension | Short description: Additional Content defined by implementations Alternate names:extensions, user content 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. 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. Unordered, Open, by url(Value) Constraints
| |
| system | Σ | 1..1 | uriFixed Value | Short description: Identity of the terminology system Definition:The identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.
urn:iso:std:iso:11073:10101
|
| version | Σ | 0..1 | string | Short description: Version of the system - if relevant Definition:The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
| code | Σ | 1..1 | code | Short description: Symbol in syntax defined by the system Definition:A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings may not exceed 1MB in size
|
| display | Σ | 0..1 | string | Short description: Representation defined by the system Definition:A representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings may not exceed 1MB in size
|
| userSelected | Σ | 0..1 | boolean | Short description: If this coding was chosen directly by the user Definition:Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
| text | Σ | 0..1 | string | Short description: Plain text representation of the concept Definition:A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
| unit | Σ | 0..0 | CodeableConceptBinding | Short description: Unit of Measure for the Metric Definition:Describes the unit that an observed value determined for this metric will have. For example: Percent, Seconds, etc. DeviceMetric.unit can refer to either UCUM or preferable a RTMMS coding system.
|
| source | Σ | 1..1 | Reference(PoC Device Profile) | Short description: Describes the link to the source Device Definition:DeviceMetric.source shall be present and refer to a Device resource according to the PoC Device profile. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(PoC Device Profile) Constraints
|
| extension | 0..* | Extension | Short description: Additional Content defined by implementations Alternate names:extensions, user content 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. 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. Unordered, Open, by url(Value) Constraints
| |
| reference | Σ | 0..1 | string | Short description: Literal reference, Relative, internal or absolute URL 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. 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.
|
| identifier | Σ | 0..1 | Identifier | Short description: Logical reference, when literal reference is not known 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. 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.
|
| display | Σ | 0..1 | string | Short description: Text alternative for the resource Definition: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.
|
| parent | Σ | 1..1 | Reference(Channel DeviceComponent Profile) | Short description: Describes the link to the parent DeviceComponent Definition:DeviceMetric.parent shall be present and refer to the Channel DeviceComponent resource where this metric belongs to. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Channel DeviceComponent Profile) Constraints
|
| extension | 0..* | Extension | Short description: Additional Content defined by implementations Alternate names:extensions, user content 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. 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. Unordered, Open, by url(Value) Constraints
| |
| reference | Σ | 0..1 | string | Short description: Literal reference, Relative, internal or absolute URL 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. 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.
|
| identifier | Σ | 0..1 | Identifier | Short description: Logical reference, when literal reference is not known 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. 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.
|
| display | Σ | 0..1 | string | Short description: Text alternative for the resource Definition: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.
|
| operationalStatus | Σ | 0..1 | codeBinding | Short description: on | off | standby | entered-in-error Definition:Indicates current operational state of the device. For example: On, Off, Standby, etc. Note that FHIR strings may not exceed 1MB in size metric-operational-status (required) Constraints
|
| color | Σ | 0..1 | codeBinding | Short description: black | red | green | yellow | blue | magenta | cyan | white Definition:Describes the color representation for the metric. This is often used to aid clinicians to track and identify parameter types by color. In practice, consider a Patient Monitor that has ECG/HR and Pleth for example; the parameters are displayed in different characteristic colors, such as HR-blue, BP-green, and PR and SpO2- magenta. Note that FHIR strings may not exceed 1MB in size
|
| category | Σ | 1..1 | codeBinding | Short description: measurement | setting | calculation | unspecified Definition:Indicates the category of the observation generation process. A DeviceMetric can be for example a setting, measurement, or calculation. Note that FHIR strings may not exceed 1MB in size
|
| measurementPeriod | Σ | 0..1 | Timing | Short description: Describes the measurement repetition time Definition:Describes the measurement repetition time. This is not necessarily the same as the update period. The measurement repetition time can range from milliseconds up to hours. An example for a measurement repetition time in the range of milliseconds is the sampling rate of an ECG. An example for a measurement repetition time in the range of hours is a NIBP that is triggered automatically every hour. The update period may be different than the measurement repetition time, if the device does not update the published observed value with the same frequency as it was measured. A timing schedule can be either a list of events - intervals on which the event occurs, or a single event with repeating criteria or just repeating criteria with no actual event. When both event and a repeating specification are provided, the list of events should be understood as an interpretation of the information in the repeat structure.
|
| extension | 0..* | Extension | Short description: Additional Content defined by implementations Alternate names:extensions, user content 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. 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. Unordered, Open, by url(Value) Constraints
| |
| event | Σ | 0..* | dateTime | Short description: When the event occurs Definition:Identifies specific times when the event occurs. In an MAR, for instance, you need to take a general specification, and turn it into a precise specification.
|
| repeat | Σ | 0..1 | Element | Short description: When the event is to occur Definition:A set of rules that describe when the event is scheduled. Many timing schedules are determined by regular repetitions.
|
| extension | 0..* | Extension | Short description: Additional Content defined by implementations Alternate names:extensions, user content 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. 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. Unordered, Open, by url(Value) Constraints
| |
| bounds[x] | Σ | 0..1 | Short description: Length/Range of lengths, or (Start and/or end) limits Definition:Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule. The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.
| |
| boundsDuration | Duration | Data Type | ||
| boundsRange | Range | Data Type | ||
| boundsPeriod | Period | Data Type | ||
| count | Σ | 0..1 | integer | Short description: Number of times to repeat Definition:A total count of the desired number of repetitions. Repetitions may be limited by end time or total occurrences. If you have both bounds and count, then this should be understood as within the bounds period, until count times happens.
|
| countMax | Σ | 0..1 | integer | Short description: Maximum number of times to repeat Definition:A maximum value for the count of the desired repetitions (e.g. do something 6-8 times). 32 bit number; for values larger than this, use decimal
|
| duration | Σ | 0..1 | decimal | Short description: How long when it happens Definition:How long this thing happens for when it happens. Some activities are not instantaneous and need to be maintained for a period of time. For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise).
|
| durationMax | Σ | 0..1 | decimal | Short description: How long when it happens (Max) Definition:The upper limit of how long this thing happens for when it happens. Some activities are not instantaneous and need to be maintained for a period of time. For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise).
|
| durationUnit | Σ | 0..1 | codeBinding | Short description: s | min | h | d | wk | mo | a - unit of time (UCUM) Definition:The units of time for the duration, in UCUM units. Note that FHIR strings may not exceed 1MB in size
|
| frequency | Σ | 0..1 | integer | Short description: Event occurs frequency times per period Definition:The number of times to repeat the action within the specified period / period range (i.e. both period and periodMax provided). 32 bit number; for values larger than this, use decimal
|
| frequencyMax | Σ | 0..1 | integer | Short description: Event occurs up to frequencyMax times per period Definition:If present, indicates that the frequency is a range - so to repeat between [frequency] and [frequencyMax] times within the period or period range. 32 bit number; for values larger than this, use decimal
|
| period | Σ | 0..1 | decimal | Short description: Event occurs frequency times per period Definition:Indicates the duration of time over which repetitions are to occur; e.g. to express "3 times per day", 3 would be the frequency and "1 day" would be the period. Do not use a IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger)
|
| periodMax | Σ | 0..1 | decimal | Short description: Upper limit of period (3-4 hours) Definition:If present, indicates that the period is a range from [period] to [periodMax], allowing expressing concepts such as "do this once every 3-5 days. Do not use a IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger)
|
| periodUnit | Σ | 0..1 | codeBinding | Short description: s | min | h | d | wk | mo | a - unit of time (UCUM) Definition:The units of time for the period in UCUM units. Note that FHIR strings may not exceed 1MB in size
|
| dayOfWeek | Σ | 0..* | codeBinding | Short description: mon | tue | wed | thu | fri | sat | sun Definition:If one or more days of week is provided, then the action happens only on the specified day(s). If no days are specified, the action is assumed to happen every day as otherwise specified. The elements frequency and period cannot be used as well as dayOfWeek.
|
| timeOfDay | Σ | 0..* | time | Short description: Time of day for action Definition:Specified time of day for action to take place. When time of day is specified, it is inferred that the action happens every day (as filtered by dayofWeek) on the specified times. The elements when, frequency and period cannot be used as well as timeOfDay.
|
| when | Σ | 0..* | codeBinding | Short description: Regular life events the event is tied to Definition:Real world events that the occurrence of the event should be tied to. Timings are frequently determined by occurrences such as waking, eating and sleep. When more than one event is listed, the event is tied to the union of the specified events.
|
| offset | Σ | 0..1 | unsignedInt | Short description: Minutes from event (before or after) Definition:The number of minutes from the event. If the event code does not indicate whether the minutes is before or after the event, then the offset is assumed to be after the event. 32 bit number; for values larger than this, use decimal
|
| code | Σ | 0..1 | CodeableConceptBinding | Short description: BID | TID | QID | AM | PM | QD | QOD | Q4H | Q6H + Definition:A code for the timing schedule. Some codes such as BID are ubiquitous, but many institutions define their own additional codes. If a code is provided, the code is understood to be a complete statement of whatever is specified in the structured timing data, and either the code or the data may be used to interpret the Timing, with the exception that .repeat.bounds still applies over the code (and is not contained in the code). BID etc are defined as 'at institutionally specified times'. For example, an institution may choose that BID is "always at 7am and 6pm". If it is inappropriate for this choice to be made, the code BID should not be used. Instead, a distinct organization-specific code should be used in place of the HL7-defined BID code and/or the a structured representation should be used (in this case, specifying the two event times). timing-abbreviation (preferred) Constraints
|
| extension | 0..* | Extension | Short description: Additional Content defined by implementations Alternate names:extensions, user content 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. 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. Unordered, Open, by url(Value) Constraints
| |
| coding | Σ | 0..* | Coding | Short description: Code defined by a terminology system Definition:A reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
| extension | 0..* | Extension | Short description: Additional Content defined by implementations Alternate names:extensions, user content 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. 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. Unordered, Open, by url(Value) Constraints
| |
| system | Σ | 0..1 | uri | Short description: Identity of the terminology system Definition:The identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.
|
| version | Σ | 0..1 | string | Short description: Version of the system - if relevant Definition:The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
| code | Σ | 0..1 | code | Short description: Symbol in syntax defined by the system Definition:A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings may not exceed 1MB in size
|
| display | Σ | 0..1 | string | Short description: Representation defined by the system Definition:A representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings may not exceed 1MB in size
|
| userSelected | Σ | 0..1 | boolean | Short description: If this coding was chosen directly by the user Definition:Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
| text | Σ | 0..1 | string | Short description: Plain text representation of the concept Definition:A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
| calibration | Σ | 0..* | BackboneElement | Short description: Describes the calibrations that have been performed or that are required to be performed Definition:Describes the calibrations that have been performed or that are required to be performed.
|
| extension | 0..* | Extension | Short description: Additional Content defined by implementations Alternate names:extensions, user content 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. 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. Unordered, Open, by url(Value) Constraints
| |
| type | Σ | 0..1 | codeBinding | Short description: unspecified | offset | gain | two-point Definition:Describes the type of the calibration method. Note that FHIR strings may not exceed 1MB in size metric-calibration-type (required) Constraints
|
| state | Σ | 0..1 | codeBinding | Short description: not-calibrated | calibration-required | calibrated | unspecified Definition:Describes the state of the calibration. Note that FHIR strings may not exceed 1MB in size metric-calibration-state (required) Constraints
|
| time | Σ | 0..1 | instant | Short description: Describes the time last calibration has been performed Definition:Describes the time last calibration has been performed. Note: This is intended for precisely observed times, typically system logs etc., and not human-reported times - for them, see date and dateTime below. Time zone is always required
|
Example (XML view)
Example of a Rhythm Status Enumeration DeviceMetric
<DeviceMetric> <id value="221" /> <meta> <profile value="http://devices.fhir.org/StructureDefinition/EnumerationDeviceMetric" /> </meta> <identifier> <use value="temp" /> <system value="urn:ietf:rfc:3986" /> <value value="urn:uuid:a7606788-a5ad-4ed8-a8a2-ead3d49442b7" /> </identifier> <type> <coding> <system value="urn:iso:std:iso:11073:10101" /> <code value="184327" /> <display value="MDC_ECG_STAT_RHY" /> </coding> <text value="Rhythm Status" /> </type> <source> <reference value="Device/72" /> </source> <parent> <reference value="DeviceComponent/429" /> </parent> <operationalStatus value="on" /> <category value="measurement" /> </DeviceMetric>
Example (JSON view)
Example of a Rhythm Status Enumeration DeviceMetric
{ "resourceType":"DeviceMetric", "id":"221", "meta":{ "profile": [ "http://devices.fhir.org/StructureDefinition/EnumerationDeviceMetric" ] }, "identifier":{ "use":"temp", "system":"urn:ietf:rfc:3986", "value":"urn:uuid:a7606788-a5ad-4ed8-a8a2-ead3d49442b7" }, "type":{ "coding": [ { "system":"urn:iso:std:iso:11073:10101", "code":"184327", "display":"MDC_ECG_STAT_RHY" } ], "text":"Rhythm Status" }, "source":{ "reference":"Device/72" }, "parent":{ "reference":"DeviceComponent/429" }, "operationalStatus":"on", "category":"measurement" }