This page is part of the Point-of-care Device FHIR IG (v0.3.0: STU 1 Ballot 3) based on FHIR R4. . For a full list of available versions, see the Directory of published versions
Defining URL: | http://hl7.org/fhir/uv/pocd/StructureDefinition/VmdDevice |
Version: | 0.3.0 |
Name: | VmdDevice |
Title: | VMD Device profile |
Status: | Draft as of 2021-07-24 |
Definition: | StructureDefinition for Device resources that represent Virtual Medical Devices (VMD). These are medical-related subsystems in the hierarchical model of a Point-of-Care device. |
Publisher: | HL7 International - Devices Work Group |
Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://hl7.org/fhir/uv/pocd/StructureDefinition/VmdDevice
This profile sets minimum expectations for the Device resource that represents a Virtual Medical Device (VMD). This is a medical-related subsystem in the hierarchical model of a Point-of-Care device.
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Device
Summary
The profile defines the following rules:
Device.type
shall be present and have a coding from the ISO/IEEE 11073 MDC Device nomenclature if there is an appropriate code available.Device.patient
and Device.location
references must not be present.Device.parent
shall be pesent and refer to the MDS Device resource.Mandatory: 2 elements
Must-Support: 17 elements
Prohibited: 2 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
This structure is derived from Device
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Device | 0..* | Device | Item used in healthcare | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
device-instance | S | 0..1 | (Complex) | Instance number or label URL: http://hl7.org/fhir/uv/pocd/StructureDefinition/device-instance |
extension:number | 0..1 | Extension | Instance number | |
valueUnsignedInt | 1..1 | unsignedInt | Value of extension | |
extension:label | 0..1 | Extension | Instance label | |
valueString | 1..1 | string | Value of extension | |
approved-jurisdictions | S | 0..* | CodeableConcept | Approved jurisdictions URL: http://hl7.org/fhir/uv/pocd/StructureDefinition/approved-jurisdictions Binding: Jurisdiction ValueSet (extensible): Codes for country, country subdivision and region |
valueCodeableConcept | 1..1 | CodeableConcept | Approved Jurisdictions | |
coding | 0..* | Coding | Code defined by a terminology system | |
system | 0..1 | uri | Identity of the terminology system | |
code | 0..1 | code | Symbol in syntax defined by the system | |
operating-hours | S | 0..1 | unsignedInt | Operating hours URL: http://hl7.org/fhir/uv/pocd/StructureDefinition/operating-hours |
valueUnsignedInt | 1..1 | unsignedInt | Operating hours | |
operating-cycles | S | 0..1 | unsignedInt | Operating cycles URL: http://hl7.org/fhir/uv/pocd/StructureDefinition/operating-cycles |
valueUnsignedInt | 1..1 | unsignedInt | Operating cycles | |
identifier | S | 0..* | Identifier | Instance identifier |
system | 0..1 | uri | The namespace for the identifier value | |
value | 0..1 | string | The value that is unique | |
udiCarrier | S | 0..* | BackboneElement | Unique Device Identifier (UDI) Barcode string |
deviceIdentifier | 0..1 | string | Mandatory fixed portion of UDI | |
issuer | 0..1 | uri | UDI Issuing Organization | |
jurisdiction | 0..1 | uri | Regional UDI authority | |
carrierHRF | 0..1 | string | UDI Human Readable Barcode String | |
status | S | 0..1 | code | active | inactive | entered-in-error | unknown |
statusReason | S | 0..* | CodeableConcept | online | paused | standby | offline | not-ready | transduc-discon | hw-discon | off |
manufacturer | S | 0..1 | string | Name of device manufacturer |
manufactureDate | 0..1 | dateTime | Date when the device was made | |
expirationDate | 0..1 | dateTime | Date and time of expiry of this device (if applicable) | |
lotNumber | 0..1 | string | Lot number of manufacture | |
serialNumber | S | 0..1 | string | Serial number assigned by the manufacturer |
deviceName | S | 0..* | BackboneElement | The name of the device as given by the manufacturer |
modelNumber | S | 0..1 | string | The model number for the device |
partNumber | S | 0..1 | string | The part number of the device |
type | S | 1..1 | CodeableConcept | The kind or type of device Binding: MDC Object infrastructure and Device nomenclature (extensible) |
coding | 0..* | Coding | Code defined by a terminology system | |
system | 0..1 | uri | Identity of the terminology system | |
version | 0..1 | string | Version of the system - if relevant | |
code | 0..1 | code | Symbol in syntax defined by the system | |
text | 0..1 | string | Plain text representation of the concept | |
version | S | 0..* | BackboneElement | The actual design of the device or software version running on the device |
type | 0..1 | CodeableConcept | The type of the device version | |
coding | 0..* | Coding | Code defined by a terminology system | |
system | 0..1 | uri | Identity of the terminology system | |
version | 0..1 | string | Version of the system - if relevant | |
code | 0..1 | code | Symbol in syntax defined by the system | |
component | 0..1 | Identifier | A single component of the device version | |
value | 1..1 | string | The version text | |
patient | 0..0 | |||
location | 0..0 | |||
safety | S | 0..* | CodeableConcept | Safety Characteristics of Device |
coding | 0..* | Coding | Code defined by a terminology system | |
system | 0..1 | uri | Identity of the terminology system | |
code | 0..1 | code | Symbol in syntax defined by the system Binding: Safety (required): Safety classification | |
parent | S | 1..1 | Reference(MDS Device profile) | The parent device |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Device | 0..* | Device | Item used in healthcare | |
id | Σ | 0..1 | string | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
device-instance | S | 0..1 | (Complex) | Instance number or label URL: http://hl7.org/fhir/uv/pocd/StructureDefinition/device-instance |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
extension:number | 0..1 | Extension | Instance number | |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | uri | identifies the meaning of the extension | |
value[x] | 0..1 | Value of extension | ||
valueBase64Binary | base64Binary | |||
valueBoolean | boolean | |||
valueCanonical | canonical(Any) | |||
valueCode | code | |||
valueDate | date | |||
valueDateTime | dateTime | |||
valueDecimal | decimal | |||
valueId | id | |||
valueInstant | instant | |||
valueInteger | integer | |||
valueMarkdown | markdown | |||
valueOid | oid | |||
valuePositiveInt | positiveInt | |||
valueString | string | |||
valueTime | time | |||
valueUnsignedInt | unsignedInt | |||
valueUri | uri | |||
valueUrl | url | |||
valueUuid | uuid | |||
valueAddress | Address | |||
valueAge | Age | |||
valueAnnotation | Annotation | |||
valueAttachment | Attachment | |||
valueCodeableConcept | CodeableConcept | |||
valueCoding | Coding | |||
valueContactPoint | ContactPoint | |||
valueCount | Count | |||
valueDistance | Distance | |||
valueDuration | Duration | |||
valueHumanName | HumanName | |||
valueIdentifier | Identifier | |||
valueMoney | Money | |||
valuePeriod | Period | |||
valueQuantity | Quantity | |||
valueRange | Range | |||
valueRatio | Ratio | |||
valueReference | Reference(Any) | |||
valueSampledData | SampledData | |||
valueSignature | Signature | |||
valueTiming | Timing | |||
valueContactDetail | ContactDetail | |||
valueContributor | Contributor | |||
valueDataRequirement | DataRequirement | |||
valueExpression | Expression | |||
valueParameterDefinition | ParameterDefinition | |||
valueRelatedArtifact | RelatedArtifact | |||
valueTriggerDefinition | TriggerDefinition | |||
valueUsageContext | UsageContext | |||
valueDosage | Dosage | |||
valueMeta | Meta | |||
url | 1..1 | uri | "number" | |
Slices for value[x] | 1..1 | unsignedInt | Value of extension Slice: Unordered, Closed by type:$this | |
value[x]:valueUnsignedInt | 1..1 | unsignedInt | Value of extension | |
extension:label | 0..1 | Extension | Instance label | |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | uri | identifies the meaning of the extension | |
value[x] | 0..1 | Value of extension | ||
valueBase64Binary | base64Binary | |||
valueBoolean | boolean | |||
valueCanonical | canonical(Any) | |||
valueCode | code | |||
valueDate | date | |||
valueDateTime | dateTime | |||
valueDecimal | decimal | |||
valueId | id | |||
valueInstant | instant | |||
valueInteger | integer | |||
valueMarkdown | markdown | |||
valueOid | oid | |||
valuePositiveInt | positiveInt | |||
valueString | string | |||
valueTime | time | |||
valueUnsignedInt | unsignedInt | |||
valueUri | uri | |||
valueUrl | url | |||
valueUuid | uuid | |||
valueAddress | Address | |||
valueAge | Age | |||
valueAnnotation | Annotation | |||
valueAttachment | Attachment | |||
valueCodeableConcept | CodeableConcept | |||
valueCoding | Coding | |||
valueContactPoint | ContactPoint | |||
valueCount | Count | |||
valueDistance | Distance | |||
valueDuration | Duration | |||
valueHumanName | HumanName | |||
valueIdentifier | Identifier | |||
valueMoney | Money | |||
valuePeriod | Period | |||
valueQuantity | Quantity | |||
valueRange | Range | |||
valueRatio | Ratio | |||
valueReference | Reference(Any) | |||
valueSampledData | SampledData | |||
valueSignature | Signature | |||
valueTiming | Timing | |||
valueContactDetail | ContactDetail | |||
valueContributor | Contributor | |||
valueDataRequirement | DataRequirement | |||
valueExpression | Expression | |||
valueParameterDefinition | ParameterDefinition | |||
valueRelatedArtifact | RelatedArtifact | |||
valueTriggerDefinition | TriggerDefinition | |||
valueUsageContext | UsageContext | |||
valueDosage | Dosage | |||
valueMeta | Meta | |||
url | 1..1 | uri | "label" | |
Slices for value[x] | 1..1 | string | Value of extension Slice: Unordered, Closed by type:$this | |
value[x]:valueString | 1..1 | string | Value of extension | |
url | 1..1 | uri | "http://hl7.org/fhir/uv/pocd/StructureDefinition/device-instance" | |
approved-jurisdictions | S | 0..* | CodeableConcept | Approved jurisdictions URL: http://hl7.org/fhir/uv/pocd/StructureDefinition/approved-jurisdictions Binding: Jurisdiction ValueSet (extensible): Codes for country, country subdivision and region |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org/fhir/uv/pocd/StructureDefinition/approved-jurisdictions" | |
Slices for value[x] | 1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |
value[x]:valueCodeableConcept | 1..1 | CodeableConcept | Approved Jurisdictions Binding: Jurisdiction ValueSet (extensible): Codes for country, country subdivision and region | |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | 0..* | Coding | Code defined by a terminology system |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
system | Σ | 0..1 | uri | Identity of the terminology system |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | Σ | 0..1 | code | Symbol in syntax defined by the system |
display | Σ | 0..1 | string | Representation defined by the system |
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
text | Σ | 0..1 | string | Plain text representation of the concept |
operating-hours | S | 0..1 | unsignedInt | Operating hours URL: http://hl7.org/fhir/uv/pocd/StructureDefinition/operating-hours |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org/fhir/uv/pocd/StructureDefinition/operating-hours" | |
Slices for value[x] | 1..1 | unsignedInt | Operating hours Slice: Unordered, Closed by type:$this | |
value[x]:valueUnsignedInt | 1..1 | unsignedInt | Operating hours | |
operating-cycles | S | 0..1 | unsignedInt | Operating cycles URL: http://hl7.org/fhir/uv/pocd/StructureDefinition/operating-cycles |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org/fhir/uv/pocd/StructureDefinition/operating-cycles" | |
Slices for value[x] | 1..1 | unsignedInt | Operating cycles Slice: Unordered, Closed by type:$this | |
value[x]:valueUnsignedInt | 1..1 | unsignedInt | Operating cycles | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | S | 0..* | Identifier | Instance identifier |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | Σ | 0..1 | string | The value that is unique Example General: 123456 |
period | Σ | 0..1 | Period | Time period when id is/was valid for use |
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
definition | 0..1 | Reference(DeviceDefinition) | The reference to the definition for the device | |
udiCarrier | SΣ | 0..* | BackboneElement | Unique Device Identifier (UDI) Barcode string |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
deviceIdentifier | Σ | 0..1 | string | Mandatory fixed portion of UDI |
issuer | 0..1 | uri | UDI Issuing Organization | |
jurisdiction | 0..1 | uri | Regional UDI authority | |
carrierAIDC | Σ | 0..1 | base64Binary | UDI Machine Readable Barcode String |
carrierHRF | Σ | 0..1 | string | UDI Human Readable Barcode String |
entryType | 0..1 | code | barcode | rfid | manual + Binding: UDIEntryType (required): Codes to identify how UDI data was entered. | |
status | ?!SΣ | 0..1 | code | active | inactive | entered-in-error | unknown Binding: FHIRDeviceStatus (required): The availability status of the device. |
statusReason | S | 0..* | CodeableConcept | online | paused | standby | offline | not-ready | transduc-discon | hw-discon | off Binding: FHIRDeviceStatusReason (extensible): The availability status reason of the device. |
distinctIdentifier | 0..1 | string | The distinct identification string | |
manufacturer | S | 0..1 | string | Name of device manufacturer |
manufactureDate | 0..1 | dateTime | Date when the device was made | |
expirationDate | 0..1 | dateTime | Date and time of expiry of this device (if applicable) | |
lotNumber | 0..1 | string | Lot number of manufacture | |
serialNumber | S | 0..1 | string | Serial number assigned by the manufacturer |
deviceName | S | 0..* | BackboneElement | The name of the device as given by the manufacturer |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
name | 1..1 | string | The name of the device | |
type | 1..1 | code | udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other Binding: DeviceNameType (required): The type of name the device is referred by. | |
modelNumber | S | 0..1 | string | The model number for the device |
partNumber | S | 0..1 | string | The part number of the device |
type | S | 1..1 | CodeableConcept | The kind or type of device Binding: MDC Object infrastructure and Device nomenclature (extensible) |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | 0..* | Coding | Code defined by a terminology system |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
system | Σ | 0..1 | uri | Identity of the terminology system |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | Σ | 0..1 | code | Symbol in syntax defined by the system |
display | Σ | 0..1 | string | Representation defined by the system |
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
text | Σ | 0..1 | string | Plain text representation of the concept |
specialization | 0..* | BackboneElement | The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
systemType | 1..1 | CodeableConcept | The standard that is used to operate and communicate | |
version | 0..1 | string | The version of the standard that is used to operate and communicate | |
version | S | 0..* | BackboneElement | The actual design of the device or software version running on the device |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | 0..1 | CodeableConcept | The type of the device version | |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | 0..* | Coding | Code defined by a terminology system |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
system | Σ | 0..1 | uri | Identity of the terminology system |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | Σ | 0..1 | code | Symbol in syntax defined by the system |
display | Σ | 0..1 | string | Representation defined by the system |
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
text | Σ | 0..1 | string | Plain text representation of the concept |
component | 0..1 | Identifier | A single component of the device version | |
value | 1..1 | string | The version text | |
property | 0..* | BackboneElement | The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | 1..1 | CodeableConcept | Code that specifies the property DeviceDefinitionPropetyCode (Extensible) | |
valueQuantity | 0..* | Quantity | Property value as a quantity | |
valueCode | 0..* | CodeableConcept | Property value as a code, e.g., NTP4 (synced to NTP) | |
owner | 0..1 | Reference(Organization) | Organization responsible for device | |
contact | 0..* | ContactPoint | Details for human/organization for support | |
url | 0..1 | uri | Network address to contact device | |
note | 0..* | Annotation | Device notes and comments | |
safety | SΣ | 0..* | CodeableConcept | Safety Characteristics of Device |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | 0..* | Coding | Code defined by a terminology system |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
system | Σ | 0..1 | uri | Identity of the terminology system |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | Σ | 0..1 | code | Symbol in syntax defined by the system Binding: Safety (required): Safety classification |
display | Σ | 0..1 | string | Representation defined by the system |
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
text | Σ | 0..1 | string | Plain text representation of the concept |
parent | S | 1..1 | Reference(MDS Device profile) | The parent device |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Device | 0..* | Device | Item used in healthcare | |
device-instance | 0..1 | (Complex) | Instance number or label URL: http://hl7.org/fhir/uv/pocd/StructureDefinition/device-instance | |
approved-jurisdictions | 0..* | CodeableConcept | Approved jurisdictions URL: http://hl7.org/fhir/uv/pocd/StructureDefinition/approved-jurisdictions Binding: Jurisdiction ValueSet (extensible): Codes for country, country subdivision and region | |
operating-hours | 0..1 | unsignedInt | Operating hours URL: http://hl7.org/fhir/uv/pocd/StructureDefinition/operating-hours | |
operating-cycles | 0..1 | unsignedInt | Operating cycles URL: http://hl7.org/fhir/uv/pocd/StructureDefinition/operating-cycles | |
identifier | 0..* | Identifier | Instance identifier | |
udiCarrier | Σ | 0..* | BackboneElement | Unique Device Identifier (UDI) Barcode string |
status | ?!Σ | 0..1 | code | active | inactive | entered-in-error | unknown Binding: FHIRDeviceStatus (required): The availability status of the device. |
statusReason | 0..* | CodeableConcept | online | paused | standby | offline | not-ready | transduc-discon | hw-discon | off Binding: FHIRDeviceStatusReason (extensible): The availability status reason of the device. | |
manufacturer | 0..1 | string | Name of device manufacturer | |
serialNumber | 0..1 | string | Serial number assigned by the manufacturer | |
deviceName | 0..* | BackboneElement | The name of the device as given by the manufacturer | |
modelNumber | 0..1 | string | The model number for the device | |
partNumber | 0..1 | string | The part number of the device | |
type | 1..1 | CodeableConcept | The kind or type of device Binding: MDC Object infrastructure and Device nomenclature (extensible) | |
version | 0..* | BackboneElement | The actual design of the device or software version running on the device | |
safety | Σ | 0..* | CodeableConcept | Safety Characteristics of Device |
parent | 1..1 | Reference(MDS Device profile) | The parent device | |
Documentation for this format |
This structure is derived from Device
Summary
The profile defines the following rules:
Device.type
shall be present and have a coding from the ISO/IEEE 11073 MDC Device nomenclature if there is an appropriate code available.Device.patient
and Device.location
references must not be present.Device.parent
shall be pesent and refer to the MDS Device resource.Mandatory: 2 elements
Must-Support: 17 elements
Prohibited: 2 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from Device
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Device | 0..* | Device | Item used in healthcare | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
device-instance | S | 0..1 | (Complex) | Instance number or label URL: http://hl7.org/fhir/uv/pocd/StructureDefinition/device-instance |
extension:number | 0..1 | Extension | Instance number | |
valueUnsignedInt | 1..1 | unsignedInt | Value of extension | |
extension:label | 0..1 | Extension | Instance label | |
valueString | 1..1 | string | Value of extension | |
approved-jurisdictions | S | 0..* | CodeableConcept | Approved jurisdictions URL: http://hl7.org/fhir/uv/pocd/StructureDefinition/approved-jurisdictions Binding: Jurisdiction ValueSet (extensible): Codes for country, country subdivision and region |
valueCodeableConcept | 1..1 | CodeableConcept | Approved Jurisdictions | |
coding | 0..* | Coding | Code defined by a terminology system | |
system | 0..1 | uri | Identity of the terminology system | |
code | 0..1 | code | Symbol in syntax defined by the system | |
operating-hours | S | 0..1 | unsignedInt | Operating hours URL: http://hl7.org/fhir/uv/pocd/StructureDefinition/operating-hours |
valueUnsignedInt | 1..1 | unsignedInt | Operating hours | |
operating-cycles | S | 0..1 | unsignedInt | Operating cycles URL: http://hl7.org/fhir/uv/pocd/StructureDefinition/operating-cycles |
valueUnsignedInt | 1..1 | unsignedInt | Operating cycles | |
identifier | S | 0..* | Identifier | Instance identifier |
system | 0..1 | uri | The namespace for the identifier value | |
value | 0..1 | string | The value that is unique | |
udiCarrier | S | 0..* | BackboneElement | Unique Device Identifier (UDI) Barcode string |
deviceIdentifier | 0..1 | string | Mandatory fixed portion of UDI | |
issuer | 0..1 | uri | UDI Issuing Organization | |
jurisdiction | 0..1 | uri | Regional UDI authority | |
carrierHRF | 0..1 | string | UDI Human Readable Barcode String | |
status | S | 0..1 | code | active | inactive | entered-in-error | unknown |
statusReason | S | 0..* | CodeableConcept | online | paused | standby | offline | not-ready | transduc-discon | hw-discon | off |
manufacturer | S | 0..1 | string | Name of device manufacturer |
manufactureDate | 0..1 | dateTime | Date when the device was made | |
expirationDate | 0..1 | dateTime | Date and time of expiry of this device (if applicable) | |
lotNumber | 0..1 | string | Lot number of manufacture | |
serialNumber | S | 0..1 | string | Serial number assigned by the manufacturer |
deviceName | S | 0..* | BackboneElement | The name of the device as given by the manufacturer |
modelNumber | S | 0..1 | string | The model number for the device |
partNumber | S | 0..1 | string | The part number of the device |
type | S | 1..1 | CodeableConcept | The kind or type of device Binding: MDC Object infrastructure and Device nomenclature (extensible) |
coding | 0..* | Coding | Code defined by a terminology system | |
system | 0..1 | uri | Identity of the terminology system | |
version | 0..1 | string | Version of the system - if relevant | |
code | 0..1 | code | Symbol in syntax defined by the system | |
text | 0..1 | string | Plain text representation of the concept | |
version | S | 0..* | BackboneElement | The actual design of the device or software version running on the device |
type | 0..1 | CodeableConcept | The type of the device version | |
coding | 0..* | Coding | Code defined by a terminology system | |
system | 0..1 | uri | Identity of the terminology system | |
version | 0..1 | string | Version of the system - if relevant | |
code | 0..1 | code | Symbol in syntax defined by the system | |
component | 0..1 | Identifier | A single component of the device version | |
value | 1..1 | string | The version text | |
patient | 0..0 | |||
location | 0..0 | |||
safety | S | 0..* | CodeableConcept | Safety Characteristics of Device |
coding | 0..* | Coding | Code defined by a terminology system | |
system | 0..1 | uri | Identity of the terminology system | |
code | 0..1 | code | Symbol in syntax defined by the system Binding: Safety (required): Safety classification | |
parent | S | 1..1 | Reference(MDS Device profile) | The parent device |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Device | 0..* | Device | Item used in healthcare | |
id | Σ | 0..1 | string | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
device-instance | S | 0..1 | (Complex) | Instance number or label URL: http://hl7.org/fhir/uv/pocd/StructureDefinition/device-instance |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
extension:number | 0..1 | Extension | Instance number | |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | uri | identifies the meaning of the extension | |
value[x] | 0..1 | Value of extension | ||
valueBase64Binary | base64Binary | |||
valueBoolean | boolean | |||
valueCanonical | canonical(Any) | |||
valueCode | code | |||
valueDate | date | |||
valueDateTime | dateTime | |||
valueDecimal | decimal | |||
valueId | id | |||
valueInstant | instant | |||
valueInteger | integer | |||
valueMarkdown | markdown | |||
valueOid | oid | |||
valuePositiveInt | positiveInt | |||
valueString | string | |||
valueTime | time | |||
valueUnsignedInt | unsignedInt | |||
valueUri | uri | |||
valueUrl | url | |||
valueUuid | uuid | |||
valueAddress | Address | |||
valueAge | Age | |||
valueAnnotation | Annotation | |||
valueAttachment | Attachment | |||
valueCodeableConcept | CodeableConcept | |||
valueCoding | Coding | |||
valueContactPoint | ContactPoint | |||
valueCount | Count | |||
valueDistance | Distance | |||
valueDuration | Duration | |||
valueHumanName | HumanName | |||
valueIdentifier | Identifier | |||
valueMoney | Money | |||
valuePeriod | Period | |||
valueQuantity | Quantity | |||
valueRange | Range | |||
valueRatio | Ratio | |||
valueReference | Reference(Any) | |||
valueSampledData | SampledData | |||
valueSignature | Signature | |||
valueTiming | Timing | |||
valueContactDetail | ContactDetail | |||
valueContributor | Contributor | |||
valueDataRequirement | DataRequirement | |||
valueExpression | Expression | |||
valueParameterDefinition | ParameterDefinition | |||
valueRelatedArtifact | RelatedArtifact | |||
valueTriggerDefinition | TriggerDefinition | |||
valueUsageContext | UsageContext | |||
valueDosage | Dosage | |||
valueMeta | Meta | |||
url | 1..1 | uri | "number" | |
Slices for value[x] | 1..1 | unsignedInt | Value of extension Slice: Unordered, Closed by type:$this | |
value[x]:valueUnsignedInt | 1..1 | unsignedInt | Value of extension | |
extension:label | 0..1 | Extension | Instance label | |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | uri | identifies the meaning of the extension | |
value[x] | 0..1 | Value of extension | ||
valueBase64Binary | base64Binary | |||
valueBoolean | boolean | |||
valueCanonical | canonical(Any) | |||
valueCode | code | |||
valueDate | date | |||
valueDateTime | dateTime | |||
valueDecimal | decimal | |||
valueId | id | |||
valueInstant | instant | |||
valueInteger | integer | |||
valueMarkdown | markdown | |||
valueOid | oid | |||
valuePositiveInt | positiveInt | |||
valueString | string | |||
valueTime | time | |||
valueUnsignedInt | unsignedInt | |||
valueUri | uri | |||
valueUrl | url | |||
valueUuid | uuid | |||
valueAddress | Address | |||
valueAge | Age | |||
valueAnnotation | Annotation | |||
valueAttachment | Attachment | |||
valueCodeableConcept | CodeableConcept | |||
valueCoding | Coding | |||
valueContactPoint | ContactPoint | |||
valueCount | Count | |||
valueDistance | Distance | |||
valueDuration | Duration | |||
valueHumanName | HumanName | |||
valueIdentifier | Identifier | |||
valueMoney | Money | |||
valuePeriod | Period | |||
valueQuantity | Quantity | |||
valueRange | Range | |||
valueRatio | Ratio | |||
valueReference | Reference(Any) | |||
valueSampledData | SampledData | |||
valueSignature | Signature | |||
valueTiming | Timing | |||
valueContactDetail | ContactDetail | |||
valueContributor | Contributor | |||
valueDataRequirement | DataRequirement | |||
valueExpression | Expression | |||
valueParameterDefinition | ParameterDefinition | |||
valueRelatedArtifact | RelatedArtifact | |||
valueTriggerDefinition | TriggerDefinition | |||
valueUsageContext | UsageContext | |||
valueDosage | Dosage | |||
valueMeta | Meta | |||
url | 1..1 | uri | "label" | |
Slices for value[x] | 1..1 | string | Value of extension Slice: Unordered, Closed by type:$this | |
value[x]:valueString | 1..1 | string | Value of extension | |
url | 1..1 | uri | "http://hl7.org/fhir/uv/pocd/StructureDefinition/device-instance" | |
approved-jurisdictions | S | 0..* | CodeableConcept | Approved jurisdictions URL: http://hl7.org/fhir/uv/pocd/StructureDefinition/approved-jurisdictions Binding: Jurisdiction ValueSet (extensible): Codes for country, country subdivision and region |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org/fhir/uv/pocd/StructureDefinition/approved-jurisdictions" | |
Slices for value[x] | 1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |
value[x]:valueCodeableConcept | 1..1 | CodeableConcept | Approved Jurisdictions Binding: Jurisdiction ValueSet (extensible): Codes for country, country subdivision and region | |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | 0..* | Coding | Code defined by a terminology system |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
system | Σ | 0..1 | uri | Identity of the terminology system |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | Σ | 0..1 | code | Symbol in syntax defined by the system |
display | Σ | 0..1 | string | Representation defined by the system |
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
text | Σ | 0..1 | string | Plain text representation of the concept |
operating-hours | S | 0..1 | unsignedInt | Operating hours URL: http://hl7.org/fhir/uv/pocd/StructureDefinition/operating-hours |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org/fhir/uv/pocd/StructureDefinition/operating-hours" | |
Slices for value[x] | 1..1 | unsignedInt | Operating hours Slice: Unordered, Closed by type:$this | |
value[x]:valueUnsignedInt | 1..1 | unsignedInt | Operating hours | |
operating-cycles | S | 0..1 | unsignedInt | Operating cycles URL: http://hl7.org/fhir/uv/pocd/StructureDefinition/operating-cycles |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org/fhir/uv/pocd/StructureDefinition/operating-cycles" | |
Slices for value[x] | 1..1 | unsignedInt | Operating cycles Slice: Unordered, Closed by type:$this | |
value[x]:valueUnsignedInt | 1..1 | unsignedInt | Operating cycles | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | S | 0..* | Identifier | Instance identifier |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | Σ | 0..1 | string | The value that is unique Example General: 123456 |
period | Σ | 0..1 | Period | Time period when id is/was valid for use |
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
definition | 0..1 | Reference(DeviceDefinition) | The reference to the definition for the device | |
udiCarrier | SΣ | 0..* | BackboneElement | Unique Device Identifier (UDI) Barcode string |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
deviceIdentifier | Σ | 0..1 | string | Mandatory fixed portion of UDI |
issuer | 0..1 | uri | UDI Issuing Organization | |
jurisdiction | 0..1 | uri | Regional UDI authority | |
carrierAIDC | Σ | 0..1 | base64Binary | UDI Machine Readable Barcode String |
carrierHRF | Σ | 0..1 | string | UDI Human Readable Barcode String |
entryType | 0..1 | code | barcode | rfid | manual + Binding: UDIEntryType (required): Codes to identify how UDI data was entered. | |
status | ?!SΣ | 0..1 | code | active | inactive | entered-in-error | unknown Binding: FHIRDeviceStatus (required): The availability status of the device. |
statusReason | S | 0..* | CodeableConcept | online | paused | standby | offline | not-ready | transduc-discon | hw-discon | off Binding: FHIRDeviceStatusReason (extensible): The availability status reason of the device. |
distinctIdentifier | 0..1 | string | The distinct identification string | |
manufacturer | S | 0..1 | string | Name of device manufacturer |
manufactureDate | 0..1 | dateTime | Date when the device was made | |
expirationDate | 0..1 | dateTime | Date and time of expiry of this device (if applicable) | |
lotNumber | 0..1 | string | Lot number of manufacture | |
serialNumber | S | 0..1 | string | Serial number assigned by the manufacturer |
deviceName | S | 0..* | BackboneElement | The name of the device as given by the manufacturer |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
name | 1..1 | string | The name of the device | |
type | 1..1 | code | udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other Binding: DeviceNameType (required): The type of name the device is referred by. | |
modelNumber | S | 0..1 | string | The model number for the device |
partNumber | S | 0..1 | string | The part number of the device |
type | S | 1..1 | CodeableConcept | The kind or type of device Binding: MDC Object infrastructure and Device nomenclature (extensible) |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | 0..* | Coding | Code defined by a terminology system |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
system | Σ | 0..1 | uri | Identity of the terminology system |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | Σ | 0..1 | code | Symbol in syntax defined by the system |
display | Σ | 0..1 | string | Representation defined by the system |
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
text | Σ | 0..1 | string | Plain text representation of the concept |
specialization | 0..* | BackboneElement | The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
systemType | 1..1 | CodeableConcept | The standard that is used to operate and communicate | |
version | 0..1 | string | The version of the standard that is used to operate and communicate | |
version | S | 0..* | BackboneElement | The actual design of the device or software version running on the device |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | 0..1 | CodeableConcept | The type of the device version | |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | 0..* | Coding | Code defined by a terminology system |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
system | Σ | 0..1 | uri | Identity of the terminology system |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | Σ | 0..1 | code | Symbol in syntax defined by the system |
display | Σ | 0..1 | string | Representation defined by the system |
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
text | Σ | 0..1 | string | Plain text representation of the concept |
component | 0..1 | Identifier | A single component of the device version | |
value | 1..1 | string | The version text | |
property | 0..* | BackboneElement | The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | 1..1 | CodeableConcept | Code that specifies the property DeviceDefinitionPropetyCode (Extensible) | |
valueQuantity | 0..* | Quantity | Property value as a quantity | |
valueCode | 0..* | CodeableConcept | Property value as a code, e.g., NTP4 (synced to NTP) | |
owner | 0..1 | Reference(Organization) | Organization responsible for device | |
contact | 0..* | ContactPoint | Details for human/organization for support | |
url | 0..1 | uri | Network address to contact device | |
note | 0..* | Annotation | Device notes and comments | |
safety | SΣ | 0..* | CodeableConcept | Safety Characteristics of Device |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | 0..* | Coding | Code defined by a terminology system |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
system | Σ | 0..1 | uri | Identity of the terminology system |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | Σ | 0..1 | code | Symbol in syntax defined by the system Binding: Safety (required): Safety classification |
display | Σ | 0..1 | string | Representation defined by the system |
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
text | Σ | 0..1 | string | Plain text representation of the concept |
parent | S | 1..1 | Reference(MDS Device profile) | The parent device |
Documentation for this format |
Other representations of profile: CSV, Excel, Schematron
Path | Conformance | ValueSet |
Device.language | preferred | CommonLanguages Max Binding: AllLanguages |
Device.extension:approvedJurisdictions.value[x]:valueCodeableConcept | extensible | Jurisdiction ValueSet |
Device.identifier.use | required | IdentifierUse |
Device.identifier.type | extensible | Identifier Type Codes |
Device.udiCarrier.entryType | required | UDIEntryType |
Device.status | required | FHIRDeviceStatus |
Device.statusReason | extensible | FHIRDeviceStatusReason |
Device.deviceName.type | required | DeviceNameType |
Device.type | extensible | MdcObject |
Device.safety.coding.code | required | Safety |