ResMed Core Implementation Guide
0.37.0 - ci-build
ResMed Core Implementation Guide
0.37.0 - ci-build
ResMed Core Implementation Guide - Local Development build (v0.37.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: http://resmed.com/fhir/core/StructureDefinition/resmed-device | Version: 0.37.0 | |||
| Draft as of 2024-01-11 | Computable Name: ResMedDevice | |||
Minimalist resource profile for ResMed devices, sufficient for capturing key details
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Device
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Device | Device | |||
  Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
 verificationCode | 1..1 | string | Extension URL: http://resmed.com/fhir/core/StructureDefinition/ResMedSerialNumberVerificationCode | |
  Slices for identifier | 1..* | Identifier | Instance identifier Slice: Unordered, Open by pattern:system | |
  identifier:SERIAL | 1..1 | Identifier | Instance identifier | |
   system | 1..1 | uri | The namespace for the identifier value Required Pattern: http://identifier.resmed.com/device-serial | |
 value | 1..1 | string | The value that is unique | |
| status | 1..1 | code | active | inactive | entered-in-error | unknown | |
| manufacturer | 1..1 | string | Name of device manufacturer Required Pattern: ResMed Ltd | |
| serialNumber | 1..1 | string | Serial number assigned by the manufacturer | |
| deviceName | 1..* | BackboneElement | The name of the device as given by the manufacturer | |
| modelNumber | 1..1 | string | The model number for the device | |
| type | 1..1 | CodeableConcept | The kind or type of device Binding: ResMed device type codes (required) | |
 Slices for version | 3..* | BackboneElement | The actual design of the device or software version running on the device Slice: Unordered, Open by pattern:type | |
 version:ResMedVID | S | 1..1 | BackboneElement | The actual design of the device or software version running on the device |
  type | 1..1 | CodeableConcept | The type of the device version Required Pattern: At least the following | |
 coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.resmed.com/CodeSystem/device-version-components | |
 code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: variant-identifier | |
| version:ResMedMID | S | 1..1 | BackboneElement | The actual design of the device or software version running on the device |
| type | 1..1 | CodeableConcept | The type of the device version Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.resmed.com/CodeSystem/device-version-components | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: metadata-identifier | |
| version:ResMedSoftware | S | 1..1 | BackboneElement | The actual design of the device or software version running on the device |
| type | 1..1 | CodeableConcept | The type of the device version Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.resmed.com/CodeSystem/device-version-components | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: application-identifier | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Device.type | required | ResMedDeviceTypeValueSet (a valid code from ResMed device type CodeSystem) |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Device | 0..* | Device | Item used in healthcare | |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| verificationCode | 1..1 | string | Extension URL: http://resmed.com/fhir/core/StructureDefinition/ResMedSerialNumberVerificationCode | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier | 1..* | Identifier | Instance identifier Slice: Unordered, Open by pattern:system | |
| identifier:SERIAL | 1..1 | Identifier | Instance identifier | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system | Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://identifier.resmed.com/device-serial |
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
| status | ?!Σ | 1..1 | code | active | inactive | entered-in-error | unknown Binding: FHIRDeviceStatus (required): The availability status of the device. |
| manufacturer | 1..1 | string | Name of device manufacturer Required Pattern: ResMed Ltd | |
| serialNumber | 1..1 | string | Serial number assigned by the manufacturer | |
 deviceName | 1..* | BackboneElement | The name of the device as given by the manufacturer | |
| 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 | 1..1 | string | The model number for the device | |
| type | 1..1 | CodeableConcept | The kind or type of device Binding: ResMed device type codes (required) | |
| Slices for version | 3..* | BackboneElement | The actual design of the device or software version running on the device Slice: Unordered, Open by pattern:type | |
| version:All Slices | Content/Rules for all slices | |||
 modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
 value | 1..1 | string | The version text | |
| version:ResMedVID | S | 1..1 | BackboneElement | The actual design of the device or software version running on the device |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
 type | 1..1 | CodeableConcept | The type of the device version Required Pattern: At least the following | |
 coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.resmed.com/CodeSystem/device-version-components | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: variant-identifier | |
| value | 1..1 | string | The version text | |
| version:ResMedMID | S | 1..1 | BackboneElement | The actual design of the device or software version running on the device |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | 1..1 | CodeableConcept | The type of the device version Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.resmed.com/CodeSystem/device-version-components | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: metadata-identifier | |
| value | 1..1 | string | The version text | |
| version:ResMedSoftware | S | 1..1 | BackboneElement | The actual design of the device or software version running on the device |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | 1..1 | CodeableConcept | The type of the device version Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.resmed.com/CodeSystem/device-version-components | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: application-identifier | |
| value | 1..1 | string | The version text | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Device.identifier:SERIAL.use | required | IdentifierUse |
| Device.status | required | FHIRDeviceStatus |
| Device.deviceName.type | required | DeviceNameType |
| Device.type | required | ResMedDeviceTypeValueSet (a valid code from ResMed device type CodeSystem) |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Device | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Device | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Device | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Device | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Device | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Device | 0..* | Device | Item used in healthcare | |||||
| id | Σ | 0..1 | id | 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): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| verificationCode | 1..1 | string | Extension URL: http://resmed.com/fhir/core/StructureDefinition/ResMedSerialNumberVerificationCode | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier | 1..* | Identifier | Instance identifier Slice: Unordered, Open by pattern:system | |||||
| identifier:SERIAL | 1..1 | Identifier | Instance identifier | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| 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 | Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://identifier.resmed.com/device-serial | ||||
| value | Σ | 1..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 | Σ | 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 | ?!Σ | 1..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. | |||||
| distinctIdentifier | 0..1 | string | The distinct identification string | |||||
| manufacturer | 1..1 | string | Name of device manufacturer Required Pattern: ResMed Ltd | |||||
| 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 | 1..1 | string | Serial number assigned by the manufacturer | |||||
| deviceName | 1..* | 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 | 1..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: ResMed device type codes (required) | |||||
| 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 | |||||
| Slices for version | 3..* | BackboneElement | The actual design of the device or software version running on the device Slice: Unordered, Open by pattern:type | |||||
| version:All Slices | Content/Rules for all slices | |||||||
| 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 | |||||
| component | 0..1 | Identifier | A single component of the device version | |||||
| value | 1..1 | string | The version text | |||||
| version:ResMedVID | S | 1..1 | 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 | 1..1 | CodeableConcept | The type of the device version Required Pattern: At least the following | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.resmed.com/CodeSystem/device-version-components | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: variant-identifier | |||||
| 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 | |||||
| version:ResMedMID | S | 1..1 | 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 | 1..1 | CodeableConcept | The type of the device version Required Pattern: At least the following | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.resmed.com/CodeSystem/device-version-components | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: metadata-identifier | |||||
| 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 | |||||
| version:ResMedSoftware | S | 1..1 | 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 | 1..1 | CodeableConcept | The type of the device version Required Pattern: At least the following | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.resmed.com/CodeSystem/device-version-components | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: application-identifier | |||||
| 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) | |||||
| patient | 0..1 | Reference(Patient) | Patient to whom Device is affixed | |||||
| owner | 0..1 | Reference(Organization) | Organization responsible for device | |||||
| contact | 0..* | ContactPoint | Details for human/organization for support | |||||
| location | 0..1 | Reference(Location) | Where the device is found | |||||
| url | 0..1 | uri | Network address to contact device | |||||
| note | 0..* | Annotation | Device notes and comments | |||||
| safety | Σ | 0..* | CodeableConcept | Safety Characteristics of Device | ||||
| parent | 0..1 | Reference(Device) | The parent device | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Device.language | preferred | CommonLanguages
| ||||
| Device.identifier:SERIAL.use | required | IdentifierUse | ||||
| Device.identifier:SERIAL.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 | required | ResMedDeviceTypeValueSet (a valid code from ResMed device type CodeSystem) |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Device | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Device | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Device | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Device | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Device | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Device
Summary
Mandatory: 18 elements
Must-Support: 3 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Device
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Device | Device | |||
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| verificationCode | 1..1 | string | Extension URL: http://resmed.com/fhir/core/StructureDefinition/ResMedSerialNumberVerificationCode | |
| Slices for identifier | 1..* | Identifier | Instance identifier Slice: Unordered, Open by pattern:system | |
| identifier:SERIAL | 1..1 | Identifier | Instance identifier | |
| system | 1..1 | uri | The namespace for the identifier value Required Pattern: http://identifier.resmed.com/device-serial | |
| value | 1..1 | string | The value that is unique | |
| status | 1..1 | code | active | inactive | entered-in-error | unknown | |
| manufacturer | 1..1 | string | Name of device manufacturer Required Pattern: ResMed Ltd | |
| serialNumber | 1..1 | string | Serial number assigned by the manufacturer | |
| deviceName | 1..* | BackboneElement | The name of the device as given by the manufacturer | |
| modelNumber | 1..1 | string | The model number for the device | |
| type | 1..1 | CodeableConcept | The kind or type of device Binding: ResMed device type codes (required) | |
| Slices for version | 3..* | BackboneElement | The actual design of the device or software version running on the device Slice: Unordered, Open by pattern:type | |
| version:ResMedVID | S | 1..1 | BackboneElement | The actual design of the device or software version running on the device |
| type | 1..1 | CodeableConcept | The type of the device version Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.resmed.com/CodeSystem/device-version-components | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: variant-identifier | |
| version:ResMedMID | S | 1..1 | BackboneElement | The actual design of the device or software version running on the device |
| type | 1..1 | CodeableConcept | The type of the device version Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.resmed.com/CodeSystem/device-version-components | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: metadata-identifier | |
| version:ResMedSoftware | S | 1..1 | BackboneElement | The actual design of the device or software version running on the device |
| type | 1..1 | CodeableConcept | The type of the device version Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.resmed.com/CodeSystem/device-version-components | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: application-identifier | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Device.type | required | ResMedDeviceTypeValueSet (a valid code from ResMed device type CodeSystem) |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Device | 0..* | Device | Item used in healthcare | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| verificationCode | 1..1 | string | Extension URL: http://resmed.com/fhir/core/StructureDefinition/ResMedSerialNumberVerificationCode | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier | 1..* | Identifier | Instance identifier Slice: Unordered, Open by pattern:system | |
| identifier:SERIAL | 1..1 | Identifier | Instance identifier | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system | Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://identifier.resmed.com/device-serial |
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
| status | ?!Σ | 1..1 | code | active | inactive | entered-in-error | unknown Binding: FHIRDeviceStatus (required): The availability status of the device. |
| manufacturer | 1..1 | string | Name of device manufacturer Required Pattern: ResMed Ltd | |
| serialNumber | 1..1 | string | Serial number assigned by the manufacturer | |
| deviceName | 1..* | BackboneElement | The name of the device as given by the manufacturer | |
| 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 | 1..1 | string | The model number for the device | |
| type | 1..1 | CodeableConcept | The kind or type of device Binding: ResMed device type codes (required) | |
| Slices for version | 3..* | BackboneElement | The actual design of the device or software version running on the device Slice: Unordered, Open by pattern:type | |
| version:All Slices | Content/Rules for all slices | |||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| value | 1..1 | string | The version text | |
| version:ResMedVID | S | 1..1 | BackboneElement | The actual design of the device or software version running on the device |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | 1..1 | CodeableConcept | The type of the device version Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.resmed.com/CodeSystem/device-version-components | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: variant-identifier | |
| value | 1..1 | string | The version text | |
| version:ResMedMID | S | 1..1 | BackboneElement | The actual design of the device or software version running on the device |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | 1..1 | CodeableConcept | The type of the device version Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.resmed.com/CodeSystem/device-version-components | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: metadata-identifier | |
| value | 1..1 | string | The version text | |
| version:ResMedSoftware | S | 1..1 | BackboneElement | The actual design of the device or software version running on the device |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | 1..1 | CodeableConcept | The type of the device version Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.resmed.com/CodeSystem/device-version-components | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: application-identifier | |
| value | 1..1 | string | The version text | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Device.identifier:SERIAL.use | required | IdentifierUse |
| Device.status | required | FHIRDeviceStatus |
| Device.deviceName.type | required | DeviceNameType |
| Device.type | required | ResMedDeviceTypeValueSet (a valid code from ResMed device type CodeSystem) |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Device | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Device | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Device | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Device | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Device | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Device | 0..* | Device | Item used in healthcare | |||||
| id | Σ | 0..1 | id | 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): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| verificationCode | 1..1 | string | Extension URL: http://resmed.com/fhir/core/StructureDefinition/ResMedSerialNumberVerificationCode | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier | 1..* | Identifier | Instance identifier Slice: Unordered, Open by pattern:system | |||||
| identifier:SERIAL | 1..1 | Identifier | Instance identifier | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| 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 | Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://identifier.resmed.com/device-serial | ||||
| value | Σ | 1..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 | Σ | 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 | ?!Σ | 1..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. | |||||
| distinctIdentifier | 0..1 | string | The distinct identification string | |||||
| manufacturer | 1..1 | string | Name of device manufacturer Required Pattern: ResMed Ltd | |||||
| 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 | 1..1 | string | Serial number assigned by the manufacturer | |||||
| deviceName | 1..* | 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 | 1..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: ResMed device type codes (required) | |||||
| 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 | |||||
| Slices for version | 3..* | BackboneElement | The actual design of the device or software version running on the device Slice: Unordered, Open by pattern:type | |||||
| version:All Slices | Content/Rules for all slices | |||||||
| 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 | |||||
| component | 0..1 | Identifier | A single component of the device version | |||||
| value | 1..1 | string | The version text | |||||
| version:ResMedVID | S | 1..1 | 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 | 1..1 | CodeableConcept | The type of the device version Required Pattern: At least the following | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.resmed.com/CodeSystem/device-version-components | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: variant-identifier | |||||
| 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 | |||||
| version:ResMedMID | S | 1..1 | 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 | 1..1 | CodeableConcept | The type of the device version Required Pattern: At least the following | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.resmed.com/CodeSystem/device-version-components | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: metadata-identifier | |||||
| 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 | |||||
| version:ResMedSoftware | S | 1..1 | 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 | 1..1 | CodeableConcept | The type of the device version Required Pattern: At least the following | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.resmed.com/CodeSystem/device-version-components | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: application-identifier | |||||
| 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) | |||||
| patient | 0..1 | Reference(Patient) | Patient to whom Device is affixed | |||||
| owner | 0..1 | Reference(Organization) | Organization responsible for device | |||||
| contact | 0..* | ContactPoint | Details for human/organization for support | |||||
| location | 0..1 | Reference(Location) | Where the device is found | |||||
| url | 0..1 | uri | Network address to contact device | |||||
| note | 0..* | Annotation | Device notes and comments | |||||
| safety | Σ | 0..* | CodeableConcept | Safety Characteristics of Device | ||||
| parent | 0..1 | Reference(Device) | The parent device | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Device.language | preferred | CommonLanguages
| ||||
| Device.identifier:SERIAL.use | required | IdentifierUse | ||||
| Device.identifier:SERIAL.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 | required | ResMedDeviceTypeValueSet (a valid code from ResMed device type CodeSystem) |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Device | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Device | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Device | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Device | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Device | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Device
Summary
Mandatory: 18 elements
Must-Support: 3 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron